Merge tag 'upstream/3.3.3'
[debian/amanda] / man / xml-source / amfetchdump.8.xml
index 4f4d4a3878679c7f74491d2dc1239d7b37cc1520..5b443a0f13e9dac6bf176f6bb2a679f0cef85e92 100644 (file)
@@ -3,7 +3,7 @@
                    "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;
 ]>
 
 <refmeta>
 <refentrytitle>amfetchdump</refentrytitle>
 <manvolnum>8</manvolnum>
+&rmi.source;
+&rmi.version;
+&rmi.manual.8;
 </refmeta>
 <refnamediv>
 <refname>amfetchdump</refname>
-<refpurpose>extract backup images from multiple &A; tapes.</refpurpose>
+<refpurpose>extract backup images from multiple Amanda tapes.</refpurpose>
 </refnamediv>
+<refentryinfo>
+&author.jstange;
+&author.ian;
+</refentryinfo>
 <!-- body begins here -->
 <refsynopsisdiv>
 <cmdsynopsis>
   <command>amfetchdump</command>
-    <arg choice='opt'>-pcClawns</arg>
-    <arg choice='opt'>-d <replaceable>device</replaceable></arg>
+    <group choice='opt'>
+      <arg choice='plain'>-c</arg>
+      <arg choice='plain'>-C</arg>
+      <arg choice='plain'>-l</arg>
+    </group>
+    <group choice='opt'>
+      <arg choice='plain'>-p</arg>
+      <arg choice='plain'>-n</arg>
+    </group>
+    <arg choice='opt'>-a</arg>
     <arg choice='opt'>-O <replaceable>directory</replaceable></arg>
-    <arg choice='opt'>-i <replaceable>logfile</replaceable></arg>
-    <arg choice='opt'>-b <replaceable>blocksize</replaceable></arg>
+    <arg choice='opt'>-d <replaceable>device</replaceable></arg>
+    <group choice='opt'>
+      <arg choice='plain'>-h</arg>
+      <arg choice='plain'>--header-file <replaceable>filename</replaceable></arg>
+      <arg choice='plain'>--header-fd <replaceable>fd</replaceable></arg>
+    </group>
+    <group choice='opt'>
+      <arg choice='plain'>--decompress</arg>
+      <arg choice='plain'>--no-decompress</arg>
+      <arg choice='plain'>--server-decompress</arg>
+      <arg choice='plain'>--client-decompress</arg>
+    </group>
+    <arg>
+       <arg choice='plain'>--extract</arg>
+       <arg choice='plain'>--directory<replaceable> directory</replaceable></arg>
+       <arg choice='opt'>--data-path<replaceable> amanda|directtcp</replaceable></arg>
+       <arg choice='opt'>--application-property <replaceable>NAME=VALUE</replaceable></arg>*
+    </arg>
+    <group choice='opt'>
+      <arg choice='plain'>--decrypt</arg>
+      <arg choice='plain'>--no-decrypt</arg>
+      <arg choice='plain'>--server-decrypt</arg>
+      <arg choice='plain'>--client-decrypt</arg>
+    </group>
+    <arg choice='opt'>--exact_match</arg>
+    &configoverride.synopsis;
     <arg choice='plain'><replaceable>config</replaceable></arg>
     <arg choice='plain'><replaceable>hostname</replaceable></arg>
     <arg choice='opt'>
@@ -41,7 +80,6 @@
         </arg>
       </arg>
     </arg>
-    <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o </arg><replaceable>configoption</replaceable></group></arg>
 </cmdsynopsis>
 </refsynopsisdiv>
 
 <para><emphasis remap='B'>Amfetchdump</emphasis>
 pulls one or more matching dumps from tape or from the holding disk,
 handling the reassembly of multi-tape split dump files as well as any
-tape autochanger operations.</para>
+tape autochanger operations. The dump are by default decompressed and decrypted.
+</para>
 
-<para>It will automatically use the logs created by
-<citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+<para>It will automatically use the Amanda catalog
 to locate available dumps on tape, in the same way that the <emphasis
 remap='B'>find</emphasis> feature of
-<citerefentry><refentrytitle>amadmin</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-lists available dumps. If these logs are unavailable, it can search
-tape-by-tape to find what it needs, and can generate new logs to serve
-as an emergency tape inventory.</para>
+<manref name="amadmin" vol="8"/>
+lists available dumps.</para>
 
 <para>The 
 <emphasis remap='I'>hostname</emphasis>,
 <emphasis remap='I'>diskname</emphasis>,
 <emphasis remap='I'>datestamp</emphasis>,
 and
-<emphasis remap='I'>level</emphasis> dump pattern-matching works as in
-<citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-with the added requirement that at minimum a <emphasis
-remap='I'>hostname</emphasis> must be specified when not in inventory mode.</para>
+<emphasis remap='I'>level</emphasis> dump specifications are further described in
+<manref name="amanda-match" vol="7"/>.
+Note that at minimum a <emphasis remap='I'>hostname</emphasis> must be specified.</para>
 
