Changeset 2305


Ignore:
Timestamp:
01/10/2008 00:28:57 (3 years ago)
Author:
jamesog
Message:

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.

Location:
box/trunk/documentation
Files:
6 added
6 edited

Legend:

Unmodified
Added
Removed

  • box/trunk/documentation/bbackupctl.xml

    r2127 r2305  
    11<?xml version="1.0" encoding="UTF-8"?> 
    2 <refentry> 
     2<refentry version="5.0" xmlns="http://docbook.org/ns/docbook" 
     3          xmlns:xlink="http://www.w3.org/1999/xlink" 
     4          xmlns:xi="http://www.w3.org/2001/XInclude" 
     5          xmlns:svg="http://www.w3.org/2000/svg" 
     6          xmlns:m="http://www.w3.org/1998/Math/MathML" 
     7          xmlns:html="http://www.w3.org/1999/xhtml" 
     8          xmlns:db="http://docbook.org/ns/docbook"> 
    39  <refmeta> 
    410    <refentrytitle>bbackupctl</refentrytitle> 
    … …  
    1016    <refname>bbackupctl</refname> 
    1117 
    12     <refpurpose>Control the bbackupd daemon </refpurpose> 
     18    <refpurpose>Contol the Box Backup client daemon</refpurpose> 
    1319  </refnamediv> 
    1420 
    1521  <refsynopsisdiv> 
    1622    <cmdsynopsis> 
    17       <command>bbackupctl [-q] [-c config-file] command</command> 
     23      <command>bbackupctl</command> 
     24 
     25      <arg>-q</arg> 
     26 
     27      <arg>-c config-file</arg> 
     28 
     29      <arg choice="plain">command</arg> 
    1830    </cmdsynopsis> 
    1931  </refsynopsisdiv> 
    … …  
    2234    <title>Description</title> 
    2335 
    24     <para><literal>bbackupctl</literal> lets the user control the bbackupd 
    25     daemon on a client machine. The main use is to force a sync with the store 
    26     server. This is especially important if bbackupd(8) is configured to do 
    27     snapshot backups. In that case <literal>bbackupctl</literal> is the only 
    28     way to effect a backup.</para> 
     36    <para><command>bbackupctl</command> sends commands to a running 
     37    <command>bbackupd</command> daemon on a client machine. It can be used to 
     38    force an immediate backup, tell the daemon to reload its configuration 
     39    files or stop the daemon. If <command>bbackupd</command> is configured in 
     40    snapshot mode, it will not back up automatically, and the 
     41    <command>bbackupctl</command> must be used to tell it when to start a 
     42    backup.</para> 
    2943 
    3044    <para>Communication with the bbackupd daemon takes place over a local 
    31     socket. Some platforms (notably Windows) can't determine if the user 
    32     connecting on this socket has the correct credentials to execute the 
    33     commands, leaving a rather sizeable security hole open. To avoid this, 
    34     unset the CommandSocket parameter in <literal>bbackupd.conf</literal>(5). 
    35     That disables the command socket, so bbackupd is secure. This does, 
    36     however, render bbackupctl unusable.</para> 
     45    socket (not over the network). Some platforms (notably Windows) can't 
     46    determine if the user connecting on this socket has the correct 
     47    credentials to execute the commands. On these platforms, ANY local user 
     48    can interfere with bbackupd. To avoid this, remove the CommandSocket 
     49    option from bbackupd.conf, which will also disable bbackupctl. See the 
     50    Client Configuration page for more information.</para> 
    3751 
    38     <refsection> 
    39       <title>Options</title> 
     52    <para><command>bbackupctl</command> needs to read the 
     53    <command>bbackupd</command> configuration file to find out the name of the 
     54    CommandSocket. If you have to tell <command>bbackupd</command> where to 
     55    find the configuration file, you will have to tell 
     56    <command>bbackupctl</command> as well. The default on Unix systems is 
     57    usually <filename>/etc/box/bbackupd.conf</filename>. On Windows systems, 
     58    it is <filename>bbackupd.conf</filename> in the same directory where 
     59    <command>bbackupd.exe</command> is located. If 
     60    <command>bbackupctl</command> cannot find or read the configuration file, 
     61    it will log an error message and exit.</para> 
    4062 
    41       <itemizedlist> 
    42         <listitem> 
    43           <para>-q -- quiet. Do not output status messages.</para> 
    44         </listitem> 
     63    <para><command>bbackupctl</command> usually writes error messages to the 
     64    console and the system logs. If it is not doing what you expect, please 
     65    check these outputs first of all.</para> 
     66 
     67    <variablelist> 
     68      <varlistentry> 
     69        <term><option>-q</option></term> 
    4570 
    4671        <listitem> 
    47           <para>-c config_file -- Use a different config file from the default 
    48           one. Can be a full or a relative path.</para> 
     72          <para>Run in quiet mode.</para> 
    4973        </listitem> 
    50       </itemizedlist> 
    51     </refsection> 
     74      </varlistentry> 
     75 
     76      <varlistentry> 
     77        <term><option>-c</option> config-file</term> 
     78 
     79        <listitem> 
     80          <para>Specify configuration file.</para> 
     81        </listitem> 
     82      </varlistentry> 
     83    </variablelist> 
    5284 
    5385    <refsection> 
    … …  
    5688      <para>The following commands are available in bbackupctl:</para> 
    5789 
    58       <itemizedlist> 
    59         <listitem> 
    60           <para><literal>terminate</literal></para> 
     90      <variablelist> 
     91        <varlistentry> 
     92          <term><command>terminate</command></term> 
    6193 
    62           <para>This command stops the bbackupd server. This is the equivalent 
    63           of killing (kill -KILL) the bbackupd process.</para> 
    64         </listitem> 
     94          <listitem> 
     95            <para>This command cleanly shuts down <command>bbackupd</command>. 
     96            This is better than killing or terminating it any other 
     97            way.</para> 
     98          </listitem> 
     99        </varlistentry> 
    65100 
    66         <listitem> 
    67           <para><literal>reload</literal></para> 
     101        <varlistentry> 
     102          <term><command>reload</command></term> 
    68103 
    69           <para>Causes the bbackupd daemon to re-read all its configuration 
    70           files. Equivalent to kill -HUP.</para> 
    71         </listitem> 
     104          <listitem> 
     105            <para>Causes the <command>bbackupd</command> daemon to re-read all 
     106            its configuration files. Equivalent to <command>kill 
     107            -HUP</command>.</para> 
     108          </listitem> 
     109        </varlistentry> 
    72110 
    73         <listitem> 
    74           <para><literal>sync</literal></para> 
     111        <varlistentry> 
     112          <term><command>sync</command></term> 
    75113 
    76           <para>Initiates a backup to the store of whatever needs to be backed 
    77           up.</para> 
    78         </listitem> 
    79       </itemizedlist> 
     114          <listitem> 
     115            <para>Initiates a backup. If no files need to be backed up, no 
     116            connection will be made to the server.</para> 
     117          </listitem> 
     118        </varlistentry> 
     119 
     120        <varlistentry> 
     121          <term><command>force-sync</command></term> 
     122 
     123          <listitem> 
     124            <para>Initiates a backup, even if the 
     125            <varname>SyncAllowScript</varname> says that no backup should run 
     126            now.</para> 
     127          </listitem> 
     128        </varlistentry> 
     129 
     130        <varlistentry> 
     131          <term><command>wait-for-sync</command></term> 
     132 
     133          <listitem> 
     134            <para>Passively waits until the next backup starts of its own 
     135            accord, and then terminates.</para> 
     136          </listitem> 
     137        </varlistentry> 
     138 
     139        <varlistentry> 
     140          <term><command>wait-for-end</command></term> 
     141 
     142          <listitem> 
     143            <para>Passively waits until the next backup starts of its own 
     144            accord and finishes, and then terminates.</para> 
     145          </listitem> 
     146        </varlistentry> 
     147 
     148        <varlistentry> 
     149          <term><command>sync-and-wait</command></term> 
     150 
     151          <listitem> 
     152            <para>Initiates a backup, waits for it to finish, and then 
     153            terminates.</para> 
     154          </listitem> 
     155        </varlistentry> 
     156      </variablelist> 
    80157    </refsection> 
    81158  </refsection> 
    82159 
    83160  <refsection> 
    84     <title>Author</title> 
     161    <title>Files</title> 
    85162 
    86     <para>Ben Summers and contributors. For help, please go to the <ulink 
    87     url="http://www.boxbackup.org/trac/">Wiki</ulink>, or subscribe to the Box 
    88     Backup <ulink 
    89     url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing 
    90     list.</ulink></para> 
     163    <para><filename>/etc/box/bbackupd.conf</filename></para> 
    91164  </refsection> 
    92165 
    … …  
    94167    <title>See Also</title> 
    95168 
    96     <para><literal>bbackupd.conf(5)</literal></para> 
     169    <para><citerefentry> 
     170        <refentrytitle>bbackupd.conf</refentrytitle> 
    97171 
    98     <para><literal>bbackupd(8)</literal></para> 
    99   </refsection> 
     172        <manvolnum>5</manvolnum> 
     173      </citerefentry>, <citerefentry> 
     174        <refentrytitle>bbackupd-config</refentrytitle> 
    100175 
    101   <refsection> 
    102     <title>Files</title> 
     176        <manvolnum>8</manvolnum> 
     177      </citerefentry>, <citerefentry> 
     178        <refentrytitle>bbackupctl</refentrytitle> 
    103179 
    104     <para><literal>bbackupctl</literal> uses the Box Backup client 
    105     configuration file, usually located in 
    106     <filename>/etc/box/bbackupd.conf</filename>. On Windows this file is 
    107     usually located in the installation directory, and is named 
    108     <filename>bbackupd.conf</filename> as well.</para> 
    109   </refsection> 
    110  
    111   <refsection> 
    112     <title>Bugs</title> 
    113  
    114     <para>If you find a bug in Box Backup, and you want to let us know about 
    115     it, join the <ulink 
    116     url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing 
    117     list</ulink>, and send a description of the problem there.</para> 
    118  
    119     <para>To report a bug, give us at least the following information:</para> 
    120  
    121     <itemizedlist> 
    122       <listitem> 
    123         <para>The version of Box Backup you are running</para> 
    124       </listitem> 
    125  
    126       <listitem> 
    127         <para>The platform you are running on (Hardware and OS), for both 
    128         client and server.</para> 
    129       </listitem> 
    130  
    131       <listitem> 
    132         <para>If possible attach your config files (bbstored.conf, 
    133         bbackupd.conf) to the bug report.</para> 
    134       </listitem> 
    135  
    136       <listitem> 
    137         <para>Also attach any log file output that helps shed light on the 
    138         problem you are seeing.</para> 
    139       </listitem> 
    140  
    141       <listitem> 
    142         <para>And last but certainly not least, a description of what you are 
    143         seeing, in as much detail as possible.</para> 
    144       </listitem> 
    145     </itemizedlist> 
     180        <manvolnum>8</manvolnum> 
     181      </citerefentry></para> 
    146182  </refsection> 
    147183</refentry> 

  • box/trunk/documentation/bbackupquery.xml

    r2127 r2305  
    11<?xml version="1.0" encoding="UTF-8"?> 
    2 <refentry> 
     2<refentry version="5.0" xmlns="http://docbook.org/ns/docbook" 
     3          xmlns:xlink="http://www.w3.org/1999/xlink" 
     4          xmlns:xi="http://www.w3.org/2001/XInclude" 
     5          xmlns:svg="http://www.w3.org/2000/svg" 
     6          xmlns:m="http://www.w3.org/1998/Math/MathML" 
     7          xmlns:html="http://www.w3.org/1999/xhtml" 
     8          xmlns:db="http://docbook.org/ns/docbook"> 
    39  <refmeta> 
    410    <refentrytitle>bbackupquery</refentrytitle> 
    511 
    612    <manvolnum>8</manvolnum> 
     13 
     14    <refmiscinfo class="manual">Box Backup 0.11</refmiscinfo> 
    715  </refmeta> 
    816 
    … …  
    1018    <refname>bbackupquery</refname> 
    1119 
    12     <refpurpose>Box Backup store query and retrieval</refpurpose> 
     20    <refpurpose>Box Backup store query and file retrieval</refpurpose> 
    1321  </refnamediv> 
    1422 
    1523  <refsynopsisdiv> 
    1624    <cmdsynopsis> 
    17       <command>bbackupquery [-q] [-c configfile] [commands ...]</command> 
     25      <command>bbackupquery</command> 
     26 
     27      <arg>-q</arg> 
     28 
     29      <arg>-c configfile</arg> 
     30 
     31      <arg>command ...</arg> 
    1832    </cmdsynopsis> 
    1933  </refsynopsisdiv> 
    … …  
    2236    <title>Description</title> 
    2337 
    24     <para><literal>bbackupquery</literal> is the main way of interacting with 
     38    <para><command>bbackupquery</command> is the main way of interacting with 
    2539    the backup store from a Box Backup client machine. It supports both 
    2640    interactive and batch modes of operation.</para> 
    … …  
    3044    files and directories when needed.</para> 
    3145 
    32     <para><literal>bbackupquery</literal> supports interactive and batch modes 
     46    <para><command>bbackupquery</command> supports interactive and batch modes 
    3347    of operation. Interactive mode allows for interaction with the server much 
    3448    like an interactive FTP client.</para> 
    3549 
    3650    <para>Batch mode is invoked by putting commands into the invocation of 
    37     bbackupquery. Example:</para> 
    38  
    39     <programlisting>bbackupquery "list home-dirs" quit</programlisting> 
     51    <command>bbackupquery</command>. Example:</para> 
     52 
     53    <para><programlisting>bbackupquery "list home-dirs" quit</programlisting></para> 
    4054 
    4155    <para>Note that commands that contain spaces are enclosed in double 
    42     quotes. If the <literal>quit</literal> command is omitted, after the 
    43     preceding commands are completed, <literal>bbackupquery</literal> will 
     56    quotes. If the <command>quit</command> command is omitted, after the 
     57    preceding commands are completed, <command>bbackupquery</command> will 
    4458    enter interactive mode.</para> 
    45  
    46     <para><emphasis role="bold">Options</emphasis></para> 
    47  
    48     <para><emphasis>-q: Quiet. Suppresses status output while 
    49     running.</emphasis></para> 
    50  
    51     <para><emphasis>-c configfile: Use config file, instead of the default 
    52     bbackupd.conf file. Can be a relative or full path.</emphasis></para> 
    53  
    54     <refsection> 
    55       <title>Commands</title> 
    56  
    57       <para>The commands that can be used in <literal>bbackupquery</literal> 
    58       are listed below.</para> 
    59  
    60       <itemizedlist> 
    61         <listitem> 
    62           <para><literal>help</literal></para> 
    63  
     59  </refsection> 
     60 
     61  <refsection> 
     62    <title>Options</title> 
     63 
     64    <para><variablelist> 
     65        <varlistentry> 
     66          <term><option>-q</option></term> 
     67 
     68          <listitem> 
     69            <para>Quiet. Suppresses status output while running.</para> 
     70          </listitem> 
     71        </varlistentry> 
     72 
     73        <varlistentry> 
     74          <term><option>-c</option> <option>configfile</option></term> 
     75 
     76          <listitem> 
     77            <para>Use configfile instead of the default bbackupd.conf file. 
     78            Can be a relative or full path.</para> 
     79          </listitem> 
     80        </varlistentry> 
     81      </variablelist></para> 
     82  </refsection> 
     83 
     84  <refsection> 
     85    <title>Commands</title> 
     86 
     87    <para>The commands that can be used in bbackupquery are listed 
     88    below.</para> 
     89 
     90    <variablelist> 
     91      <varlistentry> 
     92        <term><command>help</command></term> 
     93 
     94        <listitem> 
    6495          <para>Displays the basic help message, which gives information about 
    65           the commands available in bbackupquery. Use the form <literal>help 
    66           command</literal>, to get help on a specific command.</para> 
    67         </listitem> 
    68  
    69         <listitem> 
    70           <para><literal>quit</literal></para> 
    71  
     96          the commands available in <command>bbackupquery</command>. Use the 
     97          form <command>help command</command> to get help on a specific 
     98          command.</para> 
     99        </listitem> 
     100      </varlistentry> 
     101 
     102      <varlistentry> 
     103        <term><command>quit</command></term> 
     104 
     105        <listitem> 
    72106          <para>End the session with the store server, and quit 
    73           <literal>bbackupquery</literal>.</para> 
    74         </listitem> 
    75  
    76         <listitem> 
    77           <para><literal>cd [options] &lt;directory-name&gt;</literal></para> 
    78  
    79           <para>Change directory. Options:</para> 
    80  
    81           <itemizedlist> 
    82             <listitem> 
    83               <para><literal>-d</literal> -- consider deleted directories for 
    84               traversal</para> 
    85             </listitem> 
    86  
    87             <listitem> 
    88               <para><literal>-o</literal> -- consider old versions of 
    89               directories for traversal. This option should never be useful in 
    90               a correctly formed store.</para> 
    91             </listitem> 
    92           </itemizedlist> 
    93         </listitem> 
    94  
    95         <listitem> 
    96           <para><literal>lcd &lt;local-directory-name&gt;</literal></para> 
    97  
     107          bbackupquery.</para> 
     108        </listitem> 
     109      </varlistentry> 
     110 
     111      <varlistentry> 
     112        <term><command>cd</command> <optional>options</optional> 
     113        <varname>directory-name</varname></term> 
     114 
     115        <listitem> 
     116          <para>Change directory. Options: <variablelist> 
     117              <varlistentry> 
     118                <term><option>-d</option></term> 
     119 
     120                <listitem> 
     121                  <para>consider deleted directories for traversal</para> 
     122                </listitem> 
     123              </varlistentry> 
     124 
     125              <varlistentry> 
     126                <term><option>-o</option></term> 
     127 
     128                <listitem> 
     129                  <para>consider old versions of directories for traversal. 
     130                  This option should never be useful in a correctly formed 
     131                  store.</para> 
     132                </listitem> 
     133              </varlistentry> 
     134            </variablelist></para> 
     135        </listitem> 
     136      </varlistentry> 
     137 
     138      <varlistentry> 
     139        <term><command>lcd</command> 
     140        <varname>local-directory-name</varname></term> 
     141 
     142        <listitem> 
    98143          <para>Change directory on the client machine. To list the contents 
    99           of the local directory, type <literal>sh ls</literal> (on unix-like 
    100           machines). TODO: Does <literal>sh dir</literal> work on 
    101           Windows?</para> 
    102         </listitem> 
    103  
    104         <listitem> 
    105           <para><literal>list [options] [directory-name]</literal></para> 
    106  
    107           <para>The <literal>list</literal> (or its synonym 
    108           <literal>ls</literal>) command lists the content of the current, or 
    109           specified, directory. The options are as follows:</para> 
    110  
    111           <itemizedlist> 
    112             <listitem> 
    113               <para><literal>-r</literal> -- recursively list all files</para> 
    114             </listitem> 
    115  
    116             <listitem> 
    117               <para><literal>-d</literal> -- list deleted files and 
    118               directories</para> 
    119             </listitem> 
    120  
    121             <listitem> 
    122               <para><literal>-o</literal> -- list old versions of files and 
    123               directories</para> 
    124             </listitem> 
    125  
    126             <listitem> 
    127               <para><literal>-I</literal> -- don't display object IDs</para> 
    128             </listitem> 
    129  
    130             <listitem> 
    131               <para><literal>-F</literal> -- don't display flags</para> 
    132             </listitem> 
    133  
    134             <listitem> 
    135               <para><literal>-t</literal> -- show file modification time (and 
    136               attr mod time, if the object has attributes.</para> 
    137             </listitem> 
    138  
    139             <listitem> 
    140               <para><literal>-s</literal> -- show file size in blocks used on 
    141               server. Note that this is only a very approximate indication of 
    142               local file size.</para> 
    143             </listitem> 
    144           </itemizedlist> 
    145         </listitem> 
    146  
    147         <listitem> 
    148           <para><literal>ls [options] [directory-name]</literal></para> 
    149  
    150           <para>Synonym for <literal>list</literal>.</para> 
    151         </listitem> 
    152  
    153         <listitem> 
    154           <para><literal><literal>pwd</literal></literal></para> 
    155  
     144          of the local directory, type <command>sh ls</command> (on Unix-like 
     145          machines).</para> 
     146        </listitem> 
     147      </varlistentry> 
     148 
     149      <varlistentry> 
     150        <term><command>list</command> <optional>options</optional> 
     151        <optional>directory-name</optional></term> 
     152 
     153        <listitem> 
     154          <para>The list (or its synonym <command>ls</command>) command lists 
     155          the content of the current, or specified, directory. The options are 
     156          as follows:</para> 
     157 
     158          <para><variablelist> 
     159              <varlistentry> 
     160                <term><option>-r</option></term> 
     161 
     162                <listitem> 
     163                  <para>recursively list all files</para> 
     164                </listitem> 
     165              </varlistentry> 
     166 
     167              <varlistentry> 
     168                <term><option>-d</option></term> 
     169 
     170                <listitem> 
     171                  <para>list deleted files and directories</para> 
     172                </listitem> 
     173              </varlistentry> 
     174 
     175              <varlistentry> 
     176                <term><option>-o</option></term> 
     177 
     178                <listitem> 
     179                  <para>list old versions of files and directories</para> 
     180                </listitem> 
     181              </varlistentry> 
     182 
     183              <varlistentry> 
     184                <term><option>-I</option></term> 
     185 
     186                <listitem> 
     187                  <para>don't display object IDs</para> 
     188                </listitem> 
     189              </varlistentry> 
     190 
     191              <varlistentry> 
     192                <term><option>-F</option></term> 
     193 
     194                <listitem> 
     195                  <para>don't display flags</para> 
     196                </listitem> 
     197              </varlistentry> 
     198 
     199              <varlistentry> 
     200                <term><option>-t</option></term> 
     201 
     202                <listitem> 
     203                  <para>show file modification time (and attr mod time, if the 
     204                  object has attributes).</para> 
     205                </listitem> 
     206              </varlistentry> 
     207 
     208              <varlistentry> 
     209                <term><option>-s</option></term> 
     210 
     211                <listitem> 
     212                  <para>show file size in blocks used on server. Note that 
     213                  this is only a very approximate indication of local file 
     214                  size.</para> 
     215                </listitem> 
     216              </varlistentry> 
     217            </variablelist></para> 
     218        </listitem> 
     219      </varlistentry> 
     220 
     221      <varlistentry> 
     222        <term><command>ls</command> <optional>options</optional> 
     223        <optional>directory-name</optional></term> 
     224 
     225        <listitem> 
     226          <para>Synonym for <command>list</command>.</para> 
     227        </listitem> 
     228      </varlistentry> 
     229 
     230      <varlistentry> 
     231        <term><command>pwd</command></term> 
     232 
     233        <listitem> 
    156234          <para>Print current directory, always relative to the backup store 
    157235          root.</para> 
    158236        </listitem> 
    159  
    160         <listitem> 
    161           <para><literal>sh &lt;shell command&gt;</literal></para> 
    162  
     237      </varlistentry> 
     238 
     239      <varlistentry> 
     240        <term><command>sh</command> <varname>shell-command</varname></term> 
     241 
     242        <listitem> 
    163243          <para>Everything after the sh is passed to a shell and run. All 
    164244          output from the command is displayed in the client.</para> 
    165245 
    166246          <para>Example: to list the contents of the current directory on the 
    167           client machine type <literal>sh ls</literal>.</para> 
    168         </listitem> 
    169  
    170         <listitem> 
    171           <para><literal>compare -a</literal></para> 
    172  
    173           <para><literal>compare -l &lt;location-name&gt;</literal></para> 
    174  
    175           <para><literal>compare &lt;store-dir-name&gt; 
    176           &lt;local-dir-name&gt;</literal></para> 
    177  
     247          client machine type <command>sh ls</command>.</para> 
     248        </listitem> 
     249      </varlistentry> 
     250 
     251      <varlistentry> 
     252        <term><command>compare -a</command></term> 
     253 
     254        <listitem> 
     255          <para></para> 
     256        </listitem> 
     257      </varlistentry> 
     258 
     259      <varlistentry> 
     260        <term><command>compare -l</command> 
     261        <varname>location-name</varname></term> 
     262 
     263        <listitem> 
     264          <para></para> 
     265        </listitem> 
     266      </varlistentry> 
     267 
     268      <varlistentry> 
     269        <term><command>compare</command> <varname>store-dir-name</varname> 
     270        <varname>local-dir-name</varname></term> 
     271 
     272        <listitem> 
    178273          <para>Compare the current data in the store with the data on the 
    179274          disc. Please note that all the data will be downloaded from the 
    … …  
    183278          <para>Options:</para> 
    184279 
    185           <itemizedlist> 
    186             <listitem> 
    187               <para><literal>-a</literal> -- compare all locations. </para> 
    188             </listitem> 
    189  
    190             <listitem> 
    191               <para><literal>-l</literal> -- compare one backup location as 
    192               specified in the configuration file. This compares one of the 
    193               top level store directories.</para> 
    194             </listitem> 
    195  
    196             <listitem> 
    197               <para><literal>-c</literal> -- set return code. The return code 
    198               is set to the following values, if <literal>quit</literal> is 
    199               the next command. So, if another command is run after the 
    200               <literal>compare</literal>, the return code will not refer to 
    201               the <literal>compare</literal>. This option is very useful for 
    202               automating compares. Return code values:</para> 
    203  
    204               <itemizedlist> 
    205                 <listitem> 
    206                   <para>1 -- no differences were found</para> 
    207                 </listitem> 
    208  
    209                 <listitem> 
    210                   <para>2 -- differences were found</para> 
    211                 </listitem> 
    212  
    213                 <listitem> 
    214                   <para>3 -- an error occured</para> 
    215                 </listitem> 
    216               </itemizedlist> 
    217             </listitem> 
    218           </itemizedlist> 
    219         </listitem> 
    220  
    221         <listitem> 
    222           <para><literal>get &lt;object-filename&gt; 
    223           [&lt;local-filename&gt;]</literal></para> 
    224  
    225           <para><literal>get -i &lt;object-id&gt; 
    226           &lt;local-filename&gt;</literal></para> 
    227  
     280          <para><variablelist> 
     281              <varlistentry> 
     282                <term><option>-a</option></term> 
     283 
     284                <listitem> 
     285                  <para>compare all locations.</para> 
     286                </listitem> 
     287              </varlistentry> 
     288 
     289              <varlistentry> 
     290                <term><option>-l</option></term> 
     291 
     292                <listitem> 
     293                  <para>compare one backup location as specified in the 
     294                  configuration file. This compares one of the top level store 
     295                  directories.</para> 
     296                </listitem> 
     297              </varlistentry> 
     298 
     299              <varlistentry> 
     300                <term><option>-c</option></term> 
     301 
     302                <listitem> 
     303                  <para>set return code. The return code is set to the 
     304                  following values, if quit is the next command. So, if 
     305                  another command is run after the compare, the return code 
     306                  will not refer to the compare. This option is very useful 
     307                  for automating compares. Return code values:<itemizedlist> 
     308                      <listitem> 
     309                        <para><option>1</option> -- no differences were 
     310                        found</para> 
     311                      </listitem> 
     312 
     313                      <listitem> 
     314                        <para><option>2</option> -- differences were 
     315                        found</para> 
     316                      </listitem> 
     317 
     318                      <listitem> 
     319                        <para><option>3</option> -- an error occured</para> 
     320                      </listitem> 
     321                    </itemizedlist></para> 
     322                </listitem> 
     323              </varlistentry> 
     324            </variablelist></para> 
     325        </listitem> 
     326      </varlistentry> 
     327 
     328      <varlistentry> 
     329        <term><command>get</command> <varname>object-filename</varname> 
     330        <optional>local-filename</optional></term> 
     331 
     332        <listitem> 
     333          <para></para> 
     334        </listitem> 
     335      </varlistentry> 
     336 
     337      <varlistentry> 
     338        <term><command>get -i</command> <varname>object-id</varname> 
     339        <varname>local-filename</varname></term> 
     340 
     341        <listitem> 
    228342          <para>Gets a file from the store. Object is specified as the 
    229343          filename within the current directory. Local filename is optional. 
    … …  
    231345          file to retrieve.</para> 
    232346 
    233           <para>To get an old or deleted file, use the <literal>-i</literal> 
     347          <para>To get an old or deleted file, use the <option>-i</option> 
    234348          option and select the object as a hex object ID (first column in 
    235349          listing). The local filename must be specified.</para> 
    236350        </listitem> 
    237  
    238         <listitem> 
    239           <para><literal>getobject &lt;object-id&gt; 
    240           &lt;local-filename&gt;</literal></para> 
    241  
     351      </varlistentry> 
     352 
     353      <varlistentry> 
     354        <term><command>getobject</command> <varname>object-id</varname> 
     355        <varname>local-filename</varname></term> 
     356 
     357        <listitem> 
    242358          <para>Gets the object specified by the object id (in hex) and stores 
    243           the raw contents in the local file specified. <emphasis 
    244           role="bold">Note</emphasis>: This is only useful for debugging as it 
    245           does not decode files from the stored format, which is encrypted and 
    246           compressed.</para> 
    247         </listitem> 
    248  
    249         <listitem> 
    250           <para><literal>restore [-d] &lt;directory-name&gt; 
    251           &lt;local-directory-name&gt;</literal></para> 
    252  
    253           <para><literal>restore -r</literal></para> 
    254  
     359          the raw contents in the local file specified. Note: This is only 
     360          useful for debugging as it does not decode files from the stored 
     361          format, which is encrypted and compressed.</para> 
     362        </listitem> 
     363      </varlistentry> 
     364 
     365      <varlistentry> 
     366        <term><command>restore</command> <optional>-d</optional> 
     367        <varname>directory-name</varname> 
     368        <varname>local-directory-name</varname></term> 
     369 
     370        <listitem> 
     371          <para></para> 
     372        </listitem> 
     373      </varlistentry> 
     374 
     375      <varlistentry> 
     376        <term><command>restore -r</command></term> 
     377 
     378        <listitem> 
    255379          <para>Restores a directory to the local disc. The local directory 
    256380          specified must not exist (unless a previous restore is being 
    257381          restarted). The root cannot be restored -- restore locations 
    258           individually. </para> 
     382          individually.</para> 
    259383 
    260384          <para>Options:</para> 
    261385 
    262           <itemizedlist> 
    263             <listitem> 
    264               <para><literal>-d</literal> -- restore a deleted 
    265               directory</para> 
    266             </listitem> 
    267  
    268             <listitem> 
    269               <para><literal>-r</literal> -- resume an interrupted 
    270               restore</para> 
    271             </listitem> 
    272           </itemizedlist> 
    273  
    274           <para> If a restore operation is interrupted for any reason, it can 
    275           be restarted using the <literal>-r</literal> switch. Restore 
    276           progress information is saved in a file at regular intervals during 
    277           the restore operation to allow restarts.</para> 
    278         </listitem> 
    279  
    280         <listitem> 
    281           <para>usage</para> 
    282  
     386          <para><variablelist> 
     387              <varlistentry> 
     388                <term><option>-d</option></term> 
     389 
     390                <listitem> 
     391                  <para>restore a deleted directory</para> 
     392                </listitem> 
     393              </varlistentry> 
     394 
     395              <varlistentry> 
     396                <term><option>-r</option></term> 
     397 
     398                <listitem> 
     399                  <para>resume an interrupted restore</para> 
     400                </listitem> 
     401              </varlistentry> 
     402            </variablelist>If a restore operation is interrupted for any 
     403          reason, it can be restarted using the <option>-r</option> switch. 
     404          Restore progress information is saved in a file at regular intervals 
     405          during the restore operation to allow restarts.</para> 
     406        </listitem> 
     407      </varlistentry> 
     408 
     409      <varlistentry> 
     410        <term><command>usage</command></term> 
     411 
     412        <listitem> 
    283413          <para>Show space used on the server for this account. Display 
    284           fields:</para> 
    285  
    286           <itemizedlist> 
    287             <listitem> 
    288               <para><literal>Used</literal>: Total amount of space used on the 
    289               server</para> 
    290             </listitem> 
    291  
    292             <listitem> 
    293               <para><literal>Old files</literal>: Space used by old 
    294               files</para> 
    295             </listitem> 
    296  
    297             <listitem> 
    298               <para><literal>Deleted files</literal>: Space used by deleted 
    299               files</para> 
    300             </listitem> 
    301  
    302             <listitem> 
    303               <para><literal>Directories</literal>: Space used by the 
    304               directory structure</para> 
    305             </listitem> 
    306           </itemizedlist> 
    307  
    308           <para>When Used exceeds the soft limit, the server will start to 
    309           remove old and deleted files until the usage drops below the soft 
    310           limit. After a while, you should expect to see the usage stay at 
    311           just below the soft limit. You only need more space if the space 
    312           used by old and deleted files is near zero.</para> 
    313         </listitem> 
    314       </itemizedlist> 
    315     </refsection> 
    316   </refsection> 
    317  
    318   <refsection> 
    319     <title>Author</title> 
    320  
    321     <para>Ben Summers and contributors. For help, please go to the <ulink 
    322     url="http://www.boxbackup.org/trac/">Wiki</ulink>, or subscribe to the Box 
    323     Backup <ulink 
    324     url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing 
    325     list.</ulink></para> 
    326   </refsection> 
    327  
    328   <refsection> 
    329     <title>See Also</title> 
    330  
    331     <para>bbackupd.conf(5)</para> 
    332   </refsection> 
    333  
    334   <refsection> 
    335     <title>Files</title> 
    336  
    337     <para><literal>bbackupquery</literal> uses the Box Backup client 
    338     configuration file, usually located in 
    339     <filename>/etc/box/bbackupd.conf</filename>. On Windows this file is 
    340     usually located in the installation directory, and is named 
    341     <filename>bbackupd.conf</filename> as well.</para> 
     414          fields:<itemizedlist> 
     415              <listitem> 
     416                <para><property>Used</property>: Total amount of space used on 
     417                the server</para> 
     418              </listitem> 
     419 
     420              <listitem> 
     421                <para><property>Old files</property>: Space used by old 
     422                files</para> 
     423              </listitem> 
     424 
     425              <listitem> 
     426                <para><property>Deleted files</property>: Space used by 
     427                deleted files</para> 
     428              </listitem> 
     429 
     430              <listitem> 
     431                <para><property>Directories</property>: Space used by the 
     432                directory structure</para> 
     433              </listitem> 
     434            </itemizedlist></para> 
     435 
     436          <para>When <property>Used</property> exceeds the soft limit, the 
     437          server will start to remove old and deleted files until the usage 
     438          drops below the soft limit. After a while, you should expect to see 
     439          the usage stay at just below the soft limit. You only need more 
     440          space if the space used by old and deleted files is near 
     441          zero.</para> 
     442        </listitem> 
     443      </varlistentry> 
     444    </variablelist> 
    342445  </refsection> 
    343446 
    … …  
    345448    <title>Bugs</title> 
    346449 
    347     <para>If you find a bug in Box Backup, and you want to let us know about 
    348     it, join the <ulink 
    349     url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing 
    350     list</ulink>, and send a description of the problem there.</para> 
     450    <para>If you find a bug in Box Backup and you want to let us know about 
     451    it, join the <link 
     452    xlink:href="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing 
     453    list</link> and send us a description of the problem there.</para> 
    351454 
    352455    <para>To report a bug, give us at least the following information:</para> 
    … …  
    378481    </itemizedlist> 
    379482  </refsection> 
     483 
     484  <refsection> 
     485    <title>Authors</title> 
     486 
     487    <para><author> 
     488        <personname>Ben Summers</personname> 
     489      </author></para> 
     490 
     491    <para><author> 
     492        <personname>Per Thomsen</personname> 
     493      </author></para> 
     494 
     495    <para><author> 
     496        <personname>James O'Gorman</personname> 
     497      </author></para> 
     498  </refsection> 
    380499</refentry> 

  • box/trunk/documentation/bbstoreaccounts.xml

    r2127 r2305  
    11<?xml version="1.0" encoding="UTF-8"?> 
    2 <refentry> 
     2<refentry version="5.0" xmlns="http://docbook.org/ns/docbook" 
     3          xmlns:xlink="http://www.w3.org/1999/xlink" 
     4          xmlns:xi="http://www.w3.org/2001/XInclude" 
     5          xmlns:svg="http://www.w3.org/2000/svg" 
     6          xmlns:m="http://www.w3.org/1998/Math/MathML" 
     7          xmlns:html="http://www.w3.org/1999/xhtml" 
     8          xmlns:db="http://docbook.org/ns/docbook"> 
    39  <refmeta> 
    410    <refentrytitle>bbstoreaccounts</refentrytitle> 
    511 
    612    <manvolnum>8</manvolnum> 
     13 
     14    <refmiscinfo>Box Backup 0.11</refmiscinfo> 
    715  </refmeta> 
    816 
    … …  
    1018    <refname>bbstoreaccounts</refname> 
    1119 
    12     <refpurpose>View and change account information on the store 
    13     server</refpurpose> 
     20    <refpurpose>Box Backup store accounts manager</refpurpose> 
    1421  </refnamediv> 
    1522 
    1623  <refsynopsisdiv> 
    1724    <cmdsynopsis> 
    18       <command>bbstoreaccounts [-c configfile] command account_id 
    19       [command-specific arguments]</command> 
     25      <command>bbstoreaccounts</command> 
     26 
     27      <arg>-c config-file</arg> 
     28 
     29      <arg choice="plain">command</arg> 
     30 
     31      <arg choice="plain">account-id</arg> 
     32 
     33      <arg>command-specific arguments</arg> 
    2034    </cmdsynopsis> 
    2135  </refsynopsisdiv> 
    … …  
    2438    <title>Description</title> 
    2539 
    26     <para><literal>bbstoreaccounts</literal> is the tool for managing accounts 
     40    <para><command>bbstoreaccounts</command> is the tool for managing accounts 
    2741    on the store server. It can be used to view information related to 
    2842    accounts, as well as create, change and delete accounts on the store 
    29     server. </para> 
    30  
    31     <para><literal>bbstoreaccounts</literal> always takes at least 2 
     43    server.</para> 
     44 
     45    <para><command>bbstoreaccounts</command> always takes at least 2 
    3246    parameters: the command name and the account ID. Some commands require 
    3347    additional parameters, and some commands have optional parameters.</para> 
    … …  
    3650      <title>Options</title> 
    3751 
    38       <para><literal>-c &lt;configfile&gt;</literal></para> 
    39  
    40       <para>The configfile to use for connecting to the store. Default is 
    41       <literal>/etc/box/bbstored.conf</literal>.</para> 
     52      <para><variablelist> 
     53          <varlistentry> 
     54            <term><option>-c config-file</option></term> 
     55 
     56            <listitem> 
     57              <para>The configfile to use for connecting to the store. Default 
     58              is <filename>/etc/box/bbstored.conf</filename>.</para> 
     59            </listitem> 
     60          </varlistentry> 
     61        </variablelist></para> 
    4262    </refsection> 
    4363 
    … …  
    4767      <para>The commands tells bbstoreaccounts what action to perform.</para> 
    4868 
    49       <itemizedlist> 
    50         <listitem> 
    51           <para><literal>check &lt;account-id&gt; [fix]</literal></para> 
    52  
    53           <para>The <literal>check</literal> command verifies the integrity of 
    54           the store account given, and optionally fixes any corruptions. 
    55           <emphasis role="bold">Note</emphasis>: It is recommended to run the 
    56           'simple' check command (without <literal>fix</literal>) before using 
    57           the <literal>fix</literal> option, This gives an overview of the 
    58           extent of any problems, before attempting to fix them.</para> 
    59         </listitem> 
    60  
    61         <listitem> 
    62           <para><literal>create &lt;account-id&gt; &lt;discset&gt; 
    63           &lt;softlimit&gt; &lt;hardlimit&gt;</literal></para> 
    64  
    65           <para>Creates a new store account with the parameters given. The 
    66           parameters are as follows:</para> 
    67  
    68           <itemizedlist> 
    69             <listitem> 
    70               <para><literal>account-id</literal>: the ID of the new account 
    71               to be created. A 32-bit hexadecimal number. Cannot already exist 
    72               on the server.</para> 
    73             </listitem> 
    74  
    75             <listitem> 
    76               <para><literal>discset</literal>: the disc set from 
    77               raidfile.conf(5) where the backups for this client will be 
    78               stored.. A number. Each RAID-file set has a number in 
    79               raidfile.conf. This number is what's used.</para> 
    80             </listitem> 
    81  
    82             <listitem> 
    83               <para><literal>softlimit</literal>: The soft limit is the amount 
    84               of storage that the server will guarantee to be available for 
    85               storage.</para> 
    86             </listitem> 
    87  
    88             <listitem> 
    89               <para><literal>hardlimit</literal>: The amount of storage that 
    90               the the server will allow, before rejecting uploads, and 
    91               starting to eliminate old and deleted files to get back down to 
    92               <literal>softlimit</literal>. </para> 
    93             </listitem> 
    94           </itemizedlist> 
    95         </listitem> 
    96  
    97         <listitem> 
    98           <para><literal>delete &lt;account-id&gt; [yes]</literal></para> 
    99  
    100           <para>Deletes the account from the store server completely. Removes 
    101           all backups and deletes all references to the account in the config 
    102           files.</para> 
    103  
    104           <para><literal>delete</literal> will ask for confirmation from the 
    105           user, when called. Using the <literal>yes</literal> flag, eliminates 
    106           that need. This is useful when deleting accounts from within a 
    107           script or some other automated means.</para> 
    108         </listitem> 
    109  
    110         <listitem> 
    111           <para><literal>info &lt;account-id&gt;</literal></para> 
    112  
    113           <para>Display information about the given account. Example:</para> 
    114  
    115           <programlisting>[root]# bbstoreaccounts info 1 
     69      <para><variablelist> 
     70          <varlistentry> 
     71            <term><command>check</command> <varname>account-id</varname> 
     72            <optional>fix</optional></term> 
     73 
     74            <listitem> 
     75              <para>The <command>check</command> command verifies the 
     76              integrity of the store account given, and optionally fixes any 
     77              corruptions. <emphasis role="bold">Note</emphasis>: It is 
     78              recommended to run the 'simple' check command (without 
     79              <command>fix</command>) before using the <command>fix</command> 
     80              option. This gives an overview of the extent of any problems, 
     81              before attempting to fix them.</para> 
     82            </listitem> 
     83          </varlistentry> 
     84 
     85          <varlistentry> 
     86            <term><command>create</command> <varname>account-id</varname> 
     87            <varname>disc-set</varname> <varname>soft-limit</varname> 
     88            <varname>hard-limit</varname></term> 
     89 
     90            <listitem> 
     91              <para>Creates a new store account with the parameters given. The 
     92              parameters are as follows:</para> 
     93 
     94              <para><variablelist> 
     95                  <varlistentry> 
     96                    <term><option>account-id</option></term> 
     97 
     98                    <listitem> 
     99                      <para>The ID of the new account to be created. A 32-bit 
     100                      hexadecimal number. Cannot already exist on the 
     101                      server.</para> 
     102                    </listitem> 
     103                  </varlistentry> 
     104 
     105                  <varlistentry> 
     106                    <term><option>disc-set</option></term> 
     107 
     108                    <listitem> 
     109                      <para>The disc set from <citerefentry> 
     110                          <refentrytitle>raidfile.conf</refentrytitle> 
     111 
     112                          <manvolnum>5</manvolnum> 
     113                        </citerefentry> where the backups for this client will 
     114                      be stored. A number. Each RAID-file set has a number in 
     115                      raidfile.conf. This number is what's used.</para> 
     116                    </listitem> 
     117                  </varlistentry> 
     118 
     119                  <varlistentry> 
     120                    <term><option>soft-limit</option></term> 
     121 
     122                    <listitem> 
     123                      <para>The soft limit is the amount of storage that the 
     124                      server will guarantee to be available for 
     125                      storage.</para> 
     126                    </listitem> 
     127                  </varlistentry> 
     128 
     129                  <varlistentry> 
     130                    <term><option>hard-limit</option></term> 
     131 
     132                    <listitem> 
     133                      <para>The amount of storage that the the server will 
     134                      allow, before rejecting uploads, and starting to 
     135                      eliminate old and deleted files to get back down to 
     136                      soft-limit.</para> 
     137                    </listitem> 
     138                  </varlistentry> 
     139                </variablelist></para> 
     140            </listitem> 
     141          </varlistentry> 
     142 
     143          <varlistentry> 
     144            <term><command>delete</command> <varname>account-id</varname> 
     145            <optional>yes</optional></term> 
     146 
     147            <listitem> 
     148              <para>Deletes the account from the store server completely. 
     149              Removes all backups and deletes all references to the account in 
     150              the config files.</para> 
     151 
     152              <para><command>delete</command> will ask for confirmation from 
     153              the user, when called. Using the <option>yes</option> flag, 
     154              eliminates that need. This is useful when deleting accounts from 
     155              within a script or some other automated means. 0</para> 
     156            </listitem> 
     157          </varlistentry> 
     158 
     159          <varlistentry> 
     160            <term><command>info</command> <varname>account-id</varname></term> 
     161 
     162            <listitem> 
     163              <para>Display information about the given account. 
     164              Example:<programlisting>[root]# bbstoreaccounts info 1 
    116165                  Account ID: 00000001 
    117166              Last object ID: 58757 
    … …  
    122171            Block soft limit: 11796480 (46080.00Mb) 
    123172            Block hard limit: 13107200 (51200.00Mb) 
    124          Client store marker: 1139559852000000 </programlisting> 
    125  
    126           <para>Explanation:</para> 
    127  
    128           <itemizedlist> 
    129             <listitem> 
    130               <para>Account ID: The account ID being displayed.</para> 
    131             </listitem> 
    132  
    133             <listitem> 
    134               <para>Last Object ID: A counter that keeps track of the objects 
    135               that have been backed up. This number refers to the last file 
    136               that was written to the store. The ID is displayed as a decimal 
    137               number, and the object ID can be converted to a path name to a 
    138               file as follows: convert the number to hex (e.g.: 58757 =&gt; 
    139               0xE585); The last backed up file will be (relative from the 
    140               client's store root): <literal>e5/o85.rfw</literal>. Longer 
    141               numbers infer more directories in the structure, so as an 
    142               example 3952697264 as the last object ID gives 0xEB995FB0, which 
    143               translates to a backup pathname of 
    144               <literal>eb/99/5f/ob0.rfw.</literal></para> 
    145             </listitem> 
    146  
    147             <listitem> 
    148               <para>Blocks used: The number of blocks used by the store. The 
    149               size in Mb depends on the number of blocks, as well as the block 
    150               size for the disc set given in 
    151               <literal>raidfile.conf(5)</literal>. In this case the block size 
    152               is 4096.</para> 
    153             </listitem> 
    154  
    155             <listitem> 
    156               <para>Blocks used by old files: The number of blocks occupied by 
    157               files that have newer versions in the store. This data is at 
    158               risk for being removed during housekeeping.</para> 
    159             </listitem> 
    160  
    161             <listitem> 
    162               <para>Blocks used by deleted files: The number of blocks used by 
    163               files that have been deleted on the client. This data is at 
    164               risk for being removed during housekeeping.</para> 
    165             </listitem> 
    166  
    167             <listitem> 
    168               <para>Blocks used by directories: The number of blocks used by 
    169               directories in the store.</para> 
    170             </listitem> 
    171  
    172             <listitem> 
    173               <para>Block soft limit: The soft limit in blocks. The soft limit 
    174               is the maximum guaranteed storage space available to the 
    175               account. When housekeeping starts, and the old and deleted files 
    176               are removed, they are removed in chronological order (oldest 
    177               first), until the data used is less than the soft limit.</para> 
    178             </listitem> 
    179  
    180             <listitem> 
    181               <para>Block hard limit: The hard limit in blocks. The hard limit 
    182               is the most amount of storage the server will allow in an 
    183               account. Any data above this amount will be rejected. 
    184               Housekeeping will reduce the storage use, so more data can be 
    185               uploaded.</para> 
    186             </listitem> 
    187  
    188             <listitem> 
    189               <para>Client store marker: TODO What exactly is this? </para> 
    190             </listitem> 
    191           </itemizedlist> 
    192         </listitem> 
    193  
    194         <listitem> 
    195           <para><literal>setlimit &lt;account-id&gt; &lt;softlimit&gt; 
    196           &lt;hardlimit&gt;</literal></para> 
    197  
    198           <para>Changes the storage space allocation for the given account. No 
    199           server restart is needed.</para> 
    200  
    201           <para>Parameters:</para> 
    202  
    203           <itemizedlist> 
    204             <listitem> 
    205               <para><literal>account-id</literal>: the ID of the new account 
    206               to be created. A 32-bit hexadecimal number. Cannot already exist 
    207               on the server.</para> 
    208             </listitem> 
    209  
    210             <listitem> 
    211               <para><literal>softlimit</literal>: The soft limit is the amount 
    212               of storage that the server will guarantee to be available for 
    213               storage.</para> 
    214             </listitem> 
    215  
    216             <listitem> 
    217               <para><literal>hardlimit</literal>: The amount of storage that 
    218               the the server will allow, before rejecting uploads, and 
    219               starting to eliminate old and deleted files to get back down to 
    220               <literal>softlimit</literal>.</para> 
    221             </listitem> 
    222           </itemizedlist> 
    223         </listitem> 
    224       </itemizedlist> 
     173         Client store marker: 1139559852000000</programlisting></para> 
     174 
     175              <para>Explanation:</para> 
     176 
     177              <para><variablelist> 
     178                  <varlistentry> 
     179                    <term>Account ID</term> 
     180 
     181                    <listitem> 
     182                      <para>The account ID being displayed.</para> 
     183                    </listitem> 
     184                  </varlistentry> 
     185 
     186                  <varlistentry> 
     187                    <term>Last Object ID</term> 
     188 
     189                    <listitem> 
     190                      <para>A counter that keeps track of the objects that 
     191                      have been backed up. This number refers to the last file 
     192                      that was written to the store. The ID is displayed as a 
     193                      decimal number, and the object ID can be converted to a 
     194                      path name to a file as follows: convert the number to 
     195                      hex (e.g.: 58757 =&gt; 0xE585); The last backed up file 
     196                      will be (relative from the client's store root): 
     197                      <filename>e5/o85.rfw</filename>. Longer numbers infer 
     198                      more directories in the structure, so as an example 
     199                      3952697264 as the last object ID gives 0xEB995FB0, which 
     200                      translates to a backup pathname of 
     201                      <filename>eb/99/5f/ob0.rfw</filename>.</para> 
     202                    </listitem> 
     203                  </varlistentry> 
     204 
     205                  <varlistentry> 
     206                    <term>Blocks used</term> 
     207 
     208                    <listitem> 
     209                      <para>The number of blocks used by the store. The size 
     210                      in Mb depends on the number of blocks, as well as the 
     211                      block size for the disc set given in <citerefentry> 
     212                          <refentrytitle>raidfile.conf</refentrytitle> 
     213 
     214                          <manvolnum>5</manvolnum> 
     215                        </citerefentry>. In this case the block size is 
     216                      4096.</para> 
     217                    </listitem> 
     218                  </varlistentry> 
     219 
     220                  <varlistentry> 
     221                    <term>Blocks used by old files</term> 
     222 
     223                    <listitem> 
     224                      <para>The number of blocks occupied by files that have 
     225                      newer versions in the store. This data is at risk for 
     226                      being removed during housekeeping.</para> 
     227                    </listitem> 
     228                  </varlistentry> 
     229 
     230                  <varlistentry> 
     231                    <term>Blocks used by deleted files</term> 
     232 
     233                    <listitem> 
     234                      <para>The number of blocks used by files that have been 
     235                      deleted on the client. This data is at risk for being 
     236                      removed during housekeeping.</para> 
     237                    </listitem> 
     238                  </varlistentry> 
     239 
     240                  <varlistentry> 
     241                    <term>Blocks used by directories</term> 
     242 
     243                    <listitem> 
     244                      <para>The number of blocks used by directories in the 
     245                      store.</para> 
     246                    </listitem> 
     247                  </varlistentry> 
     248 
     249                  <varlistentry> 
     250                    <term>Block soft limit</term> 
     251 
     252                    <listitem> 
     253                      <para>The soft limit in blocks. The soft limit is the 
     254                      maximum guaranteed storage space available to the 
     255                      account. When housekeeping starts, and the old and 
     256                      deleted files are removed, they are removed in 
     257                      chronological order (oldest first), until the data used 
     258                      is less than the soft limit.</para> 
     259                    </listitem> 
     260                  </varlistentry> 
     261 
     262                  <varlistentry> 
     263                    <term>Block hard limit</term> 
     264 
     265                    <listitem> 
     266                      <para>The hard limit in blocks. The hard limit is the 
     267                      most amount of storage the server will allow in an 
     268                      account. Any data above this amount will be rejected. 
     269                      Housekeeping will reduce the storage use, so more data 
     270                      can be uploaded.</para> 
     271                    </listitem> 
     272                  </varlistentry> 
     273 
     274                  <varlistentry> 
     275                    <term>Client store marker</term> 
     276 
     277                    <listitem> 
     278                      <para><citerefentry> 
     279                          <refentrytitle>bbstored</refentrytitle> 
     280 
     281                          <manvolnum>8</manvolnum> 
     282                        </citerefentry> uses this number to determine if it 
     283                      needs to rescan the entire store. If this number is 
     284                      different from the last time it checked, a rescan will 
     285                      take place.</para> 
     286                    </listitem> 
     287                  </varlistentry> 
     288                </variablelist></para> 
     289            </listitem> 
     290          </varlistentry> 
     291 
     292          <varlistentry> 
     293            <term><command>setlimit</command> <varname>account-id</varname> 
     294            <varname>soft-limit</varname> <varname>hard-limit</varname></term> 
     295 
     296            <listitem> 
     297              <para>Changes the storage space allocation for the given 
     298              account. No server restart is needed.</para> 
     299 
     300              <para>Parameters:</para> 
     301 
     302              <para><variablelist> 
     303                  <varlistentry> 
     304                    <term><option>account-id</option></term> 
     305 
     306                    <listitem> 
     307                      <para>The ID of the account to be modified.</para> 
     308                    </listitem> 
     309                  </varlistentry> 
     310 
     311                  <varlistentry> 
     312                    <term><option>soft-limit</option></term> 
     313 
     314                    <listitem> 
     315                      <para>The soft limit is the amount of storage that the 
     316                      server will guarantee to be available for 
     317                      storage.</para> 
     318                    </listitem> 
     319                  </varlistentry> 
     320 
     321                  <varlistentry> 
     322                    <term><option>hard-limit</option></term> 
     323 
     324                    <listitem> 
     325                      <para>The amount of storage that the the server will 
     326                      allow before rejecting uploads and starting to eliminate 
     327                      old and deleted files to get back down to 
     328                      <option>soft-limit</option>.</para> 
     329                    </listitem> 
     330                  </varlistentry> 
     331                </variablelist></para> 
     332            </listitem> 
     333          </varlistentry> 
     334        </variablelist></para> 
    225335    </refsection> 
    226336  </refsection> 
    227337 
    228338  <refsection> 
    229     <title>Author</title> 
    230  
    231     <para>Ben Summers and contributors. For help, please go to the <ulink 
    232     url="http://www.boxbackup.org/trac/">Wiki</ulink>, or subscribe to the Box 
    233     Backup <ulink 
    234     url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing 
    235     list.</ulink></para> 
     339    <title>Examples</title> 
     340 
     341    <para>Create an account with ID 3af on disc set 0, with a 20GB soft-limit 
     342    and a 22GB hard-limit:<programlisting>bbstoreaccounts create 3af 0 20G 22G</programlisting>Alter 
     343    existing account ID 20 to have a 50GB soft-limit and a 55GB 
     344    hard-limit:<programlisting>bbstoreaccounts setlimit 20 50G 55G</programlisting></para> 
     345  </refsection> 
     346 
     347  <refsection> 
     348    <title>Files</title> 
     349 
     350    <para><filename>/etc/box/bbstored/accounts.txt</filename></para> 
    236351  </refsection> 
    237352 
    … …  
    239354    <title>See Also</title> 
    240355 
    241     <para><literal>bbstored.conf(5)</literal></para> 
    242  
    243     <para><literal>raidfile.conf(5)</literal></para> 
    244   </refsection> 
    245  
    246   <refsection> 
    247     <title>Files</title> 
    248  
    249     <para><literal>bbstoreaccounts</literal> uses the Box Backup server 
    250     configuration file, usually located in 
    251     <filename>/etc/box/bbstored.conf</filename>. </para> 
    252   </refsection> 
    253  
    254   <refsection> 
    255     <title>Bugs</title> 
    256  
    257     <para>If you find a bug in Box Backup, and you want to let us know about 
    258     it, join the <ulink 
    259     url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing 
    260     list</ulink>, and send a description of the problem there.</para> 
    261  
    262     <para>To report a bug, give us at least the following information:</para> 
    263  
    264     <itemizedlist> 
    265       <listitem> 
    266         <para>The version of Box Backup you are running</para> 
    267       </listitem> 
    268  
    269       <listitem> 
    270         <para>The platform you are running on (hardware and OS), for both 
    271         client and server.</para> 
    272       </listitem> 
    273  
    274       <listitem> 
    275         <para>If possible attach your config files (bbstored.conf, 
    276         bbackupd.conf) to the bug report.</para> 
    277       </listitem> 
    278  
    279       <listitem> 
    280         <para>Also attach any log file output that helps shed light on the 
    281         problem you are seeing.</para> 
    282       </listitem> 
    283  
    284       <listitem> 
    285         <para>And last but certainly not least, a description of what you are 
    286         seeing, in as much detail as possible.</para> 
    287       </listitem> 
    288     </itemizedlist> 
     356    <para><citerefentry> 
     357        <refentrytitle>bbstored</refentrytitle> 
     358 
     359        <manvolnum>8</manvolnum> 
     360      </citerefentry>, <citerefentry> 
     361        <refentrytitle>bbstored-config</refentrytitle> 
     362 
     363        <manvolnum>8</manvolnum> 
     364      </citerefentry></para> 
     365  </refsection> 
     366 
     367  <refsection> 
     368    <title>Authors</title> 
     369 
     370    <para><author> 
     371        <personname>Ben Summers</personname> 
     372      </author></para> 
     373 
     374    <para><author> 
     375        <personname>Per Thomsen</personname> 
     376      </author></para> 
     377 
     378    <para><author> 
     379        <personname>James O'Gorman</personname> 
     380      </author></para> 
    289381  </refsection> 
    290382</refentry> 

  • box/trunk/documentation/bbstored-certs.xml

    r2127 r2305  
    11<?xml version="1.0" encoding="UTF-8"?> 
    2 <refentry> 
     2<refentry version="5.0" xmlns="http://docbook.org/ns/docbook" 
     3          xmlns:xlink="http://www.w3.org/1999/xlink" 
     4          xmlns:xi="http://www.w3.org/2001/XInclude" 
     5          xmlns:svg="http://www.w3.org/2000/svg" 
     6          xmlns:m="http://www.w3.org/1998/Math/MathML" 
     7          xmlns:html="http://www.w3.org/1999/xhtml" 
     8          xmlns:db="http://docbook.org/ns/docbook"> 
    39  <refmeta> 
    410    <refentrytitle>bbstored-certs</refentrytitle> 
    511 
    612    <manvolnum>8</manvolnum> 
     13 
     14    <refmiscinfo>Box Backup 0.11</refmiscinfo> 
    715  </refmeta> 
    816 
    … …  
    1523  <refsynopsisdiv> 
    1624    <cmdsynopsis> 
    17       <command>bbstored-certs &lt;certs-dir&gt; &lt;command&gt; 
    18       [&lt;arguments&gt;]</command> 
     25      <command>bbstored-certs</command> 
     26 
     27      <arg choice="plain">certs-dir</arg> 
     28 
     29      <arg choice="plain">command</arg> 
     30 
     31      <arg>arguments</arg> 
    1932    </cmdsynopsis> 
    2033  </refsynopsisdiv> 
    … …  
    2336    <title>Description</title> 
    2437 
    25     <para><literal>bbstored-certs</literal> creates and signs certificates for 
     38    <para><command>bbstored-certs</command> creates and signs certificates for 
    2639    use in Box Backup. It allows the user to create and sign the server keys, 
    2740    as well as signing client keys.</para> 
    2841 
    29     <para>All commands must be followed by the <literal>certs-dir</literal>, 
     42    <para>All commands must be followed by the <varname>certs-dir</varname>, 
    3043    which is the directory in which the certificates are stored.</para> 
    3144 
    … …  
    3548      <para>There are 3 commands:</para> 
    3649 
    37       <itemizedlist> 
    38         <listitem> 
    39           <para><literal>init</literal>: Create the 
    40           <literal>certs-dir</literal>, and generate the server keys for 
    41           bbstored. <literal>certs-dir</literal> cannot exist before running 
    42           the command.</para> 
    43         </listitem> 
     50      <variablelist> 
     51        <varlistentry> 
     52          <term><command>init</command></term> 
    4453 
    45         <listitem> 
    46           <para><literal>sign-server &lt;servercsrfile&gt;</literal>: Sign the 
    47           server certificate. The <literal>servercsrfile</literal> is the file 
    48           generated by the <literal>init</literal> command.</para> 
    49         </listitem> 
     54          <listitem> 
     55            <para>Create the <varname>certs-dir</varname>, and generate the 
     56            server keys for bbstored. <varname>certs-dir</varname> cannot 
     57            exist before running the command.</para> 
     58          </listitem> 
     59        </varlistentry> 
    5060 
    51         <listitem> 
    52           <para><literal>sign &lt;clientcsrfile&gt;</literal>: Sign a client 
    53           certificate. The <literal>clientcsrfile</literal> is generated 
    54           during client setup. See <literal>bbackupd-config(8)</literal>. Send 
    55           the signed certificate back to the client, and install according to 
    56           the instructions given by <literal>bbackupd-config</literal>.</para> 
    57         </listitem> 
    58       </itemizedlist> 
     61        <varlistentry> 
     62          <term><command>sign-server</command> 
     63          <varname>servercsrfile</varname></term> 
     64 
     65          <listitem> 
     66            <para>Sign the server certificate. The 
     67            <varname>servercsrfile</varname> is the file generated by the 
     68            <command>init</command> command.</para> 
     69          </listitem> 
     70        </varlistentry> 
     71 
     72        <varlistentry> 
     73          <term><command>sign</command> 
     74          <varname>clientcsrfile</varname></term> 
     75 
     76          <listitem> 
     77            <para>Sign a client certificate. The 
     78            <varname>clientcsrfile</varname> is generated during client setup. 
     79            See <citerefentry> 
     80                <refentrytitle>bbackupd-config</refentrytitle> 
     81 
     82                <manvolnum>8</manvolnum> 
     83              </citerefentry>. Send the signed certificate back to the client, 
     84            and install according to the instructions given by 
     85            <command>bbackupd-config</command>.</para> 
     86          </listitem> 
     87        </varlistentry> 
     88      </variablelist> 
    5989    </refsection> 
    60   </refsection> 
    61  
    62   <refsection> 
    63     <title>Author</title> 
    64  
    65     <para>Ben Summers and contributors. For help, please go to the <ulink 
    66     url="http://www.boxbackup.org/trac/">Wiki</ulink>, or subscribe to the Box 
    67     Backup <ulink 
    68     url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing 
    69     list.</ulink></para> 
    70   </refsection> 
    71  
    72   <refsection> 
    73     <title>See Also</title> 
    74  
    75     <para><literal>bbstored-config(8)</literal></para> 
    76  
    77     <para><literal>bbstored.conf(5)</literal></para> 
    78  
    79     <para><literal>bbstoreaccounts(8)</literal></para> 
    8090  </refsection> 
    8191 
    … …  
    8393    <title>Files</title> 
    8494 
    85     <para><literal>raidfile-config</literal> generates the raidfile.conf(5) 
    86     file.</para> 
     95    <para><citerefentry> 
     96        <refentrytitle>raidfile-config</refentrytitle> 
     97 
     98        <manvolnum>8</manvolnum> 
     99      </citerefentry> generates the <citerefentry> 
     100        <refentrytitle>raidfile.conf</refentrytitle> 
     101 
     102        <manvolnum>5</manvolnum> 
     103      </citerefentry> file.</para> 
    87104  </refsection> 
    88105 
    … …  
    123140    </itemizedlist> 
    124141  </refsection> 
     142 
     143  <refsection> 
     144    <title>See Also</title> 
     145 
     146    <para><citerefentry> 
     147        <refentrytitle>bbstored-config</refentrytitle> 
     148 
     149        <manvolnum>8</manvolnum> 
     150      </citerefentry>, <citerefentry> 
     151        <refentrytitle>bbstored.conf</refentrytitle> 
     152 
     153        <manvolnum>5</manvolnum> 
     154      </citerefentry>, <citerefentry> 
     155        <refentrytitle>bbstoreaccounts</refentrytitle> 
     156 
     157        <manvolnum>8</manvolnum> 
     158      </citerefentry></para> 
     159  </refsection> 
     160 
     161  <refsection> 
     162    <title>Authors</title> 
     163 
     164    <para><author> 
     165        <personname>Ben Summers</personname> 
     166      </author></para> 
     167 
     168    <para><author> 
     169        <personname>Per Thomsen</personname> 
     170      </author></para> 
     171 
     172    <para><author> 
     173        <personname>James O'Gorman</personname> 
     174      </author></para> 
     175  </refsection> 
    125176</refentry> 

  • box/trunk/documentation/bbstored-config.xml

    r2127 r2305  
    11<?xml version="1.0" encoding="UTF-8"?> 
    2 <refentry> 
     2<refentry version="5.0" xmlns="http://docbook.org/ns/docbook" 
     3          xmlns:xlink="http://www.w3.org/1999/xlink" 
     4          xmlns:xi="http://www.w3.org/2001/XInclude" 
     5          xmlns:svg="http://www.w3.org/2000/svg" 
     6          xmlns:m="http://www.w3.org/1998/Math/MathML" 
     7          xmlns:html="http://www.w3.org/1999/xhtml" 
     8          xmlns:db="http://docbook.org/ns/docbook"> 
    39  <refmeta> 
    410    <refentrytitle>bbstored-config</refentrytitle> 
    511 
    612    <manvolnum>8</manvolnum> 
     13 
     14    <refmiscinfo>Box Backup 0.11</refmiscinfo> 
    715  </refmeta> 
    816 
    … …  
    1018    <refname>bbstored-config</refname> 
    1119 
    12     <refpurpose>Create config files for bbstored</refpurpose> 
     20    <refpurpose>Box Backup store daemon configuration file 
     21    generator</refpurpose> 
    1322  </refnamediv> 
    1423 
    1524  <refsynopsisdiv> 
    1625    <cmdsynopsis> 
    17       <command>bbstored-config &lt;configdir&gt; &lt;servername&gt; 
    18       &lt;username&gt;</command> 
     26      <command>bbstored-config</command> 
     27 
     28      <arg choice="plain">configdir</arg> 
     29 
     30      <arg choice="plain">servername</arg> 
     31 
     32      <arg choice="plain">username</arg> 
    1933    </cmdsynopsis> 
    2034  </refsynopsisdiv> 
    … …  
    2337    <title>Description</title> 
    2438 
    25     <para>The <literal>bbstored-config</literal> script creates config files 
    26     and server certificates for a bbstored instance. It takes three 
    27     parameters:</para> 
     39    <para>The bbstored-config script creates configuration files and server 
     40    certificates for a bbstored instance. It takes three parameters</para> 
     41 
     42    <variablelist> 
     43      <varlistentry> 
     44        <term>configdir</term> 
     45 
     46        <listitem> 
     47          <para>The directory where config files will reside. A 
     48          <filename>bbstored</filename> subdirectory will be created where 
     49          several config files will reside. The 
     50          <filename>bbstored.conf</filename> file will be created in 
     51          <varname>configdir</varname>.</para> 
     52        </listitem> 
     53      </varlistentry> 
     54 
     55      <varlistentry> 
     56        <term>servername</term> 
     57 
     58        <listitem> 
     59          <para>The name of the server that is being configured. Usually the 
     60          fully qualified domain name of the machine in question.</para> 
     61        </listitem> 
     62      </varlistentry> 
     63 
     64      <varlistentry> 
     65        <term>username</term> 
     66 
     67        <listitem> 
     68          <para>The name of the user that should be running the 
     69          <command>bbstored</command> process. Recommended name: 
     70          _bbstored.</para> 
     71        </listitem> 
     72      </varlistentry> 
     73    </variablelist> 
     74 
     75    <para>A valid <citerefentry> 
     76        <refentrytitle>raidfile.conf</refentrytitle> 
     77 
     78        <manvolnum>5</manvolnum> 
     79      </citerefentry> must be found in configdir. Several steps are taken 
     80    during the run of <command>bbstored-config</command>:</para> 
    2881 
    2982    <itemizedlist> 
    30       <listitem> 
    31         <para><literal>configdir</literal>: The directory where config files 
    32         will reside. A subdirectory bbstored will be created, where several 
    33         config files will reside. the <literal>bbstored.conf</literal> file 
    34         will be created in <literal>configdir</literal>.</para> 
    35       </listitem> 
    36  
    37       <listitem> 
    38         <para><literal>servername</literal>: The name of the server that is 
    39         being configured. Usually the fully qualified domain name of the 
    40         machine in question.</para> 
    41       </listitem> 
    42  
    43       <listitem> 
    44         <para><literal>username</literal>: The name of the user that should be 
    45         running the bbstored processes. Recommended name: 
    46         _<literal>bbstored.</literal></para> 
    47       </listitem> 
    48     </itemizedlist> 
    49  
    50     <para>A valid raidfile.conf(5) must be found in configdir. Several steps 
    51     are taken during the run of bbstored-config:</para> 
    52  
    53     <itemizedlist> 
    54       <listitem> 
    55         <para>Configuration files are created.</para> 
    56       </listitem> 
    57  
    5883      <listitem> 
    5984        <para>Server certificates are created. This requires interaction from 
    … …  
    6287 
    6388      <listitem> 
    64         <para>The raid volumes are checked, to ensure that the configuration 
    65         is consistent, and will work.</para> 
     89        <para>The RAID volumes are checked to ensure that the configuration is 
     90        consistent and will work.</para> 
    6691      </listitem> 
    6792 
    … …  
    75100 
    76101  <refsection> 
    77     <title>Author</title> 
     102    <title>Files</title> 
    78103 
    79     <para>Ben Summers and contributors. For help, please go to the <ulink 
    80     url="http://www.boxbackup.org/trac/">Wiki</ulink>, or subscribe to the Box 
    81     Backup <ulink 
    82     url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing 
    83     list.</ulink></para> 
     104    <para><filename>/etc/box/bbstored.conf</filename></para> 
    84105  </refsection> 
    85106 
    … …  
    87108    <title>See Also</title> 
    88109 
    89     <para><literal>raidfile-config(8)</literal></para> 
     110    <para><citerefentry> 
     111        <refentrytitle>bbstored.conf</refentrytitle> 
    90112 
    91     <para><literal>bbstored.conf(5)</literal></para> 
     113        <manvolnum>5</manvolnum> 
     114      </citerefentry>, <citerefentry> 
     115        <refentrytitle>bbstored</refentrytitle> 
    92116 
    93     <para><literal>raidfile.conf(5)</literal></para> 
     117        <manvolnum>8</manvolnum> 
     118      </citerefentry>, <citerefentry> 
     119        <refentrytitle>bbstored-certs</refentrytitle> 
     120 
     121        <manvolnum>8</manvolnum> 
     122      </citerefentry>, <citerefentry> 
     123        <refentrytitle>raidfile-config</refentrytitle> 
     124 
     125        <manvolnum>8</manvolnum> 
     126      </citerefentry></para> 
    94127  </refsection> 
    95128 
    96129  <refsection> 
    97     <title>Files</title> 
     130    <title>Authors</title> 
    98131 
    99     <para><literal>bbstoreaccounts</literal> uses the Box Backup server 
    100     configuration file, usually located in 
    101     <filename>/etc/box/bbstored.conf</filename>.</para> 
    102   </refsection> 
     132    <para><author> 
     133        <personname>Ben Summers</personname> 
     134      </author></para> 
    103135 
    104   <refsection> 
    105     <title>Bugs</title> 
     136    <para><author> 
     137        <personname>Per Thomsen</personname> 
     138      </author></para> 
    106139 
    107     <para>If you find a bug in Box Backup, and you want to let us know about 
    108     it, join the <ulink 
    109     url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing 
    110     list</ulink>, and send a description of the problem there.</para> 
    111  
    112     <para>To report a bug, give us at least the following information:</para> 
    113  
    114     <itemizedlist> 
    115       <listitem> 
    116         <para>The version of Box Backup you are running</para> 
    117       </listitem> 
    118  
    119       <listitem> 
    120         <para>The platform you are running on (hardware and OS), for both 
    121         client and server.</para> 
    122       </listitem> 
    123  
    124       <listitem> 
    125         <para>If possible attach your config files (bbstored.conf, 
    126         bbackupd.conf) to the bug report.</para> 
    127       </listitem> 
    128  
    129       <listitem> 
    130         <para>Also attach any log file output that helps shed light on the 
    131         problem you are seeing.</para> 
    132       </listitem> 
    133  
    134       <listitem> 
    135         <para>And last but certainly not least, a description of what you are 
    136         seeing, in as much detail as possible.</para> 
    137       </listitem> 
    138     </itemizedlist> 
     140    <para><author> 
     141        <personname>James O'Gorman</personname> 
     142      </author></para> 
    139143  </refsection> 
    140144</refentry> 

  • box/trunk/documentation/raidfile-config.xml

    r2127 r2305  
    11<?xml version="1.0" encoding="UTF-8"?> 
    2 <refentry> 
     2<refentry version="5.0" xmlns="http://docbook.org/ns/docbook" 
     3          xmlns:xlink="http://www.w3.org/1999/xlink" 
     4          xmlns:xi="http://www.w3.org/2001/XInclude" 
     5          xmlns:svg="http://www.w3.org/2000/svg" 
     6          xmlns:m="http://www.w3.org/1998/Math/MathML" 
     7          xmlns:html="http://www.w3.org/1999/xhtml" 
     8          xmlns:db="http://docbook.org/ns/docbook"> 
    39  <refmeta> 
    410    <refentrytitle>raidfile-config</refentrytitle> 
    511 
    612    <manvolnum>8</manvolnum> 
     13 
     14    <refmiscinfo>Box Backup 0.11</refmiscinfo> 
    715  </refmeta> 
    816 
    … …  
    1523  <refsynopsisdiv> 
    1624    <cmdsynopsis> 
    17       <command>raidfile-config &lt;configdir&gt; &lt;blocksize&gt; 
    18       &lt;dir1&gt; [&lt;dir2&gt; &lt;dir3&gt;]</command> 
     25      <command>raidfile-config</command> 
     26 
     27      <arg choice="plain">config-dir</arg> 
     28 
     29      <arg choice="plain">blocksize</arg> 
     30 
     31      <arg choice="plain">dir1 <arg>dir2 <arg>dir3</arg></arg></arg> 
    1932    </cmdsynopsis> 
    2033  </refsynopsisdiv> 
    … …  
    2841    3 and only 3 'drives' are supported. You can read more about RAID5 (and 
    2942    other RAID-levels) <ulink 
    30     url="http://en.wikipedia.org/wiki/Redundant_array_of_independent_disks#RAID_5">here</ulink>. 
    31     </para> 
     43    url="http://en.wikipedia.org/wiki/Redundant_array_of_independent_disks#RAID_5">here</ulink>.</para> 
    3244 
    3345    <refsection> 
    … …  
    3648      <para>The parameters are as follows:</para> 
    3749 
    38       <itemizedlist> 
    39         <listitem> 
    40           <para><literal>configdir</literal>: The directory path where 
    41           configuration files are located. Usually this is 
    42           <literal>/etc/box</literal>. <literal>raidfile.conf</literal> will 
    43           be written in this directory.</para> 
    44         </listitem> 
     50      <variablelist> 
     51        <varlistentry> 
     52          <term><varname>config-dir</varname></term> 
    4553 
    46         <listitem> 
    47           <para><literal>blocksize</literal>: The block size used for file 
    48           storage in the system, in bytes. Using a multiple of the file system 
    49           block size is a good strategy. Depending on the size of the files 
    50           you will be backing up, this multiple varies. Of course it also 
    51           depends on the native block size of your file system.</para> 
    52         </listitem> 
     54          <listitem> 
     55            <para>The directory path where configuration files are located. 
     56            Usually this is <filename>/etc/box</filename>. 
     57            <filename>raidfile.conf</filename> will be written in this 
     58            directory.</para> 
     59          </listitem> 
     60        </varlistentry> 
    5361 
    54         <listitem> 
    55           <para><literal>dir1</literal>: The first directory in the built-in 
    56           RAID array.</para> 
    57         </listitem> 
     62        <varlistentry> 
     63          <term><varname>blocksize</varname></term> 
    5864 
    59         <listitem> 
    60           <para><literal>dir2</literal>: The second directory in the built-in 
    61           RAID array. If you are not using the built-in RAID functionality, 
    62           this field should be ignored. You should not use the built-in RAID, 
    63           when you have a hardware RAID solution, or if you're using another 
    64           type of software RAID (like md on Linux).</para> 
    65         </listitem> 
     65          <listitem> 
     66            <para>The block size used for file storage in the system, in 
     67            bytes. Using a multiple of the file system block size is a good 
     68            strategy. Depending on the size of the files you will be backing 
     69            up, this multiple varies. Of course it also depends on the native 
     70            block size of your file system.</para> 
     71          </listitem> 
     72        </varlistentry> 
    6673 
    67         <listitem> 
    68           <para><literal>dir3</literal>: The third directory in the built-in 
    69           RAID array. The same notes that apply to <literal>dir2</literal> 
    70           also apply to <literal>dir3</literal>.</para> 
    71         </listitem> 
    72       </itemizedlist> 
     74        <varlistentry> 
     75          <term><varname>dir1</varname></term> 
     76 
     77          <listitem> 
     78            <para>The first directory in the built-in RAID array.</para> 
     79          </listitem> 
     80        </varlistentry> 
     81 
     82        <varlistentry> 
     83          <term><varname>dir2</varname></term> 
     84 
     85          <listitem> 
     86            <para>The second directory in the built-in RAID array. If you are 
     87            not using the built-in RAID functionality, this field should be 
     88            ignored. You should not use the built-in RAID if you have a 
     89            hardware RAID solution or if you're using another type of software 
     90            RAID (like md on Linux).</para> 
     91          </listitem> 
     92        </varlistentry> 
     93 
     94        <varlistentry> 
     95          <term><varname>dir3</varname></term> 
     96 
     97          <listitem> 
     98            <para>The third directory in the built-in RAID array. The same 
     99            notes that apply to <varname>dir2</varname> also apply to 
     100            <varname>dir3</varname>.</para> 
     101          </listitem> 
     102        </varlistentry> 
     103      </variablelist> 
    73104 
    74105      <para>Note that there are currently no way to add multiple disk sets to 
    75       the raidfile.conf file using command line tools, etc. See 
    76       raidfile.conf(5) for details on adding more disks</para> 
     106      the raidfile.conf file using command line tools, etc. See <citerefentry> 
     107          <refentrytitle>raidfile.conf</refentrytitle> 
     108 
     109          <manvolnum>5</manvolnum> 
     110        </citerefentry> for details on adding more disks.</para> 
    77111    </refsection> 
    78   </refsection> 
    79  
    80   <refsection> 
    81     <title>Author</title> 
    82  
    83     <para>Ben Summers and contributors. For help, please go to the <ulink 
    84     url="http://www.boxbackup.org/trac/">Wiki</ulink>, or subscribe to the Box 
    85     Backup <ulink 
    86     url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing 
    87     list.</ulink></para> 
    88   </refsection> 
    89  
    90   <refsection> 
    91     <title>See Also</title> 
    92  
    93     <para><literal>bbstored-config(8)</literal></para> 
    94  
    95     <para><literal>bbstored.conf(5)</literal></para> 
    96  
    97     <para><literal>raidfile.conf(5)</literal></para> 
    98   </refsection> 
    99  
    100   <refsection> 
    101     <title>Files</title> 
    102  
    103     <para><literal>raidfile-config</literal> generates the raidfile.conf(5) 
    104     file.</para> 
    105112  </refsection> 
    106113 
    … …  
    141148    </itemizedlist> 
    142149  </refsection> 
     150 
     151  <refsection> 
     152    <title>Files</title> 
     153 
     154    <para><command>raidfile-config</command> generates the <citerefentry> 
     155        <refentrytitle>raidfile.conf</refentrytitle> 
     156 
     157        <manvolnum>5</manvolnum> 
     158      </citerefentry> file.</para> 
     159  </refsection> 
     160 
     161  <refsection> 
     162    <title>See Also</title> 
     163 
     164    <para><citerefentry> 
     165        <refentrytitle>bbstored-config</refentrytitle> 
     166 
     167        <manvolnum>8</manvolnum> 
     168      </citerefentry>, <citerefentry> 
     169        <refentrytitle>bbstored.conf</refentrytitle> 
     170 
     171        <manvolnum>5</manvolnum> 
     172      </citerefentry>, <citerefentry> 
     173        <refentrytitle>raidfile.conf</refentrytitle> 
     174 
     175        <manvolnum>5</manvolnum> 
     176      </citerefentry></para> 
     177  </refsection> 
     178 
     179  <refsection> 
     180    <title>Authors</title> 
     181 
     182    <para><author> 
     183        <personname>Ben Summers</personname> 
     184      </author></para> 
     185 
     186    <para><author> 
     187        <personname>Per Thomsen</personname> 
     188      </author></para> 
     189 
     190    <para><author> 
     191        <personname>James O'Gorman</personname> 
     192      </author></para> 
     193  </refsection> 
    143194</refentry> 
Note: See TracChangeset for help on using the changeset viewer.