s3cmd.1
2dff2c09
 
2a6a46fe
 .\" !!! IMPORTANT: This file is generated from s3cmd \-\-help output using format-manpage.pl
 .\" !!!            Do your changes either in s3cmd file or in 'format\-manpage.pl' otherwise
2dff2c09
 .\" !!!            they will be overwritten!
 
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
25ff338b
 s3cmd \fBrm\fR \fIs3://BUCKET/OBJECT\fR
 Delete file from bucket (alias for del)
 .TP
6b20eb4b
 s3cmd \fBrestore\fR \fIs3://BUCKET/OBJECT\fR
 Restore file from Glacier storage
 .TP
593ef060
 s3cmd \fBsync\fR \fILOCAL_DIR s3://BUCKET[/PREFIX] or s3://BUCKET[/PREFIX] LOCAL_DIR\fR
23ace818
 Synchronize a directory tree to S3 (checks files freshness using size and md5 checksum, unless overridden by options, see below)
593ef060
 .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
6fa6fcb3
 s3cmd \fBmodify\fR \fIs3://BUCKET1/OBJECT\fR
 Modify object metadata
 .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
38085b13
 s3cmd \fBsetpolicy\fR \fIFILE s3://BUCKET\fR
 Modify Bucket Policy
 .TP
 s3cmd \fBdelpolicy\fR \fIs3://BUCKET\fR
 Delete Bucket Policy
fa5e43d7
 .TP
800b9a1c
 s3cmd \fBsetcors\fR \fIFILE s3://BUCKET\fR
 Modify Bucket CORS
 .TP
 s3cmd \fBdelcors\fR \fIs3://BUCKET\fR
 Delete Bucket CORS
 .TP
 s3cmd \fBpayer\fR \fIs3://BUCKET\fR
 Modify Bucket Requester Pays policy
 .TP
2dff2c09
 s3cmd \fBmultipart\fR \fIs3://BUCKET [Id]\fR
2a5a1d08
 Show multipart uploads
2dff2c09
 .TP
 s3cmd \fBabortmp\fR \fIs3://BUCKET/OBJECT Id\fR
2a5a1d08
 Abort a multipart upload
2dff2c09
 .TP
 s3cmd \fBlistmp\fR \fIs3://BUCKET/OBJECT Id\fR
2a5a1d08
 List parts of a multipart upload
2dff2c09
 .TP
593ef060
 s3cmd \fBaccesslog\fR \fIs3://BUCKET\fR
 Enable/disable bucket access logging
7393bdba
 .TP
5f3baaaf
 s3cmd \fBsign\fR \fISTRING\-TO\-SIGN\fR
593ef060
 Sign arbitrary string using the secret key
 .TP
2a5a1d08
 s3cmd \fBsignurl\fR \fIs3://BUCKET/OBJECT <expiry_epoch|+expiry_offset>\fR
fa5e43d7
 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
ac014aa8
 .TP
 s3cmd \fBexpire\fR \fIs3://BUCKET\fR
 Set or delete expiration rule for the bucket
25ff338b
 .TP
800b9a1c
 s3cmd \fBsetlifecycle\fR \fIFILE s3://BUCKET\fR
25ff338b
 Upload a lifecycle policy for the bucket
 .TP
 s3cmd \fBdellifecycle\fR \fIs3://BUCKET\fR
 Remove a lifecycle policy for the bucket
6063e01c
 
 
 .PP
 Commands for static WebSites configuration
a76d2f39
 .TP
2a6a46fe
 s3cmd \fBws\-create\fR \fIs3://BUCKET\fR
a76d2f39
 Create Website from bucket
 .TP
2a6a46fe
 s3cmd \fBws\-delete\fR \fIs3://BUCKET\fR
a76d2f39
 Delete Website
 .TP
2a6a46fe
 s3cmd \fBws\-info\fR \fIs3://BUCKET\fR
a76d2f39
 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
6b20eb4b
 changes you like. 
593ef060
 .TP
 \fB\-h\fR, \fB\-\-help\fR
 show this help message and exit
dd4fec78
 .TP
bf42f420
 \fB\-\-configure\fR
2dff2c09
 Invoke interactive (re)configuration tool. Optionally
2a6a46fe
 use as '\fB\-\-configure\fR s3://some\-bucket' to test access
2dff2c09
 to a specific bucket instead of attempting to list
 them all.
dd4fec78
 .TP
bf42f420
 \fB\-c\fR FILE, \fB\-\-config\fR=FILE
8c75d521
 Config file name. Defaults to $HOME/.s3cfg
dd4fec78
 .TP
