[Box Backup-dev] Re: [Box Backup-commit] COMMIT r2305 - box/trunk/documentation

James O'Gorman boxbackup-dev at boxbackup.org
Wed Oct 1 00:34:29 BST 2008


Hi all,

As you can see from the below, we now have a (pretty much) complete
documentation set! The only one that still needs a little work is
bbackupd.conf. I've listed all of its options but couldn't really
explain them all (e.g. new features).

Chris, if you could quickly review the new doc and let me know what I'm
missing, I'll fill in the blanks (unless you want to have a go at doing
it yourself :-) ).

To all distro packagers out there, it'd be great if you could all review
these docs too, and start including them in your distributions!

Cheers,

James


subversion at fluffy.co.uk wrote:
> Author: jamesog
> Date: 2008-10-01 00:28:57 +0100 (Wed, 01 Oct 2008)
> New Revision: 2305
> 
> Added:
>    box/trunk/documentation/bbackupd-config.xml
>    box/trunk/documentation/bbackupd.conf.xml
>    box/trunk/documentation/bbackupd.xml
>    box/trunk/documentation/bbstored.conf.xml
>    box/trunk/documentation/bbstored.xml
>    box/trunk/documentation/raidfile.conf.xml
> Modified:
>    box/trunk/documentation/bbackupctl.xml
>    box/trunk/documentation/bbackupquery.xml
>    box/trunk/documentation/bbstoreaccounts.xml
>    box/trunk/documentation/bbstored-certs.xml
>    box/trunk/documentation/bbstored-config.xml
>    box/trunk/documentation/raidfile-config.xml
> Log:
> Documentation!
> 
> Add new documents for:
>  * bbackupd
>  * bbstored
>  * bbackupd-config
>  * bbackupd.conf
>  * bbstored.conf
>  * raidfile.conf
> 
> Update all other existing docs with a little more info.
> 
> 
> 
> Modified: box/trunk/documentation/bbackupctl.xml
> ===================================================================
> --- box/trunk/documentation/bbackupctl.xml	2008-09-30 23:27:06 UTC (rev 2304)
> +++ box/trunk/documentation/bbackupctl.xml	2008-09-30 23:28:57 UTC (rev 2305)
> @@ -1,5 +1,11 @@
>  <?xml version="1.0" encoding="UTF-8"?>
> -<refentry>
> +<refentry version="5.0" xmlns="http://docbook.org/ns/docbook"
> +          xmlns:xlink="http://www.w3.org/1999/xlink"
> +          xmlns:xi="http://www.w3.org/2001/XInclude"
> +          xmlns:svg="http://www.w3.org/2000/svg"
> +          xmlns:m="http://www.w3.org/1998/Math/MathML"
> +          xmlns:html="http://www.w3.org/1999/xhtml"
> +          xmlns:db="http://docbook.org/ns/docbook">
>    <refmeta>
>      <refentrytitle>bbackupctl</refentrytitle>
>  
> @@ -9,139 +15,169 @@
>    <refnamediv>
>      <refname>bbackupctl</refname>
>  
> -    <refpurpose>Control the bbackupd daemon </refpurpose>
> +    <refpurpose>Contol the Box Backup client daemon</refpurpose>
>    </refnamediv>
>  
>    <refsynopsisdiv>
>      <cmdsynopsis>
> -      <command>bbackupctl [-q] [-c config-file] command</command>
> +      <command>bbackupctl</command>
> +
> +      <arg>-q</arg>
> +
> +      <arg>-c config-file</arg>
> +
> +      <arg choice="plain">command</arg>
>      </cmdsynopsis>
>    </refsynopsisdiv>
>  
>    <refsection>
>      <title>Description</title>
>  
> -    <para><literal>bbackupctl</literal> lets the user control the bbackupd
> -    daemon on a client machine. The main use is to force a sync with the store
> -    server. This is especially important if bbackupd(8) is configured to do
> -    snapshot backups. In that case <literal>bbackupctl</literal> is the only
> -    way to effect a backup.</para>
> +    <para><command>bbackupctl</command> sends commands to a running
> +    <command>bbackupd</command> daemon on a client machine. It can be used to
> +    force an immediate backup, tell the daemon to reload its configuration
> +    files or stop the daemon. If <command>bbackupd</command> is configured in
> +    snapshot mode, it will not back up automatically, and the
> +    <command>bbackupctl</command> must be used to tell it when to start a
> +    backup.</para>
>  
>      <para>Communication with the bbackupd daemon takes place over a local
> -    socket. Some platforms (notably Windows) can't determine if the user
> -    connecting on this socket has the correct credentials to execute the
> -    commands, leaving a rather sizeable security hole open. To avoid this,
> -    unset the CommandSocket parameter in <literal>bbackupd.conf</literal>(5).
> -    That disables the command socket, so bbackupd is secure. This does,
> -    however, render bbackupctl unusable.</para>
> +    socket (not over the network). Some platforms (notably Windows) can't
> +    determine if the user connecting on this socket has the correct
> +    credentials to execute the commands. On these platforms, ANY local user
> +    can interfere with bbackupd. To avoid this, remove the CommandSocket
> +    option from bbackupd.conf, which will also disable bbackupctl. See the
> +    Client Configuration page for more information.</para>
>  
> -    <refsection>
> -      <title>Options</title>
> +    <para><command>bbackupctl</command> needs to read the
> +    <command>bbackupd</command> configuration file to find out the name of the
> +    CommandSocket. If you have to tell <command>bbackupd</command> where to
> +    find the configuration file, you will have to tell
> +    <command>bbackupctl</command> as well. The default on Unix systems is
> +    usually <filename>/etc/box/bbackupd.conf</filename>. On Windows systems,
> +    it is <filename>bbackupd.conf</filename> in the same directory where
> +    <command>bbackupd.exe</command> is located. If
> +    <command>bbackupctl</command> cannot find or read the configuration file,
> +    it will log an error message and exit.</para>
>  
> -      <itemizedlist>
> +    <para><command>bbackupctl</command> usually writes error messages to the
> +    console and the system logs. If it is not doing what you expect, please
> +    check these outputs first of all.</para>
> +
> +    <variablelist>
> +      <varlistentry>
> +        <term><option>-q</option></term>
> +
>          <listitem>
> -          <para>-q -- quiet. Do not output status messages.</para>
> +          <para>Run in quiet mode.</para>
>          </listitem>
> +      </varlistentry>
>  
> +      <varlistentry>
> +        <term><option>-c</option> config-file</term>
> +
>          <listitem>
> -          <para>-c config_file -- Use a different config file from the default
> -          one. Can be a full or a relative path.</para>
> +          <para>Specify configuration file.</para>
>          </listitem>
> -      </itemizedlist>
> -    </refsection>
> +      </varlistentry>
> +    </variablelist>
>  
>      <refsection>
>        <title>Commands</title>
>  
>        <para>The following commands are available in bbackupctl:</para>
>  
> -      <itemizedlist>
> -        <listitem>
> -          <para><literal>terminate</literal></para>
> +      <variablelist>
> +        <varlistentry>
> +          <term><command>terminate</command></term>
>  
> -          <para>This command stops the bbackupd server. This is the equivalent
> -          of killing (kill -KILL) the bbackupd process.</para>
> -        </listitem>
> +          <listitem>
> +            <para>This command cleanly shuts down <command>bbackupd</command>.
> +            This is better than killing or terminating it any other
> +            way.</para>
> +          </listitem>
> +        </varlistentry>
>  
> -        <listitem>
> -          <para><literal>reload</literal></para>
> +        <varlistentry>
> +          <term><command>reload</command></term>
>  
> -          <para>Causes the bbackupd daemon to re-read all its configuration
> -          files. Equivalent to kill -HUP.</para>
> -        </listitem>
> +          <listitem>
> +            <para>Causes the <command>bbackupd</command> daemon to re-read all
> +            its configuration files. Equivalent to <command>kill
> +            -HUP</command>.</para>
> +          </listitem>
> +        </varlistentry>
>  
> -        <listitem>
> -          <para><literal>sync</literal></para>
> +        <varlistentry>
> +          <term><command>sync</command></term>
>  
> -          <para>Initiates a backup to the store of whatever needs to be backed
> -          up.</para>
> -        </listitem>
> -      </itemizedlist>
> -    </refsection>
> -  </refsection>
> +          <listitem>
> +            <para>Initiates a backup. If no files need to be backed up, no
> +            connection will be made to the server.</para>
> +          </listitem>
> +        </varlistentry>
>  
> -  <refsection>
> -    <title>Author</title>
> +        <varlistentry>
> +          <term><command>force-sync</command></term>
>  
> -    <para>Ben Summers and contributors. For help, please go to the <ulink
> -    url="http://www.boxbackup.org/trac/">Wiki</ulink>, or subscribe to the Box
> -    Backup <ulink
> -    url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing
> -    list.</ulink></para>
> -  </refsection>
> +          <listitem>
> +            <para>Initiates a backup, even if the
> +            <varname>SyncAllowScript</varname> says that no backup should run
> +            now.</para>
> +          </listitem>
> +        </varlistentry>
>  
> -  <refsection>
> -    <title>See Also</title>
> +        <varlistentry>
> +          <term><command>wait-for-sync</command></term>
>  
> -    <para><literal>bbackupd.conf(5)</literal></para>
> +          <listitem>
> +            <para>Passively waits until the next backup starts of its own
> +            accord, and then terminates.</para>
> +          </listitem>
> +        </varlistentry>
>  
> -    <para><literal>bbackupd(8)</literal></para>
> +        <varlistentry>
> +          <term><command>wait-for-end</command></term>
> +
> +          <listitem>
> +            <para>Passively waits until the next backup starts of its own
> +            accord and finishes, and then terminates.</para>
> +          </listitem>
> +        </varlistentry>
> +
> +        <varlistentry>
> +          <term><command>sync-and-wait</command></term>
> +
> +          <listitem>
> +            <para>Initiates a backup, waits for it to finish, and then
> +            terminates.</para>
> +          </listitem>
> +        </varlistentry>
> +      </variablelist>
> +    </refsection>
>    </refsection>
>  
>    <refsection>
>      <title>Files</title>
>  
> -    <para><literal>bbackupctl</literal> uses the Box Backup client
> -    configuration file, usually located in
> -    <filename>/etc/box/bbackupd.conf</filename>. On Windows this file is
> -    usually located in the installation directory, and is named
> -    <filename>bbackupd.conf</filename> as well.</para>
> +    <para><filename>/etc/box/bbackupd.conf</filename></para>
>    </refsection>
>  
>    <refsection>
> -    <title>Bugs</title>
> +    <title>See Also</title>
>  
> -    <para>If you find a bug in Box Backup, and you want to let us know about
> -    it, join the <ulink
> -    url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing
> -    list</ulink>, and send a description of the problem there.</para>
> +    <para><citerefentry>
> +        <refentrytitle>bbackupd.conf</refentrytitle>
>  
> -    <para>To report a bug, give us at least the following information:</para>
> +        <manvolnum>5</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>bbackupd-config</refentrytitle>
>  
> -    <itemizedlist>
> -      <listitem>
> -        <para>The version of Box Backup you are running</para>
> -      </listitem>
> +        <manvolnum>8</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>bbackupctl</refentrytitle>
>  
> -      <listitem>
> -        <para>The platform you are running on (Hardware and OS), for both
> -        client and server.</para>
> -      </listitem>
> -
> -      <listitem>
> -        <para>If possible attach your config files (bbstored.conf,
> -        bbackupd.conf) to the bug report.</para>
> -      </listitem>
> -
> -      <listitem>
> -        <para>Also attach any log file output that helps shed light on the
> -        problem you are seeing.</para>
> -      </listitem>
> -
> -      <listitem>
> -        <para>And last but certainly not least, a description of what you are
> -        seeing, in as much detail as possible.</para>
> -      </listitem>
> -    </itemizedlist>
> +        <manvolnum>8</manvolnum>
> +      </citerefentry></para>
>    </refsection>
>  </refentry>
> 
> Added: box/trunk/documentation/bbackupd-config.xml
> ===================================================================
> --- box/trunk/documentation/bbackupd-config.xml	                        (rev 0)
> +++ box/trunk/documentation/bbackupd-config.xml	2008-09-30 23:28:57 UTC (rev 2305)
> @@ -0,0 +1,149 @@
> +<?xml version="1.0" encoding="UTF-8"?>
> +<refentry version="5.0" xmlns="http://docbook.org/ns/docbook"
> +          xmlns:xlink="http://www.w3.org/1999/xlink"
> +          xmlns:xi="http://www.w3.org/2001/XInclude"
> +          xmlns:svg="http://www.w3.org/2000/svg"
> +          xmlns:m="http://www.w3.org/1998/Math/MathML"
> +          xmlns:html="http://www.w3.org/1999/xhtml"
> +          xmlns:db="http://docbook.org/ns/docbook">
> +  <refmeta>
> +    <refentrytitle>bbackupd-config</refentrytitle>
> +
> +    <manvolnum>8</manvolnum>
> +
> +    <refmiscinfo>Box Backup 0.11</refmiscinfo>
> +  </refmeta>
> +
> +  <refnamediv>
> +    <refname>bbackupd-config</refname>
> +
> +    <refpurpose>Box Backup client daemon configuration file
> +    generator</refpurpose>
> +  </refnamediv>
> +
> +  <refsynopsisdiv>
> +    <cmdsynopsis>
> +      <command>bbackupd-config</command>
> +
> +      <arg choice="plain">config-dir</arg>
> +
> +      <arg choice="plain">backup-mode</arg>
> +
> +      <arg choice="plain">account-num</arg>
> +
> +      <arg choice="plain">server-hostname</arg>
> +
> +      <arg choice="plain">working-dir</arg>
> +
> +      <arg choice="plain">backup-dir</arg>
> +
> +      <arg choice="opt">backup-dir ...</arg>
> +    </cmdsynopsis>
> +  </refsynopsisdiv>
> +
> +  <refsection>
> +    <title>Description</title>
> +
> +    <para>The bbackupd-config script creates configuration files and client
> +    certificates. It takes at least six parameters:</para>
> +
> +    <variablelist>
> +      <varlistentry>
> +        <term>config-dir</term>
> +
> +        <listitem>
> +          <para>Configuration directory. Usually
> +          <filename>/etc/box</filename>.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term>backup-mode</term>
> +
> +        <listitem>
> +          <para>Either lazy or snapshot.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term>account-num</term>
> +
> +        <listitem>
> +          <para>The client account number. This is set by the bbstored
> +          administrator.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term>server-hostname</term>
> +
> +        <listitem>
> +          <para>The hostname or IP address of the bbstored server.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term>working-dir</term>
> +
> +        <listitem>
> +          <para>A directory to keep temporary state files. This is usually
> +          something like <filename>/var/bbackupd</filename>. This can be
> +          changed in <filename>bbackupd.conf</filename> later on if
> +          required.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term>backup-dir</term>
> +
> +        <listitem>
> +          <para>A space-separated list of directories to be backed up. Note
> +          that this <emphasis>does not</emphasis> traverse mount
> +          points.</para>
> +        </listitem>
> +      </varlistentry>
> +    </variablelist>
> +  </refsection>
> +
> +  <refsection>
> +    <title>Files</title>
> +
> +    <para><filename>/etc/box/bbackupd.conf</filename></para>
> +
> +    <para><filename>/etc/box/bbackupd/NotifySysAdmin.sh</filename></para>
> +  </refsection>
> +
> +  <refsection>
> +    <title>See Also</title>
> +
> +    <para><citerefentry>
> +        <refentrytitle>bbackupd.conf</refentrytitle>
> +
> +        <manvolnum>5</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>bbackupd</refentrytitle>
> +
> +        <manvolnum>8</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>bbackupctl</refentrytitle>
> +
> +        <manvolnum>8</manvolnum>
> +      </citerefentry></para>
> +  </refsection>
> +
> +  <refsection>
> +    <title>Authors</title>
> +
> +    <para><author>
> +        <personname>Ben Summers</personname>
> +      </author></para>
> +
> +    <para><author>
> +        <personname>Per Thomsen</personname>
> +      </author></para>
> +
> +    <para><author>
> +        <personname>James O'Gorman</personname>
> +      </author></para>
> +  </refsection>
> +</refentry>
> 
> Added: box/trunk/documentation/bbackupd.conf.xml
> ===================================================================
> --- box/trunk/documentation/bbackupd.conf.xml	                        (rev 0)
> +++ box/trunk/documentation/bbackupd.conf.xml	2008-09-30 23:28:57 UTC (rev 2305)
> @@ -0,0 +1,475 @@
> +<?xml version="1.0" encoding="UTF-8"?>
> +<refentry version="5.0" xmlns="http://docbook.org/ns/docbook"
> +          xmlns:xlink="http://www.w3.org/1999/xlink"
> +          xmlns:xi="http://www.w3.org/2001/XInclude"
> +          xmlns:svg="http://www.w3.org/2000/svg"
> +          xmlns:m="http://www.w3.org/1998/Math/MathML"
> +          xmlns:html="http://www.w3.org/1999/xhtml"
> +          xmlns:db="http://docbook.org/ns/docbook">
> +  <refmeta>
> +    <refentrytitle>bbackupd.conf</refentrytitle>
> +
> +    <manvolnum>5</manvolnum>
> +
> +    <refmiscinfo>Box Backup 0.11</refmiscinfo>
> +  </refmeta>
> +
> +  <refnamediv>
> +    <refname>bbackupd.conf</refname>
> +
> +    <refpurpose>Box Backup client daemon configuration file</refpurpose>
> +  </refnamediv>
> +
> +  <refsynopsisdiv>
> +    <cmdsynopsis>
> +      <command>/etc/box/bbackupd.conf</command>
> +    </cmdsynopsis>
> +  </refsynopsisdiv>
> +
> +  <refsection>
> +    <title>Description</title>
> +
> +    <variablelist>
> +      <varlistentry>
> +        <term><varname>AccountNumber</varname></term>
> +
> +        <listitem>
> +          <para>The account number of this client. This is set by the admin of
> +          the store server.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>UpdateStoreInterval</varname></term>
> +
> +        <listitem>
> +          <para>Specifies the interval between scanning of the local discs. To
> +          avoid cycles of load on the server, this time is randomly adjusted
> +          by a small percentage as the daemon runs. Defaults to 1 hour.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>MinimumFileAge</varname></term>
> +
> +        <listitem>
> +          <para>Specifies how long since a file was last modified before it
> +          will be uploaded. Defaults to 6 hours.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>MaxUploadWait</varname></term>
> +
> +        <listitem>
> +          <para>If a file is repeatedly modified it won't be uploaded
> +          immediately in case it's modified again. However it should be
> +          uploaded eventually. This is how long we should wait after first
> +          noticing a change. Defaults to 1 day.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>MaxFileTimeInFuture</varname></term>
> +
> +        <listitem>
> +          <para></para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>AutomaticBackup</varname></term>
> +
> +        <listitem>
> +          <para></para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>SyncAllowScript</varname></term>
> +
> +        <listitem>
> +          <para>Use this to temporarily stop bbackupd from syncronising or
> +          connecting to the store. This specifies a program or script script
> +          which is run just before each sync, and ideally the full path to the
> +          interpreter. It will be run as the same user bbackupd is running as,
> +          usually root.</para>
> +
> +          <para>The script prints either "now" or a number to STDOUT (and a
> +          terminating newline, no quotes). If the result was "now", then the
> +          sync will happen. If it's a number, then the script will be asked
> +          again in that number of seconds.</para>
> +
> +          <para>For example, you could use this on a laptop to only backup
> +          when on a specific network. </para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>MaximumDiffingTime</varname></term>
> +
> +        <listitem>
> +          <para>How much time should be spent on diffing files.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>DeleteRedundantLocationsAfter</varname></term>
> +
> +        <listitem>
> +          <para></para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>FileTrackingSizeThreshold</varname></term>
> +
> +        <listitem>
> +          <para></para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>DiffingUploadSizeThreshold</varname></term>
> +
> +        <listitem>
> +          <para></para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>StoreHostname</varname></term>
> +
> +        <listitem>
> +          <para>The hostname or IP address of the <citerefentry>
> +              <refentrytitle>bbstored</refentrytitle>
> +
> +              <manvolnum>8</manvolnum>
> +            </citerefentry> server.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>StorePort</varname></term>
> +
> +        <listitem>
> +          <para>The port used by the server. Defaults to 2201.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>ExtendedLogging</varname></term>
> +
> +        <listitem>
> +          <para>Logs everything that happens between the client and server.
> +          The <citerefentry>
> +              <refentrytitle>bbackupd</refentrytitle>
> +
> +              <manvolnum>8</manvolnum>
> +            </citerefentry> client must also be started with
> +          <option>-V</option>.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>ExtendedLogFile</varname></term>
> +
> +        <listitem>
> +          <para></para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>LogAllFileAccess</varname></term>
> +
> +        <listitem>
> +          <para></para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>LogFile</varname></term>
> +
> +        <listitem>
> +          <para></para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>LogFileLevel</varname></term>
> +
> +        <listitem>
> +          <para></para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>CommandSocket</varname></term>
> +
> +        <listitem>
> +          <para>Where the command socket is created in the filesystem.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>KeepAliveTime</varname></term>
> +
> +        <listitem>
> +          <para></para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>StoreObjectInfoFile</varname></term>
> +
> +        <listitem>
> +          <para></para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>NotifyScript</varname></term>
> +
> +        <listitem>
> +          <para>The location of the script which runs at certain events. This
> +          script is generated by <citerefentry>
> +              <refentrytitle>bbackupd-config</refentrytitle>
> +
> +              <manvolnum>8</manvolnum>
> +            </citerefentry>. Defaults to
> +          <filename>/etc/box/bbackupd/NotifySysAdmin.sh</filename>.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>NotifyAlways</varname></term>
> +
> +        <listitem>
> +          <para></para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>CertificateFile</varname></term>
> +
> +        <listitem>
> +          <para>The path to the client's public certificate.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>PrivateKeyFile</varname></term>
> +
> +        <listitem>
> +          <para>The path to the client's private key. This should only be
> +          readable by root.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>TrustedCAsFile</varname></term>
> +
> +        <listitem>
> +          <para>The Certificate Authority created by <citerefentry>
> +              <refentrytitle>bbstored-certs</refentrytitle>
> +
> +              <manvolnum>8</manvolnum>
> +            </citerefentry>.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>KeysFile</varname></term>
> +
> +        <listitem>
> +          <para>The data encryption key. This <emphasis
> +          role="bold">must</emphasis> be kept safe at all costs, your data is
> +          useless without it!</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>DataDirectory</varname></term>
> +
> +        <listitem>
> +          <para>A directory to keep temporary state files. This is usually
> +          something like <filename>/var/bbackupd</filename>.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>Server</varname></term>
> +
> +        <listitem>
> +          <para>This section relates to the running daemon.</para>
> +
> +          <para><variablelist>
> +              <varlistentry>
> +                <term><varname>PidFile</varname></term>
> +
> +                <listitem>
> +                  <para>The location of the process ID file. Defaults to
> +                  <filename>/var/run/bbackupd.pid</filename>.</para>
> +                </listitem>
> +              </varlistentry>
> +            </variablelist></para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>BackupLocations</varname></term>
> +
> +        <listitem>
> +          <para>This section defines each directory to be backed up. Each
> +          entry must have at least a Path entry and, optionally, include and
> +          exclude directives.</para>
> +
> +          <para>Multiple include and exclude directives may appear.</para>
> +
> +          <para><variablelist>
> +              <varlistentry>
> +                <term><varname>Path</varname></term>
> +
> +                <listitem>
> +                  <para>The path to back up.</para>
> +                </listitem>
> +              </varlistentry>
> +
> +              <varlistentry>
> +                <term><varname>ExcludeFile</varname></term>
> +
> +                <listitem>
> +                  <para>Exclude a single file.</para>
> +                </listitem>
> +              </varlistentry>
> +
> +              <varlistentry>
> +                <term><varname>ExcludeFilesRegex</varname></term>
> +
> +                <listitem>
> +                  <para>Exclude multiple files based on a regular expression.
> +                  See <citerefentry>
> +                      <refentrytitle>re_format</refentrytitle>
> +
> +                      <manvolnum>7</manvolnum>
> +                    </citerefentry>.</para>
> +                </listitem>
> +              </varlistentry>
> +
> +              <varlistentry>
> +                <term><varname>ExcludeDir</varname></term>
> +
> +                <listitem>
> +                  <para>Exclude a single directory.</para>
> +                </listitem>
> +              </varlistentry>
> +
> +              <varlistentry>
> +                <term><varname>ExcludeDirsRegex</varname></term>
> +
> +                <listitem>
> +                  <para>Exclude multiple directories based on a regular
> +                  expression. See <citerefentry>
> +                      <refentrytitle>re_format</refentrytitle>
> +
> +                      <manvolnum>7</manvolnum>
> +                    </citerefentry>.</para>
> +                </listitem>
> +              </varlistentry>
> +
> +              <varlistentry>
> +                <term><varname>AlwaysIncludeFile</varname></term>
> +
> +                <listitem>
> +                  <para>Include a single file from a directory which has been
> +                  excluded.</para>
> +                </listitem>
> +              </varlistentry>
> +
> +              <varlistentry>
> +                <term><varname>AlwaysIncludeFilesRegex</varname></term>
> +
> +                <listitem>
> +                  <para>Include multiple files from an excluded directory,
> +                  based on a regular expression.</para>
> +                </listitem>
> +              </varlistentry>
> +
> +              <varlistentry>
> +                <term><varname>AlwaysIncludeDir</varname></term>
> +
> +                <listitem>
> +                  <para>Include a single directory from a directory which has
> +                  been excluded.</para>
> +                </listitem>
> +              </varlistentry>
> +
> +              <varlistentry>
> +                <term><varname>AlwaysIncludeDirsRegex</varname></term>
> +
> +                <listitem>
> +                  <para>Include multiple directories from an excluded
> +                  directory, based on a regular expression.</para>
> +                </listitem>
> +              </varlistentry>
> +            </variablelist></para>
> +        </listitem>
> +      </varlistentry>
> +    </variablelist>
> +  </refsection>
> +
> +  <refsection>
> +    <title>Examples</title>
> +
> +    <para>The following is an example of a backup location:</para>
> +
> +    <programlisting>home
> +{
> +   Path = /home
> +   ExcludeDir = /home/guest
> +   ExcludeDir = /home/[^/]+/tmp
> +   ExcludeFilesRegex = .*\.(mp3|MP3)$
> +   AlwaysIncludeFile = /home/someuser/importantspeech.mp3
> +}</programlisting>
> +  </refsection>
> +
> +  <refsection>
> +    <title>Files</title>
> +
> +    <para><filename>/etc/box/bbackupd.conf</filename></para>
> +  </refsection>
> +
> +  <refsection>
> +    <title>See Also</title>
> +
> +    <para><citerefentry>
> +        <refentrytitle>bbackupd</refentrytitle>
> +
> +        <manvolnum>8</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>bbackupd-config</refentrytitle>
> +
> +        <manvolnum>8</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>bbackupctl</refentrytitle>
> +
> +        <manvolnum>8</manvolnum>
> +      </citerefentry></para>
> +  </refsection>
> +
> +  <refsection>
> +    <title>Authors</title>
> +
> +    <para><author>
> +        <personname>Ben Summers</personname>
> +      </author></para>
> +
> +    <para><author>
> +        <personname>Per Thomsen</personname>
> +      </author></para>
> +
> +    <para><author>
> +        <personname>James O'Gorman</personname>
> +      </author></para>
> +  </refsection>
> +</refentry>
> 
> Added: box/trunk/documentation/bbackupd.xml
> ===================================================================
> --- box/trunk/documentation/bbackupd.xml	                        (rev 0)
> +++ box/trunk/documentation/bbackupd.xml	2008-09-30 23:28:57 UTC (rev 2305)
> @@ -0,0 +1,205 @@
> +<?xml version="1.0" encoding="UTF-8"?>
> +<refentry version="5.0" xmlns="http://docbook.org/ns/docbook"
> +          xmlns:xlink="http://www.w3.org/1999/xlink"
> +          xmlns:xi="http://www.w3.org/2001/XInclude"
> +          xmlns:svg="http://www.w3.org/2000/svg"
> +          xmlns:m="http://www.w3.org/1998/Math/MathML"
> +          xmlns:html="http://www.w3.org/1999/xhtml"
> +          xmlns:db="http://docbook.org/ns/docbook">
> +  <refmeta>
> +    <refentrytitle>bbackupd</refentrytitle>
> +
> +    <manvolnum>8</manvolnum>
> +
> +    <refmiscinfo>Box Backup 0.11</refmiscinfo>
> +  </refmeta>
> +
> +  <refnamediv>
> +    <refname>bbackupd</refname>
> +
> +    <refpurpose>Box Backup client daemon</refpurpose>
> +  </refnamediv>
> +
> +  <refsynopsisdiv>
> +    <cmdsynopsis>
> +      <command>bbackupd</command>
> +
> +      <arg>-DFkqvVT</arg>
> +
> +      <arg>-c config-file</arg>
> +
> +      <arg>-t tag</arg>
> +    </cmdsynopsis>
> +  </refsynopsisdiv>
> +
> +  <refsection>
> +    <title>Description</title>
> +
> +    <para><command>bbackupd</command> runs on client computers in the
> +    background, finding new files to back up. When it is time for a backup,
> +    <command>bbackupd</command> will connect to the server
> +    (<command>bbstored</command>) to upload the files.</para>
> +
> +    <para>A running <command>bbackupd</command> daemon can be controlled with
> +    the <command>bbackupctl</command> command, to make it shut down, reload
> +    its configuration, or start an immediate backup.</para>
> +
> +    <para><command>bbackupd</command> needs to be configured to tell it which
> +    files to back up, how often, and to which server (running
> +    <command>bbstored</command>). See the Client Configuration page for more
> +    information. For this, you must write a configuration file. You must
> +    either place it in the default location, or tell
> +    <command>bbackupd</command> where to find it.</para>
> +
> +    <para>You can check the default location with the <option>-h</option>
> +    option. The default on Unix systems is usually
> +    <filename>/etc/box/bbackupd.conf</filename>. On Windows systems, it is
> +    <filename>bbackupd.conf</filename> in the same directory where
> +    <command>bbackupd.exe</command> is located. If bbackupd cannot find or
> +    read the configuration file, it will log an error message and exit.</para>
> +
> +    <para><command>bbackupd</command> usually writes log messages to the
> +    system logs, using the facility <function>local5</function>, which you can
> +    use to filter them to send them to a separate file. It can also write them
> +    to the console, see options below. If <command>bbackupd</command> is not
> +    doing what you expect, please check the logs first of all.</para>
> +
> +    <refsection>
> +      <title>Options</title>
> +
> +      <variablelist>
> +        <varlistentry>
> +          <term><option>-c</option> config-file</term>
> +
> +          <listitem>
> +            <para>Use the specified configuration file. If <option>-c</option>
> +            is omitted, the last argument is the configuration file. If none
> +            is specified, the default is used (see above).</para>
> +          </listitem>
> +        </varlistentry>
> +
> +        <varlistentry>
> +          <term><option>-D</option></term>
> +
> +          <listitem>
> +            <para>Debugging mode. Do not fork into the background (do not run
> +            as a daemon). Not available on Windows.</para>
> +          </listitem>
> +        </varlistentry>
> +
> +        <varlistentry>
> +          <term><option>-F</option></term>
> +
> +          <listitem>
> +            <para>No-fork mode. Same as <option>-D</option> for bbackupd. Not
> +            available on Windows.</para>
> +          </listitem>
> +        </varlistentry>
> +
> +        <varlistentry>
> +          <term><option>-k</option></term>
> +
> +          <listitem>
> +            <para>Keep console open after fork, keep writing log messages to
> +            it. Not available on Windows.</para>
> +          </listitem>
> +        </varlistentry>
> +
> +        <varlistentry>
> +          <term><option>-q</option></term>
> +
> +          <listitem>
> +            <para>Run more quietly. Reduce verbosity level by one. Available
> +            levels are <varname>NOTHING</varname>, <varname>FATAL</varname>,
> +            <varname>ERROR</varname>, <varname>WARNING</varname>,
> +            <varname>NOTICE</varname>, <varname>INFO</varname>,
> +            <varname>TRACE</varname>, <varname>EVERYTHING</varname>. Default
> +            level is <varname>NOTICE</varname> in non-debugging builds. Use
> +            once to drop to <varname>WARNING</varname> level, twice for
> +            <varname>ERROR</varname> level, four times for no logging at
> +            all.</para>
> +          </listitem>
> +        </varlistentry>
> +
> +        <varlistentry>
> +          <term>-v</term>
> +
> +          <listitem>
> +            <para>Run more verbosely. Increase verbosity level by one. Use
> +            once to raise to <varname>INFO</varname> level, twice for
> +            <varname>TRACE</varname> level, three times for
> +            <varname>EVERYTHING</varname> (currently the same as
> +            <varname>TRACE</varname>).</para>
> +          </listitem>
> +        </varlistentry>
> +
> +        <varlistentry>
> +          <term><option>-V</option></term>
> +
> +          <listitem>
> +            <para>Run at maximum verbosity (<varname>EVERYTHING</varname>
> +            level).</para>
> +          </listitem>
> +        </varlistentry>
> +
> +        <varlistentry>
> +          <term><option>-t</option> tag</term>
> +
> +          <listitem>
> +            <para>Tag each console message with specified marker. Mainly
> +            useful in testing when running multiple daemons on the same
> +            console.</para>
> +          </listitem>
> +        </varlistentry>
> +
> +        <varlistentry>
> +          <term><option>-T</option></term>
> +
> +          <listitem>
> +            <para>Timestamp each line of console output.</para>
> +          </listitem>
> +        </varlistentry>
> +      </variablelist>
> +    </refsection>
> +  </refsection>
> +
> +  <refsection>
> +    <title>Files</title>
> +
> +    <para><filename>/etc/box/bbackupd.conf</filename></para>
> +  </refsection>
> +
> +  <refsection>
> +    <title>See Also</title>
> +
> +    <para><citerefentry>
> +        <refentrytitle>bbackupd.conf</refentrytitle>
> +
> +        <manvolnum>5</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>bbackupd-config</refentrytitle>
> +
> +        <manvolnum>8</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>bbackupctl</refentrytitle>
> +
> +        <manvolnum>8</manvolnum>
> +      </citerefentry></para>
> +  </refsection>
> +
> +  <refsection>
> +    <title>Author</title>
> +
> +    <para><author>
> +        <personname>Ben Summers</personname>
> +      </author></para>
> +
> +    <para><author>
> +        <personname>Per Thomsen</personname>
> +      </author></para>
> +
> +    <para><author>
> +        <personname>James O'Gorman</personname>
> +      </author></para>
> +  </refsection>
> +</refentry>
> 
> Modified: box/trunk/documentation/bbackupquery.xml
> ===================================================================
> --- box/trunk/documentation/bbackupquery.xml	2008-09-30 23:27:06 UTC (rev 2304)
> +++ box/trunk/documentation/bbackupquery.xml	2008-09-30 23:28:57 UTC (rev 2305)
> @@ -1,27 +1,41 @@
>  <?xml version="1.0" encoding="UTF-8"?>
> -<refentry>
> +<refentry version="5.0" xmlns="http://docbook.org/ns/docbook"
> +          xmlns:xlink="http://www.w3.org/1999/xlink"
> +          xmlns:xi="http://www.w3.org/2001/XInclude"
> +          xmlns:svg="http://www.w3.org/2000/svg"
> +          xmlns:m="http://www.w3.org/1998/Math/MathML"
> +          xmlns:html="http://www.w3.org/1999/xhtml"
> +          xmlns:db="http://docbook.org/ns/docbook">
>    <refmeta>
>      <refentrytitle>bbackupquery</refentrytitle>
>  
>      <manvolnum>8</manvolnum>
> +
> +    <refmiscinfo class="manual">Box Backup 0.11</refmiscinfo>
>    </refmeta>
>  
>    <refnamediv>
>      <refname>bbackupquery</refname>
>  
> -    <refpurpose>Box Backup store query and retrieval</refpurpose>
> +    <refpurpose>Box Backup store query and file retrieval</refpurpose>
>    </refnamediv>
>  
>    <refsynopsisdiv>
>      <cmdsynopsis>
> -      <command>bbackupquery [-q] [-c configfile] [commands ...]</command>
> +      <command>bbackupquery</command>
> +
> +      <arg>-q</arg>
> +
> +      <arg>-c configfile</arg>
> +
> +      <arg>command ...</arg>
>      </cmdsynopsis>
>    </refsynopsisdiv>
>  
>    <refsection>
>      <title>Description</title>
>  
> -    <para><literal>bbackupquery</literal> is the main way of interacting with
> +    <para><command>bbackupquery</command> is the main way of interacting with
>      the backup store from a Box Backup client machine. It supports both
>      interactive and batch modes of operation.</para>
>  
> @@ -29,152 +43,233 @@
>      store, getting status from the store server. The main use is to retrieve
>      files and directories when needed.</para>
>  
> -    <para><literal>bbackupquery</literal> supports interactive and batch modes
> +    <para><command>bbackupquery</command> supports interactive and batch modes
>      of operation. Interactive mode allows for interaction with the server much
>      like an interactive FTP client.</para>
>  
>      <para>Batch mode is invoked by putting commands into the invocation of
> -    bbackupquery. Example:</para>
> +    <command>bbackupquery</command>. Example:</para>
>  
> -    <programlisting>bbackupquery "list home-dirs" quit</programlisting>
> +    <para><programlisting>bbackupquery "list home-dirs" quit</programlisting></para>
>  
>      <para>Note that commands that contain spaces are enclosed in double
> -    quotes. If the <literal>quit</literal> command is omitted, after the
> -    preceding commands are completed, <literal>bbackupquery</literal> will
> +    quotes. If the <command>quit</command> command is omitted, after the
> +    preceding commands are completed, <command>bbackupquery</command> will
>      enter interactive mode.</para>
> +  </refsection>
>  
> -    <para><emphasis role="bold">Options</emphasis></para>
> +  <refsection>
> +    <title>Options</title>
>  
> -    <para><emphasis>-q: Quiet. Suppresses status output while
> -    running.</emphasis></para>
> +    <para><variablelist>
> +        <varlistentry>
> +          <term><option>-q</option></term>
>  
> -    <para><emphasis>-c configfile: Use config file, instead of the default
> -    bbackupd.conf file. Can be a relative or full path.</emphasis></para>
> +          <listitem>
> +            <para>Quiet. Suppresses status output while running.</para>
> +          </listitem>
> +        </varlistentry>
>  
> -    <refsection>
> -      <title>Commands</title>
> +        <varlistentry>
> +          <term><option>-c</option> <option>configfile</option></term>
>  
> -      <para>The commands that can be used in <literal>bbackupquery</literal>
> -      are listed below.</para>
> +          <listitem>
> +            <para>Use configfile instead of the default bbackupd.conf file.
> +            Can be a relative or full path.</para>
> +          </listitem>
> +        </varlistentry>
> +      </variablelist></para>
> +  </refsection>
>  
> -      <itemizedlist>
> +  <refsection>
> +    <title>Commands</title>
> +
> +    <para>The commands that can be used in bbackupquery are listed
> +    below.</para>
> +
> +    <variablelist>
> +      <varlistentry>
> +        <term><command>help</command></term>
> +
>          <listitem>
> -          <para><literal>help</literal></para>
> -
>            <para>Displays the basic help message, which gives information about
> -          the commands available in bbackupquery. Use the form <literal>help
> -          command</literal>, to get help on a specific command.</para>
> +          the commands available in <command>bbackupquery</command>. Use the
> +          form <command>help command</command> to get help on a specific
> +          command.</para>
>          </listitem>
> +      </varlistentry>
>  
> +      <varlistentry>
> +        <term><command>quit</command></term>
> +
>          <listitem>
> -          <para><literal>quit</literal></para>
> -
>            <para>End the session with the store server, and quit
> -          <literal>bbackupquery</literal>.</para>
> +          bbackupquery.</para>
>          </listitem>
> +      </varlistentry>
>  
> +      <varlistentry>
> +        <term><command>cd</command> <optional>options</optional>
> +        <varname>directory-name</varname></term>
> +
>          <listitem>
> -          <para><literal>cd [options] <directory-name></literal></para>
> +          <para>Change directory. Options: <variablelist>
> +              <varlistentry>
> +                <term><option>-d</option></term>
>  
> -          <para>Change directory. Options:</para>
> +                <listitem>
> +                  <para>consider deleted directories for traversal</para>
> +                </listitem>
> +              </varlistentry>
>  
> -          <itemizedlist>
> -            <listitem>
> -              <para><literal>-d</literal> -- consider deleted directories for
> -              traversal</para>
> -            </listitem>
> +              <varlistentry>
> +                <term><option>-o</option></term>
>  
> -            <listitem>
> -              <para><literal>-o</literal> -- consider old versions of
> -              directories for traversal. This option should never be useful in
> -              a correctly formed store.</para>
> -            </listitem>
> -          </itemizedlist>
> +                <listitem>
> +                  <para>consider old versions of directories for traversal.
> +                  This option should never be useful in a correctly formed
> +                  store.</para>
> +                </listitem>
> +              </varlistentry>
> +            </variablelist></para>
>          </listitem>
> +      </varlistentry>
>  
> +      <varlistentry>
> +        <term><command>lcd</command>
> +        <varname>local-directory-name</varname></term>
> +
>          <listitem>
> -          <para><literal>lcd <local-directory-name></literal></para>
> -
>            <para>Change directory on the client machine. To list the contents
> -          of the local directory, type <literal>sh ls</literal> (on unix-like
> -          machines). TODO: Does <literal>sh dir</literal> work on
> -          Windows?</para>
> +          of the local directory, type <command>sh ls</command> (on Unix-like
> +          machines).</para>
>          </listitem>
> +      </varlistentry>
>  
> +      <varlistentry>
> +        <term><command>list</command> <optional>options</optional>
> +        <optional>directory-name</optional></term>
> +
>          <listitem>
> -          <para><literal>list [options] [directory-name]</literal></para>
> +          <para>The list (or its synonym <command>ls</command>) command lists
> +          the content of the current, or specified, directory. The options are
> +          as follows:</para>
>  
> -          <para>The <literal>list</literal> (or its synonym
> -          <literal>ls</literal>) command lists the content of the current, or
> -          specified, directory. The options are as follows:</para>
> +          <para><variablelist>
> +              <varlistentry>
> +                <term><option>-r</option></term>
>  
> -          <itemizedlist>
> -            <listitem>
> -              <para><literal>-r</literal> -- recursively list all files</para>
> -            </listitem>
> +                <listitem>
> +                  <para>recursively list all files</para>
> +                </listitem>
> +              </varlistentry>
>  
> -            <listitem>
> -              <para><literal>-d</literal> -- list deleted files and
> -              directories</para>
> -            </listitem>
> +              <varlistentry>
> +                <term><option>-d</option></term>
>  
> -            <listitem>
> -              <para><literal>-o</literal> -- list old versions of files and
> -              directories</para>
> -            </listitem>
> +                <listitem>
> +                  <para>list deleted files and directories</para>
> +                </listitem>
> +              </varlistentry>
>  
> -            <listitem>
> -              <para><literal>-I</literal> -- don't display object IDs</para>
> -            </listitem>
> +              <varlistentry>
> +                <term><option>-o</option></term>
>  
> -            <listitem>
> -              <para><literal>-F</literal> -- don't display flags</para>
> -            </listitem>
> +                <listitem>
> +                  <para>list old versions of files and directories</para>
> +                </listitem>
> +              </varlistentry>
>  
> -            <listitem>
> -              <para><literal>-t</literal> -- show file modification time (and
> -              attr mod time, if the object has attributes.</para>
> -            </listitem>
> +              <varlistentry>
> +                <term><option>-I</option></term>
>  
> -            <listitem>
> -              <para><literal>-s</literal> -- show file size in blocks used on
> -              server. Note that this is only a very approximate indication of
> -              local file size.</para>
> -            </listitem>
> -          </itemizedlist>
> +                <listitem>
> +                  <para>don't display object IDs</para>
> +                </listitem>
> +              </varlistentry>
> +
> +              <varlistentry>
> +                <term><option>-F</option></term>
> +
> +                <listitem>
> +                  <para>don't display flags</para>
> +                </listitem>
> +              </varlistentry>
> +
> +              <varlistentry>
> +                <term><option>-t</option></term>
> +
> +                <listitem>
> +                  <para>show file modification time (and attr mod time, if the
> +                  object has attributes).</para>
> +                </listitem>
> +              </varlistentry>
> +
> +              <varlistentry>
> +                <term><option>-s</option></term>
> +
> +                <listitem>
> +                  <para>show file size in blocks used on server. Note that
> +                  this is only a very approximate indication of local file
> +                  size.</para>
> +                </listitem>
> +              </varlistentry>
> +            </variablelist></para>
>          </listitem>
> +      </varlistentry>
>  
> +      <varlistentry>
> +        <term><command>ls</command> <optional>options</optional>
> +        <optional>directory-name</optional></term>
> +
>          <listitem>
> -          <para><literal>ls [options] [directory-name]</literal></para>
> -
> -          <para>Synonym for <literal>list</literal>.</para>
> +          <para>Synonym for <command>list</command>.</para>
>          </listitem>
> +      </varlistentry>
>  
> +      <varlistentry>
> +        <term><command>pwd</command></term>
> +
>          <listitem>
> -          <para><literal><literal>pwd</literal></literal></para>
> -
>            <para>Print current directory, always relative to the backup store
>            root.</para>
>          </listitem>
> +      </varlistentry>
>  
> +      <varlistentry>
> +        <term><command>sh</command> <varname>shell-command</varname></term>
> +
>          <listitem>
> -          <para><literal>sh <shell command></literal></para>
> -
>            <para>Everything after the sh is passed to a shell and run. All
>            output from the command is displayed in the client.</para>
>  
>            <para>Example: to list the contents of the current directory on the
> -          client machine type <literal>sh ls</literal>.</para>
> +          client machine type <command>sh ls</command>.</para>
>          </listitem>
> +      </varlistentry>
>  
> +      <varlistentry>
> +        <term><command>compare -a</command></term>
> +
>          <listitem>
> -          <para><literal>compare -a</literal></para>
> +          <para></para>
> +        </listitem>
> +      </varlistentry>
>  
> -          <para><literal>compare -l <location-name></literal></para>
> +      <varlistentry>
> +        <term><command>compare -l</command>
> +        <varname>location-name</varname></term>
>  
> -          <para><literal>compare <store-dir-name>
> -          <local-dir-name></literal></para>
> +        <listitem>
> +          <para></para>
> +        </listitem>
> +      </varlistentry>
>  
> +      <varlistentry>
> +        <term><command>compare</command> <varname>store-dir-name</varname>
> +        <varname>local-dir-name</varname></term>
> +
> +        <listitem>
>            <para>Compare the current data in the store with the data on the
>            disc. Please note that all the data will be downloaded from the
>            store, so this can be a very lengthy process depending on the size
> @@ -182,172 +277,180 @@
>  
>            <para>Options:</para>
>  
> -          <itemizedlist>
> -            <listitem>
> -              <para><literal>-a</literal> -- compare all locations. </para>
> -            </listitem>
> +          <para><variablelist>
> +              <varlistentry>
> +                <term><option>-a</option></term>
>  
> -            <listitem>
> -              <para><literal>-l</literal> -- compare one backup location as
> -              specified in the configuration file. This compares one of the
> -              top level store directories.</para>
> -            </listitem>
> +                <listitem>
> +                  <para>compare all locations.</para>
> +                </listitem>
> +              </varlistentry>
>  
> -            <listitem>
> -              <para><literal>-c</literal> -- set return code. The return code
> -              is set to the following values, if <literal>quit</literal> is
> -              the next command. So, if another command is run after the
> -              <literal>compare</literal>, the return code will not refer to
> -              the <literal>compare</literal>. This option is very useful for
> -              automating compares. Return code values:</para>
> +              <varlistentry>
> +                <term><option>-l</option></term>
>  
> -              <itemizedlist>
>                  <listitem>
> -                  <para>1 -- no differences were found</para>
> +                  <para>compare one backup location as specified in the
> +                  configuration file. This compares one of the top level store
> +                  directories.</para>
>                  </listitem>
> +              </varlistentry>
>  
> +              <varlistentry>
> +                <term><option>-c</option></term>
> +
>                  <listitem>
> -                  <para>2 -- differences were found</para>
> -                </listitem>
> +                  <para>set return code. The return code is set to the
> +                  following values, if quit is the next command. So, if
> +                  another command is run after the compare, the return code
> +                  will not refer to the compare. This option is very useful
> +                  for automating compares. Return code values:<itemizedlist>
> +                      <listitem>
> +                        <para><option>1</option> -- no differences were
> +                        found</para>
> +                      </listitem>
>  
> -                <listitem>
> -                  <para>3 -- an error occured</para>
> +                      <listitem>
> +                        <para><option>2</option> -- differences were
> +                        found</para>
> +                      </listitem>
> +
> +                      <listitem>
> +                        <para><option>3</option> -- an error occured</para>
> +                      </listitem>
> +                    </itemizedlist></para>
>                  </listitem>
> -              </itemizedlist>
> -            </listitem>
> -          </itemizedlist>
> +              </varlistentry>
> +            </variablelist></para>
>          </listitem>
> +      </varlistentry>
>  
> +      <varlistentry>
> +        <term><command>get</command> <varname>object-filename</varname>
> +        <optional>local-filename</optional></term>
> +
>          <listitem>
> -          <para><literal>get <object-filename>
> -          [<local-filename>]</literal></para>
> +          <para></para>
> +        </listitem>
> +      </varlistentry>
>  
> -          <para><literal>get -i <object-id>
> -          <local-filename></literal></para>
> +      <varlistentry>
> +        <term><command>get -i</command> <varname>object-id</varname>
> +        <varname>local-filename</varname></term>
>  
> +        <listitem>
>            <para>Gets a file from the store. Object is specified as the
>            filename within the current directory. Local filename is optional.
>            Ignores old and deleted files when searching the directory for the
>            file to retrieve.</para>
>  
> -          <para>To get an old or deleted file, use the <literal>-i</literal>
> +          <para>To get an old or deleted file, use the <option>-i</option>
>            option and select the object as a hex object ID (first column in
>            listing). The local filename must be specified.</para>
>          </listitem>
> +      </varlistentry>
>  
> +      <varlistentry>
> +        <term><command>getobject</command> <varname>object-id</varname>
> +        <varname>local-filename</varname></term>
> +
>          <listitem>
> -          <para><literal>getobject <object-id>
> -          <local-filename></literal></para>
> -
>            <para>Gets the object specified by the object id (in hex) and stores
> -          the raw contents in the local file specified. <emphasis
> -          role="bold">Note</emphasis>: This is only useful for debugging as it
> -          does not decode files from the stored format, which is encrypted and
> -          compressed.</para>
> +          the raw contents in the local file specified. Note: This is only
> +          useful for debugging as it does not decode files from the stored
> +          format, which is encrypted and compressed.</para>
>          </listitem>
> +      </varlistentry>
>  
> +      <varlistentry>
> +        <term><command>restore</command> <optional>-d</optional>
> +        <varname>directory-name</varname>
> +        <varname>local-directory-name</varname></term>
> +
>          <listitem>
> -          <para><literal>restore [-d] <directory-name>
> -          <local-directory-name></literal></para>
> +          <para></para>
> +        </listitem>
> +      </varlistentry>
>  
> -          <para><literal>restore -r</literal></para>
> +      <varlistentry>
> +        <term><command>restore -r</command></term>
>  
> +        <listitem>
>            <para>Restores a directory to the local disc. The local directory
>            specified must not exist (unless a previous restore is being
>            restarted). The root cannot be restored -- restore locations
> -          individually. </para>
> +          individually.</para>
>  
>            <para>Options:</para>
>  
> -          <itemizedlist>
> -            <listitem>
> -              <para><literal>-d</literal> -- restore a deleted
> -              directory</para>
> -            </listitem>
> +          <para><variablelist>
> +              <varlistentry>
> +                <term><option>-d</option></term>
>  
> -            <listitem>
> -              <para><literal>-r</literal> -- resume an interrupted
> -              restore</para>
> -            </listitem>
> -          </itemizedlist>
> +                <listitem>
> +                  <para>restore a deleted directory</para>
> +                </listitem>
> +              </varlistentry>
>  
> -          <para> If a restore operation is interrupted for any reason, it can
> -          be restarted using the <literal>-r</literal> switch. Restore
> -          progress information is saved in a file at regular intervals during
> -          the restore operation to allow restarts.</para>
> +              <varlistentry>
> +                <term><option>-r</option></term>
> +
> +                <listitem>
> +                  <para>resume an interrupted restore</para>
> +                </listitem>
> +              </varlistentry>
> +            </variablelist>If a restore operation is interrupted for any
> +          reason, it can be restarted using the <option>-r</option> switch.
> +          Restore progress information is saved in a file at regular intervals
> +          during the restore operation to allow restarts.</para>
>          </listitem>
> +      </varlistentry>
>  
> +      <varlistentry>
> +        <term><command>usage</command></term>
> +
>          <listitem>
> -          <para>usage</para>
> -
>            <para>Show space used on the server for this account. Display
> -          fields:</para>
> +          fields:<itemizedlist>
> +              <listitem>
> +                <para><property>Used</property>: Total amount of space used on
> +                the server</para>
> +              </listitem>
>  
> -          <itemizedlist>
> -            <listitem>
> -              <para><literal>Used</literal>: Total amount of space used on the
> -              server</para>
> -            </listitem>
> +              <listitem>
> +                <para><property>Old files</property>: Space used by old
> +                files</para>
> +              </listitem>
>  
> -            <listitem>
> -              <para><literal>Old files</literal>: Space used by old
> -              files</para>
> -            </listitem>
> +              <listitem>
> +                <para><property>Deleted files</property>: Space used by
> +                deleted files</para>
> +              </listitem>
>  
> -            <listitem>
> -              <para><literal>Deleted files</literal>: Space used by deleted
> -              files</para>
> -            </listitem>
> +              <listitem>
> +                <para><property>Directories</property>: Space used by the
> +                directory structure</para>
> +              </listitem>
> +            </itemizedlist></para>
>  
> -            <listitem>
> -              <para><literal>Directories</literal>: Space used by the
> -              directory structure</para>
> -            </listitem>
> -          </itemizedlist>
> -
> -          <para>When Used exceeds the soft limit, the server will start to
> -          remove old and deleted files until the usage drops below the soft
> -          limit. After a while, you should expect to see the usage stay at
> -          just below the soft limit. You only need more space if the space
> -          used by old and deleted files is near zero.</para>
> +          <para>When <property>Used</property> exceeds the soft limit, the
> +          server will start to remove old and deleted files until the usage
> +          drops below the soft limit. After a while, you should expect to see
> +          the usage stay at just below the soft limit. You only need more
> +          space if the space used by old and deleted files is near
> +          zero.</para>
>          </listitem>
> -      </itemizedlist>
> -    </refsection>
> +      </varlistentry>
> +    </variablelist>
>    </refsection>
>  
>    <refsection>
> -    <title>Author</title>
> -
> -    <para>Ben Summers and contributors. For help, please go to the <ulink
> -    url="http://www.boxbackup.org/trac/">Wiki</ulink>, or subscribe to the Box
> -    Backup <ulink
> -    url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing
> -    list.</ulink></para>
> -  </refsection>
> -
> -  <refsection>
> -    <title>See Also</title>
> -
> -    <para>bbackupd.conf(5)</para>
> -  </refsection>
> -
> -  <refsection>
> -    <title>Files</title>
> -
> -    <para><literal>bbackupquery</literal> uses the Box Backup client
> -    configuration file, usually located in
> -    <filename>/etc/box/bbackupd.conf</filename>. On Windows this file is
> -    usually located in the installation directory, and is named
> -    <filename>bbackupd.conf</filename> as well.</para>
> -  </refsection>
> -
> -  <refsection>
>      <title>Bugs</title>
>  
> -    <para>If you find a bug in Box Backup, and you want to let us know about
> -    it, join the <ulink
> -    url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing
> -    list</ulink>, and send a description of the problem there.</para>
> +    <para>If you find a bug in Box Backup and you want to let us know about
> +    it, join the <link
> +    xlink:href="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing
> +    list</link> and send us a description of the problem there.</para>
>  
>      <para>To report a bug, give us at least the following information:</para>
>  
> @@ -377,4 +480,20 @@
>        </listitem>
>      </itemizedlist>
>    </refsection>
> +
> +  <refsection>
> +    <title>Authors</title>
> +
> +    <para><author>
> +        <personname>Ben Summers</personname>
> +      </author></para>
> +
> +    <para><author>
> +        <personname>Per Thomsen</personname>
> +      </author></para>
> +
> +    <para><author>
> +        <personname>James O'Gorman</personname>
> +      </author></para>
> +  </refsection>
>  </refentry>
> 
> Modified: box/trunk/documentation/bbstoreaccounts.xml
> ===================================================================
> --- box/trunk/documentation/bbstoreaccounts.xml	2008-09-30 23:27:06 UTC (rev 2304)
> +++ box/trunk/documentation/bbstoreaccounts.xml	2008-09-30 23:28:57 UTC (rev 2305)
> @@ -1,44 +1,64 @@
>  <?xml version="1.0" encoding="UTF-8"?>
> -<refentry>
> +<refentry version="5.0" xmlns="http://docbook.org/ns/docbook"
> +          xmlns:xlink="http://www.w3.org/1999/xlink"
> +          xmlns:xi="http://www.w3.org/2001/XInclude"
> +          xmlns:svg="http://www.w3.org/2000/svg"
> +          xmlns:m="http://www.w3.org/1998/Math/MathML"
> +          xmlns:html="http://www.w3.org/1999/xhtml"
> +          xmlns:db="http://docbook.org/ns/docbook">
>    <refmeta>
>      <refentrytitle>bbstoreaccounts</refentrytitle>
>  
>      <manvolnum>8</manvolnum>
> +
> +    <refmiscinfo>Box Backup 0.11</refmiscinfo>
>    </refmeta>
>  
>    <refnamediv>
>      <refname>bbstoreaccounts</refname>
>  
> -    <refpurpose>View and change account information on the store
> -    server</refpurpose>
> +    <refpurpose>Box Backup store accounts manager</refpurpose>
>    </refnamediv>
>  
>    <refsynopsisdiv>
>      <cmdsynopsis>
> -      <command>bbstoreaccounts [-c configfile] command account_id
> -      [command-specific arguments]</command>
> +      <command>bbstoreaccounts</command>
> +
> +      <arg>-c config-file</arg>
> +
> +      <arg choice="plain">command</arg>
> +
> +      <arg choice="plain">account-id</arg>
> +
> +      <arg>command-specific arguments</arg>
>      </cmdsynopsis>
>    </refsynopsisdiv>
>  
>    <refsection>
>      <title>Description</title>
>  
> -    <para><literal>bbstoreaccounts</literal> is the tool for managing accounts
> +    <para><command>bbstoreaccounts</command> is the tool for managing accounts
>      on the store server. It can be used to view information related to
>      accounts, as well as create, change and delete accounts on the store
> -    server. </para>
> +    server.</para>
>  
> -    <para><literal>bbstoreaccounts</literal> always takes at least 2
> +    <para><command>bbstoreaccounts</command> always takes at least 2
>      parameters: the command name and the account ID. Some commands require
>      additional parameters, and some commands have optional parameters.</para>
>  
>      <refsection>
>        <title>Options</title>
>  
> -      <para><literal>-c <configfile></literal></para>
> +      <para><variablelist>
> +          <varlistentry>
> +            <term><option>-c config-file</option></term>
>  
> -      <para>The configfile to use for connecting to the store. Default is
> -      <literal>/etc/box/bbstored.conf</literal>.</para>
> +            <listitem>
> +              <para>The configfile to use for connecting to the store. Default
> +              is <filename>/etc/box/bbstored.conf</filename>.</para>
> +            </listitem>
> +          </varlistentry>
> +        </variablelist></para>
>      </refsection>
>  
>      <refsection>
> @@ -46,73 +66,102 @@
>  
>        <para>The commands tells bbstoreaccounts what action to perform.</para>
>  
> -      <itemizedlist>
> -        <listitem>
> -          <para><literal>check <account-id> [fix]</literal></para>
> +      <para><variablelist>
> +          <varlistentry>
> +            <term><command>check</command> <varname>account-id</varname>
> +            <optional>fix</optional></term>
>  
> -          <para>The <literal>check</literal> command verifies the integrity of
> -          the store account given, and optionally fixes any corruptions.
> -          <emphasis role="bold">Note</emphasis>: It is recommended to run the
> -          'simple' check command (without <literal>fix</literal>) before using
> -          the <literal>fix</literal> option, This gives an overview of the
> -          extent of any problems, before attempting to fix them.</para>
> -        </listitem>
> -
> -        <listitem>
> -          <para><literal>create <account-id> <discset>
> -          <softlimit> <hardlimit></literal></para>
> -
> -          <para>Creates a new store account with the parameters given. The
> -          parameters are as follows:</para>
> -
> -          <itemizedlist>
>              <listitem>
> -              <para><literal>account-id</literal>: the ID of the new account
> -              to be created. A 32-bit hexadecimal number. Cannot already exist
> -              on the server.</para>
> +              <para>The <command>check</command> command verifies the
> +              integrity of the store account given, and optionally fixes any
> +              corruptions. <emphasis role="bold">Note</emphasis>: It is
> +              recommended to run the 'simple' check command (without
> +              <command>fix</command>) before using the <command>fix</command>
> +              option. This gives an overview of the extent of any problems,
> +              before attempting to fix them.</para>
>              </listitem>
> +          </varlistentry>
>  
> -            <listitem>
> -              <para><literal>discset</literal>: the disc set from
> -              raidfile.conf(5) where the backups for this client will be
> -              stored.. A number. Each RAID-file set has a number in
> -              raidfile.conf. This number is what's used.</para>
> -            </listitem>
> +          <varlistentry>
> +            <term><command>create</command> <varname>account-id</varname>
> +            <varname>disc-set</varname> <varname>soft-limit</varname>
> +            <varname>hard-limit</varname></term>
>  
>              <listitem>
> -              <para><literal>softlimit</literal>: The soft limit is the amount
> -              of storage that the server will guarantee to be available for
> -              storage.</para>
> -            </listitem>
> +              <para>Creates a new store account with the parameters given. The
> +              parameters are as follows:</para>
>  
> -            <listitem>
> -              <para><literal>hardlimit</literal>: The amount of storage that
> -              the the server will allow, before rejecting uploads, and
> -              starting to eliminate old and deleted files to get back down to
> -              <literal>softlimit</literal>. </para>
> +              <para><variablelist>
> +                  <varlistentry>
> +                    <term><option>account-id</option></term>
> +
> +                    <listitem>
> +                      <para>The ID of the new account to be created. A 32-bit
> +                      hexadecimal number. Cannot already exist on the
> +                      server.</para>
> +                    </listitem>
> +                  </varlistentry>
> +
> +                  <varlistentry>
> +                    <term><option>disc-set</option></term>
> +
> +                    <listitem>
> +                      <para>The disc set from <citerefentry>
> +                          <refentrytitle>raidfile.conf</refentrytitle>
> +
> +                          <manvolnum>5</manvolnum>
> +                        </citerefentry> where the backups for this client will
> +                      be stored. A number. Each RAID-file set has a number in
> +                      raidfile.conf. This number is what's used.</para>
> +                    </listitem>
> +                  </varlistentry>
> +
> +                  <varlistentry>
> +                    <term><option>soft-limit</option></term>
> +
> +                    <listitem>
> +                      <para>The soft limit is the amount of storage that the
> +                      server will guarantee to be available for
> +                      storage.</para>
> +                    </listitem>
> +                  </varlistentry>
> +
> +                  <varlistentry>
> +                    <term><option>hard-limit</option></term>
> +
> +                    <listitem>
> +                      <para>The amount of storage that the the server will
> +                      allow, before rejecting uploads, and starting to
> +                      eliminate old and deleted files to get back down to
> +                      soft-limit.</para>
> +                    </listitem>
> +                  </varlistentry>
> +                </variablelist></para>
>              </listitem>
> -          </itemizedlist>
> -        </listitem>
> +          </varlistentry>
>  
> -        <listitem>
> -          <para><literal>delete <account-id> [yes]</literal></para>
> +          <varlistentry>
> +            <term><command>delete</command> <varname>account-id</varname>
> +            <optional>yes</optional></term>
>  
> -          <para>Deletes the account from the store server completely. Removes
> -          all backups and deletes all references to the account in the config
> -          files.</para>
> +            <listitem>
> +              <para>Deletes the account from the store server completely.
> +              Removes all backups and deletes all references to the account in
> +              the config files.</para>
>  
> -          <para><literal>delete</literal> will ask for confirmation from the
> -          user, when called. Using the <literal>yes</literal> flag, eliminates
> -          that need. This is useful when deleting accounts from within a
> -          script or some other automated means.</para>
> -        </listitem>
> +              <para><command>delete</command> will ask for confirmation from
> +              the user, when called. Using the <option>yes</option> flag,
> +              eliminates that need. This is useful when deleting accounts from
> +              within a script or some other automated means. 0</para>
> +            </listitem>
> +          </varlistentry>
>  
> -        <listitem>
> -          <para><literal>info <account-id></literal></para>
> +          <varlistentry>
> +            <term><command>info</command> <varname>account-id</varname></term>
>  
> -          <para>Display information about the given account. Example:</para>
> -
> -          <programlisting>[root]# bbstoreaccounts info 1
> +            <listitem>
> +              <para>Display information about the given account.
> +              Example:<programlisting>[root]# bbstoreaccounts info 1
>                    Account ID: 00000001
>                Last object ID: 58757
>                   Blocks used: 9864063 (38531.50Mb)
> @@ -121,170 +170,213 @@
>    Blocks used by directories: 6679 (26.09Mb)
>              Block soft limit: 11796480 (46080.00Mb)
>              Block hard limit: 13107200 (51200.00Mb)
> -         Client store marker: 1139559852000000 </programlisting>
> +         Client store marker: 1139559852000000</programlisting></para>
>  
> -          <para>Explanation:</para>
> +              <para>Explanation:</para>
>  
> -          <itemizedlist>
> -            <listitem>
> -              <para>Account ID: The account ID being displayed.</para>
> -            </listitem>
> +              <para><variablelist>
> +                  <varlistentry>
> +                    <term>Account ID</term>
>  
> -            <listitem>
> -              <para>Last Object ID: A counter that keeps track of the objects
> -              that have been backed up. This number refers to the last file
> -              that was written to the store. The ID is displayed as a decimal
> -              number, and the object ID can be converted to a path name to a
> -              file as follows: convert the number to hex (e.g.: 58757 =>
> -              0xE585); The last backed up file will be (relative from the
> -              client's store root): <literal>e5/o85.rfw</literal>. Longer
> -              numbers infer more directories in the structure, so as an
> -              example 3952697264 as the last object ID gives 0xEB995FB0, which
> -              translates to a backup pathname of
> -              <literal>eb/99/5f/ob0.rfw.</literal></para>
> -            </listitem>
> +                    <listitem>
> +                      <para>The account ID being displayed.</para>
> +                    </listitem>
> +                  </varlistentry>
>  
> -            <listitem>
> -              <para>Blocks used: The number of blocks used by the store. The
> -              size in Mb depends on the number of blocks, as well as the block
> -              size for the disc set given in
> -              <literal>raidfile.conf(5)</literal>. In this case the block size
> -              is 4096.</para>
> -            </listitem>
> +                  <varlistentry>
> +                    <term>Last Object ID</term>
>  
> -            <listitem>
> -              <para>Blocks used by old files: The number of blocks occupied by
> -              files that have newer versions in the store. This data is at
> -              risk for being removed during housekeeping.</para>
> -            </listitem>
> +                    <listitem>
> +                      <para>A counter that keeps track of the objects that
> +                      have been backed up. This number refers to the last file
> +                      that was written to the store. The ID is displayed as a
> +                      decimal number, and the object ID can be converted to a
> +                      path name to a file as follows: convert the number to
> +                      hex (e.g.: 58757 => 0xE585); The last backed up file
> +                      will be (relative from the client's store root):
> +                      <filename>e5/o85.rfw</filename>. Longer numbers infer
> +                      more directories in the structure, so as an example
> +                      3952697264 as the last object ID gives 0xEB995FB0, which
> +                      translates to a backup pathname of
> +                      <filename>eb/99/5f/ob0.rfw</filename>.</para>
> +                    </listitem>
> +                  </varlistentry>
>  
> -            <listitem>
> -              <para>Blocks used by deleted files: The number of blocks used by
> -              files that have been deleted on the client. This data is at
> -              risk for being removed during housekeeping.</para>
> -            </listitem>
> +                  <varlistentry>
> +                    <term>Blocks used</term>
>  
> -            <listitem>
> -              <para>Blocks used by directories: The number of blocks used by
> -              directories in the store.</para>
> -            </listitem>
> +                    <listitem>
> +                      <para>The number of blocks used by the store. The size
> +                      in Mb depends on the number of blocks, as well as the
> +                      block size for the disc set given in <citerefentry>
> +                          <refentrytitle>raidfile.conf</refentrytitle>
>  
> -            <listitem>
> -              <para>Block soft limit: The soft limit in blocks. The soft limit
> -              is the maximum guaranteed storage space available to the
> -              account. When housekeeping starts, and the old and deleted files
> -              are removed, they are removed in chronological order (oldest
> -              first), until the data used is less than the soft limit.</para>
> -            </listitem>
> +                          <manvolnum>5</manvolnum>
> +                        </citerefentry>. In this case the block size is
> +                      4096.</para>
> +                    </listitem>
> +                  </varlistentry>
>  
> -            <listitem>
> -              <para>Block hard limit: The hard limit in blocks. The hard limit
> -              is the most amount of storage the server will allow in an
> -              account. Any data above this amount will be rejected.
> -              Housekeeping will reduce the storage use, so more data can be
> -              uploaded.</para>
> -            </listitem>
> +                  <varlistentry>
> +                    <term>Blocks used by old files</term>
>  
> -            <listitem>
> -              <para>Client store marker: TODO What exactly is this? </para>
> -            </listitem>
> -          </itemizedlist>
> -        </listitem>
> +                    <listitem>
> +                      <para>The number of blocks occupied by files that have
> +                      newer versions in the store. This data is at risk for
> +                      being removed during housekeeping.</para>
> +                    </listitem>
> +                  </varlistentry>
>  
> -        <listitem>
> -          <para><literal>setlimit <account-id> <softlimit>
> -          <hardlimit></literal></para>
> +                  <varlistentry>
> +                    <term>Blocks used by deleted files</term>
>  
> -          <para>Changes the storage space allocation for the given account. No
> -          server restart is needed.</para>
> +                    <listitem>
> +                      <para>The number of blocks used by files that have been
> +                      deleted on the client. This data is at risk for being
> +                      removed during housekeeping.</para>
> +                    </listitem>
> +                  </varlistentry>
>  
> -          <para>Parameters:</para>
> +                  <varlistentry>
> +                    <term>Blocks used by directories</term>
>  
> -          <itemizedlist>
> -            <listitem>
> -              <para><literal>account-id</literal>: the ID of the new account
> -              to be created. A 32-bit hexadecimal number. Cannot already exist
> -              on the server.</para>
> +                    <listitem>
> +                      <para>The number of blocks used by directories in the
> +                      store.</para>
> +                    </listitem>
> +                  </varlistentry>
> +
> +                  <varlistentry>
> +                    <term>Block soft limit</term>
> +
> +                    <listitem>
> +                      <para>The soft limit in blocks. The soft limit is the
> +                      maximum guaranteed storage space available to the
> +                      account. When housekeeping starts, and the old and
> +                      deleted files are removed, they are removed in
> +                      chronological order (oldest first), until the data used
> +                      is less than the soft limit.</para>
> +                    </listitem>
> +                  </varlistentry>
> +
> +                  <varlistentry>
> +                    <term>Block hard limit</term>
> +
> +                    <listitem>
> +                      <para>The hard limit in blocks. The hard limit is the
> +                      most amount of storage the server will allow in an
> +                      account. Any data above this amount will be rejected.
> +                      Housekeeping will reduce the storage use, so more data
> +                      can be uploaded.</para>
> +                    </listitem>
> +                  </varlistentry>
> +
> +                  <varlistentry>
> +                    <term>Client store marker</term>
> +
> +                    <listitem>
> +                      <para><citerefentry>
> +                          <refentrytitle>bbstored</refentrytitle>
> +
> +                          <manvolnum>8</manvolnum>
> +                        </citerefentry> uses this number to determine if it
> +                      needs to rescan the entire store. If this number is
> +                      different from the last time it checked, a rescan will
> +                      take place.</para>
> +                    </listitem>
> +                  </varlistentry>
> +                </variablelist></para>
>              </listitem>
> +          </varlistentry>
>  
> +          <varlistentry>
> +            <term><command>setlimit</command> <varname>account-id</varname>
> +            <varname>soft-limit</varname> <varname>hard-limit</varname></term>
> +
>              <listitem>
> -              <para><literal>softlimit</literal>: The soft limit is the amount
> -              of storage that the server will guarantee to be available for
> -              storage.</para>
> -            </listitem>
> +              <para>Changes the storage space allocation for the given
> +              account. No server restart is needed.</para>
>  
> -            <listitem>
> -              <para><literal>hardlimit</literal>: The amount of storage that
> -              the the server will allow, before rejecting uploads, and
> -              starting to eliminate old and deleted files to get back down to
> -              <literal>softlimit</literal>.</para>
> +              <para>Parameters:</para>
> +
> +              <para><variablelist>
> +                  <varlistentry>
> +                    <term><option>account-id</option></term>
> +
> +                    <listitem>
> +                      <para>The ID of the account to be modified.</para>
> +                    </listitem>
> +                  </varlistentry>
> +
> +                  <varlistentry>
> +                    <term><option>soft-limit</option></term>
> +
> +                    <listitem>
> +                      <para>The soft limit is the amount of storage that the
> +                      server will guarantee to be available for
> +                      storage.</para>
> +                    </listitem>
> +                  </varlistentry>
> +
> +                  <varlistentry>
> +                    <term><option>hard-limit</option></term>
> +
> +                    <listitem>
> +                      <para>The amount of storage that the the server will
> +                      allow before rejecting uploads and starting to eliminate
> +                      old and deleted files to get back down to
> +                      <option>soft-limit</option>.</para>
> +                    </listitem>
> +                  </varlistentry>
> +                </variablelist></para>
>              </listitem>
> -          </itemizedlist>
> -        </listitem>
> -      </itemizedlist>
> +          </varlistentry>
> +        </variablelist></para>
>      </refsection>
>    </refsection>
>  
>    <refsection>
> -    <title>Author</title>
> +    <title>Examples</title>
>  
> -    <para>Ben Summers and contributors. For help, please go to the <ulink
> -    url="http://www.boxbackup.org/trac/">Wiki</ulink>, or subscribe to the Box
> -    Backup <ulink
> -    url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing
> -    list.</ulink></para>
> +    <para>Create an account with ID 3af on disc set 0, with a 20GB soft-limit
> +    and a 22GB hard-limit:<programlisting>bbstoreaccounts create 3af 0 20G 22G</programlisting>Alter
> +    existing account ID 20 to have a 50GB soft-limit and a 55GB
> +    hard-limit:<programlisting>bbstoreaccounts setlimit 20 50G 55G</programlisting></para>
>    </refsection>
>  
>    <refsection>
> -    <title>See Also</title>
> -
> -    <para><literal>bbstored.conf(5)</literal></para>
> -
> -    <para><literal>raidfile.conf(5)</literal></para>
> -  </refsection>
> -
> -  <refsection>
>      <title>Files</title>
>  
> -    <para><literal>bbstoreaccounts</literal> uses the Box Backup server
> -    configuration file, usually located in
> -    <filename>/etc/box/bbstored.conf</filename>. </para>
> +    <para><filename>/etc/box/bbstored/accounts.txt</filename></para>
>    </refsection>
>  
>    <refsection>
> -    <title>Bugs</title>
> +    <title>See Also</title>
>  
> -    <para>If you find a bug in Box Backup, and you want to let us know about
> -    it, join the <ulink
> -    url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing
> -    list</ulink>, and send a description of the problem there.</para>
> +    <para><citerefentry>
> +        <refentrytitle>bbstored</refentrytitle>
>  
> -    <para>To report a bug, give us at least the following information:</para>
> +        <manvolnum>8</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>bbstored-config</refentrytitle>
>  
> -    <itemizedlist>
> -      <listitem>
> -        <para>The version of Box Backup you are running</para>
> -      </listitem>
> +        <manvolnum>8</manvolnum>
> +      </citerefentry></para>
> +  </refsection>
>  
> -      <listitem>
> -        <para>The platform you are running on (hardware and OS), for both
> -        client and server.</para>
> -      </listitem>
> +  <refsection>
> +    <title>Authors</title>
>  
> -      <listitem>
> -        <para>If possible attach your config files (bbstored.conf,
> -        bbackupd.conf) to the bug report.</para>
> -      </listitem>
> +    <para><author>
> +        <personname>Ben Summers</personname>
> +      </author></para>
>  
> -      <listitem>
> -        <para>Also attach any log file output that helps shed light on the
> -        problem you are seeing.</para>
> -      </listitem>
> +    <para><author>
> +        <personname>Per Thomsen</personname>
> +      </author></para>
>  
> -      <listitem>
> -        <para>And last but certainly not least, a description of what you are
> -        seeing, in as much detail as possible.</para>
> -      </listitem>
> -    </itemizedlist>
> +    <para><author>
> +        <personname>James O'Gorman</personname>
> +      </author></para>
>    </refsection>
>  </refentry>
> 
> Modified: box/trunk/documentation/bbstored-certs.xml
> ===================================================================
> --- box/trunk/documentation/bbstored-certs.xml	2008-09-30 23:27:06 UTC (rev 2304)
> +++ box/trunk/documentation/bbstored-certs.xml	2008-09-30 23:28:57 UTC (rev 2305)
> @@ -1,9 +1,17 @@
>  <?xml version="1.0" encoding="UTF-8"?>
> -<refentry>
> +<refentry version="5.0" xmlns="http://docbook.org/ns/docbook"
> +          xmlns:xlink="http://www.w3.org/1999/xlink"
> +          xmlns:xi="http://www.w3.org/2001/XInclude"
> +          xmlns:svg="http://www.w3.org/2000/svg"
> +          xmlns:m="http://www.w3.org/1998/Math/MathML"
> +          xmlns:html="http://www.w3.org/1999/xhtml"
> +          xmlns:db="http://docbook.org/ns/docbook">
>    <refmeta>
>      <refentrytitle>bbstored-certs</refentrytitle>
>  
>      <manvolnum>8</manvolnum>
> +
> +    <refmiscinfo>Box Backup 0.11</refmiscinfo>
>    </refmeta>
>  
>    <refnamediv>
> @@ -14,19 +22,24 @@
>  
>    <refsynopsisdiv>
>      <cmdsynopsis>
> -      <command>bbstored-certs <certs-dir> <command>
> -      [<arguments>]</command>
> +      <command>bbstored-certs</command>
> +
> +      <arg choice="plain">certs-dir</arg>
> +
> +      <arg choice="plain">command</arg>
> +
> +      <arg>arguments</arg>
>      </cmdsynopsis>
>    </refsynopsisdiv>
>  
>    <refsection>
>      <title>Description</title>
>  
> -    <para><literal>bbstored-certs</literal> creates and signs certificates for
> +    <para><command>bbstored-certs</command> creates and signs certificates for
>      use in Box Backup. It allows the user to create and sign the server keys,
>      as well as signing client keys.</para>
>  
> -    <para>All commands must be followed by the <literal>certs-dir</literal>,
> +    <para>All commands must be followed by the <varname>certs-dir</varname>,
>      which is the directory in which the certificates are stored.</para>
>  
>      <refsection>
> @@ -34,56 +47,60 @@
>  
>        <para>There are 3 commands:</para>
>  
> -      <itemizedlist>
> -        <listitem>
> -          <para><literal>init</literal>: Create the
> -          <literal>certs-dir</literal>, and generate the server keys for
> -          bbstored. <literal>certs-dir</literal> cannot exist before running
> -          the command.</para>
> -        </listitem>
> +      <variablelist>
> +        <varlistentry>
> +          <term><command>init</command></term>
>  
> -        <listitem>
> -          <para><literal>sign-server <servercsrfile></literal>: Sign the
> -          server certificate. The <literal>servercsrfile</literal> is the file
> -          generated by the <literal>init</literal> command.</para>
> -        </listitem>
> +          <listitem>
> +            <para>Create the <varname>certs-dir</varname>, and generate the
> +            server keys for bbstored. <varname>certs-dir</varname> cannot
> +            exist before running the command.</para>
> +          </listitem>
> +        </varlistentry>
>  
> -        <listitem>
> -          <para><literal>sign <clientcsrfile></literal>: Sign a client
> -          certificate. The <literal>clientcsrfile</literal> is generated
> -          during client setup. See <literal>bbackupd-config(8)</literal>. Send
> -          the signed certificate back to the client, and install according to
> -          the instructions given by <literal>bbackupd-config</literal>.</para>
> -        </listitem>
> -      </itemizedlist>
> -    </refsection>
> -  </refsection>
> +        <varlistentry>
> +          <term><command>sign-server</command>
> +          <varname>servercsrfile</varname></term>
>  
> -  <refsection>
> -    <title>Author</title>
> +          <listitem>
> +            <para>Sign the server certificate. The
> +            <varname>servercsrfile</varname> is the file generated by the
> +            <command>init</command> command.</para>
> +          </listitem>
> +        </varlistentry>
>  
> -    <para>Ben Summers and contributors. For help, please go to the <ulink
> -    url="http://www.boxbackup.org/trac/">Wiki</ulink>, or subscribe to the Box
> -    Backup <ulink
> -    url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing
> -    list.</ulink></para>
> -  </refsection>
> +        <varlistentry>
> +          <term><command>sign</command>
> +          <varname>clientcsrfile</varname></term>
>  
> -  <refsection>
> -    <title>See Also</title>
> +          <listitem>
> +            <para>Sign a client certificate. The
> +            <varname>clientcsrfile</varname> is generated during client setup.
> +            See <citerefentry>
> +                <refentrytitle>bbackupd-config</refentrytitle>
>  
> -    <para><literal>bbstored-config(8)</literal></para>
> -
> -    <para><literal>bbstored.conf(5)</literal></para>
> -
> -    <para><literal>bbstoreaccounts(8)</literal></para>
> +                <manvolnum>8</manvolnum>
> +              </citerefentry>. Send the signed certificate back to the client,
> +            and install according to the instructions given by
> +            <command>bbackupd-config</command>.</para>
> +          </listitem>
> +        </varlistentry>
> +      </variablelist>
> +    </refsection>
>    </refsection>
>  
>    <refsection>
>      <title>Files</title>
>  
> -    <para><literal>raidfile-config</literal> generates the raidfile.conf(5)
> -    file.</para>
> +    <para><citerefentry>
> +        <refentrytitle>raidfile-config</refentrytitle>
> +
> +        <manvolnum>8</manvolnum>
> +      </citerefentry> generates the <citerefentry>
> +        <refentrytitle>raidfile.conf</refentrytitle>
> +
> +        <manvolnum>5</manvolnum>
> +      </citerefentry> file.</para>
>    </refsection>
>  
>    <refsection>
> @@ -122,4 +139,38 @@
>        </listitem>
>      </itemizedlist>
>    </refsection>
> +
> +  <refsection>
> +    <title>See Also</title>
> +
> +    <para><citerefentry>
> +        <refentrytitle>bbstored-config</refentrytitle>
> +
> +        <manvolnum>8</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>bbstored.conf</refentrytitle>
> +
> +        <manvolnum>5</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>bbstoreaccounts</refentrytitle>
> +
> +        <manvolnum>8</manvolnum>
> +      </citerefentry></para>
> +  </refsection>
> +
> +  <refsection>
> +    <title>Authors</title>
> +
> +    <para><author>
> +        <personname>Ben Summers</personname>
> +      </author></para>
> +
> +    <para><author>
> +        <personname>Per Thomsen</personname>
> +      </author></para>
> +
> +    <para><author>
> +        <personname>James O'Gorman</personname>
> +      </author></para>
> +  </refsection>
>  </refentry>
> 
> Modified: box/trunk/documentation/bbstored-config.xml
> ===================================================================
> --- box/trunk/documentation/bbstored-config.xml	2008-09-30 23:27:06 UTC (rev 2304)
> +++ box/trunk/documentation/bbstored-config.xml	2008-09-30 23:28:57 UTC (rev 2305)
> @@ -1,68 +1,93 @@
>  <?xml version="1.0" encoding="UTF-8"?>
> -<refentry>
> +<refentry version="5.0" xmlns="http://docbook.org/ns/docbook"
> +          xmlns:xlink="http://www.w3.org/1999/xlink"
> +          xmlns:xi="http://www.w3.org/2001/XInclude"
> +          xmlns:svg="http://www.w3.org/2000/svg"
> +          xmlns:m="http://www.w3.org/1998/Math/MathML"
> +          xmlns:html="http://www.w3.org/1999/xhtml"
> +          xmlns:db="http://docbook.org/ns/docbook">
>    <refmeta>
>      <refentrytitle>bbstored-config</refentrytitle>
>  
>      <manvolnum>8</manvolnum>
> +
> +    <refmiscinfo>Box Backup 0.11</refmiscinfo>
>    </refmeta>
>  
>    <refnamediv>
>      <refname>bbstored-config</refname>
>  
> -    <refpurpose>Create config files for bbstored</refpurpose>
> +    <refpurpose>Box Backup store daemon configuration file
> +    generator</refpurpose>
>    </refnamediv>
>  
>    <refsynopsisdiv>
>      <cmdsynopsis>
> -      <command>bbstored-config <configdir> <servername>
> -      <username></command>
> +      <command>bbstored-config</command>
> +
> +      <arg choice="plain">configdir</arg>
> +
> +      <arg choice="plain">servername</arg>
> +
> +      <arg choice="plain">username</arg>
>      </cmdsynopsis>
>    </refsynopsisdiv>
>  
>    <refsection>
>      <title>Description</title>
>  
> -    <para>The <literal>bbstored-config</literal> script creates config files
> -    and server certificates for a bbstored instance. It takes three
> -    parameters:</para>
> +    <para>The bbstored-config script creates configuration files and server
> +    certificates for a bbstored instance. It takes three parameters</para>
>  
> -    <itemizedlist>
> -      <listitem>
> -        <para><literal>configdir</literal>: The directory where config files
> -        will reside. A subdirectory bbstored will be created, where several
> -        config files will reside. the <literal>bbstored.conf</literal> file
> -        will be created in <literal>configdir</literal>.</para>
> -      </listitem>
> +    <variablelist>
> +      <varlistentry>
> +        <term>configdir</term>
>  
> -      <listitem>
> -        <para><literal>servername</literal>: The name of the server that is
> -        being configured. Usually the fully qualified domain name of the
> -        machine in question.</para>
> -      </listitem>
> +        <listitem>
> +          <para>The directory where config files will reside. A
> +          <filename>bbstored</filename> subdirectory will be created where
> +          several config files will reside. The
> +          <filename>bbstored.conf</filename> file will be created in
> +          <varname>configdir</varname>.</para>
> +        </listitem>
> +      </varlistentry>
>  
> -      <listitem>
> -        <para><literal>username</literal>: The name of the user that should be
> -        running the bbstored processes. Recommended name:
> -        _<literal>bbstored.</literal></para>
> -      </listitem>
> -    </itemizedlist>
> +      <varlistentry>
> +        <term>servername</term>
>  
> -    <para>A valid raidfile.conf(5) must be found in configdir. Several steps
> -    are taken during the run of bbstored-config:</para>
> +        <listitem>
> +          <para>The name of the server that is being configured. Usually the
> +          fully qualified domain name of the machine in question.</para>
> +        </listitem>
> +      </varlistentry>
>  
> +      <varlistentry>
> +        <term>username</term>
> +
> +        <listitem>
> +          <para>The name of the user that should be running the
> +          <command>bbstored</command> process. Recommended name:
> +          _bbstored.</para>
> +        </listitem>
> +      </varlistentry>
> +    </variablelist>
> +
> +    <para>A valid <citerefentry>
> +        <refentrytitle>raidfile.conf</refentrytitle>
> +
> +        <manvolnum>5</manvolnum>
> +      </citerefentry> must be found in configdir. Several steps are taken
> +    during the run of <command>bbstored-config</command>:</para>
> +
>      <itemizedlist>
>        <listitem>
> -        <para>Configuration files are created.</para>
> -      </listitem>
> -
> -      <listitem>
>          <para>Server certificates are created. This requires interaction from
>          the operator.</para>
>        </listitem>
>  
>        <listitem>
> -        <para>The raid volumes are checked, to ensure that the configuration
> -        is consistent, and will work.</para>
> +        <para>The RAID volumes are checked to ensure that the configuration is
> +        consistent and will work.</para>
>        </listitem>
>  
>        <listitem>
> @@ -74,67 +99,46 @@
>    </refsection>
>  
>    <refsection>
> -    <title>Author</title>
> +    <title>Files</title>
>  
> -    <para>Ben Summers and contributors. For help, please go to the <ulink
> -    url="http://www.boxbackup.org/trac/">Wiki</ulink>, or subscribe to the Box
> -    Backup <ulink
> -    url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing
> -    list.</ulink></para>
> +    <para><filename>/etc/box/bbstored.conf</filename></para>
>    </refsection>
>  
>    <refsection>
>      <title>See Also</title>
>  
> -    <para><literal>raidfile-config(8)</literal></para>
> +    <para><citerefentry>
> +        <refentrytitle>bbstored.conf</refentrytitle>
>  
> -    <para><literal>bbstored.conf(5)</literal></para>
> +        <manvolnum>5</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>bbstored</refentrytitle>
>  
> -    <para><literal>raidfile.conf(5)</literal></para>
> -  </refsection>
> +        <manvolnum>8</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>bbstored-certs</refentrytitle>
>  
> -  <refsection>
> -    <title>Files</title>
> +        <manvolnum>8</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>raidfile-config</refentrytitle>
>  
> -    <para><literal>bbstoreaccounts</literal> uses the Box Backup server
> -    configuration file, usually located in
> -    <filename>/etc/box/bbstored.conf</filename>.</para>
> +        <manvolnum>8</manvolnum>
> +      </citerefentry></para>
>    </refsection>
>  
>    <refsection>
> -    <title>Bugs</title>
> +    <title>Authors</title>
>  
> -    <para>If you find a bug in Box Backup, and you want to let us know about
> -    it, join the <ulink
> -    url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing
> -    list</ulink>, and send a description of the problem there.</para>
> +    <para><author>
> +        <personname>Ben Summers</personname>
> +      </author></para>
>  
> -    <para>To report a bug, give us at least the following information:</para>
> +    <para><author>
> +        <personname>Per Thomsen</personname>
> +      </author></para>
>  
> -    <itemizedlist>
> -      <listitem>
> -        <para>The version of Box Backup you are running</para>
> -      </listitem>
> -
> -      <listitem>
> -        <para>The platform you are running on (hardware and OS), for both
> -        client and server.</para>
> -      </listitem>
> -
> -      <listitem>
> -        <para>If possible attach your config files (bbstored.conf,
> -        bbackupd.conf) to the bug report.</para>
> -      </listitem>
> -
> -      <listitem>
> -        <para>Also attach any log file output that helps shed light on the
> -        problem you are seeing.</para>
> -      </listitem>
> -
> -      <listitem>
> -        <para>And last but certainly not least, a description of what you are
> -        seeing, in as much detail as possible.</para>
> -      </listitem>
> -    </itemizedlist>
> +    <para><author>
> +        <personname>James O'Gorman</personname>
> +      </author></para>
>    </refsection>
>  </refentry>
> 
> Added: box/trunk/documentation/bbstored.conf.xml
> ===================================================================
> --- box/trunk/documentation/bbstored.conf.xml	                        (rev 0)
> +++ box/trunk/documentation/bbstored.conf.xml	2008-09-30 23:28:57 UTC (rev 2305)
> @@ -0,0 +1,207 @@
> +<?xml version="1.0" encoding="UTF-8"?>
> +<refentry version="5.0" xmlns="http://docbook.org/ns/docbook"
> +          xmlns:xlink="http://www.w3.org/1999/xlink"
> +          xmlns:xi="http://www.w3.org/2001/XInclude"
> +          xmlns:svg="http://www.w3.org/2000/svg"
> +          xmlns:m="http://www.w3.org/1998/Math/MathML"
> +          xmlns:html="http://www.w3.org/1999/xhtml"
> +          xmlns:db="http://docbook.org/ns/docbook">
> +  <refmeta>
> +    <refentrytitle>bbstored.conf</refentrytitle>
> +
> +    <manvolnum>5</manvolnum>
> +
> +    <refmiscinfo>Box Backup 0.11</refmiscinfo>
> +  </refmeta>
> +
> +  <refnamediv>
> +    <refname>bbstored.conf</refname>
> +
> +    <refpurpose>Box Backup store daemon configuration file</refpurpose>
> +  </refnamediv>
> +
> +  <refsynopsisdiv>
> +    <cmdsynopsis>
> +      <command>/etc/box/bbstored.conf</command>
> +    </cmdsynopsis>
> +  </refsynopsisdiv>
> +
> +  <refsection>
> +    <title>Description</title>
> +
> +    <para>The following configuration options are valid:</para>
> +
> +    <variablelist>
> +      <varlistentry>
> +        <term><varname>RaidFileConf</varname></term>
> +
> +        <listitem>
> +          <para>Specifies the path to the <citerefentry>
> +              <refentrytitle>raidfile.conf</refentrytitle>
> +
> +              <manvolnum>5</manvolnum>
> +            </citerefentry>. This is normally
> +          <filename>/etc/box/raidfile.conf</filename>.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>AccountDatabase</varname></term>
> +
> +        <listitem>
> +          <para>Specifies the path to the account database created by
> +          <citerefentry>
> +              <refentrytitle>bbstoreaccounts</refentrytitle>
> +
> +              <manvolnum>8</manvolnum>
> +            </citerefentry>. This is usually
> +          <filename>/etc/box/bbstored/accounts.txt</filename>.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>ExtendedLogging</varname></term>
> +
> +        <listitem>
> +          <para>Specifies whether extended logging should be enabled to show
> +          what commands are being received from clients.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>TimeBetweenHousekeeping</varname></term>
> +
> +        <listitem>
> +          <para>How long between scanning for files which need
> +          deleting.</para>
> +        </listitem>
> +      </varlistentry>
> +
> +      <varlistentry>
> +        <term><varname>Server</varname></term>
> +
> +        <listitem>
> +          <para>These options relate to the actual daemon.<variablelist>
> +              <varlistentry>
> +                <term><varname>PidFile</varname></term>
> +
> +                <listitem>
> +                  <para>The location of the pidfile, where the daemon's
> +                  process ID is kept.</para>
> +                </listitem>
> +              </varlistentry>
> +
> +              <varlistentry>
> +                <term><varname>User</varname></term>
> +
> +                <listitem>
> +                  <para>The user to run as.</para>
> +                </listitem>
> +              </varlistentry>
> +
> +              <varlistentry>
> +                <term><varname>ListenAddresses</varname></term>
> +
> +                <listitem>
> +                  <para>The interface addresses to listen on. Hostnames may be
> +                  used instead of IP addresses. The format is:
> +                  <option>inet:hostname</option> or
> +                  <option>inet:10.0.0.1</option>.</para>
> +                </listitem>
> +              </varlistentry>
> +
> +              <varlistentry>
> +                <term><varname>CertificateFile</varname></term>
> +
> +                <listitem>
> +                  <para>The path to the server's public certificate.</para>
> +                </listitem>
> +              </varlistentry>
> +
> +              <varlistentry>
> +                <term><varname>PrivateKeyFile</varname></term>
> +
> +                <listitem>
> +                  <para>The path to the server's private key. This should only
> +                  be readable by root and/or the <option>User</option>.</para>
> +                </listitem>
> +              </varlistentry>
> +
> +              <varlistentry>
> +                <term><varname>TrustedCAsFile</varname></term>
> +
> +                <listitem>
> +                  <para>The Certificate Authority created by <citerefentry>
> +                      <refentrytitle>bbstored-certs</refentrytitle>
> +
> +                      <manvolnum>8</manvolnum>
> +                    </citerefentry>.</para>
> +                </listitem>
> +              </varlistentry>
> +            </variablelist></para>
> +        </listitem>
> +      </varlistentry>
> +    </variablelist>
> +  </refsection>
> +
> +  <refsection>
> +    <title>Examples</title>
> +
> +    <para>The following is an example bbstored.conf:</para>
> +
> +    <para><programlisting>RaidFileConf = /etc/box/raidfile.conf
> +AccountDatabase = /etc/box/bbstored/accounts.txt
> +
> +TimeBetweenHousekeeping = 900
> +
> +Server
> +{
> +  PidFile = /var/run/bbstored.pid
> +  User = _bbstored
> +  ListenAddresses = inet:server.example.com
> +  CertificateFile = /etc/box/bbstored/server.example.com-cert.pem
> +  PrivateKeyFile = /etc/box/bbstored/server.example.com-key.pem
> +  TrustedCAsFile = /etc/box/bbstored/clientCA.pem
> +}</programlisting></para>
> +  </refsection>
> +
> +  <refsection>
> +    <title>Files</title>
> +
> +    <para><filename>/etc/box/bbstored.conf</filename></para>
> +  </refsection>
> +
> +  <refsection>
> +    <title>See Also</title>
> +
> +    <para><citerefentry>
> +        <refentrytitle>bbstored</refentrytitle>
> +
> +        <manvolnum>8</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>bbstored-config</refentrytitle>
> +
> +        <manvolnum>8</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>raidfile-config</refentrytitle>
> +
> +        <manvolnum>8</manvolnum>
> +      </citerefentry></para>
> +  </refsection>
> +
> +  <refsection>
> +    <title>Authors</title>
> +
> +    <para><author>
> +        <personname>Ben Summers</personname>
> +      </author></para>
> +
> +    <para><author>
> +        <personname>Per Thomsen</personname>
> +      </author></para>
> +
> +    <para><author>
> +        <personname>James O'Gorman</personname>
> +      </author></para>
> +  </refsection>
> +</refentry>
> 
> Added: box/trunk/documentation/bbstored.xml
> ===================================================================
> --- box/trunk/documentation/bbstored.xml	                        (rev 0)
> +++ box/trunk/documentation/bbstored.xml	2008-09-30 23:28:57 UTC (rev 2305)
> @@ -0,0 +1,86 @@
> +<?xml version="1.0" encoding="UTF-8"?>
> +<refentry version="5.0" xmlns="http://docbook.org/ns/docbook"
> +          xmlns:xlink="http://www.w3.org/1999/xlink"
> +          xmlns:xi="http://www.w3.org/2001/XInclude"
> +          xmlns:svg="http://www.w3.org/2000/svg"
> +          xmlns:m="http://www.w3.org/1998/Math/MathML"
> +          xmlns:html="http://www.w3.org/1999/xhtml"
> +          xmlns:db="http://docbook.org/ns/docbook">
> +  <refmeta>
> +    <refentrytitle>bbstored</refentrytitle>
> +
> +    <manvolnum>8</manvolnum>
> +
> +    <refmiscinfo>Box Backup 0.11</refmiscinfo>
> +  </refmeta>
> +
> +  <refnamediv>
> +    <refname>bbstored</refname>
> +
> +    <refpurpose>Box Backup store daemon</refpurpose>
> +  </refnamediv>
> +
> +  <refsynopsisdiv>
> +    <cmdsynopsis>
> +      <command>bbstored</command>
> +
> +      <arg>config-file</arg>
> +    </cmdsynopsis>
> +  </refsynopsisdiv>
> +
> +  <refsection>
> +    <title>Description</title>
> +
> +    <para><command>bbstored</command> runs on a central server. Clients
> +    running <command>bbackupd</command> connect to the server and upload
> +    files.</para>
> +
> +    <para>The only argument is optional and specifies a non-default
> +    configuration file. By default it will look for the configuration file as
> +    <filename>/etc/box/bbstored.conf</filename>.</para>
> +  </refsection>
> +
> +  <refsection>
> +    <title>Files</title>
> +
> +    <para><filename>/etc/box/bbstored.conf</filename></para>
> +  </refsection>
> +
> +  <refsection>
> +    <title>See Also</title>
> +
> +    <para><citerefentry>
> +        <refentrytitle>bbstored.conf</refentrytitle>
> +
> +        <manvolnum>5</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>bbstored-config</refentrytitle>
> +
> +        <manvolnum>8</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>raidfile-config</refentrytitle>
> +
> +        <manvolnum>8</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>raidfile.conf</refentrytitle>
> +
> +        <manvolnum>5</manvolnum>
> +      </citerefentry></para>
> +  </refsection>
> +
> +  <refsection>
> +    <title>Authors</title>
> +
> +    <para><author>
> +        <personname>Ben Summers</personname>
> +      </author></para>
> +
> +    <para><author>
> +        <personname>Per Thomsen</personname>
> +      </author></para>
> +
> +    <para><author>
> +        <personname>James O'Gorman</personname>
> +      </author></para>
> +  </refsection>
> +</refentry>
> 
> Modified: box/trunk/documentation/raidfile-config.xml
> ===================================================================
> --- box/trunk/documentation/raidfile-config.xml	2008-09-30 23:27:06 UTC (rev 2304)
> +++ box/trunk/documentation/raidfile-config.xml	2008-09-30 23:28:57 UTC (rev 2305)
> @@ -1,9 +1,17 @@
>  <?xml version="1.0" encoding="UTF-8"?>
> -<refentry>
> +<refentry version="5.0" xmlns="http://docbook.org/ns/docbook"
> +          xmlns:xlink="http://www.w3.org/1999/xlink"
> +          xmlns:xi="http://www.w3.org/2001/XInclude"
> +          xmlns:svg="http://www.w3.org/2000/svg"
> +          xmlns:m="http://www.w3.org/1998/Math/MathML"
> +          xmlns:html="http://www.w3.org/1999/xhtml"
> +          xmlns:db="http://docbook.org/ns/docbook">
>    <refmeta>
>      <refentrytitle>raidfile-config</refentrytitle>
>  
>      <manvolnum>8</manvolnum>
> +
> +    <refmiscinfo>Box Backup 0.11</refmiscinfo>
>    </refmeta>
>  
>    <refnamediv>
> @@ -14,8 +22,13 @@
>  
>    <refsynopsisdiv>
>      <cmdsynopsis>
> -      <command>raidfile-config <configdir> <blocksize>
> -      <dir1> [<dir2> <dir3>]</command>
> +      <command>raidfile-config</command>
> +
> +      <arg choice="plain">config-dir</arg>
> +
> +      <arg choice="plain">blocksize</arg>
> +
> +      <arg choice="plain">dir1 <arg>dir2 <arg>dir3</arg></arg></arg>
>      </cmdsynopsis>
>    </refsynopsisdiv>
>  
> @@ -27,84 +40,78 @@
>      Backup supports userland RAID, in a restricted RAID5 configuration, where
>      3 and only 3 'drives' are supported. You can read more about RAID5 (and
>      other RAID-levels) <ulink
> -    url="http://en.wikipedia.org/wiki/Redundant_array_of_independent_disks#RAID_5">here</ulink>.
> -    </para>
> +    url="http://en.wikipedia.org/wiki/Redundant_array_of_independent_disks#RAID_5">here</ulink>.</para>
>  
>      <refsection>
>        <title>Parameters</title>
>  
>        <para>The parameters are as follows:</para>
>  
> -      <itemizedlist>
> -        <listitem>
> -          <para><literal>configdir</literal>: The directory path where
> -          configuration files are located. Usually this is
> -          <literal>/etc/box</literal>. <literal>raidfile.conf</literal> will
> -          be written in this directory.</para>
> -        </listitem>
> +      <variablelist>
> +        <varlistentry>
> +          <term><varname>config-dir</varname></term>
>  
> -        <listitem>
> -          <para><literal>blocksize</literal>: The block size used for file
> -          storage in the system, in bytes. Using a multiple of the file system
> -          block size is a good strategy. Depending on the size of the files
> -          you will be backing up, this multiple varies. Of course it also
> -          depends on the native block size of your file system.</para>
> -        </listitem>
> +          <listitem>
> +            <para>The directory path where configuration files are located.
> +            Usually this is <filename>/etc/box</filename>.
> +            <filename>raidfile.conf</filename> will be written in this
> +            directory.</para>
> +          </listitem>
> +        </varlistentry>
>  
> -        <listitem>
> -          <para><literal>dir1</literal>: The first directory in the built-in
> -          RAID array.</para>
> -        </listitem>
> +        <varlistentry>
> +          <term><varname>blocksize</varname></term>
>  
> -        <listitem>
> -          <para><literal>dir2</literal>: The second directory in the built-in
> -          RAID array. If you are not using the built-in RAID functionality,
> -          this field should be ignored. You should not use the built-in RAID,
> -          when you have a hardware RAID solution, or if you're using another
> -          type of software RAID (like md on Linux).</para>
> -        </listitem>
> +          <listitem>
> +            <para>The block size used for file storage in the system, in
> +            bytes. Using a multiple of the file system block size is a good
> +            strategy. Depending on the size of the files you will be backing
> +            up, this multiple varies. Of course it also depends on the native
> +            block size of your file system.</para>
> +          </listitem>
> +        </varlistentry>
>  
> -        <listitem>
> -          <para><literal>dir3</literal>: The third directory in the built-in
> -          RAID array. The same notes that apply to <literal>dir2</literal>
> -          also apply to <literal>dir3</literal>.</para>
> -        </listitem>
> -      </itemizedlist>
> +        <varlistentry>
> +          <term><varname>dir1</varname></term>
>  
> -      <para>Note that there are currently no way to add multiple disk sets to
> -      the raidfile.conf file using command line tools, etc. See
> -      raidfile.conf(5) for details on adding more disks</para>
> -    </refsection>
> -  </refsection>
> +          <listitem>
> +            <para>The first directory in the built-in RAID array.</para>
> +          </listitem>
> +        </varlistentry>
>  
> -  <refsection>
> -    <title>Author</title>
> +        <varlistentry>
> +          <term><varname>dir2</varname></term>
>  
> -    <para>Ben Summers and contributors. For help, please go to the <ulink
> -    url="http://www.boxbackup.org/trac/">Wiki</ulink>, or subscribe to the Box
> -    Backup <ulink
> -    url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing
> -    list.</ulink></para>
> -  </refsection>
> +          <listitem>
> +            <para>The second directory in the built-in RAID array. If you are
> +            not using the built-in RAID functionality, this field should be
> +            ignored. You should not use the built-in RAID if you have a
> +            hardware RAID solution or if you're using another type of software
> +            RAID (like md on Linux).</para>
> +          </listitem>
> +        </varlistentry>
>  
> -  <refsection>
> -    <title>See Also</title>
> +        <varlistentry>
> +          <term><varname>dir3</varname></term>
>  
> -    <para><literal>bbstored-config(8)</literal></para>
> +          <listitem>
> +            <para>The third directory in the built-in RAID array. The same
> +            notes that apply to <varname>dir2</varname> also apply to
> +            <varname>dir3</varname>.</para>
> +          </listitem>
> +        </varlistentry>
> +      </variablelist>
>  
> -    <para><literal>bbstored.conf(5)</literal></para>
> +      <para>Note that there are currently no way to add multiple disk sets to
> +      the raidfile.conf file using command line tools, etc. See <citerefentry>
> +          <refentrytitle>raidfile.conf</refentrytitle>
>  
> -    <para><literal>raidfile.conf(5)</literal></para>
> +          <manvolnum>5</manvolnum>
> +        </citerefentry> for details on adding more disks.</para>
> +    </refsection>
>    </refsection>
>  
>    <refsection>
> -    <title>Files</title>
> -
> -    <para><literal>raidfile-config</literal> generates the raidfile.conf(5)
> -    file.</para>
> -  </refsection>
> -
> -  <refsection>
>      <title>Bugs</title>
>  
>      <para>If you find a bug in Box Backup, and you want to let us know about
> @@ -140,4 +147,48 @@
>        </listitem>
>      </itemizedlist>
>    </refsection>
> +
> +  <refsection>
> +    <title>Files</title>
> +
> +    <para><command>raidfile-config</command> generates the <citerefentry>
> +        <refentrytitle>raidfile.conf</refentrytitle>
> +
> +        <manvolnum>5</manvolnum>
> +      </citerefentry> file.</para>
> +  </refsection>
> +
> +  <refsection>
> +    <title>See Also</title>
> +
> +    <para><citerefentry>
> +        <refentrytitle>bbstored-config</refentrytitle>
> +
> +        <manvolnum>8</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>bbstored.conf</refentrytitle>
> +
> +        <manvolnum>5</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>raidfile.conf</refentrytitle>
> +
> +        <manvolnum>5</manvolnum>
> +      </citerefentry></para>
> +  </refsection>
> +
> +  <refsection>
> +    <title>Authors</title>
> +
> +    <para><author>
> +        <personname>Ben Summers</personname>
> +      </author></para>
> +
> +    <para><author>
> +        <personname>Per Thomsen</personname>
> +      </author></para>
> +
> +    <para><author>
> +        <personname>James O'Gorman</personname>
> +      </author></para>
> +  </refsection>
>  </refentry>
> 
> Added: box/trunk/documentation/raidfile.conf.xml
> ===================================================================
> --- box/trunk/documentation/raidfile.conf.xml	                        (rev 0)
> +++ box/trunk/documentation/raidfile.conf.xml	2008-09-30 23:28:57 UTC (rev 2305)
> @@ -0,0 +1,139 @@
> +<?xml version="1.0" encoding="UTF-8"?>
> +<refentry version="5.0" xmlns="http://docbook.org/ns/docbook"
> +          xmlns:xlink="http://www.w3.org/1999/xlink"
> +          xmlns:xi="http://www.w3.org/2001/XInclude"
> +          xmlns:svg="http://www.w3.org/2000/svg"
> +          xmlns:m="http://www.w3.org/1998/Math/MathML"
> +          xmlns:html="http://www.w3.org/1999/xhtml"
> +          xmlns:db="http://docbook.org/ns/docbook">
> +  <refmeta>
> +    <refentrytitle>raidfile.conf</refentrytitle>
> +
> +    <manvolnum>5</manvolnum>
> +
> +    <refmiscinfo>Box Backup 0.11</refmiscinfo>
> +  </refmeta>
> +
> +  <refnamediv>
> +    <refname>raidfile.conf</refname>
> +
> +    <refpurpose>Userland RAID for Box Backup</refpurpose>
> +  </refnamediv>
> +
> +  <refsynopsisdiv>
> +    <cmdsynopsis>
> +      <command>/etc/box/raidfile.conf</command>
> +    </cmdsynopsis>
> +  </refsynopsisdiv>
> +
> +  <refsection>
> +    <title>Description</title>
> +
> +    <para>The raidfile.conf is usually generated by <citerefentry>
> +        <refentrytitle>raidfile-config</refentrytitle>
> +
> +        <manvolnum>8</manvolnum>
> +      </citerefentry> but may be manually edited if the store locations move
> +    or if more than one disc set is required.</para>
> +
> +    <para><variablelist>
> +        <varlistentry>
> +          <term>disc<varname>X</varname></term>
> +
> +          <listitem>
> +            <para>Specifies a set of discs.</para>
> +
> +            <para><variablelist>
> +                <varlistentry>
> +                  <term><varname>SetNumber</varname></term>
> +
> +                  <listitem>
> +                    <para>The set number of the RAID disc, referenced by each
> +                    account.</para>
> +                  </listitem>
> +                </varlistentry>
> +
> +                <varlistentry>
> +                  <term><varname>BlockSize</varname></term>
> +
> +                  <listitem>
> +                    <para>The block size of the file system (usually 2048).
> +                    Under BSD with FFS, set this to your file system's
> +                    fragment size (most likely an 8th of the block
> +                    size).</para>
> +                  </listitem>
> +                </varlistentry>
> +
> +                <varlistentry>
> +                  <term><varname>Dir0</varname></term>
> +
> +                  <listitem>
> +                    <para>The first directory in the RAID array.</para>
> +                  </listitem>
> +                </varlistentry>
> +
> +                <varlistentry>
> +                  <term><varname>Dir1</varname></term>
> +
> +                  <listitem>
> +                    <para>The second directory in the RAID array. If you do
> +                    not wish to use the built-in RAID functionality, this
> +                    field should be set to the same as
> +                    <varname>Dir0</varname>. You should not use the built-in
> +                    RAID if you have a hardware RAID solution or if you're
> +                    using another type of software RAID (like md on
> +                    Linux).</para>
> +                  </listitem>
> +                </varlistentry>
> +
> +                <varlistentry>
> +                  <term><varname>Dir2</varname></term>
> +
> +                  <listitem>
> +                    <para>The third directory in the RAID array. The same
> +                    notes that apply to <varname>Dir2</varname> also apply to
> +                    <varname>Dir3</varname>.</para>
> +                  </listitem>
> +                </varlistentry>
> +              </variablelist></para>
> +          </listitem>
> +        </varlistentry>
> +      </variablelist></para>
> +  </refsection>
> +
> +  <refsection>
> +    <title>Files</title>
> +
> +    <para><filename>/etc/box/raidfile.conf</filename></para>
> +  </refsection>
> +
> +  <refsection>
> +    <title>See Also</title>
> +
> +    <para><citerefentry>
> +        <refentrytitle>raidfile-config</refentrytitle>
> +
> +        <manvolnum>8</manvolnum>
> +      </citerefentry>, <citerefentry>
> +        <refentrytitle>bbstored.conf</refentrytitle>
> +
> +        <manvolnum>5</manvolnum>
> +      </citerefentry></para>
> +  </refsection>
> +
> +  <refsection>
> +    <title>Authors</title>
> +
> +    <para><author>
> +        <personname>Ben Summers</personname>
> +      </author></para>
> +
> +    <para><author>
> +        <personname>Per Thomsen</personname>
> +      </author></para>
> +
> +    <para><author>
> +        <personname>James O'Gorman</personname>
> +      </author></para>
> +  </refsection>
> +</refentry>
> 
> _______________________________________________
> Boxbackup-commit mailing list
> Boxbackup-commit at boxbackup.org
> http://lists.warhead.org.uk/mailman/listinfo/boxbackup-commit
> 




More information about the Boxbackup-dev mailing list