-<para>Unless
-<option>-p</option>
+<para>Unless <option>-p</option>
 is used, backup images are extracted to files in the current directory named:</para>
 
+<para>If a changer error occurs, or the <option>-d</option> option is given,
+then amfetchdump prompts for each required volume.</para>
+
 <!-- .RS -->
 <para><emphasis remap='I'>hostname.diskname.datestamp.dumplevel</emphasis></para>
 <!-- .RE -->
@@ -91,8 +128,22 @@ will restore only the first matching dumpfile (where
 facility).</para></listitem>
   </varlistentry>
   <varlistentry>
-    <term><option>-d</option> <replaceable>device</replaceable></term>
-<listitem><para> Restore from this tape device instead of the default.</para></listitem>
+    <term><option>-h</option></term>
+<listitem><para>Output the amanda header as a 32K block to same output as the image.</para></listitem>
+  </varlistentry>
+  <varlistentry>
+    <term><option>--header-fd</option> <replaceable>fd</replaceable></term>
+<listitem><para>Output the amanda header to the numbered file
+ descriptor.</para></listitem>
+  </varlistentry>
+  <varlistentry>
+    <term><option>--header-file</option> <replaceable>filename</replaceable></term>
+<listitem><para>Output the amanda header to the filename.</para></listitem>
+  </varlistentry>
+  <varlistentry>
+    <term><option>-d</option> <replaceable>device_or_changer</replaceable></term>
+    <listitem><para> Restore from this device or changer instead of the default,
+prompting for each volume.</para></listitem>
   </varlistentry>
   <varlistentry>
     <term><option>-O</option>
@@ -111,66 +162,106 @@ facility).</para></listitem>
     available.</para></listitem>
   </varlistentry>
   <varlistentry>
-    <term><option>-l</option></term>
-<listitem><para>Leave dumps in the compressed/uncompressed state in which they
-were found on tape. By default, <emphasis
-remap='B'>amfetchdump</emphasis> will automatically uncompress when
-restoring.</para></listitem>
+    <term><option>--decompress</option></term>
+    <listitem><para>Always do the decompression, this is the default.</para></listitem>
   </varlistentry>
   <varlistentry>
-    <term><option>-a</option></term>
-<listitem><para>Assume that all tapes are already available, via tape changer or
-otherwise, instead of prompting the operator to ensure that all tapes
-are loaded.</para></listitem>
+    <term><option>--no-decompress</option></term>
+    <listitem><para>Never do the decompression.</para></listitem>
+  </varlistentry>
+  <varlistentry>
+    <term><option>--server-decompress</option></term>
+    <listitem><para>Do the decompression only if the compression was done on
+the server.</para></listitem>
   </varlistentry>
   <varlistentry>
-    <term><option>-i</option> <replaceable>filename</replaceable></term>
-<listitem><para>Generate an inventory of all dumps &quot;seen&quot; on the
-tapes we search, for later use as a log.</para></listitem>
+    <term><option>--client-decompress</option></term>
+    <listitem><para>Do the decompression only if the compression was done on
+the client.</para></listitem>
   </varlistentry>
   <varlistentry>
-    <term><option>-w</option></term>
-<listitem><para>Wait to put split dumps together until all chunks have been
-restored. Normally, <emphasis remap='B'>amfetchdump</emphasis> will
-attempt to read pieces of a split file from tape in order, so that it
-can assemble them simply by appending each file to the first. This
-option disables the appending behavior, and instead restores each
-piece as an individual file and reassembles them only after all have
-been restored.</para>
+    <term><option>--decrypt</option></term>
+    <listitem><para>Always do the decryption, this is the default.</para></listitem>
+  </varlistentry>
+  <varlistentry>
+    <term><option>--no-decrypt</option></term>
+    <listitem><para>Never do the decryption.</para></listitem>
+  </varlistentry>
+  <varlistentry>
+    <term><option>--server-decrypt</option></term>
+    <listitem><para>Do the decryption only if the encryption was done on
+the server.</para></listitem>
+  </varlistentry>
+  <varlistentry>
+    <term><option>--client-decrypt</option></term>
+    <listitem><para>Do the decryption only if the encryption was done on
+the client.</para></listitem>
+  </varlistentry>
 
-<note><para>This requires at least double the size of your dump in free
-disk space, in order to build the final assembled dumpfile.</para>
-</note>
+  <varlistentry>
+  <term><option>--exact-match</option></term>
+  <listitem>
+<para>The host and disk are parsed as exact values</para>
+  </listitem>
+  </varlistentry>
 
-<para>This behavior is implicitly invoked in circumstances where knowing the
-location of all dumps on tape in advance is not possible, such as when
-you are restoring without log files.</para></listitem>
+  <varlistentry>
+  <term><option>--extract</option></term>
+  <listitem>
+<para>Extract the backup on the server in the
+<replaceable>directory</replaceable> directory.</para>
+  </listitem>
   </varlistentry>
+
   <varlistentry>
