Imported Upstream version 2.4.5
[debian/amanda] / man / amoverview.8
diff --git a/man/amoverview.8 b/man/amoverview.8
new file mode 100644 (file)
index 0000000..21c7c15
--- /dev/null
@@ -0,0 +1,97 @@
+.\"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 "AMOVERVIEW" 8 "" "" ""
+.SH NAME
+amoverview \- display file systems processed by AMANDA over time
+.SH "SYNOPSIS"
+.ad l
+.hy 0
+.HP 11
+\fBamoverview\fR [[\-config]\ \fIconfig\fR] [\-hostwidth\ \fIwidth\fR] [\-diskwidth\ \fIwidth\fR] [\-skipmissed] [\-verbose]
+.ad
+.hy
+
+.SH "DESCRIPTION"
+
+.PP
+\fBAmoverview\fR displays a chart showing hosts and file systems processed by \fBAMANDA\fR along with the backup level performed each day\&.
+
+.PP
+See the \fBamanda\fR(8) man page for more details about \fBAMANDA\fR\&.
+
+.SH "OPTIONS"
+
+.TP
+\fB\-config\fR \fIconfig\fR
+Use configuration \fBconfig\fR instead of configuration daily\&.
+
+.TP
+\fB\-hostwidth\fR \fIwidth\fR
+Set \fBhost\fR field column width to \fBwidth\fR characters instead of 8\&.
+
+.TP
+\fB\-diskwidth\fR \fIwidth\fR
+Set \fBdisk\fR field column width to \fBwidth\fR characters instead of 20\&.
+
+.TP
+\fB\-skipmissed\fR
+Compacts the output by only printing stats for the days \fBAMANDA\fR actually ran\&.
+
+.TP
+\fB\-verbose\fR
+\fBAmoverview\fR can take a long while on large systems\&. This option reports intermediate steps while it is working\&.
+
+.SH "RESULTS"
+
+.PP
+\fBamoverview\fR is a summary of the output of " \fBamadmin <config> find\fR "\&. When the last column of \fBamadmin find\fR contains anything other than ``\fBOK\fR'', amoverview translates this into ``\fBE\fR'' for that day\&.
+
+.PP
+A number indicates the level of backup and it succeeded\&. An ``\fBE\fR'' indicates an error for that day\&. You get an ``\fBE\fR'' for all errors, like failed to connect, datatimeout, computer crashed, etc, but also for failing to write to tape\&.
+
+.PP
+You can have an ``\fBE\fR'' followed by a number if a filesystem ran into end\-of\-tape once (gives an ``\fBE\fR'', and later that day, you flush it to a second tape (a number: the level, indicating success)\&. If the flush failed too, you get a double ``\fBEE\fR'' for that day\&.
+
+.PP
+You can also have a double code if you have two tapes in the changer and \fBAMANDA\fR failed to write to tape the first time because it hit end of tape (resulting in ``\fBE0\fR'', for a full, ``\fBE1\fR'' for an incremental etc\&.) or twice with error (``\fBEE\fR''), and may a successful flush afterwards giving maybe ``\fBEE0\fR''\&. (Only the latest 2 characters are printed)\&.
+
+.SH "EXAMPLE"
+
+.PP
+This shows the \fI/home\fR file system on \fBhost2\fR was backed up at level 3 on the 8th, 9th and 10th of December, had a full backup on the 11th, a level 1 on the 12th and a level 2 on the 13th\&.
+.nf
+
+# amoverview
+                         date 12 12 12 12 12 12
+host     disk                 08 09 10 11 12 13
+host1    /                     0  1  1  1  1  1
+host1    /var                  0  1  1  1  1  1
+host2    /                     1  1  1  1  1  0
+host2    /home                 3  3  3  0  1  2
+host2    /opt                  1  1  1  1  1  1
+host2    /var                  1  1  0  1  1  1 
+.fi
+
+.SH "SEE ALSO"
+
+.PP
+\fBamadmin\fR(8), \fBamanda\fR(8)
+