Thread: [S3tools-commits] SF.net SVN: s3tools:[451] s3cmd/trunk (Page 8)

SourceForge Headquarters 225 Broadway Suite 1600 San Diego, CA 92101 +1 (858) 454-5900

Revision: 451
          http://s3tools.svn.sourceforge.net/s3tools/?rev=451&view=rev
Author:   ludvigm
Date:     2010-11-12 07:05:04 +0000 (Fri, 12 Nov 2010)

Log Message:
-----------
* format-manpage.pl: new manpage auto-formatter
* s3cmd.1: Updated using the above helper script
* setup.py: Warn if manpage is too old.

Modified Paths:
--------------
    s3cmd/trunk/ChangeLog
    s3cmd/trunk/s3cmd.1
    s3cmd/trunk/setup.py

Added Paths:
-----------
    s3cmd/trunk/format-manpage.pl

Modified: s3cmd/trunk/ChangeLog
===================================================================

--- s3cmd/trunk/ChangeLog	2010-10-26 12:02:35 UTC (rev 450)
+++ s3cmd/trunk/ChangeLog	2010-11-12 07:05:04 UTC (rev 451)
@@ -1,3 +1,9 @@
+2010-11-12  Michal Ludvig  <ml...@lo...>
+
+	* format-manpage.pl: new manpage auto-formatter
+	* s3cmd.1: Updated using the above helper script
+	* setup.py: Warn if manpage is too old.
+
 2010-10-27  Michal Ludvig  <ml...@lo...>
 
 	* run-tests.py, testsuite.tar.gz: Keep the testsuite in

