"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
[
<!-- entities files to use -->
- <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
+ <!ENTITY % global_entities SYSTEM 'global.entities'>
%global_entities;
]>
<!-- body begins here -->
<refsect1><title>DESCRIPTION</title>
-<para>This manual page gives an overview of the &A; commands and
+<para>This manual page gives an overview of the Amanda commands and
configuration files for quick reference.</para>
<!--
-->
<refsect2><title>COMMANDS</title> <!-- a.k.a. any section 8 manpage -->
-<para>Here are all the &A; commands. Each one has its own manual page. See them for all the gory details.</para>
+<para>Here are all the Amanda commands. Each one has its own manual page. See them for all the gory details.</para>
<itemizedlist>
<listitem>
-<citerefentry><refentrytitle>amaddclient</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amaddclient" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amadmin</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amadmin" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amaespipe</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amaespipe" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amarchiver" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amcheckdb</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amcheck" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amcheckdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amcheckdb" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amcleanup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amcheckdump" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amcrypt-ossl-asym</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amcleanup" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amcrypt-ossl</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amcrypt-ossl-asym" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amcrypt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amcrypt-ossl" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amcryptsimple</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amcrypt" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amdd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amcryptsimple" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amdevcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amdevcheck" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amdump" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amfetchdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amfetchdump" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amflush</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amflush" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amgetconf</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amgetconf" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amgpgcrypt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amgpgcrypt" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amgtar</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amgtar" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amlabel</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amlabel" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>ammt</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amoverview" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amoverview</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="ampgsql" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amplot</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amplot" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amrecover</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amraw" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amreport</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amrecover" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amreport" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amrmtape</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amrestore" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amsamba</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amrmtape" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amserverconfig</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amsamba" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amservice</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amserverconfig" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amstar</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amservice" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amstatus</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amstar" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amtape</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amstatus" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amtapetype</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amsuntar" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amtoc</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amtape" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amvault</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amtapetype" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amzfs-sendrecv</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amtoc" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amzfs-snapshot</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amvault" vol="8"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>script-email</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<manref name="amzfs-sendrecv" vol="8"/>,
+</listitem>
+<listitem>
+<manref name="amzfs-snapshot" vol="8"/>,
+</listitem>
+<listitem>
+<manref name="script-email" vol="8"/>,
</listitem>
</itemizedlist>
</refsect2>
<refsect2><title>CONFIGURATION FILES</title> <!-- a.k.a. most section 5 manpages -->
<itemizedlist>
<listitem>
-<citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+<manref name="amanda.conf" vol="5"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amanda-client.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+<manref name="amanda-client.conf" vol="5"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>disklist</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+<manref name="disklist" vol="5"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>tapelist</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+<manref name="tapelist" vol="5"/>,
</listitem>
</itemizedlist>
</refsect2>
<refsect2><title>DATA FORMATS</title> <!-- a.k.a. section 5 manpages about internal data formats -->
<itemizedlist>
<listitem>
-<citerefentry><refentrytitle>amanda-archive-format</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+<manref name="amanda-archive-format" vol="5"/>,
</listitem>
</itemizedlist>
</refsect2>
<refsect2><title>CONCEPTS</title> <!-- a.k.a. any section 7 manpage -->
<itemizedlist>
<listitem>
-<citerefentry><refentrytitle>amanda-applications</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+<manref name="amanda-applications" vol="7"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amanda-auth</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+<manref name="amanda-auth" vol="7"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amanda-changers</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+<manref name="amanda-changers" vol="7"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amanda-devices</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+<manref name="amanda-compatibility" vol="7"/>,
</listitem>
<listitem>
-<citerefentry><refentrytitle>amanda-scripts</refentrytitle><manvolnum>7</manvolnum></citerefentry>,
+<manref name="amanda-devices" vol="7"/>,
+</listitem>
+<listitem>
+<manref name="amanda-scripts" vol="7"/>,
+</listitem>
+<listitem>
+<manref name="amanda-taperscan" vol="7"/>,
</listitem>
</itemizedlist>
</refsect2>
</refsect1>
<refsect1><title>CONFIGURATION</title>
-<para>There are four user-editable files that control the behavior of &A;.
+<para>There are four user-editable files that control the behavior of Amanda.
</para>
<para>
The first two are &amconf; and &amclientconf;,
the main configuration files for the server and client, respectively.
-They contain parameters to customize &A; for the site.
+They contain parameters to customize Amanda for the site.
</para>
<para>
Next is the &disklist; file, which lists hosts and disk partitions to back up.
file, which lists tapes that are currently active.
These files are described in more detail in the following sections.</para>
-<para>All files are stored in individual configuration
+<para>All configuration files are stored in individual configuration
directories, usually under <filename>/etc/amanda/</filename>.
A site will often have more than
one configuration.
The configuration files would be stored under directories
<filename>/etc/amanda/normal/</filename> and
<filename>/etc/amanda/archive/</filename>, respectively.
-Part of the job of an &A; administrator is to create,
+Part of the job of an Amanda administrator is to create,
populate and maintain these directories.</para>
+
+<para>Most Amanda applications take a "config" parameter; this is generally the
+(unqualified) name of the configuration directory, e.g.,
+<filename>normal</filename>. If the parameter is <filename>.</filename> (dot),
+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 &A; go in corresponding
+<para>All log and database files generated by Amanda go in corresponding
directories somewhere.
The exact location is controlled by entries in
-<citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>.
+<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
</para>
<para>As log files are no longer needed (no longer contain relevant information),
-&A; cycles them out in various ways, depending on the type of file.</para>
+Amanda cycles them out in various ways, depending on the type of file.</para>
<para>Detailed information about
<command>amdump</command>
parameter below)
named
<emphasis remap='B'>oldlog</emphasis>.
-It is up to the &A; administrator to remove them from this
+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
<refsect1><title>Using Samba</title>
-<para>For Samba access, &A; needs a file on the Samba server (which may
+<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 &A;.
+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.
//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 &A;-user on the Samba server. </para>
+It only needs to be readable by the Amanda-user on the Samba server. </para>
</refsect1>
<refsect1><title>HOST & DISK EXPRESSION</title>
<para>All host and disk arguments to programs are special expressions.
-The command applies to all disks that match your arguments.
+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
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'>
<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>
<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'>
</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>
projects / debian / amanda / blobdiff