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 '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 &rmi.source;
  17 &rmi.version;
  18 &rmi.manual.8;
  19 </refmeta>
  20 <refnamediv>
  21 <refname>amcleanup</refname>
  22 <refpurpose>run the Amanda cleanup process after a failure</refpurpose>
  23 </refnamediv>
  24 <refentryinfo>
  25 &author.jds;
  26 &author.sgw.xml;
  27 </refentryinfo>
  28 <!-- body begins here -->
  29 <refsynopsisdiv>
  30 <cmdsynopsis>
  31   <command>amcleanup</command>
  32     <arg choice='opt'><option>-k</option></arg>
  33     <arg choice='opt'><option>-p</option></arg>
  34     <arg choice='opt'><option>-r</option></arg>
  35     <arg choice='opt'><option>-v</option></arg>
  36     <arg choice='plain'><replaceable>config</replaceable></arg>
  37 </cmdsynopsis>
  38 </refsynopsisdiv>
  39
  40
  41 <refsect1><title>DESCRIPTION</title>
  42 <para><emphasis remap='B'>Amcleanup</emphasis>
  43 generates the
  44 <emphasis remap='I'>Amanda Mail Report</emphasis>
  45 and updates the Amanda databases after a system failure on a tape server host.
  46 This cleanup process is normally done automatically as part of the
  47 <emphasis remap='B'>amdump</emphasis>
  48 program, but if
  49 <emphasis remap='B'>amdump</emphasis>
  50 cannot complete for some reason (usually because of a tape server host crash),
  51 <command>amcleanup</command>
  52 must be run some time later (usually during system boot).</para>
  53
  54 <para>The <emphasis remap='B'>amcleanupdisk</emphasis> program is run with
  55 the same <arg choice='opt'><option>-r</option></arg> and
  56 <arg choice='opt'><option>-v</option></arg> options.</para>
  57
  58 <para>See the
  59 <manref name="amanda" vol="8"/>
  60 man page for more details about Amanda.</para>
  61 </refsect1>
  62
  63 <refsect1><title>OPTIONS</title>
  64 <variablelist remap='TP'>
  65   <varlistentry>
  66   <term><option>-k</option></term>
  67   <listitem>
  68    <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>
  69   </listitem>
  70   </varlistentry>
  71   <varlistentry>
  72   <term><option>-p</option></term>
  73   <listitem>
  74    <para>Do the cleanup only if all process listed in the log file are already terminated.</para>
  75   </listitem>
  76   </varlistentry>
  77   <varlistentry>
  78   <term><option>-r</option></term>
  79   <listitem>
  80    <para>Remove bad file in holding disk.  This options is passed to amcleanupdisk.</para>
  81   </listitem>
  82   </varlistentry>
  83   <varlistentry>
  84   <term><option>-v</option></term>
  85   <listitem>
  86    <para>Generate verbose output.  This options is passed to amcleanupdisk.</para>
  87   </listitem>
  88   </varlistentry>
  89 </variablelist>
  90 </refsect1>
  91
  92 <refsect1><title>EXAMPLES</title>
  93 <para>This example runs the Amanda cleanup process by hand after
  94 a failure.</para>
  95
  96 <programlisting>
  97 % amcleanup daily
  98 </programlisting>
  99
 100 <para>Putting the following line in a system boot script (e.g.
 101 <filename>/etc/rc.local</filename>)
 102 runs the Amanda cleanup process as part of the reboot,
 103 eliminating the need to run it by hand.</para>
 104
 105 <programlisting>
 106 /usr/local/sbin/amcleanup daily
 107 </programlisting>
 108
 109 <para>If nothing needs to be done,
 110 <command>amcleanup</command>
 111 exits normally with the message:</para>
 112
 113 <programlisting>
 114 amcleanup: no unprocessed logfile to clean up.
 115 </programlisting>
 116 </refsect1>
 117
 118 <seealso>
 119 <manref name="amdump" vol="8"/>
 120 </seealso>
 121
 122 </refentry>
 123