git.gag.com Git - debian/amanda/blob - man/xml-source/amreport.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='amreport.8'>
  12
  13 <refmeta>
  14 <refentrytitle>amreport</refentrytitle>
  15 <manvolnum>8</manvolnum>
  16 &rmi.source;
  17 &rmi.version;
  18 &rmi.manual.8;
  19 </refmeta>
  20 <refnamediv>
  21 <refname>amreport</refname>
  22 <refpurpose>generate a formatted output of statistics for an &A; run</refpurpose>
  23 </refnamediv>
  24 <refentryinfo>
  25 &author.sgw.xml;
  26 </refentryinfo>
  27 <!-- body begins here -->
  28 <refsynopsisdiv>
  29 <cmdsynopsis>
  30   <command>amreport</command>
  31     <arg choice='opt'><replaceable>config</replaceable></arg>
  32     <arg choice='opt'>-i</arg>
  33     <arg choice='opt'>-M <replaceable>address</replaceable></arg>
  34     <arg choice='opt'>-l <replaceable>logfile</replaceable></arg>
  35     <arg choice='opt'>-f <replaceable>outputfile</replaceable></arg>
  36     <arg choice='opt'>-p <replaceable>postscriptfile</replaceable></arg>
  37     <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o </arg><replaceable>configoption</replaceable></group></arg>
  38 </cmdsynopsis>
  39 </refsynopsisdiv>
  40
  41
  42 <refsect1><title>DESCRIPTION</title>
  43 <para><emphasis remap='B'>Amreport</emphasis>
  44 generates a summary report of an
  45 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  46 backup run.
  47 If no configuration name is specified, amanda.conf is
  48 read from the current directory.</para>
  49
  50 <para>See the
  51 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
  52 man page for more details about &A;.</para>
  53 </refsect1>
  54
  55 <refsect1><title>OPTIONS</title>
  56 <variablelist remap='TP'>
  57   <varlistentry>
  58   <term><emphasis remap='I'>config</emphasis></term>
  59   <listitem>
  60 <para>Name of the configuration to process.</para>
  61   </listitem>
  62   </varlistentry>
  63   <varlistentry>
  64   <term><option>-i</option></term>
  65   <listitem>
  66 <para>Don't email the report.</para>
  67   </listitem>
  68   </varlistentry>
  69   <varlistentry>
  70   <term><option>-M</option> <replaceable>address</replaceable></term>
  71   <listitem>
  72 <para>Mail the report to
  73 <emphasis remap='I'>address</emphasis>
  74 instead of the
  75 <emphasis remap='B'>mailto</emphasis>
  76 value from
  77 <emphasis remap='I'>amanda.conf</emphasis>.
  78 </para>
  79   </listitem>
  80   </varlistentry>
  81   <varlistentry>
  82   <term><option>-l</option> <replaceable>logfile</replaceable></term>
  83   <listitem>
  84 <para>Name of the log file to parse to generate the report.
  85 If a log file is not specified, it defaults to the file:</para>
  86   </listitem>
  87   </varlistentry>
  88 </variablelist>
  89
  90 <!-- .RS -->
  91 <!-- .RS -->
  92 <para><emphasis remap='I'>logdir</emphasis>/log</para>
  93 <!-- .RE -->
  94 <!-- .RE -->
  95
  96 <para>where
  97 <emphasis remap='I'>logdir</emphasis>
  98 is the log directory defined in amanda.conf.</para>
  99 <variablelist remap='TP'>
 100   <varlistentry>
 101   <term><option>-f</option> <replaceable>outputfile</replaceable></term>
 102   <listitem>
 103 <para>Normally,
 104 <command>amreport</command>
 105 sends the report via e-mail to the
 106 <emphasis remap='I'>mailto</emphasis>
 107 user as defined in the amanda.conf file.
 108 If
 109 <emphasis remap='I'>outputfile</emphasis>
 110 is specified, then the report is put in
 111 <emphasis remap='I'>outputfile</emphasis>.</para>
 112   </listitem>
 113   </varlistentry>
 114   <varlistentry>
 115   <term><option>-p</option> <replaceable>postscriptfile</replaceable></term>
 116   <listitem>
 117 <para>Send the postscript output to the file
 118 <emphasis remap='I'>postscriptfile</emphasis>
 119 instead of to the
 120 <citerefentry><refentrytitle>lpr</refentrytitle><manvolnum>1</manvolnum></citerefentry>
 121 command.
 122 This option has an effect only if the
 123 <emphasis remap='I'>lbl-templ</emphasis>
 124 directive is specified in amanda.conf.</para>
 125   </listitem>
 126   </varlistentry>
 127
 128   <varlistentry>
 129   <term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</replaceable></term>
 130   <listitem>
 131 <para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>" section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
 132   </listitem>
 133   </varlistentry>
 134
 135 </variablelist>
 136 </refsect1>
 137
 138 <refsect1><title>LABEL PRINTING</title>
 139 <para>&A; can print postscript labels describing the contents
 140 of tape(s) written in a run.
 141 The labels are designed to be folded and
 142 inserted into the tape case along with the tape or hole punched and put
 143 in a 3-ring binder.
 144 Various label templates are provided to
 145 format data for different tape sizes.</para>
 146
 147 <para>The information printed varies slightly between label templates
 148 due to size constraints.
 149 Labels contain one line for each host/file-system
 150 pair and may also contain the file number on the tape,
 151 the level of the dump,
 152 the original size of the dump
 153 and the size of the (possibly compressed) tape file.</para>
 154
 155 <para>Add the
 156 <emphasis remap='I'>lbl-templ</emphasis>
 157 parameter to the tapetype definition in amanda.conf to enable labels.
 158 If you don't add this line to your
 159 tapetype definition,
 160 <command>amreport</command>
 161 will not print tape labels.</para>
 162
 163 <para>You may use the
 164 <emphasis>remap='I'>printer</emphasis>
 165 keyword in amanda.conf to print to other than the system default printer.</para>
 166
 167 </refsect1>
 168
 169 <refsect1><title>TEMPLATES</title>
 170
 171 <para>&A; provides label templates for the following tape types.
 172 These are pretty generic labels and should be easy to customize for
 173 other tape types or particular site needs.</para>
 174
 175 <!-- .RS -->
 176 <!-- .RS -->
 177 <literallayout remap='.nf'>
 178 * ExaByte 8mm tapes
 179 * DAT 4mm tapes
 180 * DLT tapes
 181 * 3-ring binder
 182 </literallayout> <!-- .fi -->
 183
 184 <para>The 3-ring binder type is the most generic.
 185 It may be used to make a hardcopy log of the tapes.</para>
 186 </refsect1>
 187
 188 <refsect1><title>EXIT CODE</title>
 189 The exit code of <command>amreport</command> is the ORed value of:
 190 <programlisting>
 191  0  = success
 192  1  = error
 193  2  = a dle give strange message
 194  4  = a dle failed
 195  8  = Don't know the status of a dle (RESULT_MISSING in the report)
 196  16 = tape error or no more tape
 197 </programlisting>
 198 </refsect1>
 199
 200 <refsect1><title>SEE ALSO</title>
 201 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 202 <citerefentry><refentrytitle>amflush</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
 203 <ulink url="http://wiki.zmanda.com"/>
 204 </para>
 205 </refsect1>
 206 </refentry>
 207