Imported Upstream version 2.6.0
[debian/amanda] / man / xml-source / amanda.8.xml
index 493bb74797296cbce4722f125b71ac5f8f637cc1..677d3d8e92a15d6b8e6ad8c4d3e7d499f16d7c12 100644 (file)
 </cmdsynopsis>
 
 <cmdsynopsis>
-    <command>amverify</command>
+    <command>amcheckdump</command>
+    <arg choice='opt'><replaceable>options</replaceable></arg>
     <arg choice='plain'><replaceable>config</replaceable></arg>
     <sbr/>
 </cmdsynopsis>
 
 <cmdsynopsis>
-  <command>amverifyrun</command>    
+    <command>amserverconfig</command>
+    <arg choice='opt'><replaceable>options</replaceable></arg>
     <arg choice='plain'><replaceable>config</replaceable></arg>
+    <sbr/>
 </cmdsynopsis>
 
+<cmdsynopsis>
+    <command>amaddclient</command>
+    <arg choice='plain'><replaceable>config</replaceable></arg>
+    <arg choice='opt'><replaceable>options</replaceable></arg>
+    <sbr/>
+</cmdsynopsis>
 </refsynopsisdiv>
 
 
@@ -320,9 +329,21 @@ ejecting tapes and scanning the tape storage slots.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
-  <term><emphasis remap='B'>amverify</emphasis></term>
+  <term><emphasis remap='B'>amcheckdump</emphasis></term>
+  <listitem>
+<para>Check the results of an &A; dump.</para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><emphasis remap='B'>amserverconfig</emphasis></term>
+  <listitem>
+<para>Program to setup initial &A; configuration.</para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><emphasis remap='B'>amaddclient</emphasis></term>
   <listitem>
-<para>Check &A; backup tapes for errors.</para>
+<para>Program to add client to an existing &A; configuration.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
@@ -629,7 +650,7 @@ a new dumptype:</para>
 <programlisting>
 <emphasis remap='I'>hostname diskname</emphasis> [ <emphasis remap='I'>diskdevice</emphasis> ] {
   normal
-  holdingdisk no
+  holdingdisk never
 } [ <emphasis remap='I'>spindle</emphasis> [ <emphasis remap='I'>interface</emphasis> ] ]
 </programlisting>
 
@@ -705,7 +726,7 @@ Entering
 </programlisting>
 is really a short hand for
 <programlisting>tapedev tape:/dev/rmt/0mn
-</programlisting>.</para>
+</programlisting></para>
   </listitem>
   </varlistentry>
   <varlistentry>
@@ -728,11 +749,13 @@ value from the associated
 <emphasis remap='B'>tapetype</emphasis>
 is used to limit the amount of data written. When the limit is reached, the driver will simulate end of tape.</para>
 
-<note>This driver should only be used for debugging and testing,
+<note><para>This driver should only be used for debugging and testing,
 and probably only with the
 <emphasis remap='B'>record</emphasis>
 option set to
-<emphasis remap='I'>no</emphasis>.</note>
+<emphasis remap='I'>no</emphasis>.
+</para>
+</note>
   </listitem>
   </varlistentry>
 
@@ -871,7 +894,9 @@ file is:</para>
 <para><emphasis remap='I'>hostname</emphasis>
 [
 <emphasis remap='I'>username</emphasis>
-]</para>
+[
+<emphasis remap='I'>service</emphasis>
+]*]</para>
 
 <para>If
 <emphasis remap='I'>username</emphasis>
@@ -882,6 +907,15 @@ i.e. the user listed in the
 or
 <emphasis remap='B'>xinetd</emphasis>
 configuration file.</para>
+<para>The <emphasis remap='I'>service</emphasis> is a list of the service the client is authorized to execute:
+<emphasis remap='B'>amdump</emphasis>,
+<emphasis remap='B'>noop</emphasis>,
+<emphasis remap='B'>selfcheck</emphasis>,
+<emphasis remap='B'>sendsize</emphasis>,
+<emphasis remap='B'>sendbackup</emphasis>,
+<emphasis remap='B'>amindexd</emphasis>,
+<emphasis remap='B'>amidxtaped</emphasis>.
+<emphasis remap='B'>amdump</emphasis> is a shortcut for "noop selfcheck sendsize sendbackup"</para>
   </listitem>
   </varlistentry>
   <varlistentry>
