.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp .. .de Vb \" Begin verbatim text .ft CW .nf .ne \\$1 .. .de Ve \" End verbatim text .ft R .fi .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left .\" double quote, and \*(R" will give a right double quote. \*(C+ will .\" give a nicer C++. Capital omega is used to do unbreakable dashes and .\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, .\" nothing in troff, for use with C<>. .tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- . ds PI pi . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch . ds L" "" . ds R" "" . ds C` "" . ds C' "" 'br\} .el\{\ . ds -- \|\(em\| . ds PI \(*p . ds L" `` . ds R" '' . ds C` . ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. .ie \n(.g .ds Aq \(aq .el .ds Aq ' .\" .\" If the F register is >0, we'll generate index entries on stderr for .\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index .\" entries marked with X<> in POD. Of course, you'll have to process the .\" output yourself in some meaningful fashion. .\" .\" Avoid warning from groff about undefined register 'F'. .de IX .. .nr rF 0 .if \n(.g .if rF .nr rF 1 .if (\n(rF:(\n(.g==0)) \{\ . if \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . if !\nF==2 \{\ . nr % 0 . nr F 2 . \} . \} .\} .rr rF .\" ======================================================================== .\" .IX Title "S3CL 1p" .TH S3CL 1p "2022-07-18" "perl v5.34.0" "User Contributed Perl Documentation" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l .nh .SH "NAME" s3cl \- Command line for Amazon s3 cloud storage .SH "VERSION" .IX Header "VERSION" version 0.991 .SH "SYNOPSIS" .IX Header "SYNOPSIS" s3cl command [options] .PP .Vb 7 \& s3cl buckets \& s3cl mkbucket \-\-bucket some_bucket_name \-\-jurisdiction [EU|US] \& s3cl ls :[prefix] \& s3cl cp : /path/[filename] \& s3cl sync :[prefix] /path/ \& s3cl sync_up [\-\-acl_short=public\-read] :[prefix] /path/ \& s3cl rm : \& \& Options: \& \-help brief help message \& \-man full documentation \& \& We take NO responsibility for the costs incured through using \& this script. \& \& To run this script, you need to set a pair of environment variables: \& \& AWS_ACCESS_KEY_ID \& AWS_ACCESS_KEY_SECRET .Ve .SH "DESCRIPTION" .IX Header "DESCRIPTION" This program gives a command line interface to Amazons s3 storage service. It does not limit the number of requests (which may cost you more money than if you did it a different way!) and each request costs Money (although some costs from \s-1EC2\s0 may be \f(CW$0\fR.0, check latest from Amazon costs page) \- we take \s-1NO\s0 responsibility for your bill. .SH "AUTHOR" .IX Header "AUTHOR" Branislav Zahradník .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" This software is copyright (c) 2022 by Amazon Digital Services, Leon Brocard, Brad Fitzpatrick, Pedro Figueiredo, Rusty Conover, Branislav Zahradník. .PP This is free software; you can redistribute it and/or modify it under the same terms as the Perl 5 programming language system itself. .SH "COMMANDS" .IX Header "COMMANDS" .IP "\fBbuckets\fR" 4 .IX Item "buckets" s3cl buckets .Sp List all buckets for this account. .IP "\fBmkbucket\fR" 4 .IX Item "mkbucket" s3cl mkbucket \-\-bucket sombucketname [\-\-jurisdiction [EU|US]] .Sp Create a new bucket, optionally specifying what jurisdiction it should be created in. .IP "\fBls\fR" 4 .IX Item "ls" s3cl ls :[prefix] .Sp List contents of a bucket, the optional \fBprefix\fR can be partial, in which case all keys matching this as the start of the key name will be returned. If no \fBprefix\fR is supplied all keys of the bucket will be returned. .IP "\fBcp\fR" 4 .IX Item "cp" s3cl cp : target_file .Sp s3cl cp : target_directory .Sp Copy a single key from the bucket to the target file, or into the target_directory. .IP "\fBsync\fR" 4 .IX Item "sync" s3cl sync :[prefix] target_dir .Sp Downloads all files matching the prefix into a directory structure replicating that of the prefix and all 'sub\-directories'. It will download \s-1ALL\s0 files \- even if already on your local disk: .Sp http://www.amazon.com/gp/browse.html?node=16427261 .Sp .Vb 5 \& # Data transfer "in" and "out" refers to transfer into and out \& # of Amazon S3. Data transferred between Amazon EC2 and \& # Amazon S3, is free of charge (i.e., $0.00 per GB), except \& # data transferred between Amazon EC2 and Amazon S3\-Europe, \& # which will be charged at regular rates. .Ve .IP "\fBsync_up\fR" 4 .IX Item "sync_up" s3cl sync_up [\-\-acl_short=public\-read] :[prefix] /path/ .Sp Upload all the files below /path/ to S3, with an optional prefix at the start of the key name. The existing S3 files and meta data are fetched from S3 and the md5 (etag) is compaired to what is on the local disk, files are not upload if the content has not changed. .Sp Use \-\-acl_short to set access control, options from Net::Amazon::S3::Bucket#set_acl this is only applied when the file is uploaded. .Sp Each files content-type is worked out using MIME::Types, if this does not match 'text/plain' is used for \s-1ASCII\s0 text files, otherwise a warning is issued and the file is \s-1NOT\s0 uploaded. .Sp Currently this does \s-1NOT\s0 remove old files from S3, and if there is any change to a file then the entire file will be reuploaded. .IP "\fBrm\fR" 4 .IX Item "rm" s3cl rm : .Sp Remove a key(file) from the bucket, removing a non-existent file is not classed as an error. Once removed the key (file) can not be restored \- so use with care! .SH "ABOUT" .IX Header "ABOUT" This module contains code modified from Amazon that contains the following notice (which is also applicicable to this code): .PP .Vb 8 \& # This software code is made available "AS IS" without \& # warranties of any kind. You may copy, display, modify and \& # redistribute the software code either by itself or as incorporated \& # into your code; provided that you do not remove any proprietary \& # notices. Your use of this software code is at your own risk and \& # you waive any claim against Amazon Digital Services, Inc. or its \& # affiliates with respect to your use of this software code. \& # (c) 2006 Amazon Digital Services, Inc. or its affiliates. .Ve .SH "AUTHOR" .IX Header "AUTHOR" Leo Lapworth \- Part of the HinuHinu project