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