Imported Upstream version 3.2.1

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

diff --git a/man/xml-source/amstatus.8.xml b/man/xml-source/amstatus.8.xml
index ea2e2751572ae7d46e28dccd9194ff7179941189..6e210d8d978100c5a936a73d542df317dae2a1ee 100644 (file)
--- a/man/xml-source/amstatus.8.xml
+++ b/man/xml-source/amstatus.8.xml
@@ -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;
 ]>
 
@@ -14,17 +14,21 @@
 <refmeta>
 <refentrytitle>amstatus</refentrytitle>
 <manvolnum>8</manvolnum>
+&rmi.source;
+&rmi.version;
+&rmi.manual.8;
 </refmeta>
 <refnamediv>
 <refname>amstatus</refname>
-<refpurpose>display the state of an &A; run</refpurpose>
+<refpurpose>display the state of an Amanda run</refpurpose>
 </refnamediv>
+<refentryinfo>
+&author.sgw.xml;
+</refentryinfo>
 <!-- body begins here -->
 <refsynopsisdiv>
 <cmdsynopsis>
   <command>amstatus</command>    
-    <arg choice='opt'>--config </arg>
-    <arg choice='plain'><replaceable>config</replaceable></arg>
     <arg choice='opt'><arg choice='plain'>--file </arg><arg choice='plain'><replaceable>amdumpfile</replaceable></arg></arg>
     <arg choice='opt'>--summary </arg>
     <arg choice='opt'>--dumping </arg>
@@ -38,21 +42,23 @@
     <arg choice='opt'>--gestimate </arg>
     <arg choice='opt'>--stats </arg>
     <arg choice='opt'>--locale-independent-date-format </arg>
+    <arg choice='opt'>--config </arg>
+    <arg choice='plain'><replaceable>config</replaceable></arg>
 </cmdsynopsis>
 </refsynopsisdiv>
 
 
 <refsect1><title>DESCRIPTION</title>
 <para><emphasis remap='B'>Amstatus</emphasis>
-gives the current state of the &A; run specified by the 
+gives the current state of the Amanda run specified by the 
 <emphasis remap='I'>config</emphasis>
 configuration.
-If there is no active &A; running, it summarizes the result of the last run.
+If there is no active Amanda running, it summarizes the result of the last run.
 It may also be used to summarize the results of a previous run.</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>
@@ -62,7 +68,7 @@ If no options are given, everything is displayed.</para>
   <varlistentry>
   <term><emphasis remap='B'>[--config] config</emphasis></term>
   <listitem>
-<para>Specify the &A; configuration you want to display the state for.</para>
+<para>Specify the Amanda configuration you want to display the state for.</para>
   </listitem>
   </varlistentry>
   <varlistentry>
@@ -152,14 +158,23 @@ Works only during the estimate phase.</para>
 </variablelist>
 </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>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amrestore</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amadmin</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>http://wiki.zmanda.com</refentrytitle></citerefentry>
-</para>
+<refsect1><title>EXIT CODE</title>
+The exit code of <command>amstatus</command> is the ORed value of:
+<programlisting>
+ 0  = success
+ 1  = error
+ 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>
+
+<seealso>
+<manref name="amcheck" vol="8"/>,
+<manref name="amdump" vol="8"/>,
+<manref name="amrestore" vol="8"/>,
+<manref name="amadmin" vol="8"/>
+</seealso>
+
 </refentry>