summaryrefslogtreecommitdiff
path: root/doc/man
diff options
context:
space:
mode:
authorNikolaus Rath <Nikolaus@rath.org>2016-03-09 10:09:11 -0800
committerNikolaus Rath <Nikolaus@rath.org>2016-03-09 10:09:11 -0800
commit347f05d4ab3ac1d7ce1db9599278f6533477acf5 (patch)
tree9f62d5769996d0cfa574fbcff6df20425cc2e531 /doc/man
parent8f568f6678cf1520b608cd587513399e026b881f (diff)
Import s3ql_2.5.orig.tar.bz2
Diffstat (limited to 'doc/man')
-rw-r--r--doc/man/fsck.s3ql.128
-rw-r--r--doc/man/mkfs.s3ql.124
-rw-r--r--doc/man/mount.s3ql.134
-rw-r--r--doc/man/s3qladm.130
-rw-r--r--doc/man/s3qlcp.111
-rw-r--r--doc/man/s3qlctrl.119
-rw-r--r--doc/man/s3qllock.111
-rw-r--r--doc/man/s3qlrm.111
-rw-r--r--doc/man/s3qlstat.111
-rw-r--r--doc/man/umount.s3ql.111
10 files changed, 121 insertions, 69 deletions
diff --git a/doc/man/fsck.s3ql.1 b/doc/man/fsck.s3ql.1
index 9302698..98a5ac4 100644
--- a/doc/man/fsck.s3ql.1
+++ b/doc/man/fsck.s3ql.1
@@ -1,4 +1,4 @@
-.TH "FSCK.S3QL" "1" "July 12, 2013" "1.16" "S3QL"
+.TH "FSCK.S3QL" "1" "October 19, 2013" "2.5" "S3QL"
.SH NAME
fsck.s3ql \- Check an S3QL file system for errors
.
@@ -28,15 +28,19 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
fsck.s3ql [options] <storage url>
.ft P
.fi
+.UNINDENT
+.UNINDENT
.SH DESCRIPTION
.sp
S3QL is a file system for online data storage. Before using S3QL, make
@@ -69,18 +73,21 @@ Read authentication credentials from this file (default:
\fB~/.s3ql/authinfo2)\fP
.TP
.BI \-\-debug \ <module>
-activate debugging output from <module>. Use \fBall\fP to get
-debug messages from all modules. This option can be
+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
-.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.
+.B \-\-no\-ssl
+Do not use secure (ssl) connections when connecting to
+remote servers.
+.TP
+.BI \-\-ssl\-ca\-path \ path
+File or directory or containing the trusted CA
+certificates. If not specified, the defaults compiled
+into the system\(aqs OpenSSL library are used.
.TP
.B \-\-version
just print program version and exit
@@ -105,7 +112,6 @@ The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
\fB/usr/local/doc/s3ql\fP.
.SH COPYRIGHT
-2008-2011, Nikolaus Rath
+2008-2013, Nikolaus Rath
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/doc/man/mkfs.s3ql.1 b/doc/man/mkfs.s3ql.1
index f8a7e19..4c8debb 100644
--- a/doc/man/mkfs.s3ql.1
+++ b/doc/man/mkfs.s3ql.1
@@ -1,4 +1,4 @@
-.TH "MKFS.S3QL" "1" "July 12, 2013" "1.16" "S3QL"
+.TH "MKFS.S3QL" "1" "October 19, 2013" "2.5" "S3QL"
.SH NAME
mkfs.s3ql \- Create an S3QL file system
.
@@ -28,15 +28,19 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
mkfs.s3ql [options] <storage url>
.ft P
.fi
+.UNINDENT
+.UNINDENT
.SH DESCRIPTION
.sp
S3QL is a file system for online data storage. Before using S3QL, make
@@ -75,11 +79,14 @@ be specified multiple times.
.B \-\-quiet
be really quiet
.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.
+.B \-\-no\-ssl
+Do not use secure (ssl) connections when connecting to
+remote servers.
+.TP
+.BI \-\-ssl\-ca\-path \ path
+File or directory or containing the trusted CA
+certificates. If not specified, the defaults compiled
+into the system\(aqs OpenSSL library are used.
.TP
.B \-\-version
just print program version and exit
@@ -112,7 +119,6 @@ The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
\fB/usr/local/doc/s3ql\fP.
.SH COPYRIGHT
-2008-2011, Nikolaus Rath
+2008-2013, Nikolaus Rath
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/doc/man/mount.s3ql.1 b/doc/man/mount.s3ql.1
index 82b1ddd..7cb159f 100644
--- a/doc/man/mount.s3ql.1
+++ b/doc/man/mount.s3ql.1
@@ -1,4 +1,4 @@
-.TH "MOUNT.S3QL" "1" "July 12, 2013" "1.16" "S3QL"
+.TH "MOUNT.S3QL" "1" "October 19, 2013" "2.5" "S3QL"
.SH NAME
mount.s3ql \- Mount an S3QL file system
.
@@ -28,15 +28,19 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
mount.s3ql [options] <storage url> <mount point>
.ft P
.fi
+.UNINDENT
+.UNINDENT
.SH DESCRIPTION
.sp
S3QL is a file system for online data storage. Before using S3QL, make
@@ -76,11 +80,14 @@ be specified multiple times.
.B \-\-quiet
be really quiet
.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.
+.B \-\-no\-ssl
+Do not use secure (ssl) connections when connecting to
+remote servers.
+.TP
+.BI \-\-ssl\-ca\-path \ path
+File or directory or containing the trusted CA
+certificates. If not specified, the defaults compiled
+into the system\(aqs OpenSSL library are used.
.TP
.B \-\-version
just print program version and exit
@@ -128,10 +135,12 @@ is up.
Create profiling information. If you don\(aqt understand
this, then you don\(aqt need it.
.TP
-.BI \-\-compress \ <name>
-Compression algorithm to use when storing new data.
-Allowed values: \fBlzma\fP, \fBbzip2\fP, \fBzlib\fP, none.
-(default: \fBlzma\fP)
+.BI \-\-compress \ <algorithm\-lvl>
+Compression algorithm and compression level to use
+when storing new data. \fIalgorithm\fP may be any of
+\fBlzma\fP, \fBbzip2\fP, \fBzlib\fP, or none. \fIlvl\fP may be any
+integer from 0 (fastest) to 9 (slowest). Default:
+\fBlzma\-6\fP
.TP
.BI \-\-metadata\-upload\-interval \ <seconds>
Interval in seconds between complete metadata uploads.
@@ -159,7 +168,6 @@ The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
\fB/usr/local/doc/s3ql\fP.
.SH COPYRIGHT
-2008-2011, Nikolaus Rath
+2008-2013, Nikolaus Rath
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/doc/man/s3qladm.1 b/doc/man/s3qladm.1
index 89395e4..e86808c 100644
--- a/doc/man/s3qladm.1
+++ b/doc/man/s3qladm.1
@@ -1,4 +1,4 @@
-.TH "S3QLADM" "1" "July 12, 2013" "1.16" "S3QL"
+.TH "S3QLADM" "1" "October 19, 2013" "2.5" "S3QL"
.SH NAME
s3qladm \- Manage S3QL file systems
.
@@ -28,15 +28,19 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
s3qladm [options] <action> <storage url>
.ft P
.fi
+.UNINDENT
+.UNINDENT
.sp
where \fBaction\fP may be either of \fBpassphrase\fP,
\fBupgrade\fP, \fBdelete\fP or \fBdownload\-metadata\fP.
@@ -60,8 +64,8 @@ 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
+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
@@ -71,17 +75,20 @@ be really quiet
Write logging info into this file. File will be rotated
when it reaches 1 MiB, and at most 5 old log files will
be kept. Specify \fBnone\fP to disable logging. Default:
-\fBnone\fP
+\fBNone\fP
.TP
.BI \-\-authfile \ <path>
Read authentication credentials from this file (default:
\fB~/.s3ql/authinfo2)\fP
.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.
+.B \-\-no\-ssl
+Do not use secure (ssl) connections when connecting to
+remote servers.
+.TP
+.BI \-\-ssl\-ca\-path \ path
+File or directory or containing the trusted CA
+certificates. If not specified, the defaults compiled
+into the system\(aqs OpenSSL library are used.
.TP
.BI \-\-cachedir \ <path>
Store cached data in this directory (default: \fB~/.s3ql)\fP
@@ -123,7 +130,6 @@ The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
\fB/usr/local/doc/s3ql\fP.
.SH COPYRIGHT
-2008-2011, Nikolaus Rath
+2008-2013, Nikolaus Rath
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/doc/man/s3qlcp.1 b/doc/man/s3qlcp.1
index 7527522..0d31d5d 100644
--- a/doc/man/s3qlcp.1
+++ b/doc/man/s3qlcp.1
@@ -1,4 +1,4 @@
-.TH "S3QLCP" "1" "July 12, 2013" "1.16" "S3QL"
+.TH "S3QLCP" "1" "October 19, 2013" "2.5" "S3QL"
.SH NAME
s3qlcp \- Copy-on-write replication on S3QL file systems
.
@@ -28,15 +28,19 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
s3qlcp [options] <source\-dir> <dest\-dir>
.ft P
.fi
+.UNINDENT
+.UNINDENT
.SH DESCRIPTION
.sp
S3QL is a file system for online data storage. Before using S3QL, make
@@ -127,7 +131,6 @@ The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
\fB/usr/local/doc/s3ql\fP.
.SH COPYRIGHT
-2008-2011, Nikolaus Rath
+2008-2013, Nikolaus Rath
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/doc/man/s3qlctrl.1 b/doc/man/s3qlctrl.1
index e4c2a6b..bd9c95a 100644
--- a/doc/man/s3qlctrl.1
+++ b/doc/man/s3qlctrl.1
@@ -1,4 +1,4 @@
-.TH "S3QLCTRL" "1" "July 12, 2013" "1.16" "S3QL"
+.TH "S3QLCTRL" "1" "October 19, 2013" "2.5" "S3QL"
.SH NAME
s3qlctrl \- Control a mounted S3QL file system
.
@@ -28,15 +28,19 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
s3qlctrl [options] <action> <mountpoint> ...
.ft P
.fi
+.UNINDENT
+.UNINDENT
.sp
where \fBaction\fP may be either of \fBflushcache\fP,
\fBupload\-meta\fP, \fBcachesize\fP or
@@ -69,22 +73,30 @@ block while a snapshot of the metadata is prepared for upload.
Changes the cache size of the file system. This action requires an
additional argument that specifies the new cache size in KiB, so the
complete command line is:
+.INDENT 7.0
+.INDENT 3.5
.sp
.nf
.ft C
s3qlctrl [options] cachesize <mountpoint> <new\-cache\-size>
.ft P
.fi
+.UNINDENT
+.UNINDENT
.TP
.B log
Change the amount of information that is logged into
\fB~/.s3ql/mount.log\fP file. The complete syntax is:
+.INDENT 7.0
+.INDENT 3.5
.sp
.nf
.ft C
s3qlctrl [options] log <mountpoint> <level> [<module> [<module> ...]]
.ft P
.fi
+.UNINDENT
+.UNINDENT
.sp
here \fBlevel\fP is the desired new log level and may be either of
\fIdebug\fP, \fIinfo\fP or \fIwarn\fP. One or more \fBmodule\fP may only be
@@ -125,7 +137,6 @@ The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
\fB/usr/local/doc/s3ql\fP.
.SH COPYRIGHT
-2008-2011, Nikolaus Rath
+2008-2013, Nikolaus Rath
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/doc/man/s3qllock.1 b/doc/man/s3qllock.1
index 81d5e16..c9d560d 100644
--- a/doc/man/s3qllock.1
+++ b/doc/man/s3qllock.1
@@ -1,4 +1,4 @@
-.TH "S3QLLOCK" "1" "July 12, 2013" "1.16" "S3QL"
+.TH "S3QLLOCK" "1" "October 19, 2013" "2.5" "S3QL"
.SH NAME
s3qllock \- Make trees on an S3QL file system immutable
.
@@ -28,15 +28,19 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
s3qllock [options] <directory>
.ft P
.fi
+.UNINDENT
+.UNINDENT
.SH DESCRIPTION
.sp
S3QL is a file system for online data storage. Before using S3QL, make
@@ -114,7 +118,6 @@ The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
\fB/usr/local/doc/s3ql\fP.
.SH COPYRIGHT
-2008-2011, Nikolaus Rath
+2008-2013, Nikolaus Rath
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/doc/man/s3qlrm.1 b/doc/man/s3qlrm.1
index c2c9b7d..81bd5e0 100644
--- a/doc/man/s3qlrm.1
+++ b/doc/man/s3qlrm.1
@@ -1,4 +1,4 @@
-.TH "S3QLRM" "1" "July 12, 2013" "1.16" "S3QL"
+.TH "S3QLRM" "1" "October 19, 2013" "2.5" "S3QL"
.SH NAME
s3qlrm \- Fast tree removal on S3QL file systems
.
@@ -28,15 +28,19 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
s3qlrm [options] <directory>
.ft P
.fi
+.UNINDENT
+.UNINDENT
.SH DESCRIPTION
.sp
S3QL is a file system for online data storage. Before using S3QL, make
@@ -86,7 +90,6 @@ The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
\fB/usr/local/doc/s3ql\fP.
.SH COPYRIGHT
-2008-2011, Nikolaus Rath
+2008-2013, Nikolaus Rath
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/doc/man/s3qlstat.1 b/doc/man/s3qlstat.1
index bc77358..bd5c682 100644
--- a/doc/man/s3qlstat.1
+++ b/doc/man/s3qlstat.1
@@ -1,4 +1,4 @@
-.TH "S3QLSTAT" "1" "July 12, 2013" "1.16" "S3QL"
+.TH "S3QLSTAT" "1" "October 19, 2013" "2.5" "S3QL"
.SH NAME
s3qlstat \- Gather S3QL file system statistics
.
@@ -28,15 +28,19 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
s3qlstat [options] <mountpoint>
.ft P
.fi
+.UNINDENT
+.UNINDENT
.SH DESCRIPTION
.sp
S3QL is a file system for online data storage. Before using S3QL, make
@@ -80,7 +84,6 @@ The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
\fB/usr/local/doc/s3ql\fP.
.SH COPYRIGHT
-2008-2011, Nikolaus Rath
+2008-2013, Nikolaus Rath
.\" Generated by docutils manpage writer.
-.\"
.
diff --git a/doc/man/umount.s3ql.1 b/doc/man/umount.s3ql.1
index 3e66b02..d5e199d 100644
--- a/doc/man/umount.s3ql.1
+++ b/doc/man/umount.s3ql.1
@@ -1,4 +1,4 @@
-.TH "UMOUNT.S3QL" "1" "July 12, 2013" "1.16" "S3QL"
+.TH "UMOUNT.S3QL" "1" "October 19, 2013" "2.5" "S3QL"
.SH NAME
umount.s3ql \- Unmount an S3QL file system
.
@@ -28,15 +28,19 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.\" Man page generated from reStructeredText.
+.\" Man page generated from reStructuredText.
.
.SH SYNOPSIS
+.INDENT 0.0
+.INDENT 3.5
.sp
.nf
.ft C
umount.s3ql [options] <mount point>
.ft P
.fi
+.UNINDENT
+.UNINDENT
.SH DESCRIPTION
.sp
S3QL is a file system for online data storage. Before using S3QL, make
@@ -90,7 +94,6 @@ The full S3QL documentation should also be installed somewhere on your
system, common locations are \fB/usr/share/doc/s3ql\fP or
\fB/usr/local/doc/s3ql\fP.
.SH COPYRIGHT
-2008-2011, Nikolaus Rath
+2008-2013, Nikolaus Rath
.\" Generated by docutils manpage writer.
-.\"
.