Imported Upstream version 2.5.1
[debian/amanda] / man / amreport.8
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "AMREPORT" 8 "" "" ""
21 .SH "NAME"
22 amreport - generate a formatted output of statistics for an Amanda run
23 .SH "SYNOPSIS"
24 .HP 9
25 \fBamreport\fR [\fIconfig\fR] [-i] [-M \fIaddress\fR] [-l \fIlogfile\fR] [-f \fIoutputfile\fR] [-p \fIpostscriptfile\fR] [-o \fIconfigoption\fR]*
26
27 .SH "DESCRIPTION"
28 .PP
29 \fBAmreport\fR
30 generates a summary report of an
31 \fBamanda\fR(8)
32 backup run. If no configuration name is specified, amanda.conf is read from the current directory.
33 .PP
34 See the
35 \fBamanda\fR(8)
36 man page for more details about
37 \fBAmanda\fR.
38 .SH "OPTIONS"
39 .TP
40 \fBconfig\fR
41 Name of the configuration to process.
42 .TP
43 \fB-i\fR
44 Don't email the report.
45 .TP
46 \fB-M\fR \fIaddress\fR
47 Mail the report to
48 \fBaddress\fR
49 instead of the
50 \fBmailto\fR
51 value from
52 \fBamanda.conf\fR.
53 .TP
54 \fB-l\fR \fIlogfile\fR
55 Name of the log file to parse to generate the report. If a log file is not specified, it defaults to the file:
56 .PP
57 \fBlogdir\fR/log
58 .PP
59 where
60 \fBlogdir\fR
61 is the log directory defined in amanda.conf.
62 .TP
63 \fB-f\fR \fIoutputfile\fR
64 Normally,
65 \fBamreport\fR
66 sends the report via e-mail to the
67 \fBmailto\fR
68 user as defined in the amanda.conf file. If
69 \fBoutputfile\fR
70 is specified, then the report is put in
71 \fBoutputfile\fR.
72 .TP
73 \fB-p\fR \fIpostscriptfile\fR
74 Send the postscript output to the file
75 \fBpostscriptfile\fR
76 instead of to the
77 \fBlpr\fR(1)
78 command. This option has an effect only if the
79 \fBlbl-templ\fR
80 directive is specified in amanda.conf.
81 .TP
82 \fB-o\fR \fIconfigoption\fR
83 See the "\fBCONFIGURATION OVERWRITE\fR" section in
84 \fBamanda\fR(8).
85 .SH "LABEL PRINTING"
86 .PP
87 \fBAmanda\fR
88 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.
89 .PP
90 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.
91 .PP
92 Add the
93 \fBlbl-templ\fR
94 parameter to the tapetype definition in amanda.conf to enable labels. If you don't add this line to your tapetype definition,
95 \fBamreport\fR
96 will not print tape labels.
97 .PP
98 You may use the
99 \fBremap='I'>printer\fR
100 keyword in amanda.conf to print to other than the system default printer.
101 .SH "TEMPLATES"
102 .PP
103 \fBAmanda\fR
104 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.
105 .sp
106 .nf
107
108 * ExaByte 8mm tapes
109 * DAT 4mm tapes
110 * DLT tapes
111 * 3-ring binder
112
113 .fi
114 .sp
115 .PP
116 The 3-ring binder type is the most generic. It may be used to make a hardcopy log of the tapes.
117 .SH "SEE ALSO"
118 .PP
119 \fBamanda\fR(8),
120 \fBamflush\fR(8)
121