lose the generated ps files
[debian/dds2tar] / mt-dds.man
1 .TH mt-dds 1 2.4 \" -*- nroff -*-
2 .\"----------
3 .SH NAME
4 .\"----------
5 mt-dds \- tool to control a dds device.
6 .\"----------
7 .SH SYNOPSIS
8 .\"----------
9 .B mt-dds
10 .BR comp-on | comp-off | comp-query | comp-log 
11 .PD 0
12 .PP
13 .B mt-dds
14 <
15 .BR tell | label
16 > [
17 .B -b \ #
18 ]
19 .PD 1
20 .\"----------
21 .SH DESCRIPTION
22 .\"----------
23 .B mt-dds
24 controls the compression mode of dds tape devices (DAT).
25 .PP
26 .B mt-dds
27 may also report the current tape position in
28 absolute records (relative to begin of tape) in a format
29 that may be used later by 
30 .B dds2tar(1)
31 to access tar archives that are not the first file on tape.
32 .PP
33 The default device is
34 .IR /dev/tape ,
35 which may be overridden with the environment variable
36 .BR TAPE ,
37 which in turn may be overridden with the
38 .BI -f \ device
39 option. The device must be a character special file.
40 .\"----------
41 .SH OPTIONS
42 .\"----------
43 .SS DDS tape device control options
44
45 .TP
46 .B comp-on
47 Enable the hardware compression mode if supported by the device.
48 .TP 
49 .B comp-off
50 Disable the compression mode, switch to normal mode.
51 .TP 
52 .B comp-query
53 Print to stderr if compression mode currently is disabled 
54 or enabled.  A 
55 .B 0
56 means compression is disabled, a
57 .B 1
58 means compression in enabled.
59 .TP 
60 .B comp-log
61 Print to stdout four lines of information about transferred kilobytes 
62 before and after hardware compression from and to the device
63 since initialization.
64 .\"----------
65 .SS dds2tar service functions
66
67 .TP
68 .B tell
69 Print three lines with the 
70 .BR "current tape position" ", a" 
71 .B block size 
72 value (20 by default, may be overridden with 
73 .B -b
74 option) and a 
75 .B block length
76 value (blocksize*512) to 
77 .IR stdout .
78 If this output is redirected to a location file 
79 .IR locfile ,
80 this file may be used by 
81 .B dds2tar(1)
82 to access archives on tape.
83 .TP
84 .B label
85 If the current tape position is the beginning of an archive and the archive
86 is labeled,
87 .B mt-dds
88 writes the label to stdout
89 and moves the tape back to the
90 current position (or back over the filemark).
91 .TP
92 .B ts
93 If the current tape position is the beginning of an archive and the archive
94 is labeled,
95 .B mt-dds
96 writes the timestamp in octal format to stdout
97 and moves the tape back to the
98 current position (or back over the filemark).
99 If you are using only one computer, the timestamp can be used as a unique
100 archive identifier.
101 .TP
102 .BI -b \  #
103 Specify the block size 
104 .I #
105 value that is used as a default for the written value with the
106 .B mt-dds tell
107 command (see above).
108 Also the internal buffer size is specified with this option
109 which is used to read one block in order to get the block size
110 of the current tape block. So specify the block size of the archive
111 or a larger number.
112 .\"----------
113 .SS other options
114
115 .TP
116 .BI -f\  device
117 Device of the tape archive (default is /dev/tape).
118 Must be a character special file connected to a dds tape device.
119 .TP
120 .BR -V , --version
121 Print the version number of
122 .B mt-dds
123 to stderr and exit immediately.
124 .TP
125 .B --help
126 print some screens of online help with examples through a pager
127 and exit immediately.
128 .\"----------
129 .SH EXAMPLES
130 .\"----------
131 .B Example 1: 
132 checking the compression mode of the default tape device
133 .RS 10
134 mt-dds comp-query
135 .RE
136 .PP
137 .B Example 2: 
138 Write the location information as
139 .B dds2tar
140 command line options to stdout.
141 .RS 10
142 mt-dds
143 .RE
144 .PP
145 .PD 1
146 .\"----------
147 .SH ENVIRONMENT
148 .\"----------
149 The environment variable
150 .B TAPE
151 overrides the default tape device /dev/tape.
152 .TP
153 PAGER
154 The environment variable
155 .B PAGER
156 overrides the builtin pager command ("/bin/more") to display the output
157 of the
158 .B --help
159 option.
160 .\"----------
161 .SH "SEE ALSO"
162 .\"----------
163 dds2tar(1), dds2index(1), mt(1), tar(1)
164 .\"----------
165 .SH HISTORY
166 .\"----------
167 This program was created to use it in conjunction with dds2tar.
168 .\"----------
169 .SH AUTHOR
170 .\"----------
171 J"org Weule (weule@cs.uni-duesseldorf.de), Phone +49 211 751409.
172 This software is available at
173 ftp.uni-duesseldorf.de:/pub/unix/apollo
174