1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.1.2//EN"
3 "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
5 <!-- entities files to use -->
6 <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
10 <!-- lifted from troff+man by doclifter -->
11 <refentry id='amtoc.8'>
13 <refentrytitle>amtoc</refentrytitle>
14 <manvolnum>8</manvolnum>
17 <refname>amtoc</refname>
18 <refpurpose>generate TOC (Table Of Contents) for an &A; run</refpurpose>
20 <!-- body begins here -->
23 <command>amtoc</command>
24 <arg choice='opt'>-a </arg>
25 <arg choice='opt'>-i </arg>
26 <arg choice='opt'>-t </arg>
27 <arg choice='opt'><arg choice='plain'>-f </arg><arg choice='plain'><replaceable>file</replaceable></arg></arg>
28 <arg choice='opt'><arg choice='plain'>-s </arg><arg choice='plain'><replaceable>subs</replaceable></arg></arg>
29 <arg choice='opt'>-w </arg>
30 <arg choice='opt'>-- </arg>
31 <arg choice='plain'><replaceable>logfile</replaceable></arg>
36 <refsect1><title>DESCRIPTION</title>
37 <para><emphasis remap='I'>Amtoc</emphasis>
38 generates a table of contents for an &A; run.
39 It's a perl script (if you don't have perl, install it first!).</para>
42 <refsect1><title>OPTIONS</title>
43 <variablelist remap='TP'>
45 <term><option>-a</option></term>
47 <para>The output file name will be
48 <emphasis remap='I'>label-of-the-tape</emphasis>.toc
49 in the same directory as
50 <emphasis remap='I'>logfile</emphasis>.</para>
54 <term><option>-i</option></term>
56 <para>Display help about
57 <command>amtoc</command>.</para>
61 <term><option>-t</option></term>
63 <para>Generate the output in tabular form.</para>
67 <term><option>-f file</option></term>
69 <para>Write the output to a file ('-' for stdout).</para>
73 <term><option>-s subs</option></term>
75 <para>Evaluate the output file name from
76 <emphasis remap='I'>subs</emphasis>,
78 <emphasis remap='I'>label-of-the-tape</emphasis>.
81 option is equivalent to
83 <replaceable>'s/$_/.toc/'</replaceable>.</para>
87 <term><option>-w</option></term>
89 <para>Separate tapes with form-feeds and display blank lines before totals.</para>
93 <term><option>--</option></term>
95 <para>Marks the last option so the next parameter is the
96 <emphasis remap='I'>logfile</emphasis>.</para>
100 <term><emphasis remap='B'>logfile</emphasis></term>
102 <para>(use '-' for stdin)</para>
108 <refsect1><title>OUTPUT FORMAT</title>
109 <para>The standard output has five fields separated by two spaces:</para>
112 <literallayout remap='.nf'>
113 # Server:/partition date level size[Kb]
114 0 daily-05: 19991005 - -
115 1 cuisun15:/cuisun15/home 19991005 1 96
116 2 cuinfs:/export/dentiste 19991005 1 96
118 103 cuisg11:/ 19991005 0 4139136
119 103 total: - - 16716288
122 </literallayout><para>In tabular format (-t), this would look like:</para>
125 <literallayout remap='.nf'>
126 # Server:/partition date lev size[Kb]
127 0 daily-05: 19991005 - -
128 1 cuisun15:/cuisun15/home 19991005 1 96
129 2 cuinfs:/export/dentiste 19991005 1 96
131 103 cuisg11:/ 19991005 0 4139136
132 103 total: - - 16716288
134 </literallayout></refsect1>
136 <refsect1><title>USAGE</title>
137 <para>The easiest way to use it is to run
138 <command>amtoc</command>
140 <emphasis remap='I'>amdump</emphasis>
142 <emphasis remap='I'>cron job:</emphasis></para>
145 <literallayout remap='.nf'>
146 amdump daily ; logdir=`amgetconf daily logdir` ; log=`ls -1t $logdir/log.*.[0-9] | head -1` ; amtoc -a $log
147 </literallayout> <!-- .fi -->
149 <para>which will generate /usr/local/etc/amanda//daily/<emphasis remap='I'>tape_label</emphasis>.toc.
150 You may also want to call
151 <command>amtoc</command>
153 <emphasis remap='I'>amflush</emphasis>.</para>
156 <refsect1><title>SEE ALSO</title>
157 <para><citerefentry><refentrytitle>amanda</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
158 <citerefentry><refentrytitle>amdump</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
159 <citerefentry><refentrytitle>amflush</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
160 <citerefentry><refentrytitle>amgetconf</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
165 <refsect1><title>AUTHOR</title>
166 <para>Nicolas Mayencourt <email>Nicolas.Mayencourt@cui.unige.ch</email>, University of Geneva/Switzerland : Original text</para>
167 <para>&maintainer.sgw;: XML-conversion</para>