Imported Upstream version 2.6.1
[debian/amanda] / man / xml-source / amreport.8.xml
index fd9252b603df4ab54a9c278f07e603e95bbac718..72c5395942aaf44361ef4ab03f1240cd57739a9d 100644 (file)
 <refmeta>
 <refentrytitle>amreport</refentrytitle>
 <manvolnum>8</manvolnum>
+&rmi.source;
+&rmi.version;
+&rmi.manual.8;
 </refmeta>
 <refnamediv>
 <refname>amreport</refname>
 <refpurpose>generate a formatted output of statistics for an &A; run</refpurpose>
 </refnamediv>
+<refentryinfo>
+&author.sgw.xml;
+</refentryinfo>
 <!-- body begins here -->
 <refsynopsisdiv>
 <cmdsynopsis>
   <command>amreport</command>    
     <arg choice='opt'><replaceable>config</replaceable></arg>
     <arg choice='opt'>-i</arg>
-    <group><arg choice='plain'>-M</arg><arg choice='plain'><replaceable>address</replaceable></arg></group>
-    <group><arg choice='plain'>-l</arg><arg choice='plain'><replaceable>logfile</replaceable></arg></group>
-    <group><arg choice='plain'>-f</arg><arg choice='plain'><replaceable>outputfile</replaceable></arg></group>
-    <group><arg choice='plain'>-p</arg><arg choice='plain'><replaceable>postscriptfile</replaceable></arg></group>
-    <group><arg choice='plain'>-o</arg><arg choice='plain'><replaceable>configoption</replaceable></arg></group>*
+    <arg choice='opt'>-M <replaceable>address</replaceable></arg>
+    <arg choice='opt'>-l <replaceable>logfile</replaceable></arg>
+    <arg choice='opt'>-f <replaceable>outputfile</replaceable></arg>
+    <arg choice='opt'>-p <replaceable>postscriptfile</replaceable></arg>
+    <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o </arg><replaceable>configoption</replaceable></group></arg>
 </cmdsynopsis>
 </refsynopsisdiv>
 
@@ -122,7 +128,7 @@ directive is specified in amanda.conf.</para>
   <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>
+<para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>" section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
   </listitem>
   </varlistentry>
 
@@ -179,9 +185,23 @@ other tape types or particular site needs.</para>
 It may be used to make a hardcopy log of the tapes.</para>
 </refsect1>
 
+<refsect1><title>EXIT CODE</title>
+The exit code of <command>amreport</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>amflush</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>
+<citerefentry><refentrytitle>amflush</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+<ulink url="http://wiki.zmanda.com"/>
+</para>
 </refsect1>
 </refentry>