Imported Upstream version 3.1.0
[debian/amanda] / man / amplot.8
index 15deaba35713cc4b8bcf1d7e761db48edbf66f6b..b702150e8ab6a950dd0563136632d602f103c81f 100644 (file)
-.TH AMPLOT 8
-.UC 4
-.SH NAME
+'\" t
+.\"     Title: amplot
+.\"    Author: Olafur Gudmundsson <ogud@tis.com>
+.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
+.\"      Date: 06/01/2010
+.\"    Manual: System Administration Commands
+.\"    Source: Amanda 3.1.0
+.\"  Language: English
+.\"
+.TH "AMPLOT" "8" "06/01/2010" "Amanda 3\&.1\&.0" "System Administration Commands"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.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
+.SH "SYNOPSIS"
+.HP \w'\fBamplot\fR\ 'u
+\fBamplot\fR [\-b] [\-c] [\-e] [\-g] [\-l] [\-p] [\-t\ \fIT\fR] \fIamdump_files\fR
 .br
-.SH DESCRIPTION
-.B Amplot
+
+.SH "DESCRIPTION"
+.PP
+\fBAmplot\fR
 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
+\fBamdump\fR
+output file that Amanda generates each run (e\&.g\&.
+\fIamdump\&.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
-.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
+\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
-.B awk
+\fBawk\fR
 program
-.IR \fR(\fPamplot.awk )
-to scan the
-.B amdump
-output file.
-It then executes a
-.B gnuplot
+(\fIamplot\&.awk\fR) to scan the
+\fBamdump\fR
+output file\&. It then executes a
+\fBgnuplot\fR
 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
+(\fIamplot\&.g\fR) to generate the graph\&. The
+\fBawk\fR
+program is written in an enhanced version of awk, such as GNU awk (\fBgawk\fR(1)
+version 2\&.15 or later) or
+\fBnawk\fR(1)\&.
+.PP
 During execution,
-.B amplot
+\fBamplot\fR
 generates a few temporary files that
-.B gnuplot
-uses.
-These files are deleted at the end of execution.
-.LP
+\fBgnuplot\fR
+uses\&. These files are deleted at the end of execution\&.
+.PP
 See the
-.IR amanda (8)
-man page for more details about Amanda.
-.SH OPTIONS
-.TP
-.B -b
+\fBamanda\fR(8)
+man page for more details about Amanda\&.
+.SH "OPTIONS"
+.PP
+\fB\-b\fR
+.RS 4
 Generate b/w postscript file (need
-.BR -p ).
-.TP
-.B -c
+\fB\-p\fR)\&.
+.RE
+.PP
+\fB\-c\fR
+.RS 4
 Compress
-.I amdump_files
-after plotting.
-.TP
-.B -e
-Extend the X (time) axis if needed.
-.TP
-.B -g
+\fIamdump_files\fR
+after plotting\&.
+.RE
+.PP
+\fB\-e\fR
+.RS 4
+Extend the X (time) axis if needed\&.
+.RE
+.PP
+\fB\-g\fR
+.RS 4
 Direct
-.I gnuplot
-output directly to the X11 display (default).
-.TP
-.B -p
+\fIgnuplot\fR
+output directly to the X11 display (default)\&.
+.RE
+.PP
+\fB\-p\fR
+.RS 4
 Direct postscript output to file
-.B \fIYYYYMMDD\fP.ps
+\fIYYYYMMDD\fR\fI\&.ps\fR
 (opposite of
-.BR -g ).
-.TP
-.B -l
-Generate landscape oriented output (need
-.BR -p ).
-.TP
-.B "-t \fIT\fR"
+\fB\-g\fR)\&.
+.RE
+.PP
+\fB\-l\fR
+.RS 4
+Generate landscape oriented output (needs
+\fB\-p\fR)\&.
+.RE
+.PP
+\fB\-t \fR\fIT\fR
+.RS 4
 Set the right edge of the plot to be
-.I T
-hours.
-.LP
+\fIT\fR
+hours\&.
+.RE
+.PP
 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
+\fIamdump_files\fR
+may be in various compressed formats (\fIcompress\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
+\fIQUEUES:\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
+\fI%BANDWIDTH:\fR
+Percentage of allowed network bandwidth in use\&.
+.PP
+\fIHOLDING 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
+\fITAPE:\fR
+Tape drive usage\&.
+.PP
+\fI%DUMPERS:\fR
+Percentage of active dumpers\&.
+.PP
 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
+\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 "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),
+\fBgnuplot\fR(1),
+\fBcompress\fR(1),
+\fBgzip\fR(1)
+.PP
+The Amanda Wiki:
+: http://wiki.zmanda.com/
+.SH "AUTHORS"
+.PP
+\fBOlafur Gudmundsson\fR <\&ogud@tis\&.com\&>
+.RS 4
 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)
+.RE
+.PP
+\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>