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>-v</option></arg>
  35     <arg choice='plain'><replaceable>config</replaceable></arg>
  36 </cmdsynopsis>
  37 </refsynopsisdiv>
  38
  39
  40 <refsect1><title>DESCRIPTION</title>
  41 <para><emphasis remap='B'>Amcleanup</emphasis>
  42 generates the
  43 <emphasis remap='I'>Amanda Mail Report</emphasis>
  44 and updates the Amanda databases after a system failure on a tape server host.
  45 This cleanup process is normally done automatically as part of the
  46 <emphasis remap='B'>amdump</emphasis>
  47 program, but if
  48 <emphasis remap='B'>amdump</emphasis>
  49 cannot complete for some reason (usually because of a tape server host crash),
  50 <command>amcleanup</command>
  51 must be run some time later (usually during system boot).</para>
  52
  53 <para>See the
  54 <manref name="amanda" vol="8"/>
  55 man page for more details about Amanda.</para>
  56 </refsect1>
  57
  58 <refsect1><title>OPTIONS</title>
  59 <variablelist remap='TP'>
  60   <varlistentry>
  61   <term><option>-k</option></term>
  62   <listitem>
  63    <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>
  64   </listitem>
  65   </varlistentry>
  66   <varlistentry>
  67   <term><option>-p</option></term>
  68   <listitem>
  69    <para>Do the cleanup only if all process listed in the log file are already terminated.</para>
  70   </listitem>
  71   </varlistentry>
  72   <varlistentry>
  73   <term><option>-v</option></term>
  74   <listitem>
  75    <para>Generate verbose output.</para>
  76   </listitem>
  77   </varlistentry>
  78 </variablelist>
  79 </refsect1>
  80
  81 <refsect1><title>EXAMPLES</title>
  82 <para>This example runs the Amanda cleanup process by hand after
  83 a failure.</para>
  84
  85 <programlisting>
  86 % amcleanup daily
  87 </programlisting>
  88
  89 <para>Putting the following line in a system boot script (e.g.
  90 <filename>/etc/rc.local</filename>)
  91 runs the Amanda cleanup process as part of the reboot,
  92 eliminating the need to run it by hand.</para>
  93
  94 <programlisting>
  95 /usr/local/sbin/amcleanup daily
  96 </programlisting>
  97
  98 <para>If nothing needs to be done,
  99 <command>amcleanup</command>
 100 exits normally with the message:</para>
 101
 102 <programlisting>
 103 amcleanup: no unprocessed logfile to clean up.
 104 </programlisting>
 105 </refsect1>
 106
 107 <seealso>
 108 <manref name="amdump" vol="8"/>
 109 </seealso>
 110
 111 </refentry>
 112