Imported Upstream version 2.6.0

[debian/amanda] / man / xml-source / amanda.8.xml

diff --git a/man/xml-source/amanda.8.xml b/man/xml-source/amanda.8.xml
index a30c086108ebd8e03da92ba40b77fe5141bb9a58..677d3d8e92a15d6b8e6ad8c4d3e7d499f16d7c12 100644 (file)
--- a/man/xml-source/amanda.8.xml
+++ b/man/xml-source/amanda.8.xml
@@ -176,16 +176,25 @@
 </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 &A; backup tapes for errors.</para>
+<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>Program to add client to an existing &A; configuration.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
@@ -1170,15 +1191,89 @@ Leading ^ is removed. Trailing $ forces an exact match.</para>
 
 </refsect1>
 
-<refsect1><title>CONFIGURATION OVERWRITE</title>
-<para>Most command allow to overwrite any configuration parameter on
-the command line with the -o option.</para>
-<para>-o NAME=value</para>
-<para>eg. -o runtapes=2</para>
-<para>eg. -o DUMPTYPE:no-compress:compress="server fast"</para>
-<para>eg. -o TAPETYPE:HP-DAT:length=2000m</para>
-<para>eg. -o INTERFACE:local:use="2000 kbps"</para>
+<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>
 
@@ -1212,8 +1307,10 @@ the command line with the -o option.</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>