Added: s3cmd/trunk/format-manpage.pl
===================================================================
--- s3cmd/trunk/format-manpage.pl	                        (rev 0)
+++ s3cmd/trunk/format-manpage.pl	2010-11-12 07:05:04 UTC (rev 451)
@@ -0,0 +1,185 @@
+#!/usr/bin/perl
+
+# Format s3cmd.1 manpage
+# Usage:
+#   s3cmd --help | format-manpage.pl > s3cmd.1
+
+use strict;
+
+my $commands = "";
+my $cfcommands = "";
+my $options = "";
+
+while (<>) {
+	if (/^Commands:/) {
+		while (<>) {
+			last if (/^\s*$/);
+			my ($desc, $cmd, $cmdline);
+			($desc = $_) =~ s/^\s*(.*?)\s*$/$1/;
+			($cmdline = <>) =~ s/^\s*s3cmd (.*?) (.*?)\s*$/s3cmd \\fB$1\\fR \\fI$2\\fR/;
+			$cmd = $1;
+			if ($cmd =~ /^cf/) {
+				$cfcommands .= ".TP\n$cmdline\n$desc\n";
+			} else {
+				$commands .= ".TP\n$cmdline\n$desc\n";
+			}
+		}
+	}
+	if (/^Options:/) {
+		my ($opt, $desc);
+		while (<>) {
+			last if (/^\s*$/);
+			$_ =~ s/\s*(.*?)\s*$/$1/;
+			$desc = "";
+			$opt = "";
+			if (/^(-.*)/) {
+				$opt = $1;
+				if ($opt =~ /  /) {
+					($opt, $desc) = split(/\s\s+/, $opt, 2);
+				}
+				$opt =~ s/(-[^ ,=]+)/\\fB$1\\fR/g;
+				$opt =~ s/-/\\-/g;
+				$options .= ".TP\n$opt\n";
+			} else {
+				$desc .= $_;
+			}
+			if ($desc) {
+				$options .= "$desc\n";
+			}
+		}
+	}
+}
+print "
+.TH s3cmd 1
+.SH NAME
+s3cmd \\- tool for managing Amazon S3 storage space and Amazon CloudFront content delivery network
+.SH SYNOPSIS
+.B s3cmd
+[\\fIOPTIONS\\fR] \\fICOMMAND\\fR [\\fIPARAMETERS\\fR]
+.SH DESCRIPTION
+.PP
+.B s3cmd
+is a command line client for copying files to/from 
+Amazon S3 (Simple Storage Service) and performing other
+related tasks, for instance creating and removing buckets,
+listing objects, etc.
+
+.SH COMMANDS
+.PP
+.B s3cmd
+can do several \\fIactions\\fR specified by the following \\fIcommands\\fR.
+$commands
+
+.PP
+Commands for CloudFront management
+$cfcommands
+
+.SH OPTIONS
+.PP
+Some of the below specified options can have their default 
+values set in 
+.B s3cmd
+config file (by default \$HOME/.s3cmd). As it's a simple text file 
+feel free to open it with your favorite text editor and do any
+changes you like. 
+$options
+
+.SH EXAMPLES
+One of the most powerful commands of \\fIs3cmd\\fR is \\fBs3cmd sync\\fR used for 
+synchronising complete directory trees to or from remote S3 storage. To some extent 
+\\fBs3cmd put\\fR and \\fBs3cmd get\\fR share a similar behaviour with \\fBsync\\fR.
+.PP
+Basic usage common in backup scenarios is as simple as:
+.nf
+	s3cmd sync /local/path/ s3://test-bucket/backup/
+.fi
+.PP
+This command will find all files under /local/path directory and copy them 
+to corresponding paths under s3://test-bucket/backup on the remote side.
+For example:
+.nf
+	/local/path/\\fBfile1.ext\\fR         \\->  s3://bucket/backup/\\fBfile1.ext\\fR
+	/local/path/\\fBdir123/file2.bin\\fR  \\->  s3://bucket/backup/\\fBdir123/file2.bin\\fR
+.fi
+.PP
+However if the local path doesn't end with a slash the last directory's name
+is used on the remote side as well. Compare these with the previous example:
+.nf
+	s3cmd sync /local/path s3://test-bucket/backup/
+.fi
+will sync:
+.nf
+	/local/\\fBpath/file1.ext\\fR         \\->  s3://bucket/backup/\\fBpath/file1.ext\\fR
+	/local/\\fBpath/dir123/file2.bin\\fR  \\->  s3://bucket/backup/\\fBpath/dir123/file2.bin\\fR
+.fi
+.PP
+To retrieve the files back from S3 use inverted syntax:
+.nf
+	s3cmd sync s3://test-bucket/backup/ /tmp/restore/
+.fi
+that will download files:
+.nf
+	s3://bucket/backup/\\fBfile1.ext\\fR         \\->  /tmp/restore/\\fBfile1.ext\\fR       
+	s3://bucket/backup/\\fBdir123/file2.bin\\fR  \\->  /tmp/restore/\\fBdir123/file2.bin\\fR
+.fi
+.PP
+Without the trailing slash on source the behaviour is similar to 
+what has been demonstrated with upload:
+.nf
+	s3cmd sync s3://test-bucket/backup /tmp/restore/
+.fi
+will download the files as:
+.nf
+	s3://bucket/\\fBbackup/file1.ext\\fR         \\->  /tmp/restore/\\fBbackup/file1.ext\\fR       
+	s3://bucket/\\fBbackup/dir123/file2.bin\\fR  \\->  /tmp/restore/\\fBbackup/dir123/file2.bin\\fR
+.fi
+.PP
+All source file names, the bold ones above, are matched against \\fBexclude\\fR 
+rules and those that match are then re\\-checked against \\fBinclude\\fR rules to see
+whether they should be excluded or kept in the source list.
+.PP
+For the purpose of \\fB\\-\\-exclude\\fR and \\fB\\-\\-include\\fR matching only the 
+bold file names above are used. For instance only \\fBpath/file1.ext\\fR is tested
+against the patterns, not \\fI/local/\\fBpath/file1.ext\\fR
+.PP
+Both \\fB\\-\\-exclude\\fR and \\fB\\-\\-include\\fR work with shell-style wildcards (a.k.a. GLOB).
+For a greater flexibility s3cmd provides Regular-expression versions of the two exclude options 
+named \\fB\\-\\-rexclude\\fR and \\fB\\-\\-rinclude\\fR. 
+The options with ...\\fB\\-from\\fR suffix (eg \\-\\-rinclude\\-from) expect a filename as
+an argument. Each line of such a file is treated as one pattern.
+.PP
+There is only one set of patterns built from all \\fB\\-\\-(r)exclude(\\-from)\\fR options
+and similarly for include variant. Any file excluded with eg \\-\\-exclude can 
+be put back with a pattern found in \\-\\-rinclude\\-from list.
+.PP
+Run s3cmd with \\fB\\-\\-dry\\-run\\fR to verify that your rules work as expected. 
+Use together with \\fB\\-\\-debug\\fR get detailed information
+about matching file names against exclude and include rules.
+.PP
+For example to exclude all files with \".jpg\" extension except those beginning with a number use:
+.PP
+	\\-\\-exclude '*.jpg' \\-\\-rinclude '[0-9].*\\.jpg'
+
+.SH SEE ALSO
+For the most up to date list of options run 
+.B s3cmd \\-\\-help
+.br
+For more info about usage, examples and other related info visit project homepage at
+.br
+.B http://s3tools.org
+
+.SH AUTHOR
+Written by Michal Ludvig <mludvig\@logix.net.nz>
+.SH CONTACT, SUPPORT
+Prefered way to get support is our mailing list:
+.I s3tools\\-general\@lists.sourceforge.net
+.SH REPORTING BUGS
+Report bugs to 
+.I s3tools\\-bugs\@lists.sourceforge.net
+.SH COPYRIGHT
+Copyright \\(co 2007,2008,2009,2010 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>.
+There is NO WARRANTY, to the extent permitted by law.
+";


Property changes on: s3cmd/trunk/format-manpage.pl
___________________________________________________________________
Added: svn:executable
   + *

Modified: s3cmd/trunk/s3cmd.1
===================================================================
--- s3cmd/trunk/s3cmd.1	2010-10-26 12:02:35 UTC (rev 450)
+++ s3cmd/trunk/s3cmd.1	2010-11-12 07:05:04 UTC (rev 451)
@@ -1,3 +1,4 @@
+
 .TH s3cmd 1
 .SH NAME
 s3cmd \- tool for managing Amazon S3 storage space and Amazon CloudFront content delivery network
@@ -11,72 +12,80 @@
 Amazon S3 (Simple Storage Service) and performing other
 related tasks, for instance creating and removing buckets,
 listing objects, etc.
+
+.SH COMMANDS
 .PP
 .B s3cmd
 can do several \fIactions\fR specified by the following \fIcommands\fR.
 .TP
-\fBmb\fR \fIs3://BUCKET\fR
+s3cmd \fBmb\fR \fIs3://BUCKET\fR
 Make bucket
 .TP
-\fBrb\fR \fIs3://BUCKET\fR
+s3cmd \fBrb\fR \fIs3://BUCKET\fR
 Remove bucket
 .TP
-\fBls\fR \fI[s3://BUCKET[/PREFIX]]\fR
+s3cmd \fBls\fR \fI[s3://BUCKET[/PREFIX]]\fR
 List objects or buckets
 .TP
-\fBla\fR
+s3cmd \fBla\fR \fI\fR
 List all object in all buckets
 .TP
-\fBput\fR \fIFILE [FILE...] s3://BUCKET[/PREFIX]\fR
-Put file into bucket (i.e. upload to S3)
+s3cmd \fBput\fR \fIFILE [FILE...] s3://BUCKET[/PREFIX]\fR
+Put file into bucket
 .TP
-\fBget\fR \fIs3://BUCKET/OBJECT LOCAL_FILE\fR
-Get file from bucket (i.e. download from S3)
+s3cmd \fBget\fR \fIs3://BUCKET/OBJECT LOCAL_FILE\fR
+Get file from bucket
 .TP
-\fBdel\fR \fIs3://BUCKET/OBJECT\fR
+s3cmd \fBdel\fR \fIs3://BUCKET/OBJECT\fR
 Delete file from bucket
 .TP
-\fBsync\fR \fILOCAL_DIR s3://BUCKET[/PREFIX]\fR
-Backup a directory tree to S3
+s3cmd \fBsync\fR \fILOCAL_DIR s3://BUCKET[/PREFIX] or s3://BUCKET[/PREFIX] LOCAL_DIR\fR
+Synchronize a directory tree to S3
 .TP
-\fBsync\fR \fIs3://BUCKET[/PREFIX] LOCAL_DIR\fR
-Restore a tree from S3 to local directory
+s3cmd \fBdu\fR \fI[s3://BUCKET[/PREFIX]]\fR
+Disk usage by buckets
 .TP
-\fBcp\fR \fIs3://BUCKET1/OBJECT1 s3://BUCKET2[/OBJECT2]\fR, \fBmv\fR \fIs3://BUCKET1/OBJECT1 s3://BUCKET2[/OBJECT2]\fR 
-Make a copy of a file (\fIcp\fR) or move a file (\fImv\fR). 
-Destination can be in the same bucket with a different name
-or in another bucket with the same or different name.
-Adding \fI\-\-acl\-public\fR will make the destination object 
-publicly accessible (see below).
+s3cmd \fBinfo\fR \fIs3://BUCKET[/OBJECT]\fR
+Get various information about Buckets or Files
 .TP
-\fBsetacl\fR \fIs3://BUCKET[/OBJECT]\fR
-Modify \fIAccess control list\fI for Bucket or Files. Use with 
-\fI\-\-acl\-public\fR or \fI\-\-acl\-private\fR
-.TP 
-\fBinfo\fR \fIs3://BUCKET[/OBJECT]\fR
-Get various information about a Bucket or Object
+s3cmd \fBcp\fR \fIs3://BUCKET1/OBJECT1 s3://BUCKET2[/OBJECT2]\fR
+Copy object
 .TP
-\fBdu\fR \fI[s3://BUCKET[/PREFIX]]\fR
-Disk usage \- amount of data stored in S3
+s3cmd \fBmv\fR \fIs3://BUCKET1/OBJECT1 s3://BUCKET2[/OBJECT2]\fR
+Move object
+.TP
+s3cmd \fBsetacl\fR \fIs3://BUCKET[/OBJECT]\fR
+Modify Access control list for Bucket or Files
+.TP
+s3cmd \fBaccesslog\fR \fIs3://BUCKET\fR
+Enable/disable bucket access logging
+.TP
+s3cmd \fBsign\fR \fISTRING-TO-SIGN\fR
+Sign arbitrary string using the secret key
+.TP
+s3cmd \fBfixbucket\fR \fIs3://BUCKET[/PREFIX]\fR
+Fix invalid file names in a bucket
 
+
 .PP
 Commands for CloudFront management
 .TP
-\fBcflist\fR
+s3cmd \fBcflist\fR \fI\fR
 List CloudFront distribution points
 .TP
-\fBcfinfo\fR [\fIcf://DIST_ID\fR]
+s3cmd \fBcfinfo\fR \fI[cf://DIST_ID]\fR
 Display CloudFront distribution point parameters
 .TP
-\fBcfcreate\fR \fIs3://BUCKET\fR
+s3cmd \fBcfcreate\fR \fIs3://BUCKET\fR
 Create CloudFront distribution point
 .TP
-\fBcfdelete\fR \fIcf://DIST_ID\fR
+s3cmd \fBcfdelete\fR \fIcf://DIST_ID\fR
 Delete CloudFront distribution point
 .TP
-\fBcfmodify\fR \fIcf://DIST_ID\fR
+s3cmd \fBcfmodify\fR \fIcf://DIST_ID\fR
 Change CloudFront distribution point parameters
 
+
 .SH OPTIONS
 .PP
 Some of the below specified options can have their default 
@@ -85,145 +94,201 @@
 config file (by default $HOME/.s3cmd). As it's a simple text file 
 feel free to open it with your favorite text editor and do any
 changes you like. 
-.PP
-\fIConfig file related options.\fR
 .TP
+\fB\-h\fR, \fB\-\-help\fR
+show this help message and exit
+.TP
 \fB\-\-configure\fR
-Invoke interactive (re)configuration tool. Don't worry, you won't 
-lose your settings on subsequent runs.
+Invoke interactive (re)configuration tool.
 .TP
 \fB\-c\fR FILE, \fB\-\-config\fR=FILE
-Config file name. Defaults to $HOME/.s3cfg
+Config file name. Defaults to /home/mludvig/.s3cfg
 .TP
 \fB\-\-dump\-config\fR
 Dump current configuration after parsing config files
 and command line options and exit.
-.PP
-\fIOptions specific for \fIfile transfer commands\fR (\fBsync\fR, \fBput\fR and \fBget\fR):
 .TP
 \fB\-n\fR, \fB\-\-dry\-run\fR
-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 in
-formation though.
+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 (only
+for file transfer commands)
 .TP
+\fB\-e\fR, \fB\-\-encrypt\fR
+Encrypt files before uploading to S3.
+.TP
+\fB\-\-no\-encrypt\fR
+Don't encrypt files.
+.TP
+\fB\-f\fR, \fB\-\-force\fR
+Force overwrite and other dangerous operations.
+.TP
+\fB\-\-continue\fR
+Continue getting a partially downloaded file (only for
+[get] command).
+.TP
+\fB\-\-skip\-existing\fR
+Skip over files that exist at the destination (only
+for [get] and [sync] commands).
+.TP
+\fB\-r\fR, \fB\-\-recursive\fR
+Recursive upload, download or removal.
+.TP
+\fB\-P\fR, \fB\-\-acl\-public\fR
+Store objects with ACL allowing read for anyone.
+.TP
+\fB\-\-acl\-private\fR
+Store objects with default ACL allowing access for you
+only.
+.TP
+\fB\-\-acl\-grant\fR=PERMISSION:EMAIL or USER_CANONICAL_ID
+Grant stated permission to a given amazon user.
+Permission is one of: read, write, read_acp,
+write_acp, full_control, all
+.TP
+\fB\-\-acl\-revoke\fR=PERMISSION:USER_CANONICAL_ID
+Revoke stated permission for a given amazon user.
+Permission is one of: read, write, read_acp, wr
+ite_acp, full_control, all
+.TP
 \fB\-\-delete\-removed\fR
-Delete remote objects with no corresponding local file when \fIsync\fRing \fBto\fR S3 or delete local files with no corresponding object in S3 when \fIsync\fRing \fBfrom\fR S3.
+Delete remote objects with no corresponding local file
+[sync]
 .TP
 \fB\-\-no\-delete\-removed\fR
-Don't delete remote objects. Default for \fIsync\fR command.
+Don't delete remote objects.
 .TP
 \fB\-p\fR, \fB\-\-preserve\fR
-Preserve filesystem attributes (mode, ownership, timestamps). Default for \fIsync\fR command.
+Preserve filesystem attributes (mode, ownership,
+timestamps). Default for [sync] command.
 .TP
 \fB\-\-no\-preserve\fR
-Don't store filesystem attributes with uploaded files.
+Don't store FS attributes
 .TP
-\fB\-\-exclude GLOB\fR
-Exclude files matching GLOB (a.k.a. shell-style wildcard) from \fIsync\fI. See FILE TRANSFERS section and \fIhttp://s3tools.org/s3cmd-sync\fR for more information.
+\fB\-\-exclude\fR=GLOB
+Filenames and paths matching GLOB will be excluded
+from sync
 .TP
-\fB\-\-exclude\-from FILE\fR
-Same as \-\-exclude but reads GLOBs from the given FILE instead of expecting them on the command line.
+\fB\-\-exclude\-from\fR=FILE
+Read --exclude GLOBs from FILE
 .TP
-\fB\-\-rexclude REGEXP\fR
-Same as \-\-exclude but works with REGEXPs (Regular expressions).
+\fB\-\-rexclude\fR=REGEXP
+Filenames and paths matching REGEXP (regular
+expression) will be excluded from sync
 .TP
-\fB\-\-rexclude\-from FILE\fR
-Same as \-\-exclude\-from but works with REGEXPs.
+\fB\-\-rexclude\-from\fR=FILE
+Read --rexclude REGEXPs from FILE
 .TP
-\fB\-\-include=GLOB\fR, \fB\-\-include\-from=FILE\fR, \fB\-\-rinclude=REGEXP\fR, \fB\-\-rinclude\-from=FILE\fR
-Filenames and paths matching GLOB or REGEXP will be included even if previously excluded by one of \-\-(r)exclude(\-from) patterns
+\fB\-\-include\fR=GLOB
+Filenames and paths matching GLOB will be included
+even if previously excluded by one of
 .TP
-\fB\-\-continue\fR
-Continue getting a partially downloaded file (only for \fIget\fR command). This comes handy once download of a large file, say an ISO image, from a S3 bucket fails and a partially downloaded file is left on the disk. Unfortunately \fIput\fR command doesn't support restarting of failed upload due to Amazon S3 limitations.
+\fB\-\-(r)exclude(\-from)\fR patterns
 .TP
-\fB\-\-skip\-existing\fR
-Skip over files that exist at the destination (only for \fIget\fR and \fIsync\fR commands).
+\fB\-\-include\-from\fR=FILE
+Read --include GLOBs from FILE
 .TP
-\fB\-\-follow\-symlinks\fR
-Treat local symbolic links as if they are regular files,
-copying their targets to the remote. (Only for \fIput\fR and \fIsync\fR commands).
+\fB\-\-rinclude\fR=REGEXP
+Same as --include but uses REGEXP (regular expression)
+instead of GLOB
 .TP
-\fB\-m\fR MIME/TYPE, \fB\-\-mime\-type\fR=MIME/TYPE
-Default MIME\-type to be set for objects stored.
+\fB\-\-rinclude\-from\fR=FILE
+Read --rinclude REGEXPs from FILE
 .TP
-\fB\-M\fR, \fB\-\-guess\-mime\-type\fR
-Guess MIME\(hytype of files by their extension. Falls
-back to default MIME\(hyType as specified by \fB\-\-mime\-type\fR
-option
+\fB\-\-bucket\-location\fR=BUCKET_LOCATION
+Datacentre to create bucket in. As of now the
+datacenters are: US (default), EU, us-west-1, and ap-
+southeast-1
 .TP
-\fB\-\-add\-header=NAME:VALUE\fR
-Add a given HTTP header to the upload request. Can be used multiple times with different header names. For instance set 'Expires' or 'Cache-Control' headers (or both) using this options if you like.
+\fB\-\-reduced\-redundancy\fR, \fB\-\-rr\fR
+Store object with 'Reduced redundancy'. Lower per-GB
+price. [put, cp, mv]
 .TP
-\fB\-P\fR, \fB\-\-acl\-public\fR
-Store objects with permissions allowing read for anyone. See \fIhttp://s3tools.org/s3cmd-public\fR for details and hints for storing publicly accessible files.
+\fB\-\-access\-logging\-target\-prefix\fR=LOG_TARGET_PREFIX
+Target prefix for access logs (S3 URI) (for [cfmodify]
+and [accesslog] commands)
 .TP
-\fB\-\-acl\-private\fR
-Store objects with default ACL allowing access for you only.
+\fB\-\-no\-access\-logging\fR
+Disable access logging (for [cfmodify] and [accesslog]
+commands)
 .TP
-\fB\-e\fR, \fB\-\-encrypt\fR
-Use GPG encryption to protect stored objects from unauthorized access. See \fIhttp://s3tools.org/s3cmd-public\fR for details about encryption.
+\fB\-m\fR MIME/TYPE, \fB\-\-mime\-type\fR=MIME/TYPE
+Default MIME-type to be set for objects stored.
 .TP
-\fB\-\-no\-encrypt\fR
-Don't encrypt files.
-.PP
-\fIOptions for CloudFront commands\fR:
-.PP
-See \fIhttp://s3tools.org/s3cmd-cloudfront\fR for more details.
+\fB\-M\fR, \fB\-\-guess\-mime\-type\fR
+Guess MIME-type of files by their extension. Falls
+back to default MIME-Type as specified by --mime-type
+option
 .TP
-\fB\-\-enable\fR
-Enable given CloudFront distribution (only for \fIcfmodify\fR command)
+\fB\-\-add\-header\fR=NAME:VALUE
+Add a given HTTP header to the upload request. Can be
+used multiple times. For instance set 'Expires' or
+'Cache-Control' headers (or both) using this options
+if you like.
 .TP
-\fB\-\-disable\fR
-Enable given CloudFront distribution (only for \fIcfmodify\fR command)
+\fB\-\-encoding\fR=ENCODING
+Override autodetected terminal and filesystem encoding
+(character set). Autodetected: UTF-8
 .TP
-\fB\-\-cf\-add\-cname=CNAME\fR
-Add given CNAME to a CloudFront distribution (only for \fIcfcreate\fR and \fIcfmodify\fR commands)
+\fB\-\-verbatim\fR
+Use the S3 name as given on the command line. No pre-
+processing, encoding, etc. Use with caution!
 .TP
-\fB\-\-cf\-remove\-cname=CNAME\fR
-Remove given CNAME from a CloudFront distribution (only for \fIcfmodify\fR command)
+\fB\-\-list\-md5\fR
+Include MD5 sums in bucket listings (only for 'ls'
+command).
 .TP
-\fB\-\-cf\-comment=COMMENT\fR
-Set COMMENT for a given CloudFront distribution (only for \fIcfcreate\fR and \fIcfmodify\fR commands)
-.PP
-\fIOptions common for all commands\fR (where it makes sense indeed):
+\fB\-H\fR, \fB\-\-human\-readable\-sizes\fR
+Print sizes in human readable form (eg 1kB instead of
+1234).
 .TP
-\fB\-r\fR, \fB\-\-recursive\fR
-Recursive upload, download or removal. When used with \fIdel\fR it can
-remove all the files in a bucket.
+\fB\-\-progress\fR
+Display progress meter (default on TTY).
 .TP
-\fB\-f\fR, \fB\-\-force\fR
-Force overwrite and other dangerous operations. Can be used to remove 
-a non\-empty buckets with \fIs3cmd rb \-\-force s3://bkt\fR
+\fB\-\-no\-progress\fR
+Don't display progress meter (default on non-TTY).
 .TP
-\fB\-\-bucket\-location\fR=BUCKET_LOCATION
-Specify datacentre where to create the bucket. Possible values are \fIUS\fR (default) or \fIEU\fR.
+\fB\-\-enable\fR
+Enable given CloudFront distribution (only for
+[cfmodify] command)
 .TP
-\fB\-H\fR, \fB\-\-human\-readable\-sizes\fR
-Print sizes in human readable form.
+\fB\-\-disable\fR
+Enable given CloudFront distribution (only for
+[cfmodify] command)
 .TP
-\fB\-\-list\-md5\fR
-Include MD5 sums in bucket listings (only for \fIls\fR command).
+\fB\-\-cf\-add\-cname\fR=CNAME
+Add given CNAME to a CloudFront distribution (only for
+[cfcreate] and [cfmodify] commands)
 .TP
-\fB\-\-progress\fR, \fB\-\-no\-progress\fR
-Display or don't display progress meter. When running on TTY (e.g. console or xterm) the default is to display progress meter. If not on TTY (e.g. output is redirected somewhere or running from cron) the default is to not display progress meter.
+\fB\-\-cf\-remove\-cname\fR=CNAME
+Remove given CNAME from a CloudFront distribution
+(only for [cfmodify] command)
 .TP
-\fB\-\-encoding=ENCODING\fR
-Override autodetected terminal and filesystem encoding (character set).
+\fB\-\-cf\-comment\fR=COMMENT
+Set COMMENT for a given CloudFront distribution (only
+for [cfcreate] and [cfmodify] commands)
 .TP
+\fB\-\-cf\-default\-root\-object\fR=DEFAULT_ROOT_OBJECT
+Set the default root object to return when no object
+is specified in the URL. Use a relative path, i.e.
+default/index.html instead of /default/index.html or
+s3://bucket/default/index.html (only for [cfcreate]
+and [cfmodify] commands)
+.TP
 \fB\-v\fR, \fB\-\-verbose\fR
 Enable verbose output.
 .TP
 \fB\-d\fR, \fB\-\-debug\fR
 Enable debug output.
 .TP
-\fB\-h\fR, \fB\-\-help\fR
-Show the help message and exit
+\fB\-\-version\fR
+Show s3cmd version (1.0.0-rc1) and exit.
 .TP
-\fB\-\-version\fR
-Show
-.B s3cmd
-version and exit.
+\fB\-F\fR, \fB\-\-follow\-symlinks\fR
+Follow symbolic links as if they are regular files
 
-.SH FILE TRANSFERS
+
+.SH EXAMPLES
 One of the most powerful commands of \fIs3cmd\fR is \fBs3cmd sync\fR used for 
 synchronising complete directory trees to or from remote S3 storage. To some extent 
 \fBs3cmd put\fR and \fBs3cmd get\fR share a similar behaviour with \fBsync\fR.
@@ -308,7 +373,7 @@
 .B http://s3tools.org
 
 .SH AUTHOR
-Written by Michal Ludvig <mi...@lo...>
+Written by Michal Ludvig <ml...@lo...>
 .SH CONTACT, SUPPORT
 Prefered way to get support is our mailing list:
 .I s3tools\-ge...@li...
@@ -316,7 +381,7 @@
 Report bugs to 
 .I s3tools\-b...@li...
 .SH COPYRIGHT
-Copyright \(co 2007,2008,2009 Michal Ludvig <http://www.logix.cz/michal>
+Copyright \(co 2007,2008,2009,2010 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>.

Modified: s3cmd/trunk/setup.py
===================================================================
--- s3cmd/trunk/setup.py	2010-10-26 12:02:35 UTC (rev 450)
+++ s3cmd/trunk/setup.py	2010-11-12 07:05:04 UTC (rev 451)
@@ -33,6 +33,14 @@
 except:
 	pass
 
+## Re-create the manpage
+## (Beware! Perl script on the loose!!)
+if sys.argv[1] == "sdist":
+	if os.stat_result(os.stat("s3cmd.1")).st_mtime < os.stat_result(os.stat("s3cmd")).st_mtime:
+		sys.stderr.write("Re-create man page first!\n")
+		sys.stderr.write("Run: ./s3cmd --help | ./format-manpage.pl > s3cmd.1\n")
+		sys.exit(1)
+
 ## Don't install manpages and docs when $S3CMD_PACKAGING is set
 ## This was a requirement of Debian package maintainer. 
 if not os.getenv("S3CMD_PACKAGING"):


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.




Thread: [S3tools-commits] SF.net SVN: s3tools:[451] s3cmd/trunk (Page 8)

Command line tool for managing Amazon S3 and CloudFront services

s3tools-commits