Imported Upstream version 2.5.2p1
[debian/amanda] / man / amlabel.8
1 .\"     Title: amlabel
2 .\"    Author: 
3 .\" Generator: DocBook XSL Stylesheets v1.72.0 <http://docbook.sf.net/>
4 .\"      Date: 06/06/2007
5 .\"    Manual: 
6 .\"    Source: 
7 .\"
8 .TH "AMLABEL" "8" "06/06/2007" "" ""
9 .\" disable hyphenation
10 .nh
11 .\" disable justification (adjust text to left margin only)
12 .ad l
13 .SH "NAME"
14 amlabel \- label an Amanda tape
15 .SH "SYNOPSIS"
16 .HP 8
17 \fBamlabel\fR [\-f] \fIconfig\fR \fIlabel\fR [slot\ \fIslot\fR] [\-o\ \fIconfigoption\fR]...
18 .SH "DESCRIPTION"
19 .PP
20 All
21 \fIAmanda\fR
22 tapes must be pre\-labeled before they are used.
23 \fIAmanda\fR
24 verifies the label in
25 \fBamdump\fR
26 and
27 \fBamflush\fR
28 before writing to make sure the proper tape is loaded.
29 .PP
30 \fBAmlabel\fR
31 writes an
32 \fIAmanda\fR
33 label on the tape in the device specified by the
34 \fIamanda.conf\fR
35 file in /usr/local/etc/amanda/\fIconfig\fR.
36 \fILabel\fR
37 may be any string that does not contain whitespace and that matches the
38 \fIamanda.conf\fR
39 \fBlabelstr\fR
40 regular expression option. It is up to the system administrator to define a naming convention.
41 .PP
42 \fBAmlabel\fR
43 appends the new tape to the
44 \fItapelist\fR
45 file so it will be used by
46 \fIAmanda\fR
47 before it reuses any other tapes. When you
48 \fBamlabel\fR
49 multiple tapes, they will be used in the order you
50 \fBamlabel\fR
51 them.
52 .PP
53 \fBAmlabel\fR
54 will not write the label if the tape contains an active
55 \fIAmanda\fR
56 tape or if the label specified is on an active tape. The
57 \fB\-f\fR
58 (force) flag bypasses these verifications.
59 .PP
60 An optional
61 \fIslot\fR
62 may be specified after the tape label. If a tape changer is in use,
63 \fBamlabel\fR
64 will label the tape in the specified slot instead of the currently loaded tape.
65 .PP
66 See the
67 \fBamanda\fR(8)
68 man page for more details about
69 \fIAmanda\fR.
70 .SH "OPTIONS"
71 .PP
72 \fB\-o\fR \fIconfigoption\fR
73 .RS 4
74 See the "\fBCONFIGURATION OVERRIDE\fR" section in
75 \fBamanda\fR(8).
76 .RE
77 .SH "EXAMPLE"
78 .PP
79 Write an
80 \fIAmanda\fR
81 label with the string "DMP000" on the tape loaded in the device named in the
82 \fBtapedev\fR
83 option in /usr/local/etc/amanda/daily/amanda.conf:
84 .sp
85 .RS 4
86 .nf
87 % amlabel daily DMP000 
88 .fi
89 .RE
90 .PP
91 Label the tape in slot 3 of the currently configured tape changer with the string "DMP003":
92 .sp
93 .RS 4
94 .nf
95 % amlabel daily DMP003 slot 3 
96 .fi
97 .RE
98 .SH "MESSAGES"
99 .PP
100 label \fIlabel\fR doesn't match labelstr \fIstr\fR
101 .RS 4
102 Label
103 \fIlabel\fR
104 on the command line does not match the
105 \fIlabelstr\fR
106 regular expression
107 \fIstr\fR
108 from
109 \fIamanda.conf\fR.
110 .RE
111 .PP
112 label \fIlabel\fR already on a tape
113 .RS 4
114 Label
115 \fIlabel\fR
116 is already listed as an active
117 \fIAmanda\fR
118 tape.
119 .RE
120 .PP
121 no tpchanger specified in \fIpath\fR , so slot command invalid
122 .RS 4
123 The command line has the
124 \fBslot\fR
125 parameter but the
126 \fIamanda.conf\fR
127 file in
128 \fIpath\fR
129 does not have a tape changer configured.
130 .RE
131 .PP
132 reading label \fIlabel\fR, tape is in another amanda configuration
133 .RS 4
134 This tape appears to be a valid
135 \fIAmanda\fR
136 tape, but label does not match
137 \fBlabelstr\fR
138 for this configuration so it is probably part of a different
139 \fIAmanda\fR
140 configuration.
141 .RE
142 .PP
143 reading label \fIlabel\fR, tape is active
144 .RS 4
145 Tape
146 \fIlabel\fR
147 appears to already be part of this
148 \fIAmanda\fR
149 configuration and active, i.e. has valid data on it.
150 .RE
151 .PP
152 no label found, are you sure \fItape\fR is non\-rewinding?
153 .RS 4
154 While checking that the label was written correctly,
155 \fBamlabel\fR
156 got an error that might be caused by mis\-configuring
157 \fIAmanda\fR
158 with a rewinding tape device name instead of a non\-rewinding device name for
159 \fItape.\fR
160 .RE
161 .SH "AUTHOR"
162 .PP
163 James da Silva,
164 <jds@amanda.org>: Original text
165 .PP
166 Stefan G. Weichinger,
167 <sgw@amanda.org>, maintainer of the
168 \fIAmanda\fR\-documentation: XML\-conversion
169 .SH "SEE ALSO"
170 .PP
171 \fBamanda\fR(8)
172 \fBamdump\fR(8)
173 \fBamflush\fR(8)