Imported Upstream version 2.4.5
[debian/amanda] / man / amplot.8
index 15deaba35713cc4b8bcf1d7e761db48edbf66f6b..450b9bed6033512fb27bbc116f6be3c1118e5bff 100644 (file)
-.TH AMPLOT 8
-.UC 4
-.SH NAME
-amplot \- visualize the behavior of Amanda
-.SH SYNOPSIS
-.B amplot
-[
-.B -b
-]
-[
-.B -c
-]
-[
-.B -e
-]
-[
-.B -g
-]
-[
-.B -l
-]
-[
-.B -p
-]
-[
-.B -t
-.I T
-]
-.I amdump_files
+.\"Generated by db2man.xsl. Don't modify this, modify the source.
+.de Sh \" Subsection
+.br
+.if t .Sp
+.ne 5
+.PP
+\fB\\$1\fR
+.PP
+..
+.de Sp \" Vertical space (when we can't use .PP)
+.if t .sp .5v
+.if n .sp
+..
+.de Ip \" List item
 .br
-.SH DESCRIPTION
-.B Amplot
-reads an
-.B amdump
-output file that Amanda generates each run (e.g.
-.IR amdump.1 )
-and translates the information into a
-picture format that may be used to determine how your installation
-is doing and if any parameters need to be changed.
-.B Amplot
-also prints out
-.B amdump
-lines that it either does not
-understand or knows to be warning or error lines
-and a summary of the start, end and total time for each backup image.
-.LP
-.B Amplot
-is a shell script that executes an
-.B awk
-program
-.IR \fR(\fPamplot.awk )
-to scan the
-.B amdump
-output file.
-It then executes a
-.B gnuplot
-program
-.IR \fR(\fPamplot.g )
-to generate the graph.
-The
-.B awk
-program is written in an enhanced version of awk,
-such as GNU awk
-.B \fR(\fPgawk
-version 2.15 or later) or
-.BR nawk .
-.LP
-During execution,
-.B amplot
-generates a few temporary files that
-.B gnuplot
-uses.
-These files are deleted at the end of execution.
-.LP
-See the
-.IR amanda (8)
-man page for more details about Amanda.
-.SH OPTIONS
+.ie \\n(.$>=3 .ne \\$3
+.el .ne 3
+.IP "\\$1" \\$2
+..
+.TH "AMPLOT" 8 "" "" ""
+.SH NAME
+amplot \- visualize the behavior of AMANDA
+.SH "SYNOPSIS"
+.ad l
+.hy 0
+.HP 7
+\fBamplot\fR [\-b] [\-c] [\-e] [\-g] [\-l] [\-p] [\-t\ \fIT\fR] \fIamdump_files\fR
+.ad
+.hy
+
+.SH "DESCRIPTION"
+
+.PP
+\fBAmplot\fR reads an \fBamdump\fR output file that \fBAMANDA\fR generates each run (e\&.g\&. \fBamdump\&.1\fR) and translates the information into a picture format that may be used to determine how your installation is doing and if any parameters need to be changed\&. \fBAmplot\fR also prints out \fBamdump\fR lines that it either does not understand or knows to be warning or error lines and a summary of the start, end and total time for each backup image\&.
+
+.PP
+\fBAmplot\fR is a shell script that executes an \fBawk\fR program \fB\fR(\fBamplot\&.awk\fR) to scan the \fBamdump\fR output file\&. It then executes a \fBgnuplot\fR program \fB\fR(\fBamplot\&.g\fR) to generate the graph\&. The \fBawk\fR program is written in an enhanced version of awk, such as GNU awk \fB\fR(\fBgawk\fR version 2\&.15 or later) or \fBnawk\fR\&.
+
+.PP
+During execution, \fBamplot\fR generates a few temporary files that \fBgnuplot\fR uses\&. These files are deleted at the end of execution\&.
+
+.PP
+See the \fBamanda\fR(8) man page for more details about \fBAMANDA\fR\&.
+
+.SH "OPTIONS"
+
 .TP
-.B -b
-Generate b/w postscript file (need
-.BR -p ).
+\fB\-b\fR
+Generate b/w postscript file (need \fB\-p\fR)\&.
+
 .TP
-.B -c
-Compress
-.I amdump_files
-after plotting.
+\fB\-c\fR
+Compress \fBamdump_files\fR after plotting\&.
+
 .TP
-.B -e
-Extend the X (time) axis if needed.
+\fB\-e\fR
+Extend the X (time) axis if needed\&.
+
 .TP
-.B -g
-Direct
-.I gnuplot
-output directly to the X11 display (default).
+\fB\-g\fR
+Direct \fBgnuplot\fR output directly to the X11 display (default)\&.
+
 .TP
-.B -p
-Direct postscript output to file
-.B \fIYYYYMMDD\fP.ps
-(opposite of
-.BR -g ).
+\fB\-p\fR
+Direct postscript output to file \fB\fR\fBYYYYMMDD\fR\fB\&.ps\fR (opposite of \fB\-g\fR)\&.
+
 .TP
-.B -l
-Generate landscape oriented output (need
-.BR -p ).
+\fB\-l\fR
+Generate landscape oriented output (needs \fB\-p\fR)\&.
+
 .TP
-.B "-t \fIT\fR"
-Set the right edge of the plot to be
-.I T
-hours.
-.LP
-The
-.I amdump_files
-may be in various compressed formats
-.BR \fR(\fPcompress ,
-.BR gzip ,
-.BR pact ,
-.BR compact ).
-.SH INTERPRETATION
-The figure is divided into a number of regions.
-There are titles on the top that show important statistical information
-about the configuration and from this execution of
-.BR amdump .
-In the figure, the X axis is time, with 0 being the moment
-.B amdump
-was started.
-The Y axis is divided into 5 regions:
-.IP
-.I QUEUES:
-How many backups have not been started,
-how many are waiting on space in the holding disk
-and how many have been transferred successfully to tape.
-.IP
-.I %BANDWIDTH:
-Percentage of allowed network bandwidth in use.
-.IP
-.I HOLDING DISK:
-The higher line depicts space allocated on the holding disk to
-backups in progress and completed backups waiting to be written to tape.
-The lower line depicts the fraction of the holding disk containing completed
-backups waiting to be written to tape including the file currently being
-written to tape.
-The scale is percentage of the holding disk.
-.IP
-.I TAPE:
-Tape drive usage.
-.IP
-.I %DUMPERS:
-Percentage of active dumpers.
-.LP
-The idle period at the left of the graph is time
-.B amdump
-is asking the machines how much data they are going to dump.
-This process can take a while if hosts are down
-or it takes them a long time to generate estimates.
-.SH AUTHOR
-Olafur Gudmundsson ogud@tis.com
-.br
-Trusted Information Systems
-.br
-formerly at University of Maryland, College Park
-.SH BUGS
-Reports lines it does not recognize, mainly error cases but some are
-legitimate lines the program needs to be taught about.
-.SH SEE ALSO
-amanda(8),
-amdump(8),
-gawk(1),
-nawk(1),
-awk(1),
-gnuplot(1),
-sh(1),
-compress(1),
-gzip(1)
+\fB\-t \fR\fBT\fR
+Set the right edge of the plot to be \fBT\fR hours\&.
+
+.PP
+The \fBamdump_files\fR may be in various compressed formats \fB\fR(\fBcompress\fR, \fBgzip\fR, \fBpact\fR, \fBcompact\fR)\&.
+
+.SH "INTERPRETATION"
+
+.PP
+The figure is divided into a number of regions\&. There are titles on the top that show important statistical information about the configuration and from this execution of \fBamdump\fR\&. In the figure, the X axis is time, with 0 being the moment \fBamdump\fR was started\&. The Y axis is divided into 5 regions:
+
+.PP
+\fBQUEUES:\fR How many backups have not been started, how many are waiting on space in the holding disk and how many have been transferred successfully to tape\&.
+
+.PP
+\fB%BANDWIDTH:\fR Percentage of allowed network bandwidth in use\&.
+
+.PP
+\fBHOLDING DISK:\fR The higher line depicts space allocated on the holding disk to backups in progress and completed backups waiting to be written to tape\&. The lower line depicts the fraction of the holding disk containing completed backups waiting to be written to tape including the file currently being written to tape\&. The scale is percentage of the holding disk\&.
+
+.PP
+\fBTAPE:\fR Tape drive usage\&.
+
+.PP
+\fB%DUMPERS:\fR Percentage of active dumpers\&.
+
+.PP
+The idle period at the left of the graph is time \fBamdump\fR is asking the machines how much data they are going to dump\&. This process can take a while if hosts are down or it takes them a long time to generate estimates\&.
+
+.SH "AUTHOR"
+
+.PP
+Olafur Gudmundsson <ogud@tis\&.com>, Trusted Information Systems, formerly at University of Maryland, College Park: Original text
+
+.PP
+Stefan G\&. Weichinger, <sgw@amanda\&.org>, maintainer of the \fBAMANDA\fR\-documentation: XML\-conversion
+
+.SH "BUGS"
+
+.PP
+Reports lines it does not recognize, mainly error cases but some are legitimate lines the program needs to be taught about\&.
+
+.SH "SEE ALSO"
+
+.PP
+\fBamanda\fR(8), \fBamdump\fR(8), \fBgawk\fR(1), \fBnawk\fR(1), \fBawk\fR(1), \fBgnuplot\fR(1), \fBsh\fR(1), \fBcompress\fR(1), \fBgzip\fR(1)
+