Imported Upstream version 2.6.1
[debian/amanda] / man / amtoc.8
index 52880319fd2db711aed2e78fe6db361675199e08..65c997a983c0bf31de6085a51bf08e637918cfa2 100644 (file)
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
+.\"     Title: amtoc
+.\"    Author: Nicolas Mayencourt <Nicolas.Mayencourt@cui.unige.ch>
+.\" 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 "AMTOC" "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 "AMTOC" 8 "" "" ""
-.SH NAME
-amtoc \- generate TOC (Table Of Contents) for an Amanda run
-.SH "SYNOPSIS"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
 .ad l
-.hy 0
-.HP 6
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "Name"
+amtoc \- generate TOC (Table Of Contents) for an \fIAmanda\fR run
+.SH "Synopsis"
+.fam C
+.HP \w'\fBamtoc\fR\ 'u
 \fBamtoc\fR [\-a] [\-i] [\-t] [\-f\ \fIfile\fR] [\-s\ \fIsubs\fR] [\-w] [\-\-] \fIlogfile\fR
-.ad
-.hy
-
+.fam
 .SH "DESCRIPTION"
-
 .PP
-\fBAmtoc\fR generates a table of contents for an \fBAmanda\fR run\&. It's a perl script (if you don't have perl, install it first!)\&.
-
+\fIAmtoc\fR
+generates a table of contents for an
+\fIAmanda\fR
+run\&. It\'s a perl script (if you don\'t have perl, install it first!)\&.
 .SH "OPTIONS"
-
-.TP
+.PP
 \fB\-a\fR
-The output file name will be \fBlabel\-of\-the\-tape\fR\&.toc in the same directory as \fBlogfile\fR\&.
-
-.TP
+.RS 4
+The output file name will be
+\fIlabel\-of\-the\-tape\fR\&.toc in the same directory as
+\fIlogfile\fR\&.
+.RE
+.PP
 \fB\-i\fR
-Display help about \fBamtoc\fR\&.
-
-.TP
+.RS 4
+Display help about
+\fBamtoc\fR\&.
+.RE
+.PP
 \fB\-t\fR
+.RS 4
 Generate the output in tabular form\&.
-
-.TP
+.RE
+.PP
 \fB\-f file\fR
-Write the output to a file ('\-' for stdout)\&.
-
-.TP
+.RS 4
+Write the output to a file (\'\-\' for stdout)\&.
+.RE
+.PP
 \fB\-s subs\fR
-Evaluate the output file name from \fBsubs\fR, with $_ set to \fBlabel\-of\-the\-tape\fR\&. The \fB\-a\fR option is equivalent to \fB\-s\fR  \fI's/$_/\&.toc/'\fR\&.
-
-.TP
+.RS 4
+Evaluate the output file name from
+\fIsubs\fR, with $_ set to
+\fIlabel\-of\-the\-tape\fR\&. The
+\fB\-a\fR
+option is equivalent to
+\fB\-s\fR
+\fI\'s/$_/\&.toc/\'\fR\&.
+.RE
+.PP
 \fB\-w\fR
+.RS 4
 Separate tapes with form\-feeds and display blank lines before totals\&.
-
-.TP
+.RE
+.PP
 \fB\-\-\fR
-Marks the last option so the next parameter is the \fBlogfile\fR\&.
-
-.TP
+.RS 4
+Marks the last option so the next parameter is the
+\fIlogfile\fR\&.
+.RE
+.PP
 \fBlogfile\fR
-(use '\-' for stdin)
-
+.RS 4
+(use \'\-\' for stdin)
+.RE
 .SH "OUTPUT FORMAT"
-
 .PP
 The standard output has five fields separated by two spaces:
-
 .nf
-
 #  Server:/partition  date  level  size[Kb]
 0  daily\-05:  19991005  \-  \-
 1  cuisun15:/cuisun15/home  19991005  1  96
@@ -81,16 +241,10 @@ The standard output has five fields separated by two spaces:
   \&.\&.\&.
 103  cuisg11:/  19991005  0  4139136
 103  total:  \-  \-  16716288
-
-
-
 .fi
-
 .PP
 In tabular format (\-t), this would look like:
-
 .nf
-
   #  Server:/partition           date      lev  size[Kb]
   0  daily\-05:                   19991005    \-         \-
   1  cuisun15:/cuisun15/home     19991005    1        96
@@ -98,34 +252,35 @@ In tabular format (\-t), this would look like:
   \&.\&.\&.
 103  cuisg11:/                   19991005    0   4139136
 103  total:                      \-           \-  16716288
-
-
 .fi
-
 .SH "USAGE"
-
 .PP
-The easiest way to use it is to run \fBamtoc\fR right after \fBamdump\fR in the \fBcron job:\fR
-
+The easiest way to use it is to run
+\fBamtoc\fR
+right after
+\fIamdump\fR
+in the
+\fIcron job:\fR
 .nf
-
 amdump daily ; logdir=`amgetconf daily logdir` ; log=`ls \-1t $logdir/log\&.*\&.[0\-9] | head \-1` ; amtoc \-a $log
-
 .fi
-
 .PP
-which will generate /usr/local/etc/amanda//daily/\fBtape_label\fR\&.toc\&. You may also want to call \fBamtoc\fR after an \fBamflush\fR\&.
-
+which will generate /usr/local/etc/amanda//daily/\fItape_label\fR\&.toc\&. You may also want to call
+\fBamtoc\fR
+after an
+\fIamflush\fR\&.
 .SH "SEE ALSO"
-
 .PP
-\fBamanda\fR(8), \fBamdump\fR(8), \fBamflush\fR(8), \fBamgetconf\fR(8), cron, perl
-
-.SH "AUTHOR"
-
+\fBamanda\fR(8),
+\fBamdump\fR(8),
+\fBamflush\fR(8),
+\fBamgetconf\fR(8), cron, perl,
+: http://wiki.zmanda.com
+.SH "Authors"
 .PP
-Nicolas Mayencourt <Nicolas\&.Mayencourt@cui\&.unige\&.ch>, University of Geneva/Switzerland : Original text
-
+\fBNicolas Mayencourt\fR <\&Nicolas\&.Mayencourt@cui\&.unige\&.ch\&>
+.RS 4
+University of Geneva/Switzerland
+.RE
 .PP
-Stefan G\&. Weichinger, <sgw@amanda\&.org>, maintainer of the \fBAmanda\fR\-documentation: XML\-conversion
-
+\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>