Ignore:
Timestamp:
01/10/2008 00:28:57 (4 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.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • 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.