source: box/trunk/docs/docbook/raidfile.conf.xml @ 2474

<?xml version="1.0" encoding="UTF-8"?>
<refentry version="5.0" xmlns="http://docbook.org/ns/docbook"
          xmlns:xlink="http://www.w3.org/1999/xlink"
          xmlns:xi="http://www.w3.org/2001/XInclude"
          xmlns:svg="http://www.w3.org/2000/svg"
          xmlns:m="http://www.w3.org/1998/Math/MathML"
          xmlns:html="http://www.w3.org/1999/xhtml"
          xmlns:db="http://docbook.org/ns/docbook">
  <refmeta>
    <refentrytitle>raidfile.conf</refentrytitle>

    <manvolnum>5</manvolnum>

    <refmiscinfo class="manual">Box Backup</refmiscinfo>

    <refmiscinfo class="source">Box Backup</refmiscinfo>

    <refmiscinfo class="version">0.11</refmiscinfo>
  </refmeta>

  <refnamediv>
    <refname>raidfile.conf</refname>

    <refpurpose>Userland RAID for Box Backup</refpurpose>
  </refnamediv>

  <refsynopsisdiv>
    <cmdsynopsis>
      <command>/etc/box/raidfile.conf</command>
    </cmdsynopsis>
  </refsynopsisdiv>

  <refsection>
    <title>Description</title>

    <para>The raidfile.conf is usually generated by <citerefentry>
        <refentrytitle>raidfile-config</refentrytitle>

        <manvolnum>8</manvolnum>
      </citerefentry> but may be manually edited if the store locations move
    or if more than one disc set is required.</para>

    <para><variablelist>
        <varlistentry>
          <term>disc<varname>X</varname></term>

          <listitem>
            <para>Specifies a set of discs.</para>

            <para><variablelist>
                <varlistentry>
                  <term><varname>SetNumber</varname></term>

                  <listitem>
                    <para>The set number of the RAID disc, referenced by each
                    account.</para>
                  </listitem>
                </varlistentry>

                <varlistentry>
                  <term><varname>BlockSize</varname></term>

                  <listitem>
                    <para>The block size of the file system (usually 2048).
                    Under BSD with FFS, set this to your file system's
                    fragment size (most likely an 8th of the block
                    size).</para>
                  </listitem>
                </varlistentry>

                <varlistentry>
                  <term><varname>Dir0</varname></term>

                  <listitem>
                    <para>The first directory in the RAID array.</para>
                  </listitem>
                </varlistentry>

                <varlistentry>
                  <term><varname>Dir1</varname></term>

                  <listitem>
                    <para>The second directory in the RAID array. If you do
                    not wish to use the built-in RAID functionality, this
                    field should be set to the same as
                    <varname>Dir0</varname>. You should not use the built-in
                    RAID if you have a hardware RAID solution or if you're
                    using another type of software RAID (like md on
                    Linux).</para>
                  </listitem>
                </varlistentry>

                <varlistentry>
                  <term><varname>Dir2</varname></term>

                  <listitem>
                    <para>The third directory in the RAID array. The same
                    notes that apply to <varname>Dir2</varname> also apply to
                    <varname>Dir3</varname>.</para>
                  </listitem>
                </varlistentry>
              </variablelist></para>
          </listitem>
        </varlistentry>
      </variablelist></para>
  </refsection>

  <refsection>
    <title>Files</title>

    <para><filename>/etc/box/raidfile.conf</filename></para>
  </refsection>

  <refsection>
    <title>See Also</title>

    <para><citerefentry>
        <refentrytitle>raidfile-config</refentrytitle>

        <manvolnum>8</manvolnum>
      </citerefentry>, <citerefentry>
        <refentrytitle>bbstored.conf</refentrytitle>

        <manvolnum>5</manvolnum>
      </citerefentry></para>
  </refsection>

  <refsection>
    <title>Authors</title>

    <para><author>
        <personname>Ben Summers</personname>
      </author></para>

    <para><author>
        <personname>Per Thomsen</personname>
      </author></para>

    <para><author>
        <personname>James O'Gorman</personname>
      </author></para>
  </refsection>
</refentry>