Browse code
2007-04-09 Michal Ludvig <michal@logix.cz>
* s3cmd.1: Added manpage
git-svn-id: https://s3tools.svn.sourceforge.net/svnroot/s3tools/s3cmd/trunk@107 830e0280-6d2a-0410-9c65-932aecc39d9d
Michal Ludvig authored on 2007/04/08 22:55:58Showing 2 changed files
| 4 | 8 |
new file mode 100644 |
| ... | ... |
@@ -0,0 +1,116 @@ |
| 0 |
+.TH s3cmd 1 |
|
| 1 |
+.SH NAME |
|
| 2 |
+s3cmd - tool for managing Amazon S3 storage space |
|
| 3 |
+.SH SYNOPSIS |
|
| 4 |
+.B s3cmd |
|
| 5 |
+[\fIOPTIONS\fR] \fICOMMAND\fR [\fIPARAMETERS\fR] |
|
| 6 |
+.SH DESCRIPTION |
|
| 7 |
+.PP |
|
| 8 |
+.B s3cmd |
|
| 9 |
+is a command line client for copying files to/from |
|
| 10 |
+Amazon S3 (Simple Storage Service) and performing other |
|
| 11 |
+related tasks, for instance creating and removing buckets, |
|
| 12 |
+listing objects, etc. |
|
| 13 |
+.PP |
|
| 14 |
+.B s3cmd |
|
| 15 |
+can do several \fIactions\fR specified by the following \fIcommands\fR. |
|
| 16 |
+.TP |
|
| 17 |
+\fBmb\fR \fIs3://BUCKET\fR |
|
| 18 |
+Make bucket |
|
| 19 |
+.TP |
|
| 20 |
+\fBrb\fR \fIs3://BUCKET\fR |
|
| 21 |
+Remove bucket |
|
| 22 |
+.TP |
|
| 23 |
+\fBls\fR \fI[s3://BUCKET[/PREFIX]]\fR |
|
| 24 |
+List objects or buckets |
|
| 25 |
+.TP |
|
| 26 |
+\fBla\fR |
|
| 27 |
+List all object in all buckets |
|
| 28 |
+.TP |
|
| 29 |
+\fBput\fR \fIFILE [FILE...] s3://BUCKET[/PREFIX]\fR |
|
| 30 |
+Put file into bucket |
|
| 31 |
+.TP |
|
| 32 |
+\fBget\fR \fIs3://BUCKET/OBJECT LOCAL_FILE\fR |
|
| 33 |
+Get file from bucket |
|
| 34 |
+.TP |
|
| 35 |
+\fBdel\fR \fIs3://BUCKET/OBJECT\fR |
|
| 36 |
+Delete file from bucket |
|
| 37 |
+ |
|
| 38 |
+.SH OPTIONS |
|
| 39 |
+.PP |
|
| 40 |
+Some of the below specified options can have their default |
|
| 41 |
+values set in |
|
| 42 |
+.B s3cmd |
|
| 43 |
+config file (by default $HOME/.s3cmd). As it's a simple text file |
|
| 44 |
+feel free to open it with your favorite text editor and do any |
|
| 45 |
+changes you like. |
|
| 46 |
+.PP |
|
| 47 |
+Config file related options. |
|
| 48 |
+.TP |
|
| 49 |
+\fB--configure\fR |
|
| 50 |
+Invoke interactive (re)configuration tool. Don't worry, you won't |
|
| 51 |
+lose your settings on subsequent runs. |
|
| 52 |
+.TP |
|
| 53 |
+\fB-c\fR FILE, \fB--config\fR=FILE |
|
| 54 |
+Config file name. Defaults to $HOME/.s3cfg |
|
| 55 |
+.TP |
|
| 56 |
+\fB--dump-config\fR |
|
| 57 |
+Dump current configuration after parsing config files |
|
| 58 |
+and command line options and exit. |
|
| 59 |
+.PP |
|
| 60 |
+Most of the following options can have a default value set |
|
| 61 |
+in the above specified config file. |
|
| 62 |
+.TP |
|
| 63 |
+\fB-f\fR, \fB--force\fR |
|
| 64 |
+Force overwrite and other dangerous operations. |
|
| 65 |
+.TP |
|
| 66 |
+\fB-P\fR, \fB--acl-public\fR |
|
| 67 |
+Store objects with permissions allowing read by anyone. |
|
| 68 |
+.TP |
|
| 69 |
+\fB-m\fR MIME/TYPE, \fB--mime-type\fR=MIME/TYPE |
|
| 70 |
+Default MIME-type to be set for objects stored. |
|
| 71 |
+.TP |
|
| 72 |
+\fB-M\fR, \fB--guess-mime-type\fR |
|
| 73 |
+Guess MIME-type of files by their extension. Falls |
|
| 74 |
+back to default MIME-Type as specified by \fB--mime-type\fR |
|
| 75 |
+option |
|
| 76 |
+.TP |
|
| 77 |
+\fB-H\fR, \fB--human-readable-sizes\fR |
|
| 78 |
+Print sizes in human readable form. |
|
| 79 |
+.\".TP |
|
| 80 |
+.\"\fB-u\fR, \fB--show-uri\fR |
|
| 81 |
+.\"Show complete S3 URI in listings. |
|
| 82 |
+.TP |
|
| 83 |
+\fB-v\fR, \fB--verbose\fR |
|
| 84 |
+Enable verbose output. |
|
| 85 |
+.TP |
|
| 86 |
+\fB-d\fR, \fB--debug\fR |
|
| 87 |
+Enable debug output. |
|
| 88 |
+.TP |
|
| 89 |
+\fB-h\fR, \fB--help\fR |
|
| 90 |
+Show the help message and exit |
|
| 91 |
+.TP |
|
| 92 |
+\fB--version\fR |
|
| 93 |
+Show |
|
| 94 |
+.B s3cmd |
|
| 95 |
+version and exit. |
|
| 96 |
+ |
|
| 97 |
+.SH AUTHOR |
|
| 98 |
+Written by Michal Ludvig <michal@logix.cz> |
|
| 99 |
+.SH REPORTING BUGS |
|
| 100 |
+Report bugs to |
|
| 101 |
+.I s3tools-general@lists.sourceforge.net |
|
| 102 |
+.SH COPYRIGHT |
|
| 103 |
+Copyright \(co 2007 Michal Ludvig |
|
| 104 |
+.br |
|
| 105 |
+This is free software. You may redistribute copies of it under the terms of |
|
| 106 |
+the GNU General Public License version 2 <http://www.gnu.org/licenses/gpl.html>. |
|
| 107 |
+There is NO WARRANTY, to the extent permitted by law. |
|
| 108 |
+.SH SEE ALSO |
|
| 109 |
+For the most up to date list of options run |
|
| 110 |
+.B s3cmd --help |
|
| 111 |
+.br |
|
| 112 |
+For more info about usage, examples and other related info visit project homepage at |
|
| 113 |
+.br |
|
| 114 |
+.B http://s3tools.logix.cz |
|
| 115 |
+ |