Imported Upstream version 3.3.0
[debian/amanda] / man / xml-source / tapelist.5.xml
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"
4 [
5   <!-- entities files to use -->
6   <!ENTITY % global_entities SYSTEM 'global.entities'>
7   %global_entities;
8 ]>
9
10 <refentry id='tapelist.5'>
11
12 <refmeta>
13 <refentrytitle>tapelist</refentrytitle>
14 <manvolnum>5</manvolnum>
15 &rmi.source;
16 &rmi.version;
17 &rmi.manual.5;
18 </refmeta>
19 <refnamediv>
20 <refname>tapelist</refname>
21 <refpurpose>The list of Amanda volumes in use</refpurpose>
22 </refnamediv>
23 <refentryinfo>
24 &author.jds;
25 &author.sgw.xml;
26 &author.dustin;
27 </refentryinfo>
28 <!-- body begins here -->
29
30 <refsect1><title>DESCRIPTION</title>
31
32 <para>The <emphasis remap='I'>tapelist</emphasis> file contains the list of
33 tapes in active use.  This file is not ordinarily ordinarily edited or examined
34 manually.  Its format may change, or it may be removed altogether, in future
35 versions of Amanda.  It contains lines of the form:</para>
36
37 <para><programlisting>
38 YYYYMMDD label flags [BARCODE:barcode] [META:meta] [#comment]
39 </programlisting></para>
40
41 <para>Where
42 <emphasis remap='I'>YYYYMMDD</emphasis>
43 is the date the tape was written,
44 <emphasis remap='I'>label</emphasis>
45 is a label for the tape as written by
46 <emphasis remap='B'>amlabel</emphasis>
47 and
48 <emphasis remap='I'>flags</emphasis>
49 is one of "reuse" or "no-reuse" and tells Amanda whether the tape may be reused.
50 A non-reusable tape will not be overwritten, even if it is older than <emphasis
51 remap='B'>dumpcycle</emphasis> dumps.  See the
52 <emphasis remap='B'>reuse</emphasis>
53 options of
54 <manref name="amadmin" vol="8"/>.
55 The optional barcode is prefixed with 'BARCODE' if the volume have a barcode.
56 The optional meta label is prefixed with 'META' if the volume is on a meta volume.
57 The optional comment is prefixed with a '#' and continues to the end of the line.  Amanda
58 will maintain this comment until the tape is overwritten.  Note that comments are not
59 allowed on blank lines.</para>
60
61 <para>The file is sorted such that the most-recently used tape appears on the first line, and the oldest tape appears on the last line.</para>
62
63 <para><emphasis remap='B'>Amdump</emphasis>
64 and
65 <emphasis remap='B'>amflush</emphasis>
66 will by default refuse to write to an unlabeled tape, or to a labeled tape that
67 is considered active or marked "no-reuse".  There must be more tapes in active
68 rotation (see the
69 <emphasis remap='B'>tapecycle</emphasis>
70 option) than there are runs in the backup cycle (see the
71 <emphasis remap='B'>dumpcycle</emphasis>
72 option) to prevent overwriting a backup image that would be needed to do a full recovery.</para>
73 </refsect1>
74
75 <seealso>
76 <manref name="amanda.conf" vol="5"/>
77 </seealso>
78
79 </refentry>