blob: c0ce132a27c9f53218ccbfeed2d071cfbb9a4b74 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
|
.TH "S3QLADM" "1" "April 09, 2013" "1.14" "S3QL"
.SH NAME
s3qladm \- Manage S3QL file systems
.
.nr rst2man-indent-level 0
.
.de1 rstReportMargin
\\$1 \\n[an-margin]
level \\n[rst2man-indent-level]
level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
-
\\n[rst2man-indent0]
\\n[rst2man-indent1]
\\n[rst2man-indent2]
..
.de1 INDENT
.\" .rstReportMargin pre:
. RS \\$1
. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
. nr rst2man-indent-level +1
.\" .rstReportMargin post:
..
.de UNINDENT
. RE
.\" indent \\n[an-margin]
.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
.nr rst2man-indent-level -1
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
.\" Man page generated from reStructeredText.
.
.SH SYNOPSIS
.sp
.nf
.ft C
s3qladm [options] <action> <storage url>
.ft P
.fi
.sp
where \fBaction\fP may be either of \fBpassphrase\fP,
\fBupgrade\fP, \fBdelete\fP or \fBdownload\-metadata\fP.
.SH DESCRIPTION
.sp
S3QL is a file system for online data storage. Before using S3QL, make
sure to consult the full documentation (rather than just the man pages
which only briefly document the available userspace commands).
.sp
The \fBs3qladm\fP command performs various operations on \fIunmounted\fP S3QL
file systems. The file system \fImust not be mounted\fP when using
\fBs3qladm\fP or things will go wrong badly.
.sp
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.
.INDENT 0.0
.INDENT 3.5
.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. (default: None)
.TP
.B \-\-quiet
be really quiet (default: False)
.TP
.BI \-\-log \ <target>
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
.TP
.BI \-\-authfile \ <path>
Read authentication credentials from this file (default:
\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. (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
.UNINDENT
.UNINDENT
.UNINDENT
.sp
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:
.INDENT 0.0
.TP
.B passphrase
Changes the encryption passphrase of the file system.
.TP
.B upgrade
Upgrade the file system to the newest revision.
.TP
.B delete
Delete the file system with all the stored data.
.TP
.B download\-metadata
Interactively download backups of the file system metadata.
.UNINDENT
.SH EXIT STATUS
.sp
\fBs3qladm\fP returns exit code 0 if the operation succeeded and 1 if some
error occurred.
.SH SEE ALSO
.sp
The S3QL homepage is at \fI\%http://code.google.com/p/s3ql/\fP.
.sp
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
.\" Generated by docutils manpage writer.
.\"
.
|
