git.gag.com Git - debian/amanda/blob - man/amlabel.8

   1 .\"     Title: amlabel
   2 .\"    Author: James da Silva <jds@amanda.org>
   3 .\" Generator: DocBook XSL Stylesheets v1.74.0 <http://docbook.sf.net/>
   4 .\"      Date: 01/22/2009
   5 .\"    Manual: System Administration Commands
   6 .\"    Source: Amanda 2.6.1
   7 .\"  Language: English
   8 .\"
   9 .TH "AMLABEL" "8" "01/22/2009" "Amanda 2\&.6\&.1" "System Administration Commands"
  10 .\" -----------------------------------------------------------------
  11 .\" * (re)Define some macros
  12 .\" -----------------------------------------------------------------
  13 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  14 .\" toupper - uppercase a string (locale-aware)
  15 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  16 .de toupper
  17 .tr aAbBcCdDeEfFgGhHiIjJkKlLmMnNoOpPqQrRsStTuUvVwWxXyYzZ
  18 \\$*
  19 .tr aabbccddeeffgghhiijjkkllmmnnooppqqrrssttuuvvwwxxyyzz
  20 ..
  21 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  22 .\" SH-xref - format a cross-reference to an SH section
  23 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  24 .de SH-xref
  25 .ie n \{\
  26 .\}
  27 .toupper \\$*
  28 .el \{\
  29 \\$*
  30 .\}
  31 ..
  32 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  33 .\" SH - level-one heading that works better for non-TTY output
  34 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  35 .de1 SH
  36 .\" put an extra blank line of space above the head in non-TTY output
  37 .if t \{\
  38 .sp 1
  39 .\}
  40 .sp \\n[PD]u
  41 .nr an-level 1
  42 .set-an-margin
  43 .nr an-prevailing-indent \\n[IN]
  44 .fi
  45 .in \\n[an-margin]u
  46 .ti 0
  47 .HTML-TAG ".NH \\n[an-level]"
  48 .it 1 an-trap
  49 .nr an-no-space-flag 1
  50 .nr an-break-flag 1
  51 \." make the size of the head bigger
  52 .ps +3
  53 .ft B
  54 .ne (2v + 1u)
  55 .ie n \{\
  56 .\" if n (TTY output), use uppercase
  57 .toupper \\$*
  58 .\}
  59 .el \{\
  60 .nr an-break-flag 0
  61 .\" if not n (not TTY), use normal case (not uppercase)
  62 \\$1
  63 .in \\n[an-margin]u
  64 .ti 0
  65 .\" if not n (not TTY), put a border/line under subheading
  66 .sp -.6
  67 \l'\n(.lu'
  68 .\}
  69 ..
  70 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  71 .\" SS - level-two heading that works better for non-TTY output
  72 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  73 .de1 SS
  74 .sp \\n[PD]u
  75 .nr an-level 1
  76 .set-an-margin
  77 .nr an-prevailing-indent \\n[IN]
  78 .fi
  79 .in \\n[IN]u
  80 .ti \\n[SN]u
  81 .it 1 an-trap
  82 .nr an-no-space-flag 1
  83 .nr an-break-flag 1
  84 .ps \\n[PS-SS]u
  85 \." make the size of the head bigger
  86 .ps +2
  87 .ft B
  88 .ne (2v + 1u)
  89 .if \\n[.$] \&\\$*
  90 ..
  91 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  92 .\" BB/BE - put background/screen (filled box) around block of text
  93 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
  94 .de BB
  95 .if t \{\
  96 .sp -.5
  97 .br
  98 .in +2n
  99 .ll -2n
 100 .gcolor red
 101 .di BX
 102 .\}
 103 ..
 104 .de EB
 105 .if t \{\
 106 .if "\\$2"adjust-for-leading-newline" \{\
 107 .sp -1
 108 .\}
 109 .br
 110 .di
 111 .in
 112 .ll
 113 .gcolor
 114 .nr BW \\n(.lu-\\n(.i
 115 .nr BH \\n(dn+.5v
 116 .ne \\n(BHu+.5v
 117 .ie "\\$2"adjust-for-leading-newline" \{\
 118 \M[\\$1]\h'1n'\v'+.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 119 .\}
 120 .el \{\
 121 \M[\\$1]\h'1n'\v'-.5v'\D'P \\n(BWu 0 0 \\n(BHu -\\n(BWu 0 0 -\\n(BHu'\M[]
 122 .\}
 123 .in 0
 124 .sp -.5v
 125 .nf
 126 .BX
 127 .in
 128 .sp .5v
 129 .fi
 130 .\}
 131 ..
 132 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 133 .\" BM/EM - put colored marker in margin next to block of text
 134 .\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
 135 .de BM
 136 .if t \{\
 137 .br
 138 .ll -2n
 139 .gcolor red
 140 .di BX
 141 .\}
 142 ..
 143 .de EM
 144 .if t \{\
 145 .br
 146 .di
 147 .ll
 148 .gcolor
 149 .nr BH \\n(dn
 150 .ne \\n(BHu
 151 \M[\\$1]\D'P -.75n 0 0 \\n(BHu -(\\n[.i]u - \\n(INu - .75n) 0 0 -\\n(BHu'\M[]
 152 .in 0
 153 .nf
 154 .BX
 155 .in
 156 .fi
 157 .\}
 158 ..
 159 .\" -----------------------------------------------------------------
 160 .\" * set default formatting
 161 .\" -----------------------------------------------------------------
 162 .\" disable hyphenation
 163 .nh
 164 .\" disable justification (adjust text to left margin only)
 165 .ad l
 166 .\" -----------------------------------------------------------------
 167 .\" * MAIN CONTENT STARTS HERE *
 168 .\" -----------------------------------------------------------------
 169 .SH "Name"
 170 amlabel \- label an \fIAmanda\fR tape
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBamlabel\fR\ 'u
 174 \fBamlabel\fR [\-f] \fIconfig\fR \fIlabel\fR [slot\ \fIslot\fR] [\-o\ \fIconfigoption\fR]...
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 All
 179 \fIAmanda\fR
 180 tapes must be pre\-labeled before they are used\&.
 181 \fIAmanda\fR
 182 verifies the label in
 183 \fBamdump\fR
 184 and
 185 \fBamflush\fR
 186 before writing to make sure the proper tape is loaded\&.
 187 .PP
 188 \fBAmlabel\fR
 189 writes an
 190 \fIAmanda\fR
 191 label on the tape in the device specified by the
 192 \fIamanda\&.conf\fR
 193 file in /usr/local/etc/amanda/\fIconfig\fR\&.
 194 \fILabel\fR
 195 may be any string that does not contain whitespace and that matches the
 196 \fIamanda\&.conf\fR
 197 \fBlabelstr\fR
 198 regular expression option\&. It is up to the system administrator to define a naming convention\&.
 199 .PP
 200 \fBAmlabel\fR
 201 appends the new tape to the
 202 \fBtapelist\fR(5)
 203 file so it will be used by
 204 \fIAmanda\fR
 205 before it reuses any other tapes\&. When you
 206 \fBamlabel\fR
 207 multiple tapes, they will be used in the order you
 208 \fBamlabel\fR
 209 them\&.
 210 .PP
 211 \fBAmlabel\fR
 212 will not write the label if the tape contains an active
 213 \fIAmanda\fR
 214 tape or if the label specified is on an active tape\&. The
 215 \fB\-f\fR
 216 (force) flag bypasses these verifications\&.
 217 .PP
 218 An optional
 219 \fIslot\fR
 220 may be specified after the tape label\&. If a tape changer is in use,
 221 \fBamlabel\fR
 222 will label the tape in the specified slot instead of the currently loaded tape\&.
 223 .PP
 224 See the
 225 \fBamanda\fR(8)
 226 man page for more details about
 227 \fIAmanda\fR\&.
 228 .SH "OPTIONS"
 229 .PP
 230 \fB\-o\fR \fIconfigoption\fR
 231 .RS 4
 232 See the "\fBCONFIGURATION OVERRIDE\fR" section in
 233 \fBamanda\fR(8)\&.
 234 .RE
 235 .SH "EXAMPLE"
 236 .PP
 237 Write an
 238 \fIAmanda\fR
 239 label with the string "DMP000" on the tape loaded in the device named in the
 240 \fBtapedev\fR
 241 option in /usr/local/etc/amanda/daily/amanda\&.conf:
 242 .nf
 243 % amlabel daily DMP000
 244 .fi
 245 .PP
 246 Label the tape in slot 3 of the currently configured tape changer with the string "DMP003":
 247 .nf
 248 % amlabel daily DMP003 slot 3
 249 .fi
 250 .SH "MESSAGES"
 251 .PP
 252 label \fIlabel\fR doesn\'t match labelstr \fIstr\fR
 253 .RS 4
 254 Label
 255 \fIlabel\fR
 256 on the command line does not match the
 257 \fIlabelstr\fR
 258 regular expression
 259 \fIstr\fR
 260 from
 261 \fIamanda\&.conf\fR\&.
 262 .RE
 263 .PP
 264 label \fIlabel\fR already on a tape
 265 .RS 4
 266 Label
 267 \fIlabel\fR
 268 is already listed as an active
 269 \fIAmanda\fR
 270 tape\&.
 271 .RE
 272 .PP
 273 no tpchanger specified in \fIpath\fR , so slot command invalid
 274 .RS 4
 275 The command line has the
 276 \fBslot\fR
 277 parameter but the
 278 \fIamanda\&.conf\fR
 279 file in
 280 \fIpath\fR
 281 does not have a tape changer configured\&.
 282 .RE
 283 .PP
 284 reading label \fIlabel\fR, tape is in another amanda configuration
 285 .RS 4
 286 This tape appears to be a valid
 287 \fIAmanda\fR
 288 tape, but label does not match
 289 \fBlabelstr\fR
 290 for this configuration so it is probably part of a different
 291 \fIAmanda\fR
 292 configuration\&.
 293 .RE
 294 .PP
 295 reading label \fIlabel\fR, tape is active
 296 .RS 4
 297 Tape
 298 \fIlabel\fR
 299 appears to already be part of this
 300 \fIAmanda\fR
 301 configuration and active, i\&.e\&. has valid data on it\&.
 302 .RE
 303 .PP
 304 no label found, are you sure \fItape\fR is non\-rewinding?
 305 .RS 4
 306 While checking that the label was written correctly,
 307 \fBamlabel\fR
 308 got an error that might be caused by mis\-configuring
 309 \fIAmanda\fR
 310 with a rewinding tape device name instead of a non\-rewinding device name for
 311 \fItape\&.\fR
 312 .RE
 313 .SH "SEE ALSO"
 314 .PP
 315 \fBamanda\fR(8),
 316 \fBamdump\fR(8),
 317 \fBamflush\fR(8),
 318 : http://wiki.zmanda.com
 319 .SH "Authors"
 320 .PP
 321 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
 322 .PP
 323 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>