Imported Debian patch 2.5.1p3-1

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

diff --git a/man/xml-source/amrecover.8.xml b/man/xml-source/amrecover.8.xml
index a3b29d5efe1c0e787229807a6cff75e228dd158e..d00fbca0e3da03aca5c49916a47ed7f7fab5be48 100644 (file)
--- a/man/xml-source/amrecover.8.xml
+++ b/man/xml-source/amrecover.8.xml
@@ -23,10 +23,11 @@
 <refsynopsisdiv>
 <cmdsynopsis>
   <command>amrecover</command>    
-    <arg choice='opt'><arg choice='opt'>-C </arg><arg choice='plain'><replaceable>config</replaceable></arg></arg>
-    <arg choice='opt'><arg choice='plain'>-s </arg><arg choice='plain'><replaceable>index-server</replaceable></arg></arg>
-    <arg choice='opt'><arg choice='plain'>-t </arg><arg choice='plain'><replaceable>tape-server</replaceable></arg></arg>
-    <arg choice='opt'><arg choice='plain'>-d </arg><arg choice='plain'><replaceable>tape-device</replaceable></arg></arg>
+    <arg choice='opt'>-C <replaceable>config</replaceable></arg>
+    <arg choice='opt'>-s <replaceable>index-server</replaceable></arg>
+    <arg choice='opt'>-t <replaceable>tape-server</replaceable></arg>
+    <arg choice='opt'>-d <replaceable>tape-device</replaceable></arg>
+    <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o </arg><replaceable>configoption</replaceable></group></arg>
 </cmdsynopsis>
 </refsynopsisdiv>
 
@@ -44,15 +45,18 @@ to move into that directory, otherwise a directory tree that resembles
 the backed up filesystem will be created in the current directory.
 See the examples below for details.</para>
 
+<para>Amrecover will read the <emphasis remap='B'>amanda-client.conf</emphasis> file and the <replaceable>config</replaceable><emphasis remap='B'>/amanda-client.conf</emphasis> file.</para>
+
 <para>See the
 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
 man page for more details about &A;.</para>
 </refsect1>
 
 <refsect1><title>OPTIONS</title>
-<note>The Default values are those set at compile-time.
+<note><para>The Default values are those set at compile-time.
 Use <command>amrestore</command> to recover client-encrypted or
-client-custom-compressed tapes.</note>
+client-custom-compressed tapes.</para>
+</note>
 <variablelist remap='TP'>
   <varlistentry>
   <term><emphasis remap='B'>[ -C ] config</emphasis></term>
@@ -78,6 +82,15 @@ client-custom-compressed tapes.</note>
 <para>Tape device to use on the tape server host.</para>
   </listitem>
   </varlistentry>
+
+  <varlistentry>
+  <term><emphasis remap='B'>-o</emphasis> <replaceable>clientconfigoption</replaceable></term>
+  <listitem>
+<para>See the "<emphasis remap='B'>CONFIGURATION OVERWRITE</emphasis>"
+ section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+  </listitem>
+  </varlistentry>
+
 </variablelist>
 </refsect1>
 
@@ -101,9 +114,9 @@ The following commands are available:</para>
   </listitem>
   </varlistentry>
   <varlistentry>
-  <term><emphasis remap='B'>setdate YYYY-MM-DD</emphasis></term>
+  <term><emphasis remap='B'>setdate YYYY-MM-DD-HH-MM[-SS] | YYYY-MM-DD</emphasis></term>
   <listitem>
-<para>Set the date (default: today).
+<para>Set the restore time (default: now).
 File listing commands only return information on
 backup images for this day,
 for the day before with the next lower dump level,
@@ -120,8 +133,8 @@ the specified date is encountered.</para>
 1996-07-06 through 1997-07-08 were level 2 backups
 </literallayout> <!-- .fi -->
 
-<para>then if 1997-07-08 is the requested date,
-files from the following days would be used:</para>
+<para>then the command <emphasis remap='B'>setdate 1997-07-08-00</emphasis>
+would yield files from the following days:</para>
 
 <!-- .RS -->
 <literallayout remap='.nf'>
@@ -154,9 +167,7 @@ files from the following days would be used:</para>
 <!-- .RE -->
 <variablelist remap='TP'>
   <varlistentry>
