Imported Upstream version 2.6.1

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

diff --git a/man/xml-source/amflush.8.xml b/man/xml-source/amflush.8.xml
index 9ef7256a7624de5da0dec1f7964850956afb5b92..50b4760baa3db9a33b99700bc27a30e2889bb329 100644 (file)
--- a/man/xml-source/amflush.8.xml
+++ b/man/xml-source/amflush.8.xml
@@ -13,11 +13,18 @@
 <refmeta>
 <refentrytitle>amflush</refentrytitle>
 <manvolnum>8</manvolnum>
+&rmi.source;
+&rmi.version;
+&rmi.manual.8;
 </refmeta>
 <refnamediv>
 <refname>amflush</refname>
 <refpurpose>flush &A; backup files from holding disk to tape</refpurpose>
 </refnamediv>
+<refentryinfo>
+&author.jds;
+&author.sgw.xml;
+</refentryinfo>
 <!-- body begins here -->
 <refsynopsisdiv>
 <cmdsynopsis>
@@ -25,10 +32,13 @@
     <arg choice='opt'>-b</arg>
     <arg choice='opt'>-f</arg>
     <arg choice='opt'>-s</arg>
-    <group><arg choice='plain'>-D</arg><arg choice='plain'><replaceable>datestamp</replaceable></arg></group>*
+    <arg choice='opt'>-D <replaceable>datestamp</replaceable></arg>
     <arg choice='plain'><replaceable>config</replaceable></arg>
-    <group><arg choice='plain'><replaceable>host</replaceable></arg><arg choice='opt'><replaceable>disk</replaceable></arg>*</group>*
-    <group><arg choice='plain'>-o</arg><arg choice='plain'><replaceable>configoption</replaceable></arg></group>*
+    <arg choice='opt' rep='repeat'>
+       <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>
 </cmdsynopsis>
 </refsynopsisdiv>
 
@@ -36,7 +46,7 @@
 <refsect1><title>DESCRIPTION</title>
 <para><emphasis remap='B'>Amflush</emphasis>
 writes &A; backups from the holding disks to tape,
-and updates the &A; info database and tapelist accordingly.
+and updates the &A; info database and &tapelist; accordingly.
 Backups may stay in a holding disk when something is wrong with the tape
 at the time
 <emphasis remap='B'>amdump</emphasis>
@@ -107,7 +117,7 @@ dumps from 25 december 2000 to 27 december 2000.</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>
 
@@ -148,7 +158,7 @@ a mail report similar to
 <citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
 
 <programlisting>
-% amflush daily
+% amflush MyConfig
 Scanning /amanda-hold...
   20001113: found &A; directory.
   20001114: found &A; directory.
@@ -166,16 +176,32 @@ Are you sure you want to do this? yes
 Running in background, you can log off now.
 You'll get mail when amflush is finished.
 </programlisting>
+
+<para>The following example causes amflush to flush everything to tape, then
+ejects tape, using 'at' to run the task in the background.</para>
+
+<programlisting>
+% echo 'amflush -b -f MyConfig &amp;&amp; mt offline' | at now
+</programlisting>
 </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>amflush</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>
 
 <refsect1><title>SEE ALSO</title>
-<para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>
+<para>
+  <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+  <citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
+  <ulink url="http://wiki.zmanda.com"/>
+</para>
 </refsect1>
 </refentry>