s3cmd.1
593ef060
 
dd4fec78
 .TH s3cmd 1
 .SH NAME
01a80524
 s3cmd \- tool for managing Amazon S3 storage space and Amazon CloudFront content delivery network
dd4fec78
 .SH SYNOPSIS
 .B s3cmd
 [\fIOPTIONS\fR] \fICOMMAND\fR [\fIPARAMETERS\fR]
 .SH DESCRIPTION
 .PP
 .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.
593ef060
 
 .SH COMMANDS
dd4fec78
 .PP
 .B s3cmd
 can do several \fIactions\fR specified by the following \fIcommands\fR.
 .TP
593ef060
 s3cmd \fBmb\fR \fIs3://BUCKET\fR
dd4fec78
 Make bucket
 .TP
593ef060
 s3cmd \fBrb\fR \fIs3://BUCKET\fR
dd4fec78
 Remove bucket
 .TP
593ef060
 s3cmd \fBls\fR \fI[s3://BUCKET[/PREFIX]]\fR
dd4fec78
 List objects or buckets
 .TP
593ef060
 s3cmd \fBla\fR \fI\fR
dd4fec78
 List all object in all buckets
 .TP
593ef060
 s3cmd \fBput\fR \fIFILE [FILE...] s3://BUCKET[/PREFIX]\fR
 Put file into bucket
dd4fec78
 .TP
593ef060
 s3cmd \fBget\fR \fIs3://BUCKET/OBJECT LOCAL_FILE\fR
 Get file from bucket
dd4fec78
 .TP
593ef060
 s3cmd \fBdel\fR \fIs3://BUCKET/OBJECT\fR
dd4fec78
 Delete file from bucket
f298b348
 .TP
593ef060
 s3cmd \fBsync\fR \fILOCAL_DIR s3://BUCKET[/PREFIX] or s3://BUCKET[/PREFIX] LOCAL_DIR\fR
 Synchronize a directory tree to S3
 .TP
 s3cmd \fBdu\fR \fI[s3://BUCKET[/PREFIX]]\fR
 Disk usage by buckets
 .TP
 s3cmd \fBinfo\fR \fIs3://BUCKET[/OBJECT]\fR
 Get various information about Buckets or Files
 .TP
 s3cmd \fBcp\fR \fIs3://BUCKET1/OBJECT1 s3://BUCKET2[/OBJECT2]\fR
 Copy object
29893afc
 .TP
593ef060
 s3cmd \fBmv\fR \fIs3://BUCKET1/OBJECT1 s3://BUCKET2[/OBJECT2]\fR
 Move object
7393bdba
 .TP
593ef060
 s3cmd \fBsetacl\fR \fIs3://BUCKET[/OBJECT]\fR
 Modify Access control list for Bucket or Files
01a80524
 .TP
fa5e43d7
 s3cmd \fBsetpolicy\fR \fIs3://BUCKET POLICY_STRING\fR
 Set an access policy for a bucket
 .TP
593ef060
 s3cmd \fBaccesslog\fR \fIs3://BUCKET\fR
 Enable/disable bucket access logging
7393bdba
 .TP
593ef060
 s3cmd \fBsign\fR \fISTRING-TO-SIGN\fR
 Sign arbitrary string using the secret key
 .TP
fa5e43d7
 s3cmd \fBsignurl\fR \fIs3://BUCKET/OBJECT expiry_epoch\fR
 Sign an S3 URL to provide limited public access with expiry
ff6e561b
 .TP
593ef060
 s3cmd \fBfixbucket\fR \fIs3://BUCKET[/PREFIX]\fR
 Fix invalid file names in a bucket
6063e01c
 
 
 .PP
 Commands for static WebSites configuration
a76d2f39
 .TP
 s3cmd \fBws-create\fR \fIs3://BUCKET\fR
 Create Website from bucket
 .TP
 s3cmd \fBws-delete\fR \fIs3://BUCKET\fR
 Delete Website
 .TP
 s3cmd \fBws-info\fR \fIs3://BUCKET\fR
 Info about Website
593ef060
 
dd4fec78
 
01a80524
 .PP
 Commands for CloudFront management
 .TP
593ef060
 s3cmd \fBcflist\fR \fI\fR
01a80524
 List CloudFront distribution points
 .TP
593ef060
 s3cmd \fBcfinfo\fR \fI[cf://DIST_ID]\fR
01a80524
 Display CloudFront distribution point parameters
 .TP
593ef060
 s3cmd \fBcfcreate\fR \fIs3://BUCKET\fR
01a80524
 Create CloudFront distribution point
 .TP
593ef060
 s3cmd \fBcfdelete\fR \fIcf://DIST_ID\fR
01a80524
 Delete CloudFront distribution point
 .TP
593ef060
 s3cmd \fBcfmodify\fR \fIcf://DIST_ID\fR
01a80524
 Change CloudFront distribution point parameters
d065ce30
 .TP
 s3cmd \fBcfinvalinfo\fR \fIcf://DIST_ID[/INVAL_ID]\fR
 Display CloudFront invalidation request(s) status
01a80524
 
593ef060
 
dd4fec78
 .SH OPTIONS
 .PP
 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
01a80524
 changes you like. 
593ef060
 .TP
 \fB\-h\fR, \fB\-\-help\fR
 show this help message and exit
dd4fec78
 .TP
bf42f420
 \fB\-\-configure\fR
fa5e43d7
 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.
dd4fec78
 .TP
bf42f420
 \fB\-c\fR FILE, \fB\-\-config\fR=FILE
593ef060
 Config file name. Defaults to /home/mludvig/.s3cfg
dd4fec78
 .TP
bf42f420
 \fB\-\-dump\-config\fR
fa5e43d7
 Dump current configuration after parsing config files and command line options and exit.
 .TP
 \fB\-\-access_key\fR=ACCESS_KEY
 AWS Access Key
 .TP
 \fB\-\-secret_key\fR=SECRET_KEY
 AWS Secret Key
01a80524
 .TP
 \fB\-n\fR, \fB\-\-dry\-run\fR
fa5e43d7
 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)
593ef060
 .TP
 \fB\-e\fR, \fB\-\-encrypt\fR
 Encrypt files before uploading to S3.
 .TP
 \fB\-\-no\-encrypt\fR
 Don't encrypt files.
 .TP
 \fB\-f\fR, \fB\-\-force\fR
 Force overwrite and other dangerous operations.
 .TP
 \fB\-\-continue\fR
fa5e43d7
 Continue getting a partially downloaded file (only for [get] command).
593ef060
 .TP
 \fB\-\-skip\-existing\fR
fa5e43d7
 Skip over files that exist at the destination (only for [get] and [sync] commands).
593ef060
 .TP
 \fB\-r\fR, \fB\-\-recursive\fR
 Recursive upload, download or removal.
 .TP
da0fb7b8
 \fB\-\-check\-md5\fR
fa5e43d7
 Check MD5 sums when comparing files for [sync]. (default)
da0fb7b8
 .TP
 \fB\-\-no\-check\-md5\fR
fa5e43d7
 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.
da0fb7b8
 .TP
593ef060
 \fB\-P\fR, \fB\-\-acl\-public\fR
 Store objects with ACL allowing read for anyone.
 .TP
 \fB\-\-acl\-private\fR
fa5e43d7
 Store objects with default ACL allowing access for you only.
593ef060
 .TP
 \fB\-\-acl\-grant\fR=PERMISSION:EMAIL or USER_CANONICAL_ID
fa5e43d7
 Grant stated permission to a given amazon user. Permission is one of: read, write, read_acp, write_acp, full_control, all
593ef060
 .TP
 \fB\-\-acl\-revoke\fR=PERMISSION:USER_CANONICAL_ID
fa5e43d7
 Revoke stated permission for a given amazon user. Permission is one of: read, write, read_acp, wr     ite_acp, full_control, all
7393bdba
 .TP
 \fB\-\-delete\-removed\fR
fa5e43d7
 Delete remote objects with no corresponding local file [sync]
7393bdba
 .TP
 \fB\-\-no\-delete\-removed\fR
593ef060
 Don't delete remote objects.
7393bdba
 .TP
d5dc2c0f
 \fB\-\-delete\-after\fR
fa5e43d7
 Perform deletes after new uploads [sync]
d5dc2c0f
 .TP
c3deb6a8
 \fB\-\-delay\-updates\fR
 Put all updated files into place at end [sync]
 .TP
fa5e43d7
 \fB\-\-add\-destination\fR=ADDITIONAL_DESTINATIONS
 Additional destination for parallel uploads, in addition to last arg.  May be repeated.
 .TP
 \fB\-\-delete\-after\-fetch\fR
 Delete remote objects after fetching to local file (only for [get] and [sync] commands).
 .TP
7393bdba
 \fB\-p\fR, \fB\-\-preserve\fR
fa5e43d7
 Preserve filesystem attributes (mode, ownership, timestamps). Default for [sync] command.
7393bdba
 .TP
 \fB\-\-no\-preserve\fR
593ef060
 Don't store FS attributes
ee852c0a
 .TP
593ef060
 \fB\-\-exclude\fR=GLOB
fa5e43d7
 Filenames and paths matching GLOB will be excluded from sync
ee852c0a
 .TP
593ef060
 \fB\-\-exclude\-from\fR=FILE
 Read --exclude GLOBs from FILE
2d7d5543
 .TP
593ef060
 \fB\-\-rexclude\fR=REGEXP
fa5e43d7
 Filenames and paths matching REGEXP (regular expression) will be excluded from sync
2d7d5543
 .TP
593ef060
 \fB\-\-rexclude\-from\fR=FILE
 Read --rexclude REGEXPs from FILE
ee852c0a
 .TP
593ef060
 \fB\-\-include\fR=GLOB
fa5e43d7
 Filenames and paths matching GLOB will be included even if previously excluded by one of --(r)exclude(-from) patterns
dd4fec78
 .TP
593ef060
 \fB\-\-include\-from\fR=FILE
 Read --include GLOBs from FILE
18c4a150
 .TP
593ef060
 \fB\-\-rinclude\fR=REGEXP
fa5e43d7
 Same as --include but uses REGEXP (regular expression) instead of GLOB
6454bfb7
 .TP
593ef060
 \fB\-\-rinclude\-from\fR=FILE
 Read --rinclude REGEXPs from FILE
dd4fec78
 .TP
593ef060
 \fB\-\-bucket\-location\fR=BUCKET_LOCATION
fa5e43d7
 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
dd4fec78
 .TP
593ef060
 \fB\-\-reduced\-redundancy\fR, \fB\-\-rr\fR
fa5e43d7
 Store object with 'Reduced redundancy'. Lower per-GB price. [put, cp, mv]
01a80524
 .TP
593ef060
 \fB\-\-access\-logging\-target\-prefix\fR=LOG_TARGET_PREFIX
fa5e43d7
 Target prefix for access logs (S3 URI) (for [cfmodify] and [accesslog] commands)
01a80524
 .TP
593ef060
 \fB\-\-no\-access\-logging\fR
fa5e43d7
 Disable access logging (for [cfmodify] and [accesslog] commands)
01a80524
 .TP
a76d2f39
 \fB\-\-default\-mime\-type\fR
fa5e43d7
 Default MIME-type for stored objects. Application default is binary/octet-stream.
01a80524
 .TP
fa5e43d7
 \fB\-M\fR, \fB\-\-guess\-mime\-type\fR
 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
a76d2f39
 .TP
 \fB\-\-no\-guess\-mime\-type\fR
fa5e43d7
 Don't guess MIME-type and use the default type instead.
a76d2f39
 .TP
 \fB\-m\fR MIME/TYPE, \fB\-\-mime\-type\fR=MIME/TYPE
fa5e43d7
 Force MIME-type. Override both \fB--default-mime-type\fR and \fB--guess-mime-type\fR.
01a80524
 .TP
593ef060
 \fB\-\-add\-header\fR=NAME:VALUE
fa5e43d7
 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.
01a80524
 .TP
593ef060
 \fB\-\-encoding\fR=ENCODING
fa5e43d7
 Override autodetected terminal and filesystem encoding (character set). Autodetected: UTF-8
 .TP
 \fB\-\-add\-encoding\-exts\fR=EXTENSIONs
 Add encoding to these comma delimited extensions i.e. (css,js,html) when uploading to S3 )
01a80524
 .TP
593ef060
 \fB\-\-verbatim\fR
fa5e43d7
 Use the S3 name as given on the command line. No pre-processing, encoding, etc. Use with caution!
01a80524
 .TP
6063e01c
 \fB\-\-disable\-multipart\fR
fa5e43d7
 Disable multipart upload on files bigger than --multipart-chunk-size-mb
6063e01c
 .TP
 \fB\-\-multipart\-chunk\-size\-mb\fR=SIZE
fa5e43d7
 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.
6063e01c
 .TP
593ef060
 \fB\-\-list\-md5\fR
fa5e43d7
 Include MD5 sums in bucket listings (only for 'ls' command).
01a80524
 .TP
593ef060
 \fB\-H\fR, \fB\-\-human\-readable\-sizes\fR
fa5e43d7
 Print sizes in human readable form (eg 1kB instead of 1234).
01a80524
 .TP
a76d2f39
 \fB\-\-ws\-index\fR=WEBSITE_INDEX
 Name of error-document (only for [ws-create] command)
 .TP
 \fB\-\-ws\-error\fR=WEBSITE_ERROR
 Name of index-document (only for [ws-create] command)
 .TP
593ef060
 \fB\-\-progress\fR
 Display progress meter (default on TTY).
01a80524
 .TP
593ef060
 \fB\-\-no\-progress\fR
 Don't display progress meter (default on non-TTY).
01a80524
 .TP
593ef060
 \fB\-\-enable\fR
fa5e43d7
 Enable given CloudFront distribution (only for [cfmodify] command)
01a80524
 .TP
593ef060
 \fB\-\-disable\fR
fa5e43d7
 Enable given CloudFront distribution (only for [cfmodify] command)
01a80524
 .TP
d065ce30
 \fB\-\-cf\-invalidate\fR
fa5e43d7
 Invalidate the uploaded filed in CloudFront. Also see [cfinval] command.
 .TP
 \fB\-\-cf\-invalidate\-default\-index\fR
 When using Custom Origin and S3 static website, invalidate the default index file.
 .TP
 \fB\-\-cf\-no\-invalidate\-default\-index\-root\fR
 When using Custom Origin and S3 static website, don't invalidate the path to the default index file.
d065ce30
 .TP
593ef060
 \fB\-\-cf\-add\-cname\fR=CNAME
fa5e43d7
 Add given CNAME to a CloudFront distribution (only for [cfcreate] and [cfmodify] commands)
dd4fec78
 .TP
593ef060
 \fB\-\-cf\-remove\-cname\fR=CNAME
fa5e43d7
 Remove given CNAME from a CloudFront distribution (only for [cfmodify] command)
25f6f8c9
 .TP
593ef060
 \fB\-\-cf\-comment\fR=COMMENT
fa5e43d7
 Set COMMENT for a given CloudFront distribution (only for [cfcreate] and [cfmodify] commands)
593ef060
 .TP
 \fB\-\-cf\-default\-root\-object\fR=DEFAULT_ROOT_OBJECT
fa5e43d7
 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)