bf42f420
 \fB\-\-dump\-config\fR
2dff2c09
 Dump current configuration after parsing config files
 and command line options and exit.
fa5e43d7
 .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
2dff2c09
 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
8c75d521
 \fB\-s\fR, \fB\-\-ssl\fR
 Use HTTPS connection when communicating with S3.
800b9a1c
 (default)
8c75d521
 .TP
 \fB\-\-no\-ssl\fR
800b9a1c
 Don't use HTTPS.
8c75d521
 .TP
593ef060
 \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
2dff2c09
 Continue getting a partially downloaded file (only for
 [get] command).
 .TP
 \fB\-\-continue\-put\fR
 Continue uploading partially uploaded files or
 multipart upload parts.  Restarts/parts files that
 don't have matching size and md5.  Skips files/parts
 that do.  Note: md5sum checks are not always
 sufficient to check (part) file equality.  Enable this
 at your own risk.
 .TP
 \fB\-\-upload\-id\fR=UPLOAD_ID
 UploadId for Multipart Upload, in case you want
2a6a46fe
 continue an existing upload (equivalent to \fB\-\-continue\-\fR
2dff2c09
 put) and there are multiple partial uploads.  Use
 s3cmd multipart [URI] to see what UploadIds are
 associated with the given URI.
593ef060
 .TP
 \fB\-\-skip\-existing\fR
2dff2c09
 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
2dff2c09
 Check MD5 sums when comparing files for [sync].
 (default)
da0fb7b8
 .TP
 \fB\-\-no\-check\-md5\fR
2dff2c09
 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
2dff2c09
 Store objects with default ACL allowing access for you
 only.
593ef060
 .TP
 \fB\-\-acl\-grant\fR=PERMISSION:EMAIL or USER_CANONICAL_ID
2dff2c09
 Grant stated permission to a given amazon user.
 Permission is one of: read, write, read_acp,
 write_acp, full_control, all
593ef060
 .TP
2a6a46fe
 \fB\-\-acl\-revoke\fR=PERMISSION:USER_CANONICAL_ID
2dff2c09
 Revoke stated permission for a given amazon user.
 Permission is one of: read, write, read_acp, wr
 ite_acp, full_control, all
7393bdba
 .TP
6b20eb4b
 \fB\-D\fR NUM, \fB\-\-restore\-days\fR=NUM
 Number of days to keep restored file available (only
 for 'restore' command).
 .TP
7393bdba
 \fB\-\-delete\-removed\fR
2dff2c09
 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
800b9a1c
 *OBSOLETE* Put all updated files into place at end
 [sync]
c3deb6a8
 .TP
2dff2c09
 \fB\-\-max\-delete\fR=NUM
 Do not delete more than NUM files. [del] and [sync]
 .TP
fa5e43d7
 \fB\-\-add\-destination\fR=ADDITIONAL_DESTINATIONS
2dff2c09
 Additional destination for parallel uploads, in
 addition to last arg.  May be repeated.
fa5e43d7
 .TP
 \fB\-\-delete\-after\-fetch\fR
2dff2c09
 Delete remote objects after fetching to local file
 (only for [get] and [sync] commands).
f230f799
 .TP
7393bdba
 \fB\-p\fR, \fB\-\-preserve\fR
2dff2c09
 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
2dff2c09
 Filenames and paths matching GLOB will be excluded
 from sync
ee852c0a
 .TP
593ef060
 \fB\-\-exclude\-from\fR=FILE
2a6a46fe
 Read --exclude GLOBs from FILE
2d7d5543
 .TP
593ef060
 \fB\-\-rexclude\fR=REGEXP
2dff2c09
 Filenames and paths matching REGEXP (regular
 expression) will be excluded from sync
2d7d5543
 .TP
593ef060
 \fB\-\-rexclude\-from\fR=FILE
2a6a46fe
 Read --rexclude REGEXPs from FILE
ee852c0a
 .TP
593ef060
 \fB\-\-include\fR=GLOB
2dff2c09
 Filenames and paths matching GLOB will be included
 even if previously excluded by one of
5f3baaaf
 \fB\-\-(r)exclude(\-from)\fR patterns
dd4fec78
 .TP
593ef060
 \fB\-\-include\-from\fR=FILE
2a6a46fe
 Read --include GLOBs from FILE
18c4a150
 .TP
593ef060
 \fB\-\-rinclude\fR=REGEXP
2a6a46fe
 Same as --include but uses REGEXP (regular expression)
2dff2c09
 instead of GLOB
6454bfb7
 .TP
593ef060
 \fB\-\-rinclude\-from\fR=FILE
