Imported Upstream version 2.6.1
[debian/amanda] / man / amplot.8
index 15deaba35713cc4b8bcf1d7e761db48edbf66f6b..54f84348b5556ee6dd390c16b425ec28cbf58e98 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
+.\"     Title: amplot
+.\"    Author: Olafur Gudmundsson <ogud@tis.com>
+.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
+.\"      Date: 01/22/2009
+.\"    Manual: System Administration Commands
+.\"    Source: Amanda 2.6.1
+.\"  Language: English
+.\"
+.TH "AMPLOT" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
+.\" -----------------------------------------------------------------
+.\" * (re)Define some macros
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" toupper - uppercase a string (locale-aware)
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de toupper
+.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
+\\$*
+.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH-xref - format a cross-reference to an SH section
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de SH-xref
+.ie n \{\
+.\}
+.toupper \\$*
+.el \{\
+\\$*
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH - level-one heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SH
+.\" put an extra blank line of space above the head in non-TTY output
+.if t \{\
+.sp 1
+.\}
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[an-margin]u
+.ti 0
+.HTML-TAG ".NH \\n[an-level]"
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+\." make the size of the head bigger
+.ps +3
+.ft B
+.ne (2v + 1u)
+.ie n \{\
+.\" if n (TTY output), use uppercase
+.toupper \\$*
+.\}
+.el \{\
+.nr an-break-flag 0
+.\" if not n (not TTY), use normal case (not uppercase)
+\\$1
+.in \\n[an-margin]u
+.ti 0
+.\" if not n (not TTY), put a border/line under subheading
+.sp -.6
+\l'\n(.lu'
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SS - level-two heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SS
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[IN]u
+.ti \\n[SN]u
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.ps \\n[PS-SS]u
+\." make the size of the head bigger
+.ps +2
+.ft B
+.ne (2v + 1u)
+.if \\n[.$] \&\\$*
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BB/BE - put background/screen (filled box) around block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BB
+.if t \{\
+.sp -.5
 .br
-.SH DESCRIPTION
-.B Amplot
+.in +2n
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EB
+.if t \{\
+.if "\\$2"adjust-for-leading-newline" \{\
+.sp -1
+.\}
+.br
+.di
+.in
+.ll
+.gcolor
+.nr BW \\n(.lu-\\n(.i
+.nr BH \\n(dn+.5v
+.ne \\n(BHu+.5v
+.ie "\\$2"adjust-for-leading-newline" \{\
+\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.el \{\
+\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.in 0
+.sp -.5v
+.nf
+.BX
+.in
+.sp .5v
+.fi
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BM/EM - put colored marker in margin next to block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BM
+.if t \{\
+.br
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EM
+.if t \{\
+.br
+.di
+.ll
+.gcolor
+.nr BH \\n(dn
+.ne \\n(BHu
+\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
+.in 0
+.nf
+.BX
+.in
+.fi
+.\}
+..
+.\" -----------------------------------------------------------------
+.\" * 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 \fIAmanda\fR
+.SH "Synopsis"
+.fam C
+.HP \w'\fBamplot\fR\ 'u
+\fBamplot\fR [\-b] [\-c] [\-e] [\-g] [\-l] [\-p] [\-t\ \fIT\fR] \fIamdump_files\fR
+.br
+
+.fam
+.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
+\fIAmanda\fR
+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
+(\fIgawk\fR
+version 2\&.15 or later) or
+\fBnawk\fR\&.
+.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
+\fIAmanda\fR\&.
+.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
+\fIamdump_files\fR
 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
+(\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),
+\fBgawk\fR(1),
+\fBnawk\fR(1),
+\fBawk\fR(1),
+\fBgnuplot\fR(1),
+\fBsh\fR(1),
+\fBcompress\fR(1),
+\fBgzip\fR(1),
+: 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\&>