X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Famplot.8;h=90ad3f1ea698e38d8cc2e1c5640cecba752119be;hb=d74dc4d908fcbc1a4ef474edaf51e61ec90eab6b;hp=1021d737409c8c7a72e0065d95430d7ca630666f;hpb=1194fb66aa28d9929c3f2bef3cc6c1c3f40a60a4;p=debian%2Famanda diff --git a/man/amplot.8 b/man/amplot.8 index 1021d73..90ad3f1 100644 --- a/man/amplot.8 +++ b/man/amplot.8 @@ -1,120 +1,170 @@ -.\"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 -.ie \\n(.$>=3 .ne \\$3 -.el .ne 3 -.IP "\\$1" \\$2 -.. -.TH "AMPLOT" 8 "" "" "" -.SH NAME -amplot \- visualize the behavior of Amanda -.SH "SYNOPSIS" +'\" t +.\" Title: amplot +.\" Author: Olafur Gudmundsson +.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 +.\" Date: 04/10/2009 +.\" Manual: System Administration Commands +.\" Source: Amanda 2.6.1p1 +.\" Language: English +.\" +.TH "AMPLOT" "8" "04/10/2009" "Amanda 2\&.6\&.1p1" "System Administration Commands" +.\" ----------------------------------------------------------------- +.\" * set default formatting +.\" ----------------------------------------------------------------- +.\" disable hyphenation +.nh +.\" disable justification (adjust text to left margin only) .ad l -.hy 0 -.HP 7 +.\" ----------------------------------------------------------------- +.\" * MAIN CONTENT STARTS HERE * +.\" ----------------------------------------------------------------- +.SH "NAME" +amplot \- visualize the behavior of \fIAmanda\fR +.SH "SYNOPSIS" +.HP \w'\fBamplot\fR\ 'u \fBamplot\fR [\-b] [\-c] [\-e] [\-g] [\-l] [\-p] [\-t\ \fIT\fR] \fIamdump_files\fR .br -.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\&. - +\fBAmplot\fR +reads an +\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 +\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 +(\fIamplot\&.awk\fR) to scan the +\fBamdump\fR +output file\&. It then executes a +\fBgnuplot\fR +program +(\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, +\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 +\fIAmanda\fR\&. .SH "OPTIONS" - -.TP +.PP \fB\-b\fR -Generate b/w postscript file (need \fB\-p\fR)\&. - -.TP +.RS 4 +Generate b/w postscript file (need +\fB\-p\fR)\&. +.RE +.PP \fB\-c\fR -Compress \fBamdump_files\fR after plotting\&. - -.TP +.RS 4 +Compress +\fIamdump_files\fR +after plotting\&. +.RE +.PP \fB\-e\fR +.RS 4 Extend the X (time) axis if needed\&. - -.TP +.RE +.PP \fB\-g\fR -Direct \fBgnuplot\fR output directly to the X11 display (default)\&. - -.TP +.RS 4 +Direct +\fIgnuplot\fR +output directly to the X11 display (default)\&. +.RE +.PP \fB\-p\fR -Direct postscript output to file \fB\fR\fBYYYYMMDD\fR\fB\&.ps\fR (opposite of \fB\-g\fR)\&. - -.TP -\fB\-l\fR -Generate landscape oriented output (needs \fB\-p\fR)\&. - -.TP -\fB\-t \fR\fBT\fR -Set the right edge of the plot to be \fBT\fR hours\&. - +.RS 4 +Direct postscript output to file +\fIYYYYMMDD\fR\fI\&.ps\fR +(opposite of +\fB\-g\fR)\&. +.RE .PP -The \fBamdump_files\fR may be in various compressed formats \fB\fR(\fBcompress\fR, \fBgzip\fR, \fBpact\fR, \fBcompact\fR)\&. - +\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 +\fIT\fR +hours\&. +.RE +.PP +The +\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 -\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\&. - +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 -\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\&. - +\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 -\fBTAPE:\fR Tape drive usage\&. - +\fI%BANDWIDTH:\fR +Percentage of allowed network bandwidth in use\&. .PP -\fB%DUMPERS:\fR Percentage of active dumpers\&. - +\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 -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" - +\fITAPE:\fR +Tape drive usage\&. .PP -Olafur Gudmundsson , Trusted Information Systems, formerly at University of Maryland, College Park: Original text - +\fI%DUMPERS:\fR +Percentage of active dumpers\&. .PP -Stefan G\&. Weichinger, , maintainer of the \fBAmanda\fR\-documentation: XML\-conversion - +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 "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) - +\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 +.RE +.PP +\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>