Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 629 lines (616 sloc) 19.236 kB
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
1
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
2 .\" !!! IMPORTANT: This file is generated from s3cmd \-\-help output using format-manpage.pl
3 .\" !!! Do your changes either in s3cmd file or in 'format\-manpage.pl' otherwise
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
4 .\" !!! they will be overwritten!
5
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
6 .TH s3cmd 1
7 .SH NAME
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
8 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
9 .SH SYNOPSIS
10 .B s3cmd
11 [\fIOPTIONS\fR] \fICOMMAND\fR [\fIPARAMETERS\fR]
12 .SH DESCRIPTION
13 .PP
14 .B s3cmd
15 is a command line client for copying files to/from
16 Amazon S3 (Simple Storage Service) and performing other
17 related tasks, for instance creating and removing buckets,
18 listing objects, etc.
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
19
20 .SH COMMANDS
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
21 .PP
22 .B s3cmd
23 can do several \fIactions\fR specified by the following \fIcommands\fR.
24 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
25 s3cmd \fBmb\fR \fIs3://BUCKET\fR
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
26 Make bucket
27 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
28 s3cmd \fBrb\fR \fIs3://BUCKET\fR
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
29 Remove bucket
30 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
31 s3cmd \fBls\fR \fI[s3://BUCKET[/PREFIX]]\fR
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
32 List objects or buckets
33 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
34 s3cmd \fBla\fR \fI\fR
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
35 List all object in all buckets
36 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
37 s3cmd \fBput\fR \fIFILE [FILE...] s3://BUCKET[/PREFIX]\fR
38 Put file into bucket
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
39 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
40 s3cmd \fBget\fR \fIs3://BUCKET/OBJECT LOCAL_FILE\fR
41 Get file from bucket
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
42 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
43 s3cmd \fBdel\fR \fIs3://BUCKET/OBJECT\fR
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
44 Delete file from bucket
f298b34 @mludvig 2007-05-26 Michal Ludvig <michal@logix.cz>
mludvig authored
45 .TP
25ff338 @mludvig Update version to 1.5.0-rc1
mludvig authored
46 s3cmd \fBrm\fR \fIs3://BUCKET/OBJECT\fR
47 Delete file from bucket (alias for del)
48 .TP
6b20eb4 @mdomsch update manpage
mdomsch authored
49 s3cmd \fBrestore\fR \fIs3://BUCKET/OBJECT\fR
50 Restore file from Glacier storage
51 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
52 s3cmd \fBsync\fR \fILOCAL_DIR s3://BUCKET[/PREFIX] or s3://BUCKET[/PREFIX] LOCAL_DIR\fR
23ace81 @LocutusOfBorg Fix typo (overriden -> overridden)
LocutusOfBorg authored
53 Synchronize a directory tree to S3 (checks files freshness using size and md5 checksum, unless overridden by options, see below)
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
54 .TP
55 s3cmd \fBdu\fR \fI[s3://BUCKET[/PREFIX]]\fR
56 Disk usage by buckets
57 .TP
58 s3cmd \fBinfo\fR \fIs3://BUCKET[/OBJECT]\fR
59 Get various information about Buckets or Files
60 .TP
61 s3cmd \fBcp\fR \fIs3://BUCKET1/OBJECT1 s3://BUCKET2[/OBJECT2]\fR
62 Copy object
29893af @mludvig * S3/PkgInfo.py: Bumped up version to 0.9.7
mludvig authored
63 .TP
6fa6fcb Clarified GPL version 2 plus help cleanups
matteobar authored
64 s3cmd \fBmodify\fR \fIs3://BUCKET1/OBJECT\fR
65 Modify object metadata
66 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
67 s3cmd \fBmv\fR \fIs3://BUCKET1/OBJECT1 s3://BUCKET2[/OBJECT2]\fR
68 Move object
7393bdb @mludvig * s3cmd, s3cmd.1: Updated help and man page.
mludvig authored
69 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
70 s3cmd \fBsetacl\fR \fIs3://BUCKET[/OBJECT]\fR
71 Modify Access control list for Bucket or Files
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
72 .TP
38085b1 @mludvig Updated s3cmd.1 manpage for v1.5.0-alpha2
mludvig authored
73 s3cmd \fBsetpolicy\fR \fIFILE s3://BUCKET\fR
74 Modify Bucket Policy
75 .TP
76 s3cmd \fBdelpolicy\fR \fIs3://BUCKET\fR
77 Delete Bucket Policy
fa5e43d @mludvig Updated s3cmd.1 manpage
mludvig authored
78 .TP
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
79 s3cmd \fBmultipart\fR \fIs3://BUCKET [Id]\fR
2a5a1d0 @mdomsch refresh manpage after capitolization patch
mdomsch authored
80 Show multipart uploads
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
81 .TP
82 s3cmd \fBabortmp\fR \fIs3://BUCKET/OBJECT Id\fR
2a5a1d0 @mdomsch refresh manpage after capitolization patch
mdomsch authored
83 Abort a multipart upload
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
84 .TP
85 s3cmd \fBlistmp\fR \fIs3://BUCKET/OBJECT Id\fR
2a5a1d0 @mdomsch refresh manpage after capitolization patch
mdomsch authored
86 List parts of a multipart upload
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
87 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
88 s3cmd \fBaccesslog\fR \fIs3://BUCKET\fR
89 Enable/disable bucket access logging
7393bdb @mludvig * s3cmd, s3cmd.1: Updated help and man page.
mludvig authored
90 .TP
5f3baaa Fix various typos spot by lintian
Mikhail Gusarov authored
91 s3cmd \fBsign\fR \fISTRING\-TO\-SIGN\fR
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
92 Sign arbitrary string using the secret key
93 .TP
2a5a1d0 @mdomsch refresh manpage after capitolization patch
mdomsch authored
94 s3cmd \fBsignurl\fR \fIs3://BUCKET/OBJECT <expiry_epoch|+expiry_offset>\fR
fa5e43d @mludvig Updated s3cmd.1 manpage
mludvig authored
95 Sign an S3 URL to provide limited public access with expiry
ff6e561 @ringerc Add support for creating signed S3 URLs with the new signurl command
ringerc authored
96 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
97 s3cmd \fBfixbucket\fR \fIs3://BUCKET[/PREFIX]\fR
98 Fix invalid file names in a bucket
ac014aa @mdomsch add expire and excludes examples to the manpage
mdomsch authored
99 .TP
100 s3cmd \fBexpire\fR \fIs3://BUCKET\fR
101 Set or delete expiration rule for the bucket
25ff338 @mludvig Update version to 1.5.0-rc1
mludvig authored
102 .TP
103 s3cmd \fBsetlifecycle\fR \fIs3://BUCKET\fR
104 Upload a lifecycle policy for the bucket
105 .TP
106 s3cmd \fBdellifecycle\fR \fIs3://BUCKET\fR
107 Remove a lifecycle policy for the bucket
6063e01 @mludvig Released version 1.1.0-beta2
mludvig authored
108
109
110 .PP
111 Commands for static WebSites configuration
a76d2f3 @mludvig Updated s3cmd.1 manpage with the latest options.
mludvig authored
112 .TP
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
113 s3cmd \fBws\-create\fR \fIs3://BUCKET\fR
a76d2f3 @mludvig Updated s3cmd.1 manpage with the latest options.
mludvig authored
114 Create Website from bucket
115 .TP
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
116 s3cmd \fBws\-delete\fR \fIs3://BUCKET\fR
a76d2f3 @mludvig Updated s3cmd.1 manpage with the latest options.
mludvig authored
117 Delete Website
118 .TP
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
119 s3cmd \fBws\-info\fR \fIs3://BUCKET\fR
a76d2f3 @mludvig Updated s3cmd.1 manpage with the latest options.
mludvig authored
120 Info about Website
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
121
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
122
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
123 .PP
124 Commands for CloudFront management
125 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
126 s3cmd \fBcflist\fR \fI\fR
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
127 List CloudFront distribution points
128 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
129 s3cmd \fBcfinfo\fR \fI[cf://DIST_ID]\fR
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
130 Display CloudFront distribution point parameters
131 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
132 s3cmd \fBcfcreate\fR \fIs3://BUCKET\fR
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
133 Create CloudFront distribution point
134 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
135 s3cmd \fBcfdelete\fR \fIcf://DIST_ID\fR
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
136 Delete CloudFront distribution point
137 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
138 s3cmd \fBcfmodify\fR \fIcf://DIST_ID\fR
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
139 Change CloudFront distribution point parameters
d065ce3 @mludvig Released version 1.1.0-beta1
mludvig authored
140 .TP
141 s3cmd \fBcfinvalinfo\fR \fIcf://DIST_ID[/INVAL_ID]\fR
142 Display CloudFront invalidation request(s) status
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
143
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
144
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
145 .SH OPTIONS
146 .PP
147 Some of the below specified options can have their default
148 values set in
149 .B s3cmd
150 config file (by default $HOME/.s3cmd). As it's a simple text file
151 feel free to open it with your favorite text editor and do any
6b20eb4 @mdomsch update manpage
mdomsch authored
152 changes you like.
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
153 .TP
154 \fB\-h\fR, \fB\-\-help\fR
155 show this help message and exit
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
156 .TP
bf42f42 @mludvig 2007-06-16 Michal Ludvig <michal@logix.cz>
mludvig authored
157 \fB\-\-configure\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
158 Invoke interactive (re)configuration tool. Optionally
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
159 use as '\fB\-\-configure\fR s3://some\-bucket' to test access
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
160 to a specific bucket instead of attempting to list
161 them all.
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
162 .TP
bf42f42 @mludvig 2007-06-16 Michal Ludvig <michal@logix.cz>
mludvig authored
163 \fB\-c\fR FILE, \fB\-\-config\fR=FILE
8c75d52 @mdomsch Update s3cmd --help with changes made to manpage.
mdomsch authored
164 Config file name. Defaults to $HOME/.s3cfg
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
165 .TP
bf42f42 @mludvig 2007-06-16 Michal Ludvig <michal@logix.cz>
mludvig authored
166 \fB\-\-dump\-config\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
167 Dump current configuration after parsing config files
168 and command line options and exit.
fa5e43d @mludvig Updated s3cmd.1 manpage
mludvig authored
169 .TP
170 \fB\-\-access_key\fR=ACCESS_KEY
171 AWS Access Key
172 .TP
173 \fB\-\-secret_key\fR=SECRET_KEY
174 AWS Secret Key
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
175 .TP
176 \fB\-n\fR, \fB\-\-dry\-run\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
177 Only show what should be uploaded or downloaded but
178 don't actually do it. May still perform S3 requests to
179 get bucket listings and other information though (only
180 for file transfer commands)
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
181 .TP
8c75d52 @mdomsch Update s3cmd --help with changes made to manpage.
mdomsch authored
182 \fB\-s\fR, \fB\-\-ssl\fR
183 Use HTTPS connection when communicating with S3.
184 .TP
185 \fB\-\-no\-ssl\fR
186 Don't use HTTPS. (default)
187 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
188 \fB\-e\fR, \fB\-\-encrypt\fR
189 Encrypt files before uploading to S3.
190 .TP
191 \fB\-\-no\-encrypt\fR
192 Don't encrypt files.
193 .TP
194 \fB\-f\fR, \fB\-\-force\fR
195 Force overwrite and other dangerous operations.
196 .TP
197 \fB\-\-continue\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
198 Continue getting a partially downloaded file (only for
199 [get] command).
200 .TP
201 \fB\-\-continue\-put\fR
202 Continue uploading partially uploaded files or
203 multipart upload parts. Restarts/parts files that
204 don't have matching size and md5. Skips files/parts
205 that do. Note: md5sum checks are not always
206 sufficient to check (part) file equality. Enable this
207 at your own risk.
208 .TP
209 \fB\-\-upload\-id\fR=UPLOAD_ID
210 UploadId for Multipart Upload, in case you want
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
211 continue an existing upload (equivalent to \fB\-\-continue\-\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
212 put) and there are multiple partial uploads. Use
213 s3cmd multipart [URI] to see what UploadIds are
214 associated with the given URI.
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
215 .TP
216 \fB\-\-skip\-existing\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
217 Skip over files that exist at the destination (only
218 for [get] and [sync] commands).
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
219 .TP
220 \fB\-r\fR, \fB\-\-recursive\fR
221 Recursive upload, download or removal.
222 .TP
da0fb7b @mludvig * s3cmd, s3cmd.1, format-manpage.pl: Improved --help text
mludvig authored
223 \fB\-\-check\-md5\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
224 Check MD5 sums when comparing files for [sync].
225 (default)
da0fb7b @mludvig * s3cmd, s3cmd.1, format-manpage.pl: Improved --help text
mludvig authored
226 .TP
227 \fB\-\-no\-check\-md5\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
228 Do not check MD5 sums when comparing files for [sync].
229 Only size will be compared. May significantly speed up
230 transfer but may also miss some changed files.
da0fb7b @mludvig * s3cmd, s3cmd.1, format-manpage.pl: Improved --help text
mludvig authored
231 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
232 \fB\-P\fR, \fB\-\-acl\-public\fR
233 Store objects with ACL allowing read for anyone.
234 .TP
235 \fB\-\-acl\-private\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
236 Store objects with default ACL allowing access for you
237 only.
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
238 .TP
239 \fB\-\-acl\-grant\fR=PERMISSION:EMAIL or USER_CANONICAL_ID
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
240 Grant stated permission to a given amazon user.
241 Permission is one of: read, write, read_acp,
242 write_acp, full_control, all
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
243 .TP
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
244 \fB\-\-acl\-revoke\fR=PERMISSION:USER_CANONICAL_ID
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
245 Revoke stated permission for a given amazon user.
246 Permission is one of: read, write, read_acp, wr
247 ite_acp, full_control, all
7393bdb @mludvig * s3cmd, s3cmd.1: Updated help and man page.
mludvig authored
248 .TP
6b20eb4 @mdomsch update manpage
mdomsch authored
249 \fB\-D\fR NUM, \fB\-\-restore\-days\fR=NUM
250 Number of days to keep restored file available (only
251 for 'restore' command).
252 .TP
7393bdb @mludvig * s3cmd, s3cmd.1: Updated help and man page.
mludvig authored
253 \fB\-\-delete\-removed\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
254 Delete remote objects with no corresponding local file
255 [sync]
7393bdb @mludvig * s3cmd, s3cmd.1: Updated help and man page.
mludvig authored
256 .TP
257 \fB\-\-no\-delete\-removed\fR
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
258 Don't delete remote objects.
7393bdb @mludvig * s3cmd, s3cmd.1: Updated help and man page.
mludvig authored
259 .TP
d5dc2c0 @mdomsch add --delete-after option for sync
mdomsch authored
260 \fB\-\-delete\-after\fR
fa5e43d @mludvig Updated s3cmd.1 manpage
mludvig authored
261 Perform deletes after new uploads [sync]
d5dc2c0 @mdomsch add --delete-after option for sync
mdomsch authored
262 .TP
c3deb6a @mdomsch add --delay-updates option
mdomsch authored
263 \fB\-\-delay\-updates\fR
264 Put all updated files into place at end [sync]
265 .TP
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
266 \fB\-\-max\-delete\fR=NUM
267 Do not delete more than NUM files. [del] and [sync]
268 .TP
fa5e43d @mludvig Updated s3cmd.1 manpage
mludvig authored
269 \fB\-\-add\-destination\fR=ADDITIONAL_DESTINATIONS
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
270 Additional destination for parallel uploads, in
271 addition to last arg. May be repeated.
fa5e43d @mludvig Updated s3cmd.1 manpage
mludvig authored
272 .TP
273 \fB\-\-delete\-after\-fetch\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
274 Delete remote objects after fetching to local file
275 (only for [get] and [sync] commands).
f230f79 @mdomsch add --max-delete for del and sync commands, fixes bug #155
mdomsch authored
276 .TP
7393bdb @mludvig * s3cmd, s3cmd.1: Updated help and man page.
mludvig authored
277 \fB\-p\fR, \fB\-\-preserve\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
278 Preserve filesystem attributes (mode, ownership,
279 timestamps). Default for [sync] command.
7393bdb @mludvig * s3cmd, s3cmd.1: Updated help and man page.
mludvig authored
280 .TP
281 \fB\-\-no\-preserve\fR
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
282 Don't store FS attributes
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
283 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
284 \fB\-\-exclude\fR=GLOB
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
285 Filenames and paths matching GLOB will be excluded
286 from sync
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
287 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
288 \fB\-\-exclude\-from\fR=FILE
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
289 Read --exclude GLOBs from FILE
2d7d554 @mludvig * s3cmd, s3cmd.1: Added GLOB (shell-style wildcard) exclude, renamed
mludvig authored
290 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
291 \fB\-\-rexclude\fR=REGEXP
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
292 Filenames and paths matching REGEXP (regular
293 expression) will be excluded from sync
2d7d554 @mludvig * s3cmd, s3cmd.1: Added GLOB (shell-style wildcard) exclude, renamed
mludvig authored
294 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
295 \fB\-\-rexclude\-from\fR=FILE
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
296 Read --rexclude REGEXPs from FILE
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
297 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
298 \fB\-\-include\fR=GLOB
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
299 Filenames and paths matching GLOB will be included
300 even if previously excluded by one of
5f3baaa Fix various typos spot by lintian
Mikhail Gusarov authored
301 \fB\-\-(r)exclude(\-from)\fR patterns
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
302 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
303 \fB\-\-include\-from\fR=FILE
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
304 Read --include GLOBs from FILE
18c4a15 @mludvig 2007-08-14 Michal Ludvig <michal@logix.cz>
mludvig authored
305 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
306 \fB\-\-rinclude\fR=REGEXP
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
307 Same as --include but uses REGEXP (regular expression)
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
308 instead of GLOB
6454bfb @redsymbol Manual page documentation for --follow-symlinks
redsymbol authored
309 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
310 \fB\-\-rinclude\-from\fR=FILE
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
311 Read --rinclude REGEXPs from FILE
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
312 .TP
313 \fB\-\-ignore\-failed\-copy\fR
314 Don't exit unsuccessfully because of missing keys
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
315 .TP
bc547d1 @mdomsch add --files-from to manpage
mdomsch authored
316 \fB\-\-files\-from\fR=FILE
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
317 Read list of source-file names from FILE. Use - to
318 read from stdin.
bc547d1 @mdomsch add --files-from to manpage
mdomsch authored
319 .TP
8c75d52 @mdomsch Update s3cmd --help with changes made to manpage.
mdomsch authored
320 \fB\-\-region\fR=REGION, \fB\-\-bucket\-location\fR=REGION
321 Region to create bucket in. As of now the regions are:
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
322 us\-east\-1, us\-west\-1, us\-west\-2, eu\-west\-1, eu\-
323 central\-1, ap\-northeast\-1, ap\-southeast\-1, ap\-
324 southeast\-2, sa\-east\-1
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
325 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
326 \fB\-\-reduced\-redundancy\fR, \fB\-\-rr\fR
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
327 Store object with 'Reduced redundancy'. Lower per\-GB
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
328 price. [put, cp, mv]
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
329 .TP
8c75d52 @mdomsch Update s3cmd --help with changes made to manpage.
mdomsch authored
330 \fB\-\-no\-reduced\-redundancy\fR, \fB\-\-no\-rr\fR
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
331 Store object without 'Reduced redundancy'. Higher per\-
8c75d52 @mdomsch Update s3cmd --help with changes made to manpage.
mdomsch authored
332 GB price. [put, cp, mv]
333 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
334 \fB\-\-access\-logging\-target\-prefix\fR=LOG_TARGET_PREFIX
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
335 Target prefix for access logs (S3 URI) (for [cfmodify]
336 and [accesslog] commands)
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
337 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
338 \fB\-\-no\-access\-logging\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
339 Disable access logging (for [cfmodify] and [accesslog]
340 commands)
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
341 .TP
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
342 \fB\-\-default\-mime\-type\fR=DEFAULT_MIME_TYPE
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
343 Default MIME\-type for stored objects. Application
344 default is binary/octet\-stream.
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
345 .TP
fa5e43d @mludvig Updated s3cmd.1 manpage
mludvig authored
346 \fB\-M\fR, \fB\-\-guess\-mime\-type\fR
5f3baaa Fix various typos spot by lintian
Mikhail Gusarov authored
347 Guess MIME\-type of files by their extension or mime
348 magic. Fall back to default MIME\-Type as specified by
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
349 \fB\-\-default\-mime\-type\fR option
a76d2f3 @mludvig Updated s3cmd.1 manpage with the latest options.
mludvig authored
350 .TP
351 \fB\-\-no\-guess\-mime\-type\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
352 Don't guess MIME-type and use the default type
353 instead.
a76d2f3 @mludvig Updated s3cmd.1 manpage with the latest options.
mludvig authored
354 .TP
b4207d9 @radomirml Added option --no-mime-magic to disable mime magic, bug #198
radomirml authored
355 \fB\-\-no\-mime\-magic\fR
356 Don't use mime magic when guessing MIME-type.
357 .TP
a76d2f3 @mludvig Updated s3cmd.1 manpage with the latest options.
mludvig authored
358 \fB\-m\fR MIME/TYPE, \fB\-\-mime\-type\fR=MIME/TYPE
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
359 Force MIME\-type. Override both \fB\-\-default\-mime\-type\fR and
360 \fB\-\-guess\-mime\-type\fR.
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
361 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
362 \fB\-\-add\-header\fR=NAME:VALUE
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
363 Add a given HTTP header to the upload request. Can be
6fa6fcb Clarified GPL version 2 plus help cleanups
matteobar authored
364 used multiple times. For instance set 'Expires' or
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
365 \&'Cache\-Control' headers (or both) using this option.
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
366 .TP
8c75d52 @mdomsch Update s3cmd --help with changes made to manpage.
mdomsch authored
367 \fB\-\-remove\-header\fR=NAME
368 Remove a given HTTP header. Can be used multiple
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
369 times. For instance, remove 'Expires' or 'Cache\-
8c75d52 @mdomsch Update s3cmd --help with changes made to manpage.
mdomsch authored
370 Control' headers (or both) using this option. [modify]
371 .TP
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
372 \fB\-\-server\-side\-encryption\fR
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
373 Specifies that server\-side encryption will be used
8c75d52 @mdomsch Update s3cmd --help with changes made to manpage.
mdomsch authored
374 when putting objects. [put, sync, cp, modify]
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
375 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
376 \fB\-\-encoding\fR=ENCODING
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
377 Override autodetected terminal and filesystem encoding
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
378 (character set). Autodetected: UTF\-8
fa5e43d @mludvig Updated s3cmd.1 manpage
mludvig authored
379 .TP
380 \fB\-\-add\-encoding\-exts\fR=EXTENSIONs
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
381 Add encoding to these comma delimited extensions i.e.
382 (css,js,html) when uploading to S3 )
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
383 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
384 \fB\-\-verbatim\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
385 Use the S3 name as given on the command line. No pre-
386 processing, encoding, etc. Use with caution!
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
387 .TP
6063e01 @mludvig Released version 1.1.0-beta2
mludvig authored
388 \fB\-\-disable\-multipart\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
389 Disable multipart upload on files bigger than
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
390 \fB\-\-multipart\-chunk\-size\-mb\fR
6063e01 @mludvig Released version 1.1.0-beta2
mludvig authored
391 .TP
392 \fB\-\-multipart\-chunk\-size\-mb\fR=SIZE
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
393 Size of each chunk of a multipart upload. Files bigger
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
394 than SIZE are automatically uploaded as multithreaded\-
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
395 multipart, smaller files are uploaded using the
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
396 traditional method. SIZE is in Mega\-Bytes, default
6fa6fcb Clarified GPL version 2 plus help cleanups
matteobar authored
397 chunk size is 15MB, minimum allowed chunk size is 5MB,
398 maximum is 5GB.
6063e01 @mludvig Released version 1.1.0-beta2
mludvig authored
399 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
400 \fB\-\-list\-md5\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
401 Include MD5 sums in bucket listings (only for 'ls'
402 command).
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
403 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
404 \fB\-H\fR, \fB\-\-human\-readable\-sizes\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
405 Print sizes in human readable form (eg 1kB instead of
406 1234).
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
407 .TP
a76d2f3 @mludvig Updated s3cmd.1 manpage with the latest options.
mludvig authored
408 \fB\-\-ws\-index\fR=WEBSITE_INDEX
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
409 Name of index\-document (only for [ws\-create] command)
a76d2f3 @mludvig Updated s3cmd.1 manpage with the latest options.
mludvig authored
410 .TP
411 \fB\-\-ws\-error\fR=WEBSITE_ERROR
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
412 Name of error\-document (only for [ws\-create] command)
a76d2f3 @mludvig Updated s3cmd.1 manpage with the latest options.
mludvig authored
413 .TP
ac014aa @mdomsch add expire and excludes examples to the manpage
mdomsch authored
414 \fB\-\-expiry\-date\fR=EXPIRY_DATE
6fa6fcb Clarified GPL version 2 plus help cleanups
matteobar authored
415 Indicates when the expiration rule takes effect. (only
4905599 @mdomsch man page cleanups
mdomsch authored
416 for [expire] command)
ac014aa @mdomsch add expire and excludes examples to the manpage
mdomsch authored
417 .TP
418 \fB\-\-expiry\-days\fR=EXPIRY_DAYS
419 Indicates the number of days after object creation the
6fa6fcb Clarified GPL version 2 plus help cleanups
matteobar authored
420 expiration rule takes effect. (only for [expire]
ac014aa @mdomsch add expire and excludes examples to the manpage
mdomsch authored
421 command)
422 .TP
423 \fB\-\-expiry\-prefix\fR=EXPIRY_PREFIX
424 Identifying one or more objects with the prefix to
425 which the expiration rule applies. (only for [expire]
426 command)
427 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
428 \fB\-\-progress\fR
429 Display progress meter (default on TTY).
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
430 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
431 \fB\-\-no\-progress\fR
432 Don't display progress meter (default on non-TTY).
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
433 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
434 \fB\-\-enable\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
435 Enable given CloudFront distribution (only for
436 [cfmodify] command)
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
437 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
438 \fB\-\-disable\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
439 Enable given CloudFront distribution (only for
440 [cfmodify] command)
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
441 .TP
d065ce3 @mludvig Released version 1.1.0-beta1
mludvig authored
442 \fB\-\-cf\-invalidate\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
443 Invalidate the uploaded filed in CloudFront. Also see
444 [cfinval] command.
fa5e43d @mludvig Updated s3cmd.1 manpage
mludvig authored
445 .TP
446 \fB\-\-cf\-invalidate\-default\-index\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
447 When using Custom Origin and S3 static website,
448 invalidate the default index file.
fa5e43d @mludvig Updated s3cmd.1 manpage
mludvig authored
449 .TP
450 \fB\-\-cf\-no\-invalidate\-default\-index\-root\fR
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
451 When using Custom Origin and S3 static website, don't
452 invalidate the path to the default index file.
d065ce3 @mludvig Released version 1.1.0-beta1
mludvig authored
453 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
454 \fB\-\-cf\-add\-cname\fR=CNAME
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
455 Add given CNAME to a CloudFront distribution (only for
456 [cfcreate] and [cfmodify] commands)
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
457 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
458 \fB\-\-cf\-remove\-cname\fR=CNAME
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
459 Remove given CNAME from a CloudFront distribution
460 (only for [cfmodify] command)
25f6f8c @mludvig * s3cmd, s3cmd.1, S3/S3.py: Display or don't display progress meter
mludvig authored
461 .TP
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
462 \fB\-\-cf\-comment\fR=COMMENT
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
463 Set COMMENT for a given CloudFront distribution (only
464 for [cfcreate] and [cfmodify] commands)
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
465 .TP
466 \fB\-\-cf\-default\-root\-object\fR=DEFAULT_ROOT_OBJECT
2dff2c0 @mludvig Version 1.5.0-beta1
mludvig authored
467 Set the default root object to return when no object
468 is specified in the URL. Use a relative path, i.e.
469 default/index.html instead of /default/index.html or
470 s3://bucket/default/index.html (only for [cfcreate]
471 and [cfmodify] commands)
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
472 .TP
bf42f42 @mludvig 2007-06-16 Michal Ludvig <michal@logix.cz>
mludvig authored
473 \fB\-v\fR, \fB\-\-verbose\fR
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
474 Enable verbose output.
475 .TP
bf42f42 @mludvig 2007-06-16 Michal Ludvig <michal@logix.cz>
mludvig authored
476 \fB\-d\fR, \fB\-\-debug\fR
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
477 Enable debug output.
478 .TP
bf42f42 @mludvig 2007-06-16 Michal Ludvig <michal@logix.cz>
mludvig authored
479 \fB\-\-version\fR
be45a0d @mdomsch Update version to 1.5.2
mdomsch authored
480 Show s3cmd version (1.5.2) and exit.
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
481 .TP
482 \fB\-F\fR, \fB\-\-follow\-symlinks\fR
483 Follow symbolic links as if they are regular files
fa5e43d @mludvig Updated s3cmd.1 manpage
mludvig authored
484 .TP
485 \fB\-\-cache\-file\fR=FILE
486 Cache FILE containing local source MD5 values
986aebb @mludvig Version 1.5.0-alpha3
mludvig authored
487 .TP
488 \fB\-q\fR, \fB\-\-quiet\fR
489 Silence output on stdout
8c75d52 @mdomsch Update s3cmd --help with changes made to manpage.
mdomsch authored
490 .TP
491 \fB\-\-ca\-certs\fR=CA_CERTS_FILE
492 Path to SSL CA certificate FILE (instead of system
493 default)
494 .TP
495 \fB\-\-check\-certificate\fR
496 Check SSL certificate validity
497 .TP
498 \fB\-\-no\-check\-certificate\fR
499 Check SSL certificate validity
f5e72c8 @mdomsch update manpage from source
mdomsch authored
500 .TP
501 \fB\-\-signature\-v2\fR
502 Use AWS Signature version 2 instead of newer signature
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
503 methods. Helpful for S3\-like systems that don't have
f5e72c8 @mdomsch update manpage from source
mdomsch authored
504 AWS Signature v4 yet.
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
505 .TP
506 \fB\-\-limit\-rate\fR=LIMITRATE
507 Limit the upload or download speed to amount bytes per
508 second. Amount may be expressed in bytes, kilobytes
509 with the k suffix, or megabytes with the m suffix
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
510
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
511
593ef06 @mludvig * format-manpage.pl: new manpage auto-formatter
mludvig authored
512 .SH EXAMPLES
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
513 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
514 synchronising complete directory trees to or from remote S3 storage. To some extent
515 \fBs3cmd put\fR and \fBs3cmd get\fR share a similar behaviour with \fBsync\fR.
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
516 .PP
517 Basic usage common in backup scenarios is as simple as:
518 .nf
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
519 s3cmd sync /local/path/ s3://test\-bucket/backup/
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
520 .fi
521 .PP
522 This command will find all files under /local/path directory and copy them
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
523 to corresponding paths under s3://test\-bucket/backup on the remote side.
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
524 For example:
525 .nf
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
526 /local/path/\fBfile1.ext\fR \-> s3://bucket/backup/\fBfile1.ext\fR
527 /local/path/\fBdir123/file2.bin\fR \-> s3://bucket/backup/\fBdir123/file2.bin\fR
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
528 .fi
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
529 .PP
530 However if the local path doesn't end with a slash the last directory's name
531 is used on the remote side as well. Compare these with the previous example:
532 .nf
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
533 s3cmd sync /local/path s3://test\-bucket/backup/
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
534 .fi
535 will sync:
536 .nf
537 /local/\fBpath/file1.ext\fR \-> s3://bucket/backup/\fBpath/file1.ext\fR
538 /local/\fBpath/dir123/file2.bin\fR \-> s3://bucket/backup/\fBpath/dir123/file2.bin\fR
539 .fi
540 .PP
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
541 To retrieve the files back from S3 use inverted syntax:
542 .nf
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
543 s3cmd sync s3://test\-bucket/backup/ ~/restore/
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
544 .fi
545 that will download files:
546 .nf
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
547 s3://bucket/backup/\fBfile1.ext\fR \-> ~/restore/\fBfile1.ext\fR
548 s3://bucket/backup/\fBdir123/file2.bin\fR \-> ~/restore/\fBdir123/file2.bin\fR
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
549 .fi
2d7d554 @mludvig * s3cmd, s3cmd.1: Added GLOB (shell-style wildcard) exclude, renamed
mludvig authored
550 .PP
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
551 Without the trailing slash on source the behaviour is similar to
552 what has been demonstrated with upload:
553 .nf
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
554 s3cmd sync s3://test\-bucket/backup ~/restore/
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
555 .fi
556 will download the files as:
557 .nf
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
558 s3://bucket/\fBbackup/file1.ext\fR \-> ~/restore/\fBbackup/file1.ext\fR
559 s3://bucket/\fBbackup/dir123/file2.bin\fR \-> ~/restore/\fBbackup/dir123/file2.bin\fR
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
560 .fi
561 .PP
562 All source file names, the bold ones above, are matched against \fBexclude\fR
563 rules and those that match are then re\-checked against \fBinclude\fR rules to see
564 whether they should be excluded or kept in the source list.
565 .PP
566 For the purpose of \fB\-\-exclude\fR and \fB\-\-include\fR matching only the
567 bold file names above are used. For instance only \fBpath/file1.ext\fR is tested
568 against the patterns, not \fI/local/\fBpath/file1.ext\fR
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
569 .PP
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
570 Both \fB\-\-exclude\fR and \fB\-\-include\fR work with shell\-style wildcards (a.k.a. GLOB).
571 For a greater flexibility s3cmd provides Regular\-expression versions of the two exclude options
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
572 named \fB\-\-rexclude\fR and \fB\-\-rinclude\fR.
573 The options with ...\fB\-from\fR suffix (eg \-\-rinclude\-from) expect a filename as
574 an argument. Each line of such a file is treated as one pattern.
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
575 .PP
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
576 There is only one set of patterns built from all \fB\-\-(r)exclude(\-from)\fR options
577 and similarly for include variant. Any file excluded with eg \-\-exclude can
578 be put back with a pattern found in \-\-rinclude\-from list.
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
579 .PP
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
580 Run s3cmd with \fB\-\-dry\-run\fR to verify that your rules work as expected.
581 Use together with \fB\-\-debug\fR get detailed information
582 about matching file names against exclude and include rules.
ee852c0 @mludvig * s3cmd.1, NEWS: Document --exclude
mludvig authored
583 .PP
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
584 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
585 .PP
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
586 \-\-exclude '*.jpg' \-\-rinclude '[0\-9].*\.jpg'
ac014aa @mdomsch add expire and excludes examples to the manpage
mdomsch authored
587 .PP
588 To exclude all files except "*.jpg" extension, use:
589 .PP
590 \-\-exclude '*' \-\-include '*.jpg'
591 .PP
592 To exclude local directory 'somedir', be sure to use a trailing forward slash, as such:
593 .PP
594 \-\-exclude 'somedir/'
595 .PP
596
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
597 .SH SEE ALSO
6fa6fcb Clarified GPL version 2 plus help cleanups
matteobar authored
598 For the most up to date list of options run:
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
599 .B s3cmd \-\-help
600 .br
6fa6fcb Clarified GPL version 2 plus help cleanups
matteobar authored
601 For more info about usage, examples and other related info visit project homepage at:
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
602 .B http://s3tools.org
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
603 .SH AUTHOR
6fa6fcb Clarified GPL version 2 plus help cleanups
matteobar authored
604 Written by Michal Ludvig and contributors
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
605 .SH CONTACT, SUPPORT
5311543 @robysath Fixed spelling and usage of bare hyphen.
robysath authored
606 Preferred way to get support is our mailing list:
6fa6fcb Clarified GPL version 2 plus help cleanups
matteobar authored
607 .br
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
608 .I s3tools\-general@lists.sourceforge.net
6fa6fcb Clarified GPL version 2 plus help cleanups
matteobar authored
609 .br
610 or visit the project homepage:
611 .br
612 .B http://s3tools.org
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
613 .SH REPORTING BUGS
614 Report bugs to
01a8052 @mludvig * s3cmd.1: Document all the new options and commands.
mludvig authored
615 .I s3tools\-bugs@lists.sourceforge.net
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
616 .SH COPYRIGHT
2a6a46f @mdomsch update manpage for formatting
mdomsch authored
617 Copyright \(co 2007\-2014 TGRMN Software \- http://www.tgrmn.com \- and contributors
6fa6fcb Clarified GPL version 2 plus help cleanups
matteobar authored
618 .br
619 .SH LICENSE
620 This program is free software; you can redistribute it and/or modify
621 it under the terms of the GNU General Public License as published by
622 the Free Software Foundation; either version 2 of the License, or
623 (at your option) any later version.
624 This program is distributed in the hope that it will be useful,
625 but WITHOUT ANY WARRANTY; without even the implied warranty of
626 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
627 GNU General Public License for more details.
dd4fec7 @mludvig 2007-04-09 Michal Ludvig <michal@logix.cz>
mludvig authored
628 .br
Something went wrong with that request. Please try again.