01a80524
 .TP
bf42f420
 \fB\-v\fR, \fB\-\-verbose\fR
dd4fec78
 Enable verbose output.
 .TP
bf42f420
 \fB\-d\fR, \fB\-\-debug\fR
dd4fec78
 Enable debug output.
 .TP
bf42f420
 \fB\-\-version\fR
fa5e43d7
 Show s3cmd version (1.5.0-alpha1) and exit.
593ef060
 .TP
 \fB\-F\fR, \fB\-\-follow\-symlinks\fR
 Follow symbolic links as if they are regular files
fa5e43d7
 .TP
 \fB\-\-cache\-file\fR=FILE
 Cache FILE containing local source MD5 values
593ef060
 
dd4fec78
 
593ef060
 .SH EXAMPLES
ee852c0a
 One of the most powerful commands of \fIs3cmd\fR is \fBs3cmd sync\fR used for 
01a80524
 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.
ee852c0a
 .PP
 Basic usage common in backup scenarios is as simple as:
 .nf
01a80524
 	s3cmd sync /local/path/ s3://test-bucket/backup/
ee852c0a
 .fi
 .PP
 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:
 .nf
01a80524
 	/local/path/\fBfile1.ext\fR         \->  s3://bucket/backup/\fBfile1.ext\fR
 	/local/path/\fBdir123/file2.bin\fR  \->  s3://bucket/backup/\fBdir123/file2.bin\fR
