11a36bc890207ebf3c629dbfa4670872dd24415b
[debian/amanda] / man / xml-source / amcleanup.8.xml
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
4 [
5   <!-- entities files to use -->
6   <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
7   %global_entities;
8 ]>
9
10 <!-- lifted from troff+man by doclifter -->
11 <refentry id='amcleanup.8'>
12
13 <refmeta>
14 <refentrytitle>amcleanup</refentrytitle>
15 <manvolnum>8</manvolnum>
16 </refmeta>
17 <refnamediv>
18 <refname>amcleanup</refname>
19 <refpurpose>run the &A; cleanup process after a failure</refpurpose>
20 </refnamediv>
21 <!-- body begins here -->
22 <refsynopsisdiv>
23 <cmdsynopsis>
24   <command>amcleanup</command>    
25     <arg choice='plain'><replaceable>config</replaceable></arg>
26 </cmdsynopsis>
27 </refsynopsisdiv>
28
29
30 <refsect1><title>DESCRIPTION</title>
31 <para><emphasis remap='B'>Amcleanup</emphasis>
32 generates the
33 <emphasis remap='I'>&A; Mail Report</emphasis>
34 and updates the &A; databases after a system failure on a tape server host.
35 This cleanup process is normally done automatically as part of the
36 <emphasis remap='B'>amdump</emphasis>
37 program, but if
38 <emphasis remap='B'>amdump</emphasis>
39 cannot complete for some reason (usually because of a tape server host crash),
40 <command>amcleanup</command>
41 must be run some time later (usually during system boot).</para>
42
43 <para>See the
44 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
45 man page for more details about &A;.</para>
46 </refsect1>
47
48 <refsect1><title>EXAMPLES</title>
49 <para>This example runs the &A; cleanup process by hand after
50 a failure.</para>
51
52 <programlisting>
53 % amcleanup daily
54 </programlisting>
55
56 <para>Putting the following line in a system boot script (e.g.
57 <filename>/etc/rc.local</filename>)
58 runs the &A; cleanup process as part of the reboot,
59 eliminating the need to run it by hand.</para>
60
61 <programlisting>
62 /usr/local/sbin/amcleanup daily
63 </programlisting>
64
65 <para>If nothing needs to be done,
66 <command>amcleanup</command>
67 exits normally with the message:</para>
68
69 <programlisting>
70 amcleanup: no unprocessed logfile to clean up.
71 </programlisting>
72 </refsect1>
73
74 <refsect1><title>AUTHOR</title>
75 <para>James da Silva, &email.jds;: Original text</para>
76 <para>&maintainer.sgw;: XML-conversion</para>
77 </refsect1>
78
79 <refsect1><title>SEE ALSO</title>
80 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
81 <citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry></para>
82 </refsect1>
83 </refentry>
84