diff options
Diffstat (limited to 'doc/html/man/adm.html')
| -rw-r--r-- | doc/html/man/adm.html | 239 |
1 files changed, 239 insertions, 0 deletions
diff --git a/doc/html/man/adm.html b/doc/html/man/adm.html new file mode 100644 index 0000000..7345230 --- /dev/null +++ b/doc/html/man/adm.html @@ -0,0 +1,239 @@ + + +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" + "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"> + + +<html xmlns="http://www.w3.org/1999/xhtml"> + <head> + <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> + + <title>The s3qladm command — S3QL 1.0.1 documentation</title> + + <link rel="stylesheet" href="../_static/sphinxdoc.css" type="text/css" /> + <link rel="stylesheet" href="../_static/pygments.css" type="text/css" /> + + <script type="text/javascript"> + var DOCUMENTATION_OPTIONS = { + URL_ROOT: '../', + VERSION: '1.0.1', + COLLAPSE_INDEX: false, + FILE_SUFFIX: '.html', + HAS_SOURCE: true + }; + </script> + <script type="text/javascript" src="../_static/jquery.js"></script> + <script type="text/javascript" src="../_static/underscore.js"></script> + <script type="text/javascript" src="../_static/doctools.js"></script> + <link rel="author" title="About these documents" href="../about.html" /> + <link rel="top" title="S3QL 1.0.1 documentation" href="../index.html" /> + <link rel="up" title="Manpages" href="index.html" /> + <link rel="next" title="The mount.s3ql command" href="mount.html" /> + <link rel="prev" title="The mkfs.s3ql command" href="mkfs.html" /> + </head> + <body> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="mount.html" title="The mount.s3ql command" + accesskey="N">next</a></li> + <li class="right" > + <a href="mkfs.html" title="The mkfs.s3ql command" + accesskey="P">previous</a> |</li> + <li><a href="../index.html">S3QL 1.0.1 documentation</a> »</li> + <li><a href="index.html" accesskey="U">Manpages</a> »</li> + </ul> + </div> + <div class="sphinxsidebar"> + <div class="sphinxsidebarwrapper"> + <h3><a href="../index.html">Table Of Contents</a></h3> + <ul class="current"> +<li class="toctree-l1"><a class="reference internal" href="../about.html">About S3QL</a></li> +<li class="toctree-l1"><a class="reference internal" href="../installation.html">Installation</a></li> +<li class="toctree-l1"><a class="reference internal" href="../backends.html">Storage Backends</a></li> +<li class="toctree-l1"><a class="reference internal" href="../mkfs.html">File System Creation</a></li> +<li class="toctree-l1"><a class="reference internal" href="../adm.html">Managing Buckets</a></li> +<li class="toctree-l1"><a class="reference internal" href="../mount.html">Mounting</a></li> +<li class="toctree-l1"><a class="reference internal" href="../special.html">Advanced S3QL Features</a></li> +<li class="toctree-l1"><a class="reference internal" href="../umount.html">Unmounting</a></li> +<li class="toctree-l1"><a class="reference internal" href="../fsck.html">Checking for Errors</a></li> +<li class="toctree-l1"><a class="reference internal" href="../contrib.html">Contributed Programs</a></li> +<li class="toctree-l1"><a class="reference internal" href="../tips.html">Tips & Tricks</a></li> +<li class="toctree-l1"><a class="reference internal" href="../issues.html">Known Issues</a></li> +<li class="toctree-l1 current"><a class="reference internal" href="index.html">Manpages</a><ul class="current"> +<li class="toctree-l2"><a class="reference internal" href="mkfs.html">The <strong class="program">mkfs.s3ql</strong> command</a></li> +<li class="toctree-l2 current"><a class="current reference internal" href="">The <strong class="program">s3qladm</strong> command</a></li> +<li class="toctree-l2"><a class="reference internal" href="mount.html">The <strong class="program">mount.s3ql</strong> command</a></li> +<li class="toctree-l2"><a class="reference internal" href="stat.html">The <strong class="program">s3qlstat</strong> command</a></li> +<li class="toctree-l2"><a class="reference internal" href="ctrl.html">The <strong class="program">s3qlctrl</strong> command</a></li> +<li class="toctree-l2"><a class="reference internal" href="cp.html">The <strong class="program">s3qlcp</strong> command</a></li> +<li class="toctree-l2"><a class="reference internal" href="rm.html">The <strong class="program">s3qlrm</strong> command</a></li> +<li class="toctree-l2"><a class="reference internal" href="lock.html">The <strong class="program">s3qllock</strong> command</a></li> +<li class="toctree-l2"><a class="reference internal" href="umount.html">The <strong class="program">umount.s3ql</strong> command</a></li> +<li class="toctree-l2"><a class="reference internal" href="fsck.html">The <strong class="program">fsck.s3ql</strong> command</a></li> +<li class="toctree-l2"><a class="reference internal" href="pcp.html">The <strong class="program">pcp</strong> command</a></li> +<li class="toctree-l2"><a class="reference internal" href="expire_backups.html">The <strong class="program">expire_backups</strong> command</a></li> +</ul> +</li> +<li class="toctree-l1"><a class="reference internal" href="../resources.html">Further Resources / Getting Help</a></li> +</ul> + + + <div id="searchbox" style="display: none"> + <h3>Quick search</h3> + <form class="search" action="../search.html" method="get"> + <input type="text" name="q" size="18" /> + <input type="submit" value="Go" /> + <input type="hidden" name="check_keywords" value="yes" /> + <input type="hidden" name="area" value="default" /> + </form> + <p class="searchtip" style="font-size: 90%"> + Enter search terms. + </p> + </div> + <script type="text/javascript">$('#searchbox').show(0);</script> + </div> + </div> + + <div class="document"> + <div class="documentwrapper"> + <div class="bodywrapper"> + <div class="body"> + + <div class="section" id="the-s3qladm-command"> +<h1>The <strong class="program">s3qladm</strong> command<a class="headerlink" href="#the-s3qladm-command" title="Permalink to this headline">¶</a></h1> +<div class="section" id="synopsis"> +<h2>Synopsis<a class="headerlink" href="#synopsis" title="Permalink to this headline">¶</a></h2> +<div class="highlight-commandline"><div class="highlight"><pre><span class="l">s3qladm </span><span class="ge">[options]</span><span class="l"> </span><span class="nv"><action></span><span class="l"> </span><span class="nv"><storage url></span><span class="l"></span> +</pre></div> +</div> +<p>where <tt class="var docutils literal"><span class="pre">action</span></tt> may be either of <strong class="program">passphrase</strong>, +<strong class="program">upgrade</strong>, <strong class="program">delete</strong> or <strong class="program">download-metadata</strong>.</p> +</div> +<div class="section" id="description"> +<h2>Description<a class="headerlink" href="#description" title="Permalink to this headline">¶</a></h2> +<p>The <strong class="program">s3qladm</strong> command performs various operations on S3QL buckets. +The file system contained in the bucket <em>must not be mounted</em> when +using <strong class="program">s3qladm</strong> or things will go wrong badly.</p> +<p>The form of the storage url depends on the backend that is used. The +following backends are supported:</p> +<div class="section" id="amazon-s3"> +<h3>Amazon S3<a class="headerlink" href="#amazon-s3" title="Permalink to this headline">¶</a></h3> +<p>To store your file system in an Amazon S3 bucket, use a storage URL of +the form <tt class=" docutils literal"><span class="pre">s3://<bucketname></span></tt>. Bucket names must conform to the S3 Bucket +Name Restrictions.</p> +</div> +<div class="section" id="local"> +<h3>Local<a class="headerlink" href="#local" title="Permalink to this headline">¶</a></h3> +<p>The local backend stores file system data in a directory on your +computer. The storage URL for the local backend has the form +<tt class=" docutils literal"><span class="pre">local://<path></span></tt>. Note that you have to write three consecutive +slashes to specify an absolute path, e.g. <tt class=" docutils literal"><span class="pre">local:///var/archive</span></tt>.</p> +</div> +<div class="section" id="sftp"> +<h3>SFTP<a class="headerlink" href="#sftp" title="Permalink to this headline">¶</a></h3> +<p>The storage URL for SFTP connections has the form</p> +<div class="highlight-commandline"><div class="highlight"><pre><span class="l">sftp://</span><span class="nv"><host></span><span class="ge">[:port]</span><span class="l">/</span><span class="nv"><path></span><span class="l"></span> +</pre></div> +</div> +</div> +</div> +<div class="section" id="options"> +<h2>Options<a class="headerlink" href="#options" title="Permalink to this headline">¶</a></h2> +<p>The <strong class="program">s3qladm</strong> command accepts the following options.</p> +<blockquote> +<div><table class="docutils option-list" frame="void" rules="none"> +<col class="option" /> +<col class="description" /> +<tbody valign="top"> +<tr><td class="option-group" colspan="2"> +<kbd><span class="option">--debug <var><module></var></span></kbd></td> +</tr> +<tr><td> </td><td>activate debugging output from <module>. Use <tt class=" docutils literal"><span class="pre">all</span></tt> to get +debug messages from all modules. This option can be +specified multiple times.</td></tr> +<tr><td class="option-group"> +<kbd><span class="option">--quiet</span></kbd></td> +<td>be really quiet</td></tr> +<tr><td class="option-group" colspan="2"> +<kbd><span class="option">--homedir <var><path></var></span></kbd></td> +</tr> +<tr><td> </td><td>Directory for log files, cache and authentication info. +(default: <tt class=" docutils literal"><span class="pre">~/.s3ql)</span></tt></td></tr> +<tr><td class="option-group"> +<kbd><span class="option">--version</span></kbd></td> +<td>just print program version and exit</td></tr> +<tr><td class="option-group"> +<kbd><span class="option">--ssl</span></kbd></td> +<td>Use SSL when connecting to remote servers. This option is +not enabled by default, because for encrypted file +systems, all data is already encrypted anyway, and +authentication data is never transmitted in plaintext +even for unencrypted file systems.</td></tr> +</tbody> +</table> +</div></blockquote> +<p>Hint: run <tt class=" docutils literal"><span class="pre">s3qladm</span> <span class="pre"><action></span> <span class="pre">--help</span></tt> to get help on the additional +arguments that the different actions take.</p> +</div> +<div class="section" id="actions"> +<h2>Actions<a class="headerlink" href="#actions" title="Permalink to this headline">¶</a></h2> +<p>The following actions may be specified:</p> +<dl class="docutils"> +<dt>passphrase</dt> +<dd>Changes the encryption passphrase of the bucket.</dd> +<dt>upgrade</dt> +<dd>Upgrade the file system contained in the bucket to the newest revision.</dd> +<dt>delete</dt> +<dd>Delete the bucket and all its contents.</dd> +<dt>download-metadata</dt> +<dd>Interactively download backups of the file system metadata.</dd> +</dl> +</div> +<div class="section" id="files"> +<h2>Files<a class="headerlink" href="#files" title="Permalink to this headline">¶</a></h2> +<p>Authentication data for backends and bucket encryption passphrases are +read from <tt class="file docutils literal"><span class="pre">authinfo</span></tt> in <tt class="file docutils literal"><span class="pre">~/.s3ql</span></tt> or the directory +specified with <tt class="cmdopt docutils literal"><span class="pre">--homedir</span></tt>. Log files are placed in the same +directory.</p> +</div> +<div class="section" id="exit-status"> +<h2>Exit Status<a class="headerlink" href="#exit-status" title="Permalink to this headline">¶</a></h2> +<p><strong class="program">s3qladm</strong> returns exit code 0 if the operation succeeded and 1 if some +error occured.</p> +</div> +<div class="section" id="see-also"> +<h2>See Also<a class="headerlink" href="#see-also" title="Permalink to this headline">¶</a></h2> +<p>The S3QL homepage is at <a class="reference external" href="http://code.google.com/p/s3ql/">http://code.google.com/p/s3ql/</a>.</p> +<p>The full S3QL documentation should also be installed somewhere on your +system, conventional locations are <tt class="file docutils literal"><span class="pre">/usr/share/doc/s3ql</span></tt> or +<tt class="file docutils literal"><span class="pre">/usr/local/doc/s3ql</span></tt>.</p> +</div> +</div> + + + </div> + </div> + </div> + <div class="clearer"></div> + </div> + <div class="related"> + <h3>Navigation</h3> + <ul> + <li class="right" style="margin-right: 10px"> + <a href="mount.html" title="The mount.s3ql command" + >next</a></li> + <li class="right" > + <a href="mkfs.html" title="The mkfs.s3ql command" + >previous</a> |</li> + <li><a href="../index.html">S3QL 1.0.1 documentation</a> »</li> + <li><a href="index.html" >Manpages</a> »</li> + </ul> + </div> + <div class="footer"> + © Copyright 2008-2011, Nikolaus Rath. + Created using <a href="http://sphinx.pocoo.org/">Sphinx</a> 1.1pre. + </div> + </body> +</html>
\ No newline at end of file |