Imported Upstream version 2.4.5
[debian/amanda] / man / amlabel.8
1 .\"Generated by db2man.xsl. Don't modify this, modify the source.
2 .de Sh \" Subsection
3 .br
4 .if t .Sp
5 .ne 5
6 .PP
7 \fB\\$1\fR
8 .PP
9 ..
10 .de Sp \" Vertical space (when we can't use .PP)
11 .if t .sp .5v
12 .if n .sp
13 ..
14 .de Ip \" List item
15 .br
16 .ie \\n(.$>=3 .ne \\$3
17 .el .ne 3
18 .IP "\\$1" \\$2
19 ..
20 .TH "AMLABEL" 8 "" "" ""
21 .SH NAME
22 amlabel \- label an AMANDA tape
23 .SH "SYNOPSIS"
24 .ad l
25 .hy 0
26 .HP 8
27 \fBamlabel\fR [\-f] \fIconfig\fR \fIlabel\fR [\fIslot\fR\ \fIslot\fR]
28 .ad
29 .hy
30
31 .SH "DESCRIPTION"
32
33 .PP
34 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\&.
35
36 .PP
37 \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\&.
38
39 .PP
40 \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\&.
41
42 .PP
43 \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\&.
44
45 .PP
46 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\&.
47
48 .PP
49 See the \fBamanda\fR(8) man page for more details about \fBAMANDA\fR\&.
50
51 .SH "EXAMPLE"
52
53 .PP
54 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:
55 .nf
56
57 % amlabel daily DMP000 
58 .fi
59
60 .PP
61 Label the tape in slot 3 of the currently configured tape changer with the string ``\fBDMP003\fR'':
62 .nf
63
64 % amlabel daily DMP003 slot 3 
65 .fi
66
67 .SH "MESSAGES"
68
69 .TP
70 label \fBlabel\fR doesn't match labelstr \fBstr\fR
71 Label \fBlabel\fR on the command line does not match the \fBlabelstr\fR regular expression \fBstr\fR from \fBamanda\&.conf\fR\&.
72
73 .TP
74 label \fBlabel\fR already on a tape
75 Label \fBlabel\fR is already listed as an active \fBAMANDA\fR tape\&.
76
77 .TP
78 no tpchanger specified in \fBpath\fR , so slot command invalid
79 The command line has the \fBslot\fR parameter but the \fBamanda\&.conf\fR file in \fBpath\fR does not have a tape changer configured\&.
80
81 .TP
82 reading label \fBlabel\fR, tape is in another amanda configuration
83 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\&.
84
85 .TP
86 reading label \fBlabel\fR, tape is active
87 Tape \fBlabel\fR appears to already be part of this \fBAMANDA\fR configuration and active, i\&.e\&. has valid data on it\&.
88
89 .TP
90 no label found, are you sure \fBtape\fR is non\-rewinding?
91 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
92
93 .SH "AUTHOR"
94
95 .PP
96 James da Silva, <jds@amanda\&.org>: Original text
97
98 .PP
99 Stefan G\&. Weichinger, <sgw@amanda\&.org>, maintainer of the \fBAMANDA\fR\-documentation: XML\-conversion
100
101 .SH "SEE ALSO"
102
103 .PP
104 \fBamanda\fR(8)  \fBamdump\fR(8)  \fBamflush\fR(8)
105