Imported Upstream version 2.4.5

[debian/amanda] / docs / amtoc.8.txt

diff --git a/docs/amtoc.8.txt b/docs/amtoc.8.txt
new file mode 100644 (file)
index 0000000..5d475b6
--- /dev/null
+++ b/docs/amtoc.8.txt
@@ -0,0 +1,98 @@
+
+                                amtoc
+Prev  Chapter 35. The AMANDA Manual Pages.  Next
+
+-------------------------------------------------------------------------------
+
+Name
+
+amtoc \14 generate TOC (Table Of Contents) for an AMANDA run
+
+Synopsis
+
+amtoc [-a ] [-i ] [-t ] [ -f file ] [ -s subs ] [-w ] [-- ] logfile
+
+DESCRIPTION
+
+Amtoc generates a table of contents for an AMANDA run. It's a perl script (if
+you don't have perl, install it first!).
+
+OPTIONS
+
+
+
+  -a
+      The output file name will be label-of-the-tape.toc in the same directory
+      as logfile.
+
+  -i
+      Display help about amtoc.
+
+  -t
+      Generate the output in tabular form.
+
+  -f file
+      Write the output to a file ('-' for stdout).
+
+  -s subs
+      Evaluate the output file name from subs, with $_ set to label-of-the-
+      tape. The -a option is equivalent to -s 's/$_/.toc/'.
+
+  -w
+      Separate tapes with form-feeds and display blank lines before totals.
+
+  --
+      Marks the last option so the next parameter is the logfile.
+
+  logfile
+      (use '-' for stdin)
+
+
+OUTPUT FORMAT
+
+The standard output has five fields separated by two spaces:
+
+#  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
+
+
+In tabular format (-t), this would look like:
+
+  #  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
+
+
+USAGE
+
+The easiest way to use it is to run amtoc right after amdump in the cron job:
+
+amdump daily ; logdir=`amgetconf daily logdir` ; log=`ls -1t $logdir/log.*.[0-
+9] | head -1` ; amtoc -a $log
+which will generate /usr/local/etc/amanda//daily/tape_label.toc. You may also
+want to call amtoc after an amflush.
+
+SEE ALSO
+
+amanda(8), amdump(8), amflush(8), amgetconf(8), cron, perl
+
+AUTHOR
+
+Nicolas Mayencourt <Nicolas.Mayencourt@cui.unige.ch>, University of Geneva/
+Switzerland : Original text
+Stefan G. Weichinger, <sgw@amanda.org>, maintainer of the AMANDA-documentation:
+XML-conversion
+-------------------------------------------------------------------------------
+
+Prev         Up       Next
+amtapetype  Home  amverify
+