diff options
Diffstat (limited to 'docs/docbook/raidfile-config.xml')
| -rw-r--r-- | docs/docbook/raidfile-config.xml | 198 |
1 files changed, 198 insertions, 0 deletions
diff --git a/docs/docbook/raidfile-config.xml b/docs/docbook/raidfile-config.xml new file mode 100644 index 00000000..78a3e94c --- /dev/null +++ b/docs/docbook/raidfile-config.xml @@ -0,0 +1,198 @@ +<?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-config</refentrytitle> + + <manvolnum>8</manvolnum> + + <refmiscinfo class="manual">Box Backup</refmiscinfo> + + <refmiscinfo class="source">Box Backup</refmiscinfo> + + <refmiscinfo class="version">0.11</refmiscinfo> + </refmeta> + + <refnamediv> + <refname>raidfile-config</refname> + + <refpurpose>Configure Box Backup's RAID files</refpurpose> + </refnamediv> + + <refsynopsisdiv> + <cmdsynopsis> + <command>raidfile-config</command> + + <arg choice="plain">config-dir</arg> + + <arg choice="plain">blocksize</arg> + + <arg choice="plain">dir1 <arg>dir2 <arg>dir3</arg></arg></arg> + </cmdsynopsis> + </refsynopsisdiv> + + <refsection> + <title>Description</title> + + <para>raidfile-config creates a raidfile.conf file for Box Backup. This + file holds information about the directories used to store backups in. Box + Backup supports userland RAID, in a restricted RAID5 configuration, where + 3 and only 3 'drives' are supported. You can read more about RAID5 (and + other RAID-levels) <ulink + url="http://en.wikipedia.org/wiki/Redundant_array_of_independent_disks#RAID_5">here</ulink>.</para> + + <refsection> + <title>Parameters</title> + + <para>The parameters are as follows:</para> + + <variablelist> + <varlistentry> + <term><varname>config-dir</varname></term> + + <listitem> + <para>The directory path where configuration files are located. + Usually this is <filename>/etc/box</filename>. + <filename>raidfile.conf</filename> will be written in this + directory.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>blocksize</varname></term> + + <listitem> + <para>The block size used for file storage in the system, in + bytes. Using a multiple of the file system block size is a good + strategy. Depending on the size of the files you will be backing + up, this multiple varies. Of course it also depends on the native + block size of your file system.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>dir1</varname></term> + + <listitem> + <para>The first directory in the built-in RAID array.</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>dir2</varname></term> + + <listitem> + <para>The second directory in the built-in RAID array. If you are + not using the built-in RAID functionality, this field should be + ignored. You should not use the built-in RAID if you have a + hardware RAID solution or if you're using another type of software + RAID (like md on Linux).</para> + </listitem> + </varlistentry> + + <varlistentry> + <term><varname>dir3</varname></term> + + <listitem> + <para>The third directory in the built-in RAID array. The same + notes that apply to <varname>dir2</varname> also apply to + <varname>dir3</varname>.</para> + </listitem> + </varlistentry> + </variablelist> + + <para>Note that there are currently no way to add multiple disk sets to + the raidfile.conf file using command line tools, etc. See <citerefentry> + <refentrytitle>raidfile.conf</refentrytitle> + + <manvolnum>5</manvolnum> + </citerefentry> for details on adding more disks.</para> + </refsection> + </refsection> + + <refsection> + <title>Bugs</title> + + <para>If you find a bug in Box Backup, and you want to let us know about + it, join the <ulink + url="http://lists.warhead.org.uk/mailman/listinfo/boxbackup">mailing + list</ulink>, and send a description of the problem there.</para> + + <para>To report a bug, give us at least the following information:</para> + + <itemizedlist> + <listitem> + <para>The version of Box Backup you are running</para> + </listitem> + + <listitem> + <para>The platform you are running on (hardware and OS), for both + client and server.</para> + </listitem> + + <listitem> + <para>If possible attach your config files (bbstored.conf, + bbackupd.conf) to the bug report.</para> + </listitem> + + <listitem> + <para>Also attach any log file output that helps shed light on the + problem you are seeing.</para> + </listitem> + + <listitem> + <para>And last but certainly not least, a description of what you are + seeing, in as much detail as possible.</para> + </listitem> + </itemizedlist> + </refsection> + + <refsection> + <title>Files</title> + + <para><command>raidfile-config</command> generates the <citerefentry> + <refentrytitle>raidfile.conf</refentrytitle> + + <manvolnum>5</manvolnum> + </citerefentry> file.</para> + </refsection> + + <refsection> + <title>See Also</title> + + <para><citerefentry> + <refentrytitle>bbstored-config</refentrytitle> + + <manvolnum>8</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>bbstored.conf</refentrytitle> + + <manvolnum>5</manvolnum> + </citerefentry>, <citerefentry> + <refentrytitle>raidfile.conf</refentrytitle> + + <manvolnum>5</manvolnum> + </citerefentry></para> + </refsection> + + <refsection> + <title>Authors</title> + + <para><author> + <personname>Ben Summers</personname> + </author></para> + + <para><author> + <personname>Per Thomsen</personname> + </author></para> + + <para><author> + <personname>James O'Gorman</personname> + </author></para> + </refsection> +</refentry> |