Permalink
Browse files

* s3cmd, s3cmd.1: Updated help and man page.

git-svn-id: https://s3tools.svn.sourceforge.net/svnroot/s3tools/s3cmd/trunk@165 830e0280-6d2a-0410-9c65-932aecc39d9d
  • Loading branch information...
1 parent 37a8ad4 commit 7393bdba94541753c6567562c921e468cbab8ccf @mludvig mludvig committed Feb 27, 2008
Showing with 44 additions and 11 deletions.
  1. +1 −0 ChangeLog
  2. +2 −0 TODO
  3. +5 −5 s3cmd
  4. +36 −6 s3cmd.1
View
@@ -1,5 +1,6 @@
2008-02-27 Michal Ludvig <michal@logix.cz>
+ * s3cmd, s3cmd.1: Updated help and man page.
* S3/S3.py, S3/Utils.py, s3cmd: Support for 's3cmd info' command.
* s3cmd: Fix crash when 'sync'ing files with unresolvable owner uid/gid.
* S3/S3.py, S3/Utils.py: open files in binary mode (otherwise windows
View
2 TODO
@@ -27,3 +27,5 @@ TODO list for s3cmd project
and sending data to S3 can both be time consuming yet
parallel tasks).
+- Keep man page up to date and write some more documentation
+ - Yeah, right ;-)
View
10 s3cmd
@@ -612,9 +612,9 @@ commands_list = [
{"cmd":"get", "label":"Get file from bucket", "param":"s3://BUCKET/OBJECT LOCAL_FILE", "func":cmd_object_get, "argc":1},
{"cmd":"del", "label":"Delete file from bucket", "param":"s3://BUCKET/OBJECT", "func":cmd_object_del, "argc":1},
#{"cmd":"mkdir", "label":"Make a virtual S3 directory", "param":"s3://BUCKET/path/to/dir", "func":cmd_mkdir, "argc":1},
- {"cmd":"sync", "label":"Synchronize a directory tree to S3 and back", "param":"LOCAL_DIR s3://BUCKET[/PREFIX]", "func":cmd_sync, "argc":2},
+ {"cmd":"sync", "label":"Synchronize a directory tree to S3", "param":"LOCAL_DIR s3://BUCKET[/PREFIX]", "func":cmd_sync, "argc":2},
{"cmd":"du", "label":"Disk usage by buckets", "param":"[s3://BUCKET[/PREFIX]]", "func":cmd_du, "argc":0},
- {"cmd":"info", "label":"Get various Bucket or Object information", "param":"s3://BUCKET[/OBJECT]", "func":cmd_info, "argc":1},
+ {"cmd":"info", "label":"Get various information about Buckets or Objects", "param":"s3://BUCKET[/OBJECT]", "func":cmd_info, "argc":1},
#{"cmd":"setacl", "label":"Modify Access control list for Bucket or Object", "param":"s3://BUCKET[/OBJECT]", "func":cmd_setacl, "argc":1},
]
@@ -662,13 +662,13 @@ if __name__ == '__main__':
optparser.add_option("-c", "--config", dest="config", metavar="FILE", help="Config file name. Defaults to %default")
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.")
- 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.")
+ 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.")
optparser.add_option("-e", "--encrypt", dest="encrypt", action="store_true", help="Encrypt files before uploading to S3.")
optparser.add_option( "--no-encrypt", dest="encrypt", action="store_false", help="Don't encrypt files.")
optparser.add_option("-f", "--force", dest="force", action="store_true", help="Force overwrite and other dangerous operations.")
- optparser.add_option("-P", "--acl-public", dest="acl_public", action="store_true", help="Store objects with ACL allowing read by anyone.")
- optparser.add_option( "--acl-private", dest="acl_public", action="store_false", help="Store objects with default ACL allowing access by you only.")
+ optparser.add_option("-P", "--acl-public", dest="acl_public", action="store_true", help="Store objects with ACL allowing read for anyone.")
+ optparser.add_option( "--acl-private", dest="acl_public", action="store_false", help="Store objects with default ACL allowing access for you only.")
optparser.add_option( "--delete-removed", dest="delete_removed", action="store_true", help="Delete remote objects with no corresponding local file [sync]")
optparser.add_option( "--no-delete-removed", dest="delete_removed", action="store_false", help="Don't delete remote objects.")
optparser.add_option("-p", "--preserve", dest="preserve_attrs", action="store_true", help="Preserve filesystem attributes (mode, ownership, timestamps). Default for [sync] command.")
View
42 s3cmd.1
@@ -28,14 +28,20 @@ List objects or buckets
List all object in all buckets
.TP
\fBput\fR \fIFILE [FILE...] s3://BUCKET[/PREFIX]\fR
-Put file into bucket
+Put file into bucket (i.e. upload to S3)
.TP
\fBget\fR \fIs3://BUCKET/OBJECT LOCAL_FILE\fR
-Get file from bucket
+Get file from bucket (i.e. download from S3)
.TP
\fBdel\fR \fIs3://BUCKET/OBJECT\fR
Delete file from bucket
.TP
+\fBsync\fR \fILOCAL_DIR s3://BUCKET[/PREFIX]\fR
+Synchronize a directory tree to S3
+.TP
+\fBinfo\fR \fIs3://BUCKET[/OBJECT]\fR
+Get various information about a Bucket or Object
+.TP
\fBdu\fR \fI[s3://BUCKET[/PREFIX]]\fR
Disk usage \- amount of data stored in S3
@@ -61,14 +67,38 @@ Config file name. Defaults to $HOME/.s3cfg
Dump current configuration after parsing config files
and command line options and exit.
.PP
-Most of the following options can have a default value set
-in the above specified config file.
+Most options can have a default value set in the above specified config file.
+.PP
+Options specific to \fBsync\fR command:
+.TP
+\fB\-\-delete\-removed\fR
+Delete remote objects with no corresponding local file
+.TP
+\fB\-\-no\-delete\-removed\fR
+Don't delete remote objects. Default for 'sync' command.
+.TP
+\fB\-p\fR, \fB\-\-preserve\fR
+Preserve filesystem attributes (mode, ownership, timestamps). Default for 'sync' command.
+.TP
+\fB\-\-no\-preserve\fR
+Don't store filesystem attributes with uploaded files.
+.TP
+\fB\-n\fR, \fB\-\-dry\-run\fR
+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.
+.PP
+Options common for all commands (where it makes sense indeed):
.TP
\fB\-f\fR, \fB\-\-force\fR
Force overwrite and other dangerous operations.
.TP
\fB\-P\fR, \fB\-\-acl\-public\fR
-Store objects with permissions allowing read by anyone.
+Store objects with permissions allowing read for anyone.
+.TP
+\fB\-\-acl\-private\fR
+Store objects with default ACL allowing access for you only.
+.TP
+\fB\-\-bucket\-location\fR=BUCKET_LOCATION
+Specify datacentre where to create the bucket. Possible values are \fIUS\fR (default) or \fIEU\fR.
.TP
\fB\-e\fR, \fB\-\-encrypt\fR
Use GPG encryption to protect stored objects from unauthorized access.
@@ -107,7 +137,7 @@ Written by Michal Ludvig <michal@logix.cz>
Report bugs to
.I s3tools\-general@lists.sourceforge.net
.SH COPYRIGHT
-Copyright \(co 2007 Michal Ludvig
+Copyright \(co 2007,2008 Michal Ludvig <http://www.logix.cz/michal>
.br
This is free software. You may redistribute copies of it under the terms of
the GNU General Public License version 2 <http://www.gnu.org/licenses/gpl.html>.

0 comments on commit 7393bdb

Please sign in to comment.