X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Fxml-source%2Famreport.8.xml;h=f56d6337e4b34fbad26b7832a8f6b6ac7c3407ed;hb=d5853102f67d85d8e169f9dbe973ad573306c215;hp=fd9252b603df4ab54a9c278f07e603e95bbac718;hpb=cdbbeef9cde260e429854dd313bc0bf7560e1e24;p=debian%2Famanda
diff --git a/man/xml-source/amreport.8.xml b/man/xml-source/amreport.8.xml
index fd9252b..f56d633 100644
--- a/man/xml-source/amreport.8.xml
+++ b/man/xml-source/amreport.8.xml
@@ -3,7 +3,7 @@
"http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
[
-
+
%global_entities;
]>
@@ -13,47 +13,133 @@
amreport8
+&rmi.source;
+&rmi.version;
+&rmi.manual.8;
amreport
-generate a formatted output of statistics for an &A; run
+generate a formatted output of statistics for an Amanda run
+
+&author.sgw.xml;
+amreportconfig
+ &configoverride.synopsis;
+
+ command-line options | script options
+
+
+ --log=logfile
+ --ps=filename
+ --text=filename
+ --xml=filename
+ --print=printer
+ --mail-text=recipient
+
+ -i
- -Maddress
- -llogfile
- -foutputfile
- -ppostscriptfile
- -oconfigoption*
+ -M address
+ -l logfile
+ -f outputfile
+ -p postscriptfile
+ --from-amdump
+ DESCRIPTION
-Amreport
-generates a summary report of an
-amanda8
-backup run.
-If no configuration name is specified, amanda.conf is
-read from the current directory.
-
-See the
-amanda8
-man page for more details about &A;.
+
+Amreport generates a summary report of an
+Amanda backup run.
+
+See the man page for more details about
+Amanda.
+
OPTIONS
+
config
-Name of the configuration to process.
+Name of the configuration to process. If no configuration name is
+specified, amanda.conf is read from the current directory.
+
+
+ &configoverride.varlistentry;
+
+
+Amreport operates in two distinct modes. Command-line mode is intended for use
+by an administrator from the command line, and uses long command-line options
+for clarity. Script mode is intended for use from scripts such as amdump, and
+has a lot of non-obvious default behaviors to suit that need.
+
+Unless a script-mode option is given, amreport defaults to command-line mode.
+If no options are given, amreport writes a report for the most recent logfile to
+stdout.
+
+Command-Line Mode Options
+
+
+
+
+Use this logfile as the basis for the report. If this option is given, then
+the report is a "historical" report and will not include current state from
+e.g., holding disk and curinfo. If this option is not specified, then the
+most recent logfile will be used.
+
+
+
+
+
+Write a postscript label to filename.
+See "LABEL PRINTING" below. If filename is not specified, then the
+label is written to stdout.
+
+
+
+
+
+Write a human-readable text report to filename.
+If filename is not specified, then the report is written to stdout.
+
+
+
+Write an XML-formatted report to filename.
+If filename is not specified, then the report is written to stdout.
+
+
+
+
+
+Pipe a postscript label to lp or lpr,
+specifying the given printer. If the printer is
+not specified, uses the default from the Amanda configuration, or the system
+default printer.
+
+
+
+
+
+Send a human-readable text report to the given recipient via
+the mailer specified in the Amanda configuration. If the recipient is
+not specified, this uses the mailto from the Amanda configuration.
+
+
+
+
+
+Script Mode Options
+
@@ -63,11 +149,8 @@ man page for more details about &A;.
address
-Mail the report to
-address
-instead of the
-mailto
-value from
+Mail the report to address
+instead of the mailto value from
amanda.conf.
@@ -76,61 +159,42 @@ value from
logfileName of the log file to parse to generate the report.
-If a log file is not specified, it defaults to the file:
+If a log file is not specified, it defaults to the file
+$logdir/log, where
+$logdir is the log directory defined in amanda.conf.
-
-
-
-
-logdir/log
-
-
-
-where
-logdir
-is the log directory defined in amanda.conf.
-outputfile
-Normally,
-amreport
-sends the report via e-mail to the
-mailto
-user as defined in the amanda.conf file.
-If
-outputfile
-is specified, then the report is put in
-outputfile.
+Normally, amreport sends the report via e-mail to the
+mailto user as defined in the amanda.conf
+file. If outputfile is specified, then the
+report is put in outputfile.postscriptfileSend the postscript output to the file
-postscriptfile
-instead of to the
-lpr1
-command.
-This option has an effect only if the
-lbl-templ
-directive is specified in amanda.conf.
+postscriptfile instead of to the
+ command. This option has an effect only if the
+lbl-templ directive is specified in amanda.conf.
-
- -oconfigoption
+
-See the "CONFIGURATION OVERWRITE" section in amanda8.
+ Force script mode. Has no other effect.
+LABEL PRINTING
-&A; can print postscript labels describing the contents
+Amanda 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
@@ -155,14 +219,14 @@ tapetype definition,
will not print tape labels.You may use the
-remap='I'>printer
+printer
keyword in amanda.conf to print to other than the system default printer.TEMPLATES
-&A; provides label templates for the following tape types.
+Amanda 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.
@@ -179,9 +243,21 @@ other tape types or particular site needs.
It may be used to make a hardcopy log of the tapes.
-SEE ALSO
-amanda8,
-amflush8
+EXIT CODE
+The exit code of amreport is the ORed value of:
+
+ 0 = success
+ 1 = error
+ 2 = a dle give strange message
+ 4 = a dle failed
+ 8 = Don't know the status of a dle (RESULT_MISSING in the report)
+ 16 = tape error or no more tape
+
+
+
+
+
+