X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Fxml-source%2Famflush.8.xml;h=c27261bc0751d1be06b5bad32e4c909d67ed103c;hb=b116e9366c7b2ea2c2eb53b0a13df4090e176235;hp=aaa9ed1e6a1e1fd2ef661e521ae25f0f1b4eb68c;hpb=d3b2175e084f88c8736ad7073eacbf4670147aec;p=debian%2Famanda

diff --git a/man/xml-source/amflush.8.xml b/man/xml-source/amflush.8.xml
index aaa9ed1..c27261b 100644
--- a/man/xml-source/amflush.8.xml
+++ b/man/xml-source/amflush.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;
 ]>
 
@@ -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>
+<refpurpose>flush Amanda backup files from holding disk to tape</refpurpose>
 </refnamediv>
+<refentryinfo>
+&author.jds;
+&author.sgw.xml;
+</refentryinfo>
 <!-- body begins here -->
 <refsynopsisdiv>
 <cmdsynopsis>
@@ -31,22 +38,27 @@
        <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'>Amflush</emphasis>
-writes &A; backups from the holding disks to tape,
-and updates the &A; info database and tapelist accordingly.
+writes Amanda backups from the holding disks to tape,
+and updates the Amanda info database and &tapelist; accordingly.
+It is similar to amdump, but does not perform any backup operations on
+Amanda clients.
 Backups may stay in a holding disk when something is wrong with the tape
-at the time
-<emphasis remap='B'>amdump</emphasis>
-is run.
+at the time <command>amdump</command> is run.
 When this happens, the problem must be corrected and
-<command>amflush</command>
-run by hand.</para>
+<command>amflush</command> run by hand.</para>
+
+<para>The command optionally takes a set of DLE specifications
+    (see <manref
+    name="amanda-match" vol="7"/>) to narrow the DLEs for which dumps will be flushed.
+All dumps in holding are flushed if no expressions are given.</para>
+
 </refsect1>
 
 <refsect1><title>OPTIONS</title>
@@ -90,43 +102,38 @@ option.</para>
   <varlistentry>
   <term><option>-D datestamp</option></term>
   <listitem>
-<para>specify a  datestamp expression you want to flush, see the 
-&quot;DATESTAMP EXPRESSION&quot; section of
-<citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
-for a description.
+<para>specify a datestamp expression you want to flush; see
+<manref name="amanda-match" vol="7"/>
+for details on the format of this expression.
 <option>-D 20001225-7</option>
-will flush all
-dumps from 25 december 2000 to 27 december 2000.</para>
+will flush all dumps from 25 december 2000 to 27 december 2000.</para>
   </listitem>
   </varlistentry>
 
   <varlistentry>
   <term><replaceable>host</replaceable> [<replaceable>disk</replaceable>]*</term>
   <listitem>
-<para>Specify the host and disk on which the command will work.</para>
+<para>Specify the host and disk on which the command will work -- see
+    the description of DLE specifications in <manref name="amanda-match" vol="7"/>. </para>
   </listitem>
   </varlistentry>
 
-  <varlistentry>
-  <term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</replaceable></term>
-  <listitem>
-<para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>" section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
-  </listitem>
-  </varlistentry>
+
+  &configoverride.varlistentry;
 
 </variablelist>
 
 <para>You can specify many host/disk expressions, only disks that
 match an expression will be flushed. All disks are flushed if no
 expressions are given. see the &quot;HOST &amp; DISK EXPRESSION&quot; section of
-<citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
+<manref name="amanda" vol="8"/>
 for a description.</para>
 
 <para><emphasis remap='B'>Amflush</emphasis>
 will look in the holding disks specified by the
 <emphasis remap='I'>amanda.conf</emphasis>
 file in /usr/local/etc/amanda/<emphasis remap='I'>config</emphasis>
-for any non-empty &A; work directories.
+for any non-empty Amanda work directories.
 It then prompts you to select a directory
 or to process all of the directories.
 The work directories in the holding disks are named by the date at the time
@@ -135,8 +142,8 @@ was run, e.g.
 <literal>19910215</literal>.</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>EXAMPLE</title>
@@ -148,15 +155,15 @@ After you select which holding area to flush,
 <command>amflush</command>
 writes the data to tape, updates the databases and sends
 a mail report similar to
-<citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
+<manref name="amdump" vol="8"/>.</para>
 
 <programlisting>
-% amflush daily
+% amflush MyConfig
 Scanning /amanda-hold...
-  20001113: found &A; directory.
-  20001114: found &A; directory.
+  20001113: found Amanda directory.
+  20001114: found Amanda directory.
 
-Multiple &A; directories, please pick one by letter:
+Multiple Amanda directories, please pick one by letter:
   A. 20001113
   B. 20001114
 Select directories to flush [A..B]: [ALL] all
@@ -169,16 +176,30 @@ 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>
-</refsect1>
 
-<refsect1><title>AUTHOR</title>
-<para>James da Silva, &email.jds; : Original text</para>
-<para>&maintainer.sgw;: XML-conversion</para>
+<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>SEE ALSO</title>
-<para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry></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>
+
+<seealso>
+<manref name="amdump" vol="8"/>
+<manref name="amanda-match" vol="7"/>
+</seealso>
+
 </refentry>