Browse code

Updated s3cmd.1 manpage

Michal Ludvig authored on 2013/02/19 09:09:40
Showing 1 changed files
... ...
@@ -57,28 +57,17 @@ Move object
57 57
 s3cmd \fBsetacl\fR \fIs3://BUCKET[/OBJECT]\fR
58 58
 Modify Access control list for Bucket or Files
59 59
 .TP
60
+s3cmd \fBsetpolicy\fR \fIs3://BUCKET POLICY_STRING\fR
61
+Set an access policy for a bucket
62
+.TP
60 63
 s3cmd \fBaccesslog\fR \fIs3://BUCKET\fR
61 64
 Enable/disable bucket access logging
62 65
 .TP
63 66
 s3cmd \fBsign\fR \fISTRING-TO-SIGN\fR
64 67
 Sign arbitrary string using the secret key
65 68
 .TP
66
-s3cmd \fBsignurl\fR \fIs3://BUCKET[/OBJECT]\fR \fIexpiry-in-epoch-seconds\fR
67
-Sign an S3 URL with the secret key, producing a URL that allows access to
68
-the named object using the credentials used to sign the URL until the date of
69
-expiry specified in epoch-seconds has passed. This is most useful for publishing
70
-time- or distribution-limited URLs to otherwise-private S3 objects.
71
-.br
72
-This is a purely offline operation. Your API key and secret are not sent on
73
-the wire, though your public API key is included in the generated URL. Because
74
-it's offline, no validation is done to ensure that the bucket and object actually
75
-exist, or that this API key has permission to access them.
76
-.br
77
-The URL generated is http:// but you can simply change to https:// if you want.
78
-.br
79
-See
80
-.B http://s3.amazonaws.com/doc/s3-developer-guide/RESTAuthentication.html
81
-for more information on signed URLs, and the examples section below.
69
+s3cmd \fBsignurl\fR \fIs3://BUCKET/OBJECT expiry_epoch\fR
70
+Sign an S3 URL to provide limited public access with expiry
82 71
 .TP
83 72
 s3cmd \fBfixbucket\fR \fIs3://BUCKET[/PREFIX]\fR
84 73
 Fix invalid file names in a bucket
... ...
@@ -132,23 +121,22 @@ changes you like.
132 132
 show this help message and exit
133 133
 .TP
134 134
 \fB\-\-configure\fR
135
-Invoke interactive (re)configuration tool. Optionally
136
-use as '\fB--configure\fR s3://come-bucket' to test access
137
-to a specific bucket instead of attempting to list
138
-them all.
135
+Invoke interactive (re)configuration tool. Optionally use as '--configure s3://come-bucket' to test access to a specific bucket instead of attempting to list them all.
139 136
 .TP
140 137
 \fB\-c\fR FILE, \fB\-\-config\fR=FILE
141 138
 Config file name. Defaults to /home/mludvig/.s3cfg
142 139
 .TP
143 140
 \fB\-\-dump\-config\fR
144
-Dump current configuration after parsing config files
145
-and command line options and exit.
141
+Dump current configuration after parsing config files and command line options and exit.
142
+.TP
143
+\fB\-\-access_key\fR=ACCESS_KEY
144
+AWS Access Key
145
+.TP
146
+\fB\-\-secret_key\fR=SECRET_KEY
147
+AWS Secret Key
146 148
 .TP
147 149
 \fB\-n\fR, \fB\-\-dry\-run\fR
148
-Only show what should be uploaded or downloaded but
149
-don't actually do it. May still perform S3 requests to
150
-get bucket listings and other information though (only
151
-for file transfer commands)
150
+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)
152 151
 .TP
153 152
 \fB\-e\fR, \fB\-\-encrypt\fR
154 153
 Encrypt files before uploading to S3.
... ...
@@ -160,158 +148,128 @@ Don't encrypt files.
160 160
 Force overwrite and other dangerous operations.
161 161
 .TP
162 162
 \fB\-\-continue\fR
163
-Continue getting a partially downloaded file (only for
164
-[get] command).
163
+Continue getting a partially downloaded file (only for [get] command).
165 164
 .TP
166 165
 \fB\-\-skip\-existing\fR
167
-Skip over files that exist at the destination (only
168
-for [get] and [sync] commands).
166
+Skip over files that exist at the destination (only for [get] and [sync] commands).
169 167
 .TP
170 168
 \fB\-r\fR, \fB\-\-recursive\fR
171 169
 Recursive upload, download or removal.
172 170
 .TP
173 171
 \fB\-\-check\-md5\fR
