Merge tag 'upstream/3.3.3'
[debian/amanda] / man / xml-source / tapelist.5.xml
index ae5c3435ed99dffec697ab263e8a12d371e9cbb4..40d3cfb3d36479a93c5145e07790fb49caa33b29 100644 (file)
@@ -3,7 +3,7 @@
                    "http://www.oasis-open.org/docbook/xml/4.1.2/docbookx.dtd"
 [
   <!-- entities files to use -->
-  <!ENTITY % global_entities SYSTEM '../entities/global.entities'>
+  <!ENTITY % global_entities SYSTEM 'global.entities'>
   %global_entities;
 ]>
 
@@ -18,7 +18,7 @@
 </refmeta>
 <refnamediv>
 <refname>tapelist</refname>
-<refpurpose>The list of &A; volumes in use</refpurpose>
+<refpurpose>The list of Amanda volumes in use</refpurpose>
 </refnamediv>
 <refentryinfo>
 &author.jds;
 <para>The <emphasis remap='I'>tapelist</emphasis> file contains the list of
 tapes in active use.  This file is not ordinarily ordinarily edited or examined
 manually.  Its format may change, or it may be removed altogether, in future
-versions of &A;.  It contains lines of the form:</para>
+versions of Amanda.  It contains lines of the form:</para>
 
-<para><programlisting>YYYYMMDD label flags [#comment]
+<para><programlisting>
+YYYYMMDD label flags [BARCODE:barcode] [META:meta] [BLOCKSIZE:blocksize] [#comment]
 </programlisting></para>
 
 <para>Where
@@ -45,16 +46,21 @@ is a label for the tape as written by
 <emphasis remap='B'>amlabel</emphasis>
 and
 <emphasis remap='I'>flags</emphasis>
-is one of "reuse" or "no-reuse" and tells &A; whether the tape may be reused.
+is one of "reuse" or "no-reuse" and tells Amanda whether the tape may be reused.
 A non-reusable tape will not be overwritten, even if it is older than <emphasis
 remap='B'>dumpcycle</emphasis> dumps.  See the
 <emphasis remap='B'>reuse</emphasis>
 options of
-<citerefentry><refentrytitle>amadmin</refentrytitle><manvolnum>8</manvolnum></citerefentry>.
+<manref name="amadmin" vol="8"/>.
+The optional barcode is prefixed with 'BARCODE' if the volume have a barcode.
+The optional meta label is prefixed with 'META' if the volume is on a meta volume.
+The optional blocksize is prefixed with 'BLOCKSIZE'.
 The optional comment is prefixed with a '#' and continues to the end of the line.  Amanda
 will maintain this comment until the tape is overwritten.  Note that comments are not
 allowed on blank lines.</para>
 
+<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>
+
 <para><emphasis remap='B'>Amdump</emphasis>
 and
 <emphasis remap='B'>amflush</emphasis>
@@ -67,4 +73,8 @@ option) than there are runs in the backup cycle (see the
 option) to prevent overwriting a backup image that would be needed to do a full recovery.</para>
 </refsect1>
 
+<seealso>
+<manref name="amanda.conf" vol="5"/>
+</seealso>
+
 </refentry>