diff options
Diffstat (limited to 'doc/man/s3qladm.1')
| -rw-r--r-- | doc/man/s3qladm.1 | 63 |
1 files changed, 15 insertions, 48 deletions
diff --git a/doc/man/s3qladm.1 b/doc/man/s3qladm.1 index 24cb81a..805f831 100644 --- a/doc/man/s3qladm.1 +++ b/doc/man/s3qladm.1 @@ -1,4 +1,4 @@ -.TH "S3QLADM" "1" "May 20, 2011" "1.0.1" "S3QL" +.TH "S3QLADM" "1" "September 28, 2011" "1.2" "S3QL" .SH NAME s3qladm \- Manage S3QL buckets . @@ -50,28 +50,8 @@ The \fBs3qladm\fP command performs various operations on S3QL buckets. The file system contained in the bucket \fImust not be mounted\fP when using \fBs3qladm\fP or things will go wrong badly. .sp -The form of the storage url depends on the backend that is used. The -following backends are supported: -.SS Amazon S3 -.sp -To store your file system in an Amazon S3 bucket, use a storage URL of -the form \fBs3://<bucketname>\fP. Bucket names must conform to the S3 Bucket -Name Restrictions. -.SS Local -.sp -The local backend stores file system data in a directory on your -computer. The storage URL for the local backend has the form -\fBlocal://<path>\fP. Note that you have to write three consecutive -slashes to specify an absolute path, e.g. \fBlocal:///var/archive\fP. -.SS SFTP -.sp -The storage URL for SFTP connections has the form -.sp -.nf -.ft C -sftp://<host>[:port]/<path> -.ft P -.fi +The storage url depends on the backend that is used. The S3QL User\(aqs +Guide should be consulted for a description of the available backends. .SH OPTIONS .sp The \fBs3qladm\fP command accepts the following options. @@ -80,31 +60,28 @@ The \fBs3qladm\fP command accepts the following options. .INDENT 0.0 .TP .BI \-\-debug \ <module> -. activate debugging output from <module>. Use \fBall\fP to get debug messages from all modules. This option can be specified multiple times. .TP .B \-\-quiet -. be really quiet .TP -.BI \-\-homedir \ <path> -. -Directory for log files, cache and authentication info. -(default: \fB~/.s3ql)\fP +.BI \-\-log \ <target> +Write logging info into this file. File will be rotated +when it reaches 1 MB, and at most 5 old log files will be +kept. Specify \fBnone\fP to disable logging. Default: +\fBnone\fP +.TP +.BI \-\-authfile \ <path> +Read authentication credentials from this file (default: +\fB~/.s3ql/authinfo2)\fP +.TP +.BI \-\-cachedir \ <path> +Store cached data in this directory (default: \fB~/.s3ql)\fP .TP .B \-\-version -. just print program version and exit -.TP -.B \-\-ssl -. -Use SSL when connecting to remote servers. This option is -not enabled by default, because for encrypted file -systems, all data is already encrypted anyway, and -authentication data is never transmitted in plaintext -even for unencrypted file systems. .UNINDENT .UNINDENT .UNINDENT @@ -117,27 +94,17 @@ The following actions may be specified: .INDENT 0.0 .TP .B passphrase -. Changes the encryption passphrase of the bucket. .TP .B upgrade -. Upgrade the file system contained in the bucket to the newest revision. .TP .B delete -. Delete the bucket and all its contents. .TP .B download\-metadata -. Interactively download backups of the file system metadata. .UNINDENT -.SH FILES -.sp -Authentication data for backends and bucket encryption passphrases are -read from \fBauthinfo\fP in \fB~/.s3ql\fP or the directory -specified with \fB\-\-homedir\fP. Log files are placed in the same -directory. .SH EXIT STATUS .sp \fBs3qladm\fP returns exit code 0 if the operation succeeded and 1 if some |