174
-Check MD5 sums when comparing files for [sync].
175
-(default)
172
+Check MD5 sums when comparing files for [sync]. (default)
176 173
 .TP
177 174
 \fB\-\-no\-check\-md5\fR
178
-Do not check MD5 sums when comparing files for [sync].
179
-Only size will be compared. May significantly speed up
180
-transfer but may also miss some changed files.
175
+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.
181 176
 .TP
182 177
 \fB\-P\fR, \fB\-\-acl\-public\fR
183 178
 Store objects with ACL allowing read for anyone.
184 179
 .TP
185 180
 \fB\-\-acl\-private\fR
186
-Store objects with default ACL allowing access for you
187
-only.
181
+Store objects with default ACL allowing access for you only.
188 182
 .TP
189 183
 \fB\-\-acl\-grant\fR=PERMISSION:EMAIL or USER_CANONICAL_ID
190
-Grant stated permission to a given amazon user.
191
-Permission is one of: read, write, read_acp,
192
-write_acp, full_control, all
184
+Grant stated permission to a given amazon user. Permission is one of: read, write, read_acp, write_acp, full_control, all
193 185
 .TP
194 186
 \fB\-\-acl\-revoke\fR=PERMISSION:USER_CANONICAL_ID
195
-Revoke stated permission for a given amazon user.
196
-Permission is one of: read, write, read_acp, wr
197
-ite_acp, full_control, all
187
+Revoke stated permission for a given amazon user. Permission is one of: read, write, read_acp, wr     ite_acp, full_control, all
198 188
 .TP
199 189
 \fB\-\-delete\-removed\fR
200
-Delete remote objects with no corresponding local file
201
-[sync]
190
+Delete remote objects with no corresponding local file [sync]
202 191
 .TP
203 192
 \fB\-\-no\-delete\-removed\fR
204 193
 Don't delete remote objects.
205 194
 .TP
206 195
 \fB\-\-delete\-after\fR
207
-Perform deletes after new uploads [sync].
196
+Perform deletes after new uploads [sync]
208 197
 .TP
209 198
 \fB\-\-delay\-updates\fR
210 199
 Put all updated files into place at end [sync]
211 200
 .TP
201
+\fB\-\-add\-destination\fR=ADDITIONAL_DESTINATIONS
202
+Additional destination for parallel uploads, in addition to last arg.  May be repeated.
203
+.TP
204
+\fB\-\-delete\-after\-fetch\fR
205
+Delete remote objects after fetching to local file (only for [get] and [sync] commands).
206
+.TP
212 207
 \fB\-p\fR, \fB\-\-preserve\fR
213
-Preserve filesystem attributes (mode, ownership,
214
-timestamps). Default for [sync] command.
208
+Preserve filesystem attributes (mode, ownership, timestamps). Default for [sync] command.
215 209
 .TP
216 210
 \fB\-\-no\-preserve\fR
217 211
 Don't store FS attributes
218 212
 .TP
219 213
 \fB\-\-exclude\fR=GLOB
220
-Filenames and paths matching GLOB will be excluded
221
-from sync
214
+Filenames and paths matching GLOB will be excluded from sync
222 215
 .TP
223 216
 \fB\-\-exclude\-from\fR=FILE
224 217
 Read --exclude GLOBs from FILE
225 218
 .TP
226 219
 \fB\-\-rexclude\fR=REGEXP
227
-Filenames and paths matching REGEXP (regular
228
-expression) will be excluded from sync
220
+Filenames and paths matching REGEXP (regular expression) will be excluded from sync
229 221
 .TP
230 222
 \fB\-\-rexclude\-from\fR=FILE
231 223
 Read --rexclude REGEXPs from FILE
232 224
 .TP
233 225
 \fB\-\-include\fR=GLOB
234
-Filenames and paths matching GLOB will be included
235
-even if previously excluded by one of
236
-\fB--(r)exclude(-from)\fR patterns
226
+Filenames and paths matching GLOB will be included even if previously excluded by one of --(r)exclude(-from) patterns
237 227
 .TP
238 228
 \fB\-\-include\-from\fR=FILE
239 229
 Read --include GLOBs from FILE
240 230
 .TP
241 231
 \fB\-\-rinclude\fR=REGEXP
242
-Same as --include but uses REGEXP (regular expression)
243
-instead of GLOB
232
+Same as --include but uses REGEXP (regular expression) instead of GLOB
244 233
 .TP
245 234
 \fB\-\-rinclude\-from\fR=FILE
246 235
 Read --rinclude REGEXPs from FILE
247 236
 .TP
248 237
 \fB\-\-bucket\-location\fR=BUCKET_LOCATION
