- Uniformly use .In for header file references.
[dragonfly.git] / share / man / man4 / mtio.4
1 .\" Copyright (c) 1996
2 .\"     Mike Pritchard <mpp@FreeBSD.org>.  All rights reserved.
3 .\"
4 .\" Copyright (c) 1983, 1991, 1993
5 .\"     The Regents of the University of California.  All rights reserved.
6 .\"
7 .\" Redistribution and use in source and binary forms, with or without
8 .\" modification, are permitted provided that the following conditions
9 .\" are met:
10 .\" 1. Redistributions of source code must retain the above copyright
11 .\"    notice, this list of conditions and the following disclaimer.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\"    notice, this list of conditions and the following disclaimer in the
14 .\"    documentation and/or other materials provided with the distribution.
15 .\" 3. All advertising materials mentioning features or use of this software
16 .\"    must display the following acknowledgement:
17 .\"     This product includes software developed by the University of
18 .\"     California, Berkeley and its contributors.
19 .\" 4. Neither the name of the University nor the names of its contributors
20 .\"    may be used to endorse or promote products derived from this software
21 .\"    without specific prior written permission.
22 .\"
23 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
24 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
25 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
26 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
27 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
28 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
29 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
30 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
31 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
32 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
33 .\" SUCH DAMAGE.
34 .\"
35 .\"     @(#)mtio.4      8.1 (Berkeley) 6/5/93
36 .\" $FreeBSD: src/share/man/man4/mtio.4,v 1.8.2.6 2001/08/17 13:08:38 ru Exp $
37 .\" $DragonFly: src/share/man/man4/mtio.4,v 1.4 2006/05/26 19:39:39 swildner Exp $
38 .\"
39 .Dd March 5, 2005
40 .Dt MTIO 4
41 .Os
42 .Sh NAME
43 .Nm mtio
44 .Nd FreeBSD magtape interface
45 .Sh DESCRIPTION
46 The special files
47 named
48 .Pa /dev/[nr]sa*
49 refer to SCSI tape drives,
50 which may be attached to the system.
51 .Pa /dev/[nr]sa*.ctl
52 are control devices that can be used to issue ioctls to the SCSI
53 tape driver to set parameters that are required to last beyond the
54 unmounting of a tape.
55 .Pp
56 .Pp
57 The rewind devices automatically rewind
58 when the last requested read, write or seek has finished, or the end of the tape
59 has been reached.
60 The letter
61 .Ql n
62 is usually prepended to
63 the name of the no-rewind devices.
64 .Pp
65 Tapes can be written with either fixed length records or variable length
66 records.  See
67 .Xr sa 4
68 for more information.  Two end-of-file markers mark the end of a tape, and
69 one end-of-file marker marks the end of a tape file.
70 If the tape is not to be rewound it is positioned with the
71 head in between the two tape marks, where the next write
72 will over write the second end-of-file marker.
73 .Pp
74 All of the magtape devices may be manipulated with the
75 .Xr mt 1
76 command.
77 .Pp
78 A number of
79 .Xr ioctl 2
80 operations are available
81 on raw magnetic tape.
82 Consult
83 .In sys/mtio.h
84 for further information.
85 .Sh FILES
86 .Bl -tag -width /dev/[nr]sa* -compact
87 .It Pa /dev/[nr]sa*
88 .El
89 .Sh SEE ALSO
90 .Xr mt 1 ,
91 .Xr tar 1 ,
92 .Xr sa 4
93 .Sh HISTORY
94 The
95 .Nm
96 manual appeared in
97 .Bx 4.2 .
98 An i386 version first appeared in
99 .Fx 2.2 .
100 .Sh BUGS
101 The status should be returned in a device independent format.
102 .Pp
103 The special file naming should be redone in a consistent and understandable
104 manner.