Browse code

Merge branch 'master' of github.com:s3tools/s3cmd into upstream-master

Matt Domsch authored on 2014/04/20 09:24:18
Showing 4 changed files
... ...
@@ -34,12 +34,13 @@ on Python or some libraries. Please consult your
34 34
 distribution documentation on ways to solve the problem.
35 35
 
36 36
 
37
-Installation from source .tar.gz package
37
+Installation from zip file 
38
+--------------------------
38 39
 There are three options to run s3cmd from source tarball:
39 40
 
40
-1) The S3cmd program, as distributed in s3cmd-X.Y.Z.tar.gz,
41
-   can be run directly from where you unzipped the package.
41
+1) The S3cmd program, as distributed in s3cmd-X.Y.Z.tar.gz
42
+   on SourceForge or in master.zip on GitHub, can be run directly 
43
+   from where you unzipped the package.
42 44
 
43 45
 2) Or you may want to move "s3cmd" file and "S3" subdirectory
44 46
    to some other path. Make sure that "S3" subdirectory ends up
... ...
@@ -49,7 +50,8 @@ There are three options to run s3cmd from source tarball:
49 49
    you will have $HOME/bin/s3cmd file and $HOME/bin/S3 directory 
50 50
    with a number of support files.
51 51
 
52
-3) The cleanest and most recommended approach is to just run:
52
+3) The cleanest and most recommended approach is to unzip the 
53
+   package and then just run:
53 54
 
54 55
 	python setup.py install
55 56
 
... ...
@@ -63,6 +65,13 @@ There are three options to run s3cmd from source tarball:
63 63
    Again, consult your distribution documentation on how to 
64 64
    find out the actual package name and how to install it then.
65 65
 
66
+   Note that on Linux, if you are not "root" already, you may 
67
+   need to run:
68
+       
69
+        sudo python setup.py install
70
+
71
+   instead.
72
+
66 73
 
67 74
 Note to distributions package maintainers
68 75
 ----------------------------------------
... ...
@@ -84,5 +93,6 @@ get back to us via mailing list:
84 84
 
85 85
 	s3tools-general@lists.sourceforge.net
86 86
 
87
-For more information refer to:
88
-* S3cmd / S3tools homepage at http://s3tools.org
87
+or visit the S3cmd / S3tools homepage at: 
88
+
89
+        http://s3tools.org
... ...
@@ -183,28 +183,39 @@ To exclude local directory 'somedir', be sure to use a trailing forward slash, a
183 183
 .PP
184 184
 
185 185
 .SH SEE ALSO
186
-For the most up to date list of options run 
186
+For the most up to date list of options run: 
187 187
 .B s3cmd \\-\\-help
188 188
 .br
189
-For more info about usage, examples and other related info visit project homepage at
190
-.br
189
+For more info about usage, examples and other related info visit project homepage at:
191 190
 .B http://s3tools.org
192 191
 .SH DONATIONS
193 192
 Please consider a donation if you have found s3cmd useful:
194 193
 .br
195 194
 .B http://s3tools.org/donate
196 195
 .SH AUTHOR
197
-Written by Michal Ludvig <mludvig\@logix.net.nz> and 15+ contributors
196
+Written by Michal Ludvig and contributors
198 197
 .SH CONTACT, SUPPORT
199 198
 Preferred way to get support is our mailing list:
199
+.br
200 200
 .I s3tools\\-general\@lists.sourceforge.net
201
+.br
202
+or visit the project homepage:
203
+.br
204
+.B http://s3tools.org
201 205
 .SH REPORTING BUGS
202 206
 Report bugs to 
203 207
 .I s3tools\\-bugs\@lists.sourceforge.net
204 208
 .SH COPYRIGHT
