Imported Upstream version 2.4.4p3
[debian/amanda] / man / amreport.8.in
1 .\"
2 .de EX
3 .if t .ft C
4 .nf
5 ..
6 .de EE
7 .fi
8 .if t .ft
9 ..
10 .de OP
11 \fB\\$1\fP \fI\\$2\fP
12 ..
13 .TH AMREPORT 1
14 .SH NAME
15 amreport \- generate a formatted output of statistics for an Amanda run
16 .SH SYNOPSIS
17 .B amreport
18 [
19 .I config
20 ] [
21 .B -l
22 .I logfile
23 ] [
24 .B -f
25 .I outputfile
26 ] [
27 .B -p
28 .I postscriptfile
29
30 .SH DESCRIPTION
31 .B Amreport
32 generates a summary report of an
33 .IR amanda (8)
34 backup run.
35 If no configuration name is specified, amanda.conf is
36 read from the current directory.
37 .LP
38 See the
39 .IR amanda (8)
40 man page for more details about Amanda.
41 .SH OPTIONS
42 .TP
43 .I config
44 Name of the configuration to process.
45 .TP
46 .OP -l logfile
47 Name of the log file to parse to generate the report.
48 If a log file is not specified, it defaults to the file:
49 .LP
50 .RS
51 .RS
52 \fIlogdir\fP/log
53 .RE  
54 .RE  
55 .IP  
56 where
57 .I logdir
58 is the log directory defined in amanda.conf.
59 .TP
60 .OP -f outputfile
61 Normally,
62 .B amreport
63 sends the report via e-mail to the
64 .I mailto
65 user as defined in the amanda.conf file.
66 If
67 .I outputfile
68 is specified, then the report is put in
69 .IR outputfile .
70 .TP
71 .OP -p postscriptfile
72 Send the postscript output to the file
73 .I postscriptfile
74 instead of to the
75 .IR lpr (1)
76 command.
77 This option has an effect only if the
78 .I lbl-templ
79 directive is specified in amanda.conf.
80 .SH LABEL PRINTING
81 .LP
82 Amanda can print postscript labels describing the contents
83 of tape(s) written in a run.
84 The labels are designed to be folded and
85 inserted into the tape case along with the tape or hole punched and put 
86 in a 3-ring binder.
87 Various label templates are provided to
88 format data for different tape sizes.
89 .LP
90 The information printed varies slightly between label templates
91 due to size constraints.
92 Labels contain one line for each host/file-system
93 pair and may also contain the file number on the tape,
94 the level of the dump,
95 the original size of the dump
96 and the size of the (possibly compressed) tape file.
97 .LP
98 Add the
99 .I lbl-templ
100 parameter to the tapetype definition in amanda.conf to enable labels.
101 If you don't add this line to your
102 tapetype definition,
103 .B amreport
104 will not print tape labels.
105 .LP
106 You may use the
107 .I printer
108 keyword in amanda.conf to print to other than the system default printer.
109 .LP
110 .SH TEMPLATES
111 .sp
112 Amanda provides label templates for the following tape types.
113 These are pretty generic labels and should be easy to customize for
114 other tape types or particular site needs.
115 .LP
116 .RS
117 .RS
118 .nf
119 * ExaByte 8mm tapes
120 * DAT 4mm tapes
121 * DLT tapes
122 * 3-ring binder
123 .fi
124 .RE
125 .RE
126 .LP
127 The 3-ring binder type is the most generic.
128 It may be used to make a hardcopy log of the tapes.
129 .SH "SEE ALSO"
130 amanda(8),
131 amflush(8)