diff options
Diffstat (limited to 'share/man')
24 files changed, 514 insertions, 388 deletions
diff --git a/share/man/man4/man4.i386/apm.4 b/share/man/man4/man4.i386/apm.4 index 975f2d7eb93..3af2641a968 100644 --- a/share/man/man4/man4.i386/apm.4 +++ b/share/man/man4/man4.i386/apm.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: apm.4,v 1.10 2000/07/03 15:10:57 mickey Exp $ +.\" $OpenBSD: apm.4,v 1.11 2000/07/05 13:46:52 aaron Exp $ .\" .\" Copyright (c) 1998 Marco S. Hyman .\" @@ -24,8 +24,8 @@ The driver provides an interface to the Advanced Power Management .Pq Tn APM .Tn BIOS -functions. The driver supports versions 1.0, 1.1, and 1.2 interface -specifications. +functions. +The driver supports versions 1.0, 1.1, and 1.2 interface specifications. .Pp The low two bytes of the flags specify the version of the specification driver should conform to in binary decimal notation. @@ -35,7 +35,8 @@ specification to be used. The value of 0x10000 specifies whether to leave interrupts enabled when calling .Tn APM BIOS -routines. This is needed for some +routines. +This is needed for some .Tn IBM laptops, the symptoms are hangs and freezes on suspend, stand by, and hibernation activities. @@ -55,7 +56,8 @@ The .Nm driver implements the following .Xr ioctl 2 -calls. They are defined in +calls. +They are defined in .Aq Pa machine/apmvar.h . .Pp .Bl -tag -width Ds @@ -73,7 +75,8 @@ Request mode. .It Dv APM_IOC_GETPOWER .Pq Li "struct apm_power_info" -Request the current power state. The argument structure is as follows: +Request the current power state. +The argument structure is as follows: .Bd -literal -offset indent struct apm_power_info { u_char battery_state; @@ -130,13 +133,14 @@ The .Tn APM driver stores up to .Dv APM_NEVENTS -events. This was defined as 16 at the time this documentation was written. -If the event list is full when a new event is detected the new event is -lost. +events. +This was defined as 16 at the time this documentation was written. +If the event list is full when a new event is detected the new event is lost. .Dv APM_IOC_NEXTEVENT ioctl returns the next event on the list or .Er EAGAIN -if the event list is empty. The format of the returned event is: +if the event list is empty. +The format of the returned event is: .Bd -literal -offset indent struct apm_event_info { u_int type; @@ -167,7 +171,8 @@ is one of: .Pq Li "struct apm_ctl" Allows an application to directly set the .Tm APM -operating mode. The argument structure is as follows: +operating mode. +The argument structure is as follows: .Bd -literal -offset indent struct apm_ctl { u_int dev; @@ -180,7 +185,8 @@ indicates the device, typically .Dv APM_DEV_ALLDEVS . .Pp .Va mode -indicates the desired operating mode. Possible values are +indicates the desired operating mode. +Possible values are .Bl -tag -compact -offset indent .It Dv APM_SYS_READY .It Dv APM_SYS_STANDBY @@ -195,12 +201,12 @@ This .Xr ioctl 2 controls message output by the .Tn APM -driver when a power change event is detected. The integer parameter is one -of: +driver when a power change event is detected. +The integer parameter is one of: .Bl -tag -width Ds .It Dv APM_PRINT_ON -All power change events result in a message. This is the normal -operating mode for the driver. +All power change events result in a message. +This is the normal operating mode for the driver. .It Dv APM_PRINT_OFF Power change event messages are suppressed. .It Dv APM_PRINT_PCT @@ -223,13 +229,15 @@ setting. .Bl -tag -width /dev/apmctl -compat .It Pa /dev/apm .Tn APM -data device. May only be opened read-only. May be opened by multiple -concurrent users. +data device. +May only be opened read-only. +May be opened by multiple concurrent users. .It Pa /dev/apmctl .Tn APM -control device. May be opened read-write or write-only. May only be -opened by one user at a time. An attempt to open the file when in -use will fail, returning +control device. +May be opened read-write or write-only. +May only be opened by one user at a time. +An attempt to open the file when in use will fail, returning .Er EBUSY . .El .Sh SEE ALSO @@ -241,10 +249,12 @@ http://developer.intel.com/ial/powermgm/apmv12.pdf The .Nm driver source code contains these copyrights: +.Pp .Bl -item -compact .It .Li Copyright (c) 1995 John T. Kohl. All rights reserved. .It .Li Copyright (C) 1994 by HOSOKAWA Tatsumi <hosokawa@mt.cs.keio.ac.jp> .El -and has been hacked on by many others since. +.Pp +\&...and has been hacked on by many others since. diff --git a/share/man/man4/man4.i386/autoconf.4 b/share/man/man4/man4.i386/autoconf.4 index 4f4eaa5afbd..5bed3212d4b 100644 --- a/share/man/man4/man4.i386/autoconf.4 +++ b/share/man/man4/man4.i386/autoconf.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: autoconf.4,v 1.4 1999/07/02 20:11:51 aaron Exp $ +.\" $OpenBSD: autoconf.4,v 1.5 2000/07/05 13:46:52 aaron Exp $ .\" .\" Copyright (c) 1994 Christopher G. Demetriou .\" All rights reserved. @@ -36,12 +36,12 @@ .Nd diagnostics from the autoconfiguration code .Sh DESCRIPTION When -.Tn OpenBSD +.Ox bootstraps it probes the innards of the machine on which it is running and locates controllers, drives, and other devices, printing out -what it finds on the console. This procedure is driven by a system -configuration table which is processed by +what it finds on the console. +This procedure is driven by a system configuration table which is processed by .Xr config 8 and compiled into each kernel. Devices which exist in the machine but are not configured into the @@ -50,12 +50,12 @@ kernel are not detected. .Bl -diag .It CPU class not configured. You tried to boot -.Tn OpenBSD +.Ox on a class of .Tn CPU type which it doesn't (or at least this compiled version of -.Tn OpenBSD +.Ox doesn't) understand. .El .Sh SEE ALSO diff --git a/share/man/man4/man4.i386/bktr.4 b/share/man/man4/man4.i386/bktr.4 index b9ba836ffd9..d01a2f59ec1 100644 --- a/share/man/man4/man4.i386/bktr.4 +++ b/share/man/man4/man4.i386/bktr.4 @@ -1,10 +1,8 @@ .\" -.\" $OpenBSD: bktr.4,v 1.3 1999/07/09 13:35:43 aaron Exp $ +.\" $OpenBSD: bktr.4,v 1.4 2000/07/05 13:46:52 aaron Exp $ .\" $FreeBSD: bktr.4,v 1.1 1998/03/09 10:56:22 jkh Exp $ .\" .Dd January 28, 1998 -.br -.in +0.5i .Dt BKTR 4 i386 .Os .Sh NAME @@ -15,45 +13,40 @@ .Sh DESCRIPTION The .Nm -driver provides support for PCI -.Em video -capture on low cost, high performance boards. The driver is heavily based on -the Matrox Meteor driver. The bktr driver should support most video cards -based on the +driver provides support for PCI video capture on low cost, high performance +boards. +The driver is heavily based on the Matrox Meteor driver. +The +.Nm +driver should support most video cards based on the .Em Brooktree Bt848 Video Capture Chip. .Pp Specifically, the following cards are known to work: -.br -.Em Hauppage Wincast TV -.br -.Em STB TV PCI Television Tuner -.br -.Em Miro PC TV -.br -.Em Intel Smart Video Recorder III +.Pp +.Bl -tag -width -offset indent -compact +.It Hauppage Wincast TV +.It STB TV PCI Television Tuner +.It Miro PC TV +.It MIntel Smart Video Recorder III +.El .Pp The driver currently supports the following features: -.br -.in +0.5i -PCI to PCI dma transfer -.br -clipping -.br -yuv -.br -rgb16 -.br -rgb24 -.br -rgb32 -.in -0.5i +.Pp +.Bl -tag -width -offset indent -compact +.It PCI-to-PCI DMA transfer +.It Clipping +.It YUV +.It RGB16, RGB24, RGB32 +.El .Pp The following kernel parameters may be used to further configure the driver: .Pp -.Em options "BROOKTREE_ALLOC_PAGES=xxx" -specifies the number of contiguous pages to allocate when successfully -probed. The default number of pages allocated by the kernel is 216. +.Bl -ohang +.It Cd option "BROOKTREE_ALLOC_PAGES=xxx" +Specifies the number of contiguous pages to allocate when successfully probed. +The default number of pages allocated by the kernel is 216. This means that there are (216*4096) bytes available for use. +.El .Sh AUTHOR This driver is based on the work of .An Jim Lowe Aq james@miller.cs.uwm.edu , diff --git a/share/man/man4/man4.i386/gus.4 b/share/man/man4/man4.i386/gus.4 index 2fcdd4f21d3..04c1ca7faec 100644 --- a/share/man/man4/man4.i386/gus.4 +++ b/share/man/man4/man4.i386/gus.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: gus.4,v 1.9 1999/07/21 12:18:11 deraadt Exp $ +.\" $OpenBSD: gus.4,v 1.10 2000/07/05 13:46:52 aaron Exp $ .\" $NetBSD: gus.4,v 1.7 1997/10/08 21:59:55 jtc Exp $ .\" .\" Copyright (c) 1996 The NetBSD Foundation, Inc. @@ -50,40 +50,30 @@ Gravis UltraSound/UltraSound MAX device driver The .Nm driver provides support for the Gravis UltraSound (GUS) and GUS MAX -audio cards. Both cards have on-board memory which is used for -seamless playback of samples. They can play back 8- or 16-bit samples -at up to 44.1kHz. They can record 8-bit samples at up to 44.1kHz. -The UltraSound MAX is a full-duplex sound device, and if -configured with two DRQ channels can be used for simultaneous playback -and recording. The I/O port base is jumper-selected, and may be chosen -from 0x210-0x260 in steps of 0x10. (The normal setting is 0x220.) The -GUS takes 16 ports at its base address and 8 ports at its base address + +audio cards. +Both cards have on-board memory which is used for seamless playback of samples. +They can play back 8- or 16-bit samples at up to 44.1kHz. +They can record 8-bit samples at up to 44.1kHz. +The UltraSound MAX is a full-duplex sound device, and if configured with two +DRQ channels can be used for simultaneous playback and recording. +The I/O port base is jumper-selected, and may be chosen from 0x210-0x260 in +steps of 0x10. +(The normal setting is 0x220.) +The GUS takes 16 ports at its base address and 8 ports at its base address + 0x100. .Pp The IRQ is software programmed, so you may select any IRQ from the set -{3,5,7,9,11,12,15}. The DRQ lines are software programmed, and may be -chosen from {1,3,5,6,7}. The drq2 field in the configuration file line -specifies a second DRQ line for recording. If there is no drq2 field -in the config file, the playback channel will be used for recording DMA -and only half-duplex mode will be available. +{3,5,7,9,11,12,15}. +The DRQ lines are software programmed, and may be chosen from {1,3,5,6,7}. +The +.Dq drq2 +field in the configuration file line specifies a second DRQ line for recording. +If there is no drq2 field in the config file, the playback channel will be +used for recording DMA and only half-duplex mode will be available. .Pp The Gravis UltraSound MAX has an additional CODEC onboard which is addressed with four ports at an offset of 0x10C from the base ports (0x31C-0x36C). -.Sh BUGS -The full-duplex features of the GUS MAX have not been fully tested, and -full-duplex on the original GUS may not be possible at all. -.Pp -Only two voices on the GF1 synthesizer chip are used by this driver (for -left and right channels). -.Pp -Manipulating the mixer while audio samples are playing can lead to -device driver confusion (and maybe even a system panic). -.Pp -Manipulating the mixer device seems to create pregnant system pauses, -probably due to excessive interrupt masking. -.Pp -The joystick and MIDI port interfaces are not supported. .Sh SEE ALSO .Xr audio 4 .Sh REFERENCES @@ -99,3 +89,17 @@ The .Nm device driver appeared in .Nx 1.1 . +.Sh BUGS +The full-duplex features of the GUS MAX have not been fully tested, and +full-duplex on the original GUS may not be possible at all. +.Pp +Only two voices on the GF1 synthesizer chip are used by this driver (for +left and right channels). +.Pp +Manipulating the mixer while audio samples are playing can lead to +device driver confusion (and maybe even a system panic). +.Pp +Manipulating the mixer device seems to create pregnant system pauses, +probably due to excessive interrupt masking. +.Pp +The joystick and MIDI port interfaces are not supported. diff --git a/share/man/man4/man4.i386/ie.4 b/share/man/man4/man4.i386/ie.4 index e84238da4b9..17b2392d85b 100644 --- a/share/man/man4/man4.i386/ie.4 +++ b/share/man/man4/man4.i386/ie.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ie.4,v 1.7 1999/08/04 14:33:47 jason Exp $ +.\" $OpenBSD: ie.4,v 1.8 2000/07/05 13:46:52 aaron Exp $ .\" .\" Copyright (c) 1994 James A. Jegers .\" All rights reserved. @@ -33,8 +33,8 @@ .Sh DESCRIPTION The .Nm -device driver supports Intel 82586-based Ethernet cards. This includes the -following network adapters: +device driver supports Intel 82586-based Ethernet cards. +This includes the following network adapters: .Pp .Bl -tag -width -offset indent -compact .It 3Com 3C507 diff --git a/share/man/man4/man4.i386/intro.4 b/share/man/man4/man4.i386/intro.4 index dfe244ddfc1..ad578245789 100644 --- a/share/man/man4/man4.i386/intro.4 +++ b/share/man/man4/man4.i386/intro.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: intro.4,v 1.19 2000/04/13 17:17:13 jason Exp $ +.\" $OpenBSD: intro.4,v 1.20 2000/07/05 13:46:52 aaron Exp $ .\" .\" Copyright (c) 1994 Christopher G. Demetriou .\" All rights reserved. @@ -63,8 +63,8 @@ The networking support is introduced in .Sh DEVICE SUPPORT This section describes the hardware supported on the i386 (PC-clone) platform. -Software support for these devices comes in two forms. A hardware -device may be supported with a character or block +Software support for these devices comes in two forms. +A hardware device may be supported with a character or block .Em device driver , or it may be used within the networking subsystem and have a .Em network interface driver . @@ -77,9 +77,9 @@ communication facilities provided by the system; see .Pp A hardware device is identified to the system at configuration time and the appropriate device or network interface driver is then compiled -into the system. When the resultant system is booted, the -autoconfiguration facilities in the system probe for the device -and, if found, enable the software support for it. +into the system. +When the resultant system is booted, the autoconfiguration facilities in the +system probe for the device and, if found, enable the software support for it. If a device does not respond at autoconfiguration time it is not accessible at any time afterwards. To enable a device which did not autoconfigure, @@ -94,7 +94,8 @@ A list of the supported devices is given below. .Xr config 8 .Sh LIST OF DEVICES The devices listed below are supported in this incarnation of -the system. Devices are indicated by their functional interface. +the system. +Devices are indicated by their functional interface. Not all supported devices are listed. .Pp .Bl -tag -width speaker -offset xxxx -compact @@ -186,8 +187,8 @@ RealTek 8129/8139 Ethernet. .It sb Sound Blaster card. .It sea -Seagate/Future Domain SCSI cards. ST01/02, Future Domain TMC-885, and -Future Domain TMC-950. +Seagate/Future Domain SCSI cards. +ST01/02, Future Domain TMC-885, and Future Domain TMC-950. .It sk SysKonnect 984x Gigabit Ethernet (9841/9842/9843/9844). .It speaker @@ -199,14 +200,15 @@ Texas Instruments ThunderLAN ethernet .It tx SMC 9432 10/100 Mbps Ethernet cards .It uha -Ultrastor ISA and EISA SCSI adapter cards. Ultrastore 14f, Ultrastore 34f, -and Ultrastore 24f. +Ultrastor ISA and EISA SCSI adapter cards. +Ultrastore 14f, Ultrastore 34f, and Ultrastore 24f. .It vr VIA Rhine Ethernet. .It wb Winbond W89C840F fast ethernet. .It wdc -Standard ISA Western Digital type hard drives. MFM, RLL, ESDI, and IDE. +Standard ISA Western Digital type hard drives. +MFM, RLL, ESDI, and IDE. .It wds WD-7000 SCSI host adapters. .It wdt @@ -214,7 +216,8 @@ Industrial Computer Source PCI-WDT50x watchdog timer cards. .It we Western Digital/SMC WD 80x3, SMC Elite Ultra and SMC EtherEZ Ethernet cards. .It wt -Wangtek and compatible tape drives. QIC-02 and QIC-36. +Wangtek and compatible tape drives. +QIC-02 and QIC-36. .It wx Intel 82452 Pro/1000 Gigabit Ethernet. .It xl diff --git a/share/man/man4/man4.i386/iy.4 b/share/man/man4/man4.i386/iy.4 index 88d0d5f815c..e554d24b100 100644 --- a/share/man/man4/man4.i386/iy.4 +++ b/share/man/man4/man4.i386/iy.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: iy.4,v 1.6 1999/07/09 13:35:43 aaron Exp $ +.\" $OpenBSD: iy.4,v 1.7 2000/07/05 13:46:52 aaron Exp $ .\" $NetBSD: iy.4,v 1.2 1996/05/23 16:52:39 thorpej Exp $ .\" .\" Copyright (c) 1994 Herb Peyerl @@ -57,8 +57,8 @@ UTP, also known as twisted pair .Pp The default port to use is the port the card autodetects at .Xr ifconfig up -time. To choose an alternate port, -use the following flag combinations with +time. +To choose an alternative port, use the following flag combinations with .Xr ifconfig 8 or in your /etc/hostname.iy? file. .Pp diff --git a/share/man/man4/man4.i386/joy.4 b/share/man/man4/man4.i386/joy.4 index 58220a143ac..a3e32436f33 100644 --- a/share/man/man4/man4.i386/joy.4 +++ b/share/man/man4/man4.i386/joy.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: joy.4,v 1.7 1999/07/09 13:35:43 aaron Exp $ +.\" $OpenBSD: joy.4,v 1.8 2000/07/05 13:46:52 aaron Exp $ .\" .\" Copyright (c) 1996 Matthieu Herrb .\" All rights reserved. @@ -41,27 +41,32 @@ Games adapter driver .Cd "joy0 at isa? port 0x201" .Cd "joy* at isapnp?" .Sh DESCRIPTION -This driver provides access to the games adapter. The lower bit in the -minor device number selects the joystick: 0 is the first joystick and -1 is the second. +This driver provides access to the games adapter. +The lower bit in the minor device number selects the joystick: 0 is the first +joystick and 1 is the second. .Pp The game control adapter allows up to two joysticks to be attached to -the system. The adapter plus the driver convert the present resistive -value to a relative joystick position. On receipt of an output signal, -four timing circuits are started. By determining the time required for -the circuit to time-out (a function of the resistance), the paddle -position can be determined. The adapter could be used as a general -purpose I/O card with four analog (resistive) inputs plus four digital -input points. +the system. +The adapter plus the driver convert the present resistive value to a relative +joystick position. +On receipt of an output signal, four timing circuits are started. +By determining the time required for the circuit to time-out (a function of +the resistance), the paddle position can be determined. +The adapter could be used as a general purpose I/O card with four +analog (resistive) inputs plus four digital input points. .Pp -Applications may call ioctl() on a game adapter driver file descriptor +Applications may call +.Fn ioctl +on a game adapter driver file descriptor to set and get the offsets of the two potentiometers and the maximum -time-out value for the circuit. The -ioctl() commands are listed in -.Pa Aq machine/joystick.h +time-out value for the circuit. +The +.Fn ioctl +commands are listed in +.Aq Pa machine/joystick.h and currently are: .Pp -.Bl -tag -width JOY_GET_X_OFFSET -compact +.Bl -tag -width JOY_GET_X_OFFSET -offset indent -compact .It JOY_SETTIMEOUT Sets the maximum time-out for the adapter. .It JOY_GETTIMEOUT @@ -91,42 +96,50 @@ struct joystick { .Ed .Pp The fields have the following functions: -.Bl -tag -width b1 +.Pp +.Bl -tag -width xxx -offset indent -compact .It Fa x -The current X coordinate of the joystick (or position of paddle 1) +Joystick's current X coordinate (or position of paddle 1). .It Fa y -The current Y coordinate of the joystick (or position of paddle 2) +Joystick's current Y coordinate (or position of paddle 2). .It Fa b1 -The current state of button 1 +Current state of button 1. .It Fa b2 -The current state of button 2 +Current state of button 2. .El .Pp -The b1 and b2 fields in struct joystick are set to 1 if the -corresponding button is down, 0 otherwise. +The +.Fa b1 +and +.Fa b2 +fields in struct joystick are set to 1 if the corresponding button is down, +or 0 otherwise. .Pp -The x and y coordinates are supposed to be between 0 and 255 for a -good joystick and a good adapter. Unfortunately, because of the -hardware hack that is used to measure the position (by measuring the -time needed to discharge an RC circuit made from the joystick's -potentiometer and a capacitor on the adapter), calibration +The X and Y coordinates are supposed to be between 0 and 255 for a +good joystick and a good adapter. +Unfortunately, because of the hardware hack that is used to measure the +position (by measuring the time needed to discharge an RC circuit made from +the joystick's potentiometer and a capacitor on the adapter), calibration is needed to determine exactly what values are returned for a specific -joystick/adapter combination. Incorrect hardware can yield negative or -> 255 values. +joystick/adapter combination. +Incorrect hardware can yield negative or > 255 values. .Pp -A typical calibration procedure uses the values returned at lower -left, center and upper right positions of the joystick to compute the -relative position. +A typical calibration procedure uses the values returned at lower-left, +center, and upper-right positions of the joystick to compute the relative +position. .Pp This calibration is not part of the driver. .Sh FILES -.Bl -tag -width Pa -compact +.Bl -tag -width /dev/joy0 -compact .It Pa /dev/joy0 first joystick -.br .It Pa /dev/joy1 second joystick .El .Sh AUTHORS -Jean-Marc Zucconi wrote the FreeBSD driver. Matthieu Herrb ported it -to NetBSD and wrote this manual page. +Jean-Marc Zucconi wrote the +.Fx +driver. +Matthieu Herrb ported it to +.Nx +and wrote this manual page. diff --git a/share/man/man4/man4.i386/le.4 b/share/man/man4/man4.i386/le.4 index 1811bdc8160..b187f55dcc1 100644 --- a/share/man/man4/man4.i386/le.4 +++ b/share/man/man4/man4.i386/le.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: le.4,v 1.4 1999/07/09 13:35:44 aaron Exp $ +.\" $OpenBSD: le.4,v 1.5 2000/07/05 13:46:52 aaron Exp $ .\" .\" Copyright (c) 1994 James A. Jegers .\" All rights reserved. @@ -35,11 +35,10 @@ The .Nm interface provides access to a 10 Mb/s Ethernet network via the -Lance Ethernet chips. The Ethernet cards supported by the -.Nm -interface are: +Lance Ethernet chips. +This includes the following models: .Pp -.Bl -tag -width -offset indet -compact +.Bl -tag -width -offset indent -compact .It BICC Isolan .It Novell NE2100 .It Digital DEPCA @@ -50,4 +49,4 @@ interface are: .Xr ep 4 , .Xr ie 4 , .Xr intro 4 , -.Xr ifconfig 8 , +.Xr ifconfig 8 diff --git a/share/man/man4/man4.i386/lms.4 b/share/man/man4/man4.i386/lms.4 index 0e47ab922fd..31fa71f5819 100644 --- a/share/man/man4/man4.i386/lms.4 +++ b/share/man/man4/man4.i386/lms.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: lms.4,v 1.3 1998/07/12 09:55:24 downsj Exp $ +.\" $OpenBSD: lms.4,v 1.4 2000/07/05 13:46:53 aaron Exp $ .\" .\" Copyright (c) 1993 Christopher G. Demetriou .\" All rights reserved. @@ -42,7 +42,7 @@ Logitech-style bus mouse driver .Sh DESCRIPTION This driver provides an interface to a Logitech-style bus mouse. .Sh FILES -.Bl -tag -width Pa -compact +.Bl -tag -width /dev/lms0 -compact .It Pa /dev/lms0 first Logitech-style bus mouse .El diff --git a/share/man/man4/man4.i386/lpt.4 b/share/man/man4/man4.i386/lpt.4 index c8974d8053a..779da9b26c7 100644 --- a/share/man/man4/man4.i386/lpt.4 +++ b/share/man/man4/man4.i386/lpt.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: lpt.4,v 1.5 1999/01/07 16:01:57 niklas Exp $ +.\" $OpenBSD: lpt.4,v 1.6 2000/07/05 13:46:53 aaron Exp $ .\" .\" Copyright (c) 1993 Christopher G. Demetriou .\" All rights reserved. @@ -34,7 +34,7 @@ .Sh NAME .Nm lpt .Nd -Parallel port driver +parallel port driver .Sh SYNOPSIS .\" XXX this is awful hackery to get it to work right... -- cgd .Cd "lpt0 at isa? port" \&"IO_LPT1\&" irq 7 @@ -43,9 +43,9 @@ Parallel port driver This driver provides access to parallel ports. .Pp The highest bit in the minor (bit 7, or add 128) number selects -whether to do polling or wait for interrupts. If no IRQ is specified -in the kernel configuration, or the IRQ specified is not available at -attach time, only the polling device may be used. +whether to do polling or wait for interrupts. +If no IRQ is specified in the kernel configuration, or the IRQ specified is +not available at attach time, only the polling device may be used. .Pp The next lower bit (bit 6, or add 64) indicates the driver should avoid initializing the printer. @@ -53,9 +53,11 @@ avoid initializing the printer. The next lower bit (bit 5, or add 32) requests that the driver do automatic LF generation when printing CR's. .Sh FILES -.Bl -tag -width Pa -compact +.Bl -tag -width /dev/lpt0 -compact .It Pa /dev/lpt0 first interrupt-driven parallel port device .It Pa /dev/lpa0 first polled parallel port device .El +.Sh SEE ALSO +.Xr ulpt 4 diff --git a/share/man/man4/man4.i386/mcd.4 b/share/man/man4/man4.i386/mcd.4 index 4c7e6047614..824e7334acd 100644 --- a/share/man/man4/man4.i386/mcd.4 +++ b/share/man/man4/man4.i386/mcd.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mcd.4,v 1.5 1999/07/09 13:35:44 aaron Exp $ +.\" $OpenBSD: mcd.4,v 1.6 2000/07/05 13:46:53 aaron Exp $ .\" .\" Copyright (c) 1994 James A. Jegers .\" All rights reserved. @@ -37,7 +37,10 @@ The driver provides support for Mitsumi CD-ROM drives and controllers. .Pp .Sh FILES -.Xr /dev/mcd* -.Xr /dev/rmcd* +.Bl -tag -width /dev/rmcdx -compact +.It Pa /dev/mcd* +.It Pa /dev/rmcd* .Sh SEE ALSO -.Xr intro 4 +.Xr cd 4 , +.Xr intro 4 , +.Xr scd 4 diff --git a/share/man/man4/man4.i386/mem.4 b/share/man/man4/man4.i386/mem.4 index 1847a96b4ea..84e19312317 100644 --- a/share/man/man4/man4.i386/mem.4 +++ b/share/man/man4/man4.i386/mem.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mem.4,v 1.3 2000/04/27 00:35:57 deraadt Exp $ +.\" $OpenBSD: mem.4,v 1.4 2000/07/05 13:46:53 aaron Exp $ .\" .\" Copyright (c) 1991 The Regents of the University of California. .\" All rights reserved. @@ -42,19 +42,19 @@ .Nd memory files .Sh DESCRIPTION The special file -.Nm /dev/mem +.Pa /dev/mem is an interface to the physical memory of the computer. Byte offsets in this file are interpreted as physical memory addresses. Reading and writing this file is equivalent to reading and writing memory itself. Only offsets within the bounds of -.Nm /dev/mem +.Pa /dev/mem are allowed. .Pp Kernel virtual memory is accessed through the interface -.Nm /dev/kmem +.Pa /dev/kmem in the same manner as -.Nm /dev/mem . +.Pa /dev/mem . Only kernel virtual addresses that are currently mapped to memory are allowed. .Pp On @@ -72,7 +72,7 @@ is long, and ends at virtual address 0xfe000000. .Pp -Writeability of these devices is controlled by the system +Writability of these devices is controlled by the system .Xr securelevel 7 . .Sh FILES .Bl -tag -width Pa -compact @@ -83,7 +83,8 @@ Writeability of these devices is controlled by the system .Xr securelevel 7 .Sh HISTORY The -.Nm mem , -.Nm kmem +.Pa /dev/mem +and +.Pa /dev/kmem files appeared in .At v6 . diff --git a/share/man/man4/man4.i386/mtrr.4 b/share/man/man4/man4.i386/mtrr.4 index bafb155ec41..44dd21099fd 100644 --- a/share/man/man4/man4.i386/mtrr.4 +++ b/share/man/man4/man4.i386/mtrr.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mtrr.4,v 1.4 2000/04/03 21:19:38 aaron Exp $ +.\" $OpenBSD: mtrr.4,v 1.5 2000/07/05 13:46:53 aaron Exp $ .\" .\" Pentium MTRR driver for OpenBSD. .\" Copyright 1999 Matthieu Herrb <matthieu@openbsd.org> @@ -24,7 +24,8 @@ MTRRs on Pentiums. .Pp .Ss IOCTL INTERFACE Several architectures allow attributes to be associated with ranges of physical -memory. These attributes can be manipulated via +memory. +These attributes can be manipulated via .Fn ioctl calls performed on .Pa /dev/mem @@ -34,17 +35,18 @@ Declarations and data types are to be found in .Aq Pa memrange.h .Pp The specific attributes, and number of programmable ranges may vary between -architectures. The full set of supported attributes is: +architectures. +The full set of supported attributes is: .Bl -tag -width MDF_WRITECOMBINE -.It MDF_UNCACHEABLE +.It Dv MDF_UNCACHEABLE The region is not cached. -.It MDF_WRITECOMBINE +.It Dv MDF_WRITECOMBINE Writes to the region may be combined or performed out of order. -.It MDF_WRITETHROUGH +.It Dv MDF_WRITETHROUGH Writes to the region are committed synchronously. -.It MDF_WRITEBACK +.It Dv MDF_WRITEBACK Writes to the region are committed asynchronously. -.It MDF_WRITEPROTECT +.It Dv MDF_WRITEPROTECT The region cannot be written to. .El .Pp @@ -63,19 +65,19 @@ may also be set in the .Fa mr_flags field: .Bl -tag -width MDF_FIXACTIVE -.It MDF_FIXBASE +.It Dv MDF_FIXBASE The region's base address cannot be changed. -.It MDF_FIXLEN +.It Dv MDF_FIXLEN The region's length cannot be changed. -.It MDF_FIRMWARE -The region is believed to have been established by the system firmare. -.It MDF_ACTIVE +.It Dv MDF_FIRMWARE +The region is believed to have been established by the system firmware. +.It Dv MDF_ACTIVE The region is currently active. -.It MDF_BOGUS +.It Dv MDF_BOGUS We believe the region to be invalid or otherwise erroneous. -.It MDF_FIXACTIVE +.It Dv MDF_FIXACTIVE The region cannot be disabled. -.It MDF_BUSY +.It Dv MDF_BUSY The region is currently owned by another process and may not be altered. .El @@ -90,18 +92,23 @@ struct mem_range_op { .Pp The .Fa MEMRANGE_GET -ioctl is used to retrieve current memory range attributes. If +ioctl is used to retrieve current memory range attributes. +If .Fa mo_arg[0] is set to 0, it will be updated with the total number of memory range -descriptors. If greater than 0, the array at +descriptors. +If greater than 0, the array at .Fa mo_desc will be filled with a corresponding number of descriptor structures, or the maximum, whichever is less. .Pp The .Fa MEMRANGE_SET -ioctl is used to add, alter and remove memory range attributes. A range -with the MDF_FIXACTIVE flag may not be removed; a range with the MDF_BUSY +ioctl is used to add, alter and remove memory range attributes. +A range with the +.Dv MDF_FIXACTIVE +flag may not be removed; a range with the +.Dv MDF_BUSY flag may not be removed or updated. .Pp .Fa mo_arg[0] @@ -113,7 +120,7 @@ or establish a new range, or to MEMRANGE_SET_REMOVE to remove a range. .It Bq Er EOPNOTSUPP Memory range operations are not supported on this architecture. .It Bq Er ENXIO -No memory range descriptors are available (eg. firmware has not enabled +No memory range descriptors are available (e.g., firmware has not enabled any). .It Bq Er EINVAL The memory range supplied as an argument is invalid or overlaps another @@ -122,7 +129,7 @@ range in a fashion not supported by this architecture. An attempt to remove or update a range failed because the range is busy. .It Bq Er ENOSPC An attempt to create a new range failed due to a shortage of hardware -resources (eg. descriptor slots). +resources (e.g., descriptor slots). .It Bq Er ENOENT An attempt to remove a range failed because no range matches the descriptor base/length supplued. diff --git a/share/man/man4/man4.i386/npx.4 b/share/man/man4/man4.i386/npx.4 index 792a289c64f..fd6786032de 100644 --- a/share/man/man4/man4.i386/npx.4 +++ b/share/man/man4/man4.i386/npx.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: npx.4,v 1.6 1998/07/12 09:55:30 downsj Exp $ +.\" $OpenBSD: npx.4,v 1.7 2000/07/05 13:46:53 aaron Exp $ .\" .\" Copyright (c) 1993 Christopher G. Demetriou .\" All rights reserved. @@ -42,25 +42,29 @@ Numeric Processing Extension coprocessor and emulator .Cd "npx0 at isa? port" \&"IO_NPX0\&" irq 13 .Sh DESCRIPTION The -.Nm npx +.Nm driver enables the use of the system's Numeric Processing Extension coprocessor, -if one is present. Numeric processing extensions are present in -systems with -.Nm 486DX +if one is present. +Numeric processing extensions are present in systems with +.Tn 486DX CPUs and in systems with -.Nm 387 +.Tn 387 or -.Nm 487SX -coprocessors. The -.Nm npx +.Tn 487SX +coprocessors. +The +.Nm driver is required for proper system functioning regardless of whether or not a NPX is present. .Pp -If there is no NPX present in the system, either the "MATH_EMULATE" -option or the "GPL_MATH_EMULATE" option must be defined in the kernel -configuration file. It will provide support for the instructions normally -executed by the NPX. If there is no NPX in the system and the kernel +If there is no NPX present in the system, either +.Ic option MATH_EMULATE +or +.Ic option GPL_MATH_EMULATE +must be defined in the kernel configuration file. +It will provide support for the instructions normally executed by the NPX. +If there is no NPX in the system and the kernel is not built with math emulation, the system will not boot. .Sh CAVEATS The emulator is much slower than the NPX coprocessor. @@ -68,10 +72,11 @@ The emulator is much slower than the NPX coprocessor. This will result in poor floating-point math performance if the emulator must be used. .Sh BUGS -There are lots of them, especially on cheap motherboards. In particular, -some motherboards do not have the interrupt lines from the NPX to -the CPU wired properly. If this is the case, the emulator must be used -if consistent system operation is desired. +There are lots of them, especially on cheap motherboards. +In particular, some motherboards do not have the interrupt lines from the NPX +to the CPU wired properly. +If this is the case, the emulator must be used if consistent system operation +is desired. .Pp Emulation of the transcendental functions instructions is incorrect. Emulation of other instructions is suspect. diff --git a/share/man/man4/man4.i386/pctr.4 b/share/man/man4/man4.i386/pctr.4 index 590c144a100..df7f5583d4b 100644 --- a/share/man/man4/man4.i386/pctr.4 +++ b/share/man/man4/man4.i386/pctr.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pctr.4,v 1.10 1999/06/05 13:18:35 aaron Exp $ +.\" $OpenBSD: pctr.4,v 1.11 2000/07/05 13:46:53 aaron Exp $ .\" .\" Pentium performance counter driver for OpenBSD. .\" Copyright 1996 David Mazieres <dm@lcs.mit.edu>. @@ -13,7 +13,7 @@ .Os .Sh NAME .Nm pctr -.Nd driver for cpu performance counters +.Nd driver for CPU performance counters .Sh SYNOPSIS .Cd pseudo-device pctr .Sh DESCRIPTION @@ -31,8 +31,8 @@ There is one .Em ioctl call to read the status of all counters, and one .Em ioctl -call to program the function of each counter. All require the -following includes: +call to program the function of each counter. +All require the following includes: .Bd -literal -offset indent #include <sys/types.h> #include <machine/cpu.h> @@ -64,7 +64,8 @@ ioctls (see bellow). .Dv pctr_hwc contains the actual value of the two hardware counters. .Dv pctr_tsc -is a free-running, 64-bit cycle counter. Finally, +is a free-running, 64-bit cycle counter. +Finally, .Dv pctr_idl is a 64-bit count of idle-loop iterations. @@ -92,8 +93,8 @@ The meaning of this integer is dependent on the particular CPU. .\" .Ed .Ss Time stamp counter The time stamp counter is available on all machines with Pentium and -Pentium Pro counters, as well as on some 486s and non-intel CPUs. It -is set to zero at boot time, and then increments with each cycle. +Pentium Pro counters, as well as on some 486s and non-intel CPUs. +It is set to zero at boot time, and then increments with each cycle. Because the counter is 64-bits wide, it does not overflow. .Pp The time stamp counter can be read directly from user-mode using @@ -124,15 +125,15 @@ The value of the time stamp counter is also returned by the so that one can get an exact timestamp on readings of the hardware event counters. .Ss Pentium counters -The Pentium counters are programmed with a 9 bit function. The top -three bits contain the following flags: +The Pentium counters are programmed with a 9 bit function. +The top three bits contain the following flags: .Pp .Bl -tag -width P5CTR_C .It Dv P5CTR_K Enables counting of events that occur in kernel mode. .It Dv P5CTR_U -Enables counting of events that occur in user mode. You must set at -least one of +Enables counting of events that occur in user mode. +You must set at least one of .Dv P5CTR_U and .Dv P5CTR_K @@ -143,11 +144,11 @@ cycles spent servicing a particular event, rather than simply the number of occurrences of that event. .El .Pp -The bottom 6 bits set the particular event counted. Here is the event -type of each permissible value for the bottom 6 bits of the counter -function: +The bottom 6 bits set the particular event counted. +Here is the event type of each permissible value for the bottom 6 bits of the +counter function: .Pp -.Bl -tag -width "0x00" -compact -offset indent +.Bl -tag -width 0x00 -compact -offset indent .It 0x00 Data read .It 0x01 @@ -226,13 +227,14 @@ Data read or data write Data read miss or data write miss .El .Ss Pentium Pro counters -The Pentium Pro counter functions contain several parts. The most -significant byte (an 8-bit integer shifted left by +The Pentium Pro counter functions contain several parts. +The most significant byte (an 8-bit integer shifted left by .Dv P6CTR_CM_SHIFT ) contains a .Em "counter mask" . \& If non-zero, this sets a threshold for the number of times an event -must occur in one cycle for the counter to be incremented. The +must occur in one cycle for the counter to be incremented. +The .Em "counter mask" can therefore be used to count cycles in which an event occurs at least some number of times. @@ -242,20 +244,22 @@ The next byte contains several flags: .It Dv P6CTR_U Enables counting of events that occur in user mode. .It Dv P6CTR_K -Enables counting of events that occur in kernel mode. You must set at -least one of +Enables counting of events that occur in kernel mode. +You must set at least one of .Dv P6CTR_K and .Dv P6CTR_U to count anything. .It Dv P6CTR_E -Counts edges rather than cycles. For some functions this allows you +Counts edges rather than cycles. +For some functions this allows you to get an estimate of the number of events rather than the number of cycles occupied by those events. .It Dv P6CTR_EN -Enable counters. This bit must be set in the function for counter 0 -in order for either of the counters to be enabled. This bit should -probably be set in counter 1 as well. +Enable counters. +This bit must be set in the function for counter 0 +in order for either of the counters to be enabled. +This bit should probably be set in counter 1 as well. .It Dv P6CTR_I Inverts the sense of the .Em "counter mask" . \& @@ -268,8 +272,8 @@ events than specified in the .Pp The next byte, also known as the .Em "unit mask" , -contains flags specific to the event being counted. For events -dealing with the L2 cache, the following flags are valid: +contains flags specific to the event being counted. +For events dealing with the L2 cache, the following flags are valid: .Pp .Bl -tag -width P6CTR_UM_M .It Dv P6CTR_UM_M @@ -281,8 +285,8 @@ Count events involving shared cache lines. .It Dv P6CTR_UM_I Count events involving invalid cache lines. .El -To measure all L2 cache activity, all these bits should be set. They -can be set with the macro +To measure all L2 cache activity, all these bits should be set. +They can be set with the macro .Dv P6CTR_UM_MESI which contains the bitwise or of all of the above. .Pp @@ -296,7 +300,8 @@ processor. .El .Pp Finally, the least significant byte of the counter function is the -event type to count. The following values are available: +event type to count. +The following values are available: .Pp .Bl -tag -width 0x00 -compact .It 0x03 LD_BLOCKS @@ -347,8 +352,8 @@ Total lines allocated in the DCU. .It 0x46 DCU_M_LINES_IN Number of M state lines allocated in the DCU. .It 0x47 DCU_M_LINES_OUT -Number of M state lines evicted from the DCU. This includes evictions -via snoop HITM, intervention or replacement +Number of M state lines evicted from the DCU. +This includes evictions via snoop HITM, intervention or replacement .It 0x48 DCU_MISS_OUTSTANDING Weighted number of cycles while a DCU miss is outstanding. .It 0x60 BUS_REQ_OUTSTANDING @@ -455,31 +460,19 @@ Events marked /a can take the bit. .Pp Unlike the Pentium counters, the Pentium Pro counters can be read -directly from user-mode without need to invoke the kernel. The macro +directly from user-mode without need to invoke the kernel. +The macro .Fn rdpmc ctr takes 0 or 1 as an argument to specify a counter, and returns that counter's 40-bit value (which will be of type .Dv pctrval ) . This is generally preferable to making a system call as it introduces -less distortion in measurements. However, you should be aware of the -possibility of an interrupt between invocations of +less distortion in measurements. +However, you should be aware of the possibility of an interrupt between +invocations of .Fn rdpmc and/or .Fn rdtsc . -.Sh SEE ALSO -.Xr pctr 1 -.Sh FILES -.Pa /dev/pctr -.Sh HISTORY -A -.Nm -device first appeared in -.Ox 2.0 . -.Sh AUTHORS -The -.Nm -device was written by David Mazieres -.Aq dm@lcs.mit.edu . .Sh ERRORS .Bl -tag -width "[ENODEV]" .It Bq Er ENODEV @@ -495,6 +488,22 @@ or An attempt was made to set the counter functions, but the device was not open for writing. .El +.Sh FILES +.Bl -tag -width /dev/pctr -compact +.It Pa /dev/pctr +.El +.Sh SEE ALSO +.Xr pctr 1 +.Sh HISTORY +A +.Nm +device first appeared in +.Ox 2.0 . +.Sh AUTHORS +The +.Nm +device was written by David Mazieres +.Aq dm@lcs.mit.edu . .Sh BUGS -Not all counter functions are completely accurate. Some of the -functions don't seem to make any sense at all. +Not all counter functions are completely accurate. +Some of the functions don't seem to make any sense at all. diff --git a/share/man/man4/man4.i386/pss.4 b/share/man/man4/man4.i386/pss.4 index e72200d68aa..d419ee65ef9 100644 --- a/share/man/man4/man4.i386/pss.4 +++ b/share/man/man4/man4.i386/pss.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pss.4,v 1.4 1998/05/12 09:29:49 provos Exp $ +.\" $OpenBSD: pss.4,v 1.5 2000/07/05 13:46:53 aaron Exp $ .\" $NetBSD: pss.4,v 1.3 1997/10/05 21:42:20 augustss Exp $ .\" .\" Copyright (c) 1995 Michael Long. @@ -39,15 +39,16 @@ .Sh DESCRIPTION The .Nm -driver supports soundcards based on ESC614 or ESC614A ASICs and AD1848 -or CS4231 series codecs. Known examples are: +driver supports sound cards based on ESC614 or ESC614A ASICs and AD1848 +or CS4231 series codecs. +Known examples are: .Pp .Bl -tag -width -offset indent -compact .It Cardinal Digital Sound Pro 16 .It Orchid SoundWave 32 .El .Pp -The Orchid GameWave 32 is based on the ESC614 ASIC, but is not +The Orchid GameWave 32 is based on the ESC614 ASIC, but not supported because it does not have a codec. .Pp The @@ -63,10 +64,10 @@ This driver doesn't work yet. The list of cards using the PSS chipset is incomplete. .Pp The ESC614 (version 1) is unable to reliably determine whether DMA -channels are free on some motherboards. The ASIC determines that all -channels are taken, even if that is untrue. When this happens, the driver -cannot verify configured DMA channels with the ASIC's DMA autodetect -hardware, so it blindly accepts the user setting. +channels are free on some motherboards. +The ASIC determines that all channels are taken, even if that is untrue. +When this happens, the driver cannot verify configured DMA channels with the +ASIC's DMA autodetect hardware, so it blindly accepts the user setting. .Pp Cards based on the ESC615 ASIC are not supported. .Pp diff --git a/share/man/man4/man4.i386/sb.4 b/share/man/man4/man4.i386/sb.4 index a42690e0c08..0e1982338a4 100644 --- a/share/man/man4/man4.i386/sb.4 +++ b/share/man/man4/man4.i386/sb.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sb.4,v 1.7 1998/05/12 09:29:50 provos Exp $ +.\" $OpenBSD: sb.4,v 1.8 2000/07/05 13:46:53 aaron Exp $ .\" $NetBSD: sb.4,v 1.13 1997/10/31 15:02:33 augustss Exp $ .\" .\" Copyright (c) 1996 The NetBSD Foundation, Inc. @@ -60,21 +60,32 @@ the particular model). The base I/O port address is usually jumper-selected to either 0x220 or 0x240 (newer cards may provide software configuration, but this driver does not directly support them--you must configure the card for its I/O -addresses with other software). The SoundBlaster takes 16 I/O ports. +addresses with other software). +The SoundBlaster takes 16 I/O ports. For the SoundBlaster and SoundBlaster Pro, the IRQ and DRQ channels are -jumper-selected. For the SoundBlaster 16, the IRQ and DRQ channels are -set by this driver to the values specified in the config file. The IRQ -must be selected from the set {5,7,9,10}. +jumper-selected. +For the SoundBlaster 16, the IRQ and DRQ channels are set by this driver +to the values specified in the config file. +The IRQ must be selected from the set {5,7,9,10}. .Pp The configuration file must use 1 .Cm flags -specification to enable the Jazz16 support. This is to avoid potential -conflicts with other devices when probing the Jazz 16 because it requires -use of extra I/O ports not in the base port range. -.Pp +specification to enable the Jazz16 support. +This is to avoid potential conflicts with other devices when probing the +Jazz 16 because it requires use of extra I/O ports not in the base port range. +.Sh SEE ALSO +.Xr aic 4 , +.Xr audio 4 , +.Xr joy 4 +.Sh HISTORY +The +.Nm sb +device driver appeared in +.Nx 1.0 . .Sh BUGS With a SoundBlaster 16 card the device is full duplex, but it can -only sensibly handle a precision of 8 bits. It does so by extending +only sensibly handle a precision of 8 bits. +It does so by extending the output 8 bit samples to 16 bits and using the 8 bit DMA channel for input and the 16 bit channel for output. .Pp @@ -83,15 +94,6 @@ The joystick interface (if enabled by a jumper) is handled by the driver, and the optional SCSI CD-ROM interface is handled by the .Xr aic 4 driver. -.Sh BUGS +.Pp The FM synthesizer, MIDI port, and non-SCSI CD-ROM interfaces are not supported. -.Sh SEE ALSO -.Xr aic 4 , -.Xr audio 4 , -.Xr joy 4 -.Sh HISTORY -The -.Nm sb -device driver appeared in -.Nx 1.0 . diff --git a/share/man/man4/man4.i386/scd.4 b/share/man/man4/man4.i386/scd.4 index ba0913f2510..6e9489457fb 100644 --- a/share/man/man4/man4.i386/scd.4 +++ b/share/man/man4/man4.i386/scd.4 @@ -1,5 +1,4 @@ -.\" -.\" $OpenBSD: scd.4,v 1.3 1999/07/09 13:35:44 aaron Exp $ +.\" $OpenBSD: scd.4,v 1.4 2000/07/05 13:46:53 aaron Exp $ .\" .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions @@ -31,12 +30,16 @@ .Cd "scd0 at isa? port 0x340" .Sh DESCRIPTION The -.Nm scd +.Nm driver provides support for Sony CD-ROM drives and controllers. Supported drives are CDU-31A and CDU-33A. .Pp .Sh FILES -.Xr /dev/scd* -.Xr /dev/rscd* +.Bl -tag -width /dev/rscd* -compact +.It Pa /dev/scd* +.It Pa /dev/rscd* +.El .Sh SEE ALSO -.Xr intro 4 +.Xr cd 4 , +.Xr intro 4 , +.Xr mcd 4 diff --git a/share/man/man4/man4.i386/speaker.4 b/share/man/man4/man4.i386/speaker.4 index 4a11de9cfbf..ae7f8e87759 100644 --- a/share/man/man4/man4.i386/speaker.4 +++ b/share/man/man4/man4.i386/speaker.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: speaker.4,v 1.8 1999/09/23 04:12:06 alex Exp $ +.\" $OpenBSD: speaker.4,v 1.9 2000/07/05 13:46:53 aaron Exp $ .\" $NetBSD: speaker.4,v 1.9 1998/08/18 08:16:56 augustss Exp $ .\" .\" Copyright (c) 1993 Christopher G. Demetriou @@ -36,77 +36,142 @@ speaker \- console speaker device driver .Sh SYNOPSIS .Cd "spkr0 at pcppi?" -.Fd #include <machine/spkr.h> -.Pa /dev/speaker .Sh DESCRIPTION The speaker device driver allows applications to control the PC console speaker on an IBM-PC-compatible machine running UNIX. .Pp -Only one process may have this device open at any given time; open() and -close() are used to lock and relinquish it. An attempt to open() when -another process has the device locked will return -1 with an EBUSY error -indication. Writes to the device are interpreted as 'play strings' in a -simple ASCII melody notation. An ioctl() for tone generation at arbitrary -frequencies is also supported. -.Pp -Sound-generation does \fInot\fR monopolize the processor; in fact, the driver -spends most of its time sleeping while the PC hardware is emitting -tones. Other processes may emit beeps while the driver is running. -.Pp -Applications may call ioctl() on a speaker file descriptor to control the -speaker driver directly; definitions for the ioctl() interface are in -<machine/spkr.h>. The tone_t structure used in these calls has two fields, +Only one process may have this device open at any given time; +.Xr open 2 +and +.Xr close 2 +are used to lock and relinquish it. +An attempt to +.Fn open +whenanother process has the device locked will return \-1 with an +.Er EBUSY +error indication. +Writes to the device are interpreted as +.Dq play strings +in a simple ASCII melody notation. +An +.Fn ioctl +for tone generation at arbitrary frequencies is also supported. +.Pp +Sound-generation does +.Em not +monopolize the processor; in fact, the driver +spends most of its time sleeping while the PC hardware is emitting tones. +Other processes may emit beeps while the driver is running. +.Pp +Applications may call +.Fn ioctl +on a speaker file descriptor to control the speaker driver directly; +definitions for the +.Fn ioctl +interface are in +.Aq Pa machine/spkr.h . +The +.Li tone_t +structure used in these calls has two fields, specifying a frequency (in hz) and a duration (in 1/100ths of a second). A frequency of zero is interpreted as a rest. .Pp -At present there are two such ioctls. SPKRTONE accepts a pointer to a -single tone structure as third argument and plays it. SPKRTUNE accepts a -pointer to the first of an array of tone structures and plays them in -continuous sequence; this array must be terminated by a final member with -a zero duration. +At present there are two such ioctls. +The +.Dv SPKRTONE +ioctl accepts a pointer to a single tone structure as a third argument and +plays it. +The +.Dv SPKRTUNE +ioctl accepts a pointer to the first of an array of tone structures and plays +them in continuous sequence; this array must be terminated by a final member +with a zero duration. .Pp The play-string language is modelled on the PLAY statement conventions of -IBM BASIC 2.0. The MB, MF and X primitives of PLAY are not useful in a UNIX -environment and are omitted. The `octave-tracking' feature is also new. +IBM BASIC 2.0. +The MB, MF and X primitives of PLAY are not useful in a UNIX environment and +are omitted. +The +.Dq octave-tracking +feature is also new. .Pp There are 84 accessible notes numbered 1-83 in 7 octaves, each running from C to B, numbered 0-6; the scale is equal-tempered A440 and octave 3 starts -with middle C. By default, the play function emits half-second notes with the -last 1/16th second being `rest time'. +with middle C. +By default, the play function emits half-second notes with the last 1/16th +second being +.Dq rest time . .Pp Play strings are interpreted left to right as a series of play command groups; -letter case is ignored. Play command groups are as follows: -.Pp -CDEFGAB -- letters A through G cause the corresponding note to be played in the -current octave. A note letter may optionally be followed by an \fIaccidental -sign\fR, one of # + or -; the first two of these cause it to be sharped one -half-tone, the last causes it to be flatted one half-tone. It may also be -followed by a time value number and by sustain dots (see below). Time values -are interpreted as for the L command below;. -.Pp -O <n> -- if <n> is numeric, this sets the current octave. <n> may also be one -of 'L' or 'N' to enable or disable octave-tracking (it is disabled by default). +letter case is ignored. +Play command groups are as follows: +.Bl -tag -width xxx +.It CDEFGAB +Letters A through G cause the corresponding note to be played in the current +octave. +A note letter may optionally be followed by an +.Dq accidental sign , +one of +.Ql # , +.Ql + , +or +.Ql - ; +the first two of these cause it to be sharped one half-tone, the last causes +it to be flatted one half-tone. +It may also be followed by a time value number and by sustain dots (see below). +Time values are interpreted as for the L command below;. +.It O Aq Ar n +If +.Ar n +is numeric, this sets the current octave. +.Ar n +may also be one of +.Sq L +or +.Sq N +to enable or disable octave-tracking (it is disabled by default). When octave-tracking is on, interpretation of a pair of letter notes will change octaves if necessary in order to make the smallest possible jump between -notes. Thus "olbc" will be played as "olb>c", and "olcb" as "olc<b". Octave -locking is disabled for one letter note following by >, < and O[0123456]. -.Pp +notes. +Thus +.Qq olbc +will be played as +.Qq olb>c , +and +.Qq olcb +as +.Qq olc<b . +Octave locking is disabled for one letter note following by +.Ql > , +.Ql < , +and +.Ql O[0123456] . +.Pp +.Bd -literal -offset indent > -- bump the current octave up one. -.Pp < -- drop the current octave down one. -.Pp -N <n> -- play note n, n being 1 to 84 or 0 for a rest of current time value. +.Ed +.It N Aq Ar n +Play note +.Ar n , +.Ar n +being 1 to 84 or 0 for a rest of current time value. May be followed by sustain dots. -.Pp -L <n> -- sets the current time value for notes. The default is L4, quarter -notes. The lowest possible value is 1; values up to 64 are accepted. L1 sets -whole notes, L2 sets half notes, L4 sets quarter notes, etc.. -.Pp -P <n> -- pause (rest), with <n> interpreted as for L. May be followed by -sustain dots. May also be written '~'. -.Pp -T <n> -- Sets the number of quarter notes per minute; default is 120. Musical -names for common tempi are: +.It L Aq Ar n +Sets the current time value for notes. +The default is L4, quarter notes. +The lowest possible value is 1; values up to 64 are accepted. +L1 sets whole notes, L2 sets half notes, L4 sets quarter notes, etc. +.It P Aq Ar n +Pause (rest), with +.Ar n +interpreted as for L. +May be followed by sustain dots. +May also be written +.Ql ~ . +.It T Aq Ar n +Sets the number of quarter notes per minute; default is 120. +Musical names for common tempi are: .Bl -column Description Tempo BPM -offset indent .Em Tempo Beats per Minute very slow Larghissimo @@ -126,18 +191,29 @@ fast Allegretto Presto 168-208 very fast Prestissimo .El -.Pp -M[LNS] -- set articulation. MN (N for normal) is the default; the last 1/8th of -the note's value is rest time. You can set ML for legato (no rest space) or -MS (staccato) 1/4 rest space. +.It M[LNS] +Set articulation. +MN (N for normal) is the default; the last 1/8th of the note's value is rest +time. +You can set ML for legato (no rest space) or MS (staccato) 1/4 rest space. +.El .Pp Notes (that is, CDEFGAB or N command character groups) may be followed by -sustain dots. Each dot causes the note's value to be lengthened by one-half -for each one. Thus, a note dotted once is held for 3/2 of its undotted value; +sustain dots. +Each dot causes the note's value to be lengthened by one-half for each one. +Thus, a note dotted once is held for 3/2 of its undotted value; dotted twice, it is held 9/4, and three times would give 27/8. .Pp Whitespace in play strings is simply skipped and may be used to separate melody sections. +.Sh FILES +.Bl -tag -width Pa -compact +.It Pa /dev/speaker +.El +.\" .Sh SEE ALSO +.\" .Xr pcppi 4 . +.Sh AUTHOR +Eric S. Raymond (esr@snark.thyrsus.com) Feb 1990 .Sh BUGS Due to roundoff in the pitch tables and slop in the tone-generation and timer hardware (neither of which was designed for precision), neither pitch accuracy @@ -148,11 +224,3 @@ There is no volume control. In play strings which are very long (longer than your system's physical I/O blocks) note suffixes or numbers may occasionally be parsed incorrectly due to crossing a block boundary. -.Sh FILES -.Bl -tag -width Pa -compact -.It Pa /dev/speaker -.El -.\" .Sh SEE ALSO -.\" .Xr pcppi 4 . -.Sh AUTHOR -Eric S. Raymond (esr@snark.thyrsus.com) Feb 1990 diff --git a/share/man/man4/man4.i386/wdt.4 b/share/man/man4/man4.i386/wdt.4 index f6dadfd2e04..a89c98c37c5 100644 --- a/share/man/man4/man4.i386/wdt.4 +++ b/share/man/man4/man4.i386/wdt.4 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $OpenBSD: wdt.4,v 1.1 1999/04/28 23:20:56 alex Exp $ +.\" $OpenBSD: wdt.4,v 1.2 2000/07/05 13:46:53 aaron Exp $ .\" .Dd April 25, 1999 .Dt WDT 4 i386 @@ -42,14 +42,16 @@ PCI-WDT500 and PCI-WDT501 boards. For PCI-WDT500 boards, basic watchdog timer functionality is supported. For PCI-WDT501 boards, additional access to the onboard buzzer, isolated inputs, temperature, and power supply monitors is provided. -To disable the onboard buzzer on PCI-WDT501 boards, add the -.Em WDT_DISABLE_BUZZER -option to your kernel configuration. +To disable the onboard buzzer on PCI-WDT501 boards, add +.Ic option WDT_DISABLE_BUZZER +to your kernel configuration. .Pp By default the watchdog timer is set to 30 seconds and is refreshed -by the kernel's timeout processing. If the kernel crashes, the watchdog +by the kernel's timeout processing. +If the kernel crashes, the watchdog timer is not reset and the system will reboot (assuming a proper connection -is made between the WDT50x and motherboard). Alternatively, the watchdog +is made between the WDT50x and motherboard). +Alternatively, the watchdog can be reinitialized via a userland process which insures that process scheduling, not just kernel timeout processing, is still taking place. See the @@ -74,11 +76,13 @@ See for the definition of the wdt_state structure and state bits. .It Dv WIOCSCHED Places the process into an infinite loop (interrupted only via a signal) -to guarantee process scheduling. The driver utilizes the process' -context to reinitialize the watchdog timeout. Should process -scheduling fail, the timeout will not be reinitialized and the system -will be rebooted. Note that it is possible to force a reboot by sending -a SIGSTOP signal to a process in +to guarantee process scheduling. +The driver utilizes the process' context to reinitialize the watchdog timeout. +Should process scheduling fail, the timeout will not be reinitialized and the +system will be rebooted. +Note that it is possible to force a reboot by sending a +.Dv SIGSTOP +signal to a process in .Dv WIOCSCHED and waiting for the watchdog timer to expire. Since @@ -90,11 +94,9 @@ processes regardless of the permissions on .Sh FILES .Bl -tag -width /usr/include/dev/pci/wdt50x.h -compact .It Pa /dev/wdt0 -Watchdog control device. +watchdog control device .It Pa /usr/include/dev/pci/wdt50x.h -Structure and ioctl definitions to interface with the -.Nm -driver. +structure and ioctl definitions .El .Sh SEE ALSO .Xr ioctl 2 diff --git a/share/man/man4/man4.i386/wss.4 b/share/man/man4/man4.i386/wss.4 index 6d2b6cbb37c..25f27bb246a 100644 --- a/share/man/man4/man4.i386/wss.4 +++ b/share/man/man4/man4.i386/wss.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: wss.4,v 1.7 2000/03/31 15:23:26 espie Exp $ +.\" $OpenBSD: wss.4,v 1.8 2000/07/05 13:46:54 aaron Exp $ .\" $NetBSD: wss.4,v 1.8 1998/01/19 20:22:30 augustss Exp $ .\" .\" Copyright (c) 1995 Michael Long. @@ -52,9 +52,9 @@ the DMA channel may be set to 0, 1, or 3. .Pp The configuration file must have bit 1 set in .Cm flags -to enable the MAD16 support. This is to avoid potential -conflicts with other devices when probing the MAD16 because it requires -use of extra I/O ports not in the base port range. +to enable the MAD16 support. +This is to avoid potential conflicts with other devices when probing the +MAD16 because it requires use of extra I/O ports not in the base port range. Bit 2 in .Cm flags disables the joystick port on MAD16 hardware. diff --git a/share/man/man4/man4.i386/wt.4 b/share/man/man4/man4.i386/wt.4 index 1477f50ecb7..db95256d239 100644 --- a/share/man/man4/man4.i386/wt.4 +++ b/share/man/man4/man4.i386/wt.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: wt.4,v 1.5 1999/07/09 13:35:44 aaron Exp $ +.\" $OpenBSD: wt.4,v 1.6 2000/07/05 13:46:54 aaron Exp $ .\" .\" Copyright (c) 1994 James A. Jegers .\" All rights reserved. @@ -40,6 +40,6 @@ driver provides support for the following Archive and Wangtek boards: .It QIC-02 .It QIC-36 .El -.Pp .Sh SEE ALSO -.Xr intro 4 +.Xr intro 4 , +.Xr st 4 diff --git a/share/man/man4/man4.i386/xf86.4 b/share/man/man4/man4.i386/xf86.4 index 9752f537b2f..6b962719777 100644 --- a/share/man/man4/man4.i386/xf86.4 +++ b/share/man/man4/man4.i386/xf86.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: xf86.4,v 1.9 1999/07/09 13:35:44 aaron Exp $ +.\" $OpenBSD: xf86.4,v 1.10 2000/07/05 13:46:54 aaron Exp $ .\" .\" Copyright (c) 1998 Matthieu Herrb .\" All rights reserved. @@ -47,7 +47,8 @@ Access to the .Pa /dev/xf86 device is allowed when the sysctl variable .Va machdep.allowaperture -= 1. This variable (which default value is 0) += 1. +This variable (which default value is 0) can only be manipulated when the security level is <= 0, so it should be set in .Pa /etc/sysctl.conf . @@ -61,10 +62,10 @@ set in .Sh HISTORY .Pa /dev/xf86 was introduced as a loadable kernel module for NetBSD 0.9C -with XFree86 3.1. It was integrated as an in-kernel device on +with XFree86 3.1. +It was integrated as an in-kernel device on .Ox 2.3 . -It is required in order to allow access to I/O ports for all X servers -since +It is required in order to allow access to I/O ports for all X servers since .Ox 2.4 . .Sh AUTHOR The aperture driver was written by Matthieu Herrb. |