Fetching contributors…
Cannot retrieve contributors at this time
449 lines (438 sloc) 13.3 KB
.TH s3cmd 1
s3cmd \- tool for managing Amazon S3 storage space and Amazon CloudFront content delivery network
.B s3cmd
.B s3cmd
is a command line client for copying files to/from
Amazon S3 (Simple Storage Service) and performing other
related tasks, for instance creating and removing buckets,
listing objects, etc.
.B s3cmd
can do several \fIactions\fR specified by the following \fIcommands\fR.
s3cmd \fBmb\fR \fIs3://BUCKET\fR
Make bucket
s3cmd \fBrb\fR \fIs3://BUCKET\fR
Remove bucket
s3cmd \fBls\fR \fI[s3://BUCKET[/PREFIX]]\fR
List objects or buckets
s3cmd \fBla\fR \fI\fR
List all object in all buckets
s3cmd \fBput\fR \fIFILE [FILE...] s3://BUCKET[/PREFIX]\fR
Put file into bucket
s3cmd \fBget\fR \fIs3://BUCKET/OBJECT LOCAL_FILE\fR
Get file from bucket
s3cmd \fBdel\fR \fIs3://BUCKET/OBJECT\fR
Delete file from bucket
Synchronize a directory tree to S3
s3cmd \fBdu\fR \fI[s3://BUCKET[/PREFIX]]\fR
Disk usage by buckets
s3cmd \fBinfo\fR \fIs3://BUCKET[/OBJECT]\fR
Get various information about Buckets or Files
s3cmd \fBcp\fR \fIs3://BUCKET1/OBJECT1 s3://BUCKET2[/OBJECT2]\fR
Copy object
s3cmd \fBmv\fR \fIs3://BUCKET1/OBJECT1 s3://BUCKET2[/OBJECT2]\fR
Move object
s3cmd \fBsetacl\fR \fIs3://BUCKET[/OBJECT]\fR
Modify Access control list for Bucket or Files
s3cmd \fBaccesslog\fR \fIs3://BUCKET\fR
Enable/disable bucket access logging
s3cmd \fBsign\fR \fISTRING-TO-SIGN\fR
Sign arbitrary string using the secret key
s3cmd \fBfixbucket\fR \fIs3://BUCKET[/PREFIX]\fR
Fix invalid file names in a bucket
Commands for static WebSites configuration
s3cmd \fBws-create\fR \fIs3://BUCKET\fR
Create Website from bucket
s3cmd \fBws-delete\fR \fIs3://BUCKET\fR
Delete Website
s3cmd \fBws-info\fR \fIs3://BUCKET\fR
Info about Website
Commands for CloudFront management
s3cmd \fBcflist\fR \fI\fR
List CloudFront distribution points
s3cmd \fBcfinfo\fR \fI[cf://DIST_ID]\fR
Display CloudFront distribution point parameters
s3cmd \fBcfcreate\fR \fIs3://BUCKET\fR
Create CloudFront distribution point
s3cmd \fBcfdelete\fR \fIcf://DIST_ID\fR
Delete CloudFront distribution point
s3cmd \fBcfmodify\fR \fIcf://DIST_ID\fR
Change CloudFront distribution point parameters
s3cmd \fBcfinvalinfo\fR \fIcf://DIST_ID[/INVAL_ID]\fR
Display CloudFront invalidation request(s) status
Some of the below specified options can have their default
values set in
.B s3cmd
config file (by default $HOME/.s3cmd). As it's a simple text file
feel free to open it with your favorite text editor and do any
changes you like.
\fB\-h\fR, \fB\-\-help\fR
show this help message and exit
Invoke interactive (re)configuration tool. Optionally
use as '\fB--configure\fR s3://come-bucket' to test access
to a specific bucket instead of attempting to list
them all.
\fB\-c\fR FILE, \fB\-\-config\fR=FILE
Config file name. Defaults to /home/mludvig/.s3cfg
Dump current configuration after parsing config files
and command line options and exit.
\fB\-n\fR, \fB\-\-dry\-run\fR
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)
\fB\-e\fR, \fB\-\-encrypt\fR
Encrypt files before uploading to S3.
Don't encrypt files.
\fB\-f\fR, \fB\-\-force\fR
Force overwrite and other dangerous operations.
Continue getting a partially downloaded file (only for
[get] command).
Skip over files that exist at the destination (only
for [get] and [sync] commands).
\fB\-r\fR, \fB\-\-recursive\fR
Recursive upload, download or removal.
Check MD5 sums when comparing files for [sync].
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.
\fB\-P\fR, \fB\-\-acl\-public\fR
Store objects with ACL allowing read for anyone.
Store objects with default ACL allowing access for you
Grant stated permission to a given amazon user.
Permission is one of: read, write, read_acp,
write_acp, full_control, all
Revoke stated permission for a given amazon user.
Permission is one of: read, write, read_acp, wr
ite_acp, full_control, all
Delete remote objects with no corresponding local file
Don't delete remote objects.
\fB\-p\fR, \fB\-\-preserve\fR
Preserve filesystem attributes (mode, ownership,
timestamps). Default for [sync] command.
Don't store FS attributes
Filenames and paths matching GLOB will be excluded
from sync
Read --exclude GLOBs from FILE
Filenames and paths matching REGEXP (regular
expression) will be excluded from sync
Read --rexclude REGEXPs from FILE
Filenames and paths matching GLOB will be included
even if previously excluded by one of
\fB--(r)exclude(-from)\fR patterns
Read --include GLOBs from FILE
Same as --include but uses REGEXP (regular expression)
instead of GLOB
Read --rinclude REGEXPs from FILE
Datacentre to create bucket in. As of now the
datacenters are: US (default), EU, us-west-1, and ap-
\fB\-\-reduced\-redundancy\fR, \fB\-\-rr\fR
Store object with 'Reduced redundancy'. Lower per-GB
price. [put, cp, mv]
Target prefix for access logs (S3 URI) (for [cfmodify]
and [accesslog] commands)
Disable access logging (for [cfmodify] and [accesslog]
Default MIME-type for stored objects. Application
default is binary/octet-stream.
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
Don't guess MIME-type and use the default type
\fB\-m\fR MIME/TYPE, \fB\-\-mime\-type\fR=MIME/TYPE
Force MIME-type. Override both \fB--default-mime-type\fR and
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.
Override autodetected terminal and filesystem encoding
(character set). Autodetected: UTF-8
Use the S3 name as given on the command line. No pre-
processing, encoding, etc. Use with caution!
Disable multipart upload on files bigger than
Size of each chunk of a multipart upload. Files bigger
than SIZE are automatically uploaded as multithreaded-
multipart, smaller files are uploaded using the
traditional method. SIZE is in Mega-Bytes, default
chunk size is noneMB, minimum allowed chunk size is
5MB, maximum is 5GB.
Include MD5 sums in bucket listings (only for 'ls'
\fB\-H\fR, \fB\-\-human\-readable\-sizes\fR
Print sizes in human readable form (eg 1kB instead of
Name of error-document (only for [ws-create] command)
Name of index-document (only for [ws-create] command)
Display progress meter (default on TTY).
Don't display progress meter (default on non-TTY).
Enable given CloudFront distribution (only for
[cfmodify] command)
Enable given CloudFront distribution (only for
[cfmodify] command)
Invalidate the uploaded filed in CloudFront. Also see
[cfinval] command.
Add given CNAME to a CloudFront distribution (only for
[cfcreate] and [cfmodify] commands)
Remove given CNAME from a CloudFront distribution
(only for [cfmodify] command)
Set COMMENT for a given CloudFront distribution (only
for [cfcreate] and [cfmodify] commands)
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 [cfcreate]
and [cfmodify] commands)
\fB\-v\fR, \fB\-\-verbose\fR
Enable verbose output.
\fB\-d\fR, \fB\-\-debug\fR
Enable debug output.
Show s3cmd version (1.1.0-beta3) and exit.
\fB\-F\fR, \fB\-\-follow\-symlinks\fR
Follow symbolic links as if they are regular files
One of the most powerful commands of \fIs3cmd\fR is \fBs3cmd sync\fR used for
synchronising complete directory trees to or from remote S3 storage. To some extent
\fBs3cmd put\fR and \fBs3cmd get\fR share a similar behaviour with \fBsync\fR.
Basic usage common in backup scenarios is as simple as:
s3cmd sync /local/path/ s3://test-bucket/backup/
This command will find all files under /local/path directory and copy them
to corresponding paths under s3://test-bucket/backup on the remote side.
For example:
/local/path/\fBfile1.ext\fR \-> s3://bucket/backup/\fBfile1.ext\fR
/local/path/\fBdir123/file2.bin\fR \-> s3://bucket/backup/\fBdir123/file2.bin\fR
However if the local path doesn't end with a slash the last directory's name
is used on the remote side as well. Compare these with the previous example:
s3cmd sync /local/path s3://test-bucket/backup/
will sync:
/local/\fBpath/file1.ext\fR \-> s3://bucket/backup/\fBpath/file1.ext\fR
/local/\fBpath/dir123/file2.bin\fR \-> s3://bucket/backup/\fBpath/dir123/file2.bin\fR
To retrieve the files back from S3 use inverted syntax:
s3cmd sync s3://test-bucket/backup/ /tmp/restore/
that will download files:
s3://bucket/backup/\fBfile1.ext\fR \-> /tmp/restore/\fBfile1.ext\fR
s3://bucket/backup/\fBdir123/file2.bin\fR \-> /tmp/restore/\fBdir123/file2.bin\fR
Without the trailing slash on source the behaviour is similar to
what has been demonstrated with upload:
s3cmd sync s3://test-bucket/backup /tmp/restore/
will download the files as:
s3://bucket/\fBbackup/file1.ext\fR \-> /tmp/restore/\fBbackup/file1.ext\fR
s3://bucket/\fBbackup/dir123/file2.bin\fR \-> /tmp/restore/\fBbackup/dir123/file2.bin\fR
All source file names, the bold ones above, are matched against \fBexclude\fR
rules and those that match are then re\-checked against \fBinclude\fR rules to see
whether they should be excluded or kept in the source list.
For the purpose of \fB\-\-exclude\fR and \fB\-\-include\fR matching only the
bold file names above are used. For instance only \fBpath/file1.ext\fR is tested
against the patterns, not \fI/local/\fBpath/file1.ext\fR
Both \fB\-\-exclude\fR and \fB\-\-include\fR work with shell-style wildcards (a.k.a. GLOB).
For a greater flexibility s3cmd provides Regular-expression versions of the two exclude options
named \fB\-\-rexclude\fR and \fB\-\-rinclude\fR.
The options with ...\fB\-from\fR suffix (eg \-\-rinclude\-from) expect a filename as
an argument. Each line of such a file is treated as one pattern.
There is only one set of patterns built from all \fB\-\-(r)exclude(\-from)\fR options
and similarly for include variant. Any file excluded with eg \-\-exclude can
be put back with a pattern found in \-\-rinclude\-from list.
Run s3cmd with \fB\-\-dry\-run\fR to verify that your rules work as expected.
Use together with \fB\-\-debug\fR get detailed information
about matching file names against exclude and include rules.
For example to exclude all files with ".jpg" extension except those beginning with a number use:
\-\-exclude '*.jpg' \-\-rinclude '[0-9].*\.jpg'
For the most up to date list of options run
.B s3cmd \-\-help
For more info about usage, examples and other related info visit project homepage at
.B http://s3tools.org
Please consider a donation if you have found s3cmd useful:
.B http://s3tools.org/donate
Written by Michal Ludvig <mludvig@logix.net.nz> and 15+ contributors
Prefered way to get support is our mailing list:
.I s3tools\-general@lists.sourceforge.net
Report bugs to
.I s3tools\-bugs@lists.sourceforge.net
Copyright \(co 2007,2008,2009,2010,2011,2012 Michal Ludvig <http://www.logix.cz/michal>
This is free software. You may redistribute copies of it under the terms of
the GNU General Public License version 2 <http://www.gnu.org/licenses/gpl.html>.
There is NO WARRANTY, to the extent permitted by law.