Browse code

* s3cmd, s3cmd.1, format-manpage.pl: Improved --help text and manpage. * s3cmd: Removed explicit processing of --follow-symlinks (is cought by the default / main loop).

git-svn-id: https://s3tools.svn.sourceforge.net/svnroot/s3tools/s3cmd/trunk@462 830e0280-6d2a-0410-9c65-932aecc39d9d

Michal Ludvig authored on 2011/01/02 11:33:50
Showing 4 changed files
... ...
@@ -1,3 +1,10 @@
1
+2011-01-02  Michal Ludvig  <mludvig@logix.net.nz>
2
+
3
+	* s3cmd, s3cmd.1, format-manpage.pl: Improved --help text
4
+	  and manpage.
5
+	* s3cmd: Removed explicit processing of --follow-symlinks
6
+	  (is cought by the default / main loop).
7
+
1 8
 2010-12-24  Michal Ludvig  <mludvig@logix.net.nz>
2 9
 
3 10
 	* s3cmd: Set 10s socket timeout for read()/write().
... ...
@@ -159,7 +159,6 @@ about matching file names against exclude and include rules.
159 159
 For example to exclude all files with \".jpg\" extension except those beginning with a number use:
160 160
 .PP
161 161
 	\\-\\-exclude '*.jpg' \\-\\-rinclude '[0-9].*\\.jpg'
162
-
163 162
 .SH SEE ALSO
164 163
 For the most up to date list of options run 
165 164
 .B s3cmd \\-\\-help
... ...
@@ -167,9 +166,12 @@ For the most up to date list of options run
167 167
 For more info about usage, examples and other related info visit project homepage at
168 168
 .br
169 169
 .B http://s3tools.org
170
-
170
+.SH DONATIONS
171
+Please consider a donation if you have found s3cmd useful:
172
+.br
173
+.B http://s3tools.org/donate
171 174
 .SH AUTHOR
172
-Written by Michal Ludvig <mludvig\@logix.net.nz>
175
+Written by Michal Ludvig <mludvig\@logix.net.nz> and 15+ contributors
173 176
 .SH CONTACT, SUPPORT
174 177
 Prefered way to get support is our mailing list:
175 178
 .I s3tools\\-general\@lists.sourceforge.net
... ...
@@ -177,7 +179,7 @@ Prefered way to get support is our mailing list:
177 177
 Report bugs to 
178 178
 .I s3tools\\-bugs\@lists.sourceforge.net
179 179
 .SH COPYRIGHT
180
-Copyright \\(co 2007,2008,2009,2010 Michal Ludvig <http://www.logix.cz/michal>
180
+Copyright \\(co 2007,2008,2009,2010,2011 Michal Ludvig <http://www.logix.cz/michal>
181 181
 .br
182 182
 This is free software.  You may redistribute copies of it under the terms of
183 183
 the GNU General Public License version 2 <http://www.gnu.org/licenses/gpl.html>.
... ...
@@ -1716,7 +1716,7 @@ def main():
1716 1716
 	optparser.add_option(      "--skip-existing", dest="skip_existing", action="store_true", help="Skip over files that exist at the destination (only for [get] and [sync] commands).")
1717 1717
 	optparser.add_option("-r", "--recursive", dest="recursive", action="store_true", help="Recursive upload, download or removal.")
1718 1718
 	optparser.add_option(      "--check-md5", dest="check_md5", action="store_true", help="Check MD5 sums when comparing files for [sync]. (default)")
1719
-	optparser.add_option(      "--no-check-md5", dest="check_md5", action="store_false", help="Do not check MD5 sums when comparing files for [sync]. Only size be compared. May significantly speed up transfer but may also miss some changed files.")
1719
+	optparser.add_option(      "--no-check-md5", dest="check_md5", action="store_false", help="Do not check MD5 sums when comparing files for [sync]. Only size will be compared. May significantly speed up transfer but may also miss some changed files.")
1720 1720
 	optparser.add_option("-P", "--acl-public", dest="acl_public", action="store_true", help="Store objects with ACL allowing read for anyone.")
1721 1721
 	optparser.add_option(      "--acl-private", dest="acl_public", action="store_false", help="Store objects with default ACL allowing access for you only.")
1722 1722
 	optparser.add_option(      "--acl-grant", dest="acl_grants", type="s3acl", action="append", metavar="PERMISSION:EMAIL or USER_CANONICAL_ID", help="Grant stated permission to a given amazon user. Permission is one of: read, write, read_acp, write_acp, full_control, all")
... ...
@@ -1771,7 +1771,8 @@ def main():
1771 1771
 		'"buckets" and uploading, downloading and removing '+
1772 1772
 		'"objects" from these buckets.')
1773 1773
 	optparser.epilog = format_commands(optparser.get_prog_name(), commands_list)
1774
-	optparser.epilog += ("\nSee program homepage for more information at\n%s\n" % PkgInfo.url)
1774
+	optparser.epilog += ("\nFor more informations see the progect homepage:\n%s\n" % PkgInfo.url)
1775
+	optparser.epilog += ("\nConsider a donation if you have found s3cmd useful:\n%s/donate\n" % PkgInfo.url)
1775 1776
 
1776 1777
 	(options, args) = optparser.parse_args()
1777 1778
 
... ...
@@ -1907,9 +1908,6 @@ def main():
1907 1907
 	cfg.include.extend(patterns_list)
1908 1908
 	cfg.debug_include.update(patterns_textual)
1909 1909
 
1910
-	## Process --follow-symlinks
1911
-	cfg.update_option("follow_symlinks", options.follow_symlinks)
1912
-
1913 1910
 	## Set socket read()/write() timeout
1914 1911
 	socket.setdefaulttimeout(cfg.socket_timeout)
1915 1912
 
... ...
@@ -134,6 +134,15 @@ for [get] and [sync] commands).
134 134
 \fB\-r\fR, \fB\-\-recursive\fR
