Imported Upstream version 3.3.0

[debian/amanda] / man / xml-source / amanda-taperscan.7.xml

diff --git a/man/xml-source/amanda-taperscan.7.xml b/man/xml-source/amanda-taperscan.7.xml
index 6e206971d7897f026f754bab8143671b42d7aead..6c53d4eafa18fd4a6bb61f5f1d90debbd012fe0c 100644 (file)
--- a/man/xml-source/amanda-taperscan.7.xml
+++ b/man/xml-source/amanda-taperscan.7.xml
@@ -43,9 +43,35 @@ remap='B'>taperscan</emphasis> parameter, which has a default value of
 
 </refsect1>
 
+<refsect1><title>DEFINING A TAPERSCAN</title>
+
+<para>An taperscan is defined in &amconf; as follows:
+
+<programlisting>
+define taperscan $taperscan_name {
+   comment "$comment"
+   plugin "$pluginname"
+   property "$PROPERTY_NAME" "$PROPERTY_VALUE"
+   ...
+}
+</programlisting>
+and then referenced in the global section as
+<programlisting>
+  taperscan "$taperscan_name"
+</programlisting></para>
+
+<para>Taperscan properties, like Amanda configuration parameters, are
+insensitive to case, and <literal>-</literal> (dash) and
+<literal>_</literal> (underscore) may be used interchangeably.</para>
+
+<para>See the individual plugin documentation below for properties applicable to each
+plugin.</para>
+
+</refsect1>
+
 <refsect1><title>TAPERSCAN ALGORITHMS</title>
 
-<para>In general, these volumes will only select reusable volumes.  These are
+<para>In general, these algorithms will only select reusable volumes.  These are
 volumes which are listed in the &tapelist; with the <emphasis>reuse</emphasis>
 flag, and which are not among the <emphasis>tapecycle-1</emphasis> most recent
 volumes in the list.  Put another way, reusable volumes do not contain data
@@ -93,12 +119,49 @@ algorithms.</note>
 
 </refsect2>
 
+<refsect2><title>oldest</title>
+
+<para>This algorithm works with the Changer API (see <manref
+name="amanda-changers" vol="7" />), using the inventory returned by the
+changer to locate the oldest acceptable volume available. Note that this
+will not work with changers that do not support inventory (old
+changers).  The algorithms scans
+unknown slots only if no known usable volume is found in the inventory.</para>
+
+<para>An acceptable volume is a reusable volume, a new labeled volume or an
+unlabeled volume that can be labeled according to <amkeyword>autolabel</amkeyword>.
+Note that changers do not always know the contents of every slot - for
+example, a tape with an unknown barcode will not be considered usable.</para>
+
+<para>Use <command>amtape CONF inventory</command> to see the changer's inventory, and use
+<command>amtape CONF update</command> to update it.</para>
+
+</refsect2>
+
+<refsect2><title>lexical</title>
+
+<para>This algorithm also works with the Changer API, using the inventory to
+determine the acceptable volumes; it then uses the volume which follows the
+last-used volume in lexical order.  For volume labels containing leading
+zeros, e.g., <filename>CORP-010</filename>, this algorithm will run through
+the volumes in the natural order.</para>
+
+<para>It scans unknown slots only if no usable volume
+is found in the inventory.</para>
+
+<para>See <amkeyword>oldest</amkeyword>, above, for a definition of acceptable
+volumes.</para>
+
+>>>>>>> 6a40a39... manpage edits
+</refsect2>
+
 </refsect1>
 
 <seealso>
 <manref name="amanda.conf" vol="5"/>,
 <manref name="tapelist" vol="5"/>,
 <manref name="amanda-changers" vol="7"/>,
+<manref name="amanda-interactivity" vol="7"/>,
 </seealso>
 
 </refentry>