git.gag.com Git - debian/amanda/blob - man/amreport.8

   1 .\"     Title: amreport
   2 .\"    Author: Stefan G. Weichinger <sgw@amanda.org>
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 01/22/2009
   5 .\"    Manual: System Administration Commands
   6 .\"    Source: Amanda 2.6.1
   7 .\"  Language: English
   8 .\"
   9 .TH "AMREPORT" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 amreport \- generate a formatted output of statistics for an \fIAmanda\fR run
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBamreport\fR\ 'u
 174 \fBamreport\fR [\fIconfig\fR] [\-i] [\-M\ \fIaddress\fR] [\-l\ \fIlogfile\fR] [\-f\ \fIoutputfile\fR] [\-p\ \fIpostscriptfile\fR] [\-o\ \fIconfigoption\fR]...
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 \fBAmreport\fR
 179 generates a summary report of an
 180 \fBamanda\fR(8)
 181 backup run\&. If no configuration name is specified, amanda\&.conf is read from the current directory\&.
 182 .PP
 183 See the
 184 \fBamanda\fR(8)
 185 man page for more details about
 186 \fIAmanda\fR\&.
 187 .SH "OPTIONS"
 188 .PP
 189 \fIconfig\fR
 190 .RS 4
 191 Name of the configuration to process\&.
 192 .RE
 193 .PP
 194 \fB\-i\fR
 195 .RS 4
 196 Don\'t email the report\&.
 197 .RE
 198 .PP
 199 \fB\-M\fR \fIaddress\fR
 200 .RS 4
 201 Mail the report to
 202 \fIaddress\fR
 203 instead of the
 204 \fBmailto\fR
 205 value from
 206 \fIamanda\&.conf\fR\&.
 207 .RE
 208 .PP
 209 \fB\-l\fR \fIlogfile\fR
 210 .RS 4
 211 Name of the log file to parse to generate the report\&. If a log file is not specified, it defaults to the file:
 212 .RE
 213 .PP
 214 \fIlogdir\fR/log
 215 .PP
 216 where
 217 \fIlogdir\fR
 218 is the log directory defined in amanda\&.conf\&.
 219 .PP
 220 \fB\-f\fR \fIoutputfile\fR
 221 .RS 4
 222 Normally,
 223 \fBamreport\fR
 224 sends the report via e\-mail to the
 225 \fImailto\fR
 226 user as defined in the amanda\&.conf file\&. If
 227 \fIoutputfile\fR
 228 is specified, then the report is put in
 229 \fIoutputfile\fR\&.
 230 .RE
 231 .PP
 232 \fB\-p\fR \fIpostscriptfile\fR
 233 .RS 4
 234 Send the postscript output to the file
 235 \fIpostscriptfile\fR
 236 instead of to the
 237 \fBlpr\fR(1)
 238 command\&. This option has an effect only if the
 239 \fIlbl\-templ\fR
 240 directive is specified in amanda\&.conf\&.
 241 .RE
 242 .PP
 243 \fB\-o\fR \fIconfigoption\fR
 244 .RS 4
 245 See the "\fBCONFIGURATION OVERRIDE\fR" section in
 246 \fBamanda\fR(8)\&.
 247 .RE
 248 .SH "LABEL PRINTING"
 249 .PP
 250 \fIAmanda\fR
 251 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\&.
 252 .PP
 253 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\&.
 254 .PP
 255 Add the
 256 \fIlbl\-templ\fR
 257 parameter to the tapetype definition in amanda\&.conf to enable labels\&. If you don\'t add this line to your tapetype definition,
 258 \fBamreport\fR
 259 will not print tape labels\&.
 260 .PP
 261 You may use the
 262 \fIremap=\'I\'>printer\fR
 263 keyword in amanda\&.conf to print to other than the system default printer\&.
 264 .SH "TEMPLATES"
 265 .PP
 266 \fIAmanda\fR
 267 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\&.
 268 .sp
 269 .if n \{\
 270 .RS 4
 271 .\}
 272 .fam C
 273 .ps -1
 274 .nf
 275 .if t \{\
 276 .sp -1
 277 .\}
 278 .BB lightgray adjust-for-leading-newline
 279 .sp -1
 280
 281 * ExaByte 8mm tapes
 282 * DAT 4mm tapes
 283 * DLT tapes
 284 * 3\-ring binder
 285 .EB lightgray adjust-for-leading-newline
 286 .if t \{\
 287 .sp 1
 288 .\}
 289 .fi
 290 .fam
 291 .ps +1
 292 .if n \{\
 293 .RE
 294 .\}
 295 .PP
 296 The 3\-ring binder type is the most generic\&. It may be used to make a hardcopy log of the tapes\&.
 297 .SH "EXIT CODE"
 298
 299 The exit code of \fBamreport\fR is the ORed value of:
 300 .nf
 301  0  = success
 302  1  = error
 303  2  = a dle give strange message
 304  4  = a dle failed
 305  8  = Don\'t know the status of a dle (RESULT_MISSING in the report)
 306  16 = tape error or no more tape
 307 .fi
 308 .SH "SEE ALSO"
 309 .PP
 310 \fBamanda\fR(8),
 311 \fBamflush\fR(8),
 312 : http://wiki.zmanda.com
 313 .SH "Author"
 314 .PP
 315 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>