@@ -905,14 +939,12 @@ 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>
-
+  //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 &A;-user on the Samba server.  </para>
 <para>You can find further information in the
 <emphasis remap='B'>docs/SAMBA</emphasis>
 <!-- TODO: edit link -->
@@ -937,40 +969,172 @@ succeeds if all words in your expression match contiguous words in
 the host or disk.</para>
 
 
-<literallayout remap='.nf'>
-.      word separator for a host
-/      word separator for a disk
-^      anchor at left
-$      anchor at right
-?      match exactly one character except the separator
-*      match zero or more characters except the separator
-**     match zero or more characters including the separator
-</literallayout>
+<informaltable frame="none">
+<tgroup cols="2" align="left">
+<tbody>
+
+<row>
+<entry>.  </entry>
+<entry>word separator for a host</entry>
+</row>
 
+<row>
+<entry>/</entry>
+<entry>word separator for a disk</entry>
+</row>
+
+<row>
+<entry>^</entry>
+<entry>anchor at left</entry>
+</row>
+
+<row>
+<entry>$</entry>
+<entry>anchor at right</entry>
+</row>
+
+<row>
+<entry>?</entry>
+<entry>match exactly one character except the separator</entry>
+</row>
+
+<row>
+<entry>*</entry>
+<entry>match zero or more characters except the separator</entry>
+</row>
+
+<row>
+<entry>**</entry>
+<entry>match zero or more characters including the separator</entry>
+</row>
+
+</tbody>
+</tgroup>
+</informaltable>
 
 <para>Some examples:</para>
 
-<literallayout remap='.nf'>
-EXPRESSION     WILL MATCH           WILL NOT MATCH
-hosta          hosta                hostb
-               hoSTA.dOMAIna.ORG 
-               foo.hosta.org 
-host           host                 hosta
-host?          hosta                host
-               hostb 
-ho*na          hoina                ho.aina.org
-ho**na         hoina 
-               ho.aina.org 
-^hosta         hosta                foo.hosta.org
-sda*           /dev/sda1 
-               /dev/sda12 
-/opt/          opt (disk)           opt (host)
-.opt.          opt (host)           opt (disk)
-/              /                    any other disk
-/usr           /usr 
-               /usr/opt 
-/usr$          /usr                 /usr/opt
-</literallayout>
+<informaltable frame="none">
+<tgroup cols="3" align="left">
+<tbody>
+
+<row>
+<entry>EXPRESSION  </entry>
+<entry>WILL MATCH</entry>
+<entry>WILL NOT MATCH</entry>
+</row>
+
+<row>
+<entry>hosta</entry>
+<entry>hosta</entry>
+<entry>hostb</entry>
+</row>
+
+<row>
+<entry></entry>
+<entry>hoSTA.dOMAIna.ORG</entry>
+<entry></entry>
+</row>
+
+<row>
+<entry></entry>
+<entry>foo.hosta.org</entry>
+<entry></entry>
+</row>
+
+<row>
+<entry>host</entry>
+<entry>host</entry>
+<entry>hosta</entry>
+</row>
+
+<row>
+<entry>host?</entry>
+<entry>hosta</entry>
+<entry>host</entry>
+</row>
+
+<row>
+<entry></entry>
+<entry>hostb</entry>
+<entry></entry>
+</row>
+
+<row>
+<entry>ho*na</entry>
+<entry>hoina</entry>
+<entry>ho.aina.org</entry>
+</row>
+
+<row>
+<entry>ho**na</entry>
+<entry>hoina</entry>
+<entry></entry>
+</row>
+
+<row>
+<entry></entry>
+<entry>ho.aina.org</entry>
+<entry></entry>
+</row>
+
+<row>
+<entry>^hosta</entry>
+<entry>hosta</entry>
+<entry>foo.hosta.org</entry>
+</row>
+
+<row>
+<entry>sda*</entry>
+<entry>/dev/sda1</entry>
+<entry></entry>
+</row>
+
+<row>
+<entry></entry>
+<entry>/dev/sda12</entry>
+<entry></entry>
+</row>
+
+<row>
+<entry>/opt</entry>
+<entry>opt (disk)</entry>
+<entry>opt (host)</entry>
+</row>
+
+<row>
+<entry>.opt.</entry>
+<entry>opt (host)</entry>
+<entry>opt (disk)</entry>
+</row>
+
+<row>
+<entry>/</entry>
+<entry>/</entry>
+<entry>any other disk</entry>
+</row>
+
+<row>
+<entry>/usr</entry>
+<entry>/usr</entry>
+<entry></entry>
+</row>
+
+<row>
+<entry></entry>
+<entry>/usr/opt</entry>
+<entry></entry>
+</row>
+
+<row>
+<entry>/usr$</entry>
+<entry>/usr</entry>
+<entry>/usr/opt</entry>
+</row>
+
+</tbody>
+</tgroup>
+</informaltable>
 
 
 </refsect1>
