git.gag.com Git - debian/amanda/blob - 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='opt'><option>-k</option></arg>
  26     <arg choice='opt'><option>-v</option></arg>
  27     <arg choice='plain'><replaceable>config</replaceable></arg>
  28 </cmdsynopsis>
  29 </refsynopsisdiv>
  30
  31
  32 <refsect1><title>DESCRIPTION</title>
  33 <para><emphasis remap='B'>Amcleanup</emphasis>
  34 generates the
  35 <emphasis remap='I'>&A; Mail Report</emphasis>
  36 and updates the &A; databases after a system failure on a tape server host.
  37 This cleanup process is normally done automatically as part of the
  38 <emphasis remap='B'>amdump</emphasis>
  39 program, but if
  40 <emphasis remap='B'>amdump</emphasis>
  41 cannot complete for some reason (usually because of a tape server host crash),
  42 <command>amcleanup</command>
  43 must be run some time later (usually during system boot).</para>
  44
  45 <para>See the
  46 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  47 man page for more details about &A;.</para>
  48 </refsect1>
  49
  50 <refsect1><title>OPTIONS</title>
  51 <variablelist remap='TP'>
  52   <varlistentry>
  53   <term><option>-k</option></term>
  54   <listitem>
  55    <para>Kill all Amanda processes.</para>
  56   </listitem>
  57   </varlistentry>
  58   <varlistentry>
  59   <term><option>-v</option></term>
  60   <listitem>
  61    <para>Generate verbose output.</para>
  62   </listitem>
  63   </varlistentry>
  64 </variablelist>
  65 </refsect1>
  66
  67 <refsect1><title>EXAMPLES</title>
  68 <para>This example runs the &A; cleanup process by hand after
  69 a failure.</para>
  70
  71 <programlisting>
  72 % amcleanup daily
  73 </programlisting>
  74
  75 <para>Putting the following line in a system boot script (e.g.
  76 <filename>/etc/rc.local</filename>)
  77 runs the &A; cleanup process as part of the reboot,
  78 eliminating the need to run it by hand.</para>
  79
  80 <programlisting>
  81 /usr/local/sbin/amcleanup daily
  82 </programlisting>
  83
  84 <para>If nothing needs to be done,
  85 <command>amcleanup</command>
  86 exits normally with the message:</para>
  87
  88 <programlisting>
  89 amcleanup: no unprocessed logfile to clean up.
  90 </programlisting>
  91 </refsect1>
  92
  93 <refsect1><title>AUTHOR</title>
  94 <para>James da Silva, &email.jds;: Original text</para>
  95 <para>&maintainer.sgw;: XML-conversion</para>
  96 </refsect1>
  97
  98 <refsect1><title>SEE ALSO</title>
  99 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 100 <citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 101 <ulink url="http://wiki.zmanda.com"/>
 102 </para>
 103 </refsect1>
 104 </refentry>
 105