Imported Upstream version 2.6.1
[debian/amanda] / man / amlabel.8
index 863da6cccc6b74d3980a504259e1fdec6288b9d0..918f2707520cd18c2c43da8fcfc206a56240e1e2 100644 (file)
-.\"Generated by db2man.xsl. Don't modify this, modify the source.
-.de Sh \" Subsection
+.\"     Title: amlabel
+.\"    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
+.\"
+.TH "AMLABEL" "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
+..
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" 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
-.if t .Sp
-.ne 5
-.PP
-\fB\\$1\fR
-.PP
+.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
+.\}
 ..
-.de Sp \" Vertical space (when we can't use .PP)
-.if t .sp .5v
-.if n .sp
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.\" BM/EM - put colored marker in margin next to block of text
+.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+.de BM
+.if t \{\
+.br
+.ll -2n
+.gcolor red
+.di BX
+.\}
 ..
-.de Ip \" List item
+.de EM
+.if t \{\
 .br
-.ie \\n(.$>=3 .ne \\$3
-.el .ne 3
-.IP "\\$1" \\$2
+.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
+.\}
 ..
-.TH "AMLABEL" 8 "" "" ""
-.SH NAME
-amlabel \- label an AMANDA tape
-.SH "SYNOPSIS"
+.\" -----------------------------------------------------------------
+.\" * set default formatting
+.\" -----------------------------------------------------------------
+.\" disable hyphenation
+.nh
+.\" disable justification (adjust text to left margin only)
 .ad l
-.hy 0
-.HP 8
-\fBamlabel\fR [\-f] \fIconfig\fR \fIlabel\fR [\fIslot\fR\ \fIslot\fR]
-.ad
-.hy
-
+.\" -----------------------------------------------------------------
+.\" * MAIN CONTENT STARTS HERE *
+.\" -----------------------------------------------------------------
+.SH "Name"
+amlabel \- label an \fIAmanda\fR tape
+.SH "Synopsis"
+.fam C
+.HP \w'\fBamlabel\fR\ 'u
+\fBamlabel\fR [\-f] \fIconfig\fR \fIlabel\fR [slot\ \fIslot\fR] [\-o\ \fIconfigoption\fR]...
+.fam
 .SH "DESCRIPTION"
-
 .PP
-All \fBAMANDA\fR tapes must be pre\-labeled before they are used\&. \fBAMANDA\fR verifies the label in \fBamdump\fR and \fBamflush\fR before writing to make sure the proper tape is loaded\&.
-
+All
+\fIAmanda\fR
+tapes must be pre\-labeled before they are used\&.
+\fIAmanda\fR
+verifies the label in
+\fBamdump\fR
+and
+\fBamflush\fR
+before writing to make sure the proper tape is loaded\&.
 .PP
-\fBAmlabel\fR writes an \fBAMANDA\fR label on the tape in the device specified by the \fBamanda\&.conf\fR file in /usr/local/etc/amanda/\fBconfig\fR\&. \fBLabel\fR may be any string that does not contain whitespace and that matches the \fBamanda\&.conf\fR  \fBlabelstr\fR regular expression option\&. It is up to the system administrator to define a naming convention\&.
-
+\fBAmlabel\fR
+writes an
+\fIAmanda\fR
+label on the tape in the device specified by the
+\fIamanda\&.conf\fR
+file in /usr/local/etc/amanda/\fIconfig\fR\&.
+\fILabel\fR
+may be any string that does not contain whitespace and that matches the
+\fIamanda\&.conf\fR
+\fBlabelstr\fR
+regular expression option\&. It is up to the system administrator to define a naming convention\&.
 .PP
-\fBAmlabel\fR appends the new tape to the \fBtapelist\fR file so it will be used by \fBAMANDA\fR before it reuses any other tapes\&. When you \fBamlabel\fR multiple tapes, they will be used in the order you \fBamlabel\fR them\&.
-
+\fBAmlabel\fR
+appends the new tape to the
+\fBtapelist\fR(5)
+file so it will be used by
+\fIAmanda\fR
+before it reuses any other tapes\&. When you
+\fBamlabel\fR
+multiple tapes, they will be used in the order you
+\fBamlabel\fR
+them\&.
 .PP
-\fBAmlabel\fR will not write the label if the tape contains an active \fBAMANDA\fR tape or if the label specified is on an active tape\&. The \fB\-f\fR (force) flag bypasses these verifications\&.
-
+\fBAmlabel\fR
+will not write the label if the tape contains an active
+\fIAmanda\fR
+tape or if the label specified is on an active tape\&. The
+\fB\-f\fR
+(force) flag bypasses these verifications\&.
 .PP
-An optional \fBslot\fR may be specified after the tape label\&. If a tape changer is in use, \fBamlabel\fR will label the tape in the specified slot instead of the currently loaded tape\&.
-
+An optional
+\fIslot\fR
+may be specified after the tape label\&. If a tape changer is in use,
+\fBamlabel\fR
+will label the tape in the specified slot instead of the currently loaded tape\&.
 .PP
-See the \fBamanda\fR(8) man page for more details about \fBAMANDA\fR\&.
-
+See the
+\fBamanda\fR(8)
+man page for more details about
+\fIAmanda\fR\&.
+.SH "OPTIONS"
+.PP
+\fB\-o\fR \fIconfigoption\fR
+.RS 4
+See the "\fBCONFIGURATION OVERRIDE\fR" section in
+\fBamanda\fR(8)\&.
+.RE
 .SH "EXAMPLE"
-
 .PP
-Write an \fBAMANDA\fR label with the string ``\fBDMP000\fR'' on the tape loaded in the device named in the \fBtapedev\fR option in /usr/local/etc/amanda/daily/amanda\&.conf:
+Write an
+\fIAmanda\fR
+label with the string "DMP000" on the tape loaded in the device named in the
+\fBtapedev\fR
+option in /usr/local/etc/amanda/daily/amanda\&.conf:
 .nf
-
 % amlabel daily DMP000 
 .fi
-
 .PP
-Label the tape in slot 3 of the currently configured tape changer with the string ``\fBDMP003\fR'':
+Label the tape in slot 3 of the currently configured tape changer with the string "DMP003":
 .nf
-
 % amlabel daily DMP003 slot 3 
 .fi
-
 .SH "MESSAGES"
-
-.TP
-label \fBlabel\fR doesn't match labelstr \fBstr\fR
-Label \fBlabel\fR on the command line does not match the \fBlabelstr\fR regular expression \fBstr\fR from \fBamanda\&.conf\fR\&.
-
-.TP
-label \fBlabel\fR already on a tape
-Label \fBlabel\fR is already listed as an active \fBAMANDA\fR tape\&.
-
-.TP
-no tpchanger specified in \fBpath\fR , so slot command invalid
-The command line has the \fBslot\fR parameter but the \fBamanda\&.conf\fR file in \fBpath\fR does not have a tape changer configured\&.
-
-.TP
-reading label \fBlabel\fR, tape is in another amanda configuration
-This tape appears to be a valid \fBAMANDA\fR tape, but label does not match \fBlabelstr\fR for this configuration so it is probably part of a different \fBAMANDA\fR configuration\&.
-
-.TP
-reading label \fBlabel\fR, tape is active
-Tape \fBlabel\fR appears to already be part of this \fBAMANDA\fR configuration and active, i\&.e\&. has valid data on it\&.
-
-.TP
-no label found, are you sure \fBtape\fR is non\-rewinding?
-While checking that the label was written correctly, \fBamlabel\fR got an error that might be caused by mis\-configuring \fBAMANDA\fR with a rewinding tape device name instead of a non\-rewinding device name for \fBtape\&.\fR
-
-.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
-
+.PP
+label \fIlabel\fR doesn\'t match labelstr \fIstr\fR
+.RS 4
+Label
+\fIlabel\fR
+on the command line does not match the
+\fIlabelstr\fR
+regular expression
+\fIstr\fR
+from
+\fIamanda\&.conf\fR\&.
+.RE
+.PP
+label \fIlabel\fR already on a tape
+.RS 4
+Label
+\fIlabel\fR
+is already listed as an active
+\fIAmanda\fR
+tape\&.
+.RE
+.PP
+no tpchanger specified in \fIpath\fR , so slot command invalid
+.RS 4
+The command line has the
+\fBslot\fR
+parameter but the
+\fIamanda\&.conf\fR
+file in
+\fIpath\fR
+does not have a tape changer configured\&.
+.RE
+.PP
+reading label \fIlabel\fR, tape is in another amanda configuration
+.RS 4
+This tape appears to be a valid
+\fIAmanda\fR
+tape, but label does not match
+\fBlabelstr\fR
+for this configuration so it is probably part of a different
+\fIAmanda\fR
+configuration\&.
+.RE
+.PP
+reading label \fIlabel\fR, tape is active
+.RS 4
+Tape
+\fIlabel\fR
+appears to already be part of this
+\fIAmanda\fR
+configuration and active, i\&.e\&. has valid data on it\&.
+.RE
+.PP
+no label found, are you sure \fItape\fR is non\-rewinding?
+.RS 4
+While checking that the label was written correctly,
+\fBamlabel\fR
+got an error that might be caused by mis\-configuring
+\fIAmanda\fR
+with a rewinding tape device name instead of a non\-rewinding device name for
+\fItape\&.\fR
+.RE
 .SH "SEE ALSO"
-
 .PP
-\fBamanda\fR(8)  \fBamdump\fR(8)  \fBamflush\fR(8)
-
+\fBamanda\fR(8),
+\fBamdump\fR(8),
+\fBamflush\fR(8),
+: http://wiki.zmanda.com
+.SH "Authors"
+.PP
+\fBJames da Silva\fR <\&jds@amanda\&.org\&>
+.PP
+\fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>