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

   1 .\"     Title: amtapetype
   2 .\"    Author: Dustin J. Mitchell <dustin@zmanda.com>
   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 "AMTAPETYPE" "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 amtapetype \- generate a tapetype definition by testing the device directly
 171 .SH "Synopsis"
 172 .fam C
 173 .HP \w'\fBamtapetype\fR\ 'u
 174 \fBamtapetype\fR [\-h] [\-c] [\-f] [\-b\ \fIblocksize\fR] [\-t\ \fItypename\fR] [\-l\ \fIlabel\fR] [\-o\ \fIconfig_overwrite\fR] [\fIdevice\fR]
 175 .fam
 176 .SH "DESCRIPTION"
 177 .PP
 178 \fBamtapetype\fR
 179 generates a tapetype entry for
 180 \fIAmanda\fR
 181 by testing the device directly
 182 .SH "OPTIONS"
 183 .if n \{\
 184 .sp
 185 .\}
 186 .RS 4
 187 .BM yellow
 188 .it 1 an-trap
 189 .nr an-no-space-flag 1
 190 .nr an-break-flag 1
 191 .br
 192 .ps +1
 193 \fBNote\fR
 194 .ps -1
 195 .br
 196 .PP
 197 The options for
 198 \fBamtapetype\fR
 199 have changed in version 2\&.6\&.1
 200 .sp .5v
 201 .EM yellow
 202 .RE
 203 .PP
 204 \fB\-h\fR
 205 .RS 4
 206 Display the help message\&.
 207 .RE
 208 .PP
 209 \fB\-c\fR
 210 .RS 4
 211 Run only the hardware compression detection heuristic test and stop\&. This takes a few minutes only\&.
 212 .RE
 213 .PP
 214 \fB\-f\fR
 215 .RS 4
 216 Run amtapetype even if the loaded volume is already in use or compression is enabled\&.
 217 .RE
 218 .PP
 219 \fB\-b\fR\fI blocksize\fR
 220 .RS 4
 221 block size to use with the device (default: 32k)
 222 .RE
 223 .PP
 224 \fB\-t\fR \fItypename\fR
 225 .RS 4
 226 Name to give to the new tapetype definition\&.
 227 .RE
 228 .PP
 229 \fB\-l\fR\fI label\fR
 230 .RS 4
 231 Label to write on the tape (default is randomly generated)\&.
 232 .RE
 233 .PP
 234 \fB\-o\fR \fIconfigoption\fR
 235 .RS 4
 236 See the "\fBCONFIGURATION OVERRIDE\fR" section in
 237 \fBamanda\fR(8)\&.
 238 .RE
 239 .SH "EXAMPLE"
 240 .PP
 241 Generate a tapetype definition for your tape device:
 242 .sp
 243 .if n \{\
 244 .RS 4
 245 .\}
 246 .fam C
 247 .ps -1
 248 .nf
 249 .if t \{\
 250 .sp -1
 251 .\}
 252 .BB lightgray adjust-for-leading-newline
 253 .sp -1
 254
 255 % amtapetype \-f /dev/nst0
 256 .EB lightgray adjust-for-leading-newline
 257 .if t \{\
 258 .sp 1
 259 .\}
 260 .fi
 261 .fam
 262 .ps +1
 263 .if n \{\
 264 .RE
 265 .\}
 266 .SH "NOTES"
 267 .PP
 268 If the device cannot reliably report its comprssion status (and as of this writing, no devices can do so), hardware compression is detected by measuring the writing speed difference of the tape drive when writing an amount of compressable and uncompresseable data\&. If your tape drive has very large buffers or is very fast, the program could fail to detect hardware compression status reliably\&.
 269 .PP
 270 Volume capacity is determined by writing one large file until an error, interpereted as end\-of\-tape, is encountered\&. In the next phase, about 100 files are written to fill the tape\&. This second phase will write less data, because each filemark consumes some tape\&. With a little arithmetic,
 271 \fBamtapetype\fR
 272 calculates the size of these filemarks\&.
 273 .PP
 274 All sorts of things might happen to cause the amount of data written to vary enough to generate a strange file mark size guess\&. A little more "shoe shining" because of the additional file marks (and flushes), dirt left on the heads from the first pass of a brand new tape, the temperature/humidity changed during the multi\-hour run, a different amount of data was written after the last file mark before EOT was reported, etc\&.
 275 .PP
 276 Note that the file mark size might really be zero for whatever device this is, and it was just the measured capacity variation that caused
 277 \fBamtapetype\fR
 278 to think those extra file marks in pass 2 actually took up space\&.
 279 .SH "Authors"
 280 .PP
 281 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
 282 .RS 4
 283 Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])
 284 .RE
 285 .PP
 286 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
 287 .RS 4
 288 Zmanda, Inc\&. (\FChttp://www\&.zmanda\&.com\F[])
 289 .RE