Imported Upstream version 2.4.4p3
[debian/amanda] / man / amlabel.8.in
1 .\"
2 .de EX
3 .if t .ft C
4 .nf
5 ..
6 .de EE
7 .fi
8 .if t .ft
9 ..
10 .TH AMLABEL 8
11 .SH NAME
12 amlabel \- label an Amanda tape
13 .SH SYNOPSIS
14 .B amlabel
15 [-f]
16 .I config label
17 [
18 .B slot
19 .I slot
20 ]
21 .SH DESCRIPTION
22 All Amanda tapes must be pre-labeled before they are used.
23 Amanda verifies the label in
24 .B amdump
25 and
26 .B amflush
27 before writing to make sure the proper tape is loaded.
28 .LP
29 .B Amlabel
30 writes an Amanda label on the tape in the device specified by the
31 .I amanda.conf
32 file in @CONFIG_DIR@/\fIconfig\fR.
33 .I Label
34 may be any string that does not contain whitespace and that matches the
35 .I amanda.conf
36 .B labelstr
37 regular expression option.
38 It is up to the system administrator to define a naming convention.
39 .LP
40 .B Amlabel
41 appends the new tape to the
42 .I tapelist
43 file so it will be used by Amanda before it reuses any other
44 tapes.
45 When you
46 .B amlabel
47 multiple tapes, they will be used in the
48 order you
49 .B amlabel
50 them.
51 .LP
52 .B Amlabel
53 will not write the label if the tape contains an active
54 Amanda tape or if the label specified is on an active tape.
55 The
56 .B -f
57 (force) flag bypasses these verifications.
58 .LP
59 An optional
60 .I slot
61 may be specified after the tape label.
62 If a tape changer is in use,
63 .B amlabel
64 will label the tape in the specified slot
65 instead of the currently loaded tape.
66 .LP
67 See the
68 .IR amanda (8)
69 man page for more details about Amanda.
70 .SH EXAMPLE
71 Write an Amanda label with the string "DMP000" on
72 the tape loaded in the device named in the
73 .B tapedev
74 option in @CONFIG_DIR@/@DEFAULT_CONFIG@/amanda.conf:
75 .LP
76 .RS
77 .EX
78 % amlabel @DEFAULT_CONFIG@ DMP000
79 .EE
80 .RE
81 .LP
82 Label the tape in slot 3 of the currently configured tape changer
83 with the string "DMP003":
84 .LP
85 .RS
86 .EX
87 % amlabel @DEFAULT_CONFIG@ DMP003 slot 3
88 .EE
89 .RE
90 .SH MESSAGES
91 .TP
92 label \fIlabel\fR doesn't match labelstr "\fIstr\fR"
93 Label
94 .I label
95 on the command line does not match the
96 .I labelstr
97 regular expression
98 .I str
99 from
100 .IR amanda.conf .
101 .TP
102 label \fIlabel\fR already on a tape
103 Label
104 .I label
105 is already listed as an active Amanda tape.
106 .TP
107 no tpchanger specified in "\fIpath\fR", so slot command invalid
108 The command line has the
109 .B slot
110 parameter but the
111 .I amanda.conf
112 file in
113 .I path
114 does not have a tape changer configured.
115 .TP
116 reading label \fIlabel\fR, tape is in another amanda configuration
117 This tape appears to be a valid Amanda tape,
118 but label does not match
119 .B labelstr
120 for this configuration so it is probably part of a different
121 Amanda configuration.
122 .TP
123 reading label \fIlabel\fR, tape is active
124 Tape
125 .I label
126 appears to already be part of this Amanda configuration
127 and active, i.e. has valid data on it.
128 .TP
129 no label found, are you sure \fItape\fR is non-rewinding?
130 While checking that the label was written correctly,
131 .I amlabel
132 got an error that might be caused by mis-configuring Amanda
133 with a rewinding tape device name
134 instead of a non-rewinding device name for
135 .IR tape.
136 .SH AUTHOR
137 James da Silva <jds@cs.umd.edu>
138 .br
139 University of Maryland, College Park
140 .SH "SEE ALSO"
141 amanda(8)
142 amdump(8)
143 amflush(8)