Imported Upstream version 2.5.0
[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 .ad l
25 .hy 0
26 .HP 9
27 \fBamreport\fR [\fIconfig\fR] [\-l\ \fIlogfile\fR] [\-f\ \fIoutputfile\fR] [\-p\ \fIpostscriptfile\fR]
28 .ad
29 .hy
30
31 .SH "DESCRIPTION"
32
33 .PP
34 \fBAmreport\fR generates a summary report of an \fBamanda\fR(8) backup run\&. If no configuration name is specified, amanda\&.conf is read from the current directory\&.
35
36 .PP
37 See the \fBamanda\fR(8) man page for more details about \fBAmanda\fR\&.
38
39 .SH "OPTIONS"
40
41 .TP
42 \fBconfig\fR
43 Name of the configuration to process\&.
44
45 .TP
46 \fB\-l\fR \fIlogfile\fR
47 Name of the log file to parse to generate the report\&. If a log file is not specified, it defaults to the file:
48
49 .PP
50 \fBlogdir\fR/log
51
52 .PP
53 where \fBlogdir\fR is the log directory defined in amanda\&.conf\&.
54
55 .TP
56 \fB\-f\fR \fIoutputfile\fR
57 Normally, \fBamreport\fR sends the report via e\-mail to the \fBmailto\fR user as defined in the amanda\&.conf file\&. If \fBoutputfile\fR is specified, then the report is put in \fBoutputfile\fR\&.
58
59 .TP
60 \fB\-p\fR \fIpostscriptfile\fR
61 Send the postscript output to the file \fBpostscriptfile\fR instead of to the \fBlpr\fR(1) command\&. This option has an effect only if the \fBlbl\-templ\fR directive is specified in amanda\&.conf\&.
62
63 .SH "LABEL PRINTING"
64
65 .PP
66 \fBAmanda\fR 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\&.
67
68 .PP
69 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\&.
70
71 .PP
72 Add the \fBlbl\-templ\fR parameter to the tapetype definition in amanda\&.conf to enable labels\&. If you don't add this line to your tapetype definition, \fBamreport\fR will not print tape labels\&.
73
74 .PP
75 You may use the \fBremap='I'>printer\fR keyword in amanda\&.conf to print to other than the system default printer\&.
76
77 .SH "TEMPLATES"
78
79 .PP
80 \fBAmanda\fR 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\&.
81
82 .nf
83
84 * ExaByte 8mm tapes
85 * DAT 4mm tapes
86 * DLT tapes
87 * 3\-ring binder
88
89 .fi
90
91 .PP
92 The 3\-ring binder type is the most generic\&. It may be used to make a hardcopy log of the tapes\&.
93
94 .SH "SEE ALSO"
95
96 .PP
97 \fBamanda\fR(8), \fBamflush\fR(8)
98