Imported Upstream version 2.6.1
[debian/amanda] / man / amtape.8
index c31c20784b87c726c02ac9be02940270cea1f0b7..e0c6ae18dae5c6c97234737828764d3bdb5d64f9 100644 (file)
+.\"     Title: amtape
+.\"    Author: James da Silva <jds@amanda.org>
+.\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
+.\"      Date: 01/22/2009
+.\"    Manual: System Administration Commands
+.\"    Source: Amanda 2.6.1
+.\"  Language: English
 .\"
-.de CO
-\fB\\$1\fP \fI\\$2\fP
+.TH "AMTAPE" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
+.\" -----------------------------------------------------------------
+.\" * (re)Define some macros
+.\" -----------------------------------------------------------------
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" toupper - uppercase a string (locale-aware)
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de toupper
+.tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
+\\$*
+.tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
 ..
-.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
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH-xref - format a cross-reference to an SH section
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de SH-xref
+.ie n \{\
+.\}
+.toupper \\$*
+.el \{\
+\\$*
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SH - level-one heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SH
+.\" put an extra blank line of space above the head in non-TTY output
+.if t \{\
+.sp 1
+.\}
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[an-margin]u
+.ti 0
+.HTML-TAG ".NH \\n[an-level]"
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+\." make the size of the head bigger
+.ps +3
+.ft B
+.ne (2v + 1u)
+.ie n \{\
+.\" if n (TTY output), use uppercase
+.toupper \\$*
+.\}
+.el \{\
+.nr an-break-flag 0
+.\" if not n (not TTY), use normal case (not uppercase)
+\\$1
+.in \\n[an-margin]u
+.ti 0
+.\" if not n (not TTY), put a border/line under subheading
+.sp -.6
+\l'\n(.lu'
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" SS - level-two heading that works better for non-TTY output
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de1 SS
+.sp \\n[PD]u
+.nr an-level 1
+.set-an-margin
+.nr an-prevailing-indent \\n[IN]
+.fi
+.in \\n[IN]u
+.ti \\n[SN]u
+.it 1 an-trap
+.nr an-no-space-flag 1
+.nr an-break-flag 1
+.ps \\n[PS-SS]u
+\." make the size of the head bigger
+.ps +2
+.ft B
+.ne (2v + 1u)
+.if \\n[.$] \&\\$*
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BB/BE - put background/screen (filled box) around block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BB
+.if t \{\
+.sp -.5
+.br
+.in +2n
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EB
+.if t \{\
+.if "\\$2"adjust-for-leading-newline" \{\
+.sp -1
+.\}
+.br
+.di
+.in
+.ll
+.gcolor
+.nr BW \\n(.lu-\\n(.i
+.nr BH \\n(dn+.5v
+.ne \\n(BHu+.5v
+.ie "\\$2"adjust-for-leading-newline" \{\
+\M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.el \{\
+\M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
+.\}
+.in 0
+.sp -.5v
+.nf
+.BX
+.in
+.sp .5v
+.fi
+.\}
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BM/EM - put colored marker in margin next to block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BM
+.if t \{\
+.br
+.ll -2n
+.gcolor red
+.di BX
+.\}
+..
+.de EM
+.if t \{\
+.br
+.di
+.ll
+.gcolor
+.nr BH \\n(dn
+.ne \\n(BHu
+\M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
+.in 0
+.nf
+.BX
+.in
+.fi
+.\}
+..
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
+.ad l
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "Name"
+amtape \- user interface to \fIAmanda\fR tape changer controls
+.SH "Synopsis"
+.fam C
+.HP \w'\fBamtape\fR\ 'u
+\fBamtape\fR \fIconfig\fR \fIcommand\fR [\fIcommand_options\fR...] [\fB\-o\ \fR\fIconfigoption\fR]...
+.fam
+.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
-.I config
-argument.
-.LP
+\fIconfig\fR
+argument\&.
+.PP
 Tape changers maintain a notion of the
-.I current
+\fIcurrent\fR
 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
+\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\&.
+.PP
 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
+\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
-.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
-Search for and load the Amanda tape with label
-.IR label .
-.TP
-.B taper
+\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
+.PP
+\fBlabel\fR \fIlabel\fR
+.RS 4
+Search for and load the
+\fIAmanda\fR
+tape with label
+\fIlabel\fR\&.
+.RE
+.PP
+\fBtaper\fR
+.RS 4
 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
+\fBtaper\fR
+scan algorithm\&. Load the next tape in the configuration\'s tape sequence, or a fresh tape with a suitable label\&.
+.RE
+.PP
+\fBdevice\fR
+.RS 4
 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
+\fIstdout\fR\&.
+.RE
+.PP
+\fBcurrent\fR
+.RS 4
+Display the current slot\&.
+.RE
+.PP
+\fBupdate\fR
+.RS 4
+Update the changer label database, if it has one, to match the tapes now available\&.
+.RE
+.PP
+\fBslot\fR \fIslot\fR
+.RS 4
+Eject any tape in the drive and put it away, then load the tape from slot
+\fIslot\fR
 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
+\fIcurrent\fR\&.
+.RE
+.PP
+\fBslot current\fR
+.RS 4
+Eject any tape in the drive and put it away, then load the tape from the current slot\&.
+.RE
+.PP
+\fBslot next\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\&.
+.RE
+.PP
+\fBslot first\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\&.
+.RE
+.PP
+\fBslot advance\fR
+.RS 4
+Synonym for
+\fBslot next\fR\&.
+.RE
+.PP
+\fB\-o\fR \fIconfigoption\fR
+.RS 4
+See the "\fBCONFIGURATION OVERRIDE\fR" 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
-.B eject
-does an unnecessary mount.
-.LP
+\fBeject\fR
+does an unnecessary mount\&.
+.PP
 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
+\fBslot\fR
+commands to not eject the loaded tape if it is the one being requested\&.
 .SH "SEE ALSO"
-amanda(8)
+.PP
+\fBamanda\fR(8),
+: http://wiki.zmanda.com
+.SH "Authors"
+.PP
+\fBJames da Silva\fR <\&jds@amanda\&.org\&>
+.PP
+\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>