Imported Upstream version 3.2.0
[debian/amanda] / man / amtoc.8
index fb387e9b8ce55206203ddec7e324de50dae26736..712455b5e71c41d2a65e3919b6578f6a0e600ee7 100644 (file)
+'\" t
 .\"     Title: amtoc
-.\"    Author: 
-.\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
-.\"      Date: 02/07/2007
-.\"    Manual: 
-.\"    Source: 
+.\"    Author: Nicolas Mayencourt <Nicolas.Mayencourt@cui.unige.ch>
+.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
+.\"      Date: 10/18/2010
+.\"    Manual: System Administration Commands
+.\"    Source: Amanda 3.2.0
+.\"  Language: English
 .\"
-.TH "AMTOC" "8" "02/07/2007" "" ""
+.TH "AMTOC" "8" "10/18/2010" "Amanda 3\&.2\&.0" "System Administration Commands"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
 .\" disable hyphenation
 .nh
 .\" disable justification (adjust text to left margin only)
 .ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
 .SH "NAME"
 amtoc \- generate TOC (Table Of Contents) for an Amanda run
 .SH "SYNOPSIS"
-.HP 6
+.HP \w'\fBamtoc\fR\ 'u
 \fBamtoc\fR [\-a] [\-i] [\-t] [\-f\ \fIfile\fR] [\-s\ \fIsubs\fR] [\-w] [\-\-] \fIlogfile\fR
 .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!).
+generates a table of contents for an Amanda 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
 .RS 4
-(use '\-' for stdin)
+(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  \-  \-
 1  cuisun15:/cuisun15/home  19991005  1  96
 2  cuinfs:/export/dentiste  19991005  1  96
-  ...
+  \&.\&.\&.
 103  cuisg11:/  19991005  0  4139136
 103  total:  \-  \-  16716288
-
-
 .fi
-.RE
 .PP
 In tabular format (\-t), this would look like:
-.sp
-.RS 4
 .nf
   #  Server:/partition           date      lev  size[Kb]
   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
-.RE
 .SH "USAGE"
 .PP
 The easiest way to use it is to run
@@ -112,29 +109,28 @@ right after
 \fIamdump\fR
 in the
 \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/\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),
 \fBamdump\fR(8),
 \fBamflush\fR(8),
-\fBamgetconf\fR(8), cron, perl
-.SH "AUTHOR"
+\fBamgetconf\fR(8)
+.PP
+The Amanda Wiki:
+: 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
-\fIAmanda\fR\-documentation: XML\-conversion
+\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>