@@ -982,7 +1146,7 @@ expression is a range expression where we only match the prefix.
 Leading ^ is removed. Trailing $ forces an exact match.</para>
 
 <informaltable frame="all">
-<tgroup cols="2" alignment="left">
+<tgroup cols="2" align="left">
 <tbody>
 
 <row>
@@ -1027,6 +1191,92 @@ Leading ^ is removed. Trailing $ forces an exact match.</para>
 
 </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>
+
+<informaltable frame="none">
+<tgroup cols="2" align="left">
+<tbody>
+
+<row>
+<entry>DUMPSPEC</entry>
+<entry>DESCRIPTION</entry>
+</row>
+
+<row>
+<entry>client17</entry>
+<entry>all dumps of client17</entry>
+</row>
+
+<row>
+<entry>@20080615</entry>
+<entry>All dumps on with datestamps matching 20080615</entry>
+</row>
+
+<row>
+<entry>webserver:/var/www</entry>
+<entry>All dumps of /var/www on host webserver</entry>
+</row>
+
+<row>
+<entry>webserver:/var/www@200806150317</entry>
+<entry>The dump of webserver with datestamp 200806150317</entry>
+</row>
+
+<row>
+<entry>:/var/www</entry>
+<entry>All dumps of /var/www on any host</entry>
+</row>
+
+</tbody>
+</tgroup>
+</informaltable>
+
+
+</refsect1>
+
+<refsect1><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
+choice="plain">-o</arg><replaceable>name</replaceable>=<replaceable>value</replaceable>.
+An optional space is allowed after the <arg choice="plain">-o</arg>.
+Each configuration option should be specified in a separate
+command-line option.</para>
+
+<para>For global options, <replaceable>name</replaceable> is simply the name of the option, e.g.,
+<programlisting>
+amdump -oruntapes=2
+</programlisting>
+For options in a named section of the configuration, <replaceable>name</replaceable> has the
+form <replaceable>SECTION</replaceable>:<replaceable>section_name</replaceable>:<replaceable>name</replaceable>,
+where <replaceable>SECTION</replaceable> is one of TAPETYPE, DUMPTYPE, HOLDINGDISK, or INTERFACE, and
+<replaceable>section_name</replaceable> is the name of the tapetype, dumptype, holdingdisk, or interface.
+Examples:
+<programlisting>
+amdump -o TAPETYPE:HP-DAT:length=2000m
+amdump -o DUMPTYPE:no-compress:compress="server fast"
+amdump -o HOLDINGDISK:hd1:use="-100 mb"
+amdump -o INTERFACE:local:use="2000 kbps"
+</programlisting>
+</para>
+
+<para>Note that configuration overrides are not effective for tape
+changers, which supply a tapedev based on their own configuration.  In order to
+override <emphasis remap="I">tapedev</emphasis>, you must also disable any changer:
+<programlisting>
+amdump -otapedev=/dev/nst1 -otpchanger=''
+</programlisting>
+</para>
+
+</refsect1>
+
 <refsect1><title>AUTHOR</title>
 <para>James da Silva, &email.jds; : Original text</para>
 <para>&maintainer.sgw;: XML-conversion, major update</para>
@@ -1036,6 +1286,7 @@ Leading ^ is removed. Trailing $ forces an exact match.</para>
 <para>
 <citerefentry><refentrytitle>amadmin</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>amanda.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>amanda-client.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>amcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>amcheckdb</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>amcleanup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
@@ -1056,8 +1307,10 @@ Leading ^ is removed. Trailing $ forces an exact match.</para>
 <citerefentry><refentrytitle>amtape</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>amtapetype</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>amtoc</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amverify</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amverifyrun</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>
+<citerefentry><refentrytitle>amcheckdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>amserverconfig</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>amaddclient</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+<citerefentry><refentrytitle>http://wiki.zmanda.com</refentrytitle></citerefentry></para>
 </refsect1>
 </refentry>