X-Git-Url: https://git.gag.com/?a=blobdiff_plain;f=man%2Famlabel.8;h=d35fa6ea022df35d4edd371b7be916856a87a84b;hb=HEAD;hp=918f2707520cd18c2c43da8fcfc206a56240e1e2;hpb=afaa71b3866b46b082b6c895772e15b36d8865fe;p=debian%2Famanda diff --git a/man/amlabel.8 b/man/amlabel.8 index 918f270..d35fa6e 100644 --- a/man/amlabel.8 +++ b/man/amlabel.8 @@ -1,161 +1,22 @@ +'\" t .\" Title: amlabel .\" Author: James da Silva -.\" Generator: DocBook XSL Stylesheets v1.74.0 -.\" Date: 01/22/2009 +.\" Generator: DocBook XSL Stylesheets v1.76.1 +.\" Date: 01/10/2013 .\" Manual: System Administration Commands -.\" Source: Amanda 2.6.1 +.\" Source: Amanda 3.3.3 .\" Language: English .\" -.TH "AMLABEL" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands" +.TH "AMLABEL" "8" "01/10/2013" "Amanda 3\&.3\&.3" "System Administration Commands" .\" ----------------------------------------------------------------- -.\" * (re)Define some macros +.\" * Define some portability stuff .\" ----------------------------------------------------------------- .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.\" toupper - uppercase a string (locale-aware) +.\" http://bugs.debian.org/507673 +.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ -.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 -.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 -.\} -.. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' .\" ----------------------------------------------------------------- .\" * set default formatting .\" ----------------------------------------------------------------- @@ -166,158 +27,148 @@ .\" ----------------------------------------------------------------- .\" * MAIN CONTENT STARTS HERE * .\" ----------------------------------------------------------------- -.SH "Name" -amlabel \- label an \fIAmanda\fR tape -.SH "Synopsis" -.fam C +.SH "NAME" +amlabel \- label an Amanda tape +.SH "SYNOPSIS" .HP \w'\fBamlabel\fR\ 'u -\fBamlabel\fR [\-f] \fIconfig\fR \fIlabel\fR [slot\ \fIslot\fR] [\-o\ \fIconfigoption\fR]... -.fam +\fBamlabel\fR [\fB\-\-barcode\ \fR\fB\fIbarcode\fR\fR] [\fB\-\-meta\ \fR\fB\fImeta\-label\fR\fR] [\fB\-\-assign\fR] [\fB\-f\fR] [\fB\-\-version\fR] [\fB\-o\fR\ \fIconfigoption\fR...] \fIconfig\fR [\fIlabel\fR] [slot\ \fIslot\fR] .SH "DESCRIPTION" .PP -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\&. +This command applies a label to an Amanda volume, erasing the volume in the process\&. .PP -\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\&. +Amanda uses labels to identify volumes: +\fBamdump\fR(8) +and +\fBamflush\fR(8) +verify the label before writing to make sure the proper volume is loaded, and the recovery programs use the label to ensure they are reading the data they expect\&. +.PP +If no +[\fIslot\fR] +and no +[\fIbarcode\fR] +is given, then +\fBamlabel\fR +labels the tape in the current slot of the default changer\&. If a slot is given, it labels the volume in that slot\&. If a barcode is given, it labels the volume with that barcode\&. \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\&. +(see +\fBamanda.conf\fR(5))\&. +.PP +If +[\fIlabel\fR] +is not given, an autolabel is generated, see +\fBautolabel\fR +in +\fBamanda.conf\fR(5)\&. +.PP +If +[\fB\-\-assign\fR] +is given, the barcode and meta\-label are assigned to the label without labeling the volume\&. The label must already be in the tapelist file\&. .PP -\fBAmlabel\fR -appends the new tape to the +This command also appends the new volume 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\&. +file, so that they will be used in the order they are labeled (depending on the taperscan in use \(em see +\fBamanda-taperscan\fR(7))\&. .PP -\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 +As a precaution, +\fBamlabel\fR +will not write a label if the volume already contains an active label or if the label specified is on an active tape\&. The +[\-f] (force) flag bypasses these verifications\&. +.SH "OPTIONS" .PP -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\&. +\fB\-\-barcode \fR\fB\fIbarcode\fR\fR +.RS 4 +With +[\-\-assign], assign the barcode to the label\&. Without +[\-\-assign], label the volume with that barcode\&. +.RE .PP -See the -\fBamanda\fR(8) -man page for more details about -\fIAmanda\fR\&. -.SH "OPTIONS" +\fB\-\-meta \fR\fB\fImeta\-label\fR\fR +.RS 4 +Assign the meta label to the label after labeling the volume\&. +.RE +.PP +\fB\-\-assign\fR +.RS 4 +Assign the barcode or meta\-label to the label without labeling the volume\&. The label must already be in the tapelist file\&. +.RE +.PP +\fB\-f\fR +.RS 4 +Force the label operation; see above +.RE +.PP +\fB\-\-version\fR +.RS 4 +Output version information +.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 .SH "EXAMPLE" .PP -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: +Write an Amanda label with the string "DMP000" on the current volume: .nf % amlabel daily DMP000 .fi .PP -Label the tape in slot 3 of the currently configured tape changer with the string "DMP003": +Label the tape in slot 3 of the changer with the label "DMP003": .nf % amlabel daily DMP003 slot 3 .fi .SH "MESSAGES" .PP -label \fIlabel\fR doesn\'t match labelstr \fIstr\fR +Label \*(Aq\fIlabel\fR\*(Aq doesn\*(Aqt match labelstr \*(Aq\fIlabelstr\fR\*(Aq .RS 4 -Label -\fIlabel\fR -on the command line does not match the -\fIlabelstr\fR -regular expression -\fIstr\fR -from -\fIamanda\&.conf\fR\&. +The given label does not match the configured labelstr\&. Even with +\fB\-f\fR, this is an error\&. .RE .PP -label \fIlabel\fR already on a tape +Label \*(Aq\fIlabel\fR\*(Aq already on a volume .RS 4 -Label -\fIlabel\fR -is already listed as an active -\fIAmanda\fR -tape\&. +The given label is already on another volume in the tapelist, and Amanda will not write it to this volume unless forced\&. .RE .PP -no tpchanger specified in \fIpath\fR , so slot command invalid +Found label \*(Aq\fIlabel\fR\*(Aq, but it is not from configuration \fIconfig\fR\&. .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\&. +The label +\fBamlabel\fR +found on the volume does not match this configuration\*(Aqs +\fBlabelstr\fR, so it is probably part of a different Amanda configuration\&. Amanda will not overwrite the label unless it is forced\&. .RE .PP -reading label \fIlabel\fR, tape is active +Volume with label \*(Aq\fIlabel\fR\*(Aq contains data from this configuration\&. .RS 4 -Tape -\fIlabel\fR -appears to already be part of this -\fIAmanda\fR -configuration and active, i\&.e\&. has valid data on it\&. +The label +\fBamlabel\fR +found on the volume still has valid data on it and Amanda will not overwrite it unless forced\&. Note that this does not distinguish between active and inactive volumes\&. .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), +\fBamanda.conf\fR(5), +\fBtapelist\fR(5), +\fBamanda-taperscan\fR(7), \fBamdump\fR(8), -\fBamflush\fR(8), -: http://wiki.zmanda.com -.SH "Authors" +\fBamflush\fR(8) +.PP +The Amanda Wiki: +: http://wiki.zmanda.com/ +.SH "AUTHORS" .PP \fBJames da Silva\fR <\&jds@amanda\&.org\&> .PP \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&> +.PP +\fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&> +.RS 4 +Zmanda, Inc\&. (http://www\&.zmanda\&.com) +.RE