Merge commit 'upstream/3.3.0'
[debian/amanda] / man / amtape.8
index 1741d4f74bbba2d227f876b73cd9a73245eac665..28caa8c6955a7c7c43293f1630ca781860549b91 100644 (file)
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
-.br
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
-..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
-..
-.de Ip \" List item
-.br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
-..
-.TH "AMTAPE" 8 "" "" ""
-.SH NAME
-amtape \- user interface to AMANDA tape changer controls
-.SH "SYNOPSIS"
+'\" t
+.\"     Title: amtape
+.\"    Author: Dustin J. Mitchell <dustin@zmanda.com>
+.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
+.\"      Date: 06/02/2011
+.\"    Manual: System Administration Commands
+.\"    Source: Amanda 3.3.0
+.\"  Language: English
+.\"
+.TH "AMTAPE" "8" "06/02/2011" "Amanda 3\&.3\&.0" "System Administration Commands"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
 .ad l
-.hy 0
-.HP 7
-\fBamtape\fR \fIconfig\fR \fIcommand\fR [\fIcommand\fR\ \fIoptions\fR]
-.ad
-.hy
-
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+amtape \- Control Amanda changers
+.SH "SYNOPSIS"
+.HP \w'\fBamtape\fR\ 'u
+\fBamtape\fR [\fB\-o\fR\ \fIconfigoption\fR...] \fIconfig\fR \fIsubcommand\fR [\fIsubcommand_options\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 \fBAMANDA\fR configuration as specified by the \fBconfig\fR argument\&.
-
+\fBAmtape\fR
+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 \fBcurrent\fR and \fBnext\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\&.
-
+Tape changers maintain a notion of the
+\fIcurrent\fR
+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
+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 Amanda tape with label
+[label], also setting the current slot\&.
+.RE
+.PP
+\fBslot\fR \fIslot\fR
+.RS 4
+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
+\fBcurrent\fR
+.RS 4
+Shorthand for
+\fBslot\fR
+current\&.
+.RE
+.PP
+\fBinventory\fR
+.RS 4
+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
-See the \fBamanda\fR(8) man page for more details about \fBAMANDA\fR\&.
-
-.SH "COMMANDS"
-
-.TP
-\fBreset\fR
-Reset the tape changer to a known state\&. The \fBcurrent\fR slot is set to the \fBfirst\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 \fBAMANDA\fR the stacker is back in that position\&.
-
-.TP
-\fBeject\fR
-If a tape is loaded in the drive, it is ejected and returned to the slot from which it was loaded\&.
-
-.TP
-\fBclean\fR
-If a cleaning tape is defined for the changer, it is used to clean the drive\&.
-
-.TP
 \fBshow\fR
-Show the contents of all slots\&. This can be slow\&.
-
-.TP
-\fBlabel\fR \fBlabel\fR
-Search for and load the \fBAMANDA\fR tape with label \fBlabel\fR\&.
-
-.TP
+.RS 4
+Show the contents of all slots by loading each slot and reading its label\&. This can be very slow\&.
+.RE
+.PP
+\fBreset\fR
+.RS 4
+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
+\fBeject\fR [\fIdrive\fR]
+.RS 4
+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
+\fBclean\fR [\fIdrive\fR]
+.RS 4
+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
 \fBtaper\fR
-Perform the \fBtaper\fR scan algorithm\&. Load the next tape in the configuration's tape sequence, or a fresh tape with a suitable label\&.
-
-.TP
-\fBdevice\fR
-Display the name of the current tape device on \fBstdout\fR\&.
-
-.TP
-\fBcurrent\fR
-Display the current slot\&.
-
-.TP
-\fBupdate\fR
-Update the changer label database, if it has one, to match the tapes now available\&.
-
-.TP
-\fBslot\fR \fBslot\fR
-Eject any tape in the drive and put it away, then load the tape from slot \fBslot\fR and reset \fBcurrent\fR\&.
-
-.TP
-\fBslot current\fR
-Eject any tape in the drive and put it away, then load the tape from the current slot\&.
-
-.TP
-\fBslot prev\fR
-Eject any tape in the drive and put it away, then load the tape from the previous slot and reset \fBcurrent\fR\&.
-
-.TP
-\fBslot next\fR
-Eject any tape in the drive and put it away, then load the tape from the next slot and reset \fBcurrent\fR\&.
-
-.TP
-\fBslot first\fR
-Eject any tape in the drive and put it away, then load the tape from the first slot and reset \fBcurrent\fR\&.
-
-.TP
-\fBslot last\fR
-Eject any tape in the drive and put it away, then load the tape from the last slot and reset \fBcurrent\fR\&.
-
-.TP
-\fBslot advance\fR
-Eject any tape in the drive and put it away\&. Advance \fBcurrent\fR to the next tape, but do not load it\&.
-
-.PP
-This is useful with non\-gravity stackers to unload the last tape used and set up \fBAMANDA\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 "AUTHOR"
-
-.PP
-James da Silva, <jds@amanda\&.org> : Original text
-
-.PP
-Stefan G\&. Weichinger, <sgw@amanda\&.org>, maintainer of the \fBAMANDA\fR\-documentation: XML\-conversion
-
+.RS 4
+Run the taperscan algorithm (see
+\fBamanda-taperscan\fR(7)), displaying information about the progress of the scan\&.
+.RE
+.PP
+\fBupdate\fR [what]
+.RS 4
+Update changer state\&. Consult
+\fBamanda-changers\fR(7)
+for changer\-specific details on the format of
+what\&.
+.RE
+.PP
+\fB\-o \fR\fB\fIconfigoption\fR\fR
+.RS 4
+See the "CONFIGURATION OVERRIDE" section in
+\fBamanda\fR(8)\&.
+.RE
 .SH "SEE ALSO"
-
 .PP
-\fBamanda\fR(8)
-
+\fBamanda\fR(8),
+\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\&>