Imported Debian patch 2.4.5-1
[debian/amanda] / docs / amplot.8.txt
diff --git a/docs/amplot.8.txt b/docs/amplot.8.txt
new file mode 100644 (file)
index 0000000..1f71f57
--- /dev/null
@@ -0,0 +1,99 @@
+
+                               amplot
+Prev  Chapter 35. The AMANDA Manual Pages.  Next
+
+-------------------------------------------------------------------------------
+
+Name
+
+amplot \14 visualize the behavior of AMANDA
+
+Synopsis
+
+amplot [-b ] [-c ] [-e ] [-g ] [-l ] [-p ] [ -t T ] amdump_files
+
+DESCRIPTION
+
+Amplot reads an amdump output file that AMANDA generates each run (e.g.
+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. Amplot also prints out 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.
+Amplot is a shell script that executes an awk program (amplot.awk) to scan the
+amdump output file. It then executes a gnuplot program (amplot.g) to generate
+the graph. The awk program is written in an enhanced version of awk, such as
+GNU awk (gawk version 2.15 or later) or nawk.
+During execution, amplot generates a few temporary files that gnuplot uses.
+These files are deleted at the end of execution.
+See the amanda(8) man page for more details about AMANDA.
+
+OPTIONS
+
+
+
+  -b
+      Generate b/w postscript file (need -p).
+
+  -c
+      Compress amdump_files after plotting.
+
+  -e
+      Extend the X (time) axis if needed.
+
+  -g
+      Direct gnuplot output directly to the X11 display (default).
+
+  -p
+      Direct postscript output to file YYYYMMDD.ps (opposite of -g).
+
+  -l
+      Generate landscape oriented output (needs -p).
+
+  -tT
+      Set the right edge of the plot to be T hours.
+
+The amdump_files may be in various compressed formats (compress, gzip, pact,
+compact).
+
+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 amdump. In the figure, the X axis is time, with 0 being the
+moment amdump was started. The Y axis is divided into 5 regions:
+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.
+%BANDWIDTH: Percentage of allowed network bandwidth in use.
+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.
+TAPE: Tape drive usage.
+%DUMPERS: Percentage of active dumpers.
+The idle period at the left of the graph is time 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.
+
+AUTHOR
+
+Olafur Gudmundsson <ogud@tis.com>, Trusted Information Systems, formerly at
+University of Maryland, College Park: Original text
+Stefan G. Weichinger, <sgw@amanda.org>, maintainer of the AMANDA-documentation:
+XML-conversion
+
+BUGS
+
+Reports lines it does not recognize, mainly error cases but some are legitimate
+lines the program needs to be taught about.
+
+SEE ALSO
+
+amanda(8), amdump(8), gawk(1), nawk(1), awk(1), gnuplot(1), sh(1), compress(1),
+gzip(1)
+-------------------------------------------------------------------------------
+
+Prev         Up        Next
+amoverview  Home  amrecover
+