.\" 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 "Net::Amazon::S3::Tools 3pm" .TH Net::Amazon::S3::Tools 3pm "2022-06-16" "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" Net::Amazon::S3::Tools \- command line tools for Amazon S3 .SH "SYNOPSIS" .IX Header "SYNOPSIS" .Vb 7 \& s3acl [options] [[bucket|bucket/key] ...] \& s3ls [options] \& s3ls [options] [ bucket/item ... ] \& s3get [options] [ bucket/item ... ] \& s3put [options] [ bucket/item ... ] \& s3mkbucket [options] [ bucket ... ] \& s3rmbucket [options] [ bucket ... ] .Ve .SH "OPTIONS" .IX Header "OPTIONS" Each of the tools have their own specific command line options, but the also all share some common command line options, which are described here. .IP "\fB\-\-help\fR" 4 .IX Item "--help" Print a brief help message and exits. .IP "\fB\-\-man\fR" 4 .IX Item "--man" Prints the manual page and exits. .IP "\fB\-\-verbose\fR" 4 .IX Item "--verbose" Output what is being done as it is done. .IP "\fB\-\-access\-key\fR and \fB\-\-secret\-key\fR" 4 .IX Item "--access-key and --secret-key" Specify the \*(L"\s-1AWS\s0 Access Key Identifiers\*(R" for the \s-1AWS\s0 account. \&\fB\-\-access\-key\fR is the \*(L"Access Key \s-1ID\*(R",\s0 and \fB\-\-secret\-key\fR is the \*(L"Secret Access Key\*(R". These are effectively the \*(L"username\*(R" and \&\*(L"password\*(R" to the \s-1AWS\s0 account, and should be kept confidential. .Sp The access keys \s-1MUST\s0 be specified, either via these command line parameters, or via the \fB\s-1AWS_ACCESS_KEY_ID\s0\fR and \&\fB\s-1AWS_ACCESS_KEY_SECRET\s0\fR environment variables. .Sp Specifying them on the command line overrides the environment variables. .IP "\fB\-\-secure\fR" 4 .IX Item "--secure" Uses \s-1SSL/TLS HTTPS\s0 to communicate with the \s-1AWS\s0 service, instead of \&\s-1HTTP.\s0 .SH "DESCRIPTION" .IX Header "DESCRIPTION" These S3 command line tools allow you to manipulate and populate an S3 account. Refer to the documentation (pod and man) for each of the tools. .PP This Net::Amazon::S3::Tools module is mostly just a stub, to hoist the bundling and installation of the executable scripts that make up the actual tools. .SH "BUGS" .IX Header "BUGS" Report bugs to Mark Atwood mark@fallenpegasus.com. .PP Occasionally the S3 service will randomly fail for no externally apparent reason. When that happens, these tools should retry, with a delay and a backoff. .PP Access to the S3 service can be authenticated with a X.509 certificate, instead of via the \*(L"\s-1AWS\s0 Access Key Identifiers\*(R". These tools should support that. .PP It might be useful to be able to specify the \*(L"\s-1AWS\s0 Access Key Identifiers\*(R" in the user's \f(CW\*(C`~/.netrc\*(C'\fR file. These tools should support that. .PP Errors and warnings are very \*(L"Perl-ish\*(R", and can be confusing. .SH "SEE ALSO" .IX Header "SEE ALSO" These tools use the Net::Amazon::S3 Perl module. .PP The Amazon Simple Storage Service is documented at . .PP These tools are hosted at . .SH "AUTHOR" .IX Header "AUTHOR" Written by Mark Atwood mark@fallenpegasus.com. .PP Many thanks to Wotan \s-1LLC\s0 , for supporting the development of these S3 tools. .PP Many thanks to the Amazon \s-1AWS\s0 engineers for developing S3. .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" Copyright (C) 2007,2008 by Mark Atwood .PP This module is not an official Amazon product or service. Information used to create this module was obtained only from publicly available information, mainly from the published Amazon documentation. .PP .Vb 4 \& This module is free software: you can redistribute it and/or modify \& it under the terms of the GNU Lesser General Public License as published \& by the Free Software Foundation, either version 2.1 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. \& \& You should have received a copy of the GNU General Public License \& and the GNU Lesser General Public License along with this program. \& If not, see . .Ve