Imported Upstream version 3.2.0
[debian/amanda] / man / xml-source / amanda.8.xml
index 1337822e33273c5e35134ff90afe509d530e046e..7162c175c1f38bc9a7df8235a772421e87e9695b 100644 (file)
@@ -205,6 +205,9 @@ configuration files for quick reference.</para>
 <manref name="amanda-devices" vol="7"/>,
 </listitem>
 <listitem>
+<manref name="amanda-match" vol="7"/>,
+</listitem>
+<listitem>
 <manref name="amanda-scripts" vol="7"/>,
 </listitem>
 <listitem>
@@ -214,7 +217,7 @@ configuration files for quick reference.</para>
 </refsect2>
 </refsect1>
 
-<refsect1><title>CONFIGURATION</title>
+<refsect1><title>CONFIGURATION FILES</title>
 <para>There are four user-editable files that control the behavior of Amanda.
 </para>
 <para>
@@ -251,371 +254,7 @@ populate and maintain these directories.</para>
 the current directory is used.  This feature is present for backward
 compatibility, but is not commonly used.</para>
 
-</refsect1>
-
-<refsect1><title>LOG FILES</title>
-<para>All log and database files generated by Amanda go in corresponding
-directories somewhere.
-The exact location is controlled by entries in
-<manref name="amanda.conf" vol="5"/>.
-A typical location would be under <filename>/var/adm/amanda</filename>.
-For the above example, the files might go in
-<filename>/var/adm/amanda/normal/</filename> and
-<filename>/var/adm/amanda/archive/</filename>.
-</para>
-
-<para>As log files are no longer needed (no longer contain relevant information),
-Amanda cycles them out in various ways, depending on the type of file.</para>
-
-<para>Detailed information about
-<command>amdump</command>
-runs are stored in dump logs -- files named
-<emphasis remap='B'>amdump.</emphasis><emphasis remap='I'>NN</emphasis>
-where
-<emphasis remap='I'>NN</emphasis>
-is a sequence number, with 1 being the most recent file.
-<emphasis remap='B'>Amdump</emphasis>
-rotates these files each run, keeping roughly the last
-<emphasis remap='B'>tapecycle</emphasis>
-(see below)
-worth of them.</para>
-
-<para>The file used by
-<emphasis remap='B'>amreport</emphasis>
-to generate the mail summary is the trace log.  This file constitutes the "catalog"
-describing the data on the tapes written in a run.  It is named
-<emphasis remap='B'>log.</emphasis><emphasis remap='I'>YYYYMMDDHHMMSS.NN</emphasis>
-where
-<emphasis remap='I'>YYYYMMDDHHMMSS</emphasis>
-is the datestamp of the start of the
-<command>amdump</command> or <command>amflush</command>
-run and
-<emphasis remap='I'>NN</emphasis>
-is a sequence number started at 0.
-At the end of each
-<command>amdump</command>
-run,
-log files for runs whose tapes have been reused are renamed
-into a subdirectory of the main log directory (see the
-<emphasis remap='B'>logdir</emphasis>
-parameter below)
-named
-<emphasis remap='B'>oldlog</emphasis>.
-It is up to the Amanda administrator to remove them from this
-directory when desired.</para>
-
-<para>Index (backup image catalogue) files older than the full dump
-matching the oldest backup image for a given client and disk
-are removed by
-<command>amdump</command>
-at the end of each run.</para>
-</refsect1>
-
-
-<refsect1><title>Using Samba</title>
-<para>For Samba access, Amanda needs a file on the Samba server (which may
-or may not also be the tape server) named
-<filename>/etc/amandapass</filename>
-with share names, (clear text) passwords and (optional) domain names,
-in that order, one per line, whitespace separated.
-By default, the user used to connect to the PC is the same for all
-PC's and is compiled into Amanda.
-It may be changed on a host by host basis
-by listing it first in the password field followed
-by a percent sign and then the password.
-For instance:</para>
-<programlisting>
-  //some-pc/home normalpw
-  //another-pc/disk otheruser%otherpw
-</programlisting>
-<para>With clear text passwords, this file should obviously be tightly protected.
-It only needs to be readable by the Amanda-user on the Samba server.  </para>
-</refsect1>
-
-<refsect1><title>HOST &amp; DISK EXPRESSION</title>
-<para>All host and disk arguments to programs are special expressions.
-The command applies to all DLEs that match the arguments.
-This section describes the matcher.</para>
-
-<para>The matcher matches by word, each word is a glob expression, words
-are separated by the separator '.' for host and '/' for disk. You
-can anchor the expression at left with a '^'. You can
-anchor the expression at right with a '$'. The matcher
-is case insensitive for host but is case sensitive for disk. A match
-succeeds if all words in your expression match contiguous words in 
-the host or disk.</para>
-
-<para>If the disk is a UNC ("\\windows\share") then all '\' are converted to '/' before the match.  Using '\' is complicated because of the extra quoting required by the shell and amanda. It's easier to use '/' because it require less quoting ("//windows/share")</para>
-
-<variablelist remap='TP'>
-
-    <varlistentry>
-    <term>dot (.)</term> <!-- troff gets confused by a plain dot -->
-    <listitem><para>word separator for a host</para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>/</term>
-    <listitem><para>word separator for a disk</para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>\</term>
-    <listitem><para>word separator for a UNC disk</para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>^</term>
-    <listitem><para>anchor at left</para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>$</term>
-    <listitem><para>anchor at right</para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>?</term>
-    <listitem><para>match exactly one character except the separator</para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>*</term>
-    <listitem><para>match zero or more characters except the separator</para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>**</term>
-    <listitem><para>match zero or more characters including the separator</para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>[...]</term>
-    <listitem><para>match a single character, namely any of the characters
-        enclosed  by the brackets.</para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>[!...]</term>
-    <listitem><para>match a single character, namely any characters that is not
-         enclosed by the brackets.</para></listitem>
-    </varlistentry>
-
-</variablelist>
-
-<para>The shell interpret some of these characters, they must be escaped by a backslash '\' and/or the expression must be enclosed in simple or double quote.</para>
-
-<para>Some examples:</para>
-
-<variablelist remap='TP'>
-    <varlistentry>
-    <term>hosta</term>
-    <listitem><para>
-    Will match <filename>hosta</filename>, <filename>foo.hosta.org</filename>, and
-    <filename>hoSTA.dOMAIna.ORG</filename> but not <filename>hostb</filename>.
-    </para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>host</term>
-    <listitem><para>
-    Will match <filename>host</filename> but not <filename>hosta</filename>.
-    </para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>host?</term>
-    <listitem><para>
-    Will match <filename>hosta</filename> and <filename>hostb</filename>, but
-    not <filename>host</filename>.
-    </para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>ho*na</term>
-    <listitem><para>
-    Will match <filename>hoina</filename>
-    but not <filename>ho.aina.org</filename>.
-    </para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>ho**na</term>
-    <listitem><para>
-    Will match <filename>hoina</filename>
-    and <filename>ho.aina.org</filename>.
-    </para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>^hosta</term>
-    <listitem><para>
-    Will match <filename>hosta</filename>
-    but not <filename>foo.hosta.org</filename>.
-    </para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>sda*</term>
-    <listitem><para>
-    Will match <filename>/dev/sda1</filename>
-    and <filename>/dev/sda12</filename>.
-    </para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>/opt</term>
-    <listitem><para>
-    Will match the disk <filename>opt</filename>
-    but not the host <filename>opt</filename>.
-    </para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>(note dots:) .opt.</term> <!-- nroff gets confused by dots -->
-    <listitem><para>
-    Will match the host <filename>opt</filename>
-    but not the disk <filename>opt</filename>.
-    </para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>/</term>
-    <listitem><para>
-    Will match the disk <filename>/</filename>
-    but no other disk.
-    </para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>/usr</term>
-    <listitem><para>
-    Will match the disks <filename>/usr</filename>
-    and <filename>/usr/local</filename>.
-    </para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>/usr$</term>
-    <listitem><para>
-    Will match the disks <filename>/usr</filename>
-    but not <filename>/usr/local</filename>.
-    </para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>share</term>
-    <listitem><para>
-    Will match the disks <filename>\\windows1\share</filename> and <filename>\\windows2\share</filename>.
-    </para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>share*</term>
-    <listitem><para>
-    Will match the disks <filename>\\windows\share1</filename> and <filename>\\windows\share2</filename>.
-    </para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>//windows/share</term>
-    <listitem><para>
-    Will match the disk <filename>\\windows\share</filename>.
-    </para></listitem>
-    </varlistentry>
-
-</variablelist>
-
-
-</refsect1>
-
-<refsect1><title>DATESTAMP EXPRESSION</title>
-<para>A
-<emphasis remap='I'>datestamp</emphasis>
-expression is a range expression where we only match the prefix.
-Leading ^ is removed. Trailing $ forces an exact match.</para>
-
-<variablelist remap="TP">
-
-    <varlistentry>
-    <term>20001212-14</term>
-    <listitem><para>match all dates beginning with 20001212, 20001213 or 20001214</para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>20001212-4</term>
-    <listitem><para>same as previous</para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>20001212-24</term>
-    <listitem><para>match all dates between 20001212 and 20001224</para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>2000121</term>
-    <listitem><para>match all dates that start with 2000121 (20001210-20001219)</para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>2</term>
-    <listitem><para>match all dates that start with 2 (20000101-29991231)</para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>2000-10</term>
-    <listitem><para>match all dates between 20000101-20101231</para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>200010$</term>
-    <listitem><para>match only 200010</para></listitem>
-    </varlistentry>
-
-</variablelist>
-
-</refsect1>
-
-<refsect1><title>DUMP SPECIFICATIONS</title> <para>A dump
-specification selects one or more dumps.  It has the form <emphasis
-remap="I">[host][:disk][@datestamp]</emphasis>, where each component
-is a pattern as described above.  If a component is missing, it
-is treated as a wildcard.  The characters ':', '@', and '\' may be
-escaped within any component by preceding them with a '\'.</para>
-
-<para>Some examples:</para>
-
-<variablelist remap='TP'>
-    <varlistentry>
-    <term>client17</term>
-    <listitem><para>all dumps of client17</para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>@20080615</term>
-    <listitem><para>All dumps on with datestamps matching 20080615</para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>webserver:/var/www</term>
-    <listitem><para>All dumps of /var/www on host webserver</para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>webserver:/var/www@200806150317</term>
-    <listitem><para>The dump of webserver with datestamp 200806150317</para></listitem>
-    </varlistentry>
-
-    <varlistentry>
-    <term>:/var/www</term>
-    <listitem><para>All dumps of /var/www on any host</para></listitem>
-    </varlistentry>
-</variablelist>
-
-
-</refsect1>
-
-<refsect1><title>CONFIGURATION OVERRIDE</title>
+<refsect2><title>Configuration Override</title>
 <para>Most commands allow the override of specific
 configuration options on the command line, using the <arg
 choice="plain">-o</arg> option.  This option has the form <arg
@@ -656,6 +295,8 @@ amdump -otapedev=/dev/nst1 -otpchanger=''
 </programlisting>
 </para>
 
+</refsect2>
+
 </refsect1>
 
 </refentry>