123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722 |
- .\" !!! 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
- .\" !!! they will be overwritten!
- .TH s3cmd 1
- .SH NAME
- s3cmd \- tool for managing Amazon S3 storage space and Amazon CloudFront content delivery network
- .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.
- .SH COMMANDS
- .PP
- .B s3cmd
- can do several \fIactions\fR specified by the following \fIcommands\fR.
- .TP
- s3cmd \fBmb\fR \fIs3://BUCKET\fR
- Make bucket
- .TP
- s3cmd \fBrb\fR \fIs3://BUCKET\fR
- Remove bucket
- .TP
- s3cmd \fBls\fR \fI[s3://BUCKET[/PREFIX]]\fR
- List objects or buckets
- .TP
- s3cmd \fBla\fR \fI\fR
- List all object in all buckets
- .TP
- s3cmd \fBput\fR \fIFILE [FILE...] s3://BUCKET[/PREFIX]\fR
- Put file into bucket
- .TP
- s3cmd \fBget\fR \fIs3://BUCKET/OBJECT LOCAL_FILE\fR
- Get file from bucket
- .TP
- s3cmd \fBdel\fR \fIs3://BUCKET/OBJECT\fR
- Delete file from bucket
- .TP
- s3cmd \fBrm\fR \fIs3://BUCKET/OBJECT\fR
- Delete file from bucket (alias for del)
- .TP
- s3cmd \fBrestore\fR \fIs3://BUCKET/OBJECT\fR
- Restore file from Glacier storage
- .TP
- s3cmd \fBsync\fR \fILOCAL_DIR s3://BUCKET[/PREFIX] or s3://BUCKET[/PREFIX] LOCAL_DIR or s3://BUCKET[/PREFIX] s3://BUCKET[/PREFIX]\fR
- Synchronize a directory tree to S3 (checks files freshness using size and md5 checksum, unless overridden by options, see below)
- .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
- .TP
- s3cmd \fBmodify\fR \fIs3://BUCKET1/OBJECT\fR
- Modify object metadata
- .TP
- s3cmd \fBmv\fR \fIs3://BUCKET1/OBJECT1 s3://BUCKET2[/OBJECT2]\fR
- Move object
- .TP
- s3cmd \fBsetacl\fR \fIs3://BUCKET[/OBJECT]\fR
- Modify Access control list for Bucket or Files
- .TP
- s3cmd \fBsetpolicy\fR \fIFILE s3://BUCKET\fR
- Modify Bucket Policy
- .TP
- s3cmd \fBdelpolicy\fR \fIs3://BUCKET\fR
- Delete Bucket Policy
- .TP
- 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
- s3cmd \fBmultipart\fR \fIs3://BUCKET [Id]\fR
- Show multipart uploads
- .TP
- s3cmd \fBabortmp\fR \fIs3://BUCKET/OBJECT Id\fR
- Abort a multipart upload
- .TP
- s3cmd \fBlistmp\fR \fIs3://BUCKET/OBJECT Id\fR
- List parts of a multipart upload
- .TP
- s3cmd \fBaccesslog\fR \fIs3://BUCKET\fR
- Enable/disable bucket access logging
- .TP
- s3cmd \fBsign\fR \fISTRING\-TO\-SIGN\fR
- Sign arbitrary string using the secret key
- .TP
- s3cmd \fBsignurl\fR \fIs3://BUCKET/OBJECT <expiry_epoch|+expiry_offset>\fR
- Sign an S3 URL to provide limited public access with expiry
- .TP
- s3cmd \fBfixbucket\fR \fIs3://BUCKET[/PREFIX]\fR
- Fix invalid file names in a bucket
- .TP
- s3cmd \fBexpire\fR \fIs3://BUCKET\fR
- Set or delete expiration rule for the bucket
- .TP
- s3cmd \fBsetlifecycle\fR \fIFILE s3://BUCKET\fR
- Upload a lifecycle policy for the bucket
- .TP
- s3cmd \fBgetlifecycle\fR \fIs3://BUCKET\fR
- Get a lifecycle policy for the bucket
- .TP
- s3cmd \fBdellifecycle\fR \fIs3://BUCKET\fR
- Remove a lifecycle policy for the bucket
- .TP
- s3cmd \fBsetnotification\fR \fIFILE s3://BUCKET\fR
- Upload a notification policy for the bucket
- .TP
- s3cmd \fBgetnotification\fR \fIs3://BUCKET\fR
- Get a notification policy for the bucket
- .TP
- s3cmd \fBdelnotification\fR \fIs3://BUCKET\fR
- Remove a notification policy for the bucket
- .PP
- Commands for static WebSites configuration
- .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
- .PP
- Commands for CloudFront management
- .TP
- s3cmd \fBcflist\fR \fI\fR
- List CloudFront distribution points
- .TP
- s3cmd \fBcfinfo\fR \fI[cf://DIST_ID]\fR
- Display CloudFront distribution point parameters
- .TP
- s3cmd \fBcfcreate\fR \fIs3://BUCKET\fR
- Create CloudFront distribution point
- .TP
- s3cmd \fBcfdelete\fR \fIcf://DIST_ID\fR
- Delete CloudFront distribution point
- .TP
- s3cmd \fBcfmodify\fR \fIcf://DIST_ID\fR
- Change CloudFront distribution point parameters
- .TP
- s3cmd \fBcfinvalinfo\fR \fIcf://DIST_ID[/INVAL_ID]\fR
- Display CloudFront invalidation request(s) status
- .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
- changes you like.
- .TP
- \fB\-h\fR, \fB\-\-help\fR
- show this help message and exit
- .TP
- \fB\-\-configure\fR
- Invoke interactive (re)configuration tool. Optionally
- use as '\fB\-\-configure\fR s3://some\-bucket' to test access
- to a specific bucket instead of attempting to list
- them all.
- .TP
- \fB\-c\fR FILE, \fB\-\-config\fR=FILE
- Config file name. Defaults to $HOME/.s3cfg
- .TP
- \fB\-\-dump\-config\fR
- 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
- .TP
- \fB\-\-access_token\fR=ACCESS_TOKEN
- AWS Access Token
- .TP
- \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)
- .TP
- \fB\-s\fR, \fB\-\-ssl\fR
- Use HTTPS connection when communicating with S3.
- (default)
- .TP
- \fB\-\-no\-ssl\fR
- Don't use HTTPS.
- .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
- 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
- continue an existing upload (equivalent to \fB\-\-continue\-\fR
- put) and there are multiple partial uploads. Use
- s3cmd multipart [URI] to see what UploadIds are
- associated with the given URI.
- .TP
- \fB\-\-skip\-existing\fR
- Skip over files that exist at the destination (only
- for [get] and [sync] commands).
- .TP
- \fB\-r\fR, \fB\-\-recursive\fR
- Recursive upload, download or removal.
- .TP
- \fB\-\-check\-md5\fR
- Check MD5 sums when comparing files for [sync].
- (default)
- .TP
- \fB\-\-no\-check\-md5\fR
- 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.
- .TP
- \fB\-P\fR, \fB\-\-acl\-public\fR
- Store objects with ACL allowing read for anyone.
- .TP
- \fB\-\-acl\-private\fR
- Store objects with default ACL allowing access for you
- only.
- .TP
- \fB\-\-acl\-grant\fR=PERMISSION:EMAIL or USER_CANONICAL_ID
- Grant stated permission to a given amazon user.
- Permission is one of: read, write, read_acp,
- write_acp, full_control, all
- .TP
- \fB\-\-acl\-revoke\fR=PERMISSION:USER_CANONICAL_ID
- Revoke stated permission for a given amazon user.
- Permission is one of: read, write, read_acp,
- write_acp, full_control, all
- .TP
- \fB\-D\fR NUM, \fB\-\-restore\-days\fR=NUM
- Number of days to keep restored file available (only
- for 'restore' command). Default is 1 day.
- .TP
- \fB\-\-restore\-priority\fR=RESTORE_PRIORITY
- Priority for restoring files from S3 Glacier (only for
- 'restore' command). Choices available: bulk, standard,
- expedited
- .TP
- \fB\-\-delete\-removed\fR
- Delete destination objects with no corresponding
- source file [sync]
- .TP
- \fB\-\-no\-delete\-removed\fR
- Don't delete destination objects [sync]
- .TP
- \fB\-\-delete\-after\fR
- Perform deletes AFTER new uploads when delete-removed
- is enabled [sync]
- .TP
- \fB\-\-delay\-updates\fR
- *OBSOLETE* Put all updated files into place at end
- [sync]
- .TP
- \fB\-\-max\-delete\fR=NUM
- Do not delete more than NUM files. [del] and [sync]
- .TP
- \fB\-\-limit\fR=NUM
- Limit number of objects returned in the response body
- (only for [ls] and [la] commands)
- .TP
- \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
- \fB\-p\fR, \fB\-\-preserve\fR
- Preserve filesystem attributes (mode, ownership,
- timestamps). Default for [sync] command.
- .TP
- \fB\-\-no\-preserve\fR
- Don't store FS attributes
- .TP
- \fB\-\-exclude\fR=GLOB
- Filenames and paths matching GLOB will be excluded
- from sync
- .TP
- \fB\-\-exclude\-from\fR=FILE
- Read --exclude GLOBs from FILE
- .TP
- \fB\-\-rexclude\fR=REGEXP
- Filenames and paths matching REGEXP (regular
- expression) will be excluded from sync
- .TP
- \fB\-\-rexclude\-from\fR=FILE
- Read --rexclude REGEXPs from FILE
- .TP
- \fB\-\-include\fR=GLOB
- Filenames and paths matching GLOB will be included
- even if previously excluded by one of
- \fB\-\-(r)exclude(\-from)\fR patterns
- .TP
- \fB\-\-include\-from\fR=FILE
- Read --include GLOBs from FILE
- .TP
- \fB\-\-rinclude\fR=REGEXP
- Same as --include but uses REGEXP (regular expression)
- instead of GLOB
- .TP
- \fB\-\-rinclude\-from\fR=FILE
- Read --rinclude REGEXPs from FILE
- .TP
- \fB\-\-files\-from\fR=FILE
- Read list of source-file names from FILE. Use - to
- read from stdin.
- .TP
- \fB\-\-region\fR=REGION, \fB\-\-bucket\-location\fR=REGION
- Region to create bucket in. As of now the regions are:
- 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
- .TP
- \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
- \fB\-\-reduced\-redundancy\fR, \fB\-\-rr\fR
- Store object with 'Reduced redundancy'. Lower per\-GB
- price. [put, cp, mv]
- .TP
- \fB\-\-no\-reduced\-redundancy\fR, \fB\-\-no\-rr\fR
- Store object without 'Reduced redundancy'. Higher per\-
- GB price. [put, cp, mv]
- .TP
- \fB\-\-storage\-class\fR=CLASS
- Store object with specified CLASS (STANDARD,
- STANDARD_IA, ONEZONE_IA, INTELLIGENT_TIERING, GLACIER
- or DEEP_ARCHIVE). [put, cp, mv]
- .TP
- \fB\-\-access\-logging\-target\-prefix\fR=LOG_TARGET_PREFIX
- Target prefix for access logs (S3 URI) (for [cfmodify]
- and [accesslog] commands)
- .TP
- \fB\-\-no\-access\-logging\fR
- Disable access logging (for [cfmodify] and [accesslog]
- commands)
- .TP
- \fB\-\-default\-mime\-type\fR=DEFAULT_MIME_TYPE
- Default MIME\-type for stored objects. Application
- default is binary/octet\-stream.
- .TP
- \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
- .TP
- \fB\-\-no\-guess\-mime\-type\fR
- Don't guess MIME-type and use the default type
- instead.
- .TP
- \fB\-\-no\-mime\-magic\fR
- Don't use mime magic when guessing MIME-type.
- .TP
- \fB\-m\fR MIME/TYPE, \fB\-\-mime\-type\fR=MIME/TYPE
- Force MIME\-type. Override both \fB\-\-default\-mime\-type\fR and
- \fB\-\-guess\-mime\-type\fR.
- .TP
- \fB\-\-add\-header\fR=NAME:VALUE
- 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 option.
- .TP
- \fB\-\-remove\-header\fR=NAME
- Remove a given HTTP header. Can be used multiple
- times. For instance, remove 'Expires' or 'Cache\-
- Control' headers (or both) using this option. [modify]
- .TP
- \fB\-\-server\-side\-encryption\fR
- Specifies that server\-side encryption will be used
- when putting objects. [put, sync, cp, modify]
- .TP
- \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
- \fB\-\-encoding\fR=ENCODING
- 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 )
- .TP
- \fB\-\-verbatim\fR
- Use the S3 name as given on the command line. No pre-
- processing, encoding, etc. Use with caution!
- .TP
- \fB\-\-disable\-multipart\fR
- Disable multipart upload on files bigger than
- \fB\-\-multipart\-chunk\-size\-mb\fR
- .TP
- \fB\-\-multipart\-chunk\-size\-mb\fR=SIZE
- 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 15MB, minimum allowed chunk size is 5MB,
- maximum is 5GB.
- .TP
- \fB\-\-list\-md5\fR
- Include MD5 sums in bucket listings (only for 'ls'
- command).
- .TP
- \fB\-\-list\-allow\-unordered\fR
- Not an AWS standard. Allow the listing results to be
- returned in unsorted order. This may be faster when
- listing very large buckets.
- .TP
- \fB\-H\fR, \fB\-\-human\-readable\-sizes\fR
- Print sizes in human readable form (eg 1kB instead of
- 1234).
- .TP
- \fB\-\-ws\-index\fR=WEBSITE_INDEX
- Name of index\-document (only for [ws\-create] command)
- .TP
- \fB\-\-ws\-error\fR=WEBSITE_ERROR
- Name of error\-document (only for [ws\-create] command)
- .TP
- \fB\-\-expiry\-date\fR=EXPIRY_DATE
- Indicates when the expiration rule takes effect. (only
- for [expire] command)
- .TP
- \fB\-\-expiry\-days\fR=EXPIRY_DAYS
- Indicates the number of days after object creation the
- expiration rule takes effect. (only for [expire]
- 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
- \fB\-\-progress\fR
- Display progress meter (default on TTY).
- .TP
- \fB\-\-no\-progress\fR
- Don't display progress meter (default on non-TTY).
- .TP
- \fB\-\-stats\fR
- Give some file-transfer stats.
- .TP
- \fB\-\-enable\fR
- Enable given CloudFront distribution (only for
- [cfmodify] command)
- .TP
- \fB\-\-disable\fR
- Disable given CloudFront distribution (only for
- [cfmodify] command)
- .TP
- \fB\-\-cf\-invalidate\fR
- 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.
- .TP
- \fB\-\-cf\-add\-cname\fR=CNAME
- Add given CNAME to a CloudFront distribution (only for
- [cfcreate] and [cfmodify] commands)
- .TP
- \fB\-\-cf\-remove\-cname\fR=CNAME
- Remove given CNAME from a CloudFront distribution
- (only for [cfmodify] command)
- .TP
- \fB\-\-cf\-comment\fR=COMMENT
- Set COMMENT for a given CloudFront distribution (only
- for [cfcreate] and [cfmodify] commands)
- .TP
- \fB\-\-cf\-default\-root\-object\fR=DEFAULT_ROOT_OBJECT
- 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)
- .TP
- \fB\-v\fR, \fB\-\-verbose\fR
- Enable verbose output.
- .TP
- \fB\-d\fR, \fB\-\-debug\fR
- Enable debug output.
- .TP
- \fB\-\-version\fR
- Show s3cmd version (2.3.0) and exit.
- .TP
- \fB\-F\fR, \fB\-\-follow\-symlinks\fR
- Follow symbolic links as if they are regular files
- .TP
- \fB\-\-cache\-file\fR=FILE
- Cache FILE containing local source MD5 values
- .TP
- \fB\-q\fR, \fB\-\-quiet\fR
- Silence output on stdout
- .TP
- \fB\-\-ca\-certs\fR=CA_CERTS_FILE
- Path to SSL CA certificate FILE (instead of system
- default)
- .TP
- \fB\-\-ssl\-cert\fR=SSL_CLIENT_CERT_FILE
- Path to client own SSL certificate CRT_FILE
- .TP
- \fB\-\-ssl\-key\fR=SSL_CLIENT_KEY_FILE
- Path to client own SSL certificate private key
- KEY_FILE
- .TP
- \fB\-\-check\-certificate\fR
- Check SSL certificate validity
- .TP
- \fB\-\-no\-check\-certificate\fR
- 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
- .TP
- \fB\-\-signature\-v2\fR
- Use AWS Signature version 2 instead of newer signature
- methods. Helpful for S3\-like systems that don't have
- AWS Signature v4 yet.
- .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
- .TP
- \fB\-\-no\-connection\-pooling\fR
- Disable connection re\-use
- .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"
- .SH EXAMPLES
- 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.
- .PP
- Basic usage common in backup scenarios is as simple as:
- .nf
- s3cmd sync /local/path/ s3://test\-bucket/backup/
- .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
- /local/path/\fBfile1.ext\fR \-> s3://bucket/backup/\fBfile1.ext\fR
- /local/path/\fBdir123/file2.bin\fR \-> s3://bucket/backup/\fBdir123/file2.bin\fR
- .fi
- .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
- To retrieve the files back from S3 use inverted syntax:
- .nf
- s3cmd sync s3://test\-bucket/backup/ ~/restore/
- .fi
- that will download files:
- .nf
- s3://bucket/backup/\fBfile1.ext\fR \-> ~/restore/\fBfile1.ext\fR
- s3://bucket/backup/\fBdir123/file2.bin\fR \-> ~/restore/\fBdir123/file2.bin\fR
- .fi
- .PP
- Without the trailing slash on source the behaviour is similar to
- what has been demonstrated with upload:
- .nf
- s3cmd sync s3://test\-bucket/backup ~/restore/
- .fi
- will download the files as:
- .nf
- s3://bucket/\fBbackup/file1.ext\fR \-> ~/restore/\fBbackup/file1.ext\fR
- s3://bucket/\fBbackup/dir123/file2.bin\fR \-> ~/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
- .PP
- 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.
- .PP
- 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.
- .PP
- 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.
- .PP
- For example to exclude all files with ".jpg" extension except those beginning with a number use:
- .PP
- \-\-exclude '*.jpg' \-\-rinclude '[0\-9].*\.jpg'
- .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
- .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:
- .B http://s3tools.org
- .SH AUTHOR
- Written by Michal Ludvig and contributors
- .SH CONTACT, SUPPORT
- Preferred way to get support is our mailing list:
- .br
- .I s3tools\-general@lists.sourceforge.net
- .br
- or visit the project homepage:
- .br
- .B http://s3tools.org
- .SH REPORTING BUGS
- Report bugs to
- .I s3tools\-bugs@lists.sourceforge.net
- .SH COPYRIGHT
- Copyright \(co 2007\-2015 TGRMN Software \- http://www.tgrmn.com \- and contributors
- .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.
- .br
|