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"
5 <!-- entities files to use -->
6 <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
10 <!-- lifted from troff+man by doclifter -->
11 <refentry id='amreport.8'>
14 <refentrytitle>amreport</refentrytitle>
15 <manvolnum>8</manvolnum>
21 <refname>amreport</refname>
22 <refpurpose>generate a formatted output of statistics for an &A; run</refpurpose>
27 <!-- body begins here -->
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>
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>
47 If no configuration name is specified, amanda.conf is
48 read from the current directory.</para>
51 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
52 man page for more details about &A;.</para>
55 <refsect1><title>OPTIONS</title>
56 <variablelist remap='TP'>
58 <term><emphasis remap='I'>config</emphasis></term>
60 <para>Name of the configuration to process.</para>
64 <term><option>-i</option></term>
66 <para>Don't email the report.</para>
70 <term><option>-M</option> <replaceable>address</replaceable></term>
72 <para>Mail the report to
73 <emphasis remap='I'>address</emphasis>
75 <emphasis remap='B'>mailto</emphasis>
77 <emphasis remap='I'>amanda.conf</emphasis>.
82 <term><option>-l</option> <replaceable>logfile</replaceable></term>
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>
92 <para><emphasis remap='I'>logdir</emphasis>/log</para>
97 <emphasis remap='I'>logdir</emphasis>
98 is the log directory defined in amanda.conf.</para>
99 <variablelist remap='TP'>
101 <term><option>-f</option> <replaceable>outputfile</replaceable></term>
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.
109 <emphasis remap='I'>outputfile</emphasis>
110 is specified, then the report is put in
111 <emphasis remap='I'>outputfile</emphasis>.</para>
115 <term><option>-p</option> <replaceable>postscriptfile</replaceable></term>
117 <para>Send the postscript output to the file
118 <emphasis remap='I'>postscriptfile</emphasis>
120 <citerefentry><refentrytitle>lpr</refentrytitle><manvolnum>1</manvolnum></citerefentry>
122 This option has an effect only if the
123 <emphasis remap='I'>lbl-templ</emphasis>
124 directive is specified in amanda.conf.</para>
129 <term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</replaceable></term>
131 <para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>" section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
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
144 Various label templates are provided to
145 format data for different tape sizes.</para>
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>
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
160 <command>amreport</command>
161 will not print tape labels.</para>
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>
169 <refsect1><title>TEMPLATES</title>
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>
177 <literallayout remap='.nf'>
182 </literallayout> <!-- .fi -->
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>
188 <refsect1><title>EXIT CODE</title>
189 The exit code of <command>amreport</command> is the ORed value of:
193 2 = a dle give strange message
195 8 = Don't know the status of a dle (RESULT_MISSING in the report)
196 16 = tape error or no more tape
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"/>