Imported Upstream version 2.6.1
[debian/amanda] / man / amoverview.8
index 21c7c15aa6f240761d72352ec9328d1793ef1126..f6296c65fb15f104f3277511b94e26eeb7cb566e 100644 (file)
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
+.\"     Title: amoverview
+.\"    Author: Stefan G. Weichinger <sgw@amanda.org>
+.\" 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 "AMOVERVIEW" "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
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
+.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
+.\}
 ..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BM/EM - put colored marker in margin next to block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BM
+.if t \{\
+.br
+.ll -2n
+.gcolor red
+.di BX
+.\}
 ..
-.de Ip \" List item
+.de EM
+.if t \{\
 .br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
+.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
+.\}
 ..
-.TH "AMOVERVIEW" 8 "" "" ""
-.SH NAME
-amoverview \- display file systems processed by AMANDA over time
-.SH "SYNOPSIS"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
 .ad l
-.hy 0
-.HP 11
-\fBamoverview\fR [[\-config]\ \fIconfig\fR] [\-hostwidth\ \fIwidth\fR] [\-diskwidth\ \fIwidth\fR] [\-skipmissed] [\-verbose]
-.ad
-.hy
-
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "Name"
+amoverview \- display file systems processed by \fIAmanda\fR over time
+.SH "Synopsis"
+.fam C
+.HP \w'\fBamoverview\fR\ 'u
+\fBamoverview\fR [[\-config\ ]\ \fIconfig\fR] [\-hostwidth\ \fIwidth\fR] [\-diskwidth\ \fIwidth\fR] [\-skipmissed] [\-last] [\-num0] [\-togo0] [\-verbose]
+.fam
 .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\&.
-
+\fBAmoverview\fR
+displays a chart showing hosts and file systems processed by
+\fIAmanda\fR
+along with the backup level performed each day\&.
 .PP
-See the \fBamanda\fR(8) man page for more details about \fBAMANDA\fR\&.
-
+See the
+\fBamanda\fR(8)
+man page for more details about
+\fIAmanda\fR\&.
 .SH "OPTIONS"
-
-.TP
+.PP
 \fB\-config\fR \fIconfig\fR
-Use configuration \fBconfig\fR instead of configuration daily\&.
-
-.TP
+.RS 4
+Use configuration
+\fIconfig\fR
+instead of configuration daily\&.
+.RE
+.PP
 \fB\-hostwidth\fR \fIwidth\fR
-Set \fBhost\fR field column width to \fBwidth\fR characters instead of 8\&.
-
-.TP
+.RS 4
+Set
+\fBhost\fR
+field column width to
+\fIwidth\fR
+characters instead of 8\&.
+.RE
+.PP
 \fB\-diskwidth\fR \fIwidth\fR
-Set \fBdisk\fR field column width to \fBwidth\fR characters instead of 20\&.
-
-.TP
+.RS 4
+Set
+\fBdisk\fR
+field column width to
+\fIwidth\fR
+characters instead of 20\&.
+.RE
+.PP
 \fB\-skipmissed\fR
-Compacts the output by only printing stats for the days \fBAMANDA\fR actually ran\&.
-
-.TP
+.RS 4
+Compacts the output by only printing stats for the days
+\fIAmanda\fR
+actually ran\&.
+.RE
+.PP
+\fB\-last\fR
+.RS 4
+Outputs the last status of each disk at the start\&. Useful for long tapecycles and/or sparse reports\&.
+.RE
+.PP
+\fB\-num0\fR
+.RS 4
+Outputs the number of level 0 dumps for each disk\&.
+.RE
+.PP
+\fB\-togo0\fR
+.RS 4
+Outputs the number of runs until the last level 0 dump is overwritten\&.
+.RE
+.PP
 \fB\-verbose\fR
-\fBAmoverview\fR can take a long while on large systems\&. This option reports intermediate steps while it is working\&.
-
+.RS 4
+\fBAmoverview\fR
+can take a long while on large systems\&. This option reports intermediate steps while it is working\&.
+.RE
 .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\&.
-
+\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 "OK", amoverview translates this into "E" 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\&.
-
+A number indicates the level of backup and it succeeded\&. An "E" indicates an error for that day\&. You get an "E" 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\&.
-
+You can have an "E" followed by a number if a filesystem ran into end\-of\-tape once (gives an "E", 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 "EE" 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)\&.
-
+You can also have a double code if you have two tapes in the changer and
+\fIAmanda\fR
+failed to write to tape the first time because it hit end of tape (resulting in "E0", for a full, "E1" for an incremental etc\&.) or twice with error ("EE"), and may a successful flush afterwards giving maybe "EE0"\&. (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\&.
+This shows the
+\FC/home\F[]
+file system on
+\fIhost2\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
@@ -89,9 +273,11 @@ 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)
-
+\fBamadmin\fR(8),
+\fBamanda\fR(8),
+: http://wiki.zmanda.com
+.SH "Author"
+.PP
+\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>