249
-Datacentre to create bucket in. As of now the
250
-datacenters are: US (default), EU, us-west-1, and ap-
251
-southeast-1
238
+Datacentre to create bucket in. As of now the datacenters are: US (default), EU, ap-northeast-1, ap-southeast-1, sa-east-1, us-west-1 and us-west-2
252 239
 .TP
253 240
 \fB\-\-reduced\-redundancy\fR, \fB\-\-rr\fR
254
-Store object with 'Reduced redundancy'. Lower per-GB
255
-price. [put, cp, mv]
241
+Store object with 'Reduced redundancy'. Lower per-GB price. [put, cp, mv]
256 242
 .TP
257 243
 \fB\-\-access\-logging\-target\-prefix\fR=LOG_TARGET_PREFIX
258
-Target prefix for access logs (S3 URI) (for [cfmodify]
259
-and [accesslog] commands)
244
+Target prefix for access logs (S3 URI) (for [cfmodify] and [accesslog] commands)
260 245
 .TP
261 246
 \fB\-\-no\-access\-logging\fR
262
-Disable access logging (for [cfmodify] and [accesslog]
263
-commands)
247
+Disable access logging (for [cfmodify] and [accesslog] commands)
264 248
 .TP
265 249
 \fB\-\-default\-mime\-type\fR
266
-Default MIME-type for stored objects. Application
267
-default is binary/octet-stream.
250
+Default MIME-type for stored objects. Application default is binary/octet-stream.
268 251
 .TP
269
-\fB\-\-guess\-mime\-type\fR
270
-Guess MIME-type of files by their extension or mime
271
-magic. Fall back to default MIME-Type as specified by
272
-\fB--default-mime-type\fR option
252
+\fB\-M\fR, \fB\-\-guess\-mime\-type\fR
253
+Guess MIME-type of files by their extension or mime magic. Fall back to default MIME-Type as specified by \fB--default-mime-type\fR option
273 254
 .TP
274 255
 \fB\-\-no\-guess\-mime\-type\fR
275
-Don't guess MIME-type and use the default type
276
-instead.
256
+Don't guess MIME-type and use the default type instead.
277 257
 .TP
278 258
 \fB\-m\fR MIME/TYPE, \fB\-\-mime\-type\fR=MIME/TYPE
279
-Force MIME-type. Override both \fB--default-mime-type\fR and
280
-\fB--guess-mime-type\fR.
259
+Force MIME-type. Override both \fB--default-mime-type\fR and \fB--guess-mime-type\fR.
281 260
 .TP
282 261
 \fB\-\-add\-header\fR=NAME:VALUE
283
-Add a given HTTP header to the upload request. Can be
284
-used multiple times. For instance set 'Expires' or
285
-'Cache-Control' headers (or both) using this options
286
-if you like.
262
+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.
287 263
 .TP
288 264
 \fB\-\-encoding\fR=ENCODING
289
-Override autodetected terminal and filesystem encoding
290
-(character set). Autodetected: UTF-8
265
+Override autodetected terminal and filesystem encoding (character set). Autodetected: UTF-8
266
+.TP
267
+\fB\-\-add\-encoding\-exts\fR=EXTENSIONs
268
+Add encoding to these comma delimited extensions i.e. (css,js,html) when uploading to S3 )
291 269
 .TP
292 270
 \fB\-\-verbatim\fR
293
-Use the S3 name as given on the command line. No pre-
294
-processing, encoding, etc. Use with caution!
271
+Use the S3 name as given on the command line. No pre-processing, encoding, etc. Use with caution!
295 272
 .TP
296 273
 \fB\-\-disable\-multipart\fR
297
-Disable multipart upload on files bigger than
298
-\fB--multipart-chunk-size-mb\fR
274
+Disable multipart upload on files bigger than --multipart-chunk-size-mb
299 275
 .TP
300 276
 \fB\-\-multipart\-chunk\-size\-mb\fR=SIZE
301
-Size of each chunk of a multipart upload. Files bigger
302
-than SIZE are automatically uploaded as multithreaded-
303
-multipart, smaller files are uploaded using the
304
-traditional method. SIZE is in Mega-Bytes, default
305
-chunk size is noneMB, minimum allowed chunk size is
306
-5MB, maximum is 5GB.
277
+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,
278
+default chunk size is noneMB, minimum allowed chunk size is 5MB, maximum is 5GB.
307 279
 .TP
308 280
 \fB\-\-list\-md5\fR
309
-Include MD5 sums in bucket listings (only for 'ls'
310
-command).
281
+Include MD5 sums in bucket listings (only for 'ls' command).
311 282
 .TP
