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

   1 '\" t
   2 .\"     Title: amreport
   3 .\"    Author: Stefan G. Weichinger <sgw@amanda.org>
   4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
   5 .\"      Date: 11/05/2009
   6 .\"    Manual: System Administration Commands
   7 .\"    Source: Amanda 2.6.1p2
   8 .\"  Language: English
   9 .\"
  10 .TH "AMREPORT" "8" "11/05/2009" "Amanda 2\&.6\&.1p2" "System Administration Commands"
  11 .\" -----------------------------------------------------------------
  12 .\" * set default formatting
  13 .\" -----------------------------------------------------------------
  14 .\" disable hyphenation
  15 .nh
  16 .\" disable justification (adjust text to left margin only)
  17 .ad l
  18 .\" -----------------------------------------------------------------
  19 .\" * MAIN CONTENT STARTS HERE *
  20 .\" -----------------------------------------------------------------
  21 .SH "NAME"
  22 amreport \- generate a formatted output of statistics for an \fIAmanda\fR run
  23 .SH "SYNOPSIS"
  24 .HP \w'\fBamreport\fR\ 'u
  25 \fBamreport\fR [\fIconfig\fR] [\-i] [\-M\ \fIaddress\fR] [\-l\ \fIlogfile\fR] [\-f\ \fIoutputfile\fR] [\-p\ \fIpostscriptfile\fR] [\-o\ \fIconfigoption\fR]...
  26 .SH "DESCRIPTION"
  27 .PP
  28 \fBAmreport\fR
  29 generates a summary report of an
  30 \fBamanda\fR(8)
  31 backup run\&. If no configuration name is specified, amanda\&.conf is read from the current directory\&.
  32 .PP
  33 See the
  34 \fBamanda\fR(8)
  35 man page for more details about
  36 \fIAmanda\fR\&.
  37 .SH "OPTIONS"
  38 .PP
  39 \fIconfig\fR
  40 .RS 4
  41 Name of the configuration to process\&.
  42 .RE
  43 .PP
  44 \fB\-i\fR
  45 .RS 4
  46 Don\'t email the report\&.
  47 .RE
  48 .PP
  49 \fB\-M\fR \fIaddress\fR
  50 .RS 4
  51 Mail the report to
  52 \fIaddress\fR
  53 instead of the
  54 \fBmailto\fR
  55 value from
  56 \fIamanda\&.conf\fR\&.
  57 .RE
  58 .PP
  59 \fB\-l\fR \fIlogfile\fR
  60 .RS 4
  61 Name of the log file to parse to generate the report\&. If a log file is not specified, it defaults to the file:
  62 .RE
  63 .PP
  64 \fIlogdir\fR/log
  65 .PP
  66 where
  67 \fIlogdir\fR
  68 is the log directory defined in amanda\&.conf\&.
  69 .PP
  70 \fB\-f\fR \fIoutputfile\fR
  71 .RS 4
  72 Normally,
  73 \fBamreport\fR
  74 sends the report via e\-mail to the
  75 \fImailto\fR
  76 user as defined in the amanda\&.conf file\&. If
  77 \fIoutputfile\fR
  78 is specified, then the report is put in
  79 \fIoutputfile\fR\&.
  80 .RE
  81 .PP
  82 \fB\-p\fR \fIpostscriptfile\fR
  83 .RS 4
  84 Send the postscript output to the file
  85 \fIpostscriptfile\fR
  86 instead of to the
  87 \fBlpr\fR(1)
  88 command\&. This option has an effect only if the
  89 \fIlbl\-templ\fR
  90 directive is specified in amanda\&.conf\&.
  91 .RE
  92 .PP
  93 \fB\-o\fR \fIconfigoption\fR
  94 .RS 4
  95 See the "\fBCONFIGURATION OVERRIDE\fR" section in
  96 \fBamanda\fR(8)\&.
  97 .RE
  98 .SH "LABEL PRINTING"
  99 .PP
 100 \fIAmanda\fR
 101 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\&.
 102 .PP
 103 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\&.
 104 .PP
 105 Add the
 106 \fIlbl\-templ\fR
 107 parameter to the tapetype definition in amanda\&.conf to enable labels\&. If you don\'t add this line to your tapetype definition,
 108 \fBamreport\fR
 109 will not print tape labels\&.
 110 .PP
 111 You may use the
 112 \fIremap=\'I\'>printer\fR
 113 keyword in amanda\&.conf to print to other than the system default printer\&.
 114 .SH "TEMPLATES"
 115 .PP
 116 \fIAmanda\fR
 117 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\&.
 118 .sp
 119 .if n \{\
 120 .RS 4
 121 .\}
 122 .nf
 123 * ExaByte 8mm tapes
 124 * DAT 4mm tapes
 125 * DLT tapes
 126 * 3\-ring binder
 127 .fi
 128 .if n \{\
 129 .RE
 130 .\}
 131 .PP
 132 The 3\-ring binder type is the most generic\&. It may be used to make a hardcopy log of the tapes\&.
 133 .SH "EXIT CODE"
 134
 135 The exit code of \fBamreport\fR is the ORed value of:
 136 .nf
 137  0  = success
 138  1  = error
 139  2  = a dle give strange message
 140  4  = a dle failed
 141  8  = Don\'t know the status of a dle (RESULT_MISSING in the report)
 142  16 = tape error or no more tape
 143 .fi
 144 .SH "SEE ALSO"
 145 .PP
 146 \fBamanda\fR(8),
 147 \fBamflush\fR(8),
 148 : http://wiki.zmanda.com
 149 .SH "AUTHOR"
 150 .PP
 151 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>