lintian doesn't like orphan packages with uploaders...

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

diff --git a/man/amanda-taperscan.7 b/man/amanda-taperscan.7
index a1a0bad12200419108d7abc1ba59523e27a71a53..f26b4cfe21cbda91e0b10c6d48c14902c6ec8775 100644 (file)
--- a/man/amanda-taperscan.7
+++ b/man/amanda-taperscan.7
@@ -1,13 +1,22 @@
 '\" t
 .\"     Title: amanda-taperscan
 .\"    Author: Dustin J. Mitchell <dustin@zmanda.com>
-.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
-.\"      Date: 10/18/2010
+.\" Generator: DocBook XSL Stylesheets v1.76.1 <http://docbook.sf.net/>
+.\"      Date: 01/10/2013
 .\"    Manual: Miscellanea
-.\"    Source: Amanda 3.2.0
+.\"    Source: Amanda 3.3.3
 .\"  Language: English
 .\"
-.TH "AMANDA\-TAPERSCAN" "7" "10/18/2010" "Amanda 3\&.2\&.0" "Miscellanea"
+.TH "AMANDA\-TAPERSCAN" "7" "01/10/2013" "Amanda 3\&.3\&.3" "Miscellanea"
+.\" -----------------------------------------------------------------
+.\" * Define some portability stuff
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" http://bugs.debian.org/507673
+.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.ie \n(.g .ds Aq \(aq
+.el       .ds Aq '
 .\" -----------------------------------------------------------------
 .\" * set default formatting
 .\" -----------------------------------------------------------------
@@ -35,9 +44,36 @@ Taperscan algorithms are implemented as perl packages with the prefix
 Amanda::Taper::Scan::\&. See the perl documentation for
 Amanda::Taper::Scan
 for more information\&.
+.SH "DEFINING A TAPERSCAN"
+.PP
+An taperscan is defined in
+\fBamanda.conf\fR(5)
+as follows:
+.sp
+.nf
+define taperscan $taperscan_name {
+   comment "$comment"
+   plugin "$pluginname"
+   property "$PROPERTY_NAME" "$PROPERTY_VALUE"
+   \&.\&.\&.
+}
+.fi
+and then referenced in the global section as
+.sp
+.nf
+  taperscan "$taperscan_name"
+.fi
+.PP
+Taperscan properties, like Amanda configuration parameters, are insensitive to case, and
+\-
+(dash) and
+_
+(underscore) may be used interchangeably\&.
+.PP
+See the individual plugin documentation below for properties applicable to each plugin\&.
 .SH "TAPERSCAN ALGORITHMS"
 .PP
-In general, these volumes will only select reusable volumes\&. These are volumes which are listed in the
+In general, these algorithms will only select reusable volumes\&. These are volumes which are listed in the
 \fBtapelist\fR(5)
 with the
 \fIreuse\fR
@@ -52,7 +88,7 @@ but never used) are considered reusable\&.
 Many of these algorithms look for the oldest reusable volume\&. In most cases, this is the best volume to overwrite, as the data it contains is older than that on any other volume\&. If there are no reusable volumes, then there is no oldest reusable volume\&.
 .SS "traditional"
 .PP
-This algorithm duplicates Amanda\'s historical behavior, and it operates in two stages\&.
+This algorithm duplicates Amanda\*(Aqs historical behavior, and it operates in two stages\&.
 .PP
 First, if there is an oldest reusable volume and if the changer supports "fast" searches, then the algorithm uses the changer to search for that volume\&. Newly labeled volumes are not considered when calculating the oldest reusable volume\&. Consequently, this taperscan algorithm prefers volumes which have been used before to newly\-labeled volumes when a fast\-searchable changer is in use\&.
 .PP
@@ -84,12 +120,35 @@ algorithm are used and new tapes may be unexpectedly excluded\&.  If this causes
 an undesirable change in behavior, consider one of the other taperscan
 algorithms\&..sp .5v
 .RE
+.SS "oldest"
+.PP
+This algorithm works with the Changer API (see
+\fBamanda-changers\fR(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\&.
+.PP
+An acceptable volume is a reusable volume, a new labeled volume or an unlabeled volume that can be labeled according to
+\fBautolabel\fR\&. 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\&.
+.PP
+Use
+\fBamtape CONF inventory\fR
+to see the changer\*(Aqs inventory, and use
+\fBamtape CONF update\fR
+to update it\&.
+.SS "lexical"
+.PP
+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\&.,
+CORP\-010, this algorithm will run through the volumes in the natural order\&.
+.PP
+It scans unknown slots only if no usable volume is found in the inventory\&.
+.PP
+See
+\fBoldest\fR, above, for a definition of acceptable volumes\&.
 .SH "SEE ALSO"
 .PP
 \fBamanda\fR(8),
 \fBamanda.conf\fR(5),
 \fBtapelist\fR(5),
-\fBamanda-changers\fR(7)
+\fBamanda-changers\fR(7),
+\fBamanda-interactivity\fR(7)
 .PP
 The Amanda Wiki:
 : http://wiki.zmanda.com/