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'><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>
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>
38 If no configuration name is specified, amanda.conf is
39 read from the current directory.</para>
42 <citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>
43 man page for more details about &A;.</para>
46 <refsect1><title>OPTIONS</title>
47 <variablelist remap='TP'>
49 <term><emphasis remap='I'>config</emphasis></term>
51 <para>Name of the configuration to process.</para>
55 <term><option>-l</option> <replaceable>logfile</replaceable></term>
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>
65 <para><emphasis remap='I'>logdir</emphasis>/log</para>
70 <emphasis remap='I'>logdir</emphasis>
71 is the log directory defined in amanda.conf.</para>
72 <variablelist remap='TP'>
74 <term><option>-f</option> <replaceable>outputfile</replaceable></term>
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.
82 <emphasis remap='I'>outputfile</emphasis>
83 is specified, then the report is put in
84 <emphasis remap='I'>outputfile</emphasis>.</para>
88 <term><option>-p</option> <replaceable>postscriptfile</replaceable></term>
90 <para>Send the postscript output to the file
91 <emphasis remap='I'>postscriptfile</emphasis>
93 <citerefentry><refentrytitle>lpr</refentrytitle><manvolnum>1</manvolnum></citerefentry>
95 This option has an effect only if the
96 <emphasis remap='I'>lbl-templ</emphasis>
97 directive is specified in amanda.conf.</para>
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
109 Various label templates are provided to
110 format data for different tape sizes.</para>
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>
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
125 <command>amreport</command>
126 will not print tape labels.</para>
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>
134 <refsect1><title>TEMPLATES</title>
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>
142 <literallayout remap='.nf'>
147 </literallayout> <!-- .fi -->
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>
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>