~ubuntu-branches/debian/stretch/s3ql/stretch

« back to all changes in this revision

Viewing changes to rst/man/adm.rst

  • Committer: Bazaar Package Importer
  • Author(s): Nikolaus Rath
  • Date: 2011-07-01 14:02:17 UTC
  • Revision ID: james.westby@ubuntu.com-20110701140217-cyyclk7tusagxucf
Tags: upstream-1.0.1
ImportĀ upstreamĀ versionĀ 1.0.1

Show diffs side-by-side

added added

removed removed

Lines of Context:
 
1
.. -*- mode: rst -*-
 
2
 
 
3
==============================
 
4
The :program:`s3qladm` command
 
5
==============================
 
6
 
 
7
Synopsis
 
8
========
 
9
 
 
10
::
 
11
 
 
12
   s3qladm [options] <action> <storage url>
 
13
 
 
14
where :var:`action` may be either of :program:`passphrase`,
 
15
:program:`upgrade`, :program:`delete` or :program:`download-metadata`.
 
16
  
 
17
Description
 
18
===========
 
19
 
 
20
.. include:: ../include/about.rst
 
21
 
 
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.
 
25
 
 
26
.. include:: ../include/backends.rst
 
27
 
 
28
 
 
29
Options
 
30
=======
 
31
 
 
32
The |command| command accepts the following options.
 
33
 
 
34
.. pipeinclude:: ../../bin/s3qladm --help
 
35
   :start-after: show this help message and exit
 
36
 
 
37
Actions
 
38
=======
 
39
 
 
40
The following actions may be specified:
 
41
 
 
42
passphrase
 
43
  Changes the encryption passphrase of the bucket.
 
44
 
 
45
upgrade
 
46
  Upgrade the file system contained in the bucket to the newest revision.
 
47
 
 
48
delete
 
49
  Delete the bucket and all its contents.
 
50
 
 
51
download-metadata
 
52
  Interactively download backups of the file system metadata.
 
53
 
 
54
 
 
55
Files
 
56
=====
 
57
 
 
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
 
61
directory.
 
62
  
 
63
 
 
64
.. include:: ../include/postman.rst
 
65
 
 
66
.. |command| replace:: :program:`s3qladm`