Imported Upstream version 3.2.0
[debian/amanda] / man / amtape.8
index c31c20784b87c726c02ac9be02940270cea1f0b7..85e2326d3bce8f25e4e5f134da7ef1828592b19c 100644 (file)
+'\" t
+.\"     Title: amtape
+.\"    Author: Dustin J. Mitchell <dustin@zmanda.com>
+.\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
+.\"      Date: 10/18/2010
+.\"    Manual: System Administration Commands
+.\"    Source: Amanda 3.2.0
+.\"  Language: English
 .\"
-.de CO
-\fB\\$1\fP \fI\\$2\fP
-..
-.TH AMTAPE 8
-.SH NAME
-amtape \- user interface to Amanda tape changer controls
-.SH SYNOPSIS
-.B amtape
-.I config
-.I command
-[
-.I command options
-]
-.SH DESCRIPTION
-.B Amtape
-performs tape changer control operations.
-It uses the underlying tape changer script defined by the
-.B tpchanger
-option for a particular Amanda
-configuration as specified by the
-.I config
-argument.
-.LP
+.TH "AMTAPE" "8" "10/18/2010" "Amanda 3\&.2\&.0" "System Administration Commands"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "NAME"
+amtape \- Control Amanda changers
+.SH "SYNOPSIS"
+.HP \w'\fBamtape\fR\ 'u
+\fBamtape\fR \fIconfig\fR \fIsubcommand\fR [\fIsubcommand_options\fR...] [\fB\-o\fR\ \fIconfigoption\fR...]
+.SH "DESCRIPTION"
+.PP
+\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
-.I current
-and
-.I next
-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.
-.LP
-See the
-.IR amanda (8)
-man page for more details about Amanda.
-.SH COMMANDS
-.TP
-.B reset
-Reset the tape changer to a known state.
-The
-.I current
-slot is set to the
-.I first
-slot.
-Other device-specific side effects may occur.
-Some gravity stackers need to be reset to the top position by hand.
-This command notifies Amanda the stacker is back in that position.
-.TP
-.B eject
-If a tape is loaded in the drive, it is ejected and returned to the
-slot from which it was loaded.
-.TP
-.B clean
-If a cleaning tape is defined for the changer,
-it is used to clean the drive.
-.TP
-.B show
-Show the contents of all slots.
-This can be slow.
-.TP
-.CO label label
+\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
-.IR label .
-.TP
-.B taper
-Perform the
-.B taper
-scan algorithm.
-Load the next tape in the configuration's tape sequence,
-or a fresh tape with a suitable label.
-.TP
-.B device
-Display the name of the current tape device on
-.IR stdout .
-.TP
-.B current
-Display the current slot.
-.TP
-.B update
-Update the changer label database, if it has one,
-to match the tapes now available.
-.TP
-.CO slot slot
-Eject any tape in the drive and put it away,
-then load the tape from slot
-.I slot
-and reset
-.IR current .
-.TP
-.B slot current
-Eject any tape in the drive and put it away,
-then load the tape from the current slot.
-.TP
-.B slot prev
-Eject any tape in the drive and put it away,
-then load the tape from the previous slot and reset
-.IR current .
-.TP
-.B slot next
-Eject any tape in the drive and put it away,
-then load the tape from the next slot and reset
-.IR current .
-.TP
-.B slot first
-Eject any tape in the drive and put it away,
-then load the tape from the first slot and reset
-.IR current .
-.TP
-.B slot last
-Eject any tape in the drive and put it away,
-then load the tape from the last slot and reset
-.IR current .
-.TP
-.B slot advance
-Eject any tape in the drive and put it away.
-Advance
-.I current
-to the next tape, but do not load it.
-.IP
-This is useful with non-gravity stackers to unload the last tape used
-and set up Amanda for the next run.
-If you just use
-.BR eject ,
-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
-.B slot next
-followed by
-.B eject
-does an unnecessary mount.
-.LP
-Note: most changers optimize the
-.B slot
-commands to not eject the loaded tape if it is the one being requested.
-.SH AUTHOR
-James da Silva <jds@cs.umd.edu>
-.br
-University of Maryland, College Park
+[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
+\fBshow\fR
+.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
+.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"
-amanda(8)
+.PP
+\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\&>