Imported Upstream version 2.5.1
[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 .HP 8
25 \fBamlabel\fR [-f] \fIconfig\fR \fIlabel\fR [slot \fIslot\fR] [-o \fIconfigoption\fR]*
26
27 .SH "DESCRIPTION"
28 .PP
29 All
30 \fBAmanda\fR
31 tapes must be pre-labeled before they are used.
32 \fBAmanda\fR
33 verifies the label in
34 \fBamdump\fR
35 and
36 \fBamflush\fR
37 before writing to make sure the proper tape is loaded.
38 .PP
39 \fBAmlabel\fR
40 writes an
41 \fBAmanda\fR
42 label on the tape in the device specified by the
43 \fBamanda.conf\fR
44 file in /usr/local/etc/amanda/\fBconfig\fR.
45 \fBLabel\fR
46 may be any string that does not contain whitespace and that matches the
47 \fBamanda.conf\fR\fBlabelstr\fR
48 regular expression option. It is up to the system administrator to define a naming convention.
49 .PP
50 \fBAmlabel\fR
51 appends the new tape to the
52 \fBtapelist\fR
53 file so it will be used by
54 \fBAmanda\fR
55 before it reuses any other tapes. When you
56 \fBamlabel\fR
57 multiple tapes, they will be used in the order you
58 \fBamlabel\fR
59 them.
60 .PP
61 \fBAmlabel\fR
62 will not write the label if the tape contains an active
63 \fBAmanda\fR
64 tape or if the label specified is on an active tape. The
65 \fB-f\fR
66 (force) flag bypasses these verifications.
67 .PP
68 An optional
69 \fBslot\fR
70 may be specified after the tape label. If a tape changer is in use,
71 \fBamlabel\fR
72 will label the tape in the specified slot instead of the currently loaded tape.
73 .PP
74 See the
75 \fBamanda\fR(8)
76 man page for more details about
77 \fBAmanda\fR.
78 .SH "OPTIONS"
79 .TP
80 \fB-o\fR \fIconfigoption\fR
81 See the "\fBCONFIGURATION OVERWRITE\fR" section in
82 \fBamanda\fR(8).
83 .SH "EXAMPLE"
84 .PP
85 Write an
86 \fBAmanda\fR
87 label with the string "DMP000" on the tape loaded in the device named in the
88 \fBtapedev\fR
89 option in /usr/local/etc/amanda/daily/amanda.conf:
90 .nf
91
92 % amlabel daily DMP000 
93 .fi
94 .PP
95 Label the tape in slot 3 of the currently configured tape changer with the string "DMP003":
96 .nf
97
98 % amlabel daily DMP003 slot 3 
99 .fi
100 .SH "MESSAGES"
101 .TP
102 label \fBlabel\fR doesn't match labelstr \fBstr\fR
103 Label
104 \fBlabel\fR
105 on the command line does not match the
106 \fBlabelstr\fR
107 regular expression
108 \fBstr\fR
109 from
110 \fBamanda.conf\fR.
111 .TP
112 label \fBlabel\fR already on a tape
113 Label
114 \fBlabel\fR
115 is already listed as an active
116 \fBAmanda\fR
117 tape.
118 .TP
119 no tpchanger specified in \fBpath\fR , so slot command invalid
120 The command line has the
121 \fBslot\fR
122 parameter but the
123 \fBamanda.conf\fR
124 file in
125 \fBpath\fR
126 does not have a tape changer configured.
127 .TP
128 reading label \fBlabel\fR, tape is in another amanda configuration
129 This tape appears to be a valid
130 \fBAmanda\fR
131 tape, but label does not match
132 \fBlabelstr\fR
133 for this configuration so it is probably part of a different
134 \fBAmanda\fR
135 configuration.
136 .TP
137 reading label \fBlabel\fR, tape is active
138 Tape
139 \fBlabel\fR
140 appears to already be part of this
141 \fBAmanda\fR
142 configuration and active, i.e. has valid data on it.
143 .TP
144 no label found, are you sure \fBtape\fR is non-rewinding?
145 While checking that the label was written correctly,
146 \fBamlabel\fR
147 got an error that might be caused by mis-configuring
148 \fBAmanda\fR
149 with a rewinding tape device name instead of a non-rewinding device name for
150 \fBtape.\fR
151 .SH "AUTHOR"
152 .PP
153 James da Silva,
154 <jds@amanda.org>: Original text
155 .PP
156 Stefan G. Weichinger,
157 <sgw@amanda.org>, maintainer of the
158 \fBAmanda\fR-documentation: XML-conversion
159 .SH "SEE ALSO"
160 .PP
161 \fBamanda\fR(8)\fBamdump\fR(8)\fBamflush\fR(8)
162