2a6a46fe
 Read --rinclude REGEXPs from FILE
2dff2c09
 .TP
bc547d1a
 \fB\-\-files\-from\fR=FILE
2dff2c09
 Read list of source-file names from FILE. Use - to
 read from stdin.
bc547d1a
 .TP
8c75d521
 \fB\-\-region\fR=REGION, \fB\-\-bucket\-location\fR=REGION
 Region to create bucket in. As of now the regions are:
2a6a46fe
 us\-east\-1, us\-west\-1, us\-west\-2, eu\-west\-1, eu\-
 central\-1, ap\-northeast\-1, ap\-southeast\-1, ap\-
 southeast\-2, sa\-east\-1
dd4fec78
 .TP
4c248936
 \fB\-\-host\fR=HOSTNAME
 HOSTNAME:PORT for S3 endpoint (default:
 s3.amazonaws.com, alternatives such as s3\-eu\-
 west\-1.amazonaws.com). You should also set \fB\-\-host\-\fR
 bucket.
 .TP
 \fB\-\-host\-bucket\fR=HOST_BUCKET
 DNS\-style bucket+hostname:port template for accessing
 a bucket (default: %(bucket)s.s3.amazonaws.com)
 .TP
593ef060
 \fB\-\-reduced\-redundancy\fR, \fB\-\-rr\fR
2a6a46fe
 Store object with 'Reduced redundancy'. Lower per\-GB
2dff2c09
 price. [put, cp, mv]
01a80524
 .TP
8c75d521
 \fB\-\-no\-reduced\-redundancy\fR, \fB\-\-no\-rr\fR
2a6a46fe
 Store object without 'Reduced redundancy'. Higher per\-
8c75d521
 GB price. [put, cp, mv]
 .TP
800b9a1c
 \fB\-\-storage\-class\fR=CLASS
 Store object with specified CLASS (STANDARD,
 STANDARD_IA, or REDUCED_REDUNDANCY). Lower per\-GB
 price. [put, cp, mv]
 .TP
593ef060
 \fB\-\-access\-logging\-target\-prefix\fR=LOG_TARGET_PREFIX
2dff2c09
 Target prefix for access logs (S3 URI) (for [cfmodify]
 and [accesslog] commands)
01a80524
 .TP
593ef060
 \fB\-\-no\-access\-logging\fR
2dff2c09
 Disable access logging (for [cfmodify] and [accesslog]
 commands)
01a80524
 .TP
2dff2c09
 \fB\-\-default\-mime\-type\fR=DEFAULT_MIME_TYPE
2a6a46fe
 Default MIME\-type for stored objects. Application
 default is binary/octet\-stream.
01a80524
 .TP
fa5e43d7
 \fB\-M\fR, \fB\-\-guess\-mime\-type\fR
5f3baaaf
 Guess MIME\-type of files by their extension or mime
 magic. Fall back to default MIME\-Type as specified by
2a6a46fe
 \fB\-\-default\-mime\-type\fR option
a76d2f39
 .TP
 \fB\-\-no\-guess\-mime\-type\fR
2dff2c09
 Don't guess MIME-type and use the default type
 instead.
a76d2f39
 .TP
b4207d9c
 \fB\-\-no\-mime\-magic\fR
 Don't use mime magic when guessing MIME-type.
 .TP
a76d2f39
 \fB\-m\fR MIME/TYPE, \fB\-\-mime\-type\fR=MIME/TYPE
2a6a46fe
 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
2dff2c09
 Add a given HTTP header to the upload request. Can be
6fa6fcb3
 used multiple times. For instance set 'Expires' or
2a6a46fe
 \&'Cache\-Control' headers (or both) using this option.
2dff2c09
 .TP
8c75d521
 \fB\-\-remove\-header\fR=NAME
 Remove a given HTTP header.  Can be used multiple
2a6a46fe
 times.  For instance, remove 'Expires' or 'Cache\-
8c75d521
 Control' headers (or both) using this option. [modify]
 .TP
2dff2c09
 \fB\-\-server\-side\-encryption\fR
2a6a46fe
 Specifies that server\-side encryption will be used
8c75d521
 when putting objects. [put, sync, cp, modify]
01a80524
 .TP
800b9a1c
 \fB\-\-server\-side\-encryption\-kms\-id\fR=KMS_KEY
 Specifies the key id used for server\-side encryption
 with AWS KMS\-Managed Keys (SSE\-KMS) when putting
 objects. [put, sync, cp, modify]
 .TP
593ef060
 \fB\-\-encoding\fR=ENCODING
2dff2c09
 Override autodetected terminal and filesystem encoding
