Imported Upstream version 2.5.1p3
[debian/amanda] / man / amtoc.8
index ef22913d4bf5e568a7d38b8a3a946548df7004f1..fb387e9b8ce55206203ddec7e324de50dae26736 100644 (file)
-.\"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 "AMTOC" 8 "" "" ""
+.\"     Title: amtoc
+.\"    Author: 
+.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
+.\"      Date: 02/07/2007
+.\"    Manual: 
+.\"    Source: 
+.\"
+.TH "AMTOC" "8" "02/07/2007" "" ""
+.\" 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
+amtoc \- generate TOC (Table Of Contents) for an Amanda run
 .SH "SYNOPSIS"
 .HP 6
-\fBamtoc\fR [-a] [-i] [-t] [-f \fIfile\fR] [-s \fIsubs\fR] [-w] [--] \fIlogfile\fR
+\fBamtoc\fR [\-a] [\-i] [\-t] [\-f\ \fIfile\fR] [\-s\ \fIsubs\fR] [\-w] [\-\-] \fIlogfile\fR
 .SH "DESCRIPTION"
 .PP
-\fBAmtoc\fR
+\fIAmtoc\fR
 generates a table of contents for an
-\fBAmanda\fR
+\fIAmanda\fR
 run. It's a perl script (if you don't have perl, install it first!).
 .SH "OPTIONS"
-.TP
-\fB-a\fR
+.PP
+\fB\-a\fR
+.RS 4
 The output file name will be
-\fBlabel-of-the-tape\fR.toc in the same directory as
-\fBlogfile\fR.
-.TP
-\fB-i\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.
-.TP
-\fB-t\fR
+.RE
+.PP
+\fB\-t\fR
+.RS 4
 Generate the output in tabular form.
-.TP
-\fB-f file\fR
-Write the output to a file ('-' for stdout).
-.TP
-\fB-s subs\fR
+.RE
+.PP
+\fB\-f file\fR
+.RS 4
+Write the output to a file ('\-' for stdout).
+.RE
+.PP
+\fB\-s subs\fR
+.RS 4
 Evaluate the output file name from
-\fBsubs\fR, with $_ set to
-\fBlabel-of-the-tape\fR. The
-\fB-a\fR
+\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.
-.TP
-\fB-w\fR
-Separate tapes with form-feeds and display blank lines before totals.
-.TP
-\fB--\fR
+\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.
+.RE
+.PP
+\fB\-\-\fR
+.RS 4
 Marks the last option so the next parameter is the
-\fBlogfile\fR.
-.TP
+\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:
 .sp
+.RS 4
 .nf
-
 #  Server:/partition  date  level  size[Kb]
-0  daily-05:  19991005  -  -
+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
-
+103  total:  \-  \-  16716288
 
 
 .fi
+.RE
 .PP
-In tabular format (-t), this would look like:
+In tabular format (\-t), this would look like:
 .sp
+.RS 4
 .nf
-
   #  Server:/partition           date      lev  size[Kb]
-  0  daily-05:                   19991005    -         -
+  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
-
+103  total:                      \-           \-  16716288
 
 .fi
+.RE
 .SH "USAGE"
 .PP
 The easiest way to use it is to run
 \fBamtoc\fR
 right after
-\fBamdump\fR
+\fIamdump\fR
 in the
-\fBcron job:\fR
+\fIcron job:\fR
 .sp
+.RS 4
 .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
+.RE
 .sp
 .PP
-which will generate /usr/local/etc/amanda//daily/\fBtape_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
-\fBamflush\fR.
+\fIamflush\fR.
 .SH "SEE ALSO"
 .PP
 \fBamanda\fR(8),
@@ -128,5 +137,4 @@ Nicolas Mayencourt
 .PP
 Stefan G. Weichinger,
 <sgw@amanda.org>, maintainer of the
-\fBAmanda\fR-documentation: XML-conversion
-
+\fIAmanda\fR\-documentation: XML\-conversion