git-svn-id: https://s3tools.svn.sourceforge.net/svnroot/s3tools/s3cmd/trunk@165 830e0280-6d2a-0410-9c65-932aecc39d9d
Michal Ludvig authored on 2008/02/27 19:45:59... | ... |
@@ -1,5 +1,6 @@ |
1 | 1 |
2008-02-27 Michal Ludvig <michal@logix.cz> |
2 | 2 |
|
3 |
+ * s3cmd, s3cmd.1: Updated help and man page. |
|
3 | 4 |
* S3/S3.py, S3/Utils.py, s3cmd: Support for 's3cmd info' command. |
4 | 5 |
* s3cmd: Fix crash when 'sync'ing files with unresolvable owner uid/gid. |
5 | 6 |
* S3/S3.py, S3/Utils.py: open files in binary mode (otherwise windows |
... | ... |
@@ -612,9 +612,9 @@ commands_list = [ |
612 | 612 |
{"cmd":"get", "label":"Get file from bucket", "param":"s3://BUCKET/OBJECT LOCAL_FILE", "func":cmd_object_get, "argc":1}, |
613 | 613 |
{"cmd":"del", "label":"Delete file from bucket", "param":"s3://BUCKET/OBJECT", "func":cmd_object_del, "argc":1}, |
614 | 614 |
#{"cmd":"mkdir", "label":"Make a virtual S3 directory", "param":"s3://BUCKET/path/to/dir", "func":cmd_mkdir, "argc":1}, |
615 |
- {"cmd":"sync", "label":"Synchronize a directory tree to S3 and back", "param":"LOCAL_DIR s3://BUCKET[/PREFIX]", "func":cmd_sync, "argc":2}, |
|
615 |
+ {"cmd":"sync", "label":"Synchronize a directory tree to S3", "param":"LOCAL_DIR s3://BUCKET[/PREFIX]", "func":cmd_sync, "argc":2}, |
|
616 | 616 |
{"cmd":"du", "label":"Disk usage by buckets", "param":"[s3://BUCKET[/PREFIX]]", "func":cmd_du, "argc":0}, |
617 |
- {"cmd":"info", "label":"Get various Bucket or Object information", "param":"s3://BUCKET[/OBJECT]", "func":cmd_info, "argc":1}, |
|
617 |
+ {"cmd":"info", "label":"Get various information about Buckets or Objects", "param":"s3://BUCKET[/OBJECT]", "func":cmd_info, "argc":1}, |
|
618 | 618 |
#{"cmd":"setacl", "label":"Modify Access control list for Bucket or Object", "param":"s3://BUCKET[/OBJECT]", "func":cmd_setacl, "argc":1}, |
619 | 619 |
] |
620 | 620 |
|
... | ... |
@@ -662,13 +662,13 @@ if __name__ == '__main__': |
662 | 662 |
optparser.add_option("-c", "--config", dest="config", metavar="FILE", help="Config file name. Defaults to %default") |
663 | 663 |
optparser.add_option( "--dump-config", dest="dump_config", action="store_true", help="Dump current configuration after parsing config files and command line options and exit.") |
664 | 664 |
|
665 |
- optparser.add_option("-n", "--dry-run", dest="dry_run", action="store_true", help="Only show what should be uploaded or downloaded but don't actually do it. May still perform S3 requests to get bucket listings though.") |
|
665 |
+ optparser.add_option("-n", "--dry-run", dest="dry_run", action="store_true", help="Only show what should be uploaded or downloaded but don't actually do it. May still perform S3 requests to get bucket listings and other information though.") |
|
666 | 666 |
|
667 | 667 |
optparser.add_option("-e", "--encrypt", dest="encrypt", action="store_true", help="Encrypt files before uploading to S3.") |
668 | 668 |
optparser.add_option( "--no-encrypt", dest="encrypt", action="store_false", help="Don't encrypt files.") |
669 | 669 |
optparser.add_option("-f", "--force", dest="force", action="store_true", help="Force overwrite and other dangerous operations.") |
670 |
- optparser.add_option("-P", "--acl-public", dest="acl_public", action="store_true", help="Store objects with ACL allowing read by anyone.") |
|
671 |
- optparser.add_option( "--acl-private", dest="acl_public", action="store_false", help="Store objects with default ACL allowing access by you only.") |
|
670 |
+ optparser.add_option("-P", "--acl-public", dest="acl_public", action="store_true", help="Store objects with ACL allowing read for anyone.") |
|
671 |
+ optparser.add_option( "--acl-private", dest="acl_public", action="store_false", help="Store objects with default ACL allowing access for you only.") |
|
672 | 672 |
optparser.add_option( "--delete-removed", dest="delete_removed", action="store_true", help="Delete remote objects with no corresponding local file [sync]") |
673 | 673 |
optparser.add_option( "--no-delete-removed", dest="delete_removed", action="store_false", help="Don't delete remote objects.") |
674 | 674 |
optparser.add_option("-p", "--preserve", dest="preserve_attrs", action="store_true", help="Preserve filesystem attributes (mode, ownership, timestamps). Default for [sync] command.") |
... | ... |
@@ -28,14 +28,20 @@ List objects or buckets |
28 | 28 |
List all object in all buckets |
29 | 29 |
.TP |
30 | 30 |
\fBput\fR \fIFILE [FILE...] s3://BUCKET[/PREFIX]\fR |
31 |
-Put file into bucket |
|
31 |
+Put file into bucket (i.e. upload to S3) |
|
32 | 32 |
.TP |
33 | 33 |
\fBget\fR \fIs3://BUCKET/OBJECT LOCAL_FILE\fR |
34 |
-Get file from bucket |
|
34 |
+Get file from bucket (i.e. download from S3) |
|
35 | 35 |
.TP |
36 | 36 |
\fBdel\fR \fIs3://BUCKET/OBJECT\fR |
37 | 37 |
Delete file from bucket |
38 | 38 |
.TP |
39 |
+\fBsync\fR \fILOCAL_DIR s3://BUCKET[/PREFIX]\fR |
|
40 |
+Synchronize a directory tree to S3 |
|
41 |
+.TP |
|
42 |
+\fBinfo\fR \fIs3://BUCKET[/OBJECT]\fR |
|
43 |
+Get various information about a Bucket or Object |
|
44 |
+.TP |
|
39 | 45 |
\fBdu\fR \fI[s3://BUCKET[/PREFIX]]\fR |
40 | 46 |
Disk usage \- amount of data stored in S3 |
41 | 47 |
|
... | ... |
@@ -61,14 +67,38 @@ Config file name. Defaults to $HOME/.s3cfg |
61 | 61 |
Dump current configuration after parsing config files |
62 | 62 |
and command line options and exit. |
63 | 63 |
.PP |
64 |
-Most of the following options can have a default value set |
|
65 |
-in the above specified config file. |
|
64 |
+Most options can have a default value set in the above specified config file. |
|
65 |
+.PP |
|
66 |
+Options specific to \fBsync\fR command: |
|
67 |
+.TP |
|
68 |
+\fB\-\-delete\-removed\fR |
|
69 |
+Delete remote objects with no corresponding local file |
|
70 |
+.TP |
|
71 |
+\fB\-\-no\-delete\-removed\fR |
|
72 |
+Don't delete remote objects. Default for 'sync' command. |
|
73 |
+.TP |
|
74 |
+\fB\-p\fR, \fB\-\-preserve\fR |
|
75 |
+Preserve filesystem attributes (mode, ownership, timestamps). Default for 'sync' command. |
|
76 |
+.TP |
|
77 |
+\fB\-\-no\-preserve\fR |
|
78 |
+Don't store filesystem attributes with uploaded files. |
|
79 |
+.TP |
|
80 |
+\fB\-n\fR, \fB\-\-dry\-run\fR |
|
81 |
+Only show what would be uploaded or downloaded but don't actually do it. May still perform S3 requests to get bucket listings and other information though. |
|
82 |
+.PP |
|
83 |
+Options common for all commands (where it makes sense indeed): |
|
66 | 84 |
.TP |
67 | 85 |
\fB\-f\fR, \fB\-\-force\fR |
68 | 86 |
Force overwrite and other dangerous operations. |
69 | 87 |
.TP |
70 | 88 |
\fB\-P\fR, \fB\-\-acl\-public\fR |
71 |
-Store objects with permissions allowing read by anyone. |
|
89 |
+Store objects with permissions allowing read for anyone. |
|
90 |
+.TP |
|
91 |
+\fB\-\-acl\-private\fR |
|
92 |
+Store objects with default ACL allowing access for you only. |
|
93 |
+.TP |
|
94 |
+\fB\-\-bucket\-location\fR=BUCKET_LOCATION |
|
95 |
+Specify datacentre where to create the bucket. Possible values are \fIUS\fR (default) or \fIEU\fR. |
|
72 | 96 |
.TP |
73 | 97 |
\fB\-e\fR, \fB\-\-encrypt\fR |
74 | 98 |
Use GPG encryption to protect stored objects from unauthorized access. |
... | ... |
@@ -107,7 +137,7 @@ Written by Michal Ludvig <michal@logix.cz> |
107 | 107 |
Report bugs to |
108 | 108 |
.I s3tools\-general@lists.sourceforge.net |
109 | 109 |
.SH COPYRIGHT |
110 |
-Copyright \(co 2007 Michal Ludvig |
|
110 |
+Copyright \(co 2007,2008 Michal Ludvig <http://www.logix.cz/michal> |
|
111 | 111 |
.br |
112 | 112 |
This is free software. You may redistribute copies of it under the terms of |
113 | 113 |
the GNU General Public License version 2 <http://www.gnu.org/licenses/gpl.html>. |