312 283
 \fB\-H\fR, \fB\-\-human\-readable\-sizes\fR
313
-Print sizes in human readable form (eg 1kB instead of
314
-1234).
284
+Print sizes in human readable form (eg 1kB instead of 1234).
315 285
 .TP
316 286
 \fB\-\-ws\-index\fR=WEBSITE_INDEX
317 287
 Name of error-document (only for [ws-create] command)
... ...
@@ -326,35 +284,32 @@ Display progress meter (default on TTY).
326 326
 Don't display progress meter (default on non-TTY).
327 327
 .TP
328 328
 \fB\-\-enable\fR
329
-Enable given CloudFront distribution (only for
330
-[cfmodify] command)
329
+Enable given CloudFront distribution (only for [cfmodify] command)
331 330
 .TP
332 331
 \fB\-\-disable\fR
333
-Enable given CloudFront distribution (only for
334
-[cfmodify] command)
332
+Enable given CloudFront distribution (only for [cfmodify] command)
335 333
 .TP
336 334
 \fB\-\-cf\-invalidate\fR
337
-Invalidate the uploaded filed in CloudFront. Also see
338
-[cfinval] command.
335
+Invalidate the uploaded filed in CloudFront. Also see [cfinval] command.
336
+.TP
337
+\fB\-\-cf\-invalidate\-default\-index\fR
338
+When using Custom Origin and S3 static website, invalidate the default index file.
339
+.TP
340
+\fB\-\-cf\-no\-invalidate\-default\-index\-root\fR
341
+When using Custom Origin and S3 static website, don't invalidate the path to the default index file.
339 342
 .TP
340 343
 \fB\-\-cf\-add\-cname\fR=CNAME
341
-Add given CNAME to a CloudFront distribution (only for
342
-[cfcreate] and [cfmodify] commands)
344
+Add given CNAME to a CloudFront distribution (only for [cfcreate] and [cfmodify] commands)
343 345
 .TP
344 346
 \fB\-\-cf\-remove\-cname\fR=CNAME
345
-Remove given CNAME from a CloudFront distribution
346
-(only for [cfmodify] command)
347
+Remove given CNAME from a CloudFront distribution (only for [cfmodify] command)
347 348
 .TP
348 349
 \fB\-\-cf\-comment\fR=COMMENT
349
-Set COMMENT for a given CloudFront distribution (only
350
-for [cfcreate] and [cfmodify] commands)
350
+Set COMMENT for a given CloudFront distribution (only for [cfcreate] and [cfmodify] commands)
351 351
 .TP
352 352
 \fB\-\-cf\-default\-root\-object\fR=DEFAULT_ROOT_OBJECT
353
-Set the default root object to return when no object
354
-is specified in the URL. Use a relative path, i.e.
355
-default/index.html instead of /default/index.html or
356
-s3://bucket/default/index.html (only for [cfcreate]
357
-and [cfmodify] commands)
353
+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
354
+[cfcreate] and [cfmodify] commands)
358 355
 .TP
359 356
 \fB\-v\fR, \fB\-\-verbose\fR
360 357
 Enable verbose output.
... ...
@@ -363,10 +318,13 @@ Enable verbose output.
363 363
 Enable debug output.
364 364
 .TP
365 365
 \fB\-\-version\fR
366
-Show s3cmd version (1.1.0-beta3) and exit.
366
+Show s3cmd version (1.5.0-alpha1) and exit.
367 367
 .TP
368 368
 \fB\-F\fR, \fB\-\-follow\-symlinks\fR
369 369
 Follow symbolic links as if they are regular files
370
+.TP
371
+\fB\-\-cache\-file\fR=FILE
372
+Cache FILE containing local source MD5 values
370 373
 
371 374
 
372 375
 .SH EXAMPLES
... ...
@@ -444,12 +402,6 @@ about matching file names against exclude and include rules.
444 444
 For example to exclude all files with ".jpg" extension except those beginning with a number use:
445 445
 .PP
446 446
 	\-\-exclude '*.jpg' \-\-rinclude '[0-9].*\.jpg'
447
-.PP
448
-To produce a signed HTTP URL that allows access to the normally private s3 object
449
-s3://mybucket/someobj (which you must have permission to access) to anybody
450
-with the URL for one week from today, use:
451
-.PP
452
-        s3cmd signurl s3://mybucket/someobj `date -d 'today + 1 week' +%s` 
453 447
 .SH SEE ALSO
454 448
 For the most up to date list of options run 
455 449
 .B s3cmd \-\-help