2a6a46fe
 (character set). Autodetected: UTF\-8
fa5e43d7
 .TP
 \fB\-\-add\-encoding\-exts\fR=EXTENSIONs
2dff2c09
 Add encoding to these comma delimited extensions i.e.
 (css,js,html) when uploading to S3 )
01a80524
 .TP
593ef060
 \fB\-\-verbatim\fR
2dff2c09
 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
2dff2c09
 Disable multipart upload on files bigger than
2a6a46fe
 \fB\-\-multipart\-chunk\-size\-mb\fR
6063e01c
 .TP
 \fB\-\-multipart\-chunk\-size\-mb\fR=SIZE
2dff2c09
 Size of each chunk of a multipart upload. Files bigger
2a6a46fe
 than SIZE are automatically uploaded as multithreaded\-
2dff2c09
 multipart, smaller files are uploaded using the
2a6a46fe
 traditional method. SIZE is in Mega\-Bytes, default
6fa6fcb3
 chunk size is 15MB, minimum allowed chunk size is 5MB,
 maximum is 5GB.
6063e01c
 .TP
593ef060
 \fB\-\-list\-md5\fR
2dff2c09
 Include MD5 sums in bucket listings (only for 'ls'
 command).
01a80524
 .TP
593ef060
 \fB\-H\fR, \fB\-\-human\-readable\-sizes\fR
2dff2c09
 Print sizes in human readable form (eg 1kB instead of
 1234).
01a80524
 .TP
a76d2f39
 \fB\-\-ws\-index\fR=WEBSITE_INDEX
2a6a46fe
 Name of index\-document (only for [ws\-create] command)
a76d2f39
 .TP
 \fB\-\-ws\-error\fR=WEBSITE_ERROR
2a6a46fe
 Name of error\-document (only for [ws\-create] command)
a76d2f39
 .TP
ac014aa8
 \fB\-\-expiry\-date\fR=EXPIRY_DATE
6fa6fcb3
 Indicates when the expiration rule takes effect. (only
49055997
 for [expire] command)
ac014aa8
 .TP
 \fB\-\-expiry\-days\fR=EXPIRY_DAYS
 Indicates the number of days after object creation the
