Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 455 lines (444 sloc) 13.801 kb
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
1
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
2 .TH s3cmd 1
3 .SH NAME
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
4 s3cmd \- tool for managing Amazon S3 storage space and Amazon CloudFront content delivery network
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
5 .SH SYNOPSIS
6 .B s3cmd
7 [\fIOPTIONS\fR] \fICOMMAND\fR [\fIPARAMETERS\fR]
8 .SH DESCRIPTION
9 .PP
10 .B s3cmd
11 is a command line client for copying files to/from
12 Amazon S3 (Simple Storage Service) and performing other
13 related tasks, for instance creating and removing buckets,
14 listing objects, etc.
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
15
16 .SH COMMANDS
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
17 .PP
18 .B s3cmd
19 can do several \fIactions\fR specified by the following \fIcommands\fR.
20 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
21 s3cmd \fBmb\fR \fIs3://BUCKET\fR
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
22 Make bucket
23 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
24 s3cmd \fBrb\fR \fIs3://BUCKET\fR
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
25 Remove bucket
26 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
27 s3cmd \fBls\fR \fI[s3://BUCKET[/PREFIX]]\fR
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
28 List objects or buckets
29 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
30 s3cmd \fBla\fR \fI\fR
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
31 List all object in all buckets
32 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
33 s3cmd \fBput\fR \fIFILE [FILE...] s3://BUCKET[/PREFIX]\fR
34 Put file into bucket
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
35 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
36 s3cmd \fBget\fR \fIs3://BUCKET/OBJECT LOCAL_FILE\fR
37 Get file from bucket
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
38 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
39 s3cmd \fBdel\fR \fIs3://BUCKET/OBJECT\fR
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
40 Delete file from bucket
f298b34 @mludvig 2007-05-26 Michal Ludvig <michal@logix.cz>
mludvig authored
41 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
42 s3cmd \fBsync\fR \fILOCAL_DIR s3://BUCKET[/PREFIX] or s3://BUCKET[/PREFIX] LOCAL_DIR\fR
43 Synchronize a directory tree to S3
44 .TP
45 s3cmd \fBdu\fR \fI[s3://BUCKET[/PREFIX]]\fR
46 Disk usage by buckets
47 .TP
48 s3cmd \fBinfo\fR \fIs3://BUCKET[/OBJECT]\fR
49 Get various information about Buckets or Files
50 .TP
51 s3cmd \fBcp\fR \fIs3://BUCKET1/OBJECT1 s3://BUCKET2[/OBJECT2]\fR
52 Copy object
29893af @mludvig * S3/PkgInfo.py: Bumped up version to 0.9.7
mludvig authored
53 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
54 s3cmd \fBmv\fR \fIs3://BUCKET1/OBJECT1 s3://BUCKET2[/OBJECT2]\fR
55 Move object
7393bdb @mludvig * s3cmd, s3cmd.1: Updated help and man page.
mludvig authored
56 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
57 s3cmd \fBsetacl\fR \fIs3://BUCKET[/OBJECT]\fR
58 Modify Access control list for Bucket or Files
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
59 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
60 s3cmd \fBaccesslog\fR \fIs3://BUCKET\fR
61 Enable/disable bucket access logging
7393bdb @mludvig * s3cmd, s3cmd.1: Updated help and man page.
mludvig authored
62 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
63 s3cmd \fBsign\fR \fISTRING-TO-SIGN\fR
64 Sign arbitrary string using the secret key
65 .TP
66 s3cmd \fBfixbucket\fR \fIs3://BUCKET[/PREFIX]\fR
67 Fix invalid file names in a bucket
6063e01 @mludvig Released version 1.1.0-beta2
mludvig authored
68
69
70 .PP
71 Commands for static WebSites configuration
a76d2f3 @mludvig Updated s3cmd.1 manpage with the latest options.
mludvig authored
72 .TP
73 s3cmd \fBws-create\fR \fIs3://BUCKET\fR
74 Create Website from bucket
75 .TP
76 s3cmd \fBws-delete\fR \fIs3://BUCKET\fR
77 Delete Website
78 .TP
79 s3cmd \fBws-info\fR \fIs3://BUCKET\fR
80 Info about Website
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
81
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
82
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
83 .PP
84 Commands for CloudFront management
85 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
86 s3cmd \fBcflist\fR \fI\fR
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
87 List CloudFront distribution points
88 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
89 s3cmd \fBcfinfo\fR \fI[cf://DIST_ID]\fR
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
90 Display CloudFront distribution point parameters
91 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
92 s3cmd \fBcfcreate\fR \fIs3://BUCKET\fR
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
93 Create CloudFront distribution point
94 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
95 s3cmd \fBcfdelete\fR \fIcf://DIST_ID\fR
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
96 Delete CloudFront distribution point
97 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
98 s3cmd \fBcfmodify\fR \fIcf://DIST_ID\fR
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
99 Change CloudFront distribution point parameters
d065ce3 @mludvig Released version 1.1.0-beta1
mludvig authored
100 .TP
101 s3cmd \fBcfinvalinfo\fR \fIcf://DIST_ID[/INVAL_ID]\fR
102 Display CloudFront invalidation request(s) status
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
103
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
104
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
105 .SH OPTIONS
106 .PP
107 Some of the below specified options can have their default
108 values set in
109 .B s3cmd
110 config file (by default $HOME/.s3cmd). As it's a simple text file
111 feel free to open it with your favorite text editor and do any
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
112 changes you like.
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
113 .TP
114 \fB\-h\fR, \fB\-\-help\fR
115 show this help message and exit
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
116 .TP
bf42f42 @mludvig 2007-06-16 Michal Ludvig <michal@logix.cz>
mludvig authored
117 \fB\-\-configure\fR
3234ccf @mludvig Small improvements for --configure s3://bucket
mludvig authored
118 Invoke interactive (re)configuration tool. Optionally
6063e01 @mludvig Released version 1.1.0-beta2
mludvig authored
119 use as '\fB--configure\fR s3://come-bucket' to test access
3234ccf @mludvig Small improvements for --configure s3://bucket
mludvig authored
120 to a specific bucket instead of attempting to list
121 them all.
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
122 .TP
bf42f42 @mludvig 2007-06-16 Michal Ludvig <michal@logix.cz>
mludvig authored
123 \fB\-c\fR FILE, \fB\-\-config\fR=FILE
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
124 Config file name. Defaults to /home/mludvig/.s3cfg
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
125 .TP
bf42f42 @mludvig 2007-06-16 Michal Ludvig <michal@logix.cz>
mludvig authored
126 \fB\-\-dump\-config\fR
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
127 Dump current configuration after parsing config files
128 and command line options and exit.
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
129 .TP
130 \fB\-n\fR, \fB\-\-dry\-run\fR
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
131 Only show what should be uploaded or downloaded but
132 don't actually do it. May still perform S3 requests to
133 get bucket listings and other information though (only
134 for file transfer commands)
135 .TP
136 \fB\-e\fR, \fB\-\-encrypt\fR
137 Encrypt files before uploading to S3.
138 .TP
139 \fB\-\-no\-encrypt\fR
140 Don't encrypt files.
141 .TP
142 \fB\-f\fR, \fB\-\-force\fR
143 Force overwrite and other dangerous operations.
144 .TP
145 \fB\-\-continue\fR
146 Continue getting a partially downloaded file (only for
147 [get] command).
148 .TP
149 \fB\-\-skip\-existing\fR
150 Skip over files that exist at the destination (only
151 for [get] and [sync] commands).
152 .TP
153 \fB\-r\fR, \fB\-\-recursive\fR
154 Recursive upload, download or removal.
155 .TP
da0fb7b @mludvig * s3cmd, s3cmd.1, format-manpage.pl: Improved --help text
mludvig authored
156 \fB\-\-check\-md5\fR
157 Check MD5 sums when comparing files for [sync].
158 (default)
159 .TP
160 \fB\-\-no\-check\-md5\fR
161 Do not check MD5 sums when comparing files for [sync].
162 Only size will be compared. May significantly speed up
163 transfer but may also miss some changed files.
164 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
165 \fB\-P\fR, \fB\-\-acl\-public\fR
166 Store objects with ACL allowing read for anyone.
167 .TP
168 \fB\-\-acl\-private\fR
169 Store objects with default ACL allowing access for you
170 only.
171 .TP
172 \fB\-\-acl\-grant\fR=PERMISSION:EMAIL or USER_CANONICAL_ID
173 Grant stated permission to a given amazon user.
174 Permission is one of: read, write, read_acp,
175 write_acp, full_control, all
176 .TP
177 \fB\-\-acl\-revoke\fR=PERMISSION:USER_CANONICAL_ID
178 Revoke stated permission for a given amazon user.
179 Permission is one of: read, write, read_acp, wr
180 ite_acp, full_control, all
7393bdb @mludvig * s3cmd, s3cmd.1: Updated help and man page.
mludvig authored
181 .TP
182 \fB\-\-delete\-removed\fR
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
183 Delete remote objects with no corresponding local file
184 [sync]
7393bdb @mludvig * s3cmd, s3cmd.1: Updated help and man page.
mludvig authored
185 .TP
186 \fB\-\-no\-delete\-removed\fR
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
187 Don't delete remote objects.
7393bdb @mludvig * s3cmd, s3cmd.1: Updated help and man page.
mludvig authored
188 .TP
d5dc2c0 @mdomsch add --delete-after option for sync
authored
189 \fB\-\-delete\-after\fR
190 Perform deletes after new uploads [sync].
191 .TP
c3deb6a @mdomsch add --delay-updates option
authored
192 \fB\-\-delay\-updates\fR
193 Put all updated files into place at end [sync]
194 .TP
7393bdb @mludvig * s3cmd, s3cmd.1: Updated help and man page.
mludvig authored
195 \fB\-p\fR, \fB\-\-preserve\fR
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
196 Preserve filesystem attributes (mode, ownership,
197 timestamps). Default for [sync] command.
7393bdb @mludvig * s3cmd, s3cmd.1: Updated help and man page.
mludvig authored
198 .TP
199 \fB\-\-no\-preserve\fR
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
200 Don't store FS attributes
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
201 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
202 \fB\-\-exclude\fR=GLOB
203 Filenames and paths matching GLOB will be excluded
204 from sync
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
205 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
206 \fB\-\-exclude\-from\fR=FILE
207 Read --exclude GLOBs from FILE
2d7d554 @mludvig * s3cmd, s3cmd.1: Added GLOB (shell-style wildcard) exclude, renamed
mludvig authored
208 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
209 \fB\-\-rexclude\fR=REGEXP
210 Filenames and paths matching REGEXP (regular
211 expression) will be excluded from sync
2d7d554 @mludvig * s3cmd, s3cmd.1: Added GLOB (shell-style wildcard) exclude, renamed
mludvig authored
212 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
213 \fB\-\-rexclude\-from\fR=FILE
214 Read --rexclude REGEXPs from FILE
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
215 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
216 \fB\-\-include\fR=GLOB
217 Filenames and paths matching GLOB will be included
218 even if previously excluded by one of
6063e01 @mludvig Released version 1.1.0-beta2
mludvig authored
219 \fB--(r)exclude(-from)\fR patterns
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
220 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
221 \fB\-\-include\-from\fR=FILE
222 Read --include GLOBs from FILE
18c4a15 @mludvig 2007-08-14 Michal Ludvig <michal@logix.cz>
mludvig authored
223 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
224 \fB\-\-rinclude\fR=REGEXP
225 Same as --include but uses REGEXP (regular expression)
226 instead of GLOB
6454bfb @redsymbol Manual page documentation for --follow-symlinks
redsymbol authored
227 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
228 \fB\-\-rinclude\-from\fR=FILE
229 Read --rinclude REGEXPs from FILE
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
230 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
231 \fB\-\-bucket\-location\fR=BUCKET_LOCATION
232 Datacentre to create bucket in. As of now the
233 datacenters are: US (default), EU, us-west-1, and ap-
234 southeast-1
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
235 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
236 \fB\-\-reduced\-redundancy\fR, \fB\-\-rr\fR
237 Store object with 'Reduced redundancy'. Lower per-GB
238 price. [put, cp, mv]
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
239 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
240 \fB\-\-access\-logging\-target\-prefix\fR=LOG_TARGET_PREFIX
241 Target prefix for access logs (S3 URI) (for [cfmodify]
242 and [accesslog] commands)
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
243 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
244 \fB\-\-no\-access\-logging\fR
245 Disable access logging (for [cfmodify] and [accesslog]
246 commands)
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
247 .TP
a76d2f3 @mludvig Updated s3cmd.1 manpage with the latest options.
mludvig authored
248 \fB\-\-default\-mime\-type\fR
249 Default MIME-type for stored objects. Application
250 default is binary/octet-stream.
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
251 .TP
6063e01 @mludvig Released version 1.1.0-beta2
mludvig authored
252 \fB\-\-guess\-mime\-type\fR
253 Guess MIME-type of files by their extension or mime
254 magic. Fall back to default MIME-Type as specified by
255 \fB--default-mime-type\fR option
a76d2f3 @mludvig Updated s3cmd.1 manpage with the latest options.
mludvig authored
256 .TP
257 \fB\-\-no\-guess\-mime\-type\fR
258 Don't guess MIME-type and use the default type
259 instead.
260 .TP
261 \fB\-m\fR MIME/TYPE, \fB\-\-mime\-type\fR=MIME/TYPE
6063e01 @mludvig Released version 1.1.0-beta2
mludvig authored
262 Force MIME-type. Override both \fB--default-mime-type\fR and
263 \fB--guess-mime-type\fR.
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
264 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
265 \fB\-\-add\-header\fR=NAME:VALUE
266 Add a given HTTP header to the upload request. Can be
267 used multiple times. For instance set 'Expires' or
268 'Cache-Control' headers (or both) using this options
269 if you like.
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
270 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
271 \fB\-\-encoding\fR=ENCODING
272 Override autodetected terminal and filesystem encoding
273 (character set). Autodetected: UTF-8
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
274 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
275 \fB\-\-verbatim\fR
276 Use the S3 name as given on the command line. No pre-
277 processing, encoding, etc. Use with caution!
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
278 .TP
6063e01 @mludvig Released version 1.1.0-beta2
mludvig authored
279 \fB\-\-disable\-multipart\fR
280 Disable multipart upload on files bigger than
281 \fB--multipart-chunk-size-mb\fR
282 .TP
283 \fB\-\-multipart\-chunk\-size\-mb\fR=SIZE
284 Size of each chunk of a multipart upload. Files bigger
285 than SIZE are automatically uploaded as multithreaded-
286 multipart, smaller files are uploaded using the
287 traditional method. SIZE is in Mega-Bytes, default
288 chunk size is noneMB, minimum allowed chunk size is
289 5MB, maximum is 5GB.
290 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
291 \fB\-\-list\-md5\fR
292 Include MD5 sums in bucket listings (only for 'ls'
293 command).
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
294 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
295 \fB\-H\fR, \fB\-\-human\-readable\-sizes\fR
296 Print sizes in human readable form (eg 1kB instead of
297 1234).
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
298 .TP
a76d2f3 @mludvig Updated s3cmd.1 manpage with the latest options.
mludvig authored
299 \fB\-\-ws\-index\fR=WEBSITE_INDEX
300 Name of error-document (only for [ws-create] command)
301 .TP
302 \fB\-\-ws\-error\fR=WEBSITE_ERROR
303 Name of index-document (only for [ws-create] command)
304 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
305 \fB\-\-progress\fR
306 Display progress meter (default on TTY).
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
307 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
308 \fB\-\-no\-progress\fR
309 Don't display progress meter (default on non-TTY).
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
310 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
311 \fB\-\-enable\fR
312 Enable given CloudFront distribution (only for
313 [cfmodify] command)
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
314 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
315 \fB\-\-disable\fR
316 Enable given CloudFront distribution (only for
317 [cfmodify] command)
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
318 .TP
d065ce3 @mludvig Released version 1.1.0-beta1
mludvig authored
319 \fB\-\-cf\-invalidate\fR
320 Invalidate the uploaded filed in CloudFront. Also see
321 [cfinval] command.
322 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
323 \fB\-\-cf\-add\-cname\fR=CNAME
324 Add given CNAME to a CloudFront distribution (only for
325 [cfcreate] and [cfmodify] commands)
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
326 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
327 \fB\-\-cf\-remove\-cname\fR=CNAME
328 Remove given CNAME from a CloudFront distribution
329 (only for [cfmodify] command)
25f6f8c @mludvig * s3cmd, s3cmd.1, S3/S3.py: Display or don't display progress meter
mludvig authored
330 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
331 \fB\-\-cf\-comment\fR=COMMENT
332 Set COMMENT for a given CloudFront distribution (only
333 for [cfcreate] and [cfmodify] commands)
334 .TP
335 \fB\-\-cf\-default\-root\-object\fR=DEFAULT_ROOT_OBJECT
336 Set the default root object to return when no object
337 is specified in the URL. Use a relative path, i.e.
338 default/index.html instead of /default/index.html or
339 s3://bucket/default/index.html (only for [cfcreate]
340 and [cfmodify] commands)
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
341 .TP
bf42f42 @mludvig 2007-06-16 Michal Ludvig <michal@logix.cz>
mludvig authored
342 \fB\-v\fR, \fB\-\-verbose\fR
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
343 Enable verbose output.
344 .TP
bf42f42 @mludvig 2007-06-16 Michal Ludvig <michal@logix.cz>
mludvig authored
345 \fB\-d\fR, \fB\-\-debug\fR
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
346 Enable debug output.
347 .TP
bf42f42 @mludvig 2007-06-16 Michal Ludvig <michal@logix.cz>
mludvig authored
348 \fB\-\-version\fR
7d047bd @mludvig Released version 1.1.0-beta3
mludvig authored
349 Show s3cmd version (1.1.0-beta3) and exit.
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
350 .TP
351 \fB\-F\fR, \fB\-\-follow\-symlinks\fR
352 Follow symbolic links as if they are regular files
353
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
354
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
355 .SH EXAMPLES
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
356 One of the most powerful commands of \fIs3cmd\fR is \fBs3cmd sync\fR used for
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
357 synchronising complete directory trees to or from remote S3 storage. To some extent
358 \fBs3cmd put\fR and \fBs3cmd get\fR share a similar behaviour with \fBsync\fR.
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
359 .PP
360 Basic usage common in backup scenarios is as simple as:
361 .nf
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
362 s3cmd sync /local/path/ s3://test-bucket/backup/
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
363 .fi
364 .PP
365 This command will find all files under /local/path directory and copy them
366 to corresponding paths under s3://test-bucket/backup on the remote side.
367 For example:
368 .nf
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
369 /local/path/\fBfile1.ext\fR \-> s3://bucket/backup/\fBfile1.ext\fR
370 /local/path/\fBdir123/file2.bin\fR \-> s3://bucket/backup/\fBdir123/file2.bin\fR
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
371 .fi
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
372 .PP
373 However if the local path doesn't end with a slash the last directory's name
374 is used on the remote side as well. Compare these with the previous example:
375 .nf
376 s3cmd sync /local/path s3://test-bucket/backup/
377 .fi
378 will sync:
379 .nf
380 /local/\fBpath/file1.ext\fR \-> s3://bucket/backup/\fBpath/file1.ext\fR
381 /local/\fBpath/dir123/file2.bin\fR \-> s3://bucket/backup/\fBpath/dir123/file2.bin\fR
382 .fi
383 .PP
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
384 To retrieve the files back from S3 use inverted syntax:
385 .nf
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
386 s3cmd sync s3://test-bucket/backup/ /tmp/restore/
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
387 .fi
388 that will download files:
389 .nf
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
390 s3://bucket/backup/\fBfile1.ext\fR \-> /tmp/restore/\fBfile1.ext\fR
391 s3://bucket/backup/\fBdir123/file2.bin\fR \-> /tmp/restore/\fBdir123/file2.bin\fR
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
392 .fi
2d7d554 @mludvig * s3cmd, s3cmd.1: Added GLOB (shell-style wildcard) exclude, renamed
mludvig authored
393 .PP
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
394 Without the trailing slash on source the behaviour is similar to
395 what has been demonstrated with upload:
396 .nf
397 s3cmd sync s3://test-bucket/backup /tmp/restore/
398 .fi
399 will download the files as:
400 .nf
401 s3://bucket/\fBbackup/file1.ext\fR \-> /tmp/restore/\fBbackup/file1.ext\fR
402 s3://bucket/\fBbackup/dir123/file2.bin\fR \-> /tmp/restore/\fBbackup/dir123/file2.bin\fR
403 .fi
404 .PP
405 All source file names, the bold ones above, are matched against \fBexclude\fR
406 rules and those that match are then re\-checked against \fBinclude\fR rules to see
407 whether they should be excluded or kept in the source list.
408 .PP
409 For the purpose of \fB\-\-exclude\fR and \fB\-\-include\fR matching only the
410 bold file names above are used. For instance only \fBpath/file1.ext\fR is tested
411 against the patterns, not \fI/local/\fBpath/file1.ext\fR
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
412 .PP
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
413 Both \fB\-\-exclude\fR and \fB\-\-include\fR work with shell-style wildcards (a.k.a. GLOB).
414 For a greater flexibility s3cmd provides Regular-expression versions of the two exclude options
415 named \fB\-\-rexclude\fR and \fB\-\-rinclude\fR.
416 The options with ...\fB\-from\fR suffix (eg \-\-rinclude\-from) expect a filename as
417 an argument. Each line of such a file is treated as one pattern.
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
418 .PP
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
419 There is only one set of patterns built from all \fB\-\-(r)exclude(\-from)\fR options
420 and similarly for include variant. Any file excluded with eg \-\-exclude can
421 be put back with a pattern found in \-\-rinclude\-from list.
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
422 .PP
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
423 Run s3cmd with \fB\-\-dry\-run\fR to verify that your rules work as expected.
424 Use together with \fB\-\-debug\fR get detailed information
425 about matching file names against exclude and include rules.
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
426 .PP
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
427 For example to exclude all files with ".jpg" extension except those beginning with a number use:
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
428 .PP
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
429 \-\-exclude '*.jpg' \-\-rinclude '[0-9].*\.jpg'
430 .SH SEE ALSO
431 For the most up to date list of options run
432 .B s3cmd \-\-help
433 .br
434 For more info about usage, examples and other related info visit project homepage at
435 .br
436 .B http://s3tools.org
da0fb7b @mludvig * s3cmd, s3cmd.1, format-manpage.pl: Improved --help text
mludvig authored
437 .SH DONATIONS
438 Please consider a donation if you have found s3cmd useful:
439 .br
440 .B http://s3tools.org/donate
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
441 .SH AUTHOR
da0fb7b @mludvig * s3cmd, s3cmd.1, format-manpage.pl: Improved --help text
mludvig authored
442 Written by Michal Ludvig <mludvig@logix.net.nz> and 15+ contributors
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
443 .SH CONTACT, SUPPORT
444 Prefered way to get support is our mailing list:
445 .I s3tools\-general@lists.sourceforge.net
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
446 .SH REPORTING BUGS
447 Report bugs to
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
448 .I s3tools\-bugs@lists.sourceforge.net
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
449 .SH COPYRIGHT
6063e01 @mludvig Released version 1.1.0-beta2
mludvig authored
450 Copyright \(co 2007,2008,2009,2010,2011,2012 Michal Ludvig <http://www.logix.cz/michal>
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
451 .br
452 This is free software. You may redistribute copies of it under the terms of
453 the GNU General Public License version 2 <http://www.gnu.org/licenses/gpl.html>.
454 There is NO WARRANTY, to the extent permitted by law.
Something went wrong with that request. Please try again.