3
==============================
4
The :program:`s3qladm` command
5
==============================
12
s3qladm [options] <action> <storage url>
14
where :var:`action` may be either of :program:`passphrase`,
15
:program:`upgrade`, :program:`delete` or :program:`download-metadata`.
20
.. include:: ../include/about.rst
22
The |command| command performs various operations on S3QL buckets.
23
The file system contained in the bucket *must not be mounted* when
24
using |command| or things will go wrong badly.
26
.. include:: ../include/backends.rst
32
The |command| command accepts the following options.
34
.. pipeinclude:: ../../bin/s3qladm --help
35
:start-after: show this help message and exit
40
The following actions may be specified:
43
Changes the encryption passphrase of the bucket.
46
Upgrade the file system contained in the bucket to the newest revision.
49
Delete the bucket and all its contents.
52
Interactively download backups of the file system metadata.
58
Authentication data for backends and bucket encryption passphrases are
59
read from :file:`authinfo` in :file:`~/.s3ql` or the directory
60
specified with :cmdopt:`--homedir`. Log files are placed in the same
64
.. include:: ../include/postman.rst
66
.. |command| replace:: :program:`s3qladm`