'\" t
.\" Title: amtape
-.\" Author: James da Silva <jds@amanda.org>
+.\" Author: Dustin J. Mitchell <dustin@zmanda.com>
.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
-.\" Date: 11/05/2009
+.\" Date: 06/01/2010
.\" Manual: System Administration Commands
-.\" Source: Amanda 2.6.1p2
+.\" Source: Amanda 3.1.0
.\" Language: English
.\"
-.TH "AMTAPE" "8" "11/05/2009" "Amanda 2\&.6\&.1p2" "System Administration Commands"
+.TH "AMTAPE" "8" "06/01/2010" "Amanda 3\&.1\&.0" "System Administration Commands"
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
-amtape \- user interface to \fIAmanda\fR tape changer controls
+amtape \- Control Amanda changers
.SH "SYNOPSIS"
.HP \w'\fBamtape\fR\ 'u
-\fBamtape\fR \fIconfig\fR \fIcommand\fR [\fIcommand_options\fR...] [\fB\-o\ \fR\fIconfigoption\fR]...
+\fBamtape\fR \fIconfig\fR \fIsubcommand\fR [\fIsubcommand_options\fR...] [{\fB\-o\fR\ \fIconfigoption\fR}...]
.SH "DESCRIPTION"
.PP
\fBAmtape\fR
-performs tape changer control operations\&. It uses the underlying tape changer script defined by the
-\fBtpchanger\fR
-option for a particular
-\fIAmanda\fR
-configuration as specified by the
-\fIconfig\fR
-argument\&.
+is the command\-line interface to Amanda\'s tape changers (\fBamanda-changers\fR(7)) and to the taperscan algorithm (\fBamanda-taperscan\fR(7))\&.
.PP
Tape changers maintain a notion of the
\fIcurrent\fR
-and
-\fInext\fR
-slot for each configuration\&. These may or may not correspond to an actual physical state of the device, but do tend to minimize searching through the tape storage slots\&. If the desired tape is in the current slot, it is likely the next tape needed is in the next slot rather than at some random position in the storage slots\&.
+slot for each configuration\&. This may or may not correspond to an actual physical state of the device, but is used by some taperscan algorithms to minimize searching through the slots\&.
.PP
-See the
-\fBamanda\fR(8)
-man page for more details about
-\fIAmanda\fR\&.
-.SH "COMMANDS"
-.PP
-\fBreset\fR
-.RS 4
-Reset the tape changer to a known state\&. The
-\fIcurrent\fR
-slot is set to the
-\fIfirst\fR
-slot\&. Other device\-specific side effects may occur\&. Some gravity stackers need to be reset to the top position by hand\&. This command notifies
-\fIAmanda\fR
-the stacker is back in that position\&.
-.RE
-.PP
-\fBeject\fR
-.RS 4
-If a tape is loaded in the drive, it is ejected and returned to the slot from which it was loaded\&.
-.RE
-.PP
-\fBclean\fR
-.RS 4
-If a cleaning tape is defined for the changer, it is used to clean the drive\&.
-.RE
-.PP
-\fBshow\fR
-.RS 4
-Show the contents of all slots\&. This can be slow\&.
-.RE
+Amtape uses the default changer\&. To use a different changer, use the config override option, e\&.g\&.,
+\fB\-otpchanger=otherchanger\fR\&.
+.SH "SUBCOMMANDS"
.PP
\fBlabel\fR \fIlabel\fR
.RS 4
-Search for and load the
-\fIAmanda\fR
-tape with label
-\fIlabel\fR\&.
+Search for and load the Amanda tape with label
+[label], also setting the current slot\&.
.RE
.PP
-\fBtaper\fR
+\fBslot\fR \fIslot\fR
.RS 4
-Perform the
-\fBtaper\fR
-scan algorithm\&. Load the next tape in the configuration\'s tape sequence, or a fresh tape with a suitable label\&.
+Load the volume in the given slot, also setting the current slot\&. The slot names
+\fBcurrent\fR,
+\fBnext\fR,
+\fBfirst\fR, and
+\fBlast\fR
+have special meaning\&.
.RE
.PP
-\fBdevice\fR
+\fBcurrent\fR
.RS 4
-Display the name of the current tape device on
-\fIstdout\fR\&.
+Shorthand for
+\fBslot\fR
+current\&.
.RE
.PP
-\fBcurrent\fR
+\fBinventory\fR
.RS 4
-Display the current slot\&.
+Show the contents of all slots, based on the changer\'s cached metadata\&. This is a quick operation as it does not load or unload any volumes, but is not supported by all changers\&.
.RE
.PP
-\fBupdate\fR
+\fBshow\fR
.RS 4
-Update the changer label database, if it has one, to match the tapes now available\&.
+Show the contents of all slots by loading each slot and reading its label\&. This can be very slow\&.
.RE
.PP
-\fBslot\fR \fIslot\fR
+\fBreset\fR
.RS 4
-Eject any tape in the drive and put it away, then load the tape from slot
-\fIslot\fR
-and reset
-\fIcurrent\fR\&.
+Reset the changer to a known state\&. This subcommand is intended to clear any unknown and potentially incorrect state the changer may have stored\&.
.RE
.PP
-\fBslot current\fR
+\fBeject\fR [\fIdrive\fR]
.RS 4
-Eject any tape in the drive and put it away, then load the tape from the current slot\&.
+Eject the tape currently in the drive\&. This only applies to some changers\&. Specify a drive (by drive number) if more than one drive is available\&.
.RE
.PP
-\fBslot next\fR
+\fBclean\fR [\fIdrive\fR]
.RS 4
-Eject any tape in the drive and put it away, then load the tape from the next slot and reset
-\fIcurrent\fR\&.
+If a cleaning tape is defined for the changer, used it to clean the specified drive\&. The
+[drive]
+is optional if the changer only has one drive\&.
.RE
.PP
-\fBslot first\fR
+\fBtaper\fR
.RS 4
-Eject any tape in the drive and put it away, then load the tape from the first slot and reset
-\fIcurrent\fR\&.
+Run the taperscan algorithm (see
+\fBamanda-taperscan\fR(7)), displaying information about the progress of the scan\&.
.RE
.PP
-\fBslot advance\fR
+\fBupdate\fR [what]
.RS 4
-Synonym for
-\fBslot next\fR\&.
+Update changer state\&. Consult
+\fBamanda-changers\fR(7)
+for changer\-specific details on the format of
+what\&.
.RE
.PP
-\fB\-o\fR \fIconfigoption\fR
+\fB\-o \fR\fB\fIconfigoption\fR\fR
.RS 4
-See the "\fBCONFIGURATION OVERRIDE\fR" section in
+See the "CONFIGURATION OVERRIDE" section in
\fBamanda\fR(8)\&.
.RE
-.PP
-This is useful with non\-gravity stackers to unload the last tape used and set up
-\fIAmanda\fR
-for the next run\&. If you just use
-\fBeject\fR, the current tape will be mounted again in the next run, where it will be rejected as being still in use, ejected and the next tape requested\&. Using
-\fBslot next\fR
-followed by
-\fBeject\fR
-does an unnecessary mount\&.
-.PP
-Note: most changers optimize the
-\fBslot\fR
-commands to not eject the loaded tape if it is the one being requested\&.
.SH "SEE ALSO"
.PP
\fBamanda\fR(8),
-: http://wiki.zmanda.com
+\fBamanda-changers\fR(7),
+\fBamanda-taperscan\fR(7),
+\fBamanda-devices\fR(7)
+.PP
+The Amanda Wiki:
+: http://wiki.zmanda.com/
.SH "AUTHORS"
.PP
+\fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
+.RS 4
+Zmanda, Inc\&. (http://www\&.zmanda\&.com)
+.RE
+.PP
\fBJames da Silva\fR <\&jds@amanda\&.org\&>
.PP
\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>
projects / debian / amanda / blobdiff