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>
18 <refname>amreport</refname>
19 <refpurpose>generate a formatted output of statistics for an &A; run</refpurpose>
21 <!-- body begins here -->
24 <command>amreport</command>
25 <arg choice='opt'><replaceable>config</replaceable></arg>
26 <arg choice='opt'>-i</arg>
27 <arg choice='opt'>-M <replaceable>address</replaceable></arg>
28 <arg choice='opt'>-l <replaceable>logfile</replaceable></arg>
29 <arg choice='opt'>-f <replaceable>outputfile</replaceable></arg>
30 <arg choice='opt'>-p <replaceable>postscriptfile</replaceable></arg>
31 <arg choice='plain' rep='repeat'><group><arg choice='plain'>-o </arg><replaceable>configoption</replaceable></group></arg>
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>
41 If no configuration name is specified, amanda.conf is
42 read from the current directory.</para>
45 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
46 man page for more details about &A;.</para>
49 <refsect1><title>OPTIONS</title>
50 <variablelist remap='TP'>
52 <term><emphasis remap='I'>config</emphasis></term>
54 <para>Name of the configuration to process.</para>
58 <term><option>-i</option></term>
60 <para>Don't email the report.</para>
64 <term><option>-M</option> <replaceable>address</replaceable></term>
66 <para>Mail the report to
67 <emphasis remap='I'>address</emphasis>
69 <emphasis remap='B'>mailto</emphasis>
71 <emphasis remap='I'>amanda.conf</emphasis>.
76 <term><option>-l</option> <replaceable>logfile</replaceable></term>
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>
86 <para><emphasis remap='I'>logdir</emphasis>/log</para>
91 <emphasis remap='I'>logdir</emphasis>
92 is the log directory defined in amanda.conf.</para>
93 <variablelist remap='TP'>
95 <term><option>-f</option> <replaceable>outputfile</replaceable></term>
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.
103 <emphasis remap='I'>outputfile</emphasis>
104 is specified, then the report is put in
105 <emphasis remap='I'>outputfile</emphasis>.</para>
109 <term><option>-p</option> <replaceable>postscriptfile</replaceable></term>
111 <para>Send the postscript output to the file
112 <emphasis remap='I'>postscriptfile</emphasis>
114 <citerefentry><refentrytitle>lpr</refentrytitle><manvolnum>1</manvolnum></citerefentry>
116 This option has an effect only if the
117 <emphasis remap='I'>lbl-templ</emphasis>
118 directive is specified in amanda.conf.</para>
123 <term><emphasis remap='B'>-o</emphasis> <replaceable>configoption</replaceable></term>
125 <para>See the "<emphasis remap='B'>CONFIGURATION OVERRIDE</emphasis>" section in <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>.</para>
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
138 Various label templates are provided to
139 format data for different tape sizes.</para>
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>
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
154 <command>amreport</command>
155 will not print tape labels.</para>
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>
163 <refsect1><title>TEMPLATES</title>
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>
171 <literallayout remap='.nf'>
176 </literallayout> <!-- .fi -->
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>
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>