205
-Copyright \\(co 2007,2008,2009,2010,2011,2012 Michal Ludvig <http://www.logix.cz/michal>
209
+Copyright \\(co 2007-2014 TGRMN Software - http://www.tgrmn.com - and contributors
210
+.br
211
+.SH LICENSE
212
+This program is free software; you can redistribute it and/or modify
213
+it under the terms of the GNU General Public License as published by
214
+the Free Software Foundation; either version 2 of the License, or
215
+(at your option) any later version.
216
+This program is distributed in the hope that it will be useful,
217
+but WITHOUT ANY WARRANTY; without even the implied warranty of
218
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
219
+GNU General Public License for more details.
206 220
 .br
207
-This is free software.  You may redistribute copies of it under the terms of
208
-the GNU General Public License version 2 <http://www.gnu.org/licenses/gpl.html>.
209
-There is NO WARRANTY, to the extent permitted by law.
210 221
 ";
... ...
@@ -1,10 +1,22 @@
1 1
 #!/usr/bin/env python
2 2
 
3
-## Amazon S3 manager
4
-## Author: Michal Ludvig <michal@logix.cz>
5
-##         http://www.logix.cz/michal
6
-## License: GPL Version 2
7
-## Copyright: TGRMN Software and contributors
3
+## --------------------------------------------------------------------
4
+## s3cmd - S3 client
5
+##
6
+## Authors   : Michal Ludvig and contributors
7
+## Copyright : TGRMN Software - http://www.tgrmn.com - and contributors
8
+## Website   : http://s3tools.org
9
+## License   : GPL Version 2
10
+## --------------------------------------------------------------------
11
+## This program is free software; you can redistribute it and/or modify
12
+## it under the terms of the GNU General Public License as published by
13
+## the Free Software Foundation; either version 2 of the License, or
14
+## (at your option) any later version.
15
+## This program is distributed in the hope that it will be useful,
16
+## but WITHOUT ANY WARRANTY; without even the implied warranty of
17
+## MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
18
+## GNU General Public License for more details.
19
+## --------------------------------------------------------------------
8 20
 
9 21
 import sys
10 22
 
... ...
@@ -2088,7 +2100,7 @@ def main():
2088 2088
     optparser.add_option(      "--no-mime-magic", dest="use_mime_magic", action="store_false", help="Don't use mime magic when guessing MIME-type.")
2089 2089
     optparser.add_option("-m", "--mime-type", dest="mime_type", type="mimetype", metavar="MIME/TYPE", help="Force MIME-type. Override both --default-mime-type and --guess-mime-type.")
2090 2090
 
2091
-    optparser.add_option(      "--add-header", dest="add_header", action="append", metavar="NAME:VALUE", help="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.")
2091
+    optparser.add_option(      "--add-header", dest="add_header", action="append", metavar="NAME:VALUE", help="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 option.")
2092 2092
 
2093 2093
     optparser.add_option(      "--server-side-encryption", dest="server_side_encryption", action="store_true", help="Specifies that server-side encryption will be used when putting objects.")
2094 2094
 
... ...
@@ -2097,7 +2109,7 @@ def main():
2097 2097
     optparser.add_option(      "--verbatim", dest="urlencoding_mode", action="store_const", const="verbatim", help="Use the S3 name as given on the command line. No pre-processing, encoding, etc. Use with caution!")
2098 2098
 
2099 2099
     optparser.add_option(      "--disable-multipart", dest="enable_multipart", action="store_false", help="Disable multipart upload on files bigger than --multipart-chunk-size-mb")
2100
-    optparser.add_option(      "--multipart-chunk-size-mb", dest="multipart_chunk_size_mb", type="int", action="store", metavar="SIZE", help="Size of each chunk of a multipart upload. Files bigger than SIZE are automatically uploaded as multithreaded-multipart, smaller files are uploaded using the traditional method. SIZE is in Mega-Bytes, default chunk size is %defaultMB, minimum allowed chunk size is 5MB, maximum is 5GB.")
2100
+    optparser.add_option(      "--multipart-chunk-size-mb", dest="multipart_chunk_size_mb", type="int", action="store", metavar="SIZE", help="Size of each chunk of a multipart upload. Files bigger than SIZE are automatically uploaded as multithreaded-multipart, smaller files are uploaded using the traditional method. SIZE is in Mega-Bytes, default chunk size is 15MB, minimum allowed chunk size is 5MB, maximum is 5GB.")
2101 2101
 
2102 2102
     optparser.add_option(      "--list-md5", dest="list_md5", action="store_true", help="Include MD5 sums in bucket listings (only for 'ls' command).")
2103 2103
     optparser.add_option("-H", "--human-readable-sizes", dest="human_readable_sizes", action="store_true", help="Print sizes in human readable form (eg 1kB instead of 1234).")
... ...
@@ -2105,8 +2117,8 @@ def main():
2105 2105
     optparser.add_option(      "--ws-index", dest="website_index", action="store", help="Name of index-document (only for [ws-create] command)")
2106 2106
     optparser.add_option(      "--ws-error", dest="website_error", action="store", help="Name of error-document (only for [ws-create] command)")
2107 2107
 
2108
-    optparser.add_option(      "--expiry-date", dest="expiry_date", action="store", help="Indicates when the expiration rule take effect. (only for [expire] comman)")
2109
-    optparser.add_option(      "--expiry-days", dest="expiry_days", action="store", help="Indicates the number of days after object creation the expiration rule take effect. (only for [expire] command)")
2108
+    optparser.add_option(      "--expiry-date", dest="expiry_date", action="store", help="Indicates when the expiration rule takes effect. (only for [expire] command)")
2109
+    optparser.add_option(      "--expiry-days", dest="expiry_days", action="store", help="Indicates the number of days after object creation the expiration rule takes effect. (only for [expire] command)")
2110 2110
     optparser.add_option(      "--expiry-prefix", dest="expiry_prefix", action="store", help="Identifying one or more objects with the prefix to which the expiration rule applies. (only for [expire] command)")
2111 2111
 
2112 2112
     optparser.add_option(      "--progress", dest="progress_meter", action="store_true", help="Display progress meter (default on TTY).")
... ...
@@ -2135,7 +2147,7 @@ def main():
2135 2135
         '"buckets" and uploading, downloading and removing '+
2136 2136
         '"objects" from these buckets.')
2137 2137
     optparser.epilog = format_commands(optparser.get_prog_name(), commands_list)
2138
-    optparser.epilog += ("\nFor more information see the project homepage:\n%s\n" % PkgInfo.url)
2138
+    optparser.epilog += ("\nFor more information, updates and news, visit the s3cmd website:\n%s\n" % PkgInfo.url)
2139 2139
     optparser.epilog += ("\nConsider a donation if you have found s3cmd useful:\n%s/donate\n" % PkgInfo.url)
2140 2140
 
2141 2141
     (options, args) = optparser.parse_args()
... ...
@@ -58,6 +58,9 @@ Get various information about Buckets or Files
58 58
 s3cmd \fBcp\fR \fIs3://BUCKET1/OBJECT1 s3://BUCKET2[/OBJECT2]\fR
59 59
 Copy object
60 60
 .TP
61
+s3cmd \fBmodify\fR \fIs3://BUCKET1/OBJECT\fR
62
+Modify object metadata
63
+.TP
61 64
 s3cmd \fBmv\fR \fIs3://BUCKET1/OBJECT1 s3://BUCKET2[/OBJECT2]\fR
62 65
 Move object
63 66
 .TP
... ...
@@ -149,7 +152,7 @@ to a specific bucket instead of attempting to list
149 149
 them all.
150 150
 .TP
151 151
 \fB\-c\fR FILE, \fB\-\-config\fR=FILE
152
-Config file name. Defaults to /home/mdomsch/.s3cfg
152
+Config file name. Defaults to /home/user/.s3cfg
153 153
 .TP
154 154
 \fB\-\-dump\-config\fR
155 155
 Dump current configuration after parsing config files
... ...
@@ -338,8 +341,8 @@ Force MIME-type. Override both \fB--default-mime-type\fR and
338 338
 .TP
339 339
 \fB\-\-add\-header\fR=NAME:VALUE
340 340
 Add a given HTTP header to the upload request. Can be
341
-used multiple times. For instance set 'Expires' or 'Cache-Control' headers (or both) using this options
342
-if you like.
341
+used multiple times. For instance set 'Expires' or
342
+'Cache-Control' headers (or both) using this option.
343 343
 .TP
344 344
 \fB\-\-server\-side\-encryption\fR
345 345
 Specifies that server-side encryption will be used
... ...
@@ -366,8 +369,8 @@ Size of each chunk of a multipart upload. Files bigger
366 366
 than SIZE are automatically uploaded as multithreaded-
367 367
 multipart, smaller files are uploaded using the
368 368
 traditional method. SIZE is in Mega-Bytes, default
369
-chunk size is noneMB, minimum allowed chunk size is
370
-5MB, maximum is 5GB.
369
+chunk size is 15MB, minimum allowed chunk size is 5MB,
370
+maximum is 5GB.
371 371
 .TP
372 372
 \fB\-\-list\-md5\fR
373 373
 Include MD5 sums in bucket listings (only for 'ls'
... ...
@@ -384,12 +387,12 @@ Name of index-document (only for [ws-create] command)
384 384
 Name of error-document (only for [ws-create] command)
385 385
 .TP
386 386
 \fB\-\-expiry\-date\fR=EXPIRY_DATE
387
-Indicates when the expiration rule take effect. (only
387
+Indicates when the expiration rule takes effect. (only
388 388
 for [expire] command)
389 389
 .TP
390 390
 \fB\-\-expiry\-days\fR=EXPIRY_DAYS
391 391
 Indicates the number of days after object creation the
392
-expiration rule take effect. (only for [expire]
392
+expiration rule takes effect. (only for [expire]
393 393
 command)
394 394
 .TP
395 395
 \fB\-\-expiry\-prefix\fR=EXPIRY_PREFIX
... ...
@@ -547,27 +550,38 @@ To exclude local directory 'somedir', be sure to use a trailing forward slash, a
547 547
 .PP
548 548
 
549 549
 .SH SEE ALSO
550
-For the most up to date list of options run 
550
+For the most up to date list of options run: 
551 551
 .B s3cmd \-\-help
552 552
 .br
553
-For more info about usage, examples and other related info visit project homepage at
554
-.br
553
+For more info about usage, examples and other related info visit project homepage at:
555 554
 .B http://s3tools.org
556 555
 .SH DONATIONS
557 556
 Please consider a donation if you have found s3cmd useful:
558 557
 .br
559 558
 .B http://s3tools.org/donate
560 559
 .SH AUTHOR
561
-Written by Michal Ludvig <mludvig@logix.net.nz> and 15+ contributors
560
+Written by Michal Ludvig and contributors
562 561
 .SH CONTACT, SUPPORT
563 562
 Preferred way to get support is our mailing list:
563
+.br
564 564
 .I s3tools\-general@lists.sourceforge.net
565
+.br
566
+or visit the project homepage:
567
+.br
568
+.B http://s3tools.org
565 569
 .SH REPORTING BUGS
566 570
 Report bugs to 
567 571
 .I s3tools\-bugs@lists.sourceforge.net
568 572
 .SH COPYRIGHT
569
-Copyright \(co 2007,2008,2009,2010,2011,2012 Michal Ludvig <http://www.logix.cz/michal>
573
+Copyright \(co 2007-2014 TGRMN Software - http://www.tgrmn.com - and contributors
574
+.br
575
+.SH LICENSE
576
+This program is free software; you can redistribute it and/or modify
577
+it under the terms of the GNU General Public License as published by
578
+the Free Software Foundation; either version 2 of the License, or
579
+(at your option) any later version.
580
+This program is distributed in the hope that it will be useful,
581
+but WITHOUT ANY WARRANTY; without even the implied warranty of
582
+MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
583
+GNU General Public License for more details.
570 584
 .br
571
-This is free software.  You may redistribute copies of it under the terms of
572
-the GNU General Public License version 2 <http://www.gnu.org/licenses/gpl.html>.
573
-There is NO WARRANTY, to the extent permitted by law.