amgtar and amstar need to be setuid root to work
[debian/amanda] / man / amtoc.8
index ef22913d4bf5e568a7d38b8a3a946548df7004f1..56a7ba74cac379ef1722d46a69a7fec60be511ea 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 "" "" ""
+'\" t
+.\"     Title: amtoc
+.\"    Author: Nicolas Mayencourt <Nicolas.Mayencourt@cui.unige.ch>
+.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
+.\"      Date: 04/10/2009
+.\"    Manual: System Administration Commands
+.\"    Source: Amanda 2.6.1p1
+.\"  Language: English
+.\"
+.TH "AMTOC" "8" "04/10/2009" "Amanda 2\&.6\&.1p1" "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"
 .SH "NAME"
-amtoc - generate TOC (Table Of Contents) for an Amanda run
+amtoc \- generate TOC (Table Of Contents) for an \fIAmanda\fR run
 .SH "SYNOPSIS"
 .SH "SYNOPSIS"
-.HP 6
-\fBamtoc\fR [-a] [-i] [-t] [-f \fIfile\fR] [-s \fIsubs\fR] [-w] [--] \fIlogfile\fR
+.HP \w'\fBamtoc\fR\ 'u
+\fBamtoc\fR [\-a] [\-i] [\-t] [\-f\ \fIfile\fR] [\-s\ \fIsubs\fR] [\-w] [\-\-] \fIlogfile\fR
 .SH "DESCRIPTION"
 .PP
 .SH "DESCRIPTION"
 .PP
-\fBAmtoc\fR
+\fIAmtoc\fR
 generates a table of contents for an
 generates a table of contents for an
-\fBAmanda\fR
-run. It's a perl script (if you don't have perl, install it first!).
+\fIAmanda\fR
+run\&. It\'s a perl script (if you don\'t have perl, install it first!)\&.
 .SH "OPTIONS"
 .SH "OPTIONS"
-.TP
-\fB-a\fR
+.PP
+\fB\-a\fR
+.RS 4
 The output file name will be
 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
 Display help about
-\fBamtoc\fR.
-.TP
-\fB-t\fR
-Generate the output in tabular form.
-.TP
-\fB-f file\fR
-Write the output to a file ('-' for stdout).
-.TP
-\fB-s subs\fR
+\fBamtoc\fR\&.
+.RE
+.PP
+\fB\-t\fR
+.RS 4
+Generate the output in tabular form\&.
+.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
 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
 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
 Marks the last option so the next parameter is the
-\fBlogfile\fR.
-.TP
+\fIlogfile\fR\&.
+.RE
+.PP
 \fBlogfile\fR
 \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:
 .SH "OUTPUT FORMAT"
 .PP
 The standard output has five fields separated by two spaces:
-.sp
 .nf
 .nf
-
 #  Server:/partition  date  level  size[Kb]
 #  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
 1  cuisun15:/cuisun15/home  19991005  1  96
 2  cuinfs:/export/dentiste  19991005  1  96
-  ...
+  \&.\&.\&.
 103  cuisg11:/  19991005  0  4139136
 103  cuisg11:/  19991005  0  4139136
-103  total:  -  -  16716288
-
-
-
+103  total:  \-  \-  16716288
 .fi
 .PP
 .fi
 .PP
-In tabular format (-t), this would look like:
-.sp
+In tabular format (\-t), this would look like:
 .nf
 .nf
-
   #  Server:/partition           date      lev  size[Kb]
   #  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
   1  cuisun15:/cuisun15/home     19991005    1        96
   2  cuinfs:/export/dentiste     19991005    1        96
-  ...
+  \&.\&.\&.
 103  cuisg11:/                   19991005    0   4139136
 103  cuisg11:/                   19991005    0   4139136
-103  total:                      -           -  16716288
-
-
+103  total:                      \-           \-  16716288
 .fi
 .SH "USAGE"
 .PP
 The easiest way to use it is to run
 \fBamtoc\fR
 right after
 .fi
 .SH "USAGE"
 .PP
 The easiest way to use it is to run
 \fBamtoc\fR
 right after
-\fBamdump\fR
+\fIamdump\fR
 in the
 in the
-\fBcron job:\fR
-.sp
+\fIcron job:\fR
 .nf
 .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
 .fi
-.sp
 .PP
 .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
 \fBamtoc\fR
 after an
-\fBamflush\fR.
+\fIamflush\fR\&.
 .SH "SEE ALSO"
 .PP
 \fBamanda\fR(8),
 \fBamdump\fR(8),
 \fBamflush\fR(8),
 .SH "SEE ALSO"
 .PP
 \fBamanda\fR(8),
 \fBamdump\fR(8),
 \fBamflush\fR(8),
-\fBamgetconf\fR(8), cron, perl
-.SH "AUTHOR"
+\fBamgetconf\fR(8), cron, perl,
+: http://wiki.zmanda.com
+.SH "AUTHORS"
 .PP
 .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
 .PP
-Stefan G. Weichinger,
-<sgw@amanda.org>, maintainer of the
-\fBAmanda\fR-documentation: XML-conversion
-
+\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>