6fa6fcb3
 expiration rule takes effect. (only for [expire]
ac014aa8
 command)
 .TP
 \fB\-\-expiry\-prefix\fR=EXPIRY_PREFIX
 Identifying one or more objects with the prefix to
 which the expiration rule applies. (only for [expire]
 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
4c248936
 \fB\-\-stats\fR
 Give some file-transfer stats.
 .TP
593ef060
 \fB\-\-enable\fR
2dff2c09
 Enable given CloudFront distribution (only for
 [cfmodify] command)
01a80524
 .TP
593ef060
 \fB\-\-disable\fR
2dff2c09
 Enable given CloudFront distribution (only for
 [cfmodify] command)
01a80524
 .TP
d065ce30
 \fB\-\-cf\-invalidate\fR
2dff2c09
 Invalidate the uploaded filed in CloudFront. Also see
 [cfinval] command.
fa5e43d7
 .TP
 \fB\-\-cf\-invalidate\-default\-index\fR
2dff2c09
 When using Custom Origin and S3 static website,
 invalidate the default index file.
fa5e43d7
 .TP
 \fB\-\-cf\-no\-invalidate\-default\-index\-root\fR
2dff2c09
 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
2dff2c09
 Add given CNAME to a CloudFront distribution (only for
 [cfcreate] and [cfmodify] commands)
dd4fec78
 .TP
593ef060
 \fB\-\-cf\-remove\-cname\fR=CNAME
2dff2c09
 Remove given CNAME from a CloudFront distribution
 (only for [cfmodify] command)
25f6f8c9
 .TP
593ef060
 \fB\-\-cf\-comment\fR=COMMENT
2dff2c09
 Set COMMENT for a given CloudFront distribution (only
 for [cfcreate] and [cfmodify] commands)
593ef060
 .TP
 \fB\-\-cf\-default\-root\-object\fR=DEFAULT_ROOT_OBJECT
2dff2c09
 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
4c248936
 Show s3cmd version (1.6.1) 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
986aebb7
 .TP
 \fB\-q\fR, \fB\-\-quiet\fR
 Silence output on stdout
8c75d521
 .TP
 \fB\-\-ca\-certs\fR=CA_CERTS_FILE
 Path to SSL CA certificate FILE (instead of system
 default)
 .TP
 \fB\-\-check\-certificate\fR
 Check SSL certificate validity
 .TP
 \fB\-\-no\-check\-certificate\fR
800b9a1c
 Do not check SSL certificate validity
 .TP
 \fB\-\-check\-hostname\fR
 Check SSL certificate hostname validity
 .TP
 \fB\-\-no\-check\-hostname\fR
 Do not check SSL certificate hostname validity
f5e72c8e
 .TP
 \fB\-\-signature\-v2\fR
 Use AWS Signature version 2 instead of newer signature
2a6a46fe
 methods. Helpful for S3\-like systems that don't have
f5e72c8e
 AWS Signature v4 yet.
2a6a46fe
 .TP
 \fB\-\-limit\-rate\fR=LIMITRATE
 Limit the upload or download speed to amount bytes per
 second.  Amount may be expressed in bytes, kilobytes
 with the k suffix, or megabytes with the m suffix
800b9a1c
 .TP
 \fB\-\-requester\-pays\fR
 Set the REQUESTER PAYS flag for operations
 .TP
 \fB\-l\fR, \fB\-\-long\-listing\fR
 Produce long listing [ls]
 .TP
 \fB\-\-stop\-on\-error\fR
 stop if error in transfer
 .TP
 \fB\-\-content\-disposition\fR=CONTENT_DISPOSITION
 Provide a Content\-Disposition for signed URLs, e.g.,
 "inline; filename=myvideo.mp4"
 .TP
 \fB\-\-content\-type\fR=CONTENT_TYPE
 Provide a Content\-Type for signed URLs, e.g.,
 "video/mp4"
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
2a6a46fe
 	s3cmd sync /local/path/ s3://test\-bucket/backup/
ee852c0a
 .fi
 .PP
 This command will find all files under /local/path directory and copy them 
2a6a46fe
 to corresponding paths under s3://test\-bucket/backup on the remote side.
ee852c0a
 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
2a6a46fe
 	s3cmd sync /local/path s3://test\-bucket/backup/
01a80524
 .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
2a6a46fe
 	s3cmd sync s3://test\-bucket/backup/ ~/restore/
ee852c0a
 .fi
 that will download files:
 .nf
2a6a46fe
 	s3://bucket/backup/\fBfile1.ext\fR         \->  ~/restore/\fBfile1.ext\fR
 	s3://bucket/backup/\fBdir123/file2.bin\fR  \->  ~/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
2a6a46fe
 	s3cmd sync s3://test\-bucket/backup ~/restore/
01a80524
 .fi
 will download the files as:
 .nf
2a6a46fe
 	s3://bucket/\fBbackup/file1.ext\fR         \->  ~/restore/\fBbackup/file1.ext\fR
 	s3://bucket/\fBbackup/dir123/file2.bin\fR  \->  ~/restore/\fBbackup/dir123/file2.bin\fR
01a80524
 .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
2a6a46fe
 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 
01a80524
 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
2a6a46fe
 	\-\-exclude '*.jpg' \-\-rinclude '[0\-9].*\.jpg'
ac014aa8
 .PP
 To exclude all files except "*.jpg" extension, use:
 .PP
 	\-\-exclude '*' \-\-include '*.jpg'
 .PP
 To exclude local directory 'somedir', be sure to use a trailing forward slash, as such:
 .PP
 	\-\-exclude 'somedir/'
 .PP
 
01a80524
 .SH SEE ALSO
6fa6fcb3
 For the most up to date list of options run: 
01a80524
 .B s3cmd \-\-help
 .br
6fa6fcb3
 For more info about usage, examples and other related info visit project homepage at:
01a80524
 .B http://s3tools.org
dd4fec78
 .SH AUTHOR
6fa6fcb3
 Written by Michal Ludvig and contributors
01a80524
 .SH CONTACT, SUPPORT
5311543b
 Preferred way to get support is our mailing list:
6fa6fcb3
 .br
01a80524
 .I s3tools\-general@lists.sourceforge.net
6fa6fcb3
 .br
 or visit the project homepage:
 .br
 .B http://s3tools.org
dd4fec78
 .SH REPORTING BUGS
 Report bugs to 
01a80524
 .I s3tools\-bugs@lists.sourceforge.net
dd4fec78
 .SH COPYRIGHT
800b9a1c
 Copyright \(co 2007\-2015 TGRMN Software \- http://www.tgrmn.com \- and contributors
6fa6fcb3
 .br
 .SH LICENSE
 This program is free software; you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by
 the Free Software Foundation; either version 2 of the License, or
 (at your option) any later version.
 This program is distributed in the hope that it will be useful,
 but WITHOUT ANY WARRANTY; without even the implied warranty of
 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 GNU General Public License for more details.
dd4fec78
 .br