.TH "MKFS.S3QL" "1" "August 27, 2014" "1.11.1" "S3QL"
.SH NAME
mkfs.s3ql \- Create an S3QL file system
.
.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
mkfs.s3ql [options] <storage url>
.ft P
.fi
.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 \fBmkfs.s3ql\fP command creates a new file system in the location
specified by \fIstorage url\fP. 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.
.sp
Unless you have specified the \fB\-\-plain\fP option, \fBmkfs.s3ql\fP will ask
you to enter an encryption password. This password will \fInot\fP be read
from an authentication file specified with the \fB\-\-authfile\fP
option to prevent accidental creation of an encrypted file system.
.SH OPTIONS
.sp
The \fBmkfs.s3ql\fP command accepts the following options.
.INDENT 0.0
.INDENT 3.5
.INDENT 0.0
.TP
.BI \-\-cachedir \ <path>
Store cached data in this directory (default:
\fB~/.s3ql)\fP
.TP
.BI \-\-authfile \ <path>
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 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.
.TP
.B \-\-version
just print program version and exit
.TP
.BI \-L \ <name>
Filesystem label
.TP
.BI \-\-max\-obj\-size \ <size>
Maximum size of storage objects in KB. Files bigger
than this will be spread over multiple objects in the
storage backend. Default: 10240 KB.
.TP
.B \-\-plain
Create unencrypted file system.
.TP
.B \-\-force
Overwrite any existing data.
.UNINDENT
.UNINDENT
.UNINDENT
.SH EXIT STATUS
.sp
\fBmkfs.s3ql\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.
.\" 
.