-  <term><emphasis remap='B'>setdisk <arg
-  choice='plain'><replaceable>diskname</replaceable></arg> <arg
-  choice='opt'><replaceable>mountpoint</replaceable></arg></emphasis></term>
+  <term><emphasis remap='B'>setdisk </emphasis><emphasis remap='I'>diskname</emphasis> [<emphasis remap='I'>mountpoint</emphasis>]</term>
   <listitem>
 <para>Specifies which disk to consider
 (default: the disk holding the working directory where
@@ -178,14 +189,21 @@ mount point instead of full pathnames.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
-  <term><emphasis remap='B'>listdisk [diskdevice]</emphasis></term>
+  <term><emphasis remap='B'>listhost </emphasis>[<emphasis remap='I'>diskdevice</emphasis>]</term>
+  <listitem>
+<para>List all
+<emphasis remap='B'>host</emphasis></para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><emphasis remap='B'>listdisk </emphasis>[<emphasis remap='I'>diskdevice</emphasis>]</term>
   <listitem>
 <para>List all
 <emphasis remap='B'>diskname</emphasis></para>
   </listitem>
   </varlistentry>
   <varlistentry>
-  <term><emphasis remap='B'>settape [[server]:][tapedev|default]</emphasis></term>
+  <term><emphasis remap='B'>settape </emphasis>[[<emphasis remap='I'>server</emphasis>]:][<emphasis remap='I'>tapedev</emphasis>|<emphasis remap='I'>default</emphasis>]</term>
   <listitem>
 <para>Specifies the host to use as the tape server, and which of its tape
 devices to use.
@@ -210,7 +228,6 @@ must specify the hostname.</para>
 <programlisting>
 settape 192.168.0.10:file:/file1
 </programlisting>
-
 <para>You can change the tape device when amrecover ask you to load the tape:</para>
 
 <programlisting>
@@ -227,7 +244,7 @@ Using tape /dev/nst2 from server server2.
 
 <variablelist remap='TP'>
   <varlistentry>
-  <term><emphasis remap='B'>setmode mode</emphasis></term>
+  <term><emphasis remap='B'>setmode </emphasis><emphasis remap='I'>mode</emphasis></term>
   <listitem>
 <para>Set the extraction mode for Samba shares.
 If
@@ -280,7 +297,7 @@ can be a shell style wildcards.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
-  <term><emphasis remap='B'>cdx dir</emphasis></term>
+  <term><emphasis remap='B'>cdx </emphasis><emphasis remap='I'>dir</emphasis></term>
   <listitem>
 <para>Like the
 <emphasis remap='B'>cd</emphasis>
@@ -298,7 +315,7 @@ relative to the backed up filesystem.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
-  <term><emphasis remap='B'>lcd path</emphasis></term>
+  <term><emphasis remap='B'>lcd </emphasis><emphasis remap='I'>path</emphasis></term>
   <listitem>
 <para>Change the
 <command>amrecover</command>
@@ -318,35 +335,35 @@ The backup date is shown for each file.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
-  <term><emphasis remap='B'>add item1 item2 ...</emphasis></term>
+  <term><emphasis remap='B'>add </emphasis><emphasis remap='I'>item1 item2 ...</emphasis></term>
   <listitem>
 <para>Add the specified files or directories to the restore list.
 Each item may have shell style wildcards.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
-  <term><emphasis remap='B'>addx item1 item2 ...</emphasis></term>
+  <term><emphasis remap='B'>addx </emphasis><emphasis remap='I'>item1 item2 ...</emphasis></term>
   <listitem>
 <para>Add the specified files or directories to the restore list.
 Each item may be a regular expression.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
-  <term><emphasis remap='B'>delete item1 item2 ...</emphasis></term>
+  <term><emphasis remap='B'>delete </emphasis><emphasis remap='I'>item1 item2 ...</emphasis></term>
   <listitem>
 <para>Delete the specified files or directories from the restore list.
 Each item may have shell style wildcards.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
-  <term><emphasis remap='B'>deletex item1 item2 ...</emphasis></term>
+  <term><emphasis remap='B'>deletex </emphasis><emphasis remap='I'>item1 item2 ...</emphasis></term>
   <listitem>
 <para>Delete the specified files or directories from the restore list.
 Each item may be a regular expression.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
-  <term><emphasis remap='B'>list file</emphasis></term>
+  <term><emphasis remap='B'>list </emphasis><emphasis remap='I'>file</emphasis></term>
   <listitem>
 <para>Display the contents of the restore list.
 If a file name is specified,
@@ -558,6 +575,16 @@ commands will use $PAGER to display the file lists.
 Defaults to
 <emphasis remap='I'>more</emphasis>
 if PAGER is not set.</para>
+<para><envar>AMANDA_SERVER</envar>
+If set, $AMANDA_SERVER will be used as index-server.
+The value will take precedence over the compiled default,
+but will be overridden by the -s switch.
+</para>
+<para><envar>AMANDA_TAPE_SERVER</envar>
+If set, $AMANDA_TAPE_SERVER will be used as tape-server.
+The value will take precedence over the compiled default,
+but will be overridden by the -t switch.
+</para>
 <!-- .RE -->
 </refsect1>
 
@@ -568,6 +595,7 @@ if PAGER is not set.</para>
 
 <refsect1><title>SEE ALSO</title>
 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<citerefentry><refentrytitle>amanda-client.conf</refentrytitle><manvolnum>5</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>amfetchdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 <citerefentry><refentrytitle>readline</refentrytitle><manvolnum>3</manvolnum></citerefentry></para>