-    <term><option>-n</option></term>
-<listitem><para>Do not reassemble split dump files at all, just restore each
-piece as an individual file.</para></listitem>
+  <term><option>--directory</option> <replaceable>directory</replaceable></term>
+  <listitem>
+<para>Where to extract the backup with the <option>--extract</option> option.</para>
+<para>Warning: All files in that directory can be removed.</para>
+  </listitem>
+  </varlistentry>
+
+  <varlistentry>
+  <term><option>--data-path</option> amanda|directtcp</term>
+  <listitem>
+<para>The data path to use with <option>--extract</option>, the default is
+ to use the fatest data path.</para>
+  </listitem>
+  </varlistentry>
+
+  <varlistentry>
+  <term><option>--application-property</option> <replaceable>NAME=VALUE</replaceable></term>
+  <listitem>
+<para>Application property to send to the application with
+<option>--extract.</option></para>
+  </listitem>
+  </varlistentry>
+
+  <varlistentry>
+    <term><option>-l</option></term>
+<listitem><para>Leave dumps in the compressed/uncompressed and
+encrypted/unencrypted state in which they were found on tape.
+It is a synonym for <option>--no-decompression</option>
+<option>--no-decryption</option></para></listitem>
   </varlistentry>
   <varlistentry>
-    <term><option>-s</option></term>
-<listitem><para>Do not fast-forward straight to needed files on tape. This will
-slow down most restores substantially. Only use this option if your
-tape drive does not properly support the fast-forward
-operation.</para></listitem>
+    <term><option>-a</option></term>
+<listitem><para>Assume that all tapes are already available, via tape changer or
+otherwise, instead of prompting the operator to ensure that all tapes
+are loaded.</para></listitem>
   </varlistentry>
+
   <varlistentry>
-    <term><option>-b</option>
-    <replaceable>blocksize</replaceable></term>
-<listitem><para>Force a particular block size when reading from tapes. This
-    value will usually be autodetected, and should not normally need
-    to be set.</para></listitem>
+    <term><option>-n</option></term>
+<listitem><para>Do not reassemble split dump files at all, just restore each
+piece as an individual file.</para></listitem>
   </varlistentry>
 
   <varlistentry>
-  <term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</replaceable></term>
+  <term><option>-o</option> <replaceable>configoption</replaceable></term>
   <listitem>
-<para>See the "<emphasis remap='B'>CONFIGURATION OVERWRITE</emphasis>"
- section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+<para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>"
+ section in <manref name="amanda" vol="8"/>.</para>
   </listitem>
   </varlistentry>
 
@@ -183,39 +274,17 @@ operation.</para></listitem>
 
 <para>Here's a simple case, restoring all known dumps of the host
 vanya to the current working directory.</para>
-<!-- .RS -->
-<literallayout remap='.nf'>
+<programlisting>
 $ amfetchdump SetA vanya
-</literallayout> <!-- .fi -->
+</programlisting>
 
 <para>A more likely scenario involves restoring a particular dump from
 a particular date. We'll pipe this one to &gnutar; as well, to
 automatically extract the dump.</para>
-<!-- .RS -->
-<literallayout remap='.nf'>
+<programlisting>
 $ amfetchdump -p SetA vanya /home 20051020 | gtar -xvpf -
-</literallayout> <!-- .fi -->
-
-<para>In a situation where all of our dump logs have been wiped out,
-we could also use amfetchdump to inventory our tapes and recreate an
-imitation of those logs, which we'll send to <emphasis
-remap="I">stdout</emphasis> for casual perusal.
-<!-- .RS -->
-<literallayout remap='.nf'>
-$ amfetchdump -i - SetA
-</literallayout> <!-- .fi -->
-</para>
+</programlisting>
 
-<para>Note that you can specify a restore while in inventory mode, and
-<command>amfetchdump</command> will continue searching for more dumps
-from this host even after successfully restoring a dump, inventorying
-all the while. If your backup searcher has been trashed, this is a
-handy way to recover what you have.
-<!-- .RS -->
-<literallayout remap='.nf'>
-$ amfetchdump -i /var/amanda/log SetA backupserver
-</literallayout> <!-- .fi -->
-</para>
 </refsect1>
 
 <refsect1><title>CAVEATS</title>
@@ -225,23 +294,17 @@ the most useful tool when those have all been wiped out and you
 desperately need to pull things from your tape. Pains have been taken
 to make it as capable as possible, but for seriously minimialist
 restores, look to
-<citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+<manref name="amrestore" vol="8"/>
 or
-<citerefentry><refentrytitle>dd</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+<manref name="dd" vol="8"/>
 instead.</para>
 </refsect1>
 
-<refsect1><title>AUTHOR</title>
-<para>John Stange, &email.jstange;, National Academies Press</para>
-<para>Ian Turner, &email.itt;: XML-conversion</para>
-</refsect1>
+<seealso>
+<manref name="amanda-match" vol="7"/>,
+<manref name="amadmin" vol="8"/>,
+<manref name="amrestore" vol="8"/>,
+</seealso>
 
-<refsect1><title>SEE ALSO</title>
-<para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amadmin</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>tar</refentrytitle><manvolnum>1</manvolnum></citerefentry>
-<citerefentry><refentrytitle>restore</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>
-</refsect1>
 </refentry>