Imported Upstream version 3.1.0

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

diff --git a/man/xml-source/amcleanup.8.xml b/man/xml-source/amcleanup.8.xml
index 11a36bc890207ebf3c629dbfa4670872dd24415b..dfc11f1c8e49d7cb8d528579ffea7bfcdeb4f1ab 100644 (file)
--- a/man/xml-source/amcleanup.8.xml
+++ b/man/xml-source/amcleanup.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,15 +13,25 @@
 <refmeta>
 <refentrytitle>amcleanup</refentrytitle>
 <manvolnum>8</manvolnum>
+&rmi.source;
+&rmi.version;
+&rmi.manual.8;
 </refmeta>
 <refnamediv>
 <refname>amcleanup</refname>
-<refpurpose>run the &A; cleanup process after a failure</refpurpose>
+<refpurpose>run the Amanda cleanup process after a failure</refpurpose>
 </refnamediv>
+<refentryinfo>
+&author.jds;
+&author.sgw.xml;
+</refentryinfo>
 <!-- body begins here -->
 <refsynopsisdiv>
 <cmdsynopsis>
   <command>amcleanup</command>    
+    <arg choice='opt'><option>-k</option></arg>
+    <arg choice='opt'><option>-p</option></arg>
+    <arg choice='opt'><option>-v</option></arg>
     <arg choice='plain'><replaceable>config</replaceable></arg>
 </cmdsynopsis>
 </refsynopsisdiv>
@@ -30,8 +40,8 @@
 <refsect1><title>DESCRIPTION</title>
 <para><emphasis remap='B'>Amcleanup</emphasis>
 generates the
-<emphasis remap='I'>&A; Mail Report</emphasis>
-and updates the &A; databases after a system failure on a tape server host.
+<emphasis remap='I'>Amanda Mail Report</emphasis>
+and updates the Amanda databases after a system failure on a tape server host.
 This cleanup process is normally done automatically as part of the
 <emphasis remap='B'>amdump</emphasis>
 program, but if
@@ -41,12 +51,35 @@ cannot complete for some reason (usually because of a tape server host crash),
 must be run some time later (usually during system boot).</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>
+<variablelist remap='TP'>
+  <varlistentry>
+  <term><option>-k</option></term>
+  <listitem>
+   <para>Kill all process listed in the log file are their child. if there is no log file, then kill all amdump and amflush process and their child.</para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><option>-p</option></term>
+  <listitem>
+   <para>Do the cleanup only if all process listed in the log file are already terminated.</para>
+  </listitem>
+  </varlistentry>
+  <varlistentry>
+  <term><option>-v</option></term>
+  <listitem>
+   <para>Generate verbose output.</para>
+  </listitem>
+  </varlistentry>
+</variablelist>
 </refsect1>
 
 <refsect1><title>EXAMPLES</title>
-<para>This example runs the &A; cleanup process by hand after
+<para>This example runs the Amanda cleanup process by hand after
 a failure.</para>
 
 <programlisting>
@@ -55,7 +88,7 @@ a failure.</para>
 
 <para>Putting the following line in a system boot script (e.g.
 <filename>/etc/rc.local</filename>)
-runs the &A; cleanup process as part of the reboot,
+runs the Amanda cleanup process as part of the reboot,
 eliminating the need to run it by hand.</para>
 
 <programlisting>
@@ -71,14 +104,9 @@ amcleanup: no unprocessed logfile to clean up.
 </programlisting>
 </refsect1>
 
-<refsect1><title>AUTHOR</title>
-<para>James da Silva, &email.jds;: Original text</para>
-<para>&maintainer.sgw;: XML-conversion</para>
-</refsect1>
+<seealso>
+<manref name="amdump" vol="8"/>
+</seealso>
 
-<refsect1><title>SEE ALSO</title>
-<para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
-<citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>
-</refsect1>
 </refentry>