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

   1 .\"     Title: amtape
   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 "AMTAPE" "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 amtape \- user interface to \fIAmanda\fR tape changer controls
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBamtape\fR\ 'u
 174 \fBamtape\fR \fIconfig\fR \fIcommand\fR [\fIcommand_options\fR...] [\fB\-o\ \fR\fIconfigoption\fR]...
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 \fBAmtape\fR
 179 performs tape changer control operations\&. It uses the underlying tape changer script defined by the
 180 \fBtpchanger\fR
 181 option for a particular
 182 \fIAmanda\fR
 183 configuration as specified by the
 184 \fIconfig\fR
 185 argument\&.
 186 .PP
 187 Tape changers maintain a notion of the
 188 \fIcurrent\fR
 189 and
 190 \fInext\fR
 191 slot for each configuration\&. These may or may not correspond to an actual physical state of the device, but do tend to minimize searching through the tape storage slots\&. If the desired tape is in the current slot, it is likely the next tape needed is in the next slot rather than at some random position in the storage slots\&.
 192 .PP
 193 See the
 194 \fBamanda\fR(8)
 195 man page for more details about
 196 \fIAmanda\fR\&.
 197 .SH "COMMANDS"
 198 .PP
 199 \fBreset\fR
 200 .RS 4
 201 Reset the tape changer to a known state\&. The
 202 \fIcurrent\fR
 203 slot is set to the
 204 \fIfirst\fR
 205 slot\&. Other device\-specific side effects may occur\&. Some gravity stackers need to be reset to the top position by hand\&. This command notifies
 206 \fIAmanda\fR
 207 the stacker is back in that position\&.
 208 .RE
 209 .PP
 210 \fBeject\fR
 211 .RS 4
 212 If a tape is loaded in the drive, it is ejected and returned to the slot from which it was loaded\&.
 213 .RE
 214 .PP
 215 \fBclean\fR
 216 .RS 4
 217 If a cleaning tape is defined for the changer, it is used to clean the drive\&.
 218 .RE
 219 .PP
 220 \fBshow\fR
 221 .RS 4
 222 Show the contents of all slots\&. This can be slow\&.
 223 .RE
 224 .PP
 225 \fBlabel\fR \fIlabel\fR
 226 .RS 4
 227 Search for and load the
 228 \fIAmanda\fR
 229 tape with label
 230 \fIlabel\fR\&.
 231 .RE
 232 .PP
 233 \fBtaper\fR
 234 .RS 4
 235 Perform the
 236 \fBtaper\fR
 237 scan algorithm\&. Load the next tape in the configuration\'s tape sequence, or a fresh tape with a suitable label\&.
 238 .RE
 239 .PP
 240 \fBdevice\fR
 241 .RS 4
 242 Display the name of the current tape device on
 243 \fIstdout\fR\&.
 244 .RE
 245 .PP
 246 \fBcurrent\fR
 247 .RS 4
 248 Display the current slot\&.
 249 .RE
 250 .PP
 251 \fBupdate\fR
 252 .RS 4
 253 Update the changer label database, if it has one, to match the tapes now available\&.
 254 .RE
 255 .PP
 256 \fBslot\fR \fIslot\fR
 257 .RS 4
 258 Eject any tape in the drive and put it away, then load the tape from slot
 259 \fIslot\fR
 260 and reset
 261 \fIcurrent\fR\&.
 262 .RE
 263 .PP
 264 \fBslot current\fR
 265 .RS 4
 266 Eject any tape in the drive and put it away, then load the tape from the current slot\&.
 267 .RE
 268 .PP
 269 \fBslot next\fR
 270 .RS 4
 271 Eject any tape in the drive and put it away, then load the tape from the next slot and reset
 272 \fIcurrent\fR\&.
 273 .RE
 274 .PP
 275 \fBslot first\fR
 276 .RS 4
 277 Eject any tape in the drive and put it away, then load the tape from the first slot and reset
 278 \fIcurrent\fR\&.
 279 .RE
 280 .PP
 281 \fBslot advance\fR
 282 .RS 4
 283 Synonym for
 284 \fBslot next\fR\&.
 285 .RE
 286 .PP
 287 \fB\-o\fR \fIconfigoption\fR
 288 .RS 4
 289 See the "\fBCONFIGURATION OVERRIDE\fR" section in
 290 \fBamanda\fR(8)\&.
 291 .RE
 292 .PP
 293 This is useful with non\-gravity stackers to unload the last tape used and set up
 294 \fIAmanda\fR
 295 for the next run\&. If you just use
 296 \fBeject\fR, the current tape will be mounted again in the next run, where it will be rejected as being still in use, ejected and the next tape requested\&. Using
 297 \fBslot next\fR
 298 followed by
 299 \fBeject\fR
 300 does an unnecessary mount\&.
 301 .PP
 302 Note: most changers optimize the
 303 \fBslot\fR
 304 commands to not eject the loaded tape if it is the one being requested\&.
 305 .SH "SEE ALSO"
 306 .PP
 307 \fBamanda\fR(8),
 308 : http://wiki.zmanda.com
 309 .SH "Authors"
 310 .PP
 311 \fBJames da Silva\fR <\&jds@amanda\&.org\&>
 312 .PP
 313 \fBStefan G\&. Weichinger\fR <\&sgw@amanda\&.org\&>