diff options
author | Nikolaus Rath <Nikolaus@rath.org> | 2016-03-09 10:09:01 -0800 |
---|---|---|
committer | Nikolaus Rath <Nikolaus@rath.org> | 2016-03-09 10:09:01 -0800 |
commit | 487050cd59bbea62e19eb6443f1f0a333e12538f (patch) | |
tree | 2dc0eff47921caa414eb7063d768ea427002cdd2 /doc/man | |
parent | 4c92783a314a913bab3c98d30bb9ca4cbeafb4e6 (diff) |
Import s3ql_1.14.orig.tar.bz2
Diffstat (limited to 'doc/man')
-rw-r--r-- | doc/man/fsck.s3ql.1 | 14 | ||||
-rw-r--r-- | doc/man/mkfs.s3ql.1 | 19 | ||||
-rw-r--r-- | doc/man/mount.s3ql.1 | 31 | ||||
-rw-r--r-- | doc/man/s3qladm.1 | 16 | ||||
-rw-r--r-- | doc/man/s3qlcp.1 | 6 | ||||
-rw-r--r-- | doc/man/s3qlctrl.1 | 10 | ||||
-rw-r--r-- | doc/man/s3qllock.1 | 6 | ||||
-rw-r--r-- | doc/man/s3qlrm.1 | 6 | ||||
-rw-r--r-- | doc/man/s3qlstat.1 | 6 | ||||
-rw-r--r-- | doc/man/umount.s3ql.1 | 9 |
10 files changed, 66 insertions, 57 deletions
diff --git a/doc/man/fsck.s3ql.1 b/doc/man/fsck.s3ql.1 index 1e52b4e..a9cf59a 100644 --- a/doc/man/fsck.s3ql.1 +++ b/doc/man/fsck.s3ql.1 @@ -1,4 +1,4 @@ -.TH "FSCK.S3QL" "1" "February 24, 2013" "1.13.1" "S3QL" +.TH "FSCK.S3QL" "1" "April 09, 2013" "1.14" "S3QL" .SH NAME fsck.s3ql \- Check an S3QL file system for errors . @@ -63,33 +63,37 @@ be kept. Specify \fBnone\fP to disable logging. Default: .TP .BI \-\-cachedir \ <path> Store cached data in this directory (default: \fB~/.s3ql)\fP +(default: /home/nikratio/.s3ql) .TP .BI \-\-authfile \ <path> Read authentication credentials from this file (default: -\fB~/.s3ql/authinfo2)\fP +\fB~/.s3ql/authinfo2)\fP (default: +/home/nikratio/.s3ql/authinfo2) .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. +specified multiple times. (default: None) .TP .B \-\-quiet -be really quiet +be really quiet (default: False) .TP .B \-\-ssl Always use SSL connections when connecting to remote servers. For backends that allow only encrypted connections, S3QL uses SSL automatically, even if this -option is not set. +option is not set. (default: False) .TP .B \-\-version just print program version and exit .TP .B \-\-batch If user input is required, exit without prompting. +(default: False) .TP .B \-\-force Force checking even if file system is marked clean. +(default: False) .UNINDENT .UNINDENT .UNINDENT diff --git a/doc/man/mkfs.s3ql.1 b/doc/man/mkfs.s3ql.1 index 0015ffe..ec68273 100644 --- a/doc/man/mkfs.s3ql.1 +++ b/doc/man/mkfs.s3ql.1 @@ -1,4 +1,4 @@ -.TH "MKFS.S3QL" "1" "February 24, 2013" "1.13.1" "S3QL" +.TH "MKFS.S3QL" "1" "April 09, 2013" "1.14" "S3QL" .SH NAME mkfs.s3ql \- Create an S3QL file system . @@ -61,31 +61,32 @@ The \fBmkfs.s3ql\fP command accepts the following options. .TP .BI \-\-cachedir \ <path> Store cached data in this directory (default: -\fB~/.s3ql)\fP +\fB~/.s3ql)\fP (default: /home/nikratio/.s3ql) .TP .BI \-\-authfile \ <path> Read authentication credentials from this file -(default: \fB~/.s3ql/authinfo2)\fP +(default: \fB~/.s3ql/authinfo2)\fP (default: +/home/nikratio/.s3ql/authinfo2) .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. +be specified multiple times. (default: None) .TP .B \-\-quiet -be really quiet +be really quiet (default: False) .TP .B \-\-ssl Always use SSL connections when connecting to remote servers. For backends that allow only encrypted connections, S3QL uses SSL automatically, even if this -option is not set. +option is not set. (default: False) .TP .B \-\-version just print program version and exit .TP .BI \-L \ <name> -Filesystem label +Filesystem label (default: ) .TP .BI \-\-max\-obj\-size \ <size> Maximum size of storage objects in KiB. Files bigger @@ -93,10 +94,10 @@ than this will be spread over multiple objects in the storage backend. Default: 10240 KiB. .TP .B \-\-plain -Create unencrypted file system. +Create unencrypted file system. (default: False) .TP .B \-\-force -Overwrite any existing data. +Overwrite any existing data. (default: False) .UNINDENT .UNINDENT .UNINDENT diff --git a/doc/man/mount.s3ql.1 b/doc/man/mount.s3ql.1 index 299a385..b6aae65 100644 --- a/doc/man/mount.s3ql.1 +++ b/doc/man/mount.s3ql.1 @@ -1,4 +1,4 @@ -.TH "MOUNT.S3QL" "1" "February 24, 2013" "1.13.1" "S3QL" +.TH "MOUNT.S3QL" "1" "April 09, 2013" "1.14" "S3QL" .SH NAME mount.s3ql \- Mount an S3QL file system . @@ -62,25 +62,26 @@ logging. Default: \fB~/.s3ql/mount.log\fP .TP .BI \-\-cachedir \ <path> Store cached data in this directory (default: -\fB~/.s3ql)\fP +\fB~/.s3ql)\fP (default: /home/nikratio/.s3ql) .TP .BI \-\-authfile \ <path> Read authentication credentials from this file -(default: \fB~/.s3ql/authinfo2)\fP +(default: \fB~/.s3ql/authinfo2)\fP (default: +/home/nikratio/.s3ql/authinfo2) .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. +be specified multiple times. (default: None) .TP .B \-\-quiet -be really quiet +be really quiet (default: False) .TP .B \-\-ssl Always use SSL connections when connecting to remote servers. For backends that allow only encrypted connections, S3QL uses SSL automatically, even if this -option is not set. +option is not set. (default: False) .TP .B \-\-version just print program version and exit @@ -90,7 +91,7 @@ Cache size in KiB (default: 102400 (100 MiB)). Should be at least 10 times the maximum object size of the filesystem, otherwise an object may be retrieved and written several times during a single write() or -read() operation. +read() operation. (default: 102400) .TP .BI \-\-max\-cache\-entries \ <num> Maximum number of entries in cache (default: 768). @@ -107,26 +108,26 @@ access to it, independent of individual file permissions. If the \fB\-\-allow\-other\fP option is specified, other users can access the mount point as well and individual file permissions are taken into -account for all users. +account for all users. (default: False) .TP .B \-\-allow\-root Like \fB\-\-allow\-other\fP, but restrict access to the -mounting user and the root user. +mounting user and the root user. (default: False) .TP .B \-\-fg -Do not daemonize, stay in foreground +Do not daemonize, stay in foreground (default: False) .TP .B \-\-single Run in single threaded mode. If you don\(aqt understand -this, then you don\(aqt need it. +this, then you don\(aqt need it. (default: False) .TP .B \-\-upstart Stay in foreground and raise SIGSTOP once mountpoint -is up. +is up. (default: False) .TP .B \-\-profile Create profiling information. If you don\(aqt understand -this, then you don\(aqt need it. +this, then you don\(aqt need it. (default: False) .TP .BI \-\-compress \ <name> Compression algorithm to use when storing new data. @@ -135,11 +136,11 @@ Allowed values: \fBlzma\fP, \fBbzip2\fP, \fBzlib\fP, none. .TP .BI \-\-metadata\-upload\-interval \ <seconds> Interval in seconds between complete metadata uploads. -Set to 0 to disable. Default: 24h. +Set to 0 to disable. Default: 24h. (default: 86400) .TP .BI \-\-threads \ <no> Number of parallel upload threads to use (default: -auto). +auto). (default: None) .TP .B \-\-nfs Enable some optimizations for exporting the file diff --git a/doc/man/s3qladm.1 b/doc/man/s3qladm.1 index b60f865..c0ce132 100644 --- a/doc/man/s3qladm.1 +++ b/doc/man/s3qladm.1 @@ -1,4 +1,4 @@ -.TH "S3QLADM" "1" "February 24, 2013" "1.13.1" "S3QL" +.TH "S3QLADM" "1" "April 09, 2013" "1.14" "S3QL" .SH NAME s3qladm \- Manage S3QL file systems . @@ -62,10 +62,10 @@ The \fBs3qladm\fP command accepts the following options. .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. +specified multiple times. (default: None) .TP .B \-\-quiet -be really quiet +be really quiet (default: False) .TP .BI \-\-log \ <target> Write logging info into this file. File will be rotated @@ -75,16 +75,18 @@ be kept. Specify \fBnone\fP to disable logging. Default: .TP .BI \-\-authfile \ <path> Read authentication credentials from this file (default: -\fB~/.s3ql/authinfo2)\fP +\fB~/.s3ql/authinfo2)\fP (default: +/home/nikratio/.s3ql/authinfo2) .TP .B \-\-ssl Always use SSL connections when connecting to remote servers. For backends that allow only encrypted connections, S3QL uses SSL automatically, even if this -option is not set. +option is not set. (default: False) .TP .BI \-\-cachedir \ <path> Store cached data in this directory (default: \fB~/.s3ql)\fP +(default: /home/nikratio/.s3ql) .TP .B \-\-version just print program version and exit @@ -92,8 +94,8 @@ just print program version and exit .UNINDENT .UNINDENT .sp -Hint: run \fBs3qladm <action> \-\-help\fP to get help on the additional -arguments that the different actions take. +Hint: run \fBs3qladm <action> \-\-help\fP to get help on the additional arguments +that the different actions take. .SH ACTIONS .sp The following actions may be specified: diff --git a/doc/man/s3qlcp.1 b/doc/man/s3qlcp.1 index 8fea1a0..2f4db78 100644 --- a/doc/man/s3qlcp.1 +++ b/doc/man/s3qlcp.1 @@ -1,4 +1,4 @@ -.TH "S3QLCP" "1" "February 24, 2013" "1.13.1" "S3QL" +.TH "S3QLCP" "1" "April 09, 2013" "1.14" "S3QL" .SH NAME s3qlcp \- Copy-on-write replication on S3QL file systems . @@ -105,10 +105,10 @@ The \fBs3qlcp\fP command accepts the following options: .INDENT 0.0 .TP .B \-\-debug -activate debugging output +activate debugging output (default: None) .TP .B \-\-quiet -be really quiet +be really quiet (default: False) .TP .B \-\-version just print program version and exit diff --git a/doc/man/s3qlctrl.1 b/doc/man/s3qlctrl.1 index 3f3f9b6..346ebe7 100644 --- a/doc/man/s3qlctrl.1 +++ b/doc/man/s3qlctrl.1 @@ -1,4 +1,4 @@ -.TH "S3QLCTRL" "1" "February 24, 2013" "1.13.1" "S3QL" +.TH "S3QLCTRL" "1" "April 09, 2013" "1.14" "S3QL" .SH NAME s3qlctrl \- Control a mounted S3QL file system . @@ -100,10 +100,10 @@ what specific action is being invoked: .INDENT 0.0 .TP .B \-\-debug -activate debugging output +activate debugging output (default: None) .TP .B \-\-quiet -be really quiet +be really quiet (default: False) .TP .B \-\-version just print program version and exit @@ -111,8 +111,8 @@ just print program version and exit .UNINDENT .UNINDENT .sp -Hint: run \fBs3qlctrl <action> \-\-help\fP to get help on the additional -arguments that the different actions take. +Hint: run \fBs3qlctrl <action> \-\-help\fP to get help on the additional arguments +that the different actions take. .SH EXIT STATUS .sp \fBs3qlctrl\fP returns exit code 0 if the operation succeeded and 1 if some diff --git a/doc/man/s3qllock.1 b/doc/man/s3qllock.1 index 7e5dfac..05b43e9 100644 --- a/doc/man/s3qllock.1 +++ b/doc/man/s3qllock.1 @@ -1,4 +1,4 @@ -.TH "S3QLLOCK" "1" "February 24, 2013" "1.13.1" "S3QL" +.TH "S3QLLOCK" "1" "April 09, 2013" "1.14" "S3QL" .SH NAME s3qllock \- Make trees on an S3QL file system immutable . @@ -92,10 +92,10 @@ The \fBs3qllock\fP command accepts the following options: .INDENT 0.0 .TP .B \-\-debug -activate debugging output +activate debugging output (default: None) .TP .B \-\-quiet -be really quiet +be really quiet (default: False) .TP .B \-\-version just print program version and exit diff --git a/doc/man/s3qlrm.1 b/doc/man/s3qlrm.1 index f852268..88b1190 100644 --- a/doc/man/s3qlrm.1 +++ b/doc/man/s3qlrm.1 @@ -1,4 +1,4 @@ -.TH "S3QLRM" "1" "February 24, 2013" "1.13.1" "S3QL" +.TH "S3QLRM" "1" "April 09, 2013" "1.14" "S3QL" .SH NAME s3qlrm \- Fast tree removal on S3QL file systems . @@ -64,10 +64,10 @@ The \fBs3qlrm\fP command accepts the following options: .INDENT 0.0 .TP .B \-\-debug -activate debugging output +activate debugging output (default: None) .TP .B \-\-quiet -be really quiet +be really quiet (default: False) .TP .B \-\-version just print program version and exit diff --git a/doc/man/s3qlstat.1 b/doc/man/s3qlstat.1 index 1500bcd..4b20fc7 100644 --- a/doc/man/s3qlstat.1 +++ b/doc/man/s3qlstat.1 @@ -1,4 +1,4 @@ -.TH "S3QLSTAT" "1" "February 24, 2013" "1.13.1" "S3QL" +.TH "S3QLSTAT" "1" "April 09, 2013" "1.14" "S3QL" .SH NAME s3qlstat \- Gather S3QL file system statistics . @@ -58,10 +58,10 @@ The \fBs3qlstat\fP command accepts the following options: .INDENT 0.0 .TP .B \-\-debug -activate debugging output +activate debugging output (default: None) .TP .B \-\-quiet -be really quiet +be really quiet (default: False) .TP .B \-\-version just print program version and exit diff --git a/doc/man/umount.s3ql.1 b/doc/man/umount.s3ql.1 index 2ee6c94..30ffda5 100644 --- a/doc/man/umount.s3ql.1 +++ b/doc/man/umount.s3ql.1 @@ -1,4 +1,4 @@ -.TH "UMOUNT.S3QL" "1" "February 24, 2013" "1.13.1" "S3QL" +.TH "UMOUNT.S3QL" "1" "April 09, 2013" "1.14" "S3QL" .SH NAME umount.s3ql \- Unmount an S3QL file system . @@ -63,10 +63,10 @@ The \fBumount.s3ql\fP command accepts the following options. .INDENT 0.0 .TP .B \-\-debug -activate debugging output +activate debugging output (default: None) .TP .B \-\-quiet -be really quiet +be really quiet (default: False) .TP .B \-\-version just print program version and exit @@ -74,7 +74,8 @@ just print program version and exit .B \-\-lazy, \-z Lazy umount. Detaches the file system immediately, even if there are still open files. The data will be uploaded in the -background once all open files have been closed. +background once all open files have been closed. (default: +False) .UNINDENT .UNINDENT .UNINDENT |