ee852c0a
 .fi
01a80524
 .PP
 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:
 .nf
 	s3cmd sync /local/path s3://test-bucket/backup/
 .fi
 will sync:
 .nf
 	/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
 .fi
 .PP
ee852c0a
 To retrieve the files back from S3 use inverted syntax:
 .nf
01a80524
 	s3cmd sync s3://test-bucket/backup/ /tmp/restore/
ee852c0a
 .fi
 that will download files:
 .nf
01a80524
 	s3://bucket/backup/\fBfile1.ext\fR         \->  /tmp/restore/\fBfile1.ext\fR       
 	s3://bucket/backup/\fBdir123/file2.bin\fR  \->  /tmp/restore/\fBdir123/file2.bin\fR
ee852c0a
 .fi
2d7d5543
 .PP
01a80524
 Without the trailing slash on source the behaviour is similar to 
 what has been demonstrated with upload:
 .nf
 	s3cmd sync s3://test-bucket/backup /tmp/restore/
 .fi
 will download the files as:
 .nf
 	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
 .fi
 .PP
 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.
 .PP
 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
ee852c0a
 .PP
01a80524
 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.
ee852c0a
 .PP
01a80524
 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.
ee852c0a
 .PP
01a80524
 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.
ee852c0a
 .PP
01a80524
 For example to exclude all files with ".jpg" extension except those beginning with a number use:
ee852c0a
 .PP
01a80524
 	\-\-exclude '*.jpg' \-\-rinclude '[0-9].*\.jpg'
 .SH SEE ALSO
 For the most up to date list of options run 
 .B s3cmd \-\-help
 .br
 For more info about usage, examples and other related info visit project homepage at
 .br
 .B http://s3tools.org
da0fb7b8
 .SH DONATIONS
 Please consider a donation if you have found s3cmd useful:
 .br
 .B http://s3tools.org/donate
dd4fec78
 .SH AUTHOR
da0fb7b8
 Written by Michal Ludvig <mludvig@logix.net.nz> and 15+ contributors
01a80524
 .SH CONTACT, SUPPORT
 Prefered way to get support is our mailing list:
 .I s3tools\-general@lists.sourceforge.net
dd4fec78
 .SH REPORTING BUGS
 Report bugs to 
01a80524
 .I s3tools\-bugs@lists.sourceforge.net
dd4fec78
 .SH COPYRIGHT
6063e01c
 Copyright \(co 2007,2008,2009,2010,2011,2012 Michal Ludvig <http://www.logix.cz/michal>
dd4fec78
 .br
 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.