un-do make check since there's no useful content .. fooled by INSTALL!
[debian/amanda] / man / xml-source / amdump.8.xml
index 7c7a7635d612e9b26658bf7dd8539b9ebd387815..dd8a8f503add4a6e4c8928ca9f39f3a0dc949755 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>amdump</refentrytitle>
 <manvolnum>8</manvolnum>
+&rmi.source;
+&rmi.version;
+&rmi.manual.8;
 </refmeta>
 <refnamediv>
 <refname>amdump</refname>
-<refpurpose>back up all disks in an &A; configuration</refpurpose>
+<refpurpose>back up all disks in an Amanda configuration</refpurpose>
 </refnamediv>
+<refentryinfo>
+&author.jds;
+&author.sgw.xml;
+</refentryinfo>
 <!-- body begins here -->
 <refsynopsisdiv>
 <cmdsynopsis>
        <arg choice='plain'><replaceable>host</replaceable></arg>
        <arg choice='opt' rep='repeat'><replaceable>disk</replaceable></arg>
     </arg>
-    <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o </arg><replaceable>configoption</replaceable></group></arg>
+    &configoverride.synopsis;
 </cmdsynopsis>
 </refsynopsisdiv>
 
 
 <refsect1><title>DESCRIPTION</title>
 <para><emphasis remap='B'>Amdump</emphasis>
-switches to the appropriate &A; configuration directory,
+switches to the appropriate Amanda configuration directory,
 e.g. /usr/local/etc/amanda/<emphasis remap='I'>config</emphasis>,
 then attempts to back up every disk specified by the
 <emphasis remap='I'>amanda.conf</emphasis>
@@ -57,8 +64,8 @@ While waiting,
 checks for the hold file every minute.</para>
 
 <para>See the
-<citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-man page for more details about &A;.</para>
+<manref name="amanda" vol="8"/>
+man page for more details about Amanda.</para>
 </refsect1>
 
 <refsect1><title>OPTIONS</title>
@@ -71,12 +78,7 @@ man page for more details about &A;.</para>
   </listitem>
   </varlistentry>
 
-  <varlistentry>
-  <term><emphasis remap='B'>-o</emphasis> <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>
-  </listitem>
-  </varlistentry>
+  &configoverride.varlistentry;
 
 </variablelist>
 </refsect1>
@@ -92,9 +94,9 @@ every weeknight at 1 a.m. as user
 </programlisting>
 
 <para>Please see the 
-<citerefentry><refentrytitle>crontab</refentrytitle><manvolnum>5</manvolnum></citerefentry>
+<manref name="crontab" vol="5"/>
 or
-<citerefentry><refentrytitle>crontab</refentrytitle><manvolnum>1</manvolnum></citerefentry>
+<manref name="crontab" vol="1"/>
 manual page for the correct crontab format for your system.</para>
 </refsect1>
 
@@ -115,7 +117,7 @@ or the remains of a previous incomplete &amdump; or &amflush; run.
 This run is terminated.
 If the problem is caused by the remains of a previous run,
 you must execute
-<citerefentry><refentrytitle>amcleanup</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+<manref name="amcleanup" vol="8"/>
 and then rerun
 <command>amdump</command>.</para>
   </listitem>
@@ -123,18 +125,25 @@ and then rerun
 </variablelist>
 </refsect1>
 
-<refsect1><title>AUTHOR</title>
-<para>James da Silva, &email.jds; : Original text</para>
-<para>&maintainer.sgw;: XML-conversion</para>
+<refsect1><title>EXIT CODE</title>
+The exit code of <command>amdump</command> is the ORed value of:
+<programlisting>
+ 0  = success
+ 1  = error
+ 2  = a dle give strange message
+ 4  = a dle failed
+ 8  = Don't know the status of a dle (RESULT_MISSING in the report)
+ 16 = tape error or no more tape
+</programlisting>
 </refsect1>
 
-<refsect1><title>SEE ALSO</title>
-<para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amcheck</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amcleanup</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amflush</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>cron</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>
-</refsect1>
+<seealso>
+<manref name="amcheck" vol="8"/>,
+<manref name="amcleanup" vol="8"/>,
+<manref name="amrestore" vol="8"/>,
+<manref name="amflush" vol="8"/>,
+<manref name="cron" vol="8"/>
+</seealso>
+
 </refentry>