X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Fxml-source%2Fdisklist.5.xml;fp=man%2Fxml-source%2Fdisklist.5.xml;h=110d4402279a72191873d91dac40fc95a41e16e7;hb=2627875b7d18858bc1f9f7652811e4d8c15a23eb;hp=0000000000000000000000000000000000000000;hpb=fb2bd066c2f8b34addafe48d62550e3033a59431;p=debian%2Famanda

diff --git a/man/xml-source/disklist.5.xml b/man/xml-source/disklist.5.xml
new file mode 100644
index 0000000..110d440
--- /dev/null
+++ b/man/xml-source/disklist.5.xml
@@ -0,0 +1,176 @@
+<?xml version="1.0" encoding="ISO-8859-1"?>
+<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
+                   "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
+[
+  <!-- entities files to use -->
+  <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
+  %global_entities;
+]>
+
+<refentry id='disklist.5'>
+
+<refmeta>
+<refentrytitle>disklist</refentrytitle>
+<manvolnum>5</manvolnum>
+&rmi.source;
+&rmi.version;
+&rmi.manual.5;
+</refmeta>
+<refnamediv>
+<refname>disklist</refname>
+<refpurpose>List of partitions to back up for &A;</refpurpose>
+</refnamediv>
+<refentryinfo>
+&author.jds;
+&author.sgw.xml;
+&author.dustin;
+</refentryinfo>
+<!-- body begins here -->
+
+<refsect1><title>DESCRIPTION</title>
+<para>The
+<emphasis remap='I'>disklist</emphasis>
+file determines which disks will be backed up by &A;.
+The file usually contains one line per disk:</para>
+
+<programlisting>
+<emphasis>hostname diskname</emphasis> [<emphasis>diskdevice</emphasis>] <emphasis>dumptype</emphasis> [<emphasis>spindle</emphasis> [<emphasis>interface</emphasis>] ]
+</programlisting>
+
+<para>All pairs [ <emphasis>hostname diskname</emphasis> ] must be unique.</para>
+
+<para>Lines starting with # are ignored, as are blank lines.
+The fields have the following meanings:</para>
+<variablelist remap='TP'>
+  <varlistentry>
+  <term><emphasis remap='I'>hostname</emphasis></term>
+  <listitem>
+<para>The name of the host to be backed up.
+If
+<emphasis remap='B'>diskdevice</emphasis>
+refers to a PC share, this is the host &A; will run the Samba
+<emphasis remap='B'>smbclient</emphasis> program on to back up the share.</para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><emphasis remap='I'>diskname</emphasis></term>
+  <listitem>
+<para>The name of the disk (a label).
+In most case, you set your
+<emphasis remap='B'>diskname</emphasis>
+to the
+<emphasis remap='B'>diskdevice</emphasis>
+and you don't set the
+<emphasis remap='B'>diskdevice.</emphasis>
+If you want multiple entries with the same
+<emphasis remap='B'>diskdevice</emphasis>,
+you must set a different
+<emphasis remap='B'>diskname</emphasis>
+for each entry. It's the
+<emphasis remap='B'>diskname</emphasis>
+that you use on the commandline for any &A; command.
+Look at the example/disklist file for example.</para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><emphasis remap='I'>diskdevice</emphasis></term>
+  <listitem>
+<para>Default: same as diskname.
+The name of the disk device to be backed up. It may be a full device name,
+a device name without the
+<filename>/dev/</filename>
+prefix, e.g.
+<emphasis remap='I'>sd0a</emphasis>,
+or a mount point such as
+<filename>/usr</filename>.</para>
+
+<para>It may also refer to a PC share by starting the name with two (forward) slashes, e.g.
+<filename>//some-pc/home</filename>.
+In this case, the
+<emphasis remap='B'>program</emphasis>
+option in the associated
+<emphasis remap='B'>dumptype</emphasis>
+must be entered as
+<emphasis remap='B'>GNUTAR</emphasis>.
+It is the combination of the double slash disk name and
+<emphasis remap='B'>program GNUTAR</emphasis>
+in the
+<emphasis remap='B'>dumptype</emphasis>
+that triggers the use of Samba.</para>
+</listitem>
+</varlistentry>
+
+  <varlistentry>
+  <term><emphasis remap='I'>dumptype</emphasis></term>
+  <listitem>
+<para>Refers to a
+<emphasis remap='B'>dumptype</emphasis>
+defined in the
+<emphasis remap='B'>amanda.conf</emphasis>
+file.
+<emphasis remap='I'>Dumptype</emphasis>s
+specify backup related parameters,
+such as whether to compress the backups,
+whether to record backup results in
+<filename>/etc/dumpdates</filename>, the disk's relative priority, etc.</para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><emphasis remap='I'>spindle</emphasis></term>
+  <listitem>
+<para>Default:
+<option>-1</option>.
+A number used to balance backup load on a host.
+&A; will not run multiple backups at the same time
+on the same spindle, unless the spindle number is -1,
+which means there is no spindle restriction.</para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><emphasis remap='I'>interface</emphasis></term>
+  <listitem>
+<para>Default:
+<emphasis remap='I'>local</emphasis>.
+The name of a network interface definition in the
+<emphasis remap='B'>amanda.conf</emphasis>
+file, used to balance network load.</para>
+  </listitem>
+  </varlistentry>
+</variablelist>
+
+<para>Instead of naming a
+<emphasis remap='B'>dumptype</emphasis>,
+it is possible to define one in-line, enclosing
+<emphasis remap='B'>dumptype</emphasis>
+options within curly braces, one per line, just like a
+<emphasis remap='B'>dumptype</emphasis>
+definition in
+<emphasis remap='B'>amanda.conf</emphasis>.
+Since pre-existing
+<emphasis remap='B'>dumptype</emphasis>s
+are valid option names, this syntax may be used to customize
+<emphasis remap='B'>dumptype</emphasis>s
+for particular disks.</para>
+
+<para>A line break
+<emphasis remap='B'>must</emphasis>
+follow the left curly bracket.</para>
+
+<para>For instance, if a
+<emphasis remap='B'>dumptype</emphasis>
+named
+<emphasis remap='I'>normal</emphasis>
+is used for most disks, but use of the holding disk needs to be disabled
+for the file system that holds it, this would work instead of defining
+a new dumptype:</para>
+
+<programlisting>
+<emphasis remap='I'>hostname diskname</emphasis> [ <emphasis remap='I'>diskdevice</emphasis> ] {
+  normal
+  holdingdisk never
+} [ <emphasis remap='I'>spindle</emphasis> [ <emphasis remap='I'>interface</emphasis> ] ]
+</programlisting>
+
+</refsect1>
+
+</refentry>