135 135
 Recursive upload, download or removal.
136 136
 .TP
137
+\fB\-\-check\-md5\fR
138
+Check MD5 sums when comparing files for [sync].
139
+(default)
140
+.TP
141
+\fB\-\-no\-check\-md5\fR
142
+Do not check MD5 sums when comparing files for [sync].
143
+Only size will be compared. May significantly speed up
144
+transfer but may also miss some changed files.
145
+.TP
137 146
 \fB\-P\fR, \fB\-\-acl\-public\fR
138 147
 Store objects with ACL allowing read for anyone.
139 148
 .TP
... ...
@@ -282,7 +291,7 @@ Enable verbose output.
282 282
 Enable debug output.
283 283
 .TP
284 284
 \fB\-\-version\fR
285
-Show s3cmd version (1.0.0-rc2) and exit.
285
+Show s3cmd version (1.0.0) and exit.
286 286
 .TP
287 287
 \fB\-F\fR, \fB\-\-follow\-symlinks\fR
288 288
 Follow symbolic links as if they are regular files
... ...
@@ -363,7 +372,6 @@ about matching file names against exclude and include rules.
363 363
 For example to exclude all files with ".jpg" extension except those beginning with a number use:
364 364
 .PP
365 365
 	\-\-exclude '*.jpg' \-\-rinclude '[0-9].*\.jpg'
366
-
367 366
 .SH SEE ALSO
368 367
 For the most up to date list of options run 
369 368
 .B s3cmd \-\-help
... ...
@@ -371,9 +379,12 @@ For the most up to date list of options run
371 371
 For more info about usage, examples and other related info visit project homepage at
372 372
 .br
373 373
 .B http://s3tools.org
374
-
374
+.SH DONATIONS
375
+Please consider a donation if you have found s3cmd useful:
376
+.br
377
+.B http://s3tools.org/donate
375 378
 .SH AUTHOR
376
-Written by Michal Ludvig <mludvig@logix.net.nz>
379
+Written by Michal Ludvig <mludvig@logix.net.nz> and 15+ contributors
377 380
 .SH CONTACT, SUPPORT
378 381
 Prefered way to get support is our mailing list:
379 382
 .I s3tools\-general@lists.sourceforge.net
... ...
@@ -381,7 +392,7 @@ Prefered way to get support is our mailing list:
381 381
 Report bugs to 
382 382
 .I s3tools\-bugs@lists.sourceforge.net
383 383
 .SH COPYRIGHT
384
-Copyright \(co 2007,2008,2009,2010 Michal Ludvig <http://www.logix.cz/michal>
384
+Copyright \(co 2007,2008,2009,2010,2011 Michal Ludvig <http://www.logix.cz/michal>
385 385
 .br
386 386
 This is free software.  You may redistribute copies of it under the terms of
387 387
 the GNU General Public License version 2 <http://www.gnu.org/licenses/gpl.html>.