2b474f7fb99634eac7f8c5ecbdaa2c77dfc4af5d
[debian/amanda] / man / amtapetype.8
1 '\" t
2 .\"     Title: amtapetype
3 .\"    Author: Dustin J. Mitchell <dustin@zmanda.com>
4 .\" Generator: DocBook XSL Stylesheets vsnapshot_8273 <http://docbook.sf.net/>
5 .\"      Date: 11/05/2009
6 .\"    Manual: System Administration Commands
7 .\"    Source: Amanda 2.6.1p2
8 .\"  Language: English
9 .\"
10 .TH "AMTAPETYPE" "8" "11/05/2009" "Amanda 2\&.6\&.1p2" "System Administration Commands"
11 .\" -----------------------------------------------------------------
12 .\" * set default formatting
13 .\" -----------------------------------------------------------------
14 .\" disable hyphenation
15 .nh
16 .\" disable justification (adjust text to left margin only)
17 .ad l
18 .\" -----------------------------------------------------------------
19 .\" * MAIN CONTENT STARTS HERE *
20 .\" -----------------------------------------------------------------
21 .SH "NAME"
22 amtapetype \- generate a tapetype definition by testing the device directly
23 .SH "SYNOPSIS"
24 .HP \w'\fBamtapetype\fR\ 'u
25 \fBamtapetype\fR [\-h] [\-c] [\-f] [\-p] [\-b\ \fIblocksize\fR] [\-t\ \fItypename\fR] [\-l\ \fIlabel\fR] [\-o\ \fIconfig_overwrite\fR] [\fIdevice\fR]
26 .SH "DESCRIPTION"
27 .PP
28 \fBamtapetype\fR
29 generates a tapetype entry for
30 \fIAmanda\fR
31 by testing the device directly
32 .SH "OPTIONS"
33 .if n \{\
34 .sp
35 .\}
36 .RS 4
37 .it 1 an-trap
38 .nr an-no-space-flag 1
39 .nr an-break-flag 1
40 .br
41 .ps +1
42 \fBNote\fR
43 .ps -1
44 .br
45 .PP
46 The options for
47 \fBamtapetype\fR
48 have changed in version 2\&.6\&.1
49 .sp .5v
50 .RE
51 .PP
52 \fB\-h\fR
53 .RS 4
54 Display the help message\&.
55 .RE
56 .PP
57 \fB\-c\fR
58 .RS 4
59 Run only the hardware compression detection heuristic test and stop\&. This takes a few minutes only\&.
60 .RE
61 .PP
62 \fB\-f\fR
63 .RS 4
64 Run amtapetype even if the loaded volume is already in use or compression is enabled\&.
65 .RE
66 .PP
67 \fB\-p\fR
68 .RS 4
69 Run only the device property discovery\&.
70 .RE
71 .PP
72 \fB\-b\fR\fI blocksize\fR
73 .RS 4
74 block size to use with the device (default: 32k)
75 .RE
76 .PP
77 \fB\-t\fR \fItypename\fR
78 .RS 4
79 Name to give to the new tapetype definition\&.
80 .RE
81 .PP
82 \fB\-l\fR\fI label\fR
83 .RS 4
84 Label to write on the tape (default is randomly generated)\&.
85 .RE
86 .PP
87 \fB\-o\fR \fIconfigoption\fR
88 .RS 4
89 See the "\fBCONFIGURATION OVERRIDE\fR" section in
90 \fBamanda\fR(8)\&.
91 .RE
92 .SH "EXAMPLE"
93 .PP
94 Generate a tapetype definition for your tape device:
95 .sp
96 .if n \{\
97 .RS 4
98 .\}
99 .nf
100 % amtapetype \-f /dev/nst0
101 .fi
102 .if n \{\
103 .RE
104 .\}
105 .SH "NOTES"
106 .PP
107 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\&.
108 .PP
109 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,
110 \fBamtapetype\fR
111 calculates the size of these filemarks\&.
112 .PP
113 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\&.
114 .PP
115 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
116 \fBamtapetype\fR
117 to think those extra file marks in pass 2 actually took up space\&.
118 .SH "AUTHORS"
119 .PP
120 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
121 .RS 4
122 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
123 .RE
124 .PP
125 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
126 .RS 4
127 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
128 .RE