diff options
| -rw-r--r-- | share/man/man4/atapiscsi.4 | 35 | ||||
| -rw-r--r-- | share/man/man4/boca.4 | 18 | ||||
| -rw-r--r-- | share/man/man4/pty.4 | 35 | ||||
| -rw-r--r-- | share/man/man4/st.4 | 204 |
4 files changed, 159 insertions, 133 deletions
diff --git a/share/man/man4/atapiscsi.4 b/share/man/man4/atapiscsi.4 index 035ff31ee81..331b5fe3a6d 100644 --- a/share/man/man4/atapiscsi.4 +++ b/share/man/man4/atapiscsi.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: atapiscsi.4,v 1.5 2000/04/03 21:19:35 aaron Exp $ +.\" $OpenBSD: atapiscsi.4,v 1.6 2000/07/10 13:27:34 aaron Exp $ .\" .\" Copyright (c) 1999 Constantine Sapuntzakis. .\" @@ -41,14 +41,14 @@ The .Nm driver supports ATAPI (also called IDE) devices such as CD-ROMs, ZIP -drives, LS-120 floppy drives, and tape drives. All ATAPI devices talk -a subset of the SCSI protocol. +drives, LS-120 floppy drives, and tape drives. +All ATAPI devices talk a subset of the SCSI protocol. .Pp The .Nm -driver acts like a SCSI adapter. Thus, the ATAPI devices connected to -the system will appear as SCSI devices. ATAPI CD-ROMs will appear -as +driver acts like a SCSI adapter. +Thus, the ATAPI devices connected to the system will appear as SCSI devices. +ATAPI CD-ROMs will appear as .Xr cd 4 devices, ATAPI tape drives as .Xr st 4 @@ -57,19 +57,20 @@ devices, and ATAPI floppies as devices. .Pp For performance reasons, one should avoid putting an ATAPI device and -a hard disk on the same cable. The driver does not support bus release -and, even if it did, many ATAPI devices do not support it. There is -only one command outstanding on a cable at a time. For example, if a -hard disk and a CD drive are placed on the same cable, the hard disk -requests may get queued behind slower CD operations. -.Sh BUGS -Slow devices, like tape drives, could do a better job of sharing the channel. -For now, we recommend you put the tape device on its own channel. +a hard disk on the same cable. +The driver does not support bus release and, even if it did, many ATAPI +devices do not support it. +There is only one command outstanding on a cable at a time. +For example, if a hard disk and a CD drive are placed on the same cable, +the hard disk requests may get queued behind slower CD operations. .Sh SEE ALSO +.Xr cd 4 , .Xr intro 4 , .Xr pciide 4 , .Xr scsi 4 , -.Xr wdc 4 , -.Xr cd 4 , +.Xr sd 4 , .Xr st 4 , -.Xr sd 4 +.Xr wdc 4 +.Sh BUGS +Slow devices, like tape drives, could do a better job of sharing the channel. +For now, we recommend you put the tape device on its own channel. diff --git a/share/man/man4/boca.4 b/share/man/man4/boca.4 index a4642b11561..84b87049ca8 100644 --- a/share/man/man4/boca.4 +++ b/share/man/man4/boca.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: boca.4,v 1.1 2000/05/20 17:19:51 deraadt Exp $ +.\" $OpenBSD: boca.4,v 1.2 2000/07/10 13:27:35 aaron Exp $ .\" .\" Copyright (c) 1990, 1991 The Regents of the University of California. .\" All rights reserved. @@ -66,8 +66,8 @@ and is configured as such.) .Sh DESCRIPTION The .Nm boca -driver provides support for BOCA Research BB1004, BB1008 and BB2016 -boards that multiplex together up to four, eight or sixteen +driver provides support for BOCA Research BB1004, BB1008, and BB2016 +boards that multiplex together up to four, eight, or sixteen .Tn EIA .Tn RS-232C .Pf ( Tn CCITT @@ -78,11 +78,13 @@ Each .Nm device is the master device for up to eight .Nm com -devices. The kernel configuration specifies these +devices. +The kernel configuration specifies these .Nm com devices as slave devices of the .Nm -device, as shown in the synopsis. The slave ID given for each +device, as shown in the synopsis. +The slave ID given for each .Nm com device determines which bit in the interrupt multiplexing register is tested to find interrupts for that device. @@ -104,6 +106,6 @@ The .Nm driver was written by Charles Hannum, based on the .Nm ast -driver and source code from David Muir Sharnoff. David wishes to -acknowledge the assistance of Jason Venner in determining how to use -the BOCA boards. +driver and source code from David Muir Sharnoff. +David wishes to acknowledge the assistance of Jason Venner in determining +how to use the BOCA boards. diff --git a/share/man/man4/pty.4 b/share/man/man4/pty.4 index f7fad90b11b..6a2e5f635aa 100644 --- a/share/man/man4/pty.4 +++ b/share/man/man4/pty.4 @@ -1,3 +1,4 @@ +.\" $OpenBSD: pty.4,v 1.5 2000/07/10 13:27:35 aaron Exp $ .\" $NetBSD: pty.4,v 1.4 1998/03/21 03:14:30 fair Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -51,9 +52,9 @@ A pseudo terminal is a pair of character devices, a .Em master device and a .Em slave -device. The slave device provides to a process -an interface identical -to that described in +device. +The slave device provides to a process an interface identical to that +described in .Xr tty 4 . However, whereas all other devices which provide the interface described in @@ -77,7 +78,7 @@ The following calls apply only to pseudo terminals: .Bl -tag -width TIOCREMOTE .It Dv TIOCSTOP -Stops output to a terminal (e.g. like typing +Stops output to a terminal (e.g., like typing .Ql ^S ) . Takes no parameter. @@ -90,18 +91,18 @@ Takes no parameter. .It Dv TIOCPKT Enable/disable .Em packet -mode. Packet mode is enabled by specifying (by reference) -a nonzero parameter and disabled by specifying (by reference) -a zero parameter. When applied to the master side of a pseudo -terminal, each subsequent -.Xr read +mode. +Packet mode is enabled by specifying (by reference) a non-zero parameter +and disabled by specifying (by reference) a zero parameter. +When applied to the master side of a pseudo terminal, each subsequent +.Xr read 2 from the terminal will return data written on the slave part of the pseudo terminal preceded by a zero byte (symbolically defined as .Dv TIOCPKT_DATA ) , or a single byte reflecting control -status information. In the latter case, the byte is an inclusive-or -of zero or more of the bits: +status information. +In the latter case, the byte is an inclusive-or of zero or more of the bits: .Bl -tag -width TIOCPKT_FLUSHWRITE .It Dv TIOCPKT_FLUSHREAD whenever the read queue for the terminal is flushed. @@ -205,10 +206,10 @@ A mode for the master half of a pseudo terminal, independent of .Dv TIOCPKT . This mode causes input to the pseudo terminal -to be flow controlled and not input edited (regardless of the -terminal mode). Each write to the control terminal produces -a record boundary for the process reading the terminal. In -normal usage, a write of data is like the data typed as a line +to be flow controlled and not input edited (regardless of the terminal mode). +Each write to the control terminal produces a record boundary for the process +reading the terminal. +In normal usage, a write of data is like the data typed as a line on the terminal; a write of 0 bytes is like typing an end-of-file character. .Dv TIOCREMOTE @@ -223,8 +224,8 @@ master pseudo terminals .It Pa /dev/tty[p-r][0-9a-f] slave pseudo terminals .El -.Sh DIAGNOSTICS -None. +.Sh SEE ALSO +.Xr tty 4 .Sh HISTORY The .Nm diff --git a/share/man/man4/st.4 b/share/man/man4/st.4 index bf175865444..e7371bb621d 100644 --- a/share/man/man4/st.4 +++ b/share/man/man4/st.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD +.\" $OpenBSD: st.4,v 1.5 2000/07/10 13:27:35 aaron Exp $ .\" $NetBSD: st.4,v 1.2 1996/10/20 23:15:24 explorer Exp $ .\" .\" Copyright (c) 1996 @@ -40,19 +40,18 @@ The .Nm driver provides support for .Tn SCSI -tape drives. It allows a tape drive to be run in several different -modes depending on minor numbers and supports several different -`sub-modes'. The device can have both a +tape drives. +It allows a tape drive to be run in several different modes depending +on minor numbers and supports several different +.Dq sub-modes . +The device can have both a .Em raw -interface -and a +interface and a .Em block -interface; however, only the raw interface is usually used (or -recommended). +interface; however, only the raw interface is usually used (or recommended). .Pp .Tn SCSI -devices have a relatively high level interface and talk to the -system via a +devices have a relatively high level interface and talk to the system via a .Tn SCSI adapter and a .Tn SCSI @@ -69,7 +68,8 @@ As the .Tn SCSI adapter is probed during boot, the .Tn SCSI -bus is scanned for devices. Any devices found which answer as +bus is scanned for devices. +Any devices found which answer as .Sq Em Sequential type devices will be attached to the .Nm @@ -80,17 +80,21 @@ The driver is based around the concept of a .Dq Em mount session , which is defined as the period between the time that a tape is -mounted, and the time when it is unmounted. Any parameters set -during a mount session remain in effect for the remainder of the -session or until replaced. The tape can be unmounted, bringing the -session to a close in several ways. These include: +mounted, and the time when it is unmounted. +Any parameters set during a mount session remain in effect for the remainder +of the session or until replaced. +The tape can be unmounted, bringing the session to a close in several ways. +These include: .Bl -enum .It -Closing an `unmount device', referred to as sub-mode 00 below. An -example is +Closing an +.Dq unmount device , +referred to as sub-mode 00 below. +An example is .Pa /dev/rst0 . .It -Using the MTOFFL +Using the +.Dv MTOFFL .Xr ioctl 2 command, reachable through the .Sq Cm offline @@ -98,24 +102,26 @@ command of .Xr mt 1 . .It Opening a different mode will implicitly unmount the tape, thereby -closing off the mode that was previously mounted. All parameters -will be loaded freshly from the new mode. (See below for more on -modes.) +closing off the mode that was previously mounted. +All parameters will be loaded freshly from the new mode. +(See below for more on modes.) .El .Sh MODES AND SUB-MODES There are several different .Sq operation -modes. These are controlled by bits 2 and 3 of the minor number +modes. +These are controlled by bits 2 and 3 of the minor number and are designed to allow users to easily read and write different -formats of tape on devices that allow multiple formats. The -parameters for each mode can be set individually by hand with the +formats of tape on devices that allow multiple formats. +The parameters for each mode can be set individually by hand with the .Xr mt 1 -command. When a device corresponding to a particular mode is first -mounted, The operating parameters for that mount session are copied -from that mode. Further changes to the parameters during the -session will change those in effect for the session but not those -set in the operation mode. To change the parameters for an operation -mode, one must compile them into the +command. +When a device corresponding to a particular mode is first +mounted, the operating parameters for that mount session are copied +from that mode. +Further changes to the parameters during the session will change those in +effect for the session but not those set in the operation mode. +To change the parameters for an operation mode, one must compile them into the .Dq Em quirk table in the driver's source code. .Pp @@ -129,17 +135,20 @@ A close will rewind the device; if the tape has been written, then a file mark will be written before the rewind is requested. The device is unmounted. .It 01 -A close will leave the tape mounted. If the tape was written to, -a file mark will be written. No other head positioning takes place. +A close will leave the tape mounted. +If the tape was written to, a file mark will be written. +No other head positioning takes place. Any further reads or writes will occur directly after the last read, or the written file mark. .It 10 -A close will rewind the device. If the tape has been written, then -a file mark will be written before the rewind is requested. On -completion of the rewind an unload command will be issued. The -device is unmounted. +A close will rewind the device. +If the tape has been written, then a file mark will be written before the +rewind is requested. +On completion of the rewind an unload command will be issued. +The device is unmounted. .It 11 -Reserved. Currently unused. +Reserved. +Currently unused. .El .Sh BLOCKING MODES .Tn SCSI @@ -147,60 +156,68 @@ tapes may run in either .Sq Em variable or .Sq Em fixed -block-size modes. Most +block-size modes. +Most .Tn QIC Ns -type devices run in fixed block-size mode, where most nine-track tapes -and many new cartridge formats allow variable block-size. The -difference between the two is as follows: +and many new cartridge formats allow variable block-size. +The difference between the two is as follows: .Bl -inset .It Variable block-size: Each write made to the device results in a single logical record -written to the tape. One can never read or write +written to the tape. +One can never read or write .Em part of a record from tape (though you may request a larger block and -read a smaller record); nor can one read multiple blocks. Data -from a single write is therefore read by a single read. The block -size used may be any value supported by the device, the +read a smaller record); nor can one read multiple blocks. +Data from a single write is therefore read by a single read. +The block size used may be any value supported by the device, the .Tn SCSI adapter and the system (usually between 1 byte and 64 Kbytes, sometimes more). .Pp When reading a variable record/block from the tape, the head is logically considered to be immediately after the last item read, -and before the next item after that. If the next item is a file -mark, but it was never read, then the next process to read will -immediately hit the file mark and receive an end-of-file notification. +and before the next item after that. +If the next item is a file mark, but it was never read, then the next +process to read will immediately hit the file mark and receive an +end-of-file notification. .It Fixed block-size data written by the user is passed to the tape as a succession of -fixed size blocks. It may be contiguous in memory, but it is -considered to be a series of independent blocks. One may never -write an amount of data that is not an exact multiple of the -blocksize. One may read and write the same data as a different -set of records. In other words, blocks that were written together -may be read separately, and vice-versa. +fixed size blocks. +It may be contiguous in memory, but it is considered to be a series of +independent blocks. +One may never write an amount of data that is not an exact multiple of the +blocksize. +One may read and write the same data as a different set of records. +In other words, blocks that were written together may be read separately, +and vice-versa. .Pp If one requests more blocks than remain in the file, the drive will -encounter the file mark. Because there is some data to return -(unless there were no records before the file mark), the read will -succeed, returning that data. The next read will return immediately -with an EOF. (As above, if the file mark is never read, it remains -for the next process to read if in no-rewind mode.) +encounter the file mark. +Because there is some data to return (unless there were no records before +the file mark), the read will succeed, returning that data. +The next read will return immediately with an +.Dv EOF . +(As above, if the file mark is never read, it remains for the next process +to read if in no-rewind mode.) .El .Sh FILE MARK HANDLING -The handling of file marks on write is automatic. If the user has -written to the tape, and has not done a read since the last write, -then a file mark will be written to the tape when the device is -closed. If a rewind is requested after a write, then the driver +The handling of file marks on write is automatic. +If the user has written to the tape, and has not done a read since the last +write, then a file mark will be written to the tape when the device is closed. +If a rewind is requested after a write, then the driver assumes that the last file on the tape has been written, and ensures -that there are two file marks written to the tape. The exception -to this is that there seems to be a standard (which we follow, but -don't understand why) that certain types of tape do not actually -write two file marks to tape, but when read, report a `phantom' -file mark when the last file is read. These devices include the -QIC family of devices. (It might be that this set of devices is -the same set as that of fixed block devices. This has not been -determined yet, and they are treated as separate behaviors by the -driver at this time.) +that there are two file marks written to the tape. +The exception to this is that there seems to be a standard (which we follow, +but don't understand why) that certain types of tape do not actually +write two file marks to tape, but when read, report a +.Dq phantom +file mark when the last file is read. +These devices include the QIC family of devices. +(It might be that this set of devices is the same set as that of fixed +This has not yet been determined, and they are treated as separate +behaviors by the driver at this time.) .Sh KERNEL CONFIGURATION Because different tape drives behave differently, there is a mechanism within the source to @@ -210,18 +227,21 @@ models of drive that have special requirements. .Pp There is a table (called the .Dq Em quirk table ) -in which the identification strings of known errant drives can be -stored. Alongside each is a set of flags that allows the setting +in which the identification strings of known errant drives can be stored. +Alongside each is a set of flags that allows the setting of densities and blocksizes for each of the modes, along with a -set of `QUIRK' flags that can be used to enable or disable sections +set of +.Dq QUIRK +flags that can be used to enable or disable sections of code within the driver if a particular drive is recognized. .Sh IOCTLS The following .Xr ioctl 2 calls apply to .Tn SCSI -tapes. Some also apply to other tapes. They are defined in the -header file +tapes. +Some also apply to other tapes. +They are defined in the header file .Aq Pa /sys/mtio.h . .\" .\" Almost all of this discussion belongs in a separate mt(4) @@ -234,7 +254,8 @@ header file Retrieve the status and parameters of the tape. .It Dv MTIOCTOP .Pq Li "struct mtop" -Perform a multiplexed operation. The argument structure is as follows: +Perform a multiplexed operation. +The argument structure is as follows: .Bd -literal -offset indent struct mtop { short mt_op; @@ -252,15 +273,16 @@ end of file marks at the present head position. .It Dv MTFSF Skip over .Va mt_count -file marks. Leave the head on the EOM side of the last skipped -file mark. +file marks. +Leave the head on the EOM side of the last skipped file mark. .It Dv MTBSF Skip .Em backwards over .Va mt_count -file marks. Leave the head on the BOM (beginning of media) -side of the last skipped file mark. +file marks. +Leave the head on the BOM (beginning of media) side of the last skipped +file mark. .It Dv MTFSR Skip forwards over .Va mt_count @@ -272,8 +294,9 @@ records. .It Dv MTREW Rewind the device to the beginning of the media. .It Dv MTOFFL -Rewind the media (and, if possible, eject). Even if the device cannot -eject the media it will often no longer respond to normal requests. +Rewind the media (and, if possible, eject). +Even if the device cannot eject the media it will often no longer respond +to normal requests. .It Dv MTNOP No-op; set status only. .It Dv MTCACHE @@ -281,10 +304,10 @@ Enable controller buffering. .It Dv MTNOCACHE Disable controller buffering. .It Dv MTSETBSIZ -Set the blocksize to use for the device/mode. If the device is capable of -variable blocksize operation, and the blocksize is set to 0, then the drive -will be driven in variable mode. This parameter is in effect for the present -mount session only. +Set the blocksize to use for the device/mode. +If the device is capable of variable blocksize operation, and the blocksize +is set to 0, then the drive will be driven in variable mode. +This parameter is in effect for the present mount session only. .It Dv MTSETDNSTY Set the density value (see .Xr mt 1 ) @@ -304,7 +327,7 @@ devices). .Sh FILES .Bl -tag -width /dev/[n][e]rst[0-9] -compact .It Pa /dev/[n][e]rst[0-9] -general form: +general form .It Pa /dev/rst0 Mode 0, rewind on close .It Pa /dev/nrst0 @@ -312,8 +335,6 @@ Mode 2, No rewind on close .It Pa /dev/erst0 Mode 3, Eject on close (if capable) .El -.Sh DIAGNOSTICS -None. .Sh SEE ALSO .Xr mt 1 , .Xr mtio 4 , @@ -325,6 +346,7 @@ driver was originally written for .Tn Mach 2.5 by Julian Elischer, and was ported to .Tn NetBSD -by Charles Hannum. This man page was edited for +by Charles Hannum. +This man page was edited for .Tn NetBSD by Jon Buller. |