X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Famtoc.8;h=65c997a983c0bf31de6085a51bf08e637918cfa2;hb=2627875b7d18858bc1f9f7652811e4d8c15a23eb;hp=045ff1d9c9299a89b17d88a729a8a9b04ce2218f;hpb=fb2bd066c2f8b34addafe48d62550e3033a59431;p=debian%2Famanda
diff --git a/man/amtoc.8 b/man/amtoc.8
index 045ff1d..65c997a 100644
--- a/man/amtoc.8
+++ b/man/amtoc.8
@@ -1,71 +1,229 @@
.\" Title: amtoc
-.\" Author:
-.\" Generator: DocBook XSL Stylesheets v1.73.2
-.\" Date: 08/22/2008
-.\" Manual:
-.\" Source:
+.\" Author: Nicolas Mayencourt
+.\" Generator: DocBook XSL Stylesheets v1.74.0
+.\" Date: 01/22/2009
+.\" Manual: System Administration Commands
+.\" Source: Amanda 2.6.1
+.\" Language: English
.\"
-.TH "AMTOC" "8" "08/22/2008" "" ""
+.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
+.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
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BM/EM - put colored marker in margin next to block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BM
+.if t \{\
+.br
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EM
+.if t \{\
+.br
+.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
+.\}
+..
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
-.SH "NAME"
-amtoc - generate TOC (Table Of Contents) for an Amanda run
-.SH "SYNOPSIS"
-.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
+.fam
.SH "DESCRIPTION"
.PP
\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!)\.
+run\&. It\'s a perl script (if you don\'t have perl, install it first!)\&.
.SH "OPTIONS"
.PP
\fB\-a\fR
.RS 4
The output file name will be
-\fIlabel\-of\-the\-tape\fR\.toc in the same directory as
-\fIlogfile\fR\.
+\fIlabel\-of\-the\-tape\fR\&.toc in the same directory as
+\fIlogfile\fR\&.
.RE
.PP
\fB\-i\fR
.RS 4
Display help about
-\fBamtoc\fR\.
+\fBamtoc\fR\&.
.RE
.PP
\fB\-t\fR
.RS 4
-Generate the output in tabular form\.
+Generate the output in tabular form\&.
.RE
.PP
\fB\-f file\fR
.RS 4
-Write the output to a file (\'\-\' for stdout)\.
+Write the output to a file (\'\-\' for stdout)\&.
.RE
.PP
\fB\-s subs\fR
.RS 4
Evaluate the output file name from
\fIsubs\fR, with $_ set to
-\fIlabel\-of\-the\-tape\fR\. The
+\fIlabel\-of\-the\-tape\fR\&. The
\fB\-a\fR
option is equivalent to
\fB\-s\fR
-\fI\'s/$_/\.toc/\'\fR\.
+\fI\'s/$_/\&.toc/\'\fR\&.
.RE
.PP
\fB\-w\fR
.RS 4
-Separate tapes with form\-feeds and display blank lines before totals\.
+Separate tapes with form\-feeds and display blank lines before totals\&.
.RE
.PP
\fB\-\-\fR
.RS 4
Marks the last option so the next parameter is the
-\fIlogfile\fR\.
+\fIlogfile\fR\&.
.RE
.PP
\fBlogfile\fR
@@ -80,7 +238,7 @@ The standard output has five fields separated by two spaces:
0 daily\-05: 19991005 \- \-
1 cuisun15:/cuisun15/home 19991005 1 96
2 cuinfs:/export/dentiste 19991005 1 96
- \.\.\.
+ \&.\&.\&.
103 cuisg11:/ 19991005 0 4139136
103 total: \- \- 16716288
.fi
@@ -91,7 +249,7 @@ In tabular format (\-t), this would look like:
0 daily\-05: 19991005 \- \-
1 cuisun15:/cuisun15/home 19991005 1 96
2 cuinfs:/export/dentiste 19991005 1 96
- \.\.\.
+ \&.\&.\&.
103 cuisg11:/ 19991005 0 4139136
103 total: \- \- 16716288
.fi
@@ -104,13 +262,13 @@ right after
in the
\fIcron job:\fR
.nf
-amdump daily ; logdir=`amgetconf daily logdir` ; log=`ls \-1t $logdir/log\.*\.[0\-9] | head \-1` ; amtoc \-a $log
+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/\fItape_label\fR\.toc\. You may also want to call
+which will generate /usr/local/etc/amanda//daily/\fItape_label\fR\&.toc\&. You may also want to call
\fBamtoc\fR
after an
-\fIamflush\fR\.
+\fIamflush\fR\&.
.SH "SEE ALSO"
.PP
\fBamanda\fR(8),
@@ -118,11 +276,11 @@ after an
\fBamflush\fR(8),
\fBamgetconf\fR(8), cron, perl,
: http://wiki.zmanda.com
-.SH "AUTHOR"
+.SH "Authors"
.PP
-Nicolas Mayencourt
-, 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,
-, maintainer of the
-\fIAmanda\fR\-documentation: XML\-conversion
+\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>