Imported Upstream version 2.6.0p1
[debian/amanda] / man / amreport.8
1 .\"     Title: amreport
2 .\"    Author: 
3 .\" Generator: DocBook XSL Stylesheets v1.73.2 <http://docbook.sf.net/>
4 .\"      Date: 05/14/2008
5 .\"    Manual: 
6 .\"    Source: 
7 .\"
8 .TH "AMREPORT" "8" "05/14/2008" "" ""
9 .\" disable hyphenation
10 .nh
11 .\" disable justification (adjust text to left margin only)
12 .ad l
13 .SH "NAME"
14 amreport - generate a formatted output of statistics for an Amanda run
15 .SH "SYNOPSIS"
16 .HP 9
17 \fBamreport\fR [\fIconfig\fR] [\-i] [\-M\ \fIaddress\fR] [\-l\ \fIlogfile\fR] [\-f\ \fIoutputfile\fR] [\-p\ \fIpostscriptfile\fR] [\-o\ \fIconfigoption\fR]...
18 .SH "DESCRIPTION"
19 .PP
20 \fBAmreport\fR
21 generates a summary report of an
22 \fBamanda\fR(8)
23 backup run\. If no configuration name is specified, amanda\.conf is read from the current directory\.
24 .PP
25 See the
26 \fBamanda\fR(8)
27 man page for more details about
28 \fIAmanda\fR\.
29 .SH "OPTIONS"
30 .PP
31 \fIconfig\fR
32 .RS 4
33 Name of the configuration to process\.
34 .RE
35 .PP
36 \fB\-i\fR
37 .RS 4
38 Don\'t email the report\.
39 .RE
40 .PP
41 \fB\-M\fR \fIaddress\fR
42 .RS 4
43 Mail the report to
44 \fIaddress\fR
45 instead of the
46 \fBmailto\fR
47 value from
48 \fIamanda\.conf\fR\.
49 .RE
50 .PP
51 \fB\-l\fR \fIlogfile\fR
52 .RS 4
53 Name of the log file to parse to generate the report\. If a log file is not specified, it defaults to the file:
54 .RE
55 .PP
56 \fIlogdir\fR/log
57 .PP
58 where
59 \fIlogdir\fR
60 is the log directory defined in amanda\.conf\.
61 .PP
62 \fB\-f\fR \fIoutputfile\fR
63 .RS 4
64 Normally,
65 \fBamreport\fR
66 sends the report via e\-mail to the
67 \fImailto\fR
68 user as defined in the amanda\.conf file\. If
69 \fIoutputfile\fR
70 is specified, then the report is put in
71 \fIoutputfile\fR\.
72 .RE
73 .PP
74 \fB\-p\fR \fIpostscriptfile\fR
75 .RS 4
76 Send the postscript output to the file
77 \fIpostscriptfile\fR
78 instead of to the
79 \fBlpr\fR(1)
80 command\. This option has an effect only if the
81 \fIlbl\-templ\fR
82 directive is specified in amanda\.conf\.
83 .RE
84 .PP
85 \fB\-o\fR \fIconfigoption\fR
86 .RS 4
87 See the "\fBCONFIGURATION OVERRIDE\fR" section in
88 \fBamanda\fR(8)\.
89 .RE
90 .SH "LABEL PRINTING"
91 .PP
92 \fIAmanda\fR
93 can print postscript labels describing the contents of tape(s) written in a run\. The labels are designed to be folded and inserted into the tape case along with the tape or hole punched and put in a 3\-ring binder\. Various label templates are provided to format data for different tape sizes\.
94 .PP
95 The information printed varies slightly between label templates due to size constraints\. Labels contain one line for each host/file\-system pair and may also contain the file number on the tape, the level of the dump, the original size of the dump and the size of the (possibly compressed) tape file\.
96 .PP
97 Add the
98 \fIlbl\-templ\fR
99 parameter to the tapetype definition in amanda\.conf to enable labels\. If you don\'t add this line to your tapetype definition,
100 \fBamreport\fR
101 will not print tape labels\.
102 .PP
103 You may use the
104 \fIremap=\'I\'>printer\fR
105 keyword in amanda\.conf to print to other than the system default printer\.
106 .SH "TEMPLATES"
107 .PP
108 \fIAmanda\fR
109 provides label templates for the following tape types\. These are pretty generic labels and should be easy to customize for other tape types or particular site needs\.
110 .sp
111 .RS 4
112 .nf
113 * ExaByte 8mm tapes
114 * DAT 4mm tapes
115 * DLT tapes
116 * 3\-ring binder
117 .fi
118 .RE
119 .PP
120 The 3\-ring binder type is the most generic\. It may be used to make a hardcopy log of the tapes\.
121 .SH "SEE ALSO"
122 .PP
123 \fBamanda\fR(8),
124 \fBamflush\fR(8),
125 \fI\%http://wiki.zmanda.com\fR