Imported Upstream version 3.2.0
[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: 10/18/2010
6 .\"    Manual: System Administration Commands
7 .\"    Source: Amanda 3.2.0
8 .\"  Language: English
9 .\"
10 .TH "AMTAPETYPE" "8" "10/18/2010" "Amanda 3\&.2\&.0" "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] [\fB\-o\fR\ \fIconfigoption\fR...] [\fIconfig\fR] [\fIdevice\fR]
26 .SH "DESCRIPTION"
27 .PP
28 \fBamtapetype\fR
29 generates a tapetype entry for Amanda by testing the device directly\&.
30 .SH "OPTIONS"
31 .if n \{\
32 .sp
33 .\}
34 .RS 4
35 .it 1 an-trap
36 .nr an-no-space-flag 1
37 .nr an-break-flag 1
38 .br
39 .ps +1
40 \fBNote\fR
41 .ps -1
42 .br
43 .PP
44 The options for
45 \fBamtapetype\fR
46 have changed in version 2\&.6\&.1
47 .sp .5v
48 .RE
49 .PP
50 \fB\-h\fR
51 .RS 4
52 Display the help message\&.
53 .RE
54 .PP
55 \fB\-c\fR
56 .RS 4
57 Run only the hardware compression detection heuristic test and stop\&. This takes a few minutes only\&.
58 .RE
59 .PP
60 \fB\-f\fR
61 .RS 4
62 Run amtapetype even if the loaded volume is already labeled\&.
63 .RE
64 .PP
65 \fB\-p\fR
66 .RS 4
67 Run only the device property discovery\&.
68 .RE
69 .PP
70 \fB\-b\fR\fI blocksize\fR
71 .RS 4
72 block size to use with the device (default: 32k)
73 .RE
74 .PP
75 \fB\-t\fR \fItypename\fR
76 .RS 4
77 Name to give to the new tapetype definition\&.
78 .RE
79 .PP
80 \fB\-l\fR\fI label\fR
81 .RS 4
82 Label to write on the tape (default is randomly generated)\&.
83 .RE
84 .PP
85 \fB\-o \fR\fB\fIconfigoption\fR\fR
86 .RS 4
87 See the "CONFIGURATION OVERRIDE" section in
88 \fBamanda\fR(8)\&.
89 .RE
90 .PP
91 If a configuration is specified, it is loaded and used to configure the device\&. Note that global configuration parameters are not applied to the device, so if you need to apply properties to a device to run amtapetype, you should supply those properties in a named
92 \fIdevice\fR
93 section\&.
94 .SH "EXAMPLE"
95 .PP
96 Generate a tapetype definition for your tape device:
97 .sp
98 .if n \{\
99 .RS 4
100 .\}
101 .nf
102 % amtapetype \-f /dev/nst0
103 .fi
104 .if n \{\
105 .RE
106 .\}
107 .SH "NOTES"
108 .PP
109 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\&.
110 .PP
111 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,
112 \fBamtapetype\fR
113 calculates the size of these filemarks\&.
114 .PP
115 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\&.
116 .PP
117 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
118 \fBamtapetype\fR
119 to think those extra file marks in pass 2 actually took up space\&.
120 .SH "SEE ALSO"
121 .PP
122 \fBamanda\fR(8),
123 \fBamanda.conf\fR(5)
124 .PP
125 The Amanda Wiki:
126 : http://wiki.zmanda.com/
127 .SH "AUTHORS"
128 .PP
129 \fBDustin J\&. Mitchell\fR <\&dustin@zmanda\&.com\&>
130 .RS 4
131 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
132 .RE
133 .PP
134 \fBJean\-Louis Martineau\fR <\&martineau@zmanda\&.com\&>
135 .RS 4
136 Zmanda, Inc\&. (http://www\&.zmanda\&.com)
137 .RE