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