diff options
Diffstat (limited to 'share')
228 files changed, 3170 insertions, 2495 deletions
diff --git a/share/man/man4/ami.4 b/share/man/man4/ami.4 index 612c53d4c11..56868fa9da5 100644 --- a/share/man/man4/ami.4 +++ b/share/man/man4/ami.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ami.4,v 1.7 2001/08/05 22:32:34 brad Exp $ +.\" $OpenBSD: ami.4,v 1.8 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 2001 Michael Shalayeff. All rights reserved. .\" @@ -21,14 +21,15 @@ These controllers support RAID 0, RAID 1, RAID 5, JBOD and superpositions of those configurations. .Pp Some cards support both I2O and so called `Mass Storage' mode -of operation. This driver only supports the `Mass Storage' mode, I2O -mode is supported by the +of operation. +This driver only supports the `Mass Storage' mode, I2O mode is supported +by the .Xr iop 4 driver. .Pp Although the controllers are actual RAID controllers the driver makes them -look just like SCSI controllers. All RAID configuration is done through -the controllers' BIOSes. +look just like SCSI controllers. +All RAID configuration is done through the controllers' BIOSes. .Xr iop 4 driver. .Sh SEE ALSO diff --git a/share/man/man4/atapiscsi.4 b/share/man/man4/atapiscsi.4 index 62e1a537da2..a9be1af15dd 100644 --- a/share/man/man4/atapiscsi.4 +++ b/share/man/man4/atapiscsi.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: atapiscsi.4,v 1.7 2001/04/05 20:10:39 deraadt Exp $ +.\" $OpenBSD: atapiscsi.4,v 1.8 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1999 Constantine Sapuntzakis. .\" @@ -72,8 +72,9 @@ mode settings (like some controllers). The lowest order (rightmost) nibble of the .Cm flags -define the PIO mode to use. The next four bits indicate the DMA mode and the -third nibble the UltraDMA mode. +define the PIO mode to use. +The next four bits indicate the DMA mode and the third nibble the UltraDMA +mode. .Pp For each set of four bits, the 3 lower bits define the mode to use and the last bit must be set to 1 for this setting to be used. diff --git a/share/man/man4/bpf.4 b/share/man/man4/bpf.4 index bed5f1a4d5c..c2384191200 100644 --- a/share/man/man4/bpf.4 +++ b/share/man/man4/bpf.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: bpf.4,v 1.11 2001/10/02 18:04:35 deraadt Exp $ +.\" $OpenBSD: bpf.4,v 1.12 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: bpf.4,v 1.7 1995/09/27 18:31:50 thorpej Exp $ .\" .\" Copyright (c) 1990 The Regents of the University of California. @@ -272,11 +272,12 @@ It defaults to .It Xo Dv BIOCSHDRCMPLT , Dv BIOCGHDRCMPLT ( .Li u_int Ns No ) .Xc -Set or get the status of the ``header complete'' flag. Set to zero if -the link level source address should be filled in automatically by the -the interface output routine. Set to one if the link level source -address will be written, as provided, to the wire. This flag is -initialized to zero by default. +Set or get the status of the ``header complete'' flag. +Set to zero if the link level source address should be filled in +automatically by the the interface output routine. +Set to one if the link level source address will be written, +as provided, to the wire. +This flag is initialized to zero by default. .El .Ss Standard ioctls .Nm diff --git a/share/man/man4/bridge.4 b/share/man/man4/bridge.4 index 51e80d49f39..5cc2e75198d 100644 --- a/share/man/man4/bridge.4 +++ b/share/man/man4/bridge.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: bridge.4,v 1.35 2001/08/03 15:21:16 mpech Exp $ +.\" $OpenBSD: bridge.4,v 1.36 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1999, 2000 Jason L. Wright (jason@thought.net) .\" All rights reserved. @@ -543,4 +543,5 @@ kernel interface first appeared in .Sh BUGS Incoming packets are only checked against .Xr pf 4 -input rules. There is no easy way to handle output rules. +input rules. +There is no easy way to handle output rules. diff --git a/share/man/man4/cac.4 b/share/man/man4/cac.4 index 26a4139d6d2..04709fca5e3 100644 --- a/share/man/man4/cac.4 +++ b/share/man/man4/cac.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cac.4,v 1.6 2001/07/13 17:33:32 pvalchev Exp $ +.\" $OpenBSD: cac.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 2000,2001 Michael Shalayeff. All rights reserved. .\" @@ -37,8 +37,8 @@ driver provides support for the following RAID controllers: All the RAID set volume management is done via the card BIOS. .Pp Although the controllers are actual RAID controllers the driver makes them -look just like SCSI controllers. All RAID configuration is done through -the controllers' BIOSes. +look just like SCSI controllers. +All RAID configuration is done through the controllers' BIOSes. .Sh SEE ALSO .Xr intro 4 , .Xr scsi 4 , diff --git a/share/man/man4/cz.4 b/share/man/man4/cz.4 index 8a13c339eca..ec2fa36e28e 100644 --- a/share/man/man4/cz.4 +++ b/share/man/man4/cz.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cz.4,v 1.3 2001/09/05 20:17:34 nate Exp $ +.\" $OpenBSD: cz.4,v 1.4 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: cz.4,v 1.3 2001/06/12 14:46:11 wiz Exp $ .\" .\" Copyright (c) 2000 Zembu Labs, Inc. @@ -54,25 +54,26 @@ Xilinx XC5204 FPGA IDT R3052 MIPS CPU .El .Pp -The MIPS CPU runs firmware provided by the device driver. Communication -with the MIPS is performed by modifying data structures located in board -local RAM or host RAM. +The MIPS CPU runs firmware provided by the device driver. +Communication with the MIPS is performed by modifying data structures located +in board local RAM or host RAM. .Pp The Cyclades-Z comes in three basic flavors: .Bl -bullet -offset indent .It -Cyclades-8Zo rev. 1 -- This is an older 8-port board with no FPGA. The -serial ports are provided by an octopus cable. +Cyclades-8Zo rev. 1 -- This is an older 8-port board with no FPGA. +The serial ports are provided by an octopus cable. .It -Cyclades-8Zo rev. 2 -- This is the newer 8-port board. The serial ports -are provided by an octopus cable. +Cyclades-8Zo rev. 2 -- This is the newer 8-port board. +The serial ports are provided by an octopus cable. .It -Cyclades-Ze -- This is the expandable version of the Cyclades-Z. It uses -an HD-50 SCSI cable to connect the board to a 1U rack mountable serial -expansion box. Each box has 16 RJ45 serial ports, and up to 4 boxes may -be chained together, for a total of 64 ports. Boxes 3 and 4 require their -own external power supply, otherwise the firmware will refuse to start -(as it cannot communicate with the UARTs in those boxes). +Cyclades-Ze -- This is the expandable version of the Cyclades-Z. +It uses an HD-50 SCSI cable to connect the board to a 1U rack mountable serial +expansion box. +Each box has 16 RJ45 serial ports, and up to 4 boxes may be chained together, +for a total of 64 ports. +Boxes 3 and 4 require their own external power supply, otherwise the firmware +will refuse to start (as it cannot communicate with the UARTs in those boxes). .El .Pp The Cyclades-Z has several features to improve performance under @@ -108,8 +109,8 @@ driver first appeared in .Sh BUGS The .Nm -driver does not currently implement communication via host RAM. While -this may improve performance by reducing the number of PCI memory +driver does not currently implement communication via host RAM. +While this may improve performance by reducing the number of PCI memory space read/write cycles, it is not straightforward to implement with the current .Xr bus_dma 9 diff --git a/share/man/man4/ec.4 b/share/man/man4/ec.4 index a39b8765b59..ae59ab51b83 100644 --- a/share/man/man4/ec.4 +++ b/share/man/man4/ec.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ec.4,v 1.10 2001/06/22 12:15:44 mpech Exp $ +.\" $OpenBSD: ec.4,v 1.11 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: ec.4,v 1.4 1998/08/09 00:39:02 thorpej Exp $ .\" .\" Copyright (c) 1997 The NetBSD Foundation, Inc. @@ -58,9 +58,10 @@ and .Xr xl 4 drivers. .Pp -The Etherlink II supports two media types on a single card. All support -the AUI media type. The other media is either BNC or UTP behind a -transceiver. Software cannot differentiate between BNC and UTP cards. +The Etherlink II supports two media types on a single card. +All support the AUI media type. +The other media is either BNC or UTP behind a transceiver. +Software cannot differentiate between BNC and UTP cards. .Pp The following media types and options (as given to .Xr ifconfig 8 ) @@ -82,15 +83,16 @@ For example, .Sh DIAGNOSTICS .Bl -diag .It "ec0: wildcarded IRQ is not allowed" -The IRQ was wildcarded in the kernel configuration file. This is not -supported. +The IRQ was wildcarded in the kernel configuration file. +This is not supported. .It "ec0: invalid IRQ <n>, must be 3, 4, 5, or 9" An IRQ other than the above listed IRQs was specified in the kernel -configuration file. The Etherlink II hardware only supports the -above listed IRQs. +configuration file. +The Etherlink II hardware only supports the above listed IRQs. .It "ec0: failed to clear shared memory at offset <off>" The memory test was unable to clear the interface's shared memory -region. This often indicates that the card is configured at a conflicting +region. +This often indicates that the card is configured at a conflicting .Em iomem address. .El diff --git a/share/man/man4/ep.4 b/share/man/man4/ep.4 index 33fe06f41ee..a1ddb5acee9 100644 --- a/share/man/man4/ep.4 +++ b/share/man/man4/ep.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ep.4,v 1.20 2001/06/22 12:15:45 mpech Exp $ +.\" $OpenBSD: ep.4,v 1.21 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1994 Herb Peyerl .\" All rights reserved. @@ -44,7 +44,8 @@ The .Nm device driver supports the 3Com EtherLink III and Fast EtherLink III family -of Ethernet cards. This includes, among others, the following models: +of Ethernet cards. +This includes, among others, the following models: .Pp .Bl -tag -width 3CXXXX -offset indent -compact .It 3C509 @@ -102,7 +103,8 @@ Set 10base2 (thin-net) operation (half-duplex only). .El .Pp Note that the 100baseTX media type is only available if supported by the -adapter. For more information on configuring this device, see +adapter. +For more information on configuring this device, see .Xr ifconfig 8 . To view a list of media types and options supported by your card try .Dq ifconfig -m <device> . @@ -124,18 +126,22 @@ in the following order: .El .Pp You may specify the port and IRQ numbers where the cards are expected to -be found, but it is not necessary. The cards are intelligent enough to -let us know where they live on the bus. +be found, but it is not necessary. +The cards are intelligent enough to let us know where they live on the bus. .Sh DIAGNOSTICS .Bl -diag .It ep0: reset (status: %x) -The driver has encountered a FIFO underrun or overrun. The driver will reset -the card and the packet will be lost. This is not fatal. +The driver has encountered a FIFO underrun or overrun. +The driver will reset the card and the packet will be lost. +This is not fatal. .It ep0: eeprom failed to come ready -The EEPROM failed to come ready. This probably means the card is wedged. +The EEPROM failed to come ready. +This probably means the card is wedged. .It ep0: 3c509 in test mode. Erase pencil mark! This means that someone has scribbled with pencil in the test area on the -card. Erase the pencil mark and reboot. (This is not a joke). +card. +Erase the pencil mark and reboot. +(This is not a joke). .El .Sh SEE ALSO .Xr ec 4 , diff --git a/share/man/man4/esis.4 b/share/man/man4/esis.4 index 10a6c6c8414..4791663dd9f 100644 --- a/share/man/man4/esis.4 +++ b/share/man/man4/esis.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: esis.4,v 1.6 2001/06/22 12:15:45 mpech Exp $ +.\" $OpenBSD: esis.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: esis.4,v 1.3 1994/11/30 16:22:12 jtc Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 @@ -63,7 +63,8 @@ addresses and addresses is accomplished by transmitting hello .Tn PDU Ns s -between the cooperating Systems. These +between the cooperating Systems. +These .Tn PDU Ns s are transmitted whenever the .Em configuration @@ -76,7 +77,8 @@ address that it conveys is stored in the routing table for as long as the .Em holding time in the .Tn PDU -suggests. The default +suggests. +The default .Em holding time (120 seconds) placed in the hello .Tn PDU , @@ -94,12 +96,13 @@ configured as an End System or an Intermediate System. When an interface requests a mapping for an address not in the cache, the .Tn SNPA -of any known Intermediate System is returned. If an Intermediate -System is not known, then the +of any known Intermediate System is returned. +If an Intermediate System is not known, then the .Em all end systems multicast address -is returned. It is assumed that the intended recipient of the NPDU will -immediately transmit a hello +is returned. +It is assumed that the intended recipient of the NPDU will immediately +transmit a hello .Tn PDU back to the originator of the .Tn NPDU . @@ -112,10 +115,10 @@ will not be generated. However, redirect .Tn PDU Ns s -received will be processed. This processing -consists of adding an entry in the routing table. If the -redirect is towards an Intermediate System, then an entry is made in the -routing table as well. +received will be processed. +This processing consists of adding an entry in the routing table. +If the redirect is towards an Intermediate System, then an entry is +made in the routing table as well. The entry in the routing table will mark the .Tn NSAP address contained in the redirect @@ -202,12 +205,13 @@ Redirect do not contain options from the forwarded .Tn NPDU which generated -the redirect. The multicast address used on the 802.3 network is taken from -the +the redirect. +The multicast address used on the 802.3 network is taken from the .Tn NBS -December 1987 agreements. This multicast address is not compatible -with the 802.5 (Token Ring) multicast addresses format. Therefore, broadcast -addresses are used on the 802.5 subnetwork. +December 1987 agreements. +This multicast address is not compatible with the 802.5 (Token Ring) +multicast addresses format. +Therefore, broadcast addresses are used on the 802.5 subnetwork. Researchers at the University of Wisconsin are constructing an implementation of the .Tn IS-IS diff --git a/share/man/man4/ess.4 b/share/man/man4/ess.4 index c5aa07c3b4a..6d2d3ba700b 100644 --- a/share/man/man4/ess.4 +++ b/share/man/man4/ess.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ess.4,v 1.3 2000/07/20 08:48:17 deraadt Exp $ +.\" $OpenBSD: ess.4,v 1.4 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: ess.4,v 1.6 1999/04/13 20:25:29 augustss Exp $ .\" .\" Copyright (c) 1999 The NetBSD Foundation, Inc. @@ -50,18 +50,21 @@ driver provides support for the ESS 1788, 1888, 1887, and 888 AudioDrive audio devices. .Pp The AudioDrive 1788 is a half-duplex device, while the 1888, 1887, and -888 are full-duplex. All are capable of 8- and 16-bit audio sample -recording and playback at rates up to 44.1kHz. +888 are full-duplex. +All are capable of 8- and 16-bit audio sample recording and playback +at rates up to 44.1kHz. .Pp -The AudioDrive takes 16 I/O ports. The I/O port range, IRQ, and DRQ -channels are set by the driver to the vaues specified in the -configuration file (or for isapnp or ofisa, the values assigned from -the firmware). The I/O port base must be one of 0x220, 0x230, 0x240, -0x250. The IRQ must be one of 5, 7, 9, 10 (or 15 on the 1887 -only). The first DRQ channel must be selected from 0, 1, 3. The second -DRQ channel (used for playback by the full-duplex 1888/1887, ignored -by the 1788) can additionally be set to 5. If both DRQ channels are -used they must be different. +The AudioDrive takes 16 I/O ports. +The I/O port range, IRQ, and DRQ channels are set by the driver +to the vaues specified in the configuration file (or for isapnp or ofisa, +the values assigned from the firmware). +The I/O port base must be one of 0x220, 0x230, 0x240, +0x250. +The IRQ must be one of 5, 7, 9, 10 (or 15 on the 1887 only). +The first DRQ channel must be selected from 0, 1, 3. +The second DRQ channel (used for playback by the full-duplex 1888/1887, ignored +by the 1788) can additionally be set to 5. +If both DRQ channels are used they must be different. .Pp The joystick interface (if enabled) is handled by the .Xr joy 4 @@ -70,8 +73,9 @@ driver. The AudioDrive devices have a SoundBlaster compatibility mode, and may be detected by the SoundBlaster driver (see .Xr sb 4 ) -rather than the AudioDrive driver. The workaround is to remove the -SoundBlaster driver from the kernel configuration. +rather than the AudioDrive driver. +The workaround is to remove the SoundBlaster driver from the kernel +configuration. .Sh SEE ALSO .Xr audio 4 , .Xr isa 4 , @@ -82,4 +86,3 @@ The .Nm device driver appeared in .Ox 2.2 . - diff --git a/share/man/man4/fpa.4 b/share/man/man4/fpa.4 index de5d66eb6dd..299ec2f46f2 100644 --- a/share/man/man4/fpa.4 +++ b/share/man/man4/fpa.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: fpa.4,v 1.12 2001/08/03 15:21:16 mpech Exp $ +.\" $OpenBSD: fpa.4,v 1.13 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: fpa.4,v 1.2 1997/02/18 01:07:46 jonathan Exp $ .\" .\" Copyright (c) 1995, Matt Thomas @@ -20,8 +20,9 @@ The and .Nm fea device driver provides support for the DEC DEFPA PCI FDDI Controller and -the DEC DEFEA EISA FDDI Controller, respectively. All variants of either -controller are supported including the DAS and SAS configurations. +the DEC DEFEA EISA FDDI Controller, respectively. +All variants of either controller are supported including the DAS and +SAS configurations. .Sh DIAGNOSTICS .Bl -diag .It "fea%d: error: desired IRQ of %d does not match device's actual IRQ (%d)" @@ -29,9 +30,11 @@ The device probe detected that the DEFEA board is configured for a different interrupt than the one specified in the kernel configuration file. .It "fea%d: error: memory not enabled! ECU reconfiguration required" The device probe found that no device memory had been configured on the -DEFEA. The DEFEA can be configured with no device memory, this driver -requires a minimum of 1K device memory be setup. The ECU (EISA Configuration -Utility) will need to be run to change the settings. +DEFEA. +The DEFEA can be configured with no device memory, this driver +requires a minimum of 1K device memory be setup. +The ECU (EISA Configuration Utility) will need to be run to change +the settings. .El .Sh CAVEATS Normally, the device driver will not enable the reception of SMT frames. diff --git a/share/man/man4/fxp.4 b/share/man/man4/fxp.4 index 181e9a5ff71..d93bab2e7b3 100644 --- a/share/man/man4/fxp.4 +++ b/share/man/man4/fxp.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: fxp.4,v 1.19 2001/09/04 23:52:17 provos Exp $ +.\" $OpenBSD: fxp.4,v 1.20 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1997 David E. O'Brien .\" @@ -37,10 +37,10 @@ The .Nm device driver supports the Intel EtherExpress 100 family of Ethernet cards -based on the i82557, i82558, and i82559 chipsets. These come in several -different varieties, including dual-port cards, and as built-in Ethernet -solutions on certain motherboards. This includes, among others, the following -models: +based on the i82557, i82558, and i82559 chipsets. +These come in several different varieties, including dual-port cards, and +as built-in Ethernet solutions on certain motherboards. +This includes, among others, the following models: .Pp .Bl -item -offset indent -compact .It @@ -64,7 +64,8 @@ Other models of Intel network cards are supported by the and .Xr iy 4 drivers. -This list is not exhaustive. In particular, the +This list is not exhaustive. +In particular, the .Nm driver should support any card by any manufacturer which is based on one of the aforementioned chipsets. @@ -90,8 +91,8 @@ If no media options are present, the .Nm driver places the card into autoselect mode. .Pp -These cards also come with a variety of PHYs. Models exist with PHYs supported -by both the +These cards also come with a variety of PHYs. +Models exist with PHYs supported by both the .Xr inphy 4 and .Xr nsphy 4 diff --git a/share/man/man4/gdt.4 b/share/man/man4/gdt.4 index 4b501711b51..9547c80fe78 100644 --- a/share/man/man4/gdt.4 +++ b/share/man/man4/gdt.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: gdt.4,v 1.13 2001/08/02 08:46:51 deraadt Exp $ +.\" $OpenBSD: gdt.4,v 1.14 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 2000 Niklas Hallqvist. All rights reserved. .\" @@ -83,16 +83,16 @@ and .El .Pp Although the controllers are actual RAID controllers the driver makes them -look just like SCSI controllers. All RAID configuration is done through -the controllers' BIOSes. +look just like SCSI controllers. +All RAID configuration is done through the controllers' BIOSes. .Sh DIAGNOSTICS .Bl -tag .It "pci_mem_find: expected mem type 00000000, found 00000002" This message occurs during autoconfiguration if jumper J4 is set to map -the controller memory below 1MB in physical memory. The driver primarily -wants this jumper to be set the other way round, but it will work with it in -any setting. If the diagnostic is considered a nuisance, alter jumper -J4's setting. +the controller memory below 1MB in physical memory. +The driver primarily wants this jumper to be set the other way round, +but it will work with it in any setting. +If the diagnostic is considered a nuisance, alter jumper J4's setting. .El .Sh SEE ALSO .Xr intro 4 , diff --git a/share/man/man4/hifn.4 b/share/man/man4/hifn.4 index 3b2c00b1ca5..ed919e00f0b 100644 --- a/share/man/man4/hifn.4 +++ b/share/man/man4/hifn.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hifn.4,v 1.23 2001/07/08 18:05:41 brad Exp $ +.\" $OpenBSD: hifn.4,v 1.24 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 2000 Theo de Raadt .\" All rights reserved. @@ -41,7 +41,8 @@ driver supports various cards containing the Hifn 7751 or Hifn 7951 chipsets, such as .Bl -tag -width namenamenamena -offset indent .It Invertex AEON -No longer being made. Came as 128KB SRAM model, or 2MB DRAM model. +No longer being made. +Came as 128KB SRAM model, or 2MB DRAM model. .It Hifn 7751 Reference board with 512KB SRAM. .It PowerCrypt @@ -70,19 +71,21 @@ subsystem. .Sh BUGS The 7751 chip starts out at initialization by only supporting compression. A proprietary algorithm, which has been reverse engineered, is required to -unlock the cryptographic functionality of the chip. It is possible for -vendors to make boards which have a lock ID not known to the driver, but -all vendors currently just use the obvious ID which is 13 bytes of 0. +unlock the cryptographic functionality of the chip. +It is possible for vendors to make boards which have a lock ID not known +to the driver, but all vendors currently just use the obvious ID which is +13 bytes of 0. .Sh SEE ALSO .Xr crypt 3 , .Xr ipsec 4 , .Xr random 4 , .Xr crypto 9 .Sh CAVEATS -The Hifn 9751 shares the same PCI id. This chip is basically a 7751, but -with the cryptographic functions missing. Instead, the 9751 is only capable -of doing compression. Since we do not currently attempt to use any of -these chips to do compression, the 9751-based cards are not useful. +The Hifn 9751 shares the same PCI id. +This chip is basically a 7751, but with the cryptographic functions missing. +Instead, the 9751 is only capable of doing compression. +Since we do not currently attempt to use any of these chips to do +compression, the 9751-based cards are not useful. .Sh HISTORY The .Nm diff --git a/share/man/man4/hsq.4 b/share/man/man4/hsq.4 index 2d7bb4164a8..2f0b8413901 100644 --- a/share/man/man4/hsq.4 +++ b/share/man/man4/hsq.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hsq.4,v 1.8 2001/06/26 02:09:07 pjanzen Exp $ +.\" $OpenBSD: hsq.4,v 1.9 2001/10/05 14:45:53 mpech Exp $ .\" from: OpenBSD: ast.4,v 1.5 1999/07/09 13:35:43 aaron Exp .\" from: NetBSD: ast.4,v 1.7 1996/03/16 00:07:07 thorpej Exp .\" @@ -64,11 +64,13 @@ Each .Nm device is the master device for up to four .Nm pccom -devices. The kernel configuration specifies these +devices. +The kernel configuration specifies these .Nm pccom 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 pccom device determines which bit in the interrupt multiplexing register is tested to find interrupts for that device. @@ -83,7 +85,8 @@ subdevices (they are equal to + ID * 8) and the port for the interrupt multiplexing register (it is equal to .Tn port -+ 7). More technical details on how the driver works can be found in ++ 7). +More technical details on how the driver works can be found in the big comment at the beginning of the driver's source code. .Pp Information on setup of card's configuration switches should be taken diff --git a/share/man/man4/icmp.4 b/share/man/man4/icmp.4 index a3d80f93e1c..374880ac1ee 100644 --- a/share/man/man4/icmp.4 +++ b/share/man/man4/icmp.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: icmp.4,v 1.6 2000/12/21 21:01:16 aaron Exp $ +.\" $OpenBSD: icmp.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: icmp.4,v 1.3 1994/11/30 16:22:14 jtc Exp $ .\" .\" Copyright (c) 1986, 1991, 1993 @@ -50,8 +50,8 @@ is the error and control message protocol used by .Tn IP -and the Internet protocol family. It may be accessed -through a +and the Internet protocol family. +It may be accessed through a .Dq raw socket for network monitoring and diagnostic functions. diff --git a/share/man/man4/ifmedia.4 b/share/man/man4/ifmedia.4 index 1a4141569f0..58ce778c898 100644 --- a/share/man/man4/ifmedia.4 +++ b/share/man/man4/ifmedia.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ifmedia.4,v 1.6 2001/03/01 16:11:17 aaron Exp $ +.\" $OpenBSD: ifmedia.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: ifmedia.4,v 1.1 1998/08/09 00:37:17 thorpej Exp $ .\" .\" Copyright (c) 1998 The NetBSD Foundation, Inc. @@ -50,8 +50,8 @@ The .Nm interface provides a consistent method for querying and setting -network interface media and media options. The media is typically -set using the +network interface media and media options. +The media is typically set using the .Xr ifconfig 8 command. .Pp @@ -68,32 +68,38 @@ FDDI .El .Pp The following sections describe the possible media settings for each -link type. Not all of these are supported by every device; refer to +link type. +Not all of these are supported by every device; refer to your device's manual page for more information. .Pp The lists below provide the possible names of each media type or option. The first name in the list is the canonical name of the media type or -option. Additional names are acceptable aliases for the media type or option. +Additional names are acceptable aliases for the media type or option. .Sh COMMON MEDIA TYPES AND OPTIONS The following media types are shared by all link types: .Bl -tag -offset indent -width IFM_MANUAL .It Dv IFM_AUTO -Autoselect the best media. [autoselect, auto] +Autoselect the best media. +[autoselect, auto] .It Dv IFM_MANUAL -Jumper or switch on device selects media. [manual] +Jumper or switch on device selects media. +[manual] .It Dv IFM_NONE -Deselect all media. [none] +Deselect all media. +[none] .El .Pp The following media options are shared by all link types: .Bl -tag -offset indent -width IFM_FLAG0 .It Dv IFM_FDX -Place the device into full-duplex mode. This option only has meaning -if the device is normally not full-duplex. [full-duplex, fdx] +Place the device into full-duplex mode. +This option only has meaning if the device is normally not full-duplex. +[full-duplex, fdx] .It Dv IFM_HDX -Place the device into half-duplex mode. This option only has meaning -if the device is normally not half-duplex. [half-duplex, hdx] +Place the device into half-duplex mode. +This option only has meaning if the device is normally not half-duplex. +[half-duplex, hdx] .It Dv IFM_FLAG0 Driver-defined flag. [flag0] .It Dv IFM_FLAG1 @@ -101,14 +107,15 @@ Driver-defined flag. [flag1] .It Dv IFM_FLAG2 Driver-defined flag. [flag2] .It Dv IFM_LOOP -Place the device into hardware loopback mode. [loopback, hw-loopback, loop] +Place the device into hardware loopback mode. +[loopback, hw-loopback, loop] .El .Sh MEDIA TYPES AND OPTIONS FOR ETHERNET The following media types are defined for Ethernet: .Bl -tag -offset indent -width IFM_1000_FX .It Dv IFM_10_T -10baseT, 10Mb/s over unshielded twisted pair, RJ45 connector. [10baseT, -UTP, 10UTP] +10baseT, 10Mb/s over unshielded twisted pair, RJ45 connector. +[10baseT, UTP, 10UTP] .It Dv IFM_10_2 10base2, 10Mb/s over coaxial cable, BNC connector, also called Thinnet. [10base2, BNC, 10BNC] @@ -116,24 +123,29 @@ UTP, 10UTP] 10base5, 10Mb/s over 15-wire cables, DB15 connector, also called AUI. [10base5, AUI, 10AUI] .It Dv IFM_100_TX -100baseTX, 100Mb/s over unshielded twisted pair, RJ45 connector. [100baseTX, -100TX] +100baseTX, 100Mb/s over unshielded twisted pair, RJ45 connector. +[100baseTX, 100TX] .It Dv IFM_100_FX -100baseFX, 100Mb/s over fiber optic cables. [100baseFX, 100FX] +100baseFX, 100Mb/s over fiber optic cables. +[100baseFX, 100FX] .It Dv IFM_100_T4 100baseT4, 100Mb/s over 4-wire (category 3) unshielded twisted pair, RJ45 -connector. [100baseT4, 100T4] +connector. +[100baseT4, 100T4] .It Dv IFM_100_VG -100baseVG AnyLAN. [100baseVG, 100VG] +100baseVG AnyLAN. +[100baseVG, 100VG] .It Dv IFM_100_T2 100baseT2. [100baseT2, 100T2] .It Dv IFM_1000_FX -1000baseFX, 1Gb/s over fiber optic cables. [1000baseFX, 1000FX] +1000baseFX, 1Gb/s over fiber optic cables. +[1000baseFX, 1000FX] .It Dv IFM_10_STP -10baseSTP, 10Mb/s over shielded twisted pair, DB9 connector. [10baseSTP, -STP, 10STP] +10baseSTP, 10Mb/s over shielded twisted pair, DB9 connector. +[10baseSTP, STP, 10STP] .It Dv IFM_10_FL -10baseFL, 10Mb/s over fiber optic cables. [10baseFL, FL, 10FL] +10baseFL, 10Mb/s over fiber optic cables. +[10baseFL, FL, 10FL] .El .Pp There are no link type-specific options defined for Ethernet. @@ -141,23 +153,30 @@ There are no link type-specific options defined for Ethernet. The following media types are defined for Token Ring: .Bl -tag -offset indent -width IFM_TOK_UTP16 .It Dv IFM_TOK_STP4 -4Mb/s, shielded twisted pair, DB9 connector. [DB9/4Mbit, 4STP] +4Mb/s, shielded twisted pair, DB9 connector. +[DB9/4Mbit, 4STP] .It Dv IFM_TOK_STP16 -16Mb/s, shielded twisted pair, DB9 connector. [DB9/16Mbit, 16STP] +16Mb/s, shielded twisted pair, DB9 connector. +[DB9/16Mbit, 16STP] .It Dv IFM_TOK_UTP4 -4Mb/s, unshielded twisted pair, RJ45 connector. [UTP/4Mbit, 4UTP] +4Mb/s, unshielded twisted pair, RJ45 connector. +[UTP/4Mbit, 4UTP] .It Dv IFM_TOK_UTP16 -16Mb/s, unshielded twisted pair, RJ45 connector. [UTP/16Mbit, 16UTP] +16Mb/s, unshielded twisted pair, RJ45 connector. +[UTP/16Mbit, 16UTP] .El .Pp The following media options are defined for Token Ring: .Bl -tag -offset indent -width IFM_TOK_SRCRT .It Dv IFM_TOK_ETR -Early token release. [EarlyTokenRelease, ETR] +Early token release. +[EarlyTokenRelease, ETR] .It Dv IFM_TOK_SRCRT -Enable source routing features. [SourceRouting, SRCRT] +Enable source routing features. +[SourceRouting, SRCRT] .It Dv IFM_TOK_ALLR -All routes vs. single route broadcast. [AllRoutes, ALLR] +All routes vs. single route broadcast. +[AllRoutes, ALLR] .El .Sh MEDIA TYPES AND OPTIONS FOR FDDI The following media types are defined for FDDI: @@ -167,13 +186,15 @@ Single-mode fiber. [Single-mode, SMF] .It Dv IFM_FDDI_MMF Multi-mode fiber. [Multi-mode, MMF] .It Dv IFM_FDDI_UTP -Unshielded twisted pair, RJ45 connector. [UTP, CDDI] +Unshielded twisted pair, RJ45 connector. +[UTP, CDDI] .El .Pp The following media options are defined for FDDI: .Bl -tag -offset indent -width IFM_FDDI_DA .It Dv IFM_FDDI_DA -Dual-attached station vs. Single-attached station. [dual-attach, das] +Dual-attached station vs. Single-attached station. +[dual-attach, das] .El .Sh SEE ALSO .Xr netintro 4 , @@ -186,6 +207,6 @@ interface first appeared in The implementation that appeared in .Nx 1.3 was written by Jonathan Stone and Jason R. Thorpe to be compatible with -the BSDI API. It has since gone through several revisions which have -extended the API while maintaining backwards compatibility with the -original API. +the BSDI API. +It has since gone through several revisions which have extended the API +while maintaining backwards compatibility with the original API. diff --git a/share/man/man4/inet.4 b/share/man/man4/inet.4 index 1368039f3c8..e654e1a1bc9 100644 --- a/share/man/man4/inet.4 +++ b/share/man/man4/inet.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: inet.4,v 1.7 2000/12/21 21:01:16 aaron Exp $ +.\" $OpenBSD: inet.4,v 1.8 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: inet.4,v 1.3 1994/11/30 16:22:18 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -64,7 +64,8 @@ Internet addresses are four byte quantities, stored in network standard format (on the .Tn VAX these are word and byte -reversed). The include file +reversed). +The include file .Aq Pa netinet/in.h defines this address as a discriminated union. .Pp @@ -116,7 +117,8 @@ abstraction while .Tn UDP is used to support the .Dv SOCK_DGRAM -abstraction. A raw interface to +abstraction. +A raw interface to .Tn IP is available by creating an Internet socket of type @@ -176,8 +178,8 @@ Get interface network mask. .Re .Sh CAVEAT The Internet protocol support is subject to change as -the Internet protocols develop. Users should not depend -on details of the current implementation, but rather +the Internet protocols develop. +Users should not depend on details of the current implementation, but rather the services exported. .Sh HISTORY The diff --git a/share/man/man4/iop.4 b/share/man/man4/iop.4 index 59d92df62aa..16b96778a78 100644 --- a/share/man/man4/iop.4 +++ b/share/man/man4/iop.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: iop.4,v 1.3 2001/08/20 21:43:57 mickey Exp $ +.\" $OpenBSD: iop.4,v 1.4 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: iop.4,v 1.7 2001/03/20 13:09:19 ad Exp $ .\" .\" Copyright (c) 2000 The NetBSD Foundation, Inc. @@ -68,9 +68,9 @@ and are prerequisites and must therefore be included beforehand. .Bl -tag -width OTTF .It Dv IOPIOCPT (struct ioppt) -Submit a message to the IOP and return the reply. Note that the return -value of this ioctl is not affected by completion status as indicated by the -reply. +Submit a message to the IOP and return the reply. +Note that the return value of this ioctl is not affected by completion status +as indicated by the reply. .Bd -literal struct ioppt { void *pt_msg; /* pointer to message buffer */ @@ -89,14 +89,15 @@ struct ioppt_buf { }; .Ed .Pp -The minimum timeout value that may be specified is 1000ms. All other values -must not exceed the +The minimum timeout value that may be specified is 1000ms. +All other values must not exceed the .Nm driver's operational limits. .It Dv IOPIOCGSTATUS (struct iovec) -Request the latest available status record from the IOP. This special-case -ioctl is provided as the I2O_EXEC_STATUS_GET message does not post replies, -and can therefore not be safely issued using the IOPIOCPT ioctl. +Request the latest available status record from the IOP. +This special-case ioctl is provided as the I2O_EXEC_STATUS_GET message +does not post replies, and can therefore not be safely issued using +the IOPIOCPT ioctl. .El .Pp The following ioctls may block while attempting to acquire the @@ -106,22 +107,23 @@ driver's configuration lock, and may fail if the acquisition times out. .It Dv IOPIOCGLCT (struct iovec) Retrieve the .Nm -driver's copy of the logical configuration table. This copy of the LCT -matches the current device configuration, but is not necessarily the latest -available version of the LCT. +driver's copy of the logical configuration table. +This copy of the LCT matches the current device configuration, but is not +necessarily the latest available version of the LCT. .It Dv IOPIOCRECONFIG Request that the .Nm driver scan all bus ports, retrieve the latest version of the LCT, and -attach or detach devices as necessary. Note that higher-level -reconfiguration tasks (such as logically re-scanning SCSI busses) will not -be performed by this ioctl. +attach or detach devices as necessary. +Note that higher-level reconfiguration tasks (such as logically re-scanning +SCSI busses) will not be performed by this ioctl. .It Dv IOPIOCGTIDMAP (struct iovec) -Retrieve the TID to device map. This map indicates which targets are -configured, and what the corresponding device name for each is. Although at -any given point it contains the same number of entries as the LCT, the number -of entries should be determined using the iov_len field from the returned -iovec. +Retrieve the TID to device map. +This map indicates which targets are configured, and what the corresponding +device name for each is. +Although at any given point it contains the same number of entries as the LCT, +the number of entries should be determined using the iov_len field from +the returned iovec. .Bd -literal struct iop_tidmap { u_short it_tid; diff --git a/share/man/man4/ioprbs.4 b/share/man/man4/ioprbs.4 index c2dd7e0fe34..5fc75d93685 100644 --- a/share/man/man4/ioprbs.4 +++ b/share/man/man4/ioprbs.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ioprbs.4,v 1.4 2001/08/17 11:13:58 mpech Exp $ +.\" $OpenBSD: ioprbs.4,v 1.5 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 2000 Niklas Hallqvist. All rights reserved. .\" @@ -28,8 +28,8 @@ a generic one, and the driver should cope with all I2O random block storages with no further adaptions. .Pp The storage is presented to the system as SCSI disks for uniformity -with other RAID controllers we support. All RAID configuration is done -through the controllers' BIOSes. +with other RAID controllers we support. +All RAID configuration is done through the controllers' BIOSes. .Sh SEE ALSO .Xr intro 4 , .Xr iop 4 , diff --git a/share/man/man4/iopsp.4 b/share/man/man4/iopsp.4 index fa662b6195f..615385bd7bd 100644 --- a/share/man/man4/iopsp.4 +++ b/share/man/man4/iopsp.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: iopsp.4,v 1.4 2001/08/20 21:43:57 mickey Exp $ +.\" $OpenBSD: iopsp.4,v 1.5 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: iopsp.4,v 1.2 2000/12/11 13:11:59 ad Exp $ .\" .\" Copyright (c) 2000 The NetBSD Foundation, Inc. @@ -51,19 +51,22 @@ driver provides support for I2O SCSI bus adapter ports and child peripherals. .Pp IOPs present each child peripheral attached to a bus adapter port as an -individual device. In order to present the appearance of a bus, the +individual device. +In order to present the appearance of a bus, the .Nm driver groups child peripherals by controlling port. .Pp On IOPs containing a SCSI port and block or tape driver modules, some SCSI -devices may not be directly accessible. For each inaccessible device, a -message will be displayed during configuration. For example: +devices may not be directly accessible. +For each inaccessible device, a message will be displayed during configuration. +For example: .Bd -literal iopsp0: target 0,0 (tid 70): in use by tid 47 .Ed .Pp Such devices will usually be indirectly accessible as block devices, either -individually or as part of an array. For accessing these, there is the +individually or as part of an array. +For accessing these, there is the .Nm ioprbs driver. .Sh SEE ALSO diff --git a/share/man/man4/ip.4 b/share/man/man4/ip.4 index 7a112276fed..9e6e4a4e952 100644 --- a/share/man/man4/ip.4 +++ b/share/man/man4/ip.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ip.4,v 1.16 2001/10/04 16:56:51 mpech Exp $ +.\" $OpenBSD: ip.4,v 1.17 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: ip.4,v 1.3 1994/11/30 16:22:19 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -102,7 +102,8 @@ header for .Dv SOCK_STREAM and .Dv SOCK_DGRAM -sockets. For example, +sockets. +For example, .Bd -literal int tos = IPTOS_LOWDELAY; /* see <netinet/in.h> */ setsockopt(s, IPPROTO_IP, IP_TOS, &tos, sizeof(tos)); @@ -136,7 +137,8 @@ cmsg_type = IP_RECVDSTADDR .Pp The IP_PORTRANGE option causes the default allocation policy for when the kernel is asked -to choose a free port number. Three choices are available: +to choose a free port number. +Three choices are available: .Bl -tag -width IP_PORTRANGE_DEFAULT .It IP_PORTRANGE_DEFAULT The regular range of non-reserved ports. @@ -170,7 +172,8 @@ Datagrams with a TTL of 1 are not forwarded beyond the local network. Multicast datagrams with a TTL of 0 will not be transmitted on any network, but may be delivered locally if the sending host belongs to the destination group and if multicast loopback has not been disabled on the sending socket -(see below). Multicast datagrams with TTL greater than 1 may be forwarded +(see below). +Multicast datagrams with TTL greater than 1 may be forwarded to other networks if a multicast router is attached to the local network. .Pp For hosts with multiple interfaces, each multicast transmission is @@ -212,18 +215,20 @@ setsockopt(s, IPPROTO_IP, IP_MULTICAST_LOOP, &loop, sizeof(loop)); This option improves performance for applications that may have no more than one instance on a single host (such as a router daemon), by eliminating -the overhead of receiving their own transmissions. It should generally not +the overhead of receiving their own transmissions. +It should generally not be used by applications for which there may be more than one instance on a single host (such as a conferencing program) or for which the sender does not belong to the destination group (such as a time querying program). .Pp A multicast datagram sent with an initial TTL greater than 1 may be delivered to the sending host on a different interface from that on which it was sent, -if the host belongs to the destination group on that other interface. The -loopback control option has no effect on such delivery. +if the host belongs to the destination group on that other interface. +The loopback control option has no effect on such delivery. .Pp A host must become a member of a multicast group before it can receive -datagrams sent to the group. To join a multicast group, use the +datagrams sent to the group. +To join a multicast group, use the .Dv IP_ADD_MEMBERSHIP option: .Bd -literal diff --git a/share/man/man4/ip6.4 b/share/man/man4/ip6.4 index c70e16dae70..ba3668b622b 100644 --- a/share/man/man4/ip6.4 +++ b/share/man/man4/ip6.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ip6.4,v 1.10 2001/10/04 10:28:20 wilfried Exp $ +.\" $OpenBSD: ip6.4,v 1.11 2001/10/05 14:45:53 mpech Exp $ .\" $KAME: ip6.4,v 1.12 2000/06/08 21:19:39 itojun Exp $ .\" .\" Copyright (C) 1999 WIDE Project. @@ -181,9 +181,10 @@ may be more than one instance on a single host (such as a conferencing program) or for which the sender does not belong to the destination group (such as a time querying program). .Pp -A multicast datagram sent with an initial hoplimit greater than 1 may be delivered -to the sending host on a different interface from that on which it was sent, -if the host belongs to the destination group on that other interface. +A multicast datagram sent with an initial hoplimit greater than 1 may be +delivered to the sending host on a different interface from that on which +it was sent, if the host belongs to the destination group on that other +interface. The loopback control option has no effect on such delivery. .Pp A host must become a member of a multicast group before it can receive @@ -524,9 +525,9 @@ socket option. .Pp When writing to a raw socket the kernel will automatically fragment the packet if its size exceeds the path MTU, inserting the required -fragmentation headers. On input the kernel reassembles received -fragments, so the reader of a raw socket never sees any fragment -headers. +fragmentation headers. +On input the kernel reassembles received fragments, so the reader +of a raw socket never sees any fragment headers. .Pp Most IPv4 implementations give special treatment to a raw socket created with a third argument to @@ -565,8 +566,9 @@ int offset = 2; setsockopt(fd, IPPROTO_IPV6, IPV6_CHECKSUM, &offset, sizeof(offset)); .Ed .Pp -By default, this socket option is disabled. Setting the offset to -1 -also disables the option. By disabled we mean (1) the kernel will +By default, this socket option is disabled. +Setting the offset to -1 also disables the option. +By disabled we mean (1) the kernel will not calculate and store a checksum for outgoing packets, and (2) the kernel will not verify a checksum for received packets. .Pp diff --git a/share/man/man4/ipsec.4 b/share/man/man4/ipsec.4 index 6c36abeb669..5ee487befb3 100644 --- a/share/man/man4/ipsec.4 +++ b/share/man/man4/ipsec.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ipsec.4,v 1.47 2001/08/03 15:21:16 mpech Exp $ +.\" $OpenBSD: ipsec.4,v 1.48 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright 1997 Niels Provos <provos@physnet.uni-hamburg.de> .\" All rights reserved. @@ -63,11 +63,11 @@ The internet protocol, aka .Tn IPv4 , does not inherently provide any -protection to your transferred data. It does not even guarantee that -the sender is who he says he is. +protection to your transferred data. +It does not even guarantee that the sender is who he says he is. .Tn IPsec -tries to remedy this. There -are several kinds of properties you might want to add to your +tries to remedy this. +There are several kinds of properties you might want to add to your communication, the most common are: .Bl -inset -offset indent .It Confidentiality @@ -77,23 +77,26 @@ You do not want anyone to see your passwords when logging into a remote machine over the Internet. .It Integrity - Guarantee that the data does not get changed on -the way. If you are on a line carrying invoicing data you +the way. +If you are on a line carrying invoicing data you probably want to know that the amounts and account numbers are correct and not altered while in-transit. .It Authenticity - Sign your data so that others can see that it -is really you that sent it. It is clearly nice to know that -documents are not forged. +is really you that sent it. +It is clearly nice to know that documents are not forged. .It Replay protection - We need ways to ensure a transaction can only be carried out once unless -we are authorized to repeat it. I.e. it should not be possible for someone +we are authorized to repeat it. +I.e. it should not be possible for someone to record a transaction, and then replaying it verbatim, in order to get an -effect of multiple transactions being received by the peer. Consider the -attacker has got to know what the traffic is all about by other means than -cracking the encryption, and that the traffic causes events favourable for him, -like depositing money into his account. We need to make sure he cannot just -replay that traffic later. WARNING: as per the standards specification, replay -protection is not performed when using manual-keyed IPsec (e.g., when using +effect of multiple transactions being received by the peer. +Consider the attacker has got to know what the traffic is all about by other +means than cracking the encryption, and that the traffic causes events +favourable for him, like depositing money into his account. +We need to make sure he cannot just replay that traffic later. +WARNING: as per the standards specification, replay protection is not +performed when using manual-keyed IPsec (e.g., when using .Xr ipsecadm 8 ) . .El .Pp @@ -110,14 +113,18 @@ can provide authentication, integrity, replay protection, and confidentiality of the data (it secures everything in the packet that follows the .Tn IP -header). Replay protection requires authentication and -integrity (these two go always together). Confidentiality (encryption) -can be used with or without authentication/integrity. Similarly, -one could use authentication/integrity with or without confidentiality. +header). +Replay protection requires authentication and +integrity (these two go always together). +Confidentiality (encryption) can be used with or without +authentication/integrity. +Similarly, one could use authentication/integrity with or without +confidentiality. .Pp .Tn AH provides authentication, integrity, and replay protection (but not -confidentiality). Its main difference with +confidentiality). +Its main difference with .Tn ESP is that .Tn AH @@ -128,13 +135,15 @@ header of the packet (like the source/destination addresses). .Pp These protocols need some parameters for each connection, telling -exactly how the wanted protection will be added. These parameters are -collected in an entity called a security association, or SA for short. +exactly how the wanted protection will be added. +These parameters are collected in an entity called a security association, +or SA for short. Typical parameters are: encryption algorithm, hash algorithm, -encryption key, authentication key etc. When two peers have setup -matching SAs at both ends, packets protected with one end's SA, will -be possible to verify and/or decrypt using the other end's SA. The -only problem left is to see that both ends have matching SAa, which +encryption key, authentication key etc. +When two peers have setup matching SAs at both ends, packets protected with +one end's SA, will be possible to verify and/or decrypt using the other +end's SA. +The only problem left is to see that both ends have matching SAa, which can be done manually, or automatically with a key management daemon. .Pp Further information on manual SA establishment is described in @@ -150,13 +159,14 @@ data, some of the .Tn IP header data and a certain secret value, the authentication key and sending this value along with the rest of each -packet. The receiver will do the same computation, and if the value matches, +packet. +The receiver will do the same computation, and if the value matches, he knows no one tampered with the data (integrity), the address information -(authenticity) or a sequence number (replay protection). He knows this because -the secret authentication key makes sure no man in the middle can recompute the -correct value after altering the packet. The algorithms used for the -computations are called hash algorithms and is a parameter in the SA, just -like the authentication key. +(authenticity) or a sequence number (replay protection). +He knows this because the secret authentication key makes sure no man in the +middle can recompute the correct value after altering the packet. +The algorithms used for the computations are called hash algorithms and is +a parameter in the SA, just like the authentication key. .Pp .Tn ESP optionally does almost everything that @@ -164,28 +174,31 @@ optionally does almost everything that does except that it does not protect the outer .Tn IP -header but furthermore it encrypts the payload data -with an encryption algorithm using a secret encryption key. Only the ones -knowing this key can decrypt the data, thus providing confidentiality. Both -the algorithm and the encryption key are parameters of the SA. -.Pp -In order to identify a SA we need to have a unique name for it. This name is -a triplet, consisting of the destination address, security parameter index -(aka SPI) and the security protocol. Since the destination address is part -of the name, a SA is a unidirectional construct. For a bidirectional -communication channel, two SAs are needed, one outgoing and one incoming, -where the destination address is our local IP address. The SPI is just a -number that helps us making the name unique, it can be arbitrarily chosen -in the range 0x100 - 0xffffffff. The security protocol number should be 50 -for +header but furthermore it encrypts the payload data with an encryption +algorithm using a secret encryption key. +Only the ones knowing this key can decrypt the data, thus providing +confidentiality. +Both the algorithm and the encryption key are parameters of the SA. +.Pp +In order to identify a SA we need to have a unique name for it. +This name is a triplet, consisting of the destination address, security +parameter index (aka SPI) and the security protocol. +Since the destination address is part of the name, a SA is a +unidirectional construct. +For a bidirectional communication channel, two SAs are needed, one +outgoing and one incoming, where the destination address is our local +IP address. +The SPI is just a number that helps us making the name unique, it can be +arbitrarily chosen in the range 0x100 - 0xffffffff. +The security protocol number should be 50 for .Tn ESP and 51 for .Tn AH , as these are the protocol numbers assigned by IANA. .Pp .Tn IPsec -can operate in two modes, either tunnel or transport mode. In transport -mode the ordinary +can operate in two modes, either tunnel or transport mode. +In transport mode the ordinary .Tn IP header is used to deliver the packets to their endpoint, in tunnel mode the ordinary @@ -194,20 +207,20 @@ header just tells us the address of a security gateway, knowing how to verify/decrypt the payload and forward the packet to a destination given by another .Tn IP -header contained in the -protected payload. Tunnel mode can be used for establishing VPNs, virtual +header contained in the protected payload. +Tunnel mode can be used for establishing VPNs, virtual private networks, where parts of the networks can be spread out over an unsafe public network, but security gateways at each subnet are responsible -for encrypting and decrypting the data passing over the public net. A SA -will hold information telling if it is a tunnel or transport mode SA, and for -tunnels, it will contain values to fill in into the outer +for encrypting and decrypting the data passing over the public net. +A SA will hold information telling if it is a tunnel or transport mode SA, +and for tunnels, it will contain values to fill in into the outer .Tn IP header. .Pp The SA also holds a couple of other parameters, especially useful for automatic keying, called lifetimes, which puts a limit on how much we can -use a SA for protecting our data. These limits can be in wall-clock time -or in volume of our data. +use a SA for protecting our data. +These limits can be in wall-clock time or in volume of our data. .Pp To better illustrate how .Tn IPsec @@ -230,7 +243,8 @@ where everything after the header is protected by whatever services of .Tn ESP we are using (authentication/integrity, replay protection, -confidentiality). This means the +confidentiality). +This means the .Tn IP header itself is not protected. .Pp @@ -244,21 +258,24 @@ in tunnel mode to the original packet, we would get: where, again, everything after the .Tn ESP header is cryptographically -protected. Notice the insertion of an +protected. +Notice the insertion of an .Tn IP header between the .Tn ESP and .Tn TCP -header. This mode of operation allows us to hide who the true +header. +This mode of operation allows us to hide who the true source and destination addresses of a packet are (since the protected and the unprotected .Tn IP -headers don't have to be exactly the same). A -typical application of this is in Virtual Private Networks (or VPNs), +headers don't have to be exactly the same). +A typical application of this is in Virtual Private Networks (or VPNs), where two firewalls use .Tn IPsec -to secure the traffic of all the hosts behind them. For example: +to secure the traffic of all the hosts behind them. +For example: .Bd -literal -offset indent Net A <----> Firewall 1 <--- Internet ---> Firewall 2 <----> Net B .Ed @@ -270,8 +287,8 @@ in tunnel mode, as illustrated above. .Pp This implementation makes use of a virtual interface .Nm enc0 , -which can be used in packet filters to specify those -packets that have been or will be processed by +which can be used in packet filters to specify those packets that have +been or will be processed by .Tn IPsec. .Pp NAT can also be applied to @@ -293,8 +310,9 @@ The .Tn [X] Stage on the output path represents the point where the packet is matched against the IPsec flow database (SPD) to determine if and how -the packet has to be IPsec-processed. If, at this point, it is determined -that the packet should be IPSec-processed, it is processed by the PF/NAT code. +the packet has to be IPsec-processed. +If, at this point, it is determined that the packet should be IPSec-processed, +it is processed by the PF/NAT code. Unless PF drops the packet, it will then be IPsec-processed, even if the packet has been modified by NAT. .Pp @@ -329,8 +347,8 @@ For each of the categories there are five possible levels which specify the security policy to use in that category: .Bl -tag -width IPSEC_LEVEL_REQUIRE .It IPSEC_LEVEL_BYPASS -Bypass the default system security policy. This option can only be used -by privileged processes. +Bypass the default system security policy. +This option can only be used by privileged processes. This level is necessary for key management daemons like .Xr photurisd 8 or @@ -367,9 +385,9 @@ error = setsockopt(s, IPPROTO_IP, IP_AUTH_LEVEL, &level, sizeof(int)); .Ed .Pp The system does guarantee that it will succeed at establishing the -required security associations. In any case a properly configured -key management daemon is required which listens to messages from the -kernel. +required security associations. +In any case a properly configured key management daemon is required which +listens to messages from the kernel. .Pp A list of all security associations in the kernel tables can be obtained via the kernfs file @@ -395,7 +413,8 @@ and .Tn ESP usage, using the .Fl p -flag. Using the +flag. +Using the .Fl r flag, .Xr netstat 1 @@ -408,7 +427,8 @@ displays information about memory use by IPsec with the .Fl m flag (look for ``tdb'' and ``xform'' allocations). .Sh BUGS -There's a lot more to be said on this subject. This is just a beginning. +There's a lot more to be said on this subject. +This is just a beginning. At the moment the socket options are not fully implemented. .Sh SEE ALSO .Xr enc 4 , @@ -443,8 +463,8 @@ which is work in progress. The .Tn IPsec protocol design process was started in 1992 by John Ioannidis, Phil Karn -and William Allen Simpson. In 1995, the former wrote an -implementation for +and William Allen Simpson. +In 1995, the former wrote an implementation for .Bsx . Angelos D. Keromytis ported it to .Ox diff --git a/share/man/man4/isa.4 b/share/man/man4/isa.4 index e6da7041232..701bb5446a2 100644 --- a/share/man/man4/isa.4 +++ b/share/man/man4/isa.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: isa.4,v 1.11 2001/10/04 16:56:51 mpech Exp $ +.\" $OpenBSD: isa.4,v 1.12 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: isa.4,v 1.19 2000/03/18 16:54:37 augustss Exp $ .\" .\" Copyright (c) 2000 Theo de Raadt. All rights reserved. @@ -114,7 +114,8 @@ interfaces. Mitsumi CD-ROM drives. .It Xr wdc 4 Standard Western Digital type hard drive controllers: MFM, RLL, ESDI, -and IDE/ATAPI. See also the +and IDE/ATAPI. +See also the .Xr pciide 4 device driver which is used instead on machines with PCI IDE controllers. .It Xr wt 4 diff --git a/share/man/man4/iso.4 b/share/man/man4/iso.4 index 95227af8415..36cb8982635 100644 --- a/share/man/man4/iso.4 +++ b/share/man/man4/iso.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: iso.4,v 1.8 2000/10/18 02:38:23 aaron Exp $ +.\" $OpenBSD: iso.4,v 1.9 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: iso.4,v 1.3 1994/11/30 16:22:20 jtc Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 @@ -144,7 +144,8 @@ length structures, we have separated the selector lengths from the data themselves. The network address and various selectors are stored contiguously, with the network address first, then the transport selector, and so -on. Thus, if you had a network address of less than 20 bytes, +on. +Thus, if you had a network address of less than 20 bytes, the transport selector would encroach on space normally reserved for the network address. .Sh NETWORK ADDRESSING diff --git a/share/man/man4/isp.4 b/share/man/man4/isp.4 index f9021968638..dc55bb3301c 100644 --- a/share/man/man4/isp.4 +++ b/share/man/man4/isp.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: isp.4,v 1.7 2001/09/01 07:21:59 mjacob Exp $ +.\" $OpenBSD: isp.4,v 1.8 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1998, 1999 .\" Matthew Jacob, for NASA/Ames Research Center @@ -66,8 +66,8 @@ An optional appended to the above .Tn isp* declarations will disable the download of driver f/w, which means you -use whatever F/W is running on the card. If no firmware is running on the card, -you will lose. +use whatever F/W is running on the card. +If no firmware is running on the card, you will lose. .Sh BUGS The driver currently ignores some NVRAM settings. .Pp diff --git a/share/man/man4/ksyms.4 b/share/man/man4/ksyms.4 index aa7c7c42a4a..1e00129fbef 100644 --- a/share/man/man4/ksyms.4 +++ b/share/man/man4/ksyms.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ksyms.4,v 1.5 2001/03/01 16:11:18 aaron Exp $ +.\" $OpenBSD: ksyms.4,v 1.6 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1998 Todd C. Miller <Todd.Miller@courtesan.com> .\" All rights reserved. @@ -39,11 +39,12 @@ The device masquerades as an .Em a.out executable with the symbols from the running kernel as its -symbol segment. Use of +symbol segment. +Use of .Nm /dev/ksyms requires that the boot loader preserve the kernel symbols and place -them at the end of the kernel's address space. Any port that is capable -of using the +them at the end of the kernel's address space. +Any port that is capable of using the .Em DDB debugger does this, even if .Em DDB @@ -52,9 +53,11 @@ is not configured into the kernel. The .Nm /dev/ksyms device is used to look up the symbol table name list from the running -kernel. Because it represents the running kernel it is guaranteed +kernel. +Because it represents the running kernel it is guaranteed to always be up to date even if the kernel file has been changed (or -is even non-existent). It is most useful when used in conjunction with +is even non-existent). +It is most useful when used in conjunction with .Xr nlist 3 or the .Xr kvm 3 @@ -96,7 +99,7 @@ It is not possible to .Xr mmap 2 .Nm /dev/ksyms because the boot loader does not load the symbol table onto a page -boundary (so it is not page aligned). If all the boot loaders were -fixed, +boundary (so it is not page aligned). +If all the boot loaders were fixed, .Xr mmap 2 support would be trivial. diff --git a/share/man/man4/lc.4 b/share/man/man4/lc.4 index 7110231c334..9420400e469 100644 --- a/share/man/man4/lc.4 +++ b/share/man/man4/lc.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: lc.4,v 1.1 2001/07/13 17:42:52 niklas Exp $ +.\" $OpenBSD: lc.4,v 1.2 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: lc.4,v 1.4 1999/12/15 22:07:32 abs Exp $ .\" .\" Copyright (c) 1997 The NetBSD Foundation, Inc. @@ -48,12 +48,13 @@ The .Nm device driver supports DEC EtherWORKS III Ethernet interfaces, which -are based on the LEMAC Ethernet chip. This includes the DE203, DE204, -and DE205. +are based on the LEMAC Ethernet chip. +This includes the DE203, DE204, and DE205. .Sh MEDIA SELECTION The EtherWORKS III series supports various combinations of media, depending -on model. Some models also support media autoselect. Media is selected -with +on model. +Some models also support media autoselect. +Media is selected with .Xr ifconfig 8 's .Sq media directive. diff --git a/share/man/man4/lkm.4 b/share/man/man4/lkm.4 index a60bca92eb8..bac1162d025 100644 --- a/share/man/man4/lkm.4 +++ b/share/man/man4/lkm.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: lkm.4,v 1.11 2001/06/22 12:15:46 mpech Exp $ +.\" $OpenBSD: lkm.4,v 1.12 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: lkm.4,v 1.4 1994/11/30 16:22:22 jtc Exp $ .\" .\" Copyright (c) 1993 Christopher G. Demetriou @@ -43,9 +43,9 @@ test their changes. .Pp Various types of modules can be loaded into the system. There are several defined module types, listed below, which can -be added to the system in a predefined way. In addition, there -is a generic type, for which the module itself handles loading and -unloading. +be added to the system in a predefined way. +In addition, there is a generic type, for which the module itself handles +loading and unloading. .Pp The .Nm @@ -53,13 +53,14 @@ interface is used by performing .Xr ioctl 2 calls on the .Pa /dev/lkm -device. Normally all operations involving -Loadable Kernel Modules are handled by the +device. +Normally all operations involving Loadable Kernel Modules are handled by the .Xr modload 8 , .Xr modunload 8 , and .Xr modstat 8 -programs. Users should never have to interact with +programs. +Users should never have to interact with .Pa /dev/lkm directly. .Sh "MODULE TYPES" @@ -68,9 +69,8 @@ directly. System calls may be replaced by loading new ones via the .Nm -interface. All system calls may be -replaced, but special care should -be taken with the +interface. +All system calls may be replaced, but special care should be taken with the .Xr ioctl 2 system call, as it is used to load and unload modules. @@ -92,8 +92,8 @@ drivers may be loaded into the system with The major problem with loading a device driver is that the driver's device nodes must be exist for the -devices to be accessed. They are usually -created by instructing +devices to be accessed. +They are usually created by instructing .Xr modload 8 to run an appropriate program when the driver has been successfully loaded. @@ -106,10 +106,9 @@ usable by the operating system. Miscellaneous modules are modules for which there are not currently well-defined or well-used interfaces -for extension. The user is expected -to write their own loader to manipulate -whatever kernel data structures necessary -to enable and disable the new module +for extension. +The user is expected to write their own loader to manipulate +whatever kernel data structures necessary to enable and disable the new module when it is loaded and unloaded. .El .Sh FILES diff --git a/share/man/man4/lmc.4 b/share/man/man4/lmc.4 index 79d78e463ad..eb9dffc5f25 100644 --- a/share/man/man4/lmc.4 +++ b/share/man/man4/lmc.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: lmc.4,v 1.13 2001/08/03 15:21:16 mpech Exp $ +.\" $OpenBSD: lmc.4,v 1.14 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1999 Chris Cappuccio .\" @@ -37,11 +37,12 @@ The .Nm driver provides support for the Lan Media Corporation SSI, DS1, HSSI, and DS3 -PCI WAN adapters based on the DEC 21140 Ethernet chip. The adapters use -a DEC 21140 Ethernet chip for the PCI bus interface. Leaving the bus -interface chip, the data path goes through a field programmable gate array, -where HDLC processing is accomplished. Leaving the FPGA, there are FIFO -buffers and the DS1, DS3, and V.35 drive circuitry. +PCI WAN adapters based on the DEC 21140 Ethernet chip. +The adapters use a DEC 21140 Ethernet chip for the PCI bus interface. +Leaving the bus interface chip, the data path goes through a field programmable +gate array, where HDLC processing is accomplished. +Leaving the FPGA, there are FIFO buffers and the DS1, DS3, and V.35 drive +circuitry. .Pp The intent is to provide a synchronous serial link with HDLC framing at speeds of up to 10Mbps (for the SSI card), 52Mbps (for the HSSI card), BNC connectors @@ -49,14 +50,16 @@ for 45Mbps operation without a CSU/DSU (DS3 card), and an RJ45 jack for T1/E1 operation without a CSU/DSU (DS1 card). .Pp The card will automatically use HDLC framing and defaults to external clock -source. For the DS1 and DS3 cards with built in CSU/DSU functionality, -the clock source is always external (from CSU/DSU). The ability to set cable -length is not currently implemented. +source. +For the DS1 and DS3 cards with built in CSU/DSU functionality, +the clock source is always external (from CSU/DSU). +The ability to set cable length is not currently implemented. .Pp Using the .Xr sppp 4 -driver, you can also use the ppp protocol. In either -case, the lmc interface should be configured as a point-to-point link. +driver, you can also use the ppp protocol. +In either case, the lmc interface should be configured as a point-to-point +link. .Sh DIAGNOSTICS .Bl -diag .It "lmc%d: couldn't map interrupt" @@ -76,8 +79,8 @@ The card is sending DTR and RTS signals on the line .It "lmc%d: deasserting DTR and RTS" The card is not sending DTR and RTS signals on the line .It "lmc%d: Abnormal interrupt" -The card received an incomplete request. This may be a sign of a hardware -fault. +The card received an incomplete request. +This may be a sign of a hardware fault. .It "lmc%d: tx_intr: failed to dequeue mbuf?!?" Only available if compiled with LMC_DEBUG .It "lmc%d: txput: tx not running" @@ -102,5 +105,6 @@ Matt Thomas' driver. The .Ox -port and manual page are from Chris Cappuccio. Later -enhancements to support the LMC1200 card are based on LMC's Linux driver. +port and manual page are from Chris Cappuccio. +Later enhancements to support the LMC1200 card are based on LMC's +Linux driver. diff --git a/share/man/man4/lo.4 b/share/man/man4/lo.4 index 17bc29eae02..4b49c6b2991 100644 --- a/share/man/man4/lo.4 +++ b/share/man/man4/lo.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: lo.4,v 1.14 2001/07/01 22:05:50 angelos Exp $ +.\" $OpenBSD: lo.4,v 1.15 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: lo.4,v 1.3 1994/11/30 16:22:23 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -67,7 +67,8 @@ with the .Em link1 flag set will make the interface answer to the whole set of addresses identified as being in super-net which is specified -by the address and netmask. Obviously you should not set the +by the address and netmask. +Obviously you should not set the .Em link1 flag on interface .Nm lo0 Ns , diff --git a/share/man/man4/maestro.4 b/share/man/man4/maestro.4 index b3bf80c65b3..47f4d7425ee 100644 --- a/share/man/man4/maestro.4 +++ b/share/man/man4/maestro.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: maestro.4,v 1.5 2001/09/24 12:21:03 espie Exp $ +.\" $OpenBSD: maestro.4,v 1.6 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 2001 Marc Espie. .\" All rights reserved. @@ -42,9 +42,9 @@ early models. It does not support maestro 3 cards, which are entirely different. .Pp Maestro cards have direct support for 16 bit signed little-endian -mono and stereo, 8 bit signed and unsigned mono and stereo. Other encodings -are emulated in software. Sampling range is 4000 - 48000 Hz, with roughly -a 2 Hz resolution. +mono and stereo, 8 bit signed and unsigned mono and stereo. +Other encodings are emulated in software. +Sampling range is 4000 - 48000 Hz, with roughly a 2 Hz resolution. .Pp Maestro cards have some DSP and dolby digital 5:1 hardware, but this driver does not support it. diff --git a/share/man/man4/man4.alpha/com.4 b/share/man/man4/man4.alpha/com.4 index 5ed6495797b..1032c385837 100644 --- a/share/man/man4/man4.alpha/com.4 +++ b/share/man/man4/man4.alpha/com.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: com.4,v 1.3 2001/08/20 06:09:32 mpech Exp $ +.\" $OpenBSD: com.4,v 1.4 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1990, 1991 The Regents of the University of California. .\" All rights reserved. @@ -53,9 +53,9 @@ driver provides support for NS8250-, NS16450-, NS16550- and ST16650-based .Tn RS-232C .Pf ( Tn CCITT .Tn V.28 ) -communications interfaces. The NS8250 and NS16450 have single -character buffers, the NS16550 has a 16 character buffer, while -the ST16650 has a 32 character buffer. +communications interfaces. +The NS8250 and NS16450 have single character buffers, the NS16550 has a 16 +character buffer, while the ST16650 has a 32 character buffer. .Pp Input and output for each line may set to one of following baud rates; 50, 75, 110, 134.5, 150, 300, 600, 1200, 1800, 2400, 4800, 9600, diff --git a/share/man/man4/man4.alpha/cy.4 b/share/man/man4/man4.alpha/cy.4 index 269a9ac2506..e0c3e8fdb01 100644 --- a/share/man/man4/man4.alpha/cy.4 +++ b/share/man/man4/man4.alpha/cy.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cy.4,v 1.6 2001/08/20 06:09:32 mpech Exp $ +.\" $OpenBSD: cy.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1993 Andrew Herbert. .\" All rights reserved. @@ -37,8 +37,8 @@ .Cd "cy1 at pci?" .Sh DESCRIPTION This driver provides an interface to Cyclades Cyclom-4Y, Cyclom-8Y and -Cyclom-16Y asynchronous multiport serial boards. These boards are based -around Cirrus Logic CD1400 communication controllers. +Cyclom-16Y asynchronous multiport serial boards. +These boards are based around Cirrus Logic CD1400 communication controllers. .Pp The device minor numbers for this driver are encoded as follows: .Pp @@ -62,17 +62,17 @@ The device minor numbers for this driver are encoded as follows: .Sh DIAGNOSTICS .Bl -diag .It "cy%d: tty input queue overflow" -Incoming characters have been discarded due to a buffer overflow. This is -caused by the process in control of the device not read(2)ing characters +Incoming characters have been discarded due to a buffer overflow. +This is caused by the process in control of the device not reading characters fast enough. .It "cy%d: receive fifo overrun" -Incoming characters have been discarded due to a CD1400 channel overrun. This -is caused by interrupts not being serviced sufficiently quickly to prevent -the 12 byte receive FIFO on a serial channel from overflowing. Reducing -the value of the \fIRxFifoThreshold\fR #define from 8 to something smaller may -help slow machines avoid this problem. The driver must have been compiled -with the \fILogOverruns\fR option defined (the default) in order for this -condition to be logged. +Incoming characters have been discarded due to a CD1400 channel overrun. +This is caused by interrupts not being serviced sufficiently quickly to prevent +the 12 byte receive FIFO on a serial channel from overflowing. +Reducing the value of the \fIRxFifoThreshold\fR #define from 8 to something +smaller may help slow machines avoid this problem. +The driver must have been compiled with the \fILogOverruns\fR option defined +(the default) in order for this condition to be logged. .El .Sh SEE ALSO .Xr com 4 , @@ -88,8 +88,9 @@ were derived from the fas 2.10 driver by Uwe Doering Evans <bde@kralizec.zeta.org.au>. .Pp This work was made possible through the donation of a Cyclom-8Y board by the -manufacturer, Cyclades Corporation. However, neither Cyclades nor the author -make any warranties regarding this software, nor guarantees of support. +manufacturer, Cyclades Corporation. +However, neither Cyclades nor the author make any warranties regarding this +software, nor guarantees of support. .Sh BUGS There is currently no BREAK handling - breaks are ignored. There is no support for bad-character reporting, except via PARMRK. diff --git a/share/man/man4/man4.alpha/intro.4 b/share/man/man4/man4.alpha/intro.4 index 7f8856e6f74..c84f4da8e30 100644 --- a/share/man/man4/man4.alpha/intro.4 +++ b/share/man/man4/man4.alpha/intro.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: intro.4,v 1.6 2001/10/04 22:03:40 miod Exp $ +.\" $OpenBSD: intro.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1998 The OpenBSD Project .\" All Rights Reserved. @@ -39,8 +39,8 @@ The networking support is introduced in This section describes the hardware supported on the Alpha 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 . @@ -53,9 +53,10 @@ 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, diff --git a/share/man/man4/man4.alpha/lpt.4 b/share/man/man4/man4.alpha/lpt.4 index b7b1bda67a9..12e49b761bf 100644 --- a/share/man/man4/man4.alpha/lpt.4 +++ b/share/man/man4/man4.alpha/lpt.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: lpt.4,v 1.4 2001/08/20 06:09:32 mpech Exp $ +.\" $OpenBSD: lpt.4,v 1.5 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1993 Christopher G. Demetriou .\" All rights reserved. @@ -43,8 +43,9 @@ 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, only the polling device may be used. +whether to do polling or wait for interrupts. +If no IRQ is specified in the kernel configuration, 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. diff --git a/share/man/man4/man4.alpha/pms.4 b/share/man/man4/man4.alpha/pms.4 index 2043d2a32f1..b96f69bc0a5 100644 --- a/share/man/man4/man4.alpha/pms.4 +++ b/share/man/man4/man4.alpha/pms.4 @@ -1,5 +1,5 @@ .\" -.\" $OpenBSD: pms.4,v 1.2 2001/08/20 06:09:32 mpech Exp $ +.\" $OpenBSD: pms.4,v 1.3 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1996, Jason Downs. .\" Copyright (c) 1993 Christopher G. Demetriou @@ -39,16 +39,17 @@ .Sh SYNOPSIS .Cd "pms0 at pcppi?" .Sh DESCRIPTION -This driver provides an interface to a PS/2 auxiliary port mice. The driver -offers two modes of operation, both a raw and the old style translated -input stream. The translating portion of the driver provides BusMouse -codes; in raw mode no translations are performed. +This driver provides an interface to a PS/2 auxiliary port mice. +The driver offers two modes of operation, both a raw and the old style +translated input stream. +The translating portion of the driver provides BusMouse codes; +in raw mode no translations are performed. The .Nm driver provides three .Em ioctls -for getting mouse status and changing modes. They are defined in the -following include: +for getting mouse status and changing modes. +They are defined in the following include: .Bd -literal -offset indent #include <machine/mouse.h> .Ed @@ -66,7 +67,8 @@ The puts the device into raw mode, if it is not already, and the .Dv MOUSEIOCSCOOKED .Em ioctl -puts it into translated (or cooked) mode. If the mode of the +puts it into translated (or cooked) mode. +If the mode of the .Nm device driver changes, all pending but not yet read input is flushed. .Sh FILES diff --git a/share/man/man4/man4.alpha/scc.4 b/share/man/man4/man4.alpha/scc.4 index a70c35015a7..55986fb674e 100644 --- a/share/man/man4/man4.alpha/scc.4 +++ b/share/man/man4/man4.alpha/scc.4 @@ -27,7 +27,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $OpenBSD: scc.4,v 1.3 2001/08/20 06:09:32 mpech Exp $ +.\" $OpenBSD: scc.4,v 1.4 2001/10/05 14:45:53 mpech Exp $ .\" .Dd March 7, 1998 .Dt SCC 4 alpha @@ -43,8 +43,8 @@ The .Nm driver provides support for the Zilog 8530 Serial Communications Controller (SCC) via the IOCTL asic on Turbochannel-based alphas -(the DEC 3000 series). Each scc device has two serial -ports. +(the DEC 3000 series). +Each scc device has two serial ports. .Pp Input and output for each line may set to one of following baud rates; 50, 75, 110, 134.5, 150, 300, 600, 1200, 1800, 2400, 4800, 9600, @@ -67,8 +67,8 @@ driver first appeared in .Sh BUGS The IOCTL asic provides internal DMA channels that can be programmed to transfer up to 4096 bytes of data into, or out, of an SCC without -further software intervention. This feature of the ioctl asic is not -yet supported. +further software intervention. +This feature of the ioctl asic is not yet supported. .Pp The mapping from device-special files (major and minor number) to chip and port is arguably backwards. diff --git a/share/man/man4/man4.alpha/wd.4 b/share/man/man4/man4.alpha/wd.4 index 683139dc3cf..0e7bd3f57b4 100644 --- a/share/man/man4/man4.alpha/wd.4 +++ b/share/man/man4/man4.alpha/wd.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: wd.4,v 1.6 2001/01/29 02:11:09 niklas Exp $ +.\" $OpenBSD: wd.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" .\" .\" Copyright (c) 1994 James A. Jegers @@ -37,9 +37,10 @@ The .Nm wd driver supports hard disk controllers which emulate the Western -Digital WD100x. This includes standard MFM, RLL, ESDI and IDE -controllers. Most PCI bus alpha machines have a WD100x compatible -controller built-in to the motherboard. +Digital WD100x. +This includes standard MFM, RLL, ESDI and IDE controllers. +Most PCI bus alpha machines have a WD100x compatible controller built-in to +the motherboard. .Pp Support for extended EIDE controllers is .Ud . diff --git a/share/man/man4/man4.amiga/afsc.4 b/share/man/man4/man4.amiga/afsc.4 index dc125c2c729..72fd58ccc33 100644 --- a/share/man/man4/man4.amiga/afsc.4 +++ b/share/man/man4/man4.amiga/afsc.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: afsc.4,v 1.6 2001/08/03 15:21:16 mpech Exp $ +.\" $OpenBSD: afsc.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1994 Christian E. Hopps .\" All rights reserved. @@ -41,9 +41,10 @@ The .Tn Amiga architecture uses a common machine independent scsi sub-system -provided in the kernel source. The machine independent -drivers that use this code access the hardware through a -common interface. (see +provided in the kernel source. +The machine independent drivers that use this code access the hardware +through a common interface. +(see .Xr scsibus 4 ) This common interface interacts with a machine dependent interface, such as @@ -69,8 +70,8 @@ Commodore SCSI adapter, manufacturer\ 514, product\ 84 .Sh DIAGNOSTICS .Bl -diag .It afsc%s: abort %s: dstat %02x, sstat0 %02x sbcl %02x -The scsi operation %s was aborted due to error. Dstat, sstat and -sbcl are registers within the NCR53c710 SCSI chip. +The scsi operation %s was aborted due to error. +Dstat, sstat and sbcl are registers within the NCR53c710 SCSI chip. .It siop id %d reset\n" The NCR53c710 SCSI chip has been reset and configure at id %d. .It SIOP interrupt: %x sts %x msg %x sbcl %x diff --git a/share/man/man4/man4.amiga/ahsc.4 b/share/man/man4/man4.amiga/ahsc.4 index 278b840cd6f..82694a5fae6 100644 --- a/share/man/man4/man4.amiga/ahsc.4 +++ b/share/man/man4/man4.amiga/ahsc.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ahsc.4,v 1.8 2001/09/07 15:05:41 mpech Exp $ +.\" $OpenBSD: ahsc.4,v 1.9 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1994 Christian E. Hopps .\" All rights reserved. @@ -41,9 +41,10 @@ The .Tn Amiga architecture uses a common machine independent scsi sub-system -provided in the kernel source. The machine independent -drivers that use this code access the hardware through a -common interface. (see +provided in the kernel source. +The machine independent drivers that use this code access the hardware +through a common interface. +(see .Xr scsibus 4 ) This common interface interacts with a machine dependent interface, such as @@ -62,10 +63,11 @@ uses is based on the WD33c93 SCSI chip. .Bl -diag .It sbicwait TIMEO @%d with asr=x%x csr=x%x The 33c93 code (sbic) has been waiting too long for a SCSI chip -operation to complete. %d is the line in the source file +operation to complete. +%d is the line in the source file .Pa amiga/dev/sbic.c -at which the SCSI chip timed-out. Asr and csr are status registers -withing the SCSI chip. +at which the SCSI chip timed-out. +Asr and csr are status registers withing the SCSI chip. .It ahsc%d: abort %s: csr = 0x%02x, asr = 0x%02x A SCSI operation %s was aborted due to an error. .It ahsc%d: csr == 0x%02i diff --git a/share/man/man4/man4.amiga/atzsc.4 b/share/man/man4/man4.amiga/atzsc.4 index 03554b74f94..5bf6d85e2d3 100644 --- a/share/man/man4/man4.amiga/atzsc.4 +++ b/share/man/man4/man4.amiga/atzsc.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: atzsc.4,v 1.6 1999/07/09 13:35:45 aaron Exp $ +.\" $OpenBSD: atzsc.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1994 Christian E. Hopps .\" All rights reserved. @@ -28,7 +28,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: atzsc.4,v 1.6 1999/07/09 13:35:45 aaron Exp $ +.\" $Id: atzsc.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" .Dd August 31, 1994 .Dt ATZSC 4 amiga @@ -42,9 +42,10 @@ The .Tn Amiga architecture uses a common machine independent scsi sub-system -provided in the kernel source. The machine independent -drivers that use this code access the hardware through a -common interface. (see +provided in the kernel source. +The machine independent drivers that use this code access the hardware +through a common interface. +(see .Xr scsibus 4 ) This common interface interacts with a machine dependent interface, such as @@ -71,10 +72,11 @@ Commodore SCSI adapter, manufacturer\ 514, product\ 2 or product\ 3 .Bl -diag .It sbicwait TIMEO @%d with asr=x%x csr=x%x The 33c93 code (sbic) has been waiting too long for a SCSI chip -operation to complete. %d is the line in the source file +operation to complete. +%d is the line in the source file .Pa amiga/dev/sbic.c -at which the SCSI chip timed-out. Asr and csr are status registers -withing the SCSI chip. +at which the SCSI chip timed-out. +Asr and csr are status registers withing the SCSI chip. .It atzsc%d: abort %s: csr = 0x%02x, asr = 0x%02x A SCSI operation %s was aborted due to an error. .It atzsc%d: csr == 0x%02i diff --git a/share/man/man4/man4.amiga/autoconf.4 b/share/man/man4/man4.amiga/autoconf.4 index 84aa40ae00b..346356df5e5 100644 --- a/share/man/man4/man4.amiga/autoconf.4 +++ b/share/man/man4/man4.amiga/autoconf.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: autoconf.4,v 1.5 2000/03/02 14:46:44 todd Exp $ +.\" $OpenBSD: autoconf.4,v 1.6 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1990, 1991 Regents of the University of California. .\" All rights reserved. @@ -41,8 +41,8 @@ When 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 @@ -71,9 +71,9 @@ indicates that a second floppy drive was detected, but was not configured into the kernel. .Pp .It zbus0 at mainbus0 [mem 0x%x-0x%x]. -The kernel is configuring AutoConfigured expansion boards. If any Zorro -II memory was detected, the virtual address of the space reserved for -DMA bounce buffers is printed. +The kernel is configuring AutoConfigured expansion boards. +If any Zorro II memory was detected, the virtual address of the space +reserved for DMA bounce buffers is printed. .Pp .It %s at zbus0: rom 0x%x man/prod %d/%d. A Zorro expansion board was configured. diff --git a/share/man/man4/man4.amiga/bah.4 b/share/man/man4/man4.amiga/bah.4 index a3ee17378f3..40f200a1d08 100644 --- a/share/man/man4/man4.amiga/bah.4 +++ b/share/man/man4/man4.amiga/bah.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: bah.4,v 1.7 2000/11/10 20:02:18 todd Exp $ +.\" $OpenBSD: bah.4,v 1.8 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: bah.4,v 1.2 1995/06/06 23:41:37 cgd Exp $ .\" .\" Copyright (c) 1995 Ignatios Souvatzis @@ -57,8 +57,9 @@ The interface does not employ the address resolution protocol described in .Xr arp 4 to dynamically map between Internet and Ethernet addresses on the local -network. Instead, it uses the least significant 8 bits of the IP address -as hardware address, as described in +network. +Instead, it uses the least significant 8 bits of the IP address as hardware +address, as described in .Xr RFC 1051 and .Xr RFC 1201 @@ -69,8 +70,8 @@ deprecated, but popular among Amiga users, RFC 1051 encoding (that is, with simple header, packet type 240), and the MTU is 507. .Pp With the IFF_LINK0 flag set, IP encoding is done according to RFC 1201 (that -is, with Packet Header Definition Standard header and packet type 212). The MTU -is normally 1500. +is, with Packet Header Definition Standard header and packet type 212). +The MTU is normally 1500. .Pp When switching between the two modes, do a .Cd ifconfig interfacename down up diff --git a/share/man/man4/man4.amiga/gtsc.4 b/share/man/man4/man4.amiga/gtsc.4 index d7e640e7468..90daadd28ad 100644 --- a/share/man/man4/man4.amiga/gtsc.4 +++ b/share/man/man4/man4.amiga/gtsc.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: gtsc.4,v 1.8 2001/09/07 15:05:41 mpech Exp $ +.\" $OpenBSD: gtsc.4,v 1.9 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1994 Christian E. Hopps .\" All rights reserved. @@ -41,9 +41,10 @@ The .Tn Amiga architecture uses a common machine independent scsi sub-system -provided in the kernel source. The machine independent -drivers that use this code access the hardware through a -common interface. (see +provided in the kernel source. +The machine independent drivers that use this code access the hardware +through a common interface. +(see .Xr scsibus 4 ) This common interface interacts with a machine dependent interface, such as diff --git a/share/man/man4/man4.amiga/intro.4 b/share/man/man4/man4.amiga/intro.4 index 48ad8055fd6..bee67b621e9 100644 --- a/share/man/man4/man4.amiga/intro.4 +++ b/share/man/man4/man4.amiga/intro.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: intro.4,v 1.7 2001/10/04 22:03:45 miod Exp $ +.\" $OpenBSD: intro.4,v 1.8 2001/10/05 14:45:53 mpech Exp $ .\" Copyright (c) 1990, 1991 Regents of the University of California. .\" All rights reserved. .\" @@ -67,8 +67,8 @@ The networking support is introduced in .Sh DEVICE SUPPORT This section describes the hardware supported on the .Tn Amiga . -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 . @@ -81,9 +81,10 @@ 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 +95,8 @@ The autoconfiguration system is described in A list of the supported devices is given below. .Sh LIST OF DEVICES The devices listed below are supported in this incarnation of -the system. Pseudo-devices are not listed. +the system. +Pseudo-devices are not listed. Devices are indicated by their functional interface. Not all supported devices are listed. .Pp diff --git a/share/man/man4/man4.amiga/joy.4 b/share/man/man4/man4.amiga/joy.4 index 41e3a54de75..c902317fed5 100644 --- a/share/man/man4/man4.amiga/joy.4 +++ b/share/man/man4/man4.amiga/joy.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: joy.4,v 1.1 2000/09/03 14:46:46 espie Exp $ +.\" $OpenBSD: joy.4,v 1.2 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 2000 Marc Espie .\" All rights reserved. @@ -40,8 +40,9 @@ joysticks. The lower bit in the minor device number selects the joystick: 0 is the first joystick and 1 is the second. .Pp -The joystick connectors also accept mouses. There is no simple way to -find out whether a mouse or a joystick is currently plugged in. +The joystick connectors also accept mouses. +There is no simple way to find out whether a mouse or a joystick is currently +plugged in. .Pp The joystick is a digital device. Each .Fn read diff --git a/share/man/man4/man4.amiga/mfcs.4 b/share/man/man4/man4.amiga/mfcs.4 index 3e4ee286005..08fde007df8 100644 --- a/share/man/man4/man4.amiga/mfcs.4 +++ b/share/man/man4/man4.amiga/mfcs.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mfcs.4,v 1.3 2000/03/02 14:46:44 todd Exp $ +.\" $OpenBSD: mfcs.4,v 1.4 2001/10/05 14:45:53 mpech Exp $ .\" Copyright (c) 1990, 1991 The Regents of the University of California. .\" All rights reserved. .\" @@ -58,10 +58,12 @@ controls, among other things, a dual port communications interface with a multiple character buffer. .Pp Input and output for each MultiFaceCard III line may set to a maximum baud -rates of 1152000. Formula for baud rate: Baud = 230400 / N with 1 < N < 65536. +rates of 1152000. +Formula for baud rate: Baud = 230400 / N with 1 < N < 65536. .Pp Input and output for each MultiFaceCard II line may set to a maximum baud -rates of 57600. Formula for baud rate: Baud = 115200 / N with 1 < N < 65536. +rates of 57600. +Formula for baud rate: Baud = 115200 / N with 1 < N < 65536. .Sh FILES .Bl -tag -width Pa .It Pa /dev/ttyA? diff --git a/share/man/man4/man4.amiga/mgnsc.4 b/share/man/man4/man4.amiga/mgnsc.4 index 46fd6102051..08c80a51c8a 100644 --- a/share/man/man4/man4.amiga/mgnsc.4 +++ b/share/man/man4/man4.amiga/mgnsc.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mgnsc.4,v 1.6 2001/08/03 15:21:16 mpech Exp $ +.\" $OpenBSD: mgnsc.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1994 Christian E. Hopps .\" All rights reserved. @@ -41,9 +41,10 @@ The .Tn Amiga architecture uses a common machine independent scsi sub-system -provided in the kernel source. The machine independent -drivers that use this code access the hardware through a -common interface. (see +provided in the kernel source. +The machine independent drivers that use this code access the hardware +through a common interface. +(see .Xr scsibus 4 ) This common interface interacts with a machine dependent interface, such as @@ -61,8 +62,8 @@ uses is based on the NCR53c710 SCSI chip. .Sh DIAGNOSTICS .Bl -diag .It mgnsc%s: abort %s: dstat %02x, sstat0 %02x sbcl %02x -The scsi operation %s was aborted due to error. Dstat, sstat and -sbcl are registers within the NCR53c710 SCSI chip. +The scsi operation %s was aborted due to error. +Dstat, sstat and sbcl are registers within the NCR53c710 SCSI chip. .It siop id %d reset\n" The NCR53c710 SCSI chip has been reset and configure at id %d. .It SIOP interrupt: %x sts %x msg %x sbcl %x diff --git a/share/man/man4/man4.amiga/qn.4 b/share/man/man4/man4.amiga/qn.4 index c723c4e0a51..d36f7b1fa7e 100644 --- a/share/man/man4/man4.amiga/qn.4 +++ b/share/man/man4/man4.amiga/qn.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: qn.4,v 1.8 2001/01/29 02:11:09 niklas Exp $ +.\" $OpenBSD: qn.4,v 1.9 2001/10/05 14:45:53 mpech Exp $ .\" .\" .\" Copyright (c) 1995 Mika Kortelainen. All rights reserved. @@ -78,9 +78,11 @@ interface supports the following Zorro II expansion cards: Resource Management Force's ethernet card, manufacturer\ 2011, product\ 2 .El .Sh NOTES -Multicasting not done yet. If the driver happens to lock up, you may use +Multicasting not done yet. +If the driver happens to lock up, you may use .Xr ifconfig -to force the driver down and up again. This usually helps. +to force the driver down and up again. +This usually helps. .Sh HISTORY The .Nm diff --git a/share/man/man4/man4.amiga/wesc.4 b/share/man/man4/man4.amiga/wesc.4 index 7549bbf3ee0..187febda0ec 100644 --- a/share/man/man4/man4.amiga/wesc.4 +++ b/share/man/man4/man4.amiga/wesc.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: wesc.4,v 1.6 2001/08/03 15:21:16 mpech Exp $ +.\" $OpenBSD: wesc.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1994 Christian E. Hopps .\" All rights reserved. @@ -41,9 +41,10 @@ The .Tn Amiga architecture uses a common machine independent scsi sub-system -provided in the kernel source. The machine independent -drivers that use this code access the hardware through a -common interface. (see +provided in the kernel source. +The machine independent drivers that use this code access the hardware +through a common interface. +(see .Xr scsibus 4 ) This common interface interacts with a machine dependent interface, such as @@ -64,13 +65,14 @@ The interface supports the following Zorro III expansion cards: .Bl -tag -width "WARP ENGINE" -offset indent .It Em WARP ENGINE -MacroSystem Development Warp Engine internal SCSI, manufacturer\ 2203, product\ 19 +MacroSystem Development Warp Engine internal SCSI, manufacturer\ 2203, +product\ 19 .El .Sh DIAGNOSTICS .Bl -diag .It wesc%s: abort %s: dstat %02x, sstat0 %02x sbcl %02x -The scsi operation %s was aborted due to error. Dstat, sstat and -sbcl are registers within the NCR53c710 SCSI chip. +The scsi operation %s was aborted due to error. +Dstat, sstat and sbcl are registers within the NCR53c710 SCSI chip. .It siop id %d reset\n" The NCR53c710 SCSI chip has been reset and configure at id %d. .It SIOP interrupt: %x sts %x msg %x sbcl %x diff --git a/share/man/man4/man4.amiga/zssc.4 b/share/man/man4/man4.amiga/zssc.4 index 8687ef48c3c..5e14ea2c996 100644 --- a/share/man/man4/man4.amiga/zssc.4 +++ b/share/man/man4/man4.amiga/zssc.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: zssc.4,v 1.6 2001/08/03 15:21:16 mpech Exp $ +.\" $OpenBSD: zssc.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1994 Christian E. Hopps .\" All rights reserved. @@ -41,9 +41,10 @@ The .Tn Amiga architecture uses a common machine independent scsi sub-system -provided in the kernel source. The machine independent -drivers that use this code access the hardware through a -common interface. (see +provided in the kernel source. +The machine independent drivers that use this code access the hardware +through a common interface. +(see .Xr scsibus 4 ) This common interface interacts with a machine dependent interface, such as @@ -61,8 +62,8 @@ uses is based on the NCR53c710 SCSI chip. .Sh DIAGNOSTICS .Bl -diag .It zssc%s: abort %s: dstat %02x, sstat0 %02x sbcl %02x -The scsi operation %s was aborted due to error. Dstat, sstat and -sbcl are registers within the NCR53c710 SCSI chip. +The scsi operation %s was aborted due to error. +Dstat, sstat and sbcl are registers within the NCR53c710 SCSI chip. .It siop id %d reset\n" The NCR53c710 SCSI chip has been reset and configure at id %d. .It SIOP interrupt: %x sts %x msg %x sbcl %x diff --git a/share/man/man4/man4.hp300/apci.4 b/share/man/man4/man4.hp300/apci.4 index cca62d2866c..85b46cfa90d 100644 --- a/share/man/man4/man4.hp300/apci.4 +++ b/share/man/man4/man4.hp300/apci.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: apci.4,v 1.1 2001/05/11 01:39:54 millert Exp $ +.\" $OpenBSD: apci.4,v 1.2 2001/10/05 14:45:53 mpech Exp $ .\ .\" Copyright (c) 1990, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -51,7 +51,8 @@ all series 400 machines. The first UART is used to communicate with the Domain keyboard. The second is the serial console port when the firmware is in Domain/OS mode, and is mapped to select code 9 by the HP-UX firmware (except -on 425e models). As such, the second UART is handled by the +on 425e models). +As such, the second UART is handled by the .Xr dca 4 driver on all models but the 425e. .Pp diff --git a/share/man/man4/man4.hp300/autoconf.4 b/share/man/man4/man4.hp300/autoconf.4 index 2120ee78225..32166c13973 100644 --- a/share/man/man4/man4.hp300/autoconf.4 +++ b/share/man/man4/man4.hp300/autoconf.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: autoconf.4,v 1.3 2001/05/11 01:24:19 millert Exp $ +.\" $OpenBSD: autoconf.4,v 1.4 2001/10/05 14:45:53 mpech Exp $ .\ .\" Copyright (c) 1990, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -45,8 +45,8 @@ When 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. .Pp diff --git a/share/man/man4/man4.hp300/ct.4 b/share/man/man4/man4.hp300/ct.4 index b2d813a39fc..f726e8e523a 100644 --- a/share/man/man4/man4.hp300/ct.4 +++ b/share/man/man4/man4.hp300/ct.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ct.4,v 1.4 2001/05/11 01:24:19 millert Exp $ +.\" $OpenBSD: ct.4,v 1.5 2001/10/05 14:45:53 mpech Exp $ .\ .\" Copyright (c) 1990, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -91,8 +91,8 @@ Files .Pa rct8 through .Pa rct11 -refer to streaming rewind on close interfaces. (Only 9144 type devices -can stream.) +refer to streaming rewind on close interfaces. +(Only 9144 type devices can stream.) Lastly, .Pa rct12 through diff --git a/share/man/man4/man4.hp300/dcm.4 b/share/man/man4/man4.hp300/dcm.4 index bf90196d320..4d4c5b0b9fc 100644 --- a/share/man/man4/man4.hp300/dcm.4 +++ b/share/man/man4/man4.hp300/dcm.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: dcm.4,v 1.6 2001/09/23 05:55:25 millert Exp $ +.\" $OpenBSD: dcm.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\ .\" Copyright (c) 1990, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -56,7 +56,8 @@ is a four port .Pf ( Tn CCITT .Tn V.28 ) communications -multiplexer. The +multiplexer. +The .Tn 98642A has three direct-connect ports and one port with full modem control. diff --git a/share/man/man4/man4.hp300/dv.4 b/share/man/man4/man4.hp300/dv.4 index 576bcd40070..540b0fe875b 100644 --- a/share/man/man4/man4.hp300/dv.4 +++ b/share/man/man4/man4.hp300/dv.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: dv.4,v 1.4 2001/05/11 01:24:19 millert Exp $ +.\" $OpenBSD: dv.4,v 1.5 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -49,8 +49,9 @@ This driver is for the .Tn HP98730 and 98731 graphics device, also known as -the DaVinci. This driver has not been tested with all possible -combinations of frame buffer boards and scan boards installed in the device. +the DaVinci. +This driver has not been tested with all possible combinations of frame +buffer boards and scan boards installed in the device. The driver merely checks for the existence of the device and does minimal set up. .Pp @@ -65,7 +66,8 @@ setting these values. .Pp A user process communicates to the device initially by means of .Xr ioctl 2 -calls. For the +calls. +For the .Tn HP-UX .Xr ioctl calls supported, refer to @@ -82,18 +84,20 @@ Get info about device, setting the entries in the .Ar grfinfo structure, as defined in .Aq Pa hpdev/grfioctl.h . -For the standard 98730, the number of planes should be 4. The number of -colors would therefore be 15, excluding black. If one 98732A frame buffer -board is installed, there will still be 4 planes, with the 4 planes on the -colormap board becoming overlay planes. With each additional 98732 frame -buffer board 4 planes will be added up to a maximum of 32 planes total. +For the standard 98730, the number of planes should be 4. +The number of colors would therefore be 15, excluding black. +If one 98732A frame buffer board is installed, there will still be 4 planes, +with the 4 planes on the colormap board becoming overlay planes. +With each additional 98732 frame buffer board 4 planes will be added up +to a maximum of 32 planes total. .It Dv GRFIOCON Graphics On .Pp Turn graphics on by enabling .Tn CRT -output. The screen will come on, displaying -whatever is in the frame buffer, using whatever colormap is in place. +output. +The screen will come on, displaying whatever is in the frame buffer, using +whatever colormap is in place. .It Dv GRFIOCOFF Graphics Off .Pp @@ -104,9 +108,9 @@ are not affected. .It Dv GRFIOCMAP Map Device to user space .Pp -Map in control registers and frame buffer space. Once the device file is -mapped, the frame buffer structure is accessible. The structure describing -the 98730 is defined in +Map in control registers and frame buffer space. +Once the device file is mapped, the frame buffer structure is accessible. +The structure describing the 98730 is defined in .Aq Pa hpdev/grf_dvreg.h . .El .Sh EXAMPLES diff --git a/share/man/man4/man4.hp300/gb.4 b/share/man/man4/man4.hp300/gb.4 index 54b05bde87d..580edee7afd 100644 --- a/share/man/man4/man4.hp300/gb.4 +++ b/share/man/man4/man4.hp300/gb.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: gb.4,v 1.4 2001/05/11 01:24:19 millert Exp $ +.\" $OpenBSD: gb.4,v 1.5 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -49,23 +49,27 @@ This driver is for the .Tn HP98700 and 98710 graphics devices, also known as -the Gatorbox. The term ``Gator'' will often be used, and it is not to be +the Gatorbox. +The term ``Gator'' will often be used, and it is not to be confused with ``Gator'' used in reference to an .Tn HP 9837 or 200/237 machine. Also, the term Gatorbox is used for the 98700 alone, with the 98701 frame -buffer memory or with the 98710 accelerator installed. This driver merely -checks for the existence of the device and does minimal set up, as it is -expected the applications will initialize the device to their requirements. +buffer memory or with the 98710 accelerator installed. +This driver merely checks for the existence of the device and does minimal +set up, as it is expected the applications will initialize the device to their +requirements. .Pp The 98700 can be used as the only graphics device on a system, in which case -it will be used as the system console. It can also be installed as a secondary -display device. For the first case, the +it will be used as the system console. +It can also be installed as a secondary display device. +For the first case, the .Tn HP .Tn 98287A M.A.D. interface card -should be set to internal control space. This will put the frame buffer at -the DIO address 0x200000 and the control registers at 0x560000. +should be set to internal control space. +This will put the frame buffer at the DIO address 0x200000 and the control +registers at 0x560000. At this address it will be the ``preferred'' console device (see .Xr cons 4 ) . For use as a secondary device, @@ -93,16 +97,18 @@ Get info about device, setting the entries in the .Em grfinfo structure, as defined in .Aq Pa hpdev/grfioctl.h . -For the standard 98700, the number of planes should be 4. The number of -colors would therefore be 15, excluding black. With the 98701 option installed -there will be another 4 planes for a total of 8, giving 255 colors. +For the standard 98700, the number of planes should be 4. +The number of colors would therefore be 15, excluding black. +With the 98701 option installed there will be another 4 planes for a total of 8, +giving 255 colors. .It Dv GRFIOCON Graphics On .Pp Turn graphics on by enabling .Tn CRT -output. The screen will come on, displaying -whatever is in the frame buffer, using whatever colormap is in place. +output. +The screen will come on, displaying whatever is in the frame buffer, using +whatever colormap is in place. .It Dv GRFIOCOFF Graphics Off .Pp @@ -113,8 +119,8 @@ are not affected. .It Dv GRFIOCMAP Map Device to user space .Pp -Map in control registers and framebuffer space. Once the device file is -mapped, the frame buffer structure is accessible. +Map in control registers and framebuffer space. +Once the device file is mapped, the frame buffer structure is accessible. The frame buffer structure describing the 98700 is given in .Aq Pa hpdev/grf_gbreg.h . diff --git a/share/man/man4/man4.hp300/grf.4 b/share/man/man4/man4.hp300/grf.4 index ae8699bfba6..b368ff4598a 100644 --- a/share/man/man4/man4.hp300/grf.4 +++ b/share/man/man4/man4.hp300/grf.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: grf.4,v 1.5 2001/05/11 01:24:20 millert Exp $ +.\" $OpenBSD: grf.4,v 1.6 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -88,8 +88,9 @@ such as that used for the X Window System servers, has also been successful. Examples of some frame buffer operations can be found in the device dependent X Window system sources, for example the .Pa /usr/src/new/X/libhp.fb -directory. These files contain examples of device dependent color map -initialization, frame buffer operations, bit moving routines etc. +directory. +These files contain examples of device dependent color map initialization, +frame buffer operations, bit moving routines etc. .Pp The basic programming of the .Nm grf Ns ? @@ -131,8 +132,9 @@ Graphics On .Pp Turn graphics on by enabling .Tn CRT -output. The screen will come on, displaying -whatever is in the frame buffer, using whatever colormap is in place. +output. +The screen will come on, displaying whatever is in the frame buffer, using +whatever colormap is in place. .It Dv GRFIOCOFF Graphics Off .Pp @@ -143,8 +145,8 @@ are not affected. .It Dv GRFIOCMAP Map Device to user space .Pp -Map in control registers and framebuffer space. Once the device file is -mapped, the frame buffer structure is accessible. +Map in control registers and framebuffer space. +Once the device file is mapped, the frame buffer structure is accessible. .It Dv GRFIOCUNMAP Unmap Device .Pp diff --git a/share/man/man4/man4.hp300/hd.4 b/share/man/man4/man4.hp300/hd.4 index f757f98878b..673d1cc6fe5 100644 --- a/share/man/man4/man4.hp300/hd.4 +++ b/share/man/man4/man4.hp300/hd.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hd.4,v 1.2 2001/06/20 16:49:43 millert Exp $ +.\" $OpenBSD: hd.4,v 1.3 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -80,13 +80,12 @@ Special file names begin with .Sq Li hd and .Sq Li rhd -for the block and character files respectively. The second -component of the name, a drive unit number in the range of zero to +for the block and character files respectively. +The second component of the name, a drive unit number in the range of zero to seven, is represented by a .Sq Li ? -in the disk layouts below. The last component of the name is the -file system partition -and is designated +in the disk layouts below. +The last component of the name is the file system partition and is designated by a letter from .Sq Li a to diff --git a/share/man/man4/man4.hp300/hil.4 b/share/man/man4/man4.hp300/hil.4 index 44609b4bf93..9594e1a776d 100644 --- a/share/man/man4/man4.hp300/hil.4 +++ b/share/man/man4/man4.hp300/hil.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hil.4,v 1.5 2001/08/20 05:57:55 mpech Exp $ +.\" $OpenBSD: hil.4,v 1.6 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -67,7 +67,8 @@ there can only be one keyboard and it must be the first device The device file that corresponds to a particular .Tn HIL device is determined -by the order of the devices on the loop. For instance, if the +by the order of the devices on the loop. +For instance, if the .Tn ID module is the second physical device on the loop, then @@ -111,7 +112,8 @@ and a header containing the size of the queue, and its head and tail indices. The system deposits event data at the tail of the queue, a process extracts it from the head. Extracting an event is done by copying it from the queue and then updating -the head appropriately (i.e. head = (head + 1) % qsize). +the head appropriately (i.e. +head = (head + 1) % qsize). It is up to the process to ensure that packets are removed from the queue quickly enough to prevent the queue from filling. The system, when it determines that the queue is full, @@ -184,8 +186,8 @@ ioctl. .It Dv HILIOCSC Report Security Code .Pp -Request the security code record from a device. The security code can -vary from 1 byte to 15, and is only supported by some +Request the security code record from a device. +The security code can vary from 1 byte to 15, and is only supported by some .Tn HIL devices. Identical to the diff --git a/share/man/man4/man4.hp300/intro.4 b/share/man/man4/man4.hp300/intro.4 index 9e1070b23f2..62f8bda39ea 100644 --- a/share/man/man4/man4.hp300/intro.4 +++ b/share/man/man4/man4.hp300/intro.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: intro.4,v 1.7 2001/10/04 22:03:45 miod Exp $ +.\" $OpenBSD: intro.4,v 1.8 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -69,8 +69,8 @@ The networking support is introduced in This section describes the hardware supported on the .Tn HP 9000/300 series. -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 . @@ -83,9 +83,10 @@ 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, @@ -96,7 +97,8 @@ The autoconfiguration system is described in A list of the supported devices is given below. .Sh LIST OF DEVICES The devices listed below are supported in this incarnation of -the system. Pseudo-devices are not listed. +the system. +Pseudo-devices are not listed. Devices are indicated by their functional interface. Not all supported devices are listed. .Pp diff --git a/share/man/man4/man4.hp300/st.4 b/share/man/man4/man4.hp300/st.4 index a838d66bd9b..aaf15e35818 100644 --- a/share/man/man4/man4.hp300/st.4 +++ b/share/man/man4/man4.hp300/st.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: st.4,v 1.6 2001/05/11 01:24:20 millert Exp $ +.\" $OpenBSD: st.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -53,12 +53,12 @@ The driver was written especially to support the Exabyte .Tn EXB-8200 8MM Cartridge -Tape Subsystem. It has several extensions specific to the Exabyte, -but should support other tape drives as long has they follow -the +Tape Subsystem. +It has several extensions specific to the Exabyte, but should support other +tape drives as long has they follow the .Tn ANSI SCSI-I -specification. Besides extensive use with -an Exabyte, the driver has been tested with an +specification. +Besides extensive use with an Exabyte, the driver has been tested with an Archive .Tn QIC-24 tape drive. @@ -70,8 +70,9 @@ as described in with the following exceptions: .Bl -enum .It -Density is dependent on device type. Current Exabyte hardware has -only one density. The +Density is dependent on device type. +Current Exabyte hardware has only one density. +The .Tn EXB-8500 drive, when released, will have a high density format of @@ -107,22 +108,24 @@ struct mtget { .Ed .Pp Bit 4 in the minor device number is used -to select long filemarks or short filemarks. A long filemark occupies -2.12 MBytes of space on the tape, while a short filemark occupies 488 KBytes. +to select long filemarks or short filemarks. +A long filemark occupies 2.12 MBytes of space on the tape, while a short +filemark occupies 488 KBytes. A long filemark includes an erase gap while the short filemark does not. The tape can be positioned on the .Tn BOT side of a long filemark allowing -data to be appended with a write operation. Since the short filemark does not -contain an erase gap which would allow writing it is considered to be -non-erasable. If either type of filemark is followed by blank tape, -data may be appended on its +data to be appended with a write operation. +Since the short filemark does not contain an erase gap which would allow +writing it is considered to be non-erasable. +If either type of filemark is followed by blank tape, data may be appended +on its .Tn EOT side. .Pp Bit 5 in the minor device number selects fixed block mode with a block -size of 1K. Variable length records are the default if bit 5 is not -set. +size of 1K. +Variable length records are the default if bit 5 is not set. .Pp For unit 0 here are the effects of minor device bits 2,3,4,5. For other units add the @@ -167,19 +170,20 @@ transfers. If odd length is requested the driver will use the "Program Transfer Mode" of the Fujitsu .Tn MB87030 -chip. Read requests are -normally even length for which a +chip. +Read requests are normally even length for which a .Tn DMA transfer is used. If, however, the driver detects that a odd length read has happened (when a even length was requested) it will issue the .Dv EIO error and the last byte of the read -data will be 0x00. Odd length read requests must match the size of the -requested data block on tape. +data will be 0x00. +Odd length read requests must match the size of the requested data block +on tape. .Pp -The following only applies when using long filemarks. Short filemarks can -not be overwritten. +The following only applies when using long filemarks. +Short filemarks can not be overwritten. .Bd -filled -offset 4n Due to the helical scan and the erase mechanism, there is a writing limitation on Exabyte drives. @@ -188,10 +192,12 @@ or .Dq Li tar u will not work .Pf ( Dq Li tar c -is ok). One can only start writing at 1) beginning of tape, 2) on the +is ok). +One can only start writing at 1) beginning of tape, 2) on the end of what was last written, 3) "front" side of a regular (long) filemark. -For example, you have a tape with 3 tar files. If you want to save the first -file, but overwrite the second two files with new data, on a normal +For example, you have a tape with 3 tar files. +If you want to save the first file, but overwrite the second two files with +new data, on a normal 1/4" or 1/2" drive you would do: .Pp .Li "mt fsf 1; tar cf /dev/nrst0 ..." @@ -201,29 +207,34 @@ but for an Exabyte you need to do: .Li "mt fsf 1; mt bsf 1; mt weof 1; tar cf /dev/nrst0 ..." .Pp The regular long filemark consists of an erased zone 3.8" long -(needed to begin a write). In this case, the first filemark is -rewritten in place, which creates an erased zone +(needed to begin a write). +In this case, the first filemark is rewritten in place, which creates an +erased zone .Em after it, clearing the -way to write more on the tape. The erase head is not helical. +way to write more on the tape. +The erase head is not helical. .Pp One can position a tape to the end of what was last written by reading until a .Tn \*qBLANK CHECK\*q -error is returned. Writing can be started at this -point. (This applies to both long and short filemarks.) The tape does -not become positioned somewhere down the "erased" area as does a -conventional magtape. One can issue multiple reads at the +error is returned. +Writing can be started at this point. +(This applies to both long and short filemarks.) +The tape does not become positioned somewhere down the "erased" area as +does a conventional magtape. +One can issue multiple reads at the .Tn \*qBLANK CHECK\*q error, but the Exabyte stays positioned at the beginning of the -blank area, ready to accept write commands. File skip operations do -not stop at blank tape and will run into old data or run to the end of -the tape, so you have to be careful not to +blank area, ready to accept write commands. +File skip operations do not stop at blank tape and will run into old data +or run to the end of the tape, so you have to be careful not to .Dq Li mt fsf too_many . .Ed .Pp Archive support gets confused if asked to moved more filemarks than there are on the tape. .Pp -This man page needs some work. Some of these are not really bugs, -just unavoidable consequences of the hardware. +This man page needs some work. +Some of these are not really bugs, just unavoidable consequences of the +hardware. diff --git a/share/man/man4/man4.hp300/tc.4 b/share/man/man4/man4.hp300/tc.4 index 808d71b916d..9c8070d5c39 100644 --- a/share/man/man4/man4.hp300/tc.4 +++ b/share/man/man4/man4.hp300/tc.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tc.4,v 1.5 2001/05/11 01:24:21 millert Exp $ +.\" $OpenBSD: tc.4,v 1.6 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -60,13 +60,14 @@ Topcat will be referred to from now on. .Pp The Topcat display cards are not user configurable. If one is present on a system, it will always have a frame buffer address of 0x200000 and a control -register address of 0x560000. These are the +register address of 0x560000. +These are the .Tn HP series 300 .Tn ITE (Internal -Terminal Emulator) defaults. The device can also be used as a graphics output -device. +Terminal Emulator) defaults. +The device can also be used as a graphics output device. .Pp The .Xr ioctl 2 @@ -94,8 +95,9 @@ Graphics On .Pp Turn graphics on by enabling .Tn CRT -output. The screen will come on, displaying -whatever is in the frame buffer, using whatever colormap is in place. +output. +The screen will come on, displaying whatever is in the frame buffer, +using whatever colormap is in place. .It Dv GRFIOCOFF Graphics Off .Pp @@ -106,9 +108,9 @@ are not affected. .It Dv GRFIOCMAP Map Device to user space .Pp -Map in control registers and framebuffer space. Once the device file is -mapped, the frame buffer structure is accessible. The frame buffer structure -describing Topcat/Catseye devices is defined in +Map in control registers and framebuffer space. +Once the device file is mapped, the frame buffer structure is accessible. +The frame buffer structure describing Topcat/Catseye devices is defined in .Aq Pa hpdev/grf_tcreg.h . .El .Pp diff --git a/share/man/man4/man4.hppa/lasi.4 b/share/man/man4/man4.hppa/lasi.4 index 7ca14ea895f..d52aa11bc43 100644 --- a/share/man/man4/man4.hppa/lasi.4 +++ b/share/man/man4/man4.hppa/lasi.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: lasi.4,v 1.5 2001/08/03 15:21:16 mpech Exp $ +.\" $OpenBSD: lasi.4,v 1.6 2001/10/05 14:45:53 mpech Exp $ .\" .\" .\" Copyright (c) 1999 Michael Shalayeff @@ -80,7 +80,8 @@ Hewlett Packard .Rs "712 I/O Subsystem ERS" Revision 1.1, 12 February 1993 .br -Hewlett Packard, Dwg No. A-A2263-66510-31 +Hewlett Packard, Dwg No. +A-A2263-66510-31 .Re .Rs Hewlett-Packard Journal diff --git a/share/man/man4/man4.i386/apm.4 b/share/man/man4/man4.i386/apm.4 index 85db2934ade..a0fb550a890 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.17 2001/08/20 05:57:55 mpech Exp $ +.\" $OpenBSD: apm.4,v 1.18 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1998 Marco S. Hyman .\" @@ -230,16 +230,19 @@ As noted above, the operation of the driver can be modified using the .Dv machdep.apmwarn .Xr sysctl 8 -variable. Another driver modifier is the +variable. +Another driver modifier is the .Dv machdep.apmhalt -variable. When +variable. +When .Dv machdep.apmhalt is set to 1 the .Tn APM power down code is modified in a way necessary for correct operation on some systems, mainly .Tn IBM -laptops. If your system does not power down when given the command +laptops. +If your system does not power down when given the command .Li "halt -p" try setting .Dv machdep.apmhalt diff --git a/share/man/man4/man4.i386/bktr.4 b/share/man/man4/man4.i386/bktr.4 index 46c4f5adf8a..39d0dc23a2c 100644 --- a/share/man/man4/man4.i386/bktr.4 +++ b/share/man/man4/man4.i386/bktr.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: bktr.4,v 1.7 2001/08/03 14:30:26 mpech Exp $ +.\" $OpenBSD: bktr.4,v 1.8 2001/10/05 14:45:54 mpech Exp $ .\" $FreeBSD: /c/ncvs/src/share/man/man4/bktr.4,v 1.9.2.5 2001/03/06 19:08:09 ru Exp $ .\" .Dd January 28, 1998 @@ -16,7 +16,8 @@ The .Nm driver provides support for PCI video capture and VBI capture on low cost, -high performance boards. This should support most video cards based on the +high performance boards. +This should support most video cards based on the Brooktree Bt848/849/878/879 Video Capture Chip. The driver also supports FM Radio if the Tuner supports it. .Pp @@ -49,7 +50,8 @@ The following kernel configuration options are available: .Bl -tag -width xxxxxxxx .It Cd option BROOKTREE_ALLOC_PAGES=nnn Specifies the number of contiguous pages to allocate when successfully -probed. The default number of pages allocated by the kernel is 216. +probed. +The default number of pages allocated by the kernel is 216. This means that there are (216*4096) bytes available for use. .It Cd option BROOKTREE_SYSTEM_DEFAULT="(BROOKTREE_PAL | BROOKTREE_NTSC)" One of these options can be used to set the default video format for the driver. diff --git a/share/man/man4/man4.i386/intro.4 b/share/man/man4/man4.i386/intro.4 index c4e90dc1b7e..063045173df 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.25 2001/10/04 22:03:45 miod Exp $ +.\" $OpenBSD: intro.4,v 1.26 2001/10/05 14:45:54 mpech 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,10 @@ 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, @@ -90,7 +91,8 @@ The autoconfiguration system is described in A list of the supported devices is given below. .Sh LIST OF DEVICES The devices listed below are supported in this incarnation of -the system. Pseudo-devices are not listed. +the system. +Pseudo-devices are not listed. Devices are indicated by their functional interface. Not all supported devices are listed. .Pp @@ -110,7 +112,8 @@ AdvanSys PCI wide SCSI Host Adapters. .It aic Adaptec AIC-6260, Adaptec AIC-6360, Adaptec 152x, and SoundBlaster SCSI boards. .It ami -American Megatrends Inc. MegaRAID Controllers. +American Megatrends Inc. +MegaRAID Controllers. .It an Aironet Communications 4500/4800 IEEE 802.11DS wireless network adapter. .It apm diff --git a/share/man/man4/man4.i386/pcibios.4 b/share/man/man4/man4.i386/pcibios.4 index 69e8c061ddb..3abee2c7b65 100644 --- a/share/man/man4/man4.i386/pcibios.4 +++ b/share/man/man4/man4.i386/pcibios.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pcibios.4,v 1.11 2001/08/03 15:21:16 mpech Exp $ +.\" $OpenBSD: pcibios.4,v 1.12 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: pcibios.4,v 1.7 2000/08/03 13:32:39 soda Exp $ .\" .\" Copyright (c) 2000 Michale Shalayeff, All rights reserved. @@ -53,13 +53,15 @@ using information extracted from the BIOS. .Pp Ideally, the boot firmware of a machine (a.k.a. BIOS) should set up all PCI devices; assigning them I/O and memory addresses and -interrupts. Alas, this does not always happen, so there is some +interrupts. +Alas, this does not always happen, so there is some PC specific code that can do the initialization when .Ox boots. .Pp Flags is a bit mask each bit of which specifies a fixup procedure to -omit. The following list specifies these procedures and gives +omit. +The following list specifies these procedures and gives flags bit values to disable them in case they cause problems. .Pp .Bl -tag -width 0x0000 @@ -67,8 +69,8 @@ flags bit values to disable them in case they cause problems. Fixup PCI I/O and memory addresses. .Pp Some BIOS implementations don't allocate I/O space and -memory space for all PCI devices. Especially, a BIOS -which has +memory space for all PCI devices. +Especially, a BIOS which has .Qq PnP OS mode enabled shows this behavior. Since necessary space isn't allocated, those devices @@ -91,16 +93,16 @@ bridges. .Pp Each PCI bus and CardBus should have a unique bus number. But some BIOS implementations don't assign a bus number -for subordinate PCI buses. And many BIOS implementations -don't assign a bus number for CardBuses. +for subordinate PCI buses. +And many BIOS implementations don't assign a bus number for CardBuses. .Pp A typical symptom of this is the following boot message: .D1 Sy cardbus0 at cardslot0: bus 0 device 0... Please note that this cardbus0 has a bus number .Sq 0 , but normally the bus number 0 is used by the machine's -primary PCI bus. Thus, this bus number for cardbus is -incorrect +primary PCI bus. +Thus, this bus number for cardbus is incorrect .Pq not assigned . In this situation, a device located in cardbus0 doesn't show correct device ID, diff --git a/share/man/man4/man4.i386/xf86.4 b/share/man/man4/man4.i386/xf86.4 index 98eff4ad8a5..fa64d1acdba 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.15 2001/08/17 11:13:58 mpech Exp $ +.\" $OpenBSD: xf86.4,v 1.16 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1998 Matthieu Herrb .\" All rights reserved. @@ -56,7 +56,8 @@ The possible values for are: .Bl -tag -width Ds .It 0 -the aperture driver is disabled. Opening it returns +the aperture driver is disabled. +Opening it returns .Dv EPERM. .It 1 the aperture driver allows access to standard VGA framebuffer and diff --git a/share/man/man4/man4.mac68k/adb.4 b/share/man/man4/man4.mac68k/adb.4 index bb096ecb1e4..590ea44cc3f 100644 --- a/share/man/man4/man4.mac68k/adb.4 +++ b/share/man/man4/man4.mac68k/adb.4 @@ -28,7 +28,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $OpenBSD: adb.4,v 1.4 2001/10/04 10:28:20 wilfried Exp $ +.\" $OpenBSD: adb.4,v 1.5 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: adb.4,v 1.1 1997/07/18 02:13:42 ender Exp $ .\" .Dd July 17, 1997 @@ -106,8 +106,9 @@ Device Info The .Nm event device will return an array of information containing an entry -for each device connected to the bus. Each entry contains the -current address, default address, and handler ID for the corresponding +for each device connected to the bus. +Each entry contains the current address, default address, and handler ID for +the corresponding .Tn ADB device. .It Dv ADBIOC_GETREPEAT diff --git a/share/man/man4/man4.mac68k/ae.4 b/share/man/man4/man4.mac68k/ae.4 index 19c60092bed..044e1b4ece2 100644 --- a/share/man/man4/man4.mac68k/ae.4 +++ b/share/man/man4/man4.mac68k/ae.4 @@ -27,7 +27,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $OpenBSD: ae.4,v 1.3 1999/07/07 10:50:09 aaron Exp $ +.\" $OpenBSD: ae.4,v 1.4 2001/10/05 14:45:54 mpech Exp $ .\" .Dd June 7, 1997 .Dt AE 4 mac68k @@ -41,8 +41,8 @@ The .Nm interface provides access to a 10 Mb/s Ethernet network via the -National Semiconductor DP8390 Ethernet chip set. This set includes -the DP83902. +National Semiconductor DP8390 Ethernet chip set. +This set includes the DP83902. .Pp Each of the host's network addresses is specified at boot time with an .Dv SIOCSIFADDR diff --git a/share/man/man4/man4.mac68k/autoconf.4 b/share/man/man4/man4.mac68k/autoconf.4 index bd822721c4c..5327f01bd01 100644 --- a/share/man/man4/man4.mac68k/autoconf.4 +++ b/share/man/man4/man4.mac68k/autoconf.4 @@ -29,7 +29,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $OpenBSD: autoconf.4,v 1.2 1999/06/05 13:18:36 aaron Exp $ +.\" $OpenBSD: autoconf.4,v 1.3 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: autoconf.4,v 1.2 1997/10/13 11:23:30 lukem Exp $ .\" .Dd July 17, 1997 @@ -44,8 +44,8 @@ When 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 diff --git a/share/man/man4/man4.mac68k/intro.4 b/share/man/man4/man4.mac68k/intro.4 index 338d72419cb..d42f2e9f9e7 100644 --- a/share/man/man4/man4.mac68k/intro.4 +++ b/share/man/man4/man4.mac68k/intro.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: intro.4,v 1.5 2001/10/04 22:03:45 miod Exp $ +.\" $OpenBSD: intro.4,v 1.6 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: intro.4,v 1.4 1997/03/28 00:29:35 veego Exp $ .\" .\" Copyright (c) 1990, 1991 Regents of the University of California. @@ -69,8 +69,8 @@ The networking support is introduced in .Sh DEVICE SUPPORT This section describes the hardware supported on the .Tn Mac . -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 . @@ -83,9 +83,10 @@ 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, @@ -96,7 +97,8 @@ The autoconfiguration system is described in A list of the supported devices is given below. .Sh LIST OF DEVICES The devices listed below are supported in this incarnation of -the system. Pseudo-devices are not listed. +the system. +Pseudo-devices are not listed. Devices are indicated by their functional interface. Not all supported devices are listed. .Pp diff --git a/share/man/man4/man4.macppc/abtn.4 b/share/man/man4/man4.macppc/abtn.4 index b7f496a7613..610fb97b899 100644 --- a/share/man/man4/man4.macppc/abtn.4 +++ b/share/man/man4/man4.macppc/abtn.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: abtn.4,v 1.3 2001/10/03 04:32:37 drahn Exp $ +.\" $OpenBSD: abtn.4,v 1.4 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 2001 Peter Philipp .\" All rights reserved. @@ -37,9 +37,10 @@ .Sh DESCRIPTION The .Nm -driver allows you to dim the brightness of your display. This driver only -currently recognizes the dim and brightness button. Sound, numlock and -eject buttons are also handled by this driver but are silently ignored. +driver allows you to dim the brightness of your display. +This driver only currently recognizes the dim and brightness button. +Sound, numlock and eject buttons are also handled by this driver but +are silently ignored. .Sh SEE ALSO .Xr adb 4 , .Xr aed 4 @@ -49,5 +50,6 @@ The driver was written by Tsubai Masanari for .Nx . .Sh BUGS -The bright/dim buttons currently don't work on new 2001 iBooks. It's best -to just disable the driver to avoid freeze ups when pressing these buttons. +The bright/dim buttons currently don't work on new 2001 iBooks. +It's best to just disable the driver to avoid freeze ups when pressing +these buttons. diff --git a/share/man/man4/man4.macppc/adb.4 b/share/man/man4/man4.macppc/adb.4 index 7c05e8e69ac..673a3db5d08 100644 --- a/share/man/man4/man4.macppc/adb.4 +++ b/share/man/man4/man4.macppc/adb.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: adb.4,v 1.3 2001/10/03 04:32:37 drahn Exp $ +.\" $OpenBSD: adb.4,v 1.4 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 2001 Peter Philipp .\" Copyright (c) 1997 Colin Wood @@ -80,7 +80,8 @@ The .Nm interface first appeared in .Nx 0.9 . -It has been under development ever since. The original +It has been under development ever since. +The original .Xr adb 4 manpage was written by Colin Wood for .Nx diff --git a/share/man/man4/man4.macppc/intro.4 b/share/man/man4/man4.macppc/intro.4 index 82509b81aec..a91b4c6c47a 100644 --- a/share/man/man4/man4.macppc/intro.4 +++ b/share/man/man4/man4.macppc/intro.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: intro.4,v 1.3 2001/10/04 22:03:46 miod Exp $ +.\" $OpenBSD: intro.4,v 1.4 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 2001 Peter Valchev. .\" All rights reserved. @@ -64,8 +64,8 @@ The networking support is introduced in .Sh DEVICE SUPPORT This section describes the hardware supported on the MacPPC 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 . @@ -78,9 +78,10 @@ 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, @@ -91,7 +92,8 @@ The configuration system is described in A list of the supported devices is given below. .Sh LIST OF DEVICES The devices listed below are supported in this incarnation of -the system. Pseudo-devices are not listed. +the system. +Pseudo-devices are not listed. Devices are indicated by their functional interface. Not all supported devices are listed. .Pp diff --git a/share/man/man4/man4.macppc/zs.4 b/share/man/man4/man4.macppc/zs.4 index 3349dea76a8..c246f602aef 100644 --- a/share/man/man4/man4.macppc/zs.4 +++ b/share/man/man4/man4.macppc/zs.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: zs.4,v 1.1 2001/10/03 04:32:37 drahn Exp $ +.\" $OpenBSD: zs.4,v 1.2 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1998 The OpenBSD Project .\" All rights reserved. @@ -44,8 +44,8 @@ The driver now supports cua minor devices, but with this known deficiency in the simultaneous outgoing/incoming aspect of the driver: The first outgoing connection succeeds, but second and subsequent -connections fail, apparently due to a getty hang. The hung getty apparently -prevents the cua device from being re-opened. +connections fail, apparently due to a getty hang. +The hung getty apparently prevents the cua device from being re-opened. .Sh FILES .Bl -tag -width Pa -compact .It Pa /dev/tty00 diff --git a/share/man/man4/man4.mvme68k/intro.4 b/share/man/man4/man4.mvme68k/intro.4 index 1af8fcfc756..a21fc293bda 100644 --- a/share/man/man4/man4.mvme68k/intro.4 +++ b/share/man/man4/man4.mvme68k/intro.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: intro.4,v 1.8 2001/10/04 22:03:46 miod Exp $ +.\" $OpenBSD: intro.4,v 1.9 2001/10/05 14:45:54 mpech Exp $ .\" Copyright (c) 1990, 1991 Regents of the University of California. .\" All rights reserved. .\" @@ -68,8 +68,8 @@ The networking support is introduced in This section describes the hardware supported on the .Tn mvme68k 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 . @@ -82,9 +82,10 @@ 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, @@ -95,7 +96,8 @@ The autoconfiguration system is described in A list of the supported devices is given below. .Sh LIST OF DEVICES The devices listed below are supported in this incarnation of -the system. Pseudo-devices are not listed. +the system. +Pseudo-devices are not listed. Devices are indicated by their functional interface. Not all supported devices are listed. .Pp diff --git a/share/man/man4/man4.sparc/cgfourteen.4 b/share/man/man4/man4.sparc/cgfourteen.4 index 89e8e1fb4bf..6a78e09536e 100644 --- a/share/man/man4/man4.sparc/cgfourteen.4 +++ b/share/man/man4/man4.sparc/cgfourteen.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cgfourteen.4,v 1.8 2001/06/23 07:04:18 pjanzen Exp $ +.\" $OpenBSD: cgfourteen.4,v 1.9 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: cgfourteen.4,v 1.3 1998/06/11 08:32:20 fair Exp $ .\" .\" Copyright (c) 1996 The President and Fellows of Harvard College. @@ -53,9 +53,8 @@ The .Nm cgfourteen is a memory based color frame buffer, with graphics acceleration and -overlay capabilities. Its pixel memory can be mapped into a user process -address space by using -the +overlay capabilities. +Its pixel memory can be mapped into a user process address space by using the .Xr mmap 2 system call. The diff --git a/share/man/man4/man4.sparc/esp.4 b/share/man/man4/man4.sparc/esp.4 index 2da7a334fcd..c8939933ba1 100644 --- a/share/man/man4/man4.sparc/esp.4 +++ b/share/man/man4/man4.sparc/esp.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: esp.4,v 1.4 1999/07/09 13:35:42 aaron Exp $ +.\" $OpenBSD: esp.4,v 1.5 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1998 The OpenBSD Project .\" All rights reserved. @@ -36,10 +36,11 @@ on Sun 4/300, sun4c and sun4m workstations. The .Nm device flags may be OR'd together to enable any combination of -the features listed above. Targets 4 through 7 typically have -disconnect/reselect enabled on the premise that tape devices normally -have one of these targets. Tape devices should be allowed to disconnect -for the SCSI bus to operate acceptably. +the features listed above. +Targets 4 through 7 typically have disconnect/reselect enabled on the premise +that tape devices normally have one of these targets. +Tape devices should be allowed to disconnect for the SCSI bus to operate +acceptably. .Sh SEE ALSO .Xr si 4 , .Xr sw 4 diff --git a/share/man/man4/man4.sparc/hme.4 b/share/man/man4/man4.sparc/hme.4 index 33f5c1c0767..86b09416ccb 100644 --- a/share/man/man4/man4.sparc/hme.4 +++ b/share/man/man4/man4.sparc/hme.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hme.4,v 1.6 1999/07/09 13:35:42 aaron Exp $ +.\" $OpenBSD: hme.4,v 1.7 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1998 Jason L. Wright (jason@thought.net) .\" All rights reserved. @@ -69,9 +69,9 @@ network. When a .Nm interface is brought up, by default, it will attempt to auto-negotiate the -link speed and duplex. The speeds, in order of attempt, are: -100Mb/s Full Duplex, 100Mb/s Half Duplex, 10 Mb/s Full Duplex, and -10 Mb/s Half Duplex. +link speed and duplex. +The speeds, in order of attempt, are: 100Mb/s Full Duplex, 100Mb/s Half Duplex, +10 Mb/s Full Duplex, and 10 Mb/s Half Duplex. .Pp The .Nm diff --git a/share/man/man4/man4.sparc/ie.4 b/share/man/man4/man4.sparc/ie.4 index 56ac0623e68..9e313affca8 100644 --- a/share/man/man4/man4.sparc/ie.4 +++ b/share/man/man4/man4.sparc/ie.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ie.4,v 1.5 2001/08/03 15:21:16 mpech Exp $ +.\" $OpenBSD: ie.4,v 1.6 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1998 The OpenBSD Project .\" All rights reserved. @@ -22,7 +22,8 @@ The interface provides access to the 10 Mb/s Ethernet network via the .Tn Intel 82586 -Ethernet chip set. The +Ethernet chip set. +The .Nm is found as an on-board interface on Sun 4/100, and 4/200 workstations. The diff --git a/share/man/man4/man4.sparc/intro.4 b/share/man/man4/man4.sparc/intro.4 index 0b7ca86ca1d..e5a2d206704 100644 --- a/share/man/man4/man4.sparc/intro.4 +++ b/share/man/man4/man4.sparc/intro.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: intro.4,v 1.19 2001/10/04 22:03:46 miod Exp $ +.\" $OpenBSD: intro.4,v 1.20 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: intro.4,v 1.5 1998/02/06 06:07:00 perry Exp $ .\" .\" Copyright (c) 1996 Jonathan Stone. @@ -65,8 +65,8 @@ The networking support is introduced in .Sh DEVICE SUPPORT This section describes the hardware supported on the SPARC 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 . @@ -79,9 +79,10 @@ 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, @@ -92,7 +93,8 @@ The autoconfiguration system is described in A list of the supported devices is given below. .Sh LIST OF DEVICES The devices listed below are supported in this incarnation of -the system. Pseudo-devices are not listed. +the system. +Pseudo-devices are not listed. Devices are indicated by their functional interface. Not all supported devices are listed. .Pp diff --git a/share/man/man4/man4.sparc/kbd.4 b/share/man/man4/man4.sparc/kbd.4 index f4700280bf0..52f2787f1fb 100644 --- a/share/man/man4/man4.sparc/kbd.4 +++ b/share/man/man4/man4.sparc/kbd.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: kbd.4,v 1.6 2001/06/23 07:04:20 pjanzen Exp $ +.\" $OpenBSD: kbd.4,v 1.7 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: kbd.4,v 1.3 1997/11/25 22:15:56 pk Exp $ .\" .\" Copyright (c) 1996 The NetBSD Foundation, Inc. @@ -51,8 +51,9 @@ driver provides an interface to the workstation console keyboard. .Dq type 3 , and .Dq type 4 -keyboards are supported. All types generate keycodes encoding the -key identity and motion (up or down) as the keys are pressed and released. +keyboards are supported. +All types generate keycodes encoding the key identity and motion (up or down) +as the keys are pressed and released. The .Nm driver either passes the keycodes to an application as they come in, or @@ -68,25 +69,30 @@ device special file, which can be used as a device. The device special file .Pa /dev/kbd -is used to get direct access to the keyboard input stream. The following +is used to get direct access to the keyboard input stream. +The following .Xr ioctl 2 Ns s are supported (mostly just enough to keep the X11 server going): .Bl -tag -width KIOCSDIRECT .It KIOCTRANS -Set translation mode. The argument is of type +Set translation mode. +The argument is of type .Fa "int *" , the only value supported is .Dv TR_UNTRANS_EVENT . .It KIOCGTRANS -Get translation mode. The argument is of type +Get translation mode. +The argument is of type .Fa "int *" . .Dv TR_UNTRANS_EVENT is always returned. .It KIOCGETKEY -Fill in old-style key station translation. The argument is of type +Fill in old-style key station translation. +The argument is of type .Fa "struct okiockey *" . .It KIOCCMD -Send a command to the keyboard. The argument is of type +Send a command to the keyboard. +The argument is of type .Fa "int *" , and can have one of the following values: .Bl -tag -width KBD_CMD_NOCLICK @@ -100,7 +106,8 @@ Instruct the keyboard to make extra noise when touching keys. Instruct the keyboard to.. oh well.. .El .It KIOCTYPE -Get keyboard type. The argument is of type +Get keyboard type. +The argument is of type .Fa "int *" , in which one of the values .Dv KB_SUN2 , @@ -118,11 +125,13 @@ mode, while a value of zero will make it return to .Dq ASCII translation mode. .It KIOCSKEY -Set key station translation. The argument is of type +Set key station translation. +The argument is of type .Fa "struct kiockey *" .Pq see Pa /usr/include/machine/kbio.h No for more details . .It KIOCGKEY -Get key station translation. The argument is of type +Get key station translation. +The argument is of type .Fa "struct kiockey *" . .It KIOCLAYOUT Get keyboard layout diff --git a/share/man/man4/man4.sparc/magma.4 b/share/man/man4/man4.sparc/magma.4 index dee1180f30e..43042c386de 100644 --- a/share/man/man4/man4.sparc/magma.4 +++ b/share/man/man4/man4.sparc/magma.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: magma.4,v 1.5 2001/08/20 06:09:32 mpech Exp $ +.\" $OpenBSD: magma.4,v 1.6 2001/10/05 14:45:54 mpech Exp $ .\" .\" .\" Copyright (c) 1998 Iain Hibbert @@ -40,9 +40,10 @@ .Cd "mbpp? at magma?" .Sh DESCRIPTION This driver provides an interface to Magma LC2+1Sp, 2+1Sp, 4+1Sp, 8+2Sp, -4Sp, 8Sp, 12Sp, 16Sp, 1P and 2P boards. These boards are based around -the Cirrus Logic CD1400 serial/parallel communications engine and the -Cirrus Logic CD1190 parallel communications engine. +4Sp, 8Sp, 12Sp, 16Sp, 1P and 2P boards. +These boards are based around the Cirrus Logic CD1400 serial/parallel +communications engine and the Cirrus Logic CD1190 parallel communications +engine. .Pp The device minor numbers for this driver are encoded as follows: .Pp @@ -67,17 +68,19 @@ and a 12 byte FIFO on the chip in each direction so errors should be minimal. .Sh DIAGNOSTICS .Bl -diag .It "mtty%d%x: ring buffer overflow" -Incoming characters have been discarded due to a buffer overflow. This is -caused by the process in control of the device not reading characters -fast enough. If need be you can make the ring buffer bigger by changing the +Incoming characters have been discarded due to a buffer overflow. +This is caused by the process in control of the device not reading characters +fast enough. +If need be you can make the ring buffer bigger by changing the \fIMAGMA_RBUF_SIZE\fR #define to something bigger, but it should be a multiple of two. .It "mtty%d%x: fifo overflow" -Incoming characters have been discarded due to a CD1400 channel overrun. This -is caused by interrupts not being serviced sufficiently quickly to prevent -the 12 byte receive FIFO on a serial channel from overflowing. Reducing -the value of either the \fIMTTY_RX_FIFO_THRESHOLD\fR or \fIMTTY_RX_DTR_THRESHOLD\fR -#define's to something smaller may help slow machines avoid this problem. +Incoming characters have been discarded due to a CD1400 channel overrun. +This is caused by interrupts not being serviced sufficiently quickly to prevent +the 12 byte receive FIFO on a serial channel from overflowing. +Reducing the value of either the \fIMTTY_RX_FIFO_THRESHOLD\fR or +\fIMTTY_RX_DTR_THRESHOLD\fR #define's to something smaller may help slow +machines avoid this problem. .El .Sh FILES .Bl -tag -width /dev/bpp[0-3][0-1] -compact @@ -109,5 +112,5 @@ mdmbuf is unsupported automatic XON/XOFF handshaking could be implemented fairly easily. .Pp it would be good if the tty port waited for the FIFO to empty before allowing -a close, so that I could turn off the channel interrupts at that time. It can -be done. +a close, so that I could turn off the channel interrupts at that time. +It can be done. diff --git a/share/man/man4/man4.sparc/ms.4 b/share/man/man4/man4.sparc/ms.4 index 3272aa312cb..bbd3eb9f8cc 100644 --- a/share/man/man4/man4.sparc/ms.4 +++ b/share/man/man4/man4.sparc/ms.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ms.4,v 1.6 2001/06/23 07:04:20 pjanzen Exp $ +.\" $OpenBSD: ms.4,v 1.7 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: ms.4,v 1.2 1997/10/08 22:00:12 jtc Exp $ .\" .\" Copyright (c) 1996 The NetBSD Foundation, Inc. @@ -69,17 +69,20 @@ are X and Y delta values, none of which are in the range .Pp The device special file .Pa /dev/mouse -is used to get direct access to the mouse input stream. The following +is used to get direct access to the mouse input stream. +The following .Xr ioctl 2 Ns s are supported (mostly just enough to keep the X11 server going): .Bl -tag -width VUIDSFORMAT .It VUIDSFORMAT -Set translation mode. The argument is of type +Set translation mode. +The argument is of type .Fa "int *" , the only value supported is .Dv VUID_FIRM_EVENT . .It VUIDGFORMAT -Get translation mode. The argument is of type +Get translation mode. +The argument is of type .Fa "int *" . .Dv VUID_FIRM_EVENT is always returned. diff --git a/share/man/man4/man4.sparc/si.4 b/share/man/man4/man4.sparc/si.4 index c90866da11a..d40be12a90c 100644 --- a/share/man/man4/man4.sparc/si.4 +++ b/share/man/man4/man4.sparc/si.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: si.4,v 1.4 2001/03/06 19:56:51 brad Exp $ +.\" $OpenBSD: si.4,v 1.5 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1998 The OpenBSD Project .\" All rights reserved. @@ -31,9 +31,8 @@ Allow disconnect/reconnect The .Nm device flags may be OR'd together to enable any combination of -the features listed above. If no flags are specified, the device will -use DMA by default. - +the features listed above. +If no flags are specified, the device will use DMA by default. .Sh SEE ALSO .Xr esp 4 , .Xr sw 4 diff --git a/share/man/man4/man4.sparc/sw.4 b/share/man/man4/man4.sparc/sw.4 index b34d7270894..263c4eea42c 100644 --- a/share/man/man4/man4.sparc/sw.4 +++ b/share/man/man4/man4.sparc/sw.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sw.4,v 1.4 2001/03/06 19:56:51 brad Exp $ +.\" $OpenBSD: sw.4,v 1.5 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1998 The OpenBSD Project .\" All rights reserved. @@ -16,7 +16,8 @@ The .Nm is the Sun 4/100 on-board SCSI controller based on the NCR 5380 chip, found -only on Sun 4/100 workstations. The +only on Sun 4/100 workstations. +The .Nm driver is actually implemented as part of the .Xr si 4 @@ -34,8 +35,8 @@ Allow disconnect/reconnect The .Nm device flags may be OR'd together to enable any combination of -the features listed above. If no flags are specified, the device will -use polled DMA by default. +the features listed above. +If no flags are specified, the device will use polled DMA by default. .Sh BUGS The .Nm diff --git a/share/man/man4/man4.sparc/tcx.4 b/share/man/man4/man4.sparc/tcx.4 index 4cb2ab3981e..21e9ce39066 100644 --- a/share/man/man4/man4.sparc/tcx.4 +++ b/share/man/man4/man4.sparc/tcx.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tcx.4,v 1.8 2001/06/23 07:04:21 pjanzen Exp $ +.\" $OpenBSD: tcx.4,v 1.9 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: tcx.4,v 1.3 1997/10/08 22:00:14 jtc Exp $ .\" .\" Copyright (c) 1996 The NetBSD Foundation, Inc. @@ -47,11 +47,12 @@ The .Nm tcx is a memory based color frame buffer, with graphics acceleration and -overlay capabilities. Its control registers, colour lookup table and -pixel memory can be mapped into a user process address space by using -the +overlay capabilities. +Its control registers, colour lookup table and pixel memory can be mapped +into a user process address space by using the .Xr mmap 2 -system call. The +system call. +The .Nm driver supports the minimal .Xr ioctl 2 Ns s diff --git a/share/man/man4/man4.sparc/xd.4 b/share/man/man4/man4.sparc/xd.4 index ef13917ca20..95aeee4cc2e 100644 --- a/share/man/man4/man4.sparc/xd.4 +++ b/share/man/man4/man4.sparc/xd.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: xd.4,v 1.4 2001/03/06 19:56:51 brad Exp $ +.\" $OpenBSD: xd.4,v 1.5 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1998 The OpenBSD Project .\" All rights reserved. @@ -20,9 +20,9 @@ The .Nm is a Xylogics 753 or 7053 SMD disk controller found on sun4 systems with -the VME bus. The Xylogics 753 and 7053 are programmed the same way, but -are different sizes. The 753 is a 6U VME card, while the 7053 is a 9U -VME card. +the VME bus. +The Xylogics 753 and 7053 are programmed the same way, but are different sizes. +The 753 is a 6U VME card, while the 7053 is a 9U VME card. .Sh SEE ALSO .Xr xy 4 .Sh HISTORY diff --git a/share/man/man4/man4.sparc/zs.4 b/share/man/man4/man4.sparc/zs.4 index f8aabaf6a62..f61b40f7fae 100644 --- a/share/man/man4/man4.sparc/zs.4 +++ b/share/man/man4/man4.sparc/zs.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: zs.4,v 1.7 2001/06/23 07:04:21 pjanzen Exp $ +.\" $OpenBSD: zs.4,v 1.8 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1998 The OpenBSD Project .\" All rights reserved. @@ -25,9 +25,9 @@ The .Nm is a Zilog 8530 serial interface chip used in Sun workstations. The Zilog 8530 provides two input/output channels per instance. -Most Sun workstations include two of these interfaces. One of the -interfaces is hardwired for use by the keyboard and mouse attached to -the workstation console. +Most Sun workstations include two of these interfaces. +One of the interfaces is hardwired for use by the keyboard and mouse +attached to the workstation console. The remaining additional .Nm interfaces provide RS-423 @@ -50,8 +50,8 @@ The driver now supports cua minor devices, but with this known deficiency in the simultaneous outgoing/incoming aspect of the driver: The first outgoing connection succeeds, but second and subsequent -connections fail, apparently due to a getty hang. The hung getty apparently -prevents the cua device from being re-opened. +connections fail, apparently due to a getty hang. +The hung getty apparently prevents the cua device from being re-opened. .Sh SEE ALSO .Xr ioctl 2 , .Xr kbd 4 , diff --git a/share/man/man4/man4.sparc64/intro.4 b/share/man/man4/man4.sparc64/intro.4 index 5b31b916496..741bf0d3b3a 100644 --- a/share/man/man4/man4.sparc64/intro.4 +++ b/share/man/man4/man4.sparc64/intro.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: intro.4,v 1.1 2001/10/04 22:03:46 miod Exp $ +.\" $OpenBSD: intro.4,v 1.2 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 2001 The OpenBSD Project .\" All Rights Reserved. @@ -39,8 +39,8 @@ The networking support is introduced in This section describes the hardware supported on the sparc64 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 . @@ -53,9 +53,10 @@ 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, @@ -66,7 +67,8 @@ The autoconfiguration system is described in A list of the supported devices is given below. .Sh LIST OF DEVICES The devices listed below are supported in this incarnation of -the system. Pseudo-devices are not listed. +the system. +Pseudo-devices are not listed. Devices are indicated by their functional interface. Not all supported devices are listed. .Pp diff --git a/share/man/man4/man4.sun3/ie.4 b/share/man/man4/man4.sun3/ie.4 index c73f7a483d9..c0046039492 100644 --- a/share/man/man4/man4.sun3/ie.4 +++ b/share/man/man4/man4.sun3/ie.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ie.4,v 1.6 2001/08/03 15:21:16 mpech Exp $ +.\" $OpenBSD: ie.4,v 1.7 2001/10/05 14:45:54 mpech Exp $ .\" Copyright (c) 1992, 1993 .\" The Regents of the University of California. All rights reserved. .\" @@ -52,7 +52,8 @@ The .Nm interface provides access to the 10 Mb/s Ethernet network via the .Tn Intel -82586 Ethernet chip set. The +82586 Ethernet chip set. +The .Nm is found as an on-board interface on Sun 3/75, 3/1x0 and 3/2x0 workstations. diff --git a/share/man/man4/man4.sun3/leds.4 b/share/man/man4/man4.sun3/leds.4 index 3cb6d3705d7..680cf294ef5 100644 --- a/share/man/man4/man4.sun3/leds.4 +++ b/share/man/man4/man4.sun3/leds.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: leds.4,v 1.3 2000/01/22 02:17:55 aaron Exp $ +.\" $OpenBSD: leds.4,v 1.4 2001/10/05 14:45:54 mpech Exp $ .\" .Dd March 2, 1996 .Dt LEDS 4 sun3 @@ -18,17 +18,19 @@ This file contains two .Sy unsigned int to .Xr write 2 , -which on a Sun-3 means big-endian), followed by a string of bytes. The -string of bytes gives the successive patterns to be displayed on the -LEDs; each byte's bits are taken and used to drive the LEDs. A 0 bit -illuminates the corresponding LED; a 1 bit leaves the corresponding LED -dark. The first +which on a Sun-3 means big-endian), followed by a string of bytes. +The string of bytes gives the successive patterns to be displayed on the +LEDs; each byte's bits are taken and used to drive the LEDs. +A 0 bit illuminates the corresponding LED; a 1 bit leaves the corresponding +LED dark. +The first .Li unsigned int gives the number of clock ticks that are skipped after each pattern is -loaded before the next is loaded. For example, if this value is 0, a -new pattern is loaded each clock tick; if it is 3, a new pattern will -be loaded every fourth clock tick (i.e., three ticks will be skipped -between loads). The second +loaded before the next is loaded. +For example, if this value is 0, a new pattern is loaded each clock tick; +if it is 3, a new pattern will be loaded every fourth clock tick (i.e., three +ticks will be skipped between loads). +The second .Li unsigned int gives the number of patterns in the list, that is, the number of bytes following the two @@ -36,16 +38,16 @@ following the two .Pp There are limits on the two integer values; attempting a write that would cause either of them to take on too large a value causes the -write to return EIO without affecting anything. The limits are -compiled into the kernel; as of this writing, the first one can be at -most 128, the second at most 10240. +write to return EIO without affecting anything. +The limits are compiled into the kernel; as of this writing, the first one +can be at most 128, the second at most 10240. .Sh EXAMPLES This example displays a single lit LED scrolling from one end of the -display to the other, over and over, moving every six clock ticks. The -first eight bytes supply the two +display to the other, over and over, moving every six clock ticks. +The first eight bytes supply the two .Li unsigned int Ns s -mentioned above; the other eight specify the patterns. (Convert them -to binary, and remember that 0 bits mean lit LEDs.) +mentioned above; the other eight specify the patterns. +(Convert them to binary, and remember that 0 bits mean lit LEDs.) .Bd -ragged -offset -ident # echo 0 0 0 5 0 0 0 8 254 253 250 247 239 223 175 127 | awk '{ for (i=1;i<=NF;i++) printf("%c",$i+0); }' > /dev/leds diff --git a/share/man/man4/man4.vax/acc.4 b/share/man/man4/man4.vax/acc.4 index 08acd486e4d..b4d56aaa5b4 100644 --- a/share/man/man4/man4.vax/acc.4 +++ b/share/man/man4/man4.vax/acc.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: acc.4,v 1.3 1999/06/05 13:18:37 aaron Exp $ +.\" $OpenBSD: acc.4,v 1.4 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: acc.4,v 1.3 1996/03/03 17:13:10 thorpej Exp $ .\" .\" Copyright (c) 1983, 1991 The Regents of the University of California. @@ -53,8 +53,9 @@ interface to an It is normally used when participating in the .Tn DARPA -Internet. The controller itself is not accessible -to users, but instead provides the hardware support to the +Internet. +The controller itself is not accessible to users, but instead provides +the hardware support to the .Tn IMP interface described in .Xr imp 4 . @@ -67,7 +68,8 @@ as shown above. .Bl -diag .It acc%d: not alive. The initialization routine was entered even though the device -did not autoconfigure. This indicates a system problem. +did not autoconfigure. +This indicates a system problem. .Pp .It acc%d: can't initialize. Insufficient UNIBUS resources existed to initialize the device. @@ -79,7 +81,8 @@ to use buffered data paths on an 11/730 (which has none). .It acc%d: imp doesn't respond, icsr=%b. The driver attempted to initialize the device, but the .Tn IMP -failed to respond after 500 tries. Check the cabling. +failed to respond after 500 tries. +Check the cabling. .Pp .It acc%d: stray xmit interrupt, csr=%b. An interrupt occurred when no output had previously been started. diff --git a/share/man/man4/man4.vax/autoconf.4 b/share/man/man4/man4.vax/autoconf.4 index ef2fb59347f..77397cf7f3c 100644 --- a/share/man/man4/man4.vax/autoconf.4 +++ b/share/man/man4/man4.vax/autoconf.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: autoconf.4,v 1.5 2001/06/23 07:04:22 pjanzen Exp $ +.\" $OpenBSD: autoconf.4,v 1.6 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: autoconf.4,v 1.3 1996/03/03 17:13:13 thorpej Exp $ .\" .\" Copyright (c) 1980, 1991 Regents of the University of California. @@ -60,8 +60,8 @@ slots are normally noted, thus memory controllers, .Tn UNIBUS and .Tn MASSBUS -adaptors. Devices which are not supported which -are found in +adaptors. +Devices which are not supported which are found in .Tn NEXUS slots are noted also. The Q-bus, if present, is configured in the same way as the @@ -70,15 +70,16 @@ The Q-bus, if present, is configured in the same way as the .Tn MASSBUS devices are located by a very deterministic procedure since .Tn MASSBUS -space is completely probe-able. If devices exist which -are not configured they will be silently ignored; if devices exist of -unsupported type they will be noted. +space is completely probe-able. +If devices exist which are not configured they will be silently ignored; +if devices exist of unsupported type they will be noted. .Pp .Tn UNIBUS devices are located by probing to see if their control-status -registers respond. If not, they are silently ignored. If the control -status register responds but the device cannot be made to interrupt, -a diagnostic warning will be printed on the console and the device +registers respond. +If not, they are silently ignored. +If the control status register responds but the device cannot be made to +interrupt, a diagnostic warning will be printed on the console and the device will not be available to the system. .Pp Normally, the system uses the disk from which it was loaded as the root @@ -218,8 +219,9 @@ where is the name for the tape device and .Dq Li ht0 is the name -for the formatter. A tape slave was found on the tape formatter at the -indicated drive number (on the front of the tape drive). +for the formatter. +A tape slave was found on the tape formatter at the indicated drive number +(on the front of the tape drive). .Ux will call the device, e.g., .Dq Li tu0 . @@ -258,7 +260,8 @@ where is the name of a disk drive and .Dq Li sc0 is the name -of the controller. Analogous to +of the controller. +Analogous to .Tn MASSBUS case. .El diff --git a/share/man/man4/man4.vax/cons.4 b/share/man/man4/man4.vax/cons.4 index b632b4100ec..d2ab9dbdeba 100644 --- a/share/man/man4/man4.vax/cons.4 +++ b/share/man/man4/man4.vax/cons.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: cons.4,v 1.6 2001/10/04 16:56:51 mpech Exp $ +.\" $OpenBSD: cons.4,v 1.7 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1980, 1991 Regents of the University of California. .\" All rights reserved. @@ -43,8 +43,10 @@ The console is available to the processor through the console registers. It acts like a normal terminal, except that when the local functions are not disabled, a special command character puts the console in local console -mode. The character itself is dependent upon the model of VAX and the -type of console in use. The prompt in console mode is +mode. +The character itself is dependent upon the model of VAX and the type +of console in use. +The prompt in console mode is .Sq Li >>> , also called the .Sq chevron @@ -133,9 +135,9 @@ Halt the processor if in normal mode. .El .Ss VAX 4000, MicroVAX, VAXstation, others If the console is a serial console, sending a break will likely cause the -machine to halt and enter console mode. The set of commands available at -the console varies from machine to machine, although there are several -commands which are common to most or all models. +machine to halt and enter console mode. +The set of commands available at the console varies from machine to machine, +although there are several commands which are common to most or all models. .Bl -tag -width continue -compact -offset 4n .It Ic c .It Ic continue @@ -165,10 +167,10 @@ The options are: .Bl -tag -width 5n -compact .It Cm /bwl .It Cm /ins -Size of data to examine. Your choices are examining values as bytes (8 bits), -words (16 bits), or longwords (32 bits). On systems that support it, you -can use -the +Size of data to examine. +Your choices are examining values as bytes (8 bits), words (16 bits), +or longwords (32 bits). +On systems that support it, you can use the .Cm /ins option to display the mnemonic representation of the instruction located at .Ar addr . @@ -180,19 +182,21 @@ With the .Cm /p option, .Ar addr -will be treated as an address in physical memory. With the +will be treated as an address in physical memory. +With the .Cm /v option, .Ar addr -will be treated as a virtual address. The +will be treated as a virtual address. +The .Cm /g option will let you examine the general registers. From 0 to F (base 16), general registers are R0-R12(AP), FP, SP, and PC. The .Cm /i -option will let you view the internal processor registers. These vary -from processor to processor, but a relatively complete description may be -found in +option will let you view the internal processor registers. +These vary from processor to processor, but a relatively complete description +may be found in .Pa /usr/include/vax/mtpr.h . .Pp .It Cm /n: Ns Ar count @@ -224,8 +228,9 @@ The options are: .Pp .Bl -tag -width 5n -compact .It Cm /bwl -Size of data to insert. Your choices are inserting values as bytes (8 bits), -words (16 bits), or longwords (32 bits). +Size of data to insert. +Your choices are inserting values as bytes (8 bits), words (16 bits), +or longwords (32 bits). .Pp .It Cm /pvgi These options describe the meaning of diff --git a/share/man/man4/man4.vax/css.4 b/share/man/man4/man4.vax/css.4 index 70be7531d6f..b75dc7b8147 100644 --- a/share/man/man4/man4.vax/css.4 +++ b/share/man/man4/man4.vax/css.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: css.4,v 1.3 1999/06/05 13:18:37 aaron Exp $ +.\" $OpenBSD: css.4,v 1.4 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: css.4,v 1.3 1996/03/03 17:13:16 thorpej Exp $ .\" .\" Copyright (c) 1983, 1991 Regents of the University of California. @@ -53,8 +53,9 @@ interface to an It is normally used when participating in the .Tn DARPA -Internet. The controller itself is not accessible -to users, but instead provides the hardware support to the +Internet. +The controller itself is not accessible to users, but instead provides +the hardware support to the .Tn IMP interface described in .Xr imp 4 . @@ -67,7 +68,8 @@ as shown above. .Bl -diag .It css%d: not alive. The initialization routine was entered even though the device -did not autoconfigure. This is indicates a system problem. +did not autoconfigure. +This is indicates a system problem. .Pp .It css%d: can't initialize. Insufficient @@ -81,7 +83,8 @@ to use buffered data paths on an 11/730 (which has none). .It css%d: imp doesn't respond, icsr=%b. The driver attempted to initialize the device, but the .Tn IMP -failed to respond after 500 tries. Check the cabling. +failed to respond after 500 tries. +Check the cabling. .Pp .It css%d: stray output interrupt csr=%b. An interrupt occurred when no output had previously been started. diff --git a/share/man/man4/man4.vax/ddn.4 b/share/man/man4/man4.vax/ddn.4 index 08111a4c3f5..ab19e866b20 100644 --- a/share/man/man4/man4.vax/ddn.4 +++ b/share/man/man4/man4.vax/ddn.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ddn.4,v 1.4 1999/06/05 13:18:37 aaron Exp $ +.\" $OpenBSD: ddn.4,v 1.5 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: ddn.4,v 1.3 1996/03/03 17:13:18 thorpej Exp $ .\" .\" Copyright (c) 1983, 1991 The Regents of the University of California. @@ -60,8 +60,8 @@ using the .Tn ACC ACP625 .Tn X.25 -board. It is normally used for connecting to -the Defense Data Network +board. +It is normally used for connecting to the Defense Data Network .Pq Tn DDN . The controller itself is not accessible to users, but instead provides a network interface for the @@ -71,7 +71,8 @@ Internet Protocol described in .Bl -diag .It ddn%d: not alive. The initialization routine was entered even though the device -did not autoconfigure. This indicates a system problem. +did not autoconfigure. +This indicates a system problem. .Pp .It ddn%d: failed getting UBA resources for lcn %d." Insufficient diff --git a/share/man/man4/man4.vax/dh.4 b/share/man/man4/man4.vax/dh.4 index bcf14f4078b..013d8fdd070 100644 --- a/share/man/man4/man4.vax/dh.4 +++ b/share/man/man4/man4.vax/dh.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: dh.4,v 1.4 2001/06/23 07:04:23 pjanzen Exp $ +.\" $OpenBSD: dh.4,v 1.5 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: dh.4,v 1.3 1996/03/03 17:13:20 thorpej Exp $ .\" .\" Copyright (c) 1980, 1991 Regents of the University of California. @@ -66,7 +66,8 @@ bit number .Ar i is not properly connected, and should be treated as hard-wired with carrier -always present. Thus specifying +always present. +Thus specifying .Ql flags 0x0004 for .Li dh0 @@ -107,11 +108,11 @@ the driver polls for input 30 times per second. .It dh%d: NXM. No response from .Tn UNIBUS -on a dma transfer -within a timeout period. This is often followed by a +on a dma transfer within a timeout period. +This is often followed by a .Tn UNIBUS -adapter -error. This occurs most frequently when the +adapter error. +This occurs most frequently when the .Tn UNIBUS is heavily loaded and when devices which hog the bus (such as @@ -120,8 +121,8 @@ It is not serious. .Pp .It dh%d: silo overflow. The character input silo overflowed -before it could be serviced. This can happen if a hard error occurs -when the +before it could be serviced. +This can happen if a hard error occurs when the .Tn CPU is running with elevated priority, as the system will then print a message on the console with interrupts disabled. diff --git a/share/man/man4/man4.vax/dmf.4 b/share/man/man4/man4.vax/dmf.4 index 1f2625ccd2e..2d4bc7e9122 100644 --- a/share/man/man4/man4.vax/dmf.4 +++ b/share/man/man4/man4.vax/dmf.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: dmf.4,v 1.4 2001/06/23 07:04:23 pjanzen Exp $ +.\" $OpenBSD: dmf.4,v 1.5 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: dmf.4,v 1.3 1996/03/03 17:13:23 thorpej Exp $ .\" .\" Copyright (c) 1983, 1991 Regents of the University of California. @@ -69,7 +69,8 @@ bit number .Ar i is not properly connected, and should be treated as hard-wired with carrier -always present. Thus specifying +always present. +Thus specifying .Ql flags 0x04 for .Li dmf0 @@ -127,10 +128,11 @@ driver. No response from .Tn UNIBUS on a DMA transfer -within a timeout period. This is often followed by a +within a timeout period. +This is often followed by a .Tn UNIBUS -adapter -error. This occurs most frequently when the +adapter error. +This occurs most frequently when the .Tn UNIBUS is heavily loaded and when devices which hog the bus (such as @@ -140,8 +142,8 @@ It is not serious. .Pp .It dmf%d: silo overflow. The character input silo overflowed -before it could be serviced. This can happen if a hard error occurs -when the +before it could be serviced. +This can happen if a hard error occurs when the .Tn CPU is running with elevated priority, as the system will then print a message on the console with interrupts disabled. diff --git a/share/man/man4/man4.vax/dmz.4 b/share/man/man4/man4.vax/dmz.4 index 27c5d564af6..e02850d724d 100644 --- a/share/man/man4/man4.vax/dmz.4 +++ b/share/man/man4/man4.vax/dmz.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: dmz.4,v 1.4 2001/06/23 07:04:23 pjanzen Exp $ +.\" $OpenBSD: dmz.4,v 1.5 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: dmz.4,v 1.3 1996/03/03 17:13:26 thorpej Exp $ .\" .\" Copyright (c) 1983, 1991 Regents of the University of California. @@ -61,7 +61,8 @@ bit number .Ar i is not properly connected, and should be treated as hard-wired with carrier -always present. Thus specifying +always present. +Thus specifying .Ql flags 0x000004 for .Li dmz0 @@ -105,10 +106,11 @@ No response from the on a .Tn DMA transfer -within a timeout period. This is often followed by a +within a timeout period. +This is often followed by a .Tn UNIBUS -adapter -error. This occurs most frequently when the +adapter error. +This occurs most frequently when the .Tn UNIBUS is heavily loaded and when devices which hog the bus (such as @@ -118,8 +120,8 @@ It is not serious. .Pp .It dmz%d: silo overflow. The character input silo overflowed -before it could be serviced. This can happen if a hard error occurs -when the +before it could be serviced. +This can happen if a hard error occurs when the .Tn CPU is running with elevated priority, as the system will then print a message on the console with interrupts disabled. diff --git a/share/man/man4/man4.vax/dn.4 b/share/man/man4/man4.vax/dn.4 index 1c3d216652a..caffc1395de 100644 --- a/share/man/man4/man4.vax/dn.4 +++ b/share/man/man4/man4.vax/dn.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: dn.4,v 1.3 1999/06/05 13:18:38 aaron Exp $ +.\" $OpenBSD: dn.4,v 1.4 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: dn.4,v 1.3 1996/03/03 17:13:28 thorpej Exp $ .\" .\" Copyright (c) 1980, 1991 Regents of the University of California. @@ -56,8 +56,8 @@ such as the Able Quadracall) to an auto-call unit To place an outgoing call one forks a sub-process which opens the appropriate call unit file, .Pa /dev/cua? -and writes the phone number on it. The parent process -then opens the corresponding modem line +and writes the phone number on it. +The parent process then opens the corresponding modem line .Pa /dev/cul? . When the connection has been established, the open on the modem line diff --git a/share/man/man4/man4.vax/dz.4 b/share/man/man4/man4.vax/dz.4 index 25b63e24d89..05bccc978ef 100644 --- a/share/man/man4/man4.vax/dz.4 +++ b/share/man/man4/man4.vax/dz.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: dz.4,v 1.4 2000/07/22 04:54:28 bjc Exp $ +.\" $OpenBSD: dz.4,v 1.5 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: dz.4,v 1.3 1996/03/03 17:13:29 thorpej Exp $ .\" .\" Copyright (c) 1980, 1991 Regents of the University of California. @@ -62,7 +62,8 @@ bit number .Ar i is not properly connected, and should be treated as hard-wired with carrier -always present. Thus specifying +always present. +Thus specifying .Ql flags 0x04 for .Li dz0 @@ -101,8 +102,8 @@ dialups .Bl -diag .It dz%d: silo overflow . The 64 character input silo overflowed -before it could be serviced. This can happen if a hard error occurs -when the +before it could be serviced. +This can happen if a hard error occurs when the .Tn CPU is running with elevated priority, as the system will then print a message on the console with interrupts disabled. diff --git a/share/man/man4/man4.vax/ec.4 b/share/man/man4/man4.vax/ec.4 index d967ebd8628..d92c3050b3c 100644 --- a/share/man/man4/man4.vax/ec.4 +++ b/share/man/man4/man4.vax/ec.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ec.4,v 1.4 1999/06/05 13:18:38 aaron Exp $ +.\" $OpenBSD: ec.4,v 1.5 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: ec.4,v 1.3 1996/03/03 17:13:30 thorpej Exp $ .\" .\" Copyright (c) 1983, 1991 The Regents of the University of California. @@ -85,11 +85,12 @@ flag with an .Xr ioctl . .Pp The interface software implements an exponential backoff algorithm -when notified of a collision on the cable. This algorithm utilizes -a 16-bit mask and the +when notified of a collision on the cable. +This algorithm utilizes a 16-bit mask and the .Tn VAX-11 Ns 's interval timer in calculating a series -of random backoff values. The algorithm is as follows: +of random backoff values. +The algorithm is as follows: .Bl -enum -offset indent .It Initialize the mask to be all 1's. @@ -134,9 +135,10 @@ The driver appeared in .Bx 4.2 . .Sh BUGS -The hardware is not capable of talking to itself. The software -implements local sending and broadcast by sending such packets to the -loop interface. This is a kludge. +The hardware is not capable of talking to itself. +The software implements local sending and broadcast by sending such packets +to the loop interface. +This is a kludge. .Pp Backoff delays are done in a software busy loop. This can degrade the system if the network experiences frequent collisions. diff --git a/share/man/man4/man4.vax/en.4 b/share/man/man4/man4.vax/en.4 index b9bb2517b6d..2ff356c0c67 100644 --- a/share/man/man4/man4.vax/en.4 +++ b/share/man/man4/man4.vax/en.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: en.4,v 1.4 1999/06/05 13:18:38 aaron Exp $ +.\" $OpenBSD: en.4,v 1.5 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: en.4,v 1.3 1996/03/03 17:13:32 thorpej Exp $ .\" .\" Copyright (c) 1983, 1991 The Regents of the University of California. @@ -66,11 +66,12 @@ No packets will be sent or accepted until a network address is supplied. .Pp The interface software implements an exponential backoff algorithm -when notified of a collision on the cable. This algorithm utilizes -a 16-bit mask and the +when notified of a collision on the cable. +This algorithm utilizes a 16-bit mask and the .Tn VAX-11 Ns 's interval timer in calculating a series -of random backoff values. The algorithm is as follows: +of random backoff values. +The algorithm is as follows: .Pp .Bl -enum -offset indent .It @@ -132,14 +133,15 @@ driver appeared in .Bx 4.2 . .Sh BUGS The device has insufficient buffering to handle back to -back packets. This makes use in a production environment -painful. +back packets. +This makes use in a production environment painful. .Pp The hardware does word at a time .Tn DMA without byte swapping. To compensate, byte swapping of user data must either be done -by the user or by the system. A kludge to byte swap only +by the user or by the system. +A kludge to byte swap only .Tn IP packets is provided if the .Dv ENF_SWABIPS diff --git a/share/man/man4/man4.vax/hdh.4 b/share/man/man4/man4.vax/hdh.4 index d6b7e70a139..1baa7b7e162 100644 --- a/share/man/man4/man4.vax/hdh.4 +++ b/share/man/man4/man4.vax/hdh.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hdh.4,v 1.3 1999/06/05 13:18:38 aaron Exp $ +.\" $OpenBSD: hdh.4,v 1.4 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: hdh.4,v 1.3 1996/03/03 17:13:36 thorpej Exp $ .\" .\" Copyright (c) 1983, 1991 The Regents of the University of California. @@ -59,8 +59,9 @@ interface to an It is normally used when participating in the .Tn DARPA -Internet. The controller itself is not accessible -to users, but instead provides the hardware support to the +Internet. +The controller itself is not accessible to users, but instead provides +the hardware support to the .Tn IMP interface described in .Xr imp 4 . @@ -74,7 +75,8 @@ as shown above in the .Bl -diag .It hdh%d: not alive. The initialization routine was entered even though the device -did not autoconfigure. This indicates a system problem. +did not autoconfigure. +This indicates a system problem. .Pp .It hdh%d: cannot get chan %d uba resources. Insufficient diff --git a/share/man/man4/man4.vax/hk.4 b/share/man/man4/man4.vax/hk.4 index 96145ee1c51..ff6d8e6a025 100644 --- a/share/man/man4/man4.vax/hk.4 +++ b/share/man/man4/man4.vax/hk.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hk.4,v 1.6 2001/06/20 16:49:43 millert Exp $ +.\" $OpenBSD: hk.4,v 1.7 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: hk.4,v 1.3 1996/03/03 17:13:37 thorpej Exp $ .\" .\" Copyright (c) 1980, 1991 Regents of the University of California. @@ -67,12 +67,12 @@ Special file names begin with .Sq Li hk and .Sq Li rhk -for the block and character files respectively. The second -component of the name, a drive unit number in the range of zero to +for the block and character files respectively. +The second component of the name, a drive unit number in the range of zero to seven, is represented by a .Sq Li ? -in the disk layouts below. The last component is the file system partition -which is designated +in the disk layouts below. +The last component is the file system partition which is designated by a letter from .Sq Li a to @@ -136,17 +136,19 @@ recover the error. .Pp .It rk%d: write locked. The write protect switch was set on the drive -when a write was attempted. The write operation is not recoverable. +when a write was attempted. +The write operation is not recoverable. .Pp .It rk%d: not ready. The drive was spun down or off line when it was -accessed. The i/o operation is not recoverable. +accessed. +The i/o operation is not recoverable. .Pp .It rk%d: not ready (came back!). The drive was not ready, but after printing the message about being not ready (which takes a fraction -of a second) was ready. The operation is recovered if no further -errors occur. +of a second) was ready. +The operation is recovered if no further errors occur. .Pp .It rk%d%c: soft ecc reading fsbn %d[-%d]. A recoverable @@ -154,17 +156,17 @@ A recoverable error occurred on the specified sector(s) in the specified disk partition. This happens normally -a few times a week. If it happens more frequently than -this the sectors where the errors are occurring should be checked to see -if certain cylinders on the pack, spots on the carriage of the drive -or heads are indicated. +a few times a week. +If it happens more frequently than this the sectors where the errors are +occurring should be checked to see if certain cylinders on the pack, +spots on the carriage of the drive or heads are indicated. .Pp .It hk%d: lost interrupt. A timer watching the controller detected no interrupt for an extended period while an operation was outstanding. -This indicates a hardware or software failure. There is currently a -hardware/software problem with spinning down drives while they are -being accessed which causes this error to occur. +This indicates a hardware or software failure. +There is currently a hardware/software problem with spinning down drives +while they are being accessed which causes this error to occur. The error causes a .Tn UNIBUS reset, and retry of the pending operations. diff --git a/share/man/man4/man4.vax/hp.4 b/share/man/man4/man4.vax/hp.4 index fe10208cd5e..8d332601465 100644 --- a/share/man/man4/man4.vax/hp.4 +++ b/share/man/man4/man4.vax/hp.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hp.4,v 1.7 2001/08/03 15:21:16 mpech Exp $ +.\" $OpenBSD: hp.4,v 1.8 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: hp.4,v 1.4 1996/03/05 15:28:50 ragge Exp $ .\" .\" Copyright (c) 1980,1988, 1991 Regents of the University of California. @@ -114,7 +114,8 @@ with the error bits decoded if any error bits other than .Tn MBEXC and .Tn DTABT -are set. In any case the contents of the two error registers are also printed +are set. +In any case the contents of the two error registers are also printed in octal and symbolically with bits decoded. (Note that er2 is what old .Tn RP06 @@ -138,10 +139,10 @@ The parenthesized fields list the actual disk sector number relative to the beginning of the drive, as well as the cylinder, track and sector number of the block. This happens normally -a few times a week. If it happens more frequently than -this the sectors where the errors are occurring should be checked to see -if certain cylinders on the pack, spots on the carriage of the drive -or heads are indicated. +a few times a week. +If it happens more frequently than this the sectors where the errors are +occurring should be checked to see if certain cylinders on the pack, +spots on the carriage of the drive or heads are indicated. .Pp .El .Sh SEE ALSO diff --git a/share/man/man4/man4.vax/ht.4 b/share/man/man4/man4.vax/ht.4 index fce2526bdf3..25b420cf3be 100644 --- a/share/man/man4/man4.vax/ht.4 +++ b/share/man/man4/man4.vax/ht.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ht.4,v 1.5 2001/06/20 16:49:43 millert Exp $ +.\" $OpenBSD: ht.4,v 1.6 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: ht.4,v 1.3 1996/03/03 17:13:39 thorpej Exp $ .\" .\" Copyright (c) 1980, 1991 Regents of the University of California. @@ -92,8 +92,8 @@ A tape error occurred at block .Em bn ; the ht error register and drive status register are -printed in octal with the bits symbolically decoded. Any error is -fatal on non-raw tape; when possible the driver will have retried +printed in octal with the bits symbolically decoded. +Any error is fatal on non-raw tape; when possible the driver will have retried the operation which failed several times before reporting the error. .El .Sh SEE ALSO diff --git a/share/man/man4/man4.vax/hy.4 b/share/man/man4/man4.vax/hy.4 index de093825102..322e8b82d53 100644 --- a/share/man/man4/man4.vax/hy.4 +++ b/share/man/man4/man4.vax/hy.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hy.4,v 1.4 1999/06/05 13:18:38 aaron Exp $ +.\" $OpenBSD: hy.4,v 1.5 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: hy.4,v 1.3 1996/03/03 17:13:41 thorpej Exp $ .\" .\" Copyright (c) 1983, 1991 The Regents of the University of California. @@ -53,8 +53,9 @@ is specified at boot time with an .Dv SIOCSIFADDR .Xr ioctl 2 . The host's address is discovered by reading the adapter status -register. The interface will not transmit or receive -packets until the network number is known. +register. +The interface will not transmit or receive packets until the network number is +known. .Sh DIAGNOSTICS .Bl -diag .It "hy%d: unit number 0x%x port %d type %x microcode level 0x%x." @@ -68,8 +69,8 @@ family; the packet was dropped. .It hy%d: can't initialize. The interface was unable to allocate .Tn UNIBUS -resources. This -is usually due to having too many network devices on an 11/750 +resources. +This is usually due to having too many network devices on an 11/750 where there are only 3 buffered data paths. .Pp .It hy%d: NEX - Non Existent Memory. diff --git a/share/man/man4/man4.vax/intro.4 b/share/man/man4/man4.vax/intro.4 index 47e4f2f6e24..f51ded06737 100644 --- a/share/man/man4/man4.vax/intro.4 +++ b/share/man/man4/man4.vax/intro.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: intro.4,v 1.8 2001/10/04 22:03:46 miod Exp $ +.\" $OpenBSD: intro.4,v 1.9 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: intro.4,v 1.3 1996/03/03 17:13:44 thorpej Exp $ .\" .\" Copyright (c) 1980, 1991 Regents of the University of California. @@ -70,8 +70,8 @@ The networking support is introduced in This section describes the hardware supported on the .Tn DEC .Tn VAX . -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 . @@ -84,9 +84,10 @@ 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, @@ -97,7 +98,8 @@ The autoconfiguration system is described in A list of the supported devices is given below. .Sh LIST OF DEVICES The devices listed below are supported in this incarnation of -the system. Pseudo-devices are not listed. +the system. +Pseudo-devices are not listed. Devices are indicated by their functional interface. Not all supported devices are listed. .Pp diff --git a/share/man/man4/man4.vax/ix.4 b/share/man/man4/man4.vax/ix.4 index 4343b33a68d..5f6a06caff8 100644 --- a/share/man/man4/man4.vax/ix.4 +++ b/share/man/man4/man4.vax/ix.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ix.4,v 1.4 1999/06/05 13:18:39 aaron Exp $ +.\" $OpenBSD: ix.4,v 1.5 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: ix.4,v 1.3 1996/03/03 17:13:45 thorpej Exp $ .\" .\" Copyright (c) 1986, 1991 The Regents of the University of California. @@ -99,7 +99,8 @@ The interface was unable to obtain unibus resources required for operation. .Pp .It ix%d: failed to reinitialize DLA module. The interface got sick after attempting to reprogram its physical -ethernet address. Try reloading the firmware. +ethernet address. +Try reloading the firmware. The attempt is made only when this interfaces is not the first one configured for .Tn XNS . diff --git a/share/man/man4/man4.vax/kg.4 b/share/man/man4/man4.vax/kg.4 index a46d9ab81ee..f38d797def4 100644 --- a/share/man/man4/man4.vax/kg.4 +++ b/share/man/man4/man4.vax/kg.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: kg.4,v 1.4 1999/06/05 13:18:39 aaron Exp $ +.\" $OpenBSD: kg.4,v 1.5 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: kg.4,v 1.3 1996/03/03 17:13:46 thorpej Exp $ .\" .\" Copyright (c) 1983, 1991 Regents of the University of California. @@ -51,14 +51,15 @@ or .Tn DL-11W can be used as an alternate real time clock -source. When configured, certain system -statistics and, optionally, system profiling work -will be collected each time the clock interrupts. For -optimum accuracy in profiling, the +source. +When configured, certain system statistics and, optionally, system profiling +work will be collected each time the clock interrupts. +For optimum accuracy in profiling, the .Tn DL-11W should be configured to interrupt at the highest possible priority -level. The +level. +The .Nm kg device driver automatically calibrates itself to the line clock frequency. diff --git a/share/man/man4/man4.vax/le.4 b/share/man/man4/man4.vax/le.4 index b484c348787..3993ef10d96 100644 --- a/share/man/man4/man4.vax/le.4 +++ b/share/man/man4/man4.vax/le.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: le.4,v 1.2 2000/10/13 04:09:20 aaron Exp $ +.\" $OpenBSD: le.4,v 1.3 2001/10/05 14:45:54 mpech Exp $ .\" .Dd July 21, 2000 .Dt LE 4 vax @@ -20,8 +20,8 @@ Am7990 Local Area Network Controller for Ethernet .Pq Tn LANCE chipset. .Pp -Different machine configurations have varying types of connectors. The -following types can be found: +Different machine configurations have varying types of connectors. +The following types can be found: .Pp .Bl -tag -width 10n .It AUI/DIX diff --git a/share/man/man4/man4.vax/mt.4 b/share/man/man4/man4.vax/mt.4 index 42b97271002..a4ea6fe3b23 100644 --- a/share/man/man4/man4.vax/mt.4 +++ b/share/man/man4/man4.vax/mt.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mt.4,v 1.4 2000/07/22 05:01:13 bjc Exp $ +.\" $OpenBSD: mt.4,v 1.5 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: mt.4,v 1.3 1996/03/03 17:13:52 thorpej Exp $ .\" .\" Copyright (c) 1980, 1991 Regents of the University of California. @@ -81,8 +81,8 @@ A tape error occurred at block .Em bn ; the mt error register and drive status register are -printed in octal with the bits symbolically decoded. Any error is -fatal on non-raw tape; when possible the driver will have retried +printed in octal with the bits symbolically decoded. +Any error is fatal on non-raw tape; when possible the driver will have retried the operation which failed several times before reporting the error. .Pp .It mu%d: blank tape. @@ -90,8 +90,8 @@ An attempt was made to read a blank tape (a tape without even end-of-file marks). .Pp .It mu%d: offline. -During an i/o operation the device was set offline. If a -non-raw tape was used in the access it is closed. +During an i/o operation the device was set offline. +If a non-raw tape was used in the access it is closed. .El .Sh SEE ALSO .Xr mt 1 , diff --git a/share/man/man4/man4.vax/mtio.4 b/share/man/man4/man4.vax/mtio.4 index db1edfcae08..cff508c2b0a 100644 --- a/share/man/man4/man4.vax/mtio.4 +++ b/share/man/man4/man4.vax/mtio.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mtio.4,v 1.8 2001/08/03 15:21:16 mpech Exp $ +.\" $OpenBSD: mtio.4,v 1.9 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: mtio.4,v 1.4 1996/03/03 17:13:54 thorpej Exp $ .\" .\" Copyright (c) 1983, 1991 The Regents of the University of California. @@ -99,13 +99,15 @@ it will operate at 6250 .Pp The rewind devices automatically rewind when the last requested read, write or seek has finished, or the end of the tape -has been reached. The letter +has been reached. +The letter .Ql n is usually prepended to the name of the no-rewind devices. .Pp Unix tapes are written in multiples of 1024 byte block -records. Two end-of-file markers mark the end of a tape, and +records. +Two end-of-file markers mark the end of a tape, and one end-of-file marker marks the end of a tape file. If the tape is not to be rewound it is positioned with the head in between the two tape marks, where the next write diff --git a/share/man/man4/man4.vax/pcl.4 b/share/man/man4/man4.vax/pcl.4 index 27caa2c2756..3a83b238db0 100644 --- a/share/man/man4/man4.vax/pcl.4 +++ b/share/man/man4/man4.vax/pcl.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pcl.4,v 1.6 2001/06/23 07:04:24 pjanzen Exp $ +.\" $OpenBSD: pcl.4,v 1.7 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: pcl.4,v 1.3 1996/03/03 17:13:57 thorpej Exp $ .\" .\" Copyright (c) 1983, 1991 Regents of the University of California. @@ -96,8 +96,8 @@ An interrupt occurred when no output had previously been started. The .Tn TDM bus had no station providing ``bus master'' timing signals, -so this interface has assumed the ``master'' role. This message should -only appear at most once per +so this interface has assumed the ``master'' role. +This message should only appear at most once per .Tn UNIBUS INIT on a single system. Unless there is a hardware failure, only one station may be master at a time. @@ -108,8 +108,8 @@ If a ``receiver offline'' error is detected, it is not normally logged unless the option .Dv PCL_TESTING has been selected, as this causes a lot -of console chatter when sending to a down machine. However, this option -is quite useful when debugging problems with the +of console chatter when sending to a down machine. +However, this option is quite useful when debugging problems with the .Tn PCL interfaces. .Pp diff --git a/share/man/man4/man4.vax/ps.4 b/share/man/man4/man4.vax/ps.4 index ad9806937ee..32eb1225837 100644 --- a/share/man/man4/man4.vax/ps.4 +++ b/share/man/man4/man4.vax/ps.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ps.4,v 1.3 1999/06/05 13:18:39 aaron Exp $ +.\" $OpenBSD: ps.4,v 1.4 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: ps.4,v 1.3 1996/03/03 17:13:59 thorpej Exp $ .\" .\" Copyright (c) 1983, 1991 Regents of the University of California. @@ -58,8 +58,8 @@ with no system call overhead. .Tn DMA to and from the .Tn PS2 -is not supported. All read and write -system calls will fail. +is not supported. +All read and write system calls will fail. All data is moved to and from the .Tn PS2 via programmed @@ -108,8 +108,8 @@ The second argument is the length of each double buffer. The refresh mechanism displays the current double buffer, in addition to its static refresh lists, when in double buffer mode. .It Dv PSIOSINGLEREFRESH -Single step the refresh process. That is, the driver does not continually -refresh the screen. +Single step the refresh process. +That is, the driver does not continually refresh the screen. .It Dv PSIOSINGLEMAP Single step the matrix process. The driver does not automatically feed display files through the matrix unit. @@ -117,7 +117,8 @@ The driver does not automatically feed display files through the matrix unit. Turn off double buffering. .It Dv PSIOTIMEREFRESH The argument is a count of the number of refresh interrupts to take -before turning off the screen. This is used to do time exposures. +before turning off the screen. +This is used to do time exposures. .It Dv PSIOWAITREFRESH Suspend the user process until a refresh interrupt has occurred. If in diff --git a/share/man/man4/man4.vax/rx.4 b/share/man/man4/man4.vax/rx.4 index f5665a78131..c42d7840056 100644 --- a/share/man/man4/man4.vax/rx.4 +++ b/share/man/man4/man4.vax/rx.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rx.4,v 1.5 2000/07/22 05:01:13 bjc Exp $ +.\" $OpenBSD: rx.4,v 1.6 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: rx.4,v 1.3 1996/03/03 17:14:03 thorpej Exp $ .\" .\" Copyright (c) 1983, 1991 Regents of the University of California. @@ -64,9 +64,9 @@ either single or double density. Floppy disks handled by the .Tn RX02 contain 77 tracks, each with 26 -sectors (for a total of 2,002 sectors). The sector size is 128 -bytes for single density, 256 bytes for double density. Single -density disks are compatible with the +sectors (for a total of 2,002 sectors). +The sector size is 128 bytes for single density, 256 bytes for double density. +Single density disks are compatible with the .Tn RX01 floppy disk unit and with .Tn IBM @@ -95,7 +95,8 @@ Other Drive number The two drives in a single .Tn RX02 unit are treated as -two disks attached to a single controller. Thus, if there are two +two disks attached to a single controller. +Thus, if there are two .Tn RX02 Ns 's on a system, the drives on the first .Tn RX02 @@ -109,8 +110,8 @@ and .Dq Li rx3 . .Pp When the device is opened, the density of the disk -currently in the drive is automatically determined. If there -is no floppy in the device, open will fail. +currently in the drive is automatically determined. +If there is no floppy in the device, open will fail. .Pp The interleaving parameters are represented in raw device names by the letters @@ -177,8 +178,8 @@ int *arg; The applicable codes are: .Bl -tag -width RXIOC_GETDENS .It Dv RXIOC_FORMAT -Format the diskette. The density to use is specified -by the +Format the diskette. +The density to use is specified by the .Ar arg argument, zero gives single density while non-zero gives double density. @@ -203,12 +204,13 @@ return 0. .Sh DIAGNOSTICS .Bl -diag .It "rx%d: hard error, trk %d psec %d cs=%b, db=%b, err=%x, %x, %x, %x." -An unrecoverable error was encountered. The -track and physical sector numbers, the device registers and the +An unrecoverable error was encountered. +The track and physical sector numbers, the device registers and the extended error status are displayed. .Pp .It rx%d: state %d (reset). -The driver entered a bogus state. This should not happen. +The driver entered a bogus state. +This should not happen. .El .Sh ERRORS The following errors may be returned by the driver: @@ -247,9 +249,9 @@ driver appeared in .Bx 4.2 . .Sh BUGS A floppy may not be formatted if the -header info on sector 1, track 0 has been damaged. Hence, it is not -possible to format completely degaussed disks or disks with other -formats than the two known by the hardware. +header info on sector 1, track 0 has been damaged. +Hence, it is not possible to format completely degaussed disks or disks with +other formats than the two known by the hardware. .Pp If the drive subsystem is powered down when the machine is booted, the controller won't interrupt. diff --git a/share/man/man4/man4.vax/tm.4 b/share/man/man4/man4.vax/tm.4 index b081f83654c..24255b31a5d 100644 --- a/share/man/man4/man4.vax/tm.4 +++ b/share/man/man4/man4.vax/tm.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tm.4,v 1.4 1999/06/05 13:18:39 aaron Exp $ +.\" $OpenBSD: tm.4,v 1.5 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: tm.4,v 1.3 1996/03/03 17:14:04 thorpej Exp $ .\" .\" Copyright (c) 1980, 1991 Regents of the University of California. @@ -82,17 +82,18 @@ A tape error occurred at block .Em bn ; the tm error register is -printed in octal with the bits symbolically decoded. Any error is -fatal on non-raw tape; when possible the driver will have retried +printed in octal with the bits symbolically decoded. +Any error is fatal on non-raw tape; when possible the driver will have retried the operation which failed several times before reporting the error. .Pp .It te%d: lost interrupt. A tape operation did not complete within a reasonable time, most likely because the tape was taken -off-line during rewind or lost vacuum. The controller should, but does not, -give an interrupt in these cases. The device will be made available -again after this message, but any current open reference to the device -will return an error as the operation in progress aborts. +off-line during rewind or lost vacuum. +The controller should, but does not, give an interrupt in these cases. +The device will be made available again after this message, but any current +open reference to the device will return an error as the operation in progress +aborts. .El .Sh SEE ALSO .Xr mt 1 , diff --git a/share/man/man4/man4.vax/tmscp.4 b/share/man/man4/man4.vax/tmscp.4 index 8284d1ff4fe..f328518081a 100644 --- a/share/man/man4/man4.vax/tmscp.4 +++ b/share/man/man4/man4.vax/tmscp.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tmscp.4,v 1.6 1999/07/09 13:35:40 aaron Exp $ +.\" $OpenBSD: tmscp.4,v 1.7 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: tmscp.4,v 1.4 1996/03/03 17:14:06 thorpej Exp $ .\" .\" Copyright (c) 1986, 1991 Regents of the University of California. @@ -81,15 +81,18 @@ driver state are printed. An unexpected interrupt was received (e.g. when no .Tn I/O was -pending). The interrupt is ignored. +pending). +The interrupt is ignored. .Pp .It tmscp%d: interrupt in unknown state %d ignored. An interrupt was received when the driver was in an unknown -internal state. Indicates a hardware problem or a driver bug. +internal state. +Indicates a hardware problem or a driver bug. .Pp .It tmscp%d: fatal error (0%o). The controller detected a ``fatal error'' in the status returned -to the host. The contents of the status register are displayed. +to the host. +The contents of the status register are displayed. .Pp .It OFFLINE. (Additional status information given after a hard diff --git a/share/man/man4/man4.vax/tu.4 b/share/man/man4/man4.vax/tu.4 index 79dd119b5ce..5f99147c4a9 100644 --- a/share/man/man4/man4.vax/tu.4 +++ b/share/man/man4/man4.vax/tu.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tu.4,v 1.5 2001/08/17 11:13:58 mpech Exp $ +.\" $OpenBSD: tu.4,v 1.6 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: tu.4,v 1.4 1996/03/03 17:14:09 thorpej Exp $ .\" .\" Copyright (c) 1980, 1991 Regents of the University of California. @@ -68,8 +68,8 @@ The .Tn TU58 on an 11/750 uses the Radial Serial Protocol .Pq Tn RSP -to communicate with the cpu over a serial line. This -protocol is inherently unreliable as it has no flow +to communicate with the cpu over a serial line. +This protocol is inherently unreliable as it has no flow control measures built in. .Sh FILES .Bl -tag -width /dev/tu0xx -compact diff --git a/share/man/man4/man4.vax/uda.4 b/share/man/man4/man4.vax/uda.4 index efaeb5c79f0..8595b511c88 100644 --- a/share/man/man4/man4.vax/uda.4 +++ b/share/man/man4/man4.vax/uda.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: uda.4,v 1.7 2001/06/23 08:02:03 pjanzen Exp $ +.\" $OpenBSD: uda.4,v 1.8 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: uda.4,v 1.3 1996/03/03 17:14:10 thorpej Exp $ .\" .\" Copyright (c) 1980, 1987, 1991 Regents of the University of California. @@ -50,7 +50,8 @@ disk controller interface This is a driver for the .Tn DEC UDA50 disk controller and other -compatible controllers. The +compatible controllers. +The .Tn UDA50 communicates with the host through a packet protocol known as the Mass Storage Control Protocol @@ -102,9 +103,9 @@ encountered. A default partition table in the driver is used for each type of disk when a pack is not labelled. The origin and size (in sectors) of the default pseudo-disks on each -drive are shown below. Not all partitions begin on cylinder -boundaries, as on other drives, because previous drivers used one -partition table for all drive types. +drive are shown below. +Not all partitions begin on cylinder boundaries, as on other drives, +because previous drivers used one partition table for all drive types. Variants of the partition tables are common; check the driver and the file .Pa /etc/disktab .Pq Xr disktab 5 @@ -538,7 +539,7 @@ DEC order number AA-M879A-TC, in appendices E and F. .It "unit %d: small disk error, cyl %d" Yet another kind of disk error, but for small disks. .Po -``That's what it says, guv'nor. Dunnask me what it means.'' +``That's what it says, guv'nor. Dunnask me what it means.'' .Pc .Pp .It "unit %d: unknown error, format 0x%x" @@ -568,7 +569,8 @@ disabled for diagnostics (`in diagnosis'). .Pp .It "unit available (unknown subcode) (code 4, subcode %d)" The controller has decided to report a perfectly normal event as -an error. (Why?) +an error. +(Why?) .Pp .It "media format error (%s) (code 5, subcode %d)" The drive cannot be used without reformatting. diff --git a/share/man/man4/man4.vax/up.4 b/share/man/man4/man4.vax/up.4 index 84e2a70da6a..ef2288ff41c 100644 --- a/share/man/man4/man4.vax/up.4 +++ b/share/man/man4/man4.vax/up.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: up.4,v 1.6 2001/06/20 16:49:44 millert Exp $ +.\" $OpenBSD: up.4,v 1.7 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: up.4,v 1.3 1996/03/03 17:14:12 thorpej Exp $ .\" .\" Copyright (c) 1980,1988, 1991 Regents of the University of California. @@ -68,8 +68,8 @@ It is recommended as a security precaution to not create special files for devices which may never be installed. .Sh DISK SUPPORT The driver interrogates the controller's holding register -to determine the type of drive attached. The driver recognizes -seven different drives: +to determine the type of drive attached. +The driver recognizes seven different drives: .Tn CDC 9762, .Tn CDC @@ -89,13 +89,13 @@ Special file names begin with .Sq Li up and .Sq Li rup -for the block and character files respectively. The second -component of the name, a drive unit number in the range of zero to +for the block and character files respectively. +The second component of the name, a drive unit number in the range of zero to seven, is represented by a .Sq Li ? -in the disk layouts below. The last component of the name, the -file system partition, is -designated by a letter from +in the disk layouts below. +The last component of the name, the file system partition, is designated by +a letter from .Sq Li a to .Sq Li h @@ -208,33 +208,35 @@ recover the error. .Pp .It "up%d: write locked." The write protect switch was set on the drive -when a write was attempted. The write operation is not recoverable. +when a write was attempted. +The write operation is not recoverable. .Pp .It "up%d: not ready." The drive was spun down or off line when it was -accessed. The i/o operation is not recoverable. +accessed. +The i/o operation is not recoverable. .Pp .It "up%d: not ready (flakey)." The drive was not ready, but after printing the message about being not ready (which takes a fraction -of a second) was ready. The operation is recovered if no further -errors occur. +of a second) was ready. +The operation is recovered if no further errors occur. .Pp .It "up%d%c: soft ecc reading fsbn %d[-%d]." A recoverable ECC error occurred on the specified sector of the specified disk partition. This happens normally -a few times a week. If it happens more frequently than -this the sectors where the errors are occurring should be checked to see -if certain cylinders on the pack, spots on the carriage of the drive -or heads are indicated. +a few times a week. +If it happens more frequently than this the sectors where the errors are +occurring should be checked to see if certain cylinders on the pack, +spots on the carriage of the drive or heads are indicated. .Pp .It "sc%d: lost interrupt." A timer watching the controller detecting no interrupt for an extended period while an operation was outstanding. -This indicates a hardware or software failure. There is currently a -hardware/software problem with spinning down drives while they are -being accessed which causes this error to occur. +This indicates a hardware or software failure. +There is currently a hardware/software problem with spinning down drives +while they are being accessed which causes this error to occur. The error causes a .Tn UNIBUS reset, and retry of the pending operations. diff --git a/share/man/man4/man4.vax/ut.4 b/share/man/man4/man4.vax/ut.4 index cbfb76fd6e9..6453cde673a 100644 --- a/share/man/man4/man4.vax/ut.4 +++ b/share/man/man4/man4.vax/ut.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ut.4,v 1.3 1999/06/05 13:18:39 aaron Exp $ +.\" $OpenBSD: ut.4,v 1.4 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: ut.4,v 1.3 1996/03/03 17:14:13 thorpej Exp $ .\" .\" Copyright (c) 1983, 1991 Regents of the University of California. @@ -56,8 +56,8 @@ Hardware implementing this on the is typified by the System Industries .Tn SI -9700 tape subsystem. Tapes may be read or written -at 800, 1600, and 6250 +9700 tape subsystem. +Tapes may be read or written at 800, 1600, and 6250 .Tn BPI . .Sh DIAGNOSTICS .Bl -diag @@ -79,7 +79,8 @@ the density. .Pp .It "ut%d: soft error bn%d cs1=%b er=%b cs2=%b ds=%b." The formatter indicated a corrected error at a density other -than 800bpi. The data transferred is assumed to be correct. +than 800bpi. +The data transferred is assumed to be correct. .Pp .It "ut%d: hard error bn%d cs1=%b er=%b cs2=%b ds=%b." A tape error occurred @@ -93,10 +94,11 @@ the operation which failed several times before reporting the error. .It tj%d: lost interrupt. A tape operation did not complete within a reasonable time, most likely because the tape was taken -off-line during rewind or lost vacuum. The controller should, but does not, -give an interrupt in these cases. The device will be made available -again after this message, but any current open reference to the device -will return an error as the operation in progress aborts. +off-line during rewind or lost vacuum. +The controller should, but does not, give an interrupt in these cases. +The device will be made available again after this message, but any current +open reference to the device will return an error as the operation +in progress aborts. .El .Sh SEE ALSO .Xr mt 1 , diff --git a/share/man/man4/man4.vax/uu.4 b/share/man/man4/man4.vax/uu.4 index 8b60837538b..23a7713ebe0 100644 --- a/share/man/man4/man4.vax/uu.4 +++ b/share/man/man4/man4.vax/uu.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: uu.4,v 1.4 2001/06/20 16:49:44 millert Exp $ +.\" $OpenBSD: uu.4,v 1.5 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: uu.4,v 1.3 1996/03/03 17:14:14 thorpej Exp $ .\" .\" Copyright (c) 1983, 1991 Regents of the University of California. @@ -103,11 +103,12 @@ in the configuration file. .It uu%d: no bp, active %d. A transmission complete interrupt was received with no outstanding .Tn I/O -request. This indicates a hardware problem. +request. +This indicates a hardware problem. .Pp .It uu%d protocol error, state=%s, op=%x, cnt=%d, block=%d. -The driver entered an illegal state. The information printed -indicates the illegal state, the +The driver entered an illegal state. +The information printed indicates the illegal state, the operation currently being executed, the .Tn I/O @@ -117,13 +118,14 @@ count, and the block number on the cassette. The .Tn TU58 was sending a continuous break signal and had -to be reset. This may indicate a hardware problem, but -the driver will attempt to recover from the error. +to be reset. +This may indicate a hardware problem, but the driver will attempt to recover +from the error. .Pp .It uu%d receive state error, state=%s, byte=%x. The driver entered an illegal state in the receiver finite -state machine. The state is shown along with the control -byte of the received packet. +state machine. +The state is shown along with the control byte of the received packet. .Pp .It uu%d: read stalled. A timer watching the controller detected no interrupt for @@ -132,9 +134,9 @@ This usually indicates that one or more receiver interrupts were lost and the transfer is restarted. .Pp .It uu%d: hard error bn%d, pk_mod %o. -The device returned a status code indicating a hard error. The -actual error code is shown in octal. No retries are attempted -by the driver. +The device returned a status code indicating a hard error. +The actual error code is shown in octal. +No retries are attempted by the driver. .El .Sh ERRORS The following errors may be returned: diff --git a/share/man/man4/man4.vax/va.4 b/share/man/man4/man4.vax/va.4 index 2825fb01dd3..a95e13edcb2 100644 --- a/share/man/man4/man4.vax/va.4 +++ b/share/man/man4/man4.vax/va.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: va.4,v 1.5 2001/10/04 10:28:20 wilfried Exp $ +.\" $OpenBSD: va.4,v 1.6 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: va.4,v 1.3 1996/03/03 17:14:15 thorpej Exp $ .\" .\" Copyright (c) 1980, 1991 Regents of the University of California. @@ -147,7 +147,8 @@ The device was not able to get data from the .Tn UNIBUS within the timeout period, most likely because some other -device was hogging the bus. (But see +device was hogging the bus. +(But see .Sx BUGS below). .El diff --git a/share/man/man4/man4.vax/vv.4 b/share/man/man4/man4.vax/vv.4 index e353cb980aa..af58e4f6623 100644 --- a/share/man/man4/man4.vax/vv.4 +++ b/share/man/man4/man4.vax/vv.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: vv.4,v 1.5 1999/06/05 13:18:40 aaron Exp $ +.\" $OpenBSD: vv.4,v 1.6 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: vv.4,v 1.3 1996/03/03 17:14:18 thorpej Exp $ .\" .\" Copyright (c) 1983, 1991 The Regents of the University of California. @@ -115,8 +115,8 @@ family; the packet was dropped. .Pp .It vv%d: vs_olen=%d. The ring output routine has been -handed a message with a preposterous length. This results in -an immediate +handed a message with a preposterous length. +This results in an immediate .Em panic: vs_olen . .El .Sh SEE ALSO diff --git a/share/man/man4/man4.vax/ze.4 b/share/man/man4/man4.vax/ze.4 index b326e6a1675..7371f3ab6cc 100644 --- a/share/man/man4/man4.vax/ze.4 +++ b/share/man/man4/man4.vax/ze.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ze.4,v 1.2 2000/10/13 04:09:21 aaron Exp $ +.\" $OpenBSD: ze.4,v 1.3 2001/10/05 14:45:54 mpech Exp $ .\" .Dd July 21, 2000 .Dt ZE 4 vax @@ -16,8 +16,8 @@ interface provides access to the 10 Mb/s .Tn Ethernet network through the DEC Second Generation Ethernet Chip (SGEC) chipset. .Pp -Different machine configurations have varying types of connectors. The -following types can be found: +Different machine configurations have varying types of connectors. +The following types can be found: .Pp .Bl -tag -width 10n .It AUI/DIX diff --git a/share/man/man4/midi.4 b/share/man/man4/midi.4 index dae753ad412..6bfff33bb4b 100644 --- a/share/man/man4/midi.4 +++ b/share/man/man4/midi.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: midi.4,v 1.6 2001/09/06 15:04:34 mpech Exp $ +.\" $OpenBSD: midi.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: midi.4,v 1.4 1998/08/22 14:45:35 augustss Exp $ .\" .\" Copyright (c) 1997 The NetBSD Foundation, Inc. @@ -55,9 +55,10 @@ The .Nm driver provides support for various MIDI peripherals. It provides a uniform programming interface layer above different -underlying MIDI hardware drivers. The MIDI hardware can be of many -different kinds, e.g., an external synthesizer on a MIDI port (or a serial port), -the PC speaker, an internal FM synth, or a wavetable synth. +underlying MIDI hardware drivers. +The MIDI hardware can be of many different kinds, e.g., an external +synthesizer on a MIDI port (or a serial port), the PC speaker, an +internal FM synth, or a wavetable synth. .Pp There are two device file types available for MIDI operation: .Pa /dev/rmidiN , @@ -65,25 +66,28 @@ and .Pa /dev/music . The .Pa /dev/rmidiN -devices provides raw access to a MIDI device. Data written is sent -to the physical device as fast as possible and is uninterpreted. +devices provides raw access to a MIDI device. +Data written is sent to the physical device as fast as possible and +is uninterpreted. Reading from the device returns data as soon as it becomes available. A moderate amount of buffering is available both for reading and writing. The raw MIDI devices are mostly useful for non realtime operations, such as downloading patches to a device, since it is hard to get the accurate timing -needed for quality music from a user program. But the devices can act as -a simple patchboard for MIDI devices. For example, a MIDI keyboard could -be connected to a synthesizer by the command +needed for quality music from a user program. +But the devices can act as a simple patchboard for MIDI devices. +For example, a MIDI keyboard could be connected to a synthesizer by +the command .Pp .Cd "cat -u /dev/rmidi1 >/dev/rmidi2" .Pp The .Pa /dev/music -device is a MIDI sequencer device. Data sent to and from this device -not only contains the information sent to the MIDI device, but also -timing information. The kernel will make sure that data is sent -to the physical device at the indicated time. The sequencer device -uses the +device is a MIDI sequencer device. +Data sent to and from this device not only contains the information sent to the +MIDI device, but also timing information. +The kernel will make sure that data is sent to the physical device at the +indicated time. +The sequencer device uses the .Pa /dev/midiN devices internally and they are unavailable when used by the sequencer. .Pp diff --git a/share/man/man4/mtio.4 b/share/man/man4/mtio.4 index 9c32dc4939f..4be775d593b 100644 --- a/share/man/man4/mtio.4 +++ b/share/man/man4/mtio.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mtio.4,v 1.8 2001/08/25 15:40:31 aaron Exp $ +.\" $OpenBSD: mtio.4,v 1.9 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: mtio.4,v 1.4 1996/03/03 17:13:54 thorpej Exp $ .\" .\" Copyright (c) 1983, 1991 The Regents of the University of California. @@ -71,13 +71,15 @@ it will operate at 6250 .Pp The rewind devices automatically rewind when the last requested read, write or seek has finished, or the end of the tape -has been reached. The letter +has been reached. +The letter .Ql n is usually prepended to the name of the no-rewind devices. .Pp Unix tapes are written in multiples of 1024 byte block -records. Two end-of-file markers mark the end of a tape, and +records. +Two end-of-file markers mark the end of a tape, and one end-of-file marker marks the end of a tape file. If the tape is not to be rewound it is positioned with the head in between the two tape marks, where the next write diff --git a/share/man/man4/ncr.4 b/share/man/man4/ncr.4 index 14da32195c6..fc196957c2b 100644 --- a/share/man/man4/ncr.4 +++ b/share/man/man4/ncr.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ncr.4,v 1.7 2001/04/11 20:48:03 miod Exp $ +.\" $OpenBSD: ncr.4,v 1.8 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1994 James A. Jegers .\" All rights reserved. @@ -83,8 +83,9 @@ Enable this only if using a Tekram DC-390 card. .It Cd option NCR_VERBOSE=integer Specifies the verbosity of driver messages during a kernel boot. A value of 1 will provide extra information about the controller's -capabilities and setup. A value of 2 or greater will print information -about the controller's registers. +capabilities and setup. +A value of 2 or greater will print information about the controller's +registers. .It Cd option SCSI_NCR_DFLT_TAGS=integer Specifies the maximum number of tags per logical unit. Unless @@ -122,11 +123,12 @@ firmware instead of configuring the chip itself. Some Quantum drives (specifically the Atlas series) return .Dq queue full responses when a very small number of tags is used which can confuse -the driver. With such drives, you can use +the driver. +With such drives, you can use .Bd -literal option SCSI_NCR_DFLT_TAGS=0 - .Ed +.Pp in your kernel configuration file to disable tagged command queuing. .Sh SEE ALSO .Xr cd 4 , diff --git a/share/man/man4/ne.4 b/share/man/man4/ne.4 index df8ac0c7151..d63bad86ce5 100644 --- a/share/man/man4/ne.4 +++ b/share/man/man4/ne.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ne.4,v 1.7 2001/05/21 19:47:02 aaron Exp $ +.\" $OpenBSD: ne.4,v 1.8 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: ne.4,v 1.4 1998/02/22 05:21:20 enami Exp $ .\" .\" Copyright (c) 1997 The NetBSD Foundation, Inc. @@ -56,8 +56,9 @@ cards. .Sh MEDIA SELECTION The RealTek 8019 (ISA, ISAPnP, some PCMCIA) and RealTek 8029 (PCI) NE2000-compatible Ethernet chips include support for software media -selection. If one of these chips is detected by the driver, the list -of supported media will be displayed. +selection. +If one of these chips is detected by the driver, the list of supported media +will be displayed. .Pp For all other chips supported by the .Nm diff --git a/share/man/man4/neo.4 b/share/man/man4/neo.4 index 49dc69c2d3f..ad735232ca4 100644 --- a/share/man/man4/neo.4 +++ b/share/man/man4/neo.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: neo.4,v 1.5 2001/07/31 00:39:07 deraadt Exp $ +.\" $OpenBSD: neo.4,v 1.6 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1998 Constantine Paul Sapuntzakis .\" All rights reserved @@ -47,9 +47,9 @@ audio chips found in many laptops, and perhaps on some PCI cards. .Xr audio 4 .Sh BUGS This driver has some bugs because Neomagic refuses to provide documentation, -even though they are discontinuing their products. At the time of contact, -all persons working at the company were hiding behind their receptionist as -if in a stage of siege. +even though they are discontinuing their products. +At the time of contact, all persons working at the company were hiding +behind their receptionist as if in a stage of siege. .Sh HISTORY The .Nm diff --git a/share/man/man4/netintro.4 b/share/man/man4/netintro.4 index d7a07f7d216..94aea70a7f8 100644 --- a/share/man/man4/netintro.4 +++ b/share/man/man4/netintro.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: netintro.4,v 1.17 2001/03/01 16:11:18 aaron Exp $ +.\" $OpenBSD: netintro.4,v 1.18 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: netintro.4,v 1.4 1995/10/19 08:03:40 jtc Exp $ .\" .\" Copyright (c) 1983, 1990, 1991, 1993 @@ -59,16 +59,17 @@ All network protocols are associated with a specific .Em protocol family . A protocol family provides basic services to the protocol implementation to allow it to function within a specific -network environment. These services may include -packet fragmentation and reassembly, routing, addressing, and -basic transport. A protocol family may support multiple -methods of addressing, though the current protocol implementations -do not. A protocol family is normally comprised of a number -of protocols, one per +network environment. +These services may include packet fragmentation and reassembly, routing, +addressing, and basic transport. +A protocol family may support multiple methods of addressing, though +the current protocol implementations do not. +A protocol family is normally comprised of a number of protocols, one per .Xr socket 2 -type. It is not required that a protocol family support -all socket types. A protocol family may contain multiple -protocols supporting the same socket abstraction. +type. +It is not required that a protocol family support all socket types. +A protocol family may contain multiple protocols supporting the same socket +abstraction. .Pp A protocol supports one of the socket abstractions detailed in .Xr socket 2 . @@ -79,10 +80,11 @@ Protocols normally accept only one type of address format, usually determined by the addressing structure inherent in the design of the protocol family/network architecture. Certain semantics of the basic socket abstractions are -protocol specific. All protocols are expected to support -the basic model for their particular socket type, but may, -in addition, provide non-standard facilities or extensions -to a mechanism. For example, a protocol supporting the +protocol specific. +All protocols are expected to support the basic model for their particular +socket type, but may, in addition, provide non-standard facilities or +extensions to a mechanism. +For example, a protocol supporting the .Dv SOCK_STREAM abstraction may allow more than one byte of out-of-band data to be transmitted per out-of-band message. @@ -90,12 +92,11 @@ data to be transmitted per out-of-band message. A network interface is similar to a device interface. Network interfaces comprise the lowest layer of the networking subsystem, interacting with the actual transport -hardware. An interface may support one or more protocol -families and/or address formats. -The SYNOPSIS section of each network interface -entry gives a sample specification -of the related drivers for use in providing -a system description to the +hardware. +An interface may support one or more protocol families and/or address formats. +The SYNOPSIS section of each network interface entry gives a sample +specification of the related drivers for use in providing a system description +to the .Xr config 8 program. The DIAGNOSTICS section lists messages which may appear on the console @@ -123,10 +124,11 @@ Consult the appropriate manual pages in this section for more information regarding the support for each protocol family. .Sh ADDRESSING Associated with each protocol family is an address -format. All network addresses adhere to a general structure, -called a sockaddr, described below. However, each protocol -imposes a finer, more specific structure, generally renaming -the variant, which is discussed in the protocol family manual +format. +All network addresses adhere to a general structure, called a sockaddr, +described below. +However, each protocol imposes a finer, more specific structure, generally +renaming the variant, which is discussed in the protocol family manual page alluded to above. .Bd -literal -offset indent struct sockaddr { @@ -174,9 +176,9 @@ This facility is described in .Xr route 4 . .Sh INTERFACES Each network interface in a system corresponds to a -path through which messages may be sent and received. A network -interface usually has a hardware device associated with it, though -certain interfaces such as the loopback interface, +path through which messages may be sent and received. +A network interface usually has a hardware device associated with it, +though certain interfaces such as the loopback interface, .Xr lo 4 , do not. .Pp @@ -191,7 +193,8 @@ in the desired domain. Most of the requests supported in earlier releases take an .Ar ifreq -structure as its parameter. This structure has the form +structure as its parameter. +This structure has the form .Bd -literal struct ifreq { #define IFNAMSIZ 16 @@ -217,9 +220,9 @@ struct ifreq { Calls which are now deprecated are: .Bl -tag -width SIOCGIFBRDADDR .It Dv SIOCSIFADDR -Set interface address for protocol family. Following the address -assignment, the ``initialization'' routine for -the interface is called. +Set interface address for protocol family. +Following the address assignment, the ``initialization'' routine for the +interface is called. .It Dv SIOCSIFDSTADDR Set point to point address for protocol family and interface. .It Dv SIOCSIFBRDADDR @@ -240,19 +243,21 @@ Get point to point address for protocol family and interface. .It Dv SIOCGIFBRDADDR Get broadcast address for protocol family and interface. .It Dv SIOCSIFFLAGS -Set interface flags field. If the interface is marked down, -any processes currently routing packets through the interface -are notified; -some interfaces may be reset so that incoming packets are no longer received. +Set interface flags field. +If the interface is marked down, any processes currently routing packets +through the interface are notified; some interfaces may be reset so that +incoming packets are no longer received. When marked up again, the interface is reinitialized. .It Dv SIOCGIFFLAGS Get interface flags. .It Dv SIOCSIFMEDIA -Set interface media. See +Set interface media. +See .Xr ifmedia 4 for possible values. .It Dv SIOCGIFMEDIA -Get interface media. See +Get interface media. +See .Xr ifmedia 4 for interpreting this value. .It Dv SIOCSIFMETRIC @@ -266,14 +271,13 @@ There are two requests that make use of a new structure: .Bl -tag -width SIOCGIFBRDADDR .It Dv SIOCAIFADDR An interface may have more than one address associated with it -in some protocols. This request provides a means to -add additional addresses (or modify characteristics of the -primary address if the default address for the address family -is specified). Rather than making separate calls to -set destination or broadcast addresses, or network masks -(now an integral feature of multiple protocols) -a separate structure is used to specify all three facets simultaneously -(see below). +in some protocols. +This request provides a means to add additional addresses (or modify +characteristics of the primary address if the default address for the +address family is specified). +Rather than making separate calls to set destination or broadcast addresses, +or network masks (now an integral feature of multiple protocols) a separate +structure is used to specify all three facets simultaneously (see below). One would use a slightly tailored version of this struct specific to each family (replacing each sockaddr by one of the family-specific type). @@ -284,7 +288,8 @@ identifier itself to include the total size, as described in .Xr ioctl . .It Dv SIOCDIFADDR This request deletes the specified address from the list -associated with an interface. It also uses the +associated with an interface. +It also uses the .Ar if_aliasreq structure to allow for the possibility of protocols allowing multiple masks or destination addresses, and also adopts the @@ -292,15 +297,18 @@ convention that specification of the default address means to delete the first address for the interface belonging to the address family in which the original socket was opened. .It Dv SIOCGIFCONF -Get interface configuration list. This request takes an +Get interface configuration list. +This request takes an .Ar ifconf -structure (see below) as a value-result parameter. The +structure (see below) as a value-result parameter. +The .Ar ifc_len field should be initially set to the size of the buffer pointed to by .Ar ifc_buf . On return it will contain the length, in bytes, of the -configuration list. Alternately, if the +configuration list. +Alternately, if the .Ar ifc_len passed in is set to 0, .Dv SIOCGIFCONF @@ -312,7 +320,8 @@ needs to be to fit the entire configuration list and not fill in the other parameters. This is useful for determining the exact size that .Ar ifc_buf -needs to be in advance. Note, however, that this is an extension +needs to be in advance. +Note, however, that this is an extension that not all operating systems support. .El .Bd -literal diff --git a/share/man/man4/ns.4 b/share/man/man4/ns.4 index adbc0c2b349..37e08ef3773 100644 --- a/share/man/man4/ns.4 +++ b/share/man/man4/ns.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ns.4,v 1.9 2000/12/21 21:01:17 aaron Exp $ +.\" $OpenBSD: ns.4,v 1.10 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: ns.4,v 1.3 1994/11/30 16:22:26 jtc Exp $ .\" .\" Copyright (c) 1985, 1991, 1993 @@ -77,7 +77,8 @@ all stored in network standard format. these are word and byte reversed; on the .Tn SUN they are not -reversed). The include file +reversed). +The include file .Aq Pa netns/ns.h defines the .Tn NS diff --git a/share/man/man4/opl.4 b/share/man/man4/opl.4 index fbf3730ff5e..93eba9c8bed 100644 --- a/share/man/man4/opl.4 +++ b/share/man/man4/opl.4 @@ -1,10 +1,9 @@ -.\" $OpenBSD: opl.4,v 1.4 2001/06/23 07:03:57 pjanzen Exp $ +.\" $OpenBSD: opl.4,v 1.5 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: opl.4,v 1.3 1998/09/08 11:59:48 augustss Exp $ .\" .\" Copyright (c) 1997 The NetBSD Foundation, Inc. .\" All rights reserved. .\" - .\" Redistribution and use in source and binary forms, with or without .\" modification, are permitted provided that the following conditions .\" are met: @@ -49,7 +48,8 @@ The .Nm driver provides support for the Yamaha OPL2 (YM3812) and OPL3 -(YMF262) chips. The chips are FM synthesizer and are capable +(YMF262) chips. +The chips are FM synthesizer and are capable of producing a wide range of (mostly awful) sounds. .Pp Access to the device is through the MIDI driver. diff --git a/share/man/man4/options.4 b/share/man/man4/options.4 index f426584dda5..8a8b8d4876b 100644 --- a/share/man/man4/options.4 +++ b/share/man/man4/options.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: options.4,v 1.83 2001/10/04 10:28:20 wilfried Exp $ +.\" $OpenBSD: options.4,v 1.84 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: options.4,v 1.21 1997/06/25 03:13:00 thorpej Exp $ .\" .\" Copyright (c) 1998 Theo de Raadt @@ -296,7 +296,8 @@ Includes code implementing the AmigaDOS Fast File System .Em ( ADOSFS ) . Note that the Professional and Smart File Systems are .Em not -supported. See +supported. +See .Xr mount_ados 8 for details. .It Cd option EXT2FS @@ -811,21 +812,23 @@ Enables PFKEYv2 (RFC 2367) support. While not IP specific, this option is usually used in conjunction with option .Em IPSEC . .It Cd option ALTQ -Enables ALTQ (Alternate Queueing). For simple rate-limiting, use +Enables ALTQ (Alternate Queueing). +For simple rate-limiting, use .Xr tbrconfig 8 -to set up the interface transmission rate. To use queueing disciplines, -their options should also be defined. Queueing disciplines are -managed by +to set up the interface transmission rate. +To use queueing disciplines, their options should also be defined. +Queueing disciplines are managed by .Xr altqd 8 . See .Xr altq 9 for details on ALTQ. .It Cd option ALTQ_CBQ -Enables ALTQ's CBQ (Class-based Queueing) module. CBQ achieves both -partitioning and sharing of link bandwidth by hierarchically -structured classes. Each class has its own queue and is assigned its -share of bandwidth. A child class can borrow bandwidth from its -parent class as long as excess bandwidth is available. +Enables ALTQ's CBQ (Class-based Queueing) module. +CBQ achieves both partitioning and sharing of link bandwidth by hierarchically +structured classes. +Each class has its own queue and is assigned its share of bandwidth. +A child class can borrow bandwidth from its parent class as long as excess +bandwidth is available. .It Cd option ALTQ_HFSC Enables ALTQ's HFSC (Hierarchical Fair Service Curve) module. HFSC supports both link-sharing and guaranteed real-time services. @@ -833,14 +836,14 @@ H-FSC employs a service curve based QoS model, and its unique feature is an ability to decouple delay and bandwidth allocation. .It Cd option ALTQ_PRIQ Enables ALTQ's PRIQ (Priority Queueing) module. -PRIQ implements a simple priority-based queueing. A higher priority -class is always served first. +PRIQ implements a simple priority-based queueing. +A higher priority class is always served first. .It Cd option ALTQ_WFQ Enables ALTQ's WFQ (Weighted Fair Queueing) module. WFQ implements a weighted-round robin scheduler for a set of queues. A weight can be assigned to each queue to give a different proportion -of the link capacity. A hash function is used to map a flow to one of -a set of queues. +of the link capacity. +A hash function is used to map a flow to one of a set of queues. .It Cd option ALTQ_FIFOQ Enables ALTQ's FIFO queue module. FIFOQ is a simple drop-tail FIFO queue. @@ -848,35 +851,38 @@ FIFOQ is a simple drop-tail FIFO queue. Enables ALTQ's RED (Random Early Detection) module. RED is an implicit congestion notification mechanism that exercises packet dropping or packet marking stochastically according to the -average queue length. RED can be viewed as an active buffer -management mechanism and can be integrated into other queueing -disciplines. +average queue length. +RED can be viewed as an active buffer management mechanism and can be +integrated into other queueing disciplines. .It Cd option ALTQ_RIO Enables ALTQ's RIO (RED with In/Oout) module. The original RIO has 2 sets of RED parameters; one for in-profile -packets and the other for out-of-profile packets. At the ingress of -the network, profile meters tag packets as IN or OUT based on -contracted profiles for customers. Inside the network, IN packets -receive preferential treatment by the RIO dropper. +packets and the other for out-of-profile packets. +At the ingress of the network, profile meters tag packets as IN or +OUT based on contracted profiles for customers. +Inside the network, IN packets receive preferential treatment by +the RIO dropper. ALTQ/RIO has 3 drop precedence levels defined for the Assured Forwarding PHB of DiffServ (RFC2597). .It Cd option ALTQ_BLUE Enables ALTQ's Blue module. Blue is another active buffer management mechanism. .It Cd option ALTQ_FLOWVALVE -Enables ALTQ's Flowvalve module. Flowvalve is a simple implementation -of a RED penalty box that identifies and punishes misbehaving flows. +Enables ALTQ's Flowvalve module. +Flowvalve is a simple implementation of a RED penalty box that identifies +and punishes misbehaving flows. .It Cd option ALTQ_CDNR Enables ALTQ's CDNR (diffserfv traffic conditioner) module. Traffic conditioners are components to meter, mark, or drop incoming -packets according to some rules. As opposed to queueing disciplines, -traffic conditioners handle incoming packets at an input interface. +packets according to some rules. +As opposed to queueing disciplines, traffic conditioners handle incoming +packets at an input interface. .It Cd option ALTQ_NOPCC Disables use of processor cycle counter (e.g., Pentium TSC on i386 and -PCC on alpha) to measure time in ALTQ. This option should be defined -for a non-Pentium i386 CPU which does not have TSC, SMP (per-CPU -counters are not in sync), or power management which affects processor -cycle counter. +PCC on alpha) to measure time in ALTQ. +This option should be defined for a non-Pentium i386 CPU which does not +have TSC, SMP (per-CPU counters are not in sync), or power management +which affects processor cycle counter. .El .Ss SCSI Subsystem Options .Bl -ohang @@ -926,22 +932,24 @@ See for the default. .It Cd option SEMMNI=value Number of semaphore identifiers (also called semaphore handles -and semaphore sets) available in the system. Default value is 10. +and semaphore sets) available in the system. +Default value is 10. The kernel allocates memory for the control structures at startup, so you should avoid arbitrarily large values. .It Cd option SEMMNS=value -Maximum number of semaphores in all sets in the system. Default -value is 60. +Maximum number of semaphores in all sets in the system. +Default value is 60. .It Cd option SEMMNU=value Maximum number of semaphore undo structures in the system. Default value is 30. .It Cd option SEMUME=value Maximum number of per-process undo operation entries in the -system. Semaphore undo operations are invoked by the kernel -when +system. +Semaphore undo operations are invoked by the kernel when .Xr semop 2 is called with the SEM_UNDO flag and the process holding -the semaphores terminates unexpectedly. Default value is 10. +the semaphores terminates unexpectedly. +Default value is 10. .El .Ss Operation Related Options .Bl -ohang @@ -974,8 +982,7 @@ These options set the number of pages available for the buffer cache. Their default value is a machine dependent value, often calculated as between 5% and 10% of total available RAM. .It Cd option NTP -Modify the scheduler code to add hooks necessary for running an NTP -daemon. +Modify the scheduler code to add hooks necessary for running an NTP daemon. .Xr xntpd 8 is available as part of the port collection. .It Cd option APM_NOPRINT diff --git a/share/man/man4/pcdisplay.4 b/share/man/man4/pcdisplay.4 index 9240cf7c23d..34d89536426 100644 --- a/share/man/man4/pcdisplay.4 +++ b/share/man/man4/pcdisplay.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pcdisplay.4,v 1.4 2001/06/23 07:03:57 pjanzen Exp $ +.\" $OpenBSD: pcdisplay.4,v 1.5 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: pcdisplay.4,v 1.3 2000/05/13 15:22:17 mycroft Exp $ .\" .Dd March 20, 1999 @@ -30,8 +30,8 @@ It doesn't support multiple screens, nor colors or font loading. Supported kernel option(s): .Bl -tag -ohang -width xxxx .It Cd option PCDISPLAY_SOFTCURSOR -Use a large, non-blinking cursor generated by software. The default is to use -the cursor provided by the underlying display hardware. +Use a large, non-blinking cursor generated by software. +The default is to use the cursor provided by the underlying display hardware. .El .Sh SEE ALSO .Xr isa 4 , diff --git a/share/man/man4/pci.4 b/share/man/man4/pci.4 index c6695258807..307fbe07f84 100644 --- a/share/man/man4/pci.4 +++ b/share/man/man4/pci.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pci.4,v 1.46 2001/10/04 16:56:51 mpech Exp $ +.\" $OpenBSD: pci.4,v 1.47 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: pci.4,v 1.29 2000/04/01 00:32:23 tsarna Exp $ .\" .\" Copyright (c) 2000 Theo de Raadt. All rights reserved. @@ -71,7 +71,8 @@ for additional information. Note that interrupt mappings on the i386 may require that you configure your BIOS to reserve sufficient interrupts as "PCI/ISAPnP" so that there are sufficient interrupts remaining to configure the discovered PCI -devices. For more information, see +devices. +For more information, see .Xr pcibios 4 . .Sh SUPPORTED DEVICES The system includes machine-independent @@ -117,7 +118,8 @@ Adaptec "FSA" family (Adaptec AAC, Dell PERC, HP NetRaid) .Tn RAID controllers. .It Xr ami 4 -American Megatrends Inc. MegaRAID family +American Megatrends Inc. +MegaRAID family .Tn RAID controllers. .It Xr cac 4 @@ -174,7 +176,8 @@ instances on the .Tn PCI bus on the other side of the bridge. .It Xr en 4 -Midway-based Efficient Networks Inc. and Adaptec ATM interfaces. +Midway-based Efficient Networks Inc. +and Adaptec ATM interfaces. .It Xr ep 4 3Com 3c590 and 3c595 Ethernet interfaces. .It Xr fpa 4 @@ -314,7 +317,8 @@ kernel option, the following .Xr ioctl 2 calls are supported by the .Nm -driver. They are defined in the header file +driver. +They are defined in the header file .Aq Pa sys/pciio.h . .Bl -tag -width 012345678901234 .Pp @@ -325,7 +329,8 @@ reads the .Tn PCI configuration registers specified by the passed-in .Va pci_io -structure. The +structure. +The .Va pci_io structure consists of the following fields: .Bl -tag -width pi_width @@ -339,9 +344,9 @@ The .Tn PCI configuration register the user would like to access. .It pi_width -The width, in bytes, of the data the user would like to read. This value -may be either 1, 2, or 4. 3-byte reads and reads larger than 4 bytes are -not supported. +The width, in bytes, of the data the user would like to read. +This value may be either 1, 2, or 4. 3-byte reads and reads larger than +4 bytes are not supported. .It pi_data The data returned by the kernel. .El @@ -352,9 +357,11 @@ allows users to write to the .Tn PCI specified in the passed-in .Va pci_io -structure. The +structure. +The .Va pci_io -structure is described above. The limitations on data width described for +structure is described above. +The limitations on data width described for reading registers, above, also apply to writing .Tn PCI configuration registers. diff --git a/share/man/man4/pciide.4 b/share/man/man4/pciide.4 index 96e53ffa95d..db5ccc2e93c 100644 --- a/share/man/man4/pciide.4 +++ b/share/man/man4/pciide.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pciide.4,v 1.17 2001/09/29 02:58:29 jason Exp $ +.\" $OpenBSD: pciide.4,v 1.18 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: pciide.4,v 1.8 1999/03/16 01:19:17 garbled Exp $ .\" .\" Copyright (c) 1998 Manuel Bouyer. @@ -49,7 +49,8 @@ functions for the .Xr wd 4 and .Xr atapiscsi 4 -drivers. This driver includes specific, enhanced support for the CMD Tech +drivers. +This driver includes specific, enhanced support for the CMD Tech PCI0640 controller and IDE DMA/UltraDMA support for the following PCI IDE controllers: .Pp @@ -129,11 +130,14 @@ ones using faster UltraDMA modes, because it will decrease electrical noise and increase data reliability. .Pp The AMD756 chip revision D2 has a bug affecting DMA (but not Ultra-DMA) -modes. The workaround documented by AMD is to not use DMA on any drive which -does not support Ultra-DMA modes. This does not appear to be necessary on all -drives, the PCIIDE_AMD756_ENABLEDMA option can be used to force multiword DMA -on the buggy revisions. Multiword DMA can eventually be disabled on a -per-drive basis with config flags, see +modes. +The workaround documented by AMD is to not use DMA on any drive which +does not support Ultra-DMA modes. +This does not appear to be necessary on all drives, the +PCIIDE_AMD756_ENABLEDMA option can be used to force multiword DMA +on the buggy revisions. +Multiword DMA can eventually be disabled on a per-drive basis with config +flags, see .Xr wd 4 . The bug, if triggered, will cause a total system hang. .Pp diff --git a/share/man/man4/pcmcia.4 b/share/man/man4/pcmcia.4 index 09167d8df98..692981c3499 100644 --- a/share/man/man4/pcmcia.4 +++ b/share/man/man4/pcmcia.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pcmcia.4,v 1.19 2001/10/04 16:56:51 mpech Exp $ +.\" $OpenBSD: pcmcia.4,v 1.20 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: pcmcia.4,v 1.4 1998/06/07 09:10:30 enami Exp $ .\" .\" Copyright (c) 1997 The NetBSD Foundation, Inc. @@ -92,7 +92,8 @@ Adaptec APA-14[56]0 and NewMedia BusToaster SCSI controller cards. .Bl -tag -width speaker -offset ind -compact .It Xr wdc 4 Devices which implement an ATA/IDE interface, such as mini disk drives, -CDROMS. This includes Compact Flash cards which emulate a disk drive. +CDROMS. +This includes Compact Flash cards which emulate a disk drive. .El .Pp The supported PCMCIA controllers are those that are i82365 compatible. diff --git a/share/man/man4/pf.4 b/share/man/man4/pf.4 index 1edbd9a21e3..c4a51d6f1d8 100644 --- a/share/man/man4/pf.4 +++ b/share/man/man4/pf.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pf.4,v 1.6 2001/09/15 03:54:40 frantzen Exp $ +.\" $OpenBSD: pf.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (C) 2001, Kjell Wooding. All rights reserved. .\" @@ -78,7 +78,8 @@ obtained through preceding DIOCBEGINRULES call. .Va nr is ignored. .It Dv DIOCCOMMITRULES Fa "u_int32_t" -Switch inactive to active filter rule set. Requires +Switch inactive to active filter rule set. +Requires .Va ticket . .It Dv DIOCGETRULES Fa "struct pfioc_rule" diff --git a/share/man/man4/pms.4 b/share/man/man4/pms.4 index 40d8d64bedf..f35b32a1ea2 100644 --- a/share/man/man4/pms.4 +++ b/share/man/man4/pms.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pms.4,v 1.3 2001/06/26 02:09:10 pjanzen Exp $ +.\" $OpenBSD: pms.4,v 1.4 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: pms.4,v 1.4 2000/07/05 15:45:34 msaitoh Exp $ .\" .\" Copyright (c) 1993 Christopher G. Demetriou @@ -50,11 +50,13 @@ The .Nm drivers provide an interface to PS/2 auxiliary port mice within the .Xr wscons 4 -framework. Parent device in terms of the autoconfiguration framework is +framework. +Parent device in terms of the autoconfiguration framework is .Xr pckbc 4 , the PC keyboard controller. .Dq pms -is a generic driver which supports 2 coordinate axes and 3 buttons. The +is a generic driver which supports 2 coordinate axes and 3 buttons. +The .Dq pmsi variant provides specific support for wheel mice of the .Dq IntelliMouse diff --git a/share/man/man4/raid.4 b/share/man/man4/raid.4 index 184835f21c1..63b8dca340b 100644 --- a/share/man/man4/raid.4 +++ b/share/man/man4/raid.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: raid.4,v 1.15 2001/08/03 15:21:16 mpech Exp $ +.\" $OpenBSD: raid.4,v 1.16 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: raid.4,v 1.8 1999/12/15 22:07:33 abs Exp $ .\" .\" @@ -73,11 +73,11 @@ .Sh DESCRIPTION The .Nm -driver provides RAID 0, 1, 4, and 5 (and more!) capabilities. This -document assumes that the reader has at least some familiarity with RAID -and RAID concepts. The reader is also assumed to know how to configure -disks and pseudo-devices into kernels, how to generate kernels, and how -to partition disks. +driver provides RAID 0, 1, 4, and 5 (and more!) capabilities. +This document assumes that the reader has at least some familiarity with RAID +and RAID concepts. +The reader is also assumed to know how to configure disks and pseudo-devices +into kernels, how to generate kernels, and how to partition disks. .Pp RAIDframe provides a number of different RAID levels including: .Bl -tag -width indent @@ -95,19 +95,20 @@ distributed across all the components. .Pp There are a wide variety of other RAID levels supported by RAIDframe, including Even-Odd parity, RAID level 5 with rotated sparing, Chained -declustering, and Interleaved declustering. The reader is referred -to the RAIDframe documentation mentioned in the +declustering, and Interleaved declustering. +The reader is referred to the RAIDframe documentation mentioned in the .Sx HISTORY section for more detail on these various RAID configurations. .Pp Depending on the parity level configured, the device driver can -support the failure of component drives. The number of failures -allowed depends on the parity level selected. If the driver is able -to handle drive failures, and a drive does fail, then the system is -operating in "degraded mode". In this mode, all missing data must be -reconstructed from the data and parity present on the other -components. This results in much slower data accesses, but -does mean that a failure need not bring the system to a complete halt. +support the failure of component drives. +The number of failures allowed depends on the parity level selected. +If the driver is able to handle drive failures, and a drive does fail, +then the system is operating in "degraded mode". +In this mode, all missing data must be reconstructed from the data and +parity present on the other components. +This results in much slower data accesses, but does mean that a failure +need not bring the system to a complete halt. .Pp The RAID driver supports and enforces the use of .Sq component labels . @@ -122,8 +123,8 @@ respect to each other (e.g. two or more serial numbers do not match) or that the component label is not consistent with its assigned place in the set (e.g. the component label claims the component should be the 3rd one a 6-disk set, but the RAID set has it as the 3rd component -in a 5-disk set) then the device will fail to configure. If the -driver determines that exactly one component label seems to be +in a 5-disk set) then the device will fail to configure. +If the driver determines that exactly one component label seems to be incorrect, and the RAID set is being configured as a set that supports a single failure, then the RAID set will be allowed to configure, but the incorrectly labeled component will be marked as @@ -135,14 +136,15 @@ will configure normally. The driver supports .Sq hot spares , disks which are on-line, but are not -actively used in an existing filesystem. Should a disk fail, the -driver is capable of reconstructing the failed disk onto a hot spare -or back onto a replacement drive. +actively used in an existing filesystem. +Should a disk fail, the driver is capable of reconstructing the failed disk +onto a hot spare or back onto a replacement drive. If the components are hot swapable, the failed disk can then be removed, a new disk put in its place, and a copyback operation -performed. The copyback operation, as its name indicates, will copy -the reconstructed data from the hot spare to the previously failed -(and now replaced) disk. Hot spares can also be hot-added using +performed. +The copyback operation, as its name indicates, will copy the reconstructed +data from the hot spare to the previously failed (and now replaced) disk. +Hot spares can also be hot-added using .Xr raidctl 8 . .Pp If a component cannot be detected when the RAID device is configured, @@ -159,25 +161,27 @@ must be used with the .Fl i option to re-write the data when either a) a new RAID device is brought up for the first time or b) after an un-clean shutdown of a -RAID device. By performing this on-demand recomputation of all parity -before doing a +RAID device. +By performing this on-demand recomputation of all parity before doing a .Xr fsck 8 or a .Xr newfs 8 -filesystem integrity and parity integrity can be ensured. It bears -repeating again that parity recomputation is +filesystem integrity and parity integrity can be ensured. +It bears repeating again that parity recomputation is .Em required -before any filesystems are created or used on the RAID device. If the -parity is not correct, then missing data cannot be correctly recovered. +before any filesystems are created or used on the RAID device. +If the parity is not correct, then missing data cannot be correctly recovered. .Pp -RAID levels may be combined in a hierarchical fashion. For example, a RAID 0 -device can be constructed out of a number of RAID 5 devices (which, in turn, -may be constructed out of the physical disks, or of other RAID devices). +RAID levels may be combined in a hierarchical fashion. +For example, a RAID 0 device can be constructed out of a number of RAID 5 +devices (which, in turn, may be constructed out of the physical disks, or +of other RAID devices). .Pp It is important that drives be hard-coded at their respective addresses (i.e. not left free-floating, where a drive with SCSI ID of 4 can end up as /dev/sd0c) for well-behaved functioning of the RAID -device. For normal SCSI drives, for example, the following can be +device. +For normal SCSI drives, for example, the following can be used to fix the device addresses: .Bd -unfilled -offset indent sd0 at scsibus0 target 0 lun ? # SCSI disk drives @@ -191,42 +195,46 @@ sd6 at scsibus0 target 6 lun ? # SCSI disk drives .Pp See .Xr sd 4 -for more information. The rationale for fixing the device addresses -is as follows: Consider a system with three SCSI drives at SCSI IDs -4, 5, and 6, and which map to components /dev/sd0e, /dev/sd1e, and -/dev/sd2e of a RAID 5 set. If the drive with SCSI ID 5 fails, and the -system reboots, the old /dev/sd2e will show up as /dev/sd1e. The RAID -driver is able to detect that component positions have changed, and -will not allow normal configuration. If the device addresses are hard -coded, however, the RAID driver would detect that the middle component -is unavailable, and bring the RAID 5 set up in degraded mode. +for more information. +The rationale for fixing the device addresses is as follows: Consider a +system with three SCSI drives at SCSI IDs 4, 5, and 6, and which map to +components /dev/sd0e, /dev/sd1e, and /dev/sd2e of a RAID 5 set. +If the drive with SCSI ID 5 fails, and the system reboots, the old +/dev/sd2e will show up as /dev/sd1e. +The RAID driver is able to detect that component positions have changed, +and will not allow normal configuration. +If the device addresses are hard coded, however, the RAID driver would +detect that the middle component is unavailable, and bring the RAID 5 +set up in degraded mode. .Pp The first step to using the .Nm -driver is to ensure that it is suitably configured in the kernel. This is -done by adding a line similar to: +driver is to ensure that it is suitably configured in the kernel. +This is done by adding a line similar to: .Bd -unfilled -offset indent pseudo-device raid 4 # RAIDframe disk device .Ed .Pp -to the kernel configuration file. The +to the kernel configuration file. +The .Sq count argument .Pf ( Sq 4 , in this case), specifies the number of RAIDframe drivers to configure. At the time of this writing, 4 is the MAXIMUM of .Nm -devices which are supported. This will change as soon as kernel threads -are available. +devices which are supported. +This will change as soon as kernel threads are available. .Pp In all cases the .Sq raw partitions of the disks .Pa must not -be combined. Rather, each component partition should be offset by at least one -cylinder from the beginning of that component disk. This ensures that -the disklabels for the component disks do not conflict with the -disklabel for the +be combined. +Rather, each component partition should be offset by at least one cylinder +from the beginning of that component disk. +This ensures that the disklabels for the component disks do not conflict +with the disklabel for the .Nm device. As well, all component partitions must be of the type @@ -239,14 +247,14 @@ device is found in It is highly recommended that the steps to reconstruct, copyback, and re-compute parity are well understood by the system administrator(s) .Em before -a component failure. Doing the wrong thing when a component fails may -result in data loss. +a component failure. +Doing the wrong thing when a component fails may result in data loss. .Sh WARNINGS Certain RAID levels (1, 4, 5, 6, and others) can protect against some -data loss due to component failure. However the loss of two -components of a RAID 4 or 5 system, or the loss of a single component -of a RAID 0 system, will result in the entire filesystems on that RAID -device being lost. +data loss due to component failure. +However the loss of two components of a RAID 4 or 5 system, or the loss of +a single component of a RAID 0 system, will result in the entire +filesystems on that RAID device being lost. RAID is .Em not a substitute for good backup practices. @@ -254,12 +262,13 @@ a substitute for good backup practices. Recomputation of parity .Em must be performed whenever there is a chance that it may have been -compromised. This includes after system crashes, or before a RAID -device has been used for the first time. Failure to keep parity -correct will be catastrophic should a component ever fail -- it is -better to use RAID 0 and get the additional space and speed, than it -is to use parity, but not keep the parity correct. At least with RAID -0 there is no perception of increased data security. +compromised. +This includes after system crashes, or before a RAID device has been used for +the first time. +Failure to keep parity correct will be catastrophic should a component ever +fail -- it is better to use RAID 0 and get the additional space and speed, +than it is to use parity, but not keep the parity correct. +At least with RAID 0 there is no perception of increased data security. .Sh FILES .Bl -tag -width /dev/XXrXraidX -compact .It Pa /dev/{,r}raid* @@ -281,16 +290,18 @@ driver in .Ox is a port of RAIDframe, a framework for rapid prototyping of RAID structures developed by the folks at the Parallel Data Laboratory at -Carnegie Mellon University (CMU). RAIDframe, as originally distributed -by CMU, provides a RAID simulator for a number of different -architectures, and a user-level device driver and a kernel device -driver for Digital Unix. The +Carnegie Mellon University (CMU). +RAIDframe, as originally distributed by CMU, provides a RAID simulator +for a number of different architectures, and a user-level device driver +and a kernel device driver for Digital Unix. +The .Nm driver is a kernelized version of RAIDframe v1.1. .Pp A more complete description of the internals and functionality of RAIDframe is found in the paper "RAIDframe: A Rapid Prototyping Tool -for RAID Systems", by William V. Courtright II, Garth Gibson, Mark +for RAID Systems", by William V. +Courtright II, Garth Gibson, Mark Holland, LeAnn Neal Reilly, and Jim Zelenka, and published by the Parallel Data Laboratory of Carnegie Mellon University. The @@ -301,7 +312,6 @@ from where it was ported to .Ox 2.5 . .Sh COPYRIGHT .Bd -unfilled - The RAIDframe Copyright is as follows: Copyright (c) 1994-1996 Carnegie-Mellon University. @@ -326,5 +336,4 @@ Carnegie Mellon requests users of this software to return to any improvements or extensions that they make and grant Carnegie the rights to redistribute these changes. - .Ed diff --git a/share/man/man4/random.4 b/share/man/man4/random.4 index ba447bcdfb1..a5d1236c83b 100644 --- a/share/man/man4/random.4 +++ b/share/man/man4/random.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: random.4,v 1.12 2001/06/22 12:15:46 mpech Exp $ +.\" $OpenBSD: random.4,v 1.13 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1996, 1997 Michael Shalayeff .\" @@ -55,7 +55,8 @@ hash or message digest functions to generate the output. This device is reserved for future support of hardware random generators. .It /dev/srandom -Strong random data. This device returns reliable random data. +Strong random data. +This device returns reliable random data. If sufficient entropy is not currently available (i.e., the entropy pool quality starts to run low), the driver pauses while more of such data is collected. @@ -96,6 +97,7 @@ No randomness testing suite provided. .Sh HISTORY A .Nm -device first appeared in Linux operating system. This is a cloned interface. +device first appeared in Linux operating system. +This is a cloned interface. .Pp ARC4 routines added by David Mazieres. diff --git a/share/man/man4/rl.4 b/share/man/man4/rl.4 index ca9dbb55058..1d6ec8bd6d3 100644 --- a/share/man/man4/rl.4 +++ b/share/man/man4/rl.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rl.4,v 1.11 2001/03/08 06:18:34 aaron Exp $ +.\" $OpenBSD: rl.4,v 1.12 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1997, 1998 .\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved. @@ -45,24 +45,28 @@ The .Nm driver provides support for PCI Ethernet adapters and embedded controllers based on the RealTek 8129 and 8139 Fast Ethernet controller -chips. This includes the Allied Telesyn AT2550, Genius GF100TXR, +chips. +This includes the Allied Telesyn AT2550, Genius GF100TXR, NDC Communications NE100TX-E, OvisLink LEF-8129TX, OvisLink LEF-8139TX, -Netronix Inc. EA-1210 NetEther 10/100, KTX-9130TX 10/100 Fast Ethernet, +Netronix Inc. +EA-1210 NetEther 10/100, KTX-9130TX 10/100 Fast Ethernet, Encore ENL832-TX 10/100 M PCI, Longshine LCS-8038TX-R, the SMC EZ Card 10/100 PCI 1211-TX, and various other cheap adapters. .Pp The RealTek controllers use bus master DMA but do not use a -descriptor-based data transfer mechanism. The receiver uses a -single fixed size ring buffer from which packets must be copied -into mbufs. For transmission, there are only four outbound packet +descriptor-based data transfer mechanism. +The receiver uses a single fixed size ring buffer from which packets must be +copied into mbufs. +For transmission, there are only four outbound packet address registers which require all outgoing packets to be stored -as contiguous buffers. Furthermore, outbound packet buffers must -be longword aligned or else transmission will fail. +as contiguous buffers. +Furthermore, outbound packet buffers must be longword aligned or else +transmission will fail. .Pp The 8129 differs from the 8139 in that the 8139 has an internal PHY which is controlled through special direct access registers -whereas the 8129 uses an external PHY via an MII bus. The 8139 -supports both 10 and 100Mbps speeds in either full or half duplex. +whereas the 8129 uses an external PHY via an MII bus. +The 8139 supports both 10 and 100Mbps speeds in either full or half duplex. The 8129 can support the same speeds and modes given an appropriate PHY chip. .Pp @@ -72,14 +76,16 @@ driver supports the following media types: .Pp .Bl -tag -width xxxxxxxxxxxxxxxxxxxx .It autoselect -Enable autoselection of the media type and options. This is only -supported if the PHY chip attached to the RealTek controller -supports NWAY autonegotiation. The user can manually override -the autoselected mode by adding media options to the appropriate +Enable autoselection of the media type and options. +This is only supported if the PHY chip attached to the RealTek controller +supports NWAY autonegotiation. +The user can manually override the autoselected mode by adding media options +to the appropriate .Pa /etc/hostname.rlX file. .It 10baseT/UTP -Set 10Mbps operation. The +Set 10Mbps operation. +The .Ar mediaopt option can also be used to select either .Ar full-duplex @@ -87,7 +93,8 @@ or .Ar half-duplex modes. .It 100baseTX -Set 100Mbps (Fast Ethernet) operation. The +Set 100Mbps (Fast Ethernet) operation. +The .Ar mediaopt option can also be used to select either .Ar full-duplex @@ -127,20 +134,23 @@ The driver failed to allocate an mbuf for the transmitter ring when allocating a pad buffer or collapsing an mbuf chain into a cluster. .It "rl%d: chip is in D3 power state -- setting to D0" This message applies only to adapters which support power -management. Some operating systems place the controller in low power +management. +Some operating systems place the controller in low power mode when shutting down, and some PCI BIOSes fail to bring the chip -out of this state before configuring it. The controller loses all of -its PCI configuration in the D3 state, so if the BIOS does not set -it back to full power mode in time, it won't be able to configure it -correctly. The driver tries to detect this condition and bring -the adapter back to the D0 (full power) state, but this may not be -enough to return the driver to a fully operational condition. If -you see this message at boot time and the driver fails to attach +out of this state before configuring it. +The controller loses all of its PCI configuration in the D3 state, so if +the BIOS does not set it back to full power mode in time, it won't be able +to configure it correctly. +The driver tries to detect this condition and bring the adapter back to the D0 +(full power) state, but this may not be enough to return the driver to a fully +operational condition. +If you see this message at boot time and the driver fails to attach the device as a network interface, you will have to perform second warm boot to have the device properly configured. .Pp Note that this condition only occurs when warm booting from another -operating system. If you power down your system prior to booting +operating system. +If you power down your system prior to booting .Ox , the card should be configured correctly. .El @@ -168,20 +178,25 @@ driver was written by .Sh BUGS Since outbound packets must be longword aligned, the transmit routine has to copy an unaligned packet into an mbuf cluster buffer -before transmission. The driver abuses the fact that the cluster buffer +before transmission. +The driver abuses the fact that the cluster buffer pool is allocated at system startup time in a contiguous region starting -at a page boundary. Since cluster buffers are 2048 bytes, they are -longword aligned by definition. The driver probably should not be +at a page boundary. +Since cluster buffers are 2048 bytes, they are +longword aligned by definition. +The driver probably should not be depending on this characteristic. .Pp The RealTek data sheets are of especially poor quality: the grammar and spelling are awful and there is a lot of information missing, -particularly concerning the receiver operation. One particularly -important fact that the data sheets fail to mention relates to the -way in which the chip fills in the receive buffer. When an interrupt -is posted to signal that a frame has been received, it is possible that -another frame might be in the process of being copied into the receive -buffer while the driver is busy handling the first one. If the driver +particularly concerning the receiver operation. +One particularly important fact that the data sheets fail to mention +relates to the way in which the chip fills in the receive buffer. +When an interrupt is posted to signal that a frame has been received, +it is possible that another frame might be in the process of being +copied into the receive buffer while the driver is busy handling +the first one. +If the driver manages to finish processing the first frame before the chip is done DMAing the rest of the next frame, the driver may attempt to process the next frame in the buffer before the chip has had a chance to finish @@ -189,7 +204,8 @@ DMAing all of it. .Pp The driver can check for an incomplete frame by inspecting the frame length in the header preceding the actual packet data: an incomplete -frame will have the magic length of 0xFFF0. When the driver encounters -this value, it knows that it has finished processing all currently -available packets. Neither this magic value nor its significance are +frame will have the magic length of 0xFFF0. +When the driver encounters this value, it knows that it has finished +processing all currently available packets. +Neither this magic value nor its significance are documented anywhere in the RealTek data sheets. diff --git a/share/man/man4/rln.4 b/share/man/man4/rln.4 index 224d64b8c27..70dc690dc9d 100644 --- a/share/man/man4/rln.4 +++ b/share/man/man4/rln.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rln.4,v 1.12 2001/09/06 15:04:34 mpech Exp $ +.\" $OpenBSD: rln.4,v 1.13 2001/10/05 14:45:53 mpech Exp $ .\" .Dd 2 April, 1999 .Dt RLN 4 @@ -42,7 +42,8 @@ the newer 802.11 cards in general. The RangeLAN2 cards communicate using an Ethernet-like protocol over the 2.4\(em2.483GHz part of the spectrum. This frequency happens to co-incide with that of strong harmonics emitted -by common consumer microwave ovens. You can guess the rest. +by common consumer microwave ovens. +You can guess the rest. Depending on the channel condition, the NICs operate in one of two modes: 1.6Mb/s or 0.8Mb/s signalling rate. .\" .Sh CONFIGURATION @@ -70,14 +71,16 @@ The medium used by the device is always air. .Sh DIAGNOSTICS .Bl -diag .It "rln0: hardware fault" -The card reported a hardware fault condition. Check the antenna. +The card reported a hardware fault condition. +Check the antenna. The interface is automatically marked down. .It "rln0: synchronised to ? (?) channel ?/?" The card has successfully synchronised with a nearby unit. Packets are only transmitted when the unit has synchronisation with another. .It "rln0: lost sync" -Synchronisation was lost. Check for microwave ovens being used. +Synchronisation was lost. +Check for microwave ovens being used. .It "rln0: nothing to sync to; now master" The card was unsuccessful in (re-)synchronising with any other unit, and was configured as an alternate master. @@ -86,12 +89,13 @@ The card generate a message bigger than the maximum size allowable for Ethernet. .It "rln0: command error 0x?? command ??" The card reported an error condition in the host-card protocol. .It "rln0: reset timeout" -An attempt to hard reset the card failed. This is either a serious hardware -fault, or a bus conflict. +An attempt to hard reset the card failed. +This is either a serious hardware fault, or a bus conflict. .It "rln0: tx_request timed out, status 0x??" -The host-to-card message transfer protocol timed out. This could mean -a duplex transfer is in progress and the interrupt service routine has not -run. Check the cpu load. +The host-to-card message transfer protocol timed out. +This could mean a duplex transfer is in progress and the interrupt service +routine has not run. +Check the cpu load. .It "rln0: lost message ?? seq ?" An expected response to the command did not appear within a reasonable time. .It "rln0: unknown RangeLAN2 wireless network card" diff --git a/share/man/man4/route.4 b/share/man/man4/route.4 index 6bf57241c1f..50f51eec09e 100644 --- a/share/man/man4/route.4 +++ b/share/man/man4/route.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: route.4,v 1.7 2001/03/01 16:11:19 aaron Exp $ +.\" $OpenBSD: route.4,v 1.8 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: route.4,v 1.3 1994/11/30 16:22:31 jtc Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 @@ -79,11 +79,11 @@ Normally the protocol specifies the route through each interface as a .Dq direct connection to the destination host -or network. If the route is direct, the transport layer of -a protocol family usually requests the packet be sent to the -same host specified in the packet. Otherwise, the interface -is requested to address the packet to the gateway listed in the routing entry -(i.e. the packet is forwarded). +or network. +If the route is direct, the transport layer of a protocol family usually +requests the packet be sent to the same host specified in the packet. +Otherwise, the interface is requested to address the packet to the gateway +listed in the routing entry (i.e., the packet is forwarded). .Pp When routing a packet, the kernel will attempt to find @@ -100,9 +100,9 @@ A wildcard routing entry is specified with a zero destination address value, and a mask of all zeroes. Wildcard routes will be used when the system fails to find other routes matching the -destination. The combination of wildcard -routes and routing redirects can provide an economical -mechanism for routing traffic. +destination. +The combination of wildcard routes and routing redirects can provide +an economical mechanism for routing traffic. .Pp One opens the channel for passing routing control messages by using the socket call shown in the synopsis above: @@ -131,10 +131,11 @@ bit mask within the header, and the sequence is least significant to most significant bit within the vector. .Pp Any messages sent to the kernel are returned, and copies are sent -to all interested listeners. The kernel will provide the process -id. for the sender, and the sender may use an additional sequence -field to distinguish between outstanding messages. However, -message replies may be lost when kernel buffers are exhausted. +to all interested listeners. +The kernel will provide the process id. +for the sender, and the sender may use an additional sequence +field to distinguish between outstanding messages. +However, message replies may be lost when kernel buffers are exhausted. .Pp The kernel may reject certain messages, and will indicate this by filling in the diff --git a/share/man/man4/rtfps.4 b/share/man/man4/rtfps.4 index ea2e2add3d5..6668aa78232 100644 --- a/share/man/man4/rtfps.4 +++ b/share/man/man4/rtfps.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rtfps.4,v 1.4 2001/06/22 12:15:46 mpech Exp $ +.\" $OpenBSD: rtfps.4,v 1.5 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1990, 1991 The Regents of the University of California. .\" All rights reserved. @@ -62,7 +62,8 @@ Each .Nm device is the master device for up to four .Nm com -devices. The kernel configuration specifies these +devices. +The kernel configuration specifies these .Nm com devices as slave devices of the .Nm @@ -89,11 +90,11 @@ driver. .Sh BUGS The .Nm -driver is unlikely to work on non-EISA and non-PCI machines. The ISA -bus only asserts 10 I/O address lines, and this is not enough. +driver is unlikely to work on non-EISA and non-PCI machines. +The ISA bus only asserts 10 I/O address lines, and this is not enough. .Pp Even on EISA and PCI machines, some address conflicts have been observed. On one machine, the second port always conflicted with something (though -it's not clear what) and caused strange results. Disabling the second -port in the kernel config allowed the other three ports to function -correctly. +it's not clear what) and caused strange results. +Disabling the second port in the kernel config allowed the other three +ports to function correctly. diff --git a/share/man/man4/scsi.4 b/share/man/man4/scsi.4 index 47d7bf5fa64..bdd03b2b1d9 100644 --- a/share/man/man4/scsi.4 +++ b/share/man/man4/scsi.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: scsi.4,v 1.9 2001/06/26 02:09:10 pjanzen Exp $ +.\" $OpenBSD: scsi.4,v 1.10 2001/10/05 14:45:53 mpech Exp $ .\" .Dd August 4, 1996 .Dt SCSI 4 @@ -21,10 +21,12 @@ The .Em scsi system provides a uniform and modular system for the implementation of drivers to control various scsi devices, and to utilize different -scsi host adapters through host adapter drivers. When the system probes the +scsi host adapters through host adapter drivers. +When the system probes the .Em SCSI busses, it attaches any devices it finds to the appropriate -drivers. If no driver seems appropriate, then it attaches the device to the +drivers. +If no driver seems appropriate, then it attaches the device to the uk (unknown) driver so that user level scsi ioctls may still be performed against the device. .Sh KERNEL CONFIGURATION @@ -61,73 +63,85 @@ which assigns scsibus 1 to the second bus probed on the ahc1 device. .Pp When you have a mixture of wired down and counted devices then the counting begins with the first non-wired down unit for a particular -type. That is, if you have a disk wired down as +type. +That is, if you have a disk wired down as .Em "disk sd1 at scsibus? target ? lun ?" , then the first non-wired disk shall come on line as .Em sd2 . .Sh IOCTLS There are a number of ioctls that work on any .Em SCSI -device. They are defined in +device. +They are defined in .Em sys/scsiio.h and can be applied against any scsi device that permits them. For the tape, it must be applied against the control -device. See the manual page for each device type for more information about +device. +See the manual page for each device type for more information about how generic scsi ioctls may be applied to a specific device. .Bl -tag -width DIOCSDINFO____ .It Dv SCIOCRESET* reset a device. .It Dv SCIOCDEBUG -Turn on debugging.. All scsi operations originating from this device's driver -will be traced to the console, along with other information. Debugging is -controlled by four bits, described in the header file. If no debugging is -configured into the kernel, debugging will have no effect. +Turn on debugging. +All scsi operations originating from this device's driver +will be traced to the console, along with other information. +Debugging is controlled by four bits, described in the header file. +If no debugging is configured into the kernel, debugging will have +no effect. .Em SCSI debugging is controlled by the configuration option .Em SCSIDEBUG. .It Dv SCIOCCOMMAND Take a scsi command and data from a user process and apply them to the scsi -device. Return all status information and return data to the process. The -ioctl will return a successful status even if the device rejected the -command. As all status is returned to the user, it is up to the user +device. +Return all status information and return data to the process. +The ioctl will return a successful status even if the device rejected the +command. +As all status is returned to the user, it is up to the user process to examine this information to decide the success of the command. .It Dv SCIOCREPROBE -Ask the system to probe the scsi busses for any new devices. If it finds -any, they will be attached to the appropriate drivers. The search can be -narrowed to a specific bus, target or lun. The new device may or may not -be related to the device on which the ioctl was performed. +Ask the system to probe the scsi busses for any new devices. +If it finds any, they will be attached to the appropriate drivers. +The search can be narrowed to a specific bus, target or lun. +The new device may or may not be related to the device on which +the ioctl was performed. .It Dv SCIOCIDENTIFY -Ask the driver what its bus, target and lun are. In addition, the device -type, ATAPI or SCSI, is returned. +Ask the driver what its bus, target and lun are. +In addition, the device type, ATAPI or SCSI, is returned. .It Dv SCIOCDECONFIG -Ask the device to disappear. This may not happen if the device is in use. +Ask the device to disappear. +This may not happen if the device is in use. .El .Sh NOTES The generic scsi part of the system is still being mapped out. Watch this space for changes. .Pp A device by the name of su (scsi_user) -(e.g. su0-0-0) will map bus, target and lun to minor numbers. It has not -yet been decided whether this device will be able to open a device that is -already controlled by an explicit driver. +(e.g. su0-0-0) will map bus, target and lun to minor numbers. +It has not yet been decided whether this device will be able to open a device +that is already controlled by an explicit driver. .Sh ADAPTERS The system allows common device drivers to work through many different -types of adapters. The adapters take requests from the upper layers and do -all IO between the +types of adapters. +The adapters take requests from the upper layers and do all IO between the .Em SCSI -bus and the system. The maximum size of a transfer is governed by the -adapter. Most adapters can transfer 64KB in a single operation, and -many can transfer larger amounts. +bus and the system. +The maximum size of a transfer is governed by the adapter. +Most adapters can transfer 64KB in a single operation, and many can transfer +larger amounts. .Sh TARGET MODE Some adapters support .Em target mode in which the system is capable of operating as a device, responding to -operations initiated by another system. Target mode will be supported for -some adapters, but is not yet complete for this version of the scsi system. +operations initiated by another system. +Target mode will be supported for some adapters, but is not yet complete for +this version of the scsi system. .Sh DIAGNOSTICS When the kernel is compiled with option SCSIDEBUG, the SCIOCDEBUG ioctl can be used to enable various amounts of tracing information on any -specific device. Devices not being traced will not produce trace information. +specific device. +Devices not being traced will not produce trace information. The four bits that make up the debug level each control certain types of debugging information. .Bl -tag -width "Bit 0" diff --git a/share/man/man4/sd.4 b/share/man/man4/sd.4 index cd6ef808624..a29e085b8f2 100644 --- a/share/man/man4/sd.4 +++ b/share/man/man4/sd.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sd.4,v 1.6 2001/08/03 15:21:16 mpech Exp $ +.\" $OpenBSD: sd.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: sd.4,v 1.3 1996/10/20 23:15:23 explorer Exp $ .\" .\" Copyright (c) 1996 @@ -40,8 +40,8 @@ The .Nm driver provides support for a .Tn SCSI -disk. It allows the disk -to be divided up into a set of pseudo devices called +disk. +It allows the disk to be divided up into a set of pseudo devices called .Em partitions . In general the interfaces are similar to those described by .Xr wd 4 . @@ -67,7 +67,8 @@ When 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 Direct type devices will be attached to the .Nm @@ -110,7 +111,8 @@ driver. .\"respectively.) On many systems .Xr disklabel 8 -is used to partition the drive into filesystems. On some systems the +is used to partition the drive into filesystems. +On some systems the .Nx portion of the disk resides within a native partition, and another program is used to create the @@ -119,8 +121,8 @@ portion. .Pp For example, the i386 port uses .Xr fdisk 8 -to partition the disk into a BIOS level partition. This allows sharing -the disk with other operating systems. +to partition the disk into a BIOS level partition. +This allows sharing the disk with other operating systems. .\"If an uninitialized disk is opened, the slice table will be .\"initialized with a fictitious .\".Fx @@ -143,7 +145,8 @@ The following .Xr ioctl 2 calls apply to .Tn SCSI -disks as well as to other disks. They are defined in the header file +disks as well as to other disks. +They are defined in the header file .Aq Pa disklabel.h . .Pp .Bl -tag -width DIOCSDINFO @@ -154,13 +157,15 @@ disks as well as to other disks. They are defined in the header file .\"implemented. .It Dv DIOCGDINFO Read, from the kernel, the in-core copy of the disklabel for the -drive. This may be a fictitious disklabel if the drive has never +drive. +This may be a fictitious disklabel if the drive has never been initialized, in which case it will contain information read from the .Tn SCSI inquiry commands. .It Dv DIOCSDINFO -Give the driver a new disklabel to use. The driver +Give the driver a new disklabel to use. +The driver .Em will not write the new disklabel to the disk. @@ -168,13 +173,14 @@ disklabel to the disk. Enable or disable the driver's software write protect of the disklabel on the disk. .It Dv DIOCWDINFO -Give the driver a new disklabel to use. The driver +Give the driver a new disklabel to use. +The driver .Em will write the new disklabel to the disk. .It Dv DIOCLOCK Lock the media cartridge into the device, or unlock a cartridge previously -locked. Used to prevent user and software eject while the media is in -use. +locked. +Used to prevent user and software eject while the media is in use. .It Dv DIOCEJECT Eject the media cartridge from a removable device. .El @@ -192,12 +198,12 @@ driver, but only against the If a removable device is attached to the .Nm driver, then the act of changing the media will invalidate the -disklabel and information held within the kernel. To avoid -corruption, all accesses to the device will be discarded until there -are no more open file descriptors referencing the device. During this -period, all new open attempts will be rejected. When no more open -file descriptors reference the device, the first next open will load a -new set of parameters (including disklabel) for the drive. +disklabel and information held within the kernel. +To avoid corruption, all accesses to the device will be discarded until there +are no more open file descriptors referencing the device. +During this period, all new open attempts will be rejected. +When no more open file descriptors reference the device, the first next +open will load a new set of parameters (including disklabel) for the drive. .Sh FILES .Bl -tag -width /dev/rsdXXXXX -compact .It Pa /dev/sd Ns Ar u Ns Ar p diff --git a/share/man/man4/ses.4 b/share/man/man4/ses.4 index d4852248c9d..f3fc15e8cce 100644 --- a/share/man/man4/ses.4 +++ b/share/man/man4/ses.4 @@ -23,7 +23,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $OpenBSD: ses.4,v 1.6 2001/10/04 10:28:20 wilfried Exp $ +.\" $OpenBSD: ses.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" .Dd February 22, 2000 .Dt SES 4 @@ -110,5 +110,6 @@ The .Nm driver was written for the .Tn SCSI -subsystem by Matthew Jacob. This is the functional equivalent of a similar -driver available in Solaris, Release 7. +subsystem by Matthew Jacob. +This is the functional equivalent of a similar driver available in +Solaris, Release 7. diff --git a/share/man/man4/sf.4 b/share/man/man4/sf.4 index db09f732885..5cb3fa244ef 100644 --- a/share/man/man4/sf.4 +++ b/share/man/man4/sf.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sf.4,v 1.8 2000/10/18 02:38:23 aaron Exp $ +.\" $OpenBSD: sf.4,v 1.9 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1997, 1998, 1999 .\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved. @@ -44,8 +44,8 @@ The .Nm driver provides support for Adaptec Duralink Fast Ethernet adapters -based on the Adaptec AIC-6915 "Starfire" chipset. This includes the -following: +based on the Adaptec AIC-6915 "Starfire" chipset. +This includes the following: .Pp .Bl -bullet -offset indent -compact .It @@ -60,18 +60,18 @@ ANA-69011 32-bit single port 10/100baseTX ANA-62020 64-bit single port 100baseFX .El .Pp -The AIC-6915 is a bus master controller with an MII interface. It -supports high and low priority transmit and receive queues, TCP/IP +The AIC-6915 is a bus master controller with an MII interface. +It supports high and low priority transmit and receive queues, TCP/IP checksum offload, multiple DMA descriptor formats and both polling -and producer/consumer DMA models. The AIC-6915 receive filtering -options include a 16 entry perfect filter, a 512-bit hash table -for multicast addresses, a 512-bit hash table for priority address -matching and VLAN filtering. An external MII-compliant transceiver -is required for media interfacing. +and producer/consumer DMA models. +The AIC-6915 receive filtering options include a 16 entry perfect +filter, a 512-bit hash table for multicast addresses, a 512-bit hash +table for priority address matching and VLAN filtering. +An external MII-compliant transceiver is required for media interfacing. .Pp Multiport adapters consist of several AIC-6915 controllers connected -via a PCI to PCI bridge. Each controller is treated as a separate -interface by the +via a PCI to PCI bridge. +Each controller is treated as a separate interface by the .Nm driver. .Pp @@ -87,7 +87,8 @@ the autoselected mode by adding media options to the .Xr hostname.if 5 file. .It 10baseT/UTP -Set 10Mbps operation. The +Set 10Mbps operation. +The .Ar mediaopt option can also be used to select either .Ar full-duplex @@ -95,7 +96,8 @@ or .Ar half-duplex modes. .It 100baseTX -Set 100Mbps (Fast Ethernet) operation. The +Set 100Mbps (Fast Ethernet) operation. +The .Ar mediaopt option can also be used to select either .Ar full-duplex @@ -120,16 +122,16 @@ For more information on configuring this device, see .Sh DIAGNOSTICS .Bl -diag .It "sf%d: couldn't map memory" -A fatal initialization error has occurred. This may -happen if the PCI BIOS did not configure the device, which can occur when -the BIOS has been configured for a "Plug and Play" operating system. +A fatal initialization error has occurred. +This may happen if the PCI BIOS did not configure the device, which can occur +when the BIOS has been configured for a "Plug and Play" operating system. The "Plug and Play OS" setting in the BIOS should be set to "no" or "off" in order for PCI devices to work properly with .Ox . .It "sf%d: couldn't map ports" -A fatal initialization error has occurred. This may -happen if the PCI BIOS did not configure the device, which can occur when -the BIOS has been configured for a "Plug and Play" operating system. +A fatal initialization error has occurred. +This may happen if the PCI BIOS did not configure the device, which can occur +when the BIOS has been configured for a "Plug and Play" operating system. The "Plug and Play OS" setting in the BIOS should be set to "no" or "off" in order for PCI devices to work properly with .Ox . diff --git a/share/man/man4/sk.4 b/share/man/man4/sk.4 index 26e5ecc4e83..9c9848cabd9 100644 --- a/share/man/man4/sk.4 +++ b/share/man/man4/sk.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sk.4,v 1.12 2001/06/22 12:15:47 mpech Exp $ +.\" $OpenBSD: sk.4,v 1.13 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1997, 1998, 1999 .\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved. @@ -66,21 +66,24 @@ The SysKonnect adapters consist of two main components: the XaQti Corp. XMAC II Gigabit MAC (sk) and the SysKonnect GEnesis controller ASIC (skc). The XMAC provides the Gigabit MAC and PHY support while the GEnesis provides an interface to the PCI bus, DMA support, packet buffering -and arbitration. The GEnesis can control up to two XMACs simultaneously, +and arbitration. +The GEnesis can control up to two XMACs simultaneously, allowing dual-port NIC configurations. .Pp The .Nm driver configures dual port SysKonnect adapters such that each XMAC -is treated as a separate logical network interface. Both ports can -operate independently of each other and can be connected to separate -networks. The SysKonnect driver software currently only uses the -second port on dual port adapters for failover purposes: if the link +is treated as a separate logical network interface. +Both ports can operate independently of each other and can be connected +to separate networks. +The SysKonnect driver software currently only uses the second port on +dual port adapters for failover purposes: if the link on the primary port fails, the SysKonnect driver will automatically switch traffic onto the second port. .Pp The XaQti XMAC II supports full and half duplex operation with -autonegotiation. The XMAC also supports unlimited frame sizes. +autonegotiation. +The XMAC also supports unlimited frame sizes. Support for jumbo frames is provided via the interface MTU setting. Selecting an MTU larger than 1500 bytes with the .Xr ifconfig 8 @@ -122,8 +125,8 @@ A fatal initialization error has occurred. .It "sk%d: couldn't map interrupt" A fatal initialization error has occurred. .It "sk%d: failed to enable memory mapping!" -The driver failed to initialize PCI shared memory mapping. This might -happen if the card is not in a bus-master slot. +The driver failed to initialize PCI shared memory mapping. +This might happen if the card is not in a bus-master slot. .It "sk%d: no memory for jumbo buffers!" The driver failed to allocate memory for jumbo frames during initialization. diff --git a/share/man/man4/sl.4 b/share/man/man4/sl.4 index c0c710a4d23..c63b1553f86 100644 --- a/share/man/man4/sl.4 +++ b/share/man/man4/sl.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sl.4,v 1.6 2001/06/22 12:15:47 mpech Exp $ +.\" $OpenBSD: sl.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: sl.4,v 1.1 1996/08/10 21:26:14 explorer Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -48,7 +48,8 @@ The .Nm interface allows serial lines to be used as network interfaces using the .Em slip -protocol. The +protocol. +The .Nm sl interface can use Van Jacobson TCP header compression and ICMP filtering. .Sh DIAGNOSTICS diff --git a/share/man/man4/sm.4 b/share/man/man4/sm.4 index 122a95ac198..1380df7ea87 100644 --- a/share/man/man4/sm.4 +++ b/share/man/man4/sm.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sm.4,v 1.7 2000/10/18 02:38:23 aaron Exp $ +.\" $OpenBSD: sm.4,v 1.8 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: sm.4,v 1.3 1998/08/09 00:39:02 thorpej Exp $ .\" .\" Copyright (c) 1997 The NetBSD Foundation, Inc. @@ -71,7 +71,8 @@ or media type with .Xr ifconfig 8 's .Sq media -directive. To select UTP, select the +directive. +To select UTP, select the .Em 10baseT or .Em utp diff --git a/share/man/man4/spp.4 b/share/man/man4/spp.4 index 48ccf950ba2..574aa1f9b55 100644 --- a/share/man/man4/spp.4 +++ b/share/man/man4/spp.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: spp.4,v 1.6 2000/12/21 21:01:19 aaron Exp $ +.\" $OpenBSD: spp.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: spp.4,v 1.3 1994/11/30 16:22:33 jtc Exp $ .\" .\" Copyright (c) 1985, 1991, 1993 @@ -52,8 +52,8 @@ The .Tn SPP protocol provides a reliable, flow-controlled, two-way -transmission of data. It is a byte-stream protocol used to -support the +transmission of data. +It is a byte-stream protocol used to support the .Dv SOCK_STREAM abstraction. .Tn SPP @@ -68,7 +68,8 @@ protocol are either or .Dq passive . Active sockets initiate connections to passive -sockets. By default +sockets. +By default .Tn SPP sockets are created active; to create a passive socket the @@ -76,19 +77,20 @@ passive socket the system call must be used after binding the socket with the .Xr bind 2 -system call. Only +system call. +Only passive sockets may use the .Xr accept 2 -call to accept incoming connections. Only active sockets may -use the +call to accept incoming connections. +Only active sockets may use the .Xr connect 2 call to initiate connections. .Pp Passive sockets may .Dq underspecify their location to match -incoming connection requests from multiple networks. This -technique, termed +incoming connection requests from multiple networks. +This technique, termed .Dq wildcard addressing , allows a single server to provide service to clients on multiple networks. @@ -100,10 +102,10 @@ The port may still be specified at this time; if the port is not specified the system will assign one. Once a connection has been established the socket's address is -fixed by the peer entity's location. The address assigned to the -socket is the address associated with the network interface -through which packets are being transmitted and received. Normally -this address corresponds to the peer entity's network. +fixed by the peer entity's location. +The address assigned to the socket is the address associated with the network +interface through which packets are being transmitted and received. +Normally this address corresponds to the peer entity's network. .Pp If the .Dv SOCK_SEQPACKET @@ -131,7 +133,8 @@ fields. .Pp For either socket type, packets received with the Attention bit sent are interpreted as -out of band data. Data sent with +out of band data. +Data sent with .Dq send(..., ..., ..., Dv MSG_OOB ) cause the attention bit to be set. .Sh DIAGNOSTICS @@ -169,11 +172,11 @@ when set, this determines the data stream type and whether the end of message bit is to be set on every ensuing packet. .It Dv SO_MTU This specifies the maximum amount of user data in a single packet. -The default is 576 bytes - sizeof(struct spidp). This quantity -affects windowing \- increasing it without increasing the amount -of buffering in the socket will lower the number of unread packets -accepted. Anything larger than the default will not be forwarded -by a bona fide +The default is 576 bytes - sizeof(struct spidp). +This quantity affects windowing \- increasing it without increasing +the amount of buffering in the socket will lower the number of unread +packets accepted. +Anything larger than the default will not be forwarded by a bona fide .Tn XEROX product internetwork router. The data argument for the setsockopt call must be diff --git a/share/man/man4/sppp.4 b/share/man/man4/sppp.4 index 02aa8e457bc..366332c35e0 100644 --- a/share/man/man4/sppp.4 +++ b/share/man/man4/sppp.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sppp.4,v 1.5 2001/03/01 16:11:19 aaron Exp $ +.\" $OpenBSD: sppp.4,v 1.6 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1997 Joerg Wunsch .\" @@ -39,24 +39,27 @@ The network layer implements the state machine and the Link Control Protocol (LCP) of the .Em point to point protocol (PPP) -as described in RFC 1661. Note that this layer does not provide -network interfaces of its own, it is rather intended to be layered on +as described in RFC 1661. +Note that this layer does not provide network interfaces of its own, it is +rather intended to be layered on top of drivers providing a synchronous point-to-point connection that -wish to run a PPP stack over it. The corresponding network interfaces -have to be provided by these hardware drivers. +wish to run a PPP stack over it. +The corresponding network interfaces have to be provided by these hardware +drivers. .Pp The .Nm -layer provides three basic modes of operation. The default mode, -with no special flags to be set, is to create the PPP connection -(administrative +layer provides three basic modes of operation. +The default mode, with no special flags to be set, is to create the +PPP connection (administrative .Em Open event to the LCP layer) as soon as the interface is taken up with the .Xr ifconfig 8 -command. Taking the interface down again will terminate the LCP layer -and thus all other layers on top. The link will also terminate itself as -soon as no Network Control Protocol (NCP) is open anymore, indicating -that the lower layers are no longer needed. +command. +Taking the interface down again will terminate the LCP layer +and thus all other layers on top. +The link will also terminate itself as soon as no Network Control Protocol +(NCP) is open anymore, indicating that the lower layers are no longer needed. .Pp Setting the link-level flag .Em link0 @@ -64,7 +67,8 @@ with .Xr ifconfig 8 will cause the respective network interface to go into .Em passive -mode. This means, the administrative +mode. +This means, the administrative .Em Open event to the LCP layer will be delayed until after the lower layers signals an @@ -83,15 +87,16 @@ Finally, setting the flag .Em link1 will cause the interface to operate in .Em dial-on-demand -mode. This is also only useful if the lower layer supports the notion -of a carrier (like with an ISDN line). Upon configuring the -respective interface, it will delay the administrative +mode. +This is also only useful if the lower layer supports the notion +of a carrier (like with an ISDN line). +Upon configuring the respective interface, it will delay the administrative .Em Open event to the LCP layer until either an outbound network packet arrives, or until the lower layer signals an .Em Up -event, indicating an inbound connection. As with passive mode, receipt -of a +event, indicating an inbound connection. +As with passive mode, receipt of a .Em Down event (loss of carrier) will not automatically take the interface down, thus it remains available for further connections. @@ -107,40 +112,43 @@ exchanged as well as the option negotiation between both ends of the link will be logged at level .Dv LOG_DEBUG . This can be helpful to examine configuration problems during the first -attempts to set up a new configuration. Without this flag being set, -only the major phase transitions will be logged at level +attempts to set up a new configuration. +Without this flag being set, only the major phase transitions will be +logged at level .Dv LOG_INFO . .Pp It is possible to leave the local interface IP address open for -negotiation by setting it to 0.0.0.0. This requires that the remote -peer can correctly supply a value for it based on the identity of the -caller, or on the remote address supplied by this side. Due to the -way the IPCP option negotiation works, this address is being supplied -late during the negotiation, which might cause the remote peer to make -wrong assumptions. +negotiation by setting it to 0.0.0.0. +This requires that the remote peer can correctly supply a value for it +based on the identity of the caller, or on the remote address supplied +by this side. +Due to the way the IPCP option negotiation works, this address is being +supplied late during the negotiation, which might cause the remote peer +to make wrong assumptions. .Pp In a similar spirit the remote address can be set to the magical value 0.0.0.1 which means that we don't care what address the remote side will use, as long as it is not 0.0.0.0. -This is useful if your ISP has several dial-in -servers. You can of course +This is useful if your ISP has several dial-in servers. +You can of course .Ic route add something or other 0.0.0.1 and it will do exactly what you would want it to. .Pp The PAP and CHAP authentication protocols as described in RFC 1334, -and RFC 1994 resp., are also implemented. Their parameters are being -controlled by the +and RFC 1994 resp., are also implemented. +Their parameters are being controlled by the .Xr spppcontrol 8 utility. .Sh DIAGNOSTICS .Bl -diag .It <ifname><ifnum>: <proto> illegal <event> in state <statename> An event happened that should not happen for the current state -the respective control protocol is in. See RFC 1661 for a description -of the state automaton. +the respective control protocol is in. +See RFC 1661 for a description of the state automaton. .It <ifname><ifnum>: loopback The state automaton detected a line loopback (that is, it was talking -with itself). The interface will be temporarily disabled. +with itself). +The interface will be temporarily disabled. .It <ifname><ifnum>: up The LCP layer is running again, after a line loopback had previously been detected. @@ -185,7 +193,8 @@ was written in 1994 at Cronyx Ltd., Moscow by .Aq joerg_wunsch@uriah.heep.sax.de rewrote a large part in 1997 in order to fully implement the state machine as described in RFC 1661, so it -could also be used for dialup lines. He also wrote this man page. +could also be used for dialup lines. +He also wrote this man page. Serge later on wrote a basic implementation for PAP and CHAP, which served as the base for the current implementation, done again by .ie t J\(:org Wunsch. @@ -199,8 +208,8 @@ control protocol and .Xr ip 4 network protocol is supported. .Pp -Negotiation loop avoidance is not fully implemented. If the negotiation -doesn't converge, this can cause an endless loop. +Negotiation loop avoidance is not fully implemented. +If the negotiation doesn't converge, this can cause an endless loop. .Pp The various parameters that should be adjustable per RFC 1661 are currently hard-coded into the kernel, and should be made accessible diff --git a/share/man/man4/sqphy.4 b/share/man/man4/sqphy.4 index 319e0ea75ef..969f77ea077 100644 --- a/share/man/man4/sqphy.4 +++ b/share/man/man4/sqphy.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sqphy.4,v 1.5 2001/05/31 09:08:21 deraadt Exp $ +.\" $OpenBSD: sqphy.4,v 1.6 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: sqphy.4,v 1.1 1998/11/04 05:53:59 thorpej Exp $ .\" .\" Copyright (c) 1998 The NetBSD Foundation, Inc. @@ -47,8 +47,8 @@ .Sh DESCRIPTION The .Nm -driver supports the Seeq 80220/80221, 80223 and 84220 10/100 Ethernet PHYs. The -80223 is a 3.3 volt version of the 80221. +driver supports the Seeq 80220/80221, 80223 and 84220 10/100 Ethernet PHYs. +The 80223 is a 3.3 volt version of the 80221. These PHYs are found on a variety of high-performance Ethernet interfaces. .Sh SEE ALSO .Xr ifmedia 4 , diff --git a/share/man/man4/ss.4 b/share/man/man4/ss.4 index dbf8a9f9973..6e1bd3ed281 100644 --- a/share/man/man4/ss.4 +++ b/share/man/man4/ss.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ss.4,v 1.8 2001/06/22 12:15:47 mpech Exp $ +.\" $OpenBSD: ss.4,v 1.9 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1998 Kenneth Stailey and Ian Darwin .\" @@ -49,13 +49,14 @@ concerned with details of its particular command set. The list of supported scanners varies from time to time; at present it includes HP Scanner Control Language (SCL) SCSI processor type scanners: Scanjet IIp, IIc, IIcx, 4p and 5p (others will probably work -if the SCSI INQUIRY strings are added to the driver). Not recently -tested but worked in the past true SCSI scanners: Mustek 600CX and 1200CX -(these do not do SCSI disconnect-reconnect they will lock up the bus -during operation. You can use a second controller.) +if the SCSI INQUIRY strings are added to the driver). +Not recently tested but worked in the past true SCSI scanners: Mustek 600CX +and 1200CX (these do not do SCSI disconnect-reconnect they will lock up +the bus during operation. +You can use a second controller.) .Sh KERNEL CONFIGURATION -Obviously a SCSI host adapter must be present in the config file -before this device can be configured. +Obviously a SCSI host adapter must be present in the config file before this +device can be configured. .Pp If a count is given, that many .Nm @@ -102,13 +103,16 @@ software packages. .Pp Even when vendors produce compliant SCSI scanners there is much variation in what parameters actually work in a SCSI_SET_WINDOW -command. Back in March 1997 an attempt to deal with this via quirk -tables was started. There exists some code for Ultima AT3 and A6000C +command. +Back in March 1997 an attempt to deal with this via quirk +tables was started. +There exists some code for Ultima AT3 and A6000C Plus, Ricoh IS50, IS410, IBM 2456-001, UMAX UC630, and Fujitsu M3096Gm that use this approach but none of these scanners work yet. .Pp Provisional userland programs exist in the source tree in -src/usr.sbin/ssio. Eventually a program similar to +src/usr.sbin/ssio. +Eventually a program similar to .Nm chio or .Nm mt diff --git a/share/man/man4/ste.4 b/share/man/man4/ste.4 index 1eef419c595..d4ce70c3f81 100644 --- a/share/man/man4/ste.4 +++ b/share/man/man4/ste.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ste.4,v 1.8 2001/06/23 07:03:59 pjanzen Exp $ +.\" $OpenBSD: ste.4,v 1.9 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1997, 1998, 1999 .\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved. @@ -45,14 +45,16 @@ The .Nm driver provides support for PCI Ethernet adapters and embedded controllers based on the Sundance Technologies ST201 PCI fast -Ethernet controller chip. This includes the D-Link DFE-550TX. +Ethernet controller chip. +This includes the D-Link DFE-550TX. .Pp The Sundance ST201 uses bus master DMA and is designed to be a -3Com Etherlink XL work-alike. It uses the same DMA descriptor -structure and is very similar in operation, however its register -layout is different. The ST201 has a 64-bit multicast hash filter -and a single perfect filter entry for the station address. IT -supports both 10 and 100Mbps speeds in either full or half duplex +3Com Etherlink XL work-alike. +It uses the same DMA descriptor structure and is very similar in operation, +however its register layout is different. +The ST201 has a 64-bit multicast hash filter and a single perfect filter +entry for the station address. +IT supports both 10 and 100Mbps speeds in either full or half duplex using an MII transceiver. .Pp The @@ -67,7 +69,8 @@ the autoselected mode by adding media options to the .Xr hostname.if 5 file. .It 10baseT/UTP -Set 10Mbps operation. The +Set 10Mbps operation. +The .Ar mediaopt option can also be used to select either .Ar full-duplex @@ -75,7 +78,8 @@ or .Ar half-duplex modes. .It 100baseTX -Set 100Mbps (Fast Ethernet) operation. The +Set 100Mbps (Fast Ethernet) operation. +The .Ar mediaopt option can also be used to select either .Ar full-duplex @@ -113,20 +117,24 @@ The driver failed to allocate an mbuf for the transmitter ring when allocating a pad buffer or collapsing an mbuf chain into a cluster. .It "ste%d: chip is in D3 power state -- setting to D0" This message applies only to adapters which support power -management. Some operating systems place the controller in low power +management. +Some operating systems place the controller in low power mode when shutting down, and some PCI BIOSes fail to bring the chip -out of this state before configuring it. The controller loses all of +out of this state before configuring it. +The controller loses all of its PCI configuration in the D3 state, so if the BIOS does not set it back to full power mode in time, it won't be able to configure it -correctly. The driver tries to detect this condition and bring +correctly. +The driver tries to detect this condition and bring the adapter back to the D0 (full power) state, but this may not be -enough to return the driver to a fully operational condition. If -you see this message at boot time and the driver fails to attach +enough to return the driver to a fully operational condition. +If you see this message at boot time and the driver fails to attach the device as a network interface, you will have to perform second warm boot to have the device properly configured. .Pp Note that this condition only occurs when warm booting from another -operating system. If you power down your system prior to booting +operating system. +If you power down your system prior to booting .Ox , the card should be configured correctly. .El diff --git a/share/man/man4/strip.4 b/share/man/man4/strip.4 index c8a4cb374fe..72a9a692402 100644 --- a/share/man/man4/strip.4 +++ b/share/man/man4/strip.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: strip.4,v 1.12 2001/08/03 15:21:16 mpech Exp $ +.\" $OpenBSD: strip.4,v 1.13 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright 1996 The Board of Trustees of The Leland Stanford .\" Junior University. All Rights Reserved. @@ -48,9 +48,9 @@ The STRIP driver takes outbound network packets, encapsulates them using the Metricom "starmode" framing, and sends the packets out an RS-232 interface to a Metricom .Em Ricochet -radio. Packets arriving from the radio -via the serial link are decapsulated and then passed up to the local -host's networking stack. +radio. +Packets arriving from the radio via the serial link are decapsulated and then +passed up to the local host's networking stack. .Pp .Nm is an acronym for @@ -63,7 +63,8 @@ the .Nm driver is very much like the .Nm sl -SLIP pseudo-device driver. A +SLIP pseudo-device driver. +A .Nm device is attached to a tty line with .Xr slattach 8 . @@ -74,23 +75,26 @@ The major difference between the SLIP pseudo-device driver and the .Nm driver is that SLIP works only between two hosts over -a dedicated point-to-point connection. In contrast, +a dedicated point-to-point connection. +In contrast, .Nm sends packets to a frequency-hopping radio, which can address packets to any peer Metricom radio. rather than just to a single host at the -other end of a point-to-point line. Thus, one +other end of a point-to-point line. +Thus, one .Nm pseudo-device is usually sufficient for any kernel. .Pp In other respects, a .Nm interface is rather like an Ethernet interface. -Packets are individually addressed, and subsequent packets can -be sent independently to different MAC addresses. However, -the "Star-mode" framing and MAC addressing are not in any way -compatible with Ethernet. Broadcast or multicast to more than one radio is not -possible, due to the independent frequency-hopping operation of the radios. +Packets are individually addressed, and subsequent packets can +be sent independently to different MAC addresses. +However, the "Star-mode" framing and MAC addressing are not in any way +compatible with Ethernet. +Broadcast or multicast to more than one radio is not possible, due to the +independent frequency-hopping operation of the radios. The interface flags .Dv IFF_POINTOPOINT and @@ -107,12 +111,12 @@ an RS-232 serial line, using a proprietary packet framing scheme. This version .Nm driver maps IP addresses to Metricom radio addresses using -statically configured entries in the normal routing table. These entries -map IP addresses of peer radios to the MAC-level addresses. +statically configured entries in the normal routing table. +These entries map IP addresses of peer radios to the MAC-level addresses. The exact syntax of this mapping and an example are discussed below. The Internet Assigned Numbers Authority (IANA) has allocated an ARP -type code for use with STRIP. A future version of this driver will -support +type code for use with STRIP. +A future version of this driver will support .Xr arp 4 to obtain the IP address of reachable peer radios dynamically. .Sh ADDRESS CONFIGURATION @@ -121,8 +125,9 @@ the mapping from IP addresses to radio MAC addresses. The .Xr route 8 command should be used to bind a peer STRIP host's radio IP address -to the peer's link-level radio address. Radio addresses are encoded -using the hex equivalent of the radio's decimal ASCII address. +to the peer's link-level radio address. +Radio addresses are encoded using the hex equivalent of the radio's +decimal ASCII address. For example, the following route command will configure a routing entry to a radio with a MAC address of 1234-5678, and an IP address 10.11.12.13: @@ -138,16 +143,18 @@ should be clear. .Sh RADIO CONFIGURATION The Metricom radios can auto-baud at speeds up to 38.4k baud. At higher speeds -- 57600 or 115200 -- the radio cannot autobaud. -When running at high speeds, the radio's serial port should be +When running at high speeds, the radio's serial port should be manually configured to permanently run at the desired speed. Use a terminal emulator and the Hayes command .Em ATS304=115200 -to set the serial baudrate to the specified number (or 0 for autobaud). The command +to set the serial baudrate to the specified number (or 0 for autobaud). +The command .Em AT&w -will then save the current radio state in non-volatile memory. +will then save the current radio state in non-volatile memory. .Pp Metricom radios can operate in either "modem-emulation" mode -or in packet mode (Starmode). The +or in packet mode (Starmode). +The .Nm driver automatically detects if the radio has fallen out of starmode, and resets it back into starmode, if the baud rate was set correctly @@ -162,24 +169,25 @@ by .Xr slattach 8 , .Xr slip 8 .Sh BUGS -Currently is IP-only. Encapsulations for AppleTalk and ARP have been defined, +Currently is IP-only. +Encapsulations for AppleTalk and ARP have been defined, but are not yet implemented in this driver. .Pp .Nm has not been widely tested on a variety of lower-level tty drivers. .P The detection and resetting of radios that crash out of Starmode does -not always work in this version of the driver. One workaround -is to kill the +not always work in this version of the driver. +One workaround is to kill the .Xr slattach process, ifconfig the .Nm interface down, and then start a new slattach and rerun ifconfig. .Sh HISTORY .Nm -was originally developed for the Linux kernel by Stuart -Cheshire of Stanford's Operating Systems and Networking group, -as part of Mary Baker's MosquitoNet +was originally developed for the Linux kernel by Stuart +Cheshire of Stanford's Operating Systems and Networking group, +as part of Mary Baker's MosquitoNet .Sy http://mosquitonet.stanford.edu/mosquitonet.html project. This diff --git a/share/man/man4/sv.4 b/share/man/man4/sv.4 index 948216755af..fba405b774e 100644 --- a/share/man/man4/sv.4 +++ b/share/man/man4/sv.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: sv.4,v 1.9 2001/07/31 00:39:07 deraadt Exp $ +.\" $OpenBSD: sv.4,v 1.10 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1998 Constantine Paul Sapuntzakis .\" All rights reserved @@ -42,9 +42,10 @@ The .Nm driver provides support for S3 SonicVibes (S3-617) chipset-based -cards. Disabling the SRS 3-D spatial feature of the chip is -recommended for higher quality audio. This can be done in software -by issuing the +cards. +Disabling the SRS 3-D spatial feature of the chip is recommended for higher +quality audio. +This can be done in software by issuing the .Bd -literal -offset indent mixerctl -w outputs.spatial=off .Ed @@ -62,9 +63,11 @@ device driver appeared in .Ox 2.6 . .Sh BUGS The "FM" DAC, wavetable synth, and MIDI port are not -supported. Recording at a rate different from playback is supported by -the chip but not the driver. The mixer does not allow control of reverb, -digital loopback, or 3-D SRS features. The chip does not support exact -record speeds (it seems) of 11025hz, 22050hz, and so on, used by -Windows audio. Usually, the actual record is rate is around +/- 50hz of -the specified. +supported. +Recording at a rate different from playback is supported by +the chip but not the driver. +The mixer does not allow control of reverb, digital loopback, or 3-D SRS +features. +The chip does not support exact record speeds (it seems) of 11025hz, +22050hz, and so on, used by Windows audio. +Usually, the actual record is rate is around +/- 50hz of the specified. diff --git a/share/man/man4/tb.4 b/share/man/man4/tb.4 index a8d2b6a5361..7f188e9cb95 100644 --- a/share/man/man4/tb.4 +++ b/share/man/man4/tb.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tb.4,v 1.4 2000/12/21 21:01:20 aaron Exp $ +.\" $OpenBSD: tb.4,v 1.5 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: tb.4,v 1.3.6.1 1996/05/31 00:37:45 cgd Exp $ .\" .\" Copyright (c) 1986, 1991 Regents of the University of California. @@ -64,12 +64,13 @@ Y positions (in the device coordinate space), up-down status of the buttons or pen stylus, proximity information (when available), and a count of the number of samples received from the input device -since it was opened. In addition, devices such as the +since it was opened. +In addition, devices such as the .Tn GTCO append tilt and pressure information to the end of -the aforementioned structure. For the Polhemus 3-D digitizer -the structure read is completely different. Refer to the -include file for a complete description. +the aforementioned structure. +For the Polhemus 3-D digitizer the structure read is completely different. +Refer to the include file for a complete description. .Pp While in tablet mode, normal teletype input and output functions take place. Thus, if an 8 bit output data path is desired, it is necessary diff --git a/share/man/man4/tcp.4 b/share/man/man4/tcp.4 index cc03616f5d2..b73b28aa55a 100644 --- a/share/man/man4/tcp.4 +++ b/share/man/man4/tcp.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tcp.4,v 1.11 2000/12/21 21:01:20 aaron Exp $ +.\" $OpenBSD: tcp.4,v 1.12 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: tcp.4,v 1.3 1994/11/30 16:22:35 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -51,10 +51,11 @@ The .Tn TCP protocol provides a reliable, flow-controlled, two-way -transmission of data. It is a byte-stream protocol used to -support the +transmission of data. +It is a byte-stream protocol used to support the .Dv SOCK_STREAM -abstraction. TCP uses the standard +abstraction. +TCP uses the standard Internet address format and, in addition, provides a per-host collection of .Dq port addresses . @@ -69,7 +70,8 @@ Sockets utilizing the TCP protocol are either or .Dq passive . Active sockets initiate connections to passive -sockets. By default +sockets. +By default .Tn TCP sockets are created active; to create a passive socket the @@ -77,34 +79,36 @@ passive socket the system call must be used after binding the socket with the .Xr bind 2 -system call. Only -passive sockets may use the +system call. +Only passive sockets may use the .Xr accept 2 -call to accept incoming connections. Only active sockets may -use the +call to accept incoming connections. +Only active sockets may use the .Xr connect 2 call to initiate connections. .Pp Passive sockets may .Dq underspecify their location to match -incoming connection requests from multiple networks. This -technique, termed +incoming connection requests from multiple networks. +This technique, termed .Dq wildcard addressing , allows a single server to provide service to clients on multiple networks. To create a socket which listens on all networks, the Internet address .Dv INADDR_ANY -must be bound. The +must be bound. +The .Tn TCP port may still be specified at this time; if the port is not specified the system will assign one. Once a connection has been established the socket's address is -fixed by the peer entity's location. The address assigned to the -socket is the address associated with the network interface -through which packets are being transmitted and received. Normally -this address corresponds to the peer entity's network. +fixed by the peer entity's location. +The address assigned to the socket is the address associated with +the network interface through which packets are being transmitted +and received. +Normally this address corresponds to the peer entity's network. .Pp .Tn TCP supports several socket options which are set with @@ -130,10 +134,11 @@ provides a boolean option, .Aq Pa netinet/tcp.h , to defeat this algorithm. .It Cd TCP_MAXSEG -Set the maximum segment size for this connection. The maximum segment -size can only be lowered. +Set the maximum segment size for this connection. +The maximum segment size can only be lowered. .It Cd TCP_SACK_DISABLE -Do not use selective acknowledgements for this connection. See +Do not use selective acknowledgements for this connection. +See .Xr options 4 . .El .Pp diff --git a/share/man/man4/termios.4 b/share/man/man4/termios.4 index be8a21064c6..7032ba5c25b 100644 --- a/share/man/man4/termios.4 +++ b/share/man/man4/termios.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: termios.4,v 1.15 2001/08/20 05:57:55 mpech Exp $ +.\" $OpenBSD: termios.4,v 1.16 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: termios.4,v 1.5 1994/11/30 16:22:36 jtc Exp $ .\" .\" Copyright (c) 1991, 1992, 1993 @@ -47,8 +47,9 @@ This describes a general terminal line discipline that is supported on tty asynchronous communication ports. .Ss Opening a Terminal Device File When a terminal file is opened, it normally causes the process to wait -until a connection is established. For most hardware, the presence -of a connection is indicated by the assertion of the hardware +until a connection is established. +For most hardware, the presence of a connection is indicated by the assertion +of the hardware .Dv CARRIER line. If the termios structure associated with the terminal file has the .Dv CLOCAL @@ -70,45 +71,48 @@ an application's standard input, output, and error files. .Ss Job Control in a Nutshell Every process is associated with a particular process group and session. The grouping is hierarchical: every member of a particular process group is a -member of the same session. This structuring is used in managing groups -of related processes for purposes of +member of the same session. +This structuring is used in managing groups of related processes for purposes +of .\" .Gw "job control" ; .Em "job control" ; that is, the ability from the keyboard (or from program control) to simultaneously stop or restart a complex command (a command composed of one or more related -processes). The grouping into process groups allows delivering -of signals that stop or start the group as a whole, along with -arbitrating which process group has access to the single controlling -terminal. The grouping at a higher layer into sessions is to restrict +processes). +The grouping into process groups allows delivering of signals that stop or +start the group as a whole, along with arbitrating which process group has +access to the single controlling terminal. +The grouping at a higher layer into sessions is to restrict the job control related signals and system calls to within processes -resulting from a particular instance of a "login". Typically, a session -is created when a user logs in, and the login terminal is setup -to be the controlling terminal; all processes spawned from that +resulting from a particular instance of a "login". +Typically, a session is created when a user logs in, and the login terminal +is setup to be the controlling terminal; all processes spawned from that login shell are in the same session, and inherit the controlling terminal. A job control shell operating interactively (that is, reading commands from a terminal) normally groups related processes together by placing them into the -same process group. A set of processes in the same process group -is collectively referred to as a "job". When the foreground process -group of the terminal is the same as the process group of a particular -job, that job is said to be in the "foreground". When the process -group of the terminal is different than the process group of +same process group. +A set of processes in the same process group is collectively referred to as +a "job". +When the foreground process group of the terminal is the same as the process +group of a particular job, that job is said to be in the "foreground". +When the process group of the terminal is different than the process group of a job (but is still the controlling terminal), that job is said -to be in the "background". Normally the -shell reads a command and starts the job that implements that -command. If the command is to be started in the foreground (typical), it -sets the process group of the terminal to the process group -of the started job, waits for the job to complete, and then -sets the process group of the terminal back to its own process -group (it puts itself into the foreground). If the job is to -be started in the background (as denoted by the shell operator "&"), -it never changes the process group of the terminal and doesn't +to be in the "background". +Normally the shell reads a command and starts the job that implements that +command. +If the command is to be started in the foreground (typical), it sets the +process group of the terminal to the process group of the started job, waits +for the job to complete, and then sets the process group of the terminal +back to its own process group (it puts itself into the foreground). +If the job is to be started in the background (as denoted by the shell +operator "&"), it never changes the process group of the terminal and doesn't wait for the job to complete (that is, it immediately attempts to read the next -command). If the job is started in the foreground, the user may -type a key (usually +command). +If the job is started in the foreground, the user may type a key (usually .Ql \&^Z ) which generates the terminal stop signal .Pq Dv SIGTSTP @@ -120,33 +124,37 @@ and for placing stopped or background jobs into the foreground. .Ss Orphaned Process Groups An orphaned process group is a process group that has no process whose parent is in a different process group, yet is in the same -session. Conceptually it means a process group that doesn't have -a parent that could do anything if it were to be stopped. For example, -the initial login shell is typically in an orphaned process group. +session. +Conceptually it means a process group that doesn't have +a parent that could do anything if it were to be stopped. +For example, the initial login shell is typically in an orphaned +process group. Orphaned process groups are immune to keyboard generated stop signals and job control signals resulting from reads or writes to the controlling terminal. .Ss The Controlling Terminal -A terminal may belong to a process as its controlling terminal. Each -process of a session that has a controlling terminal has the same -controlling terminal. A terminal may be the controlling terminal for at -most one session. The controlling terminal for a session is allocated by -the session leader by issuing the +A terminal may belong to a process as its controlling terminal. +Each process of a session that has a controlling terminal has the same +controlling terminal. +A terminal may be the controlling terminal for at most one session. +The controlling terminal for a session is allocated by the session leader +by issuing the .Dv TIOCSCTTY -ioctl. A controlling terminal -is never acquired by merely opening a terminal device file. +ioctl. +A controlling terminal is never acquired by merely opening a terminal device +file. When a controlling terminal becomes associated with a session, its foreground process group is set to the process group of the session leader. .Pp The controlling terminal is inherited by a child process during a .Xr fork 2 -function call. A process relinquishes its controlling terminal when it -creates a new session with the +function call. +A process relinquishes its controlling terminal when it creates a new session +with the .Xr setsid 2 -function; other processes -remaining in the old session that had this terminal as their controlling -terminal continue to have it. +function; other processes remaining in the old session that had this terminal +as their controlling terminal continue to have it. A process does not relinquish its controlling terminal simply by closing all of its file descriptors associated with the controlling terminal if other processes continue to @@ -154,9 +162,10 @@ have it open. .Pp When a controlling process terminates, the controlling terminal is disassociated from the current session, allowing it to be acquired by a -new session leader. Subsequent access to the terminal by other processes -in the earlier session will be denied, with attempts to access the -terminal treated as if modem disconnect had been sensed. +new session leader. +Subsequent access to the terminal by other processes in the earlier session +will be denied, with attempts to access the terminal treated as if modem +disconnect had been sensed. .Ss Terminal Access Control If a process is in the foreground process group of its controlling terminal, read operations are allowed. @@ -167,7 +176,7 @@ causes a signal to be sent to the process's group unless one of the -following special cases apply: If the reading process is ignoring or +following special cases apply: If the reading process is ignoring or blocking the .Dv SIGTTIN signal, or if the process group of the reading process is orphaned, the @@ -177,7 +186,8 @@ returns -1 with set to .Er Dv EIO and no -signal is sent. The default action of the +signal is sent. +The default action of the .Dv SIGTTIN signal is to stop the process to which it is sent. @@ -196,7 +206,8 @@ is set and the process is ignoring or blocking the .Dv SIGTTOU signal, the process is allowed to write to the terminal and the .Dv SIGTTOU -signal is not sent. If +signal is not sent. +If .Dv TOSTOP is set, and the process group of the writing process is orphaned, and the writing process is not ignoring @@ -222,11 +233,13 @@ A terminal device associated with a terminal device file may operate in full-duplex mode, so that data may arrive even while output is occurring. Each terminal device file has associated with it an input queue, into which incoming data is stored by the system before being read by a -process. The system imposes a limit, +process. +The system imposes a limit, .Pf \&{ Dv MAX_INPUT Ns \&} , on the number of -bytes that may be stored in the input queue. The behavior of the system -when this limit is exceeded depends on the setting of the +bytes that may be stored in the input queue. +The behavior of the system when this limit is exceeded depends on the +setting of the .Dv IMAXBEL flag in the termios .Fa c_iflag . @@ -235,20 +248,21 @@ is sent an .Tn ASCII .Dv BEL character each time a character is received -while the input queue is full. Otherwise, the input queue is flushed -upon receiving the character. +while the input queue is full. +Otherwise, the input queue is flushed upon receiving the character. .Pp Two general kinds of input processing are available, determined by whether the terminal device file is in canonical mode or noncanonical -mode. Additionally, -input characters are processed according to the +mode. +Additionally, input characters are processed according to the .Fa c_iflag and .Fa c_lflag -fields. Such processing can include echoing, which -in general means transmitting input characters immediately back to the -terminal when they are received from the terminal. This is useful for -terminals that can operate in full-duplex mode. +fields. +Such processing can include echoing, which in general means transmitting +input characters immediately back to the terminal when they are received +from the terminal. +This is useful for terminals that can operate in full-duplex mode. .Pp The manner in which data is provided to a process reading from a terminal device file is dependent on whether the terminal device file is in @@ -263,15 +277,15 @@ or If the .Dv O_NONBLOCK flag is clear, then the read request is -blocked until data is available or a signal has been received. If the +blocked until data is available or a signal has been received. +If the .Dv O_NONBLOCK flag is set, then the read request is completed, without blocking, in one of three ways: .Bl -enum -offset indent .It If there is enough data available to satisfy the entire request, -and the read completes successfully the number of -bytes read is returned. +and the read completes successfully the number of bytes read is returned. .It If there is not enough data available to satisfy the entire request, and the read completes successfully, having read as @@ -287,13 +301,15 @@ When data is available depends on whether the input processing mode is canonical or noncanonical. .Ss Canonical Mode Input Processing In canonical mode input processing, terminal input is processed in units -of lines. A line is delimited by a newline +of lines. +A line is delimited by a newline .Ql \&\en character, an end-of-file .Pq Dv EOF character, or an end-of-line .Pq Dv EOL -character. See the +character. +See the .Sx "Special Characters" section for more information on @@ -302,10 +318,11 @@ and .Dv EOL . This means that a read request will not return until an entire line has been typed, or a signal has been -received. Also, no matter how many bytes are requested in the read call, -at most one line is returned. It is not, however, necessary to -read a whole line at once; any number of bytes, even one, may be -requested in a read without losing information. +received. +Also, no matter how many bytes are requested in the read call, +at most one line is returned. +It is not, however, necessary to read a whole line at once; any number +of bytes, even one, may be requested in a read without losing information. .Pp .Pf \&{ Dv MAX_CANON Ns \&} is a limit on the @@ -329,14 +346,17 @@ delimited by a newline .Dv EOF , or .Dv EOL -character. This un-delimited -data makes up the current line. The +character. +This un-delimited data makes up the current line. +The .Dv ERASE character deletes the last -character in the current line, if there is any. The +character in the current line, if there is any. +The .Dv KILL character -deletes all data in the current line, if there is any. The +deletes all data in the current line, if there is any. +The .Dv ERASE and .Dv KILL @@ -349,7 +369,8 @@ characters themselves are not placed in the input queue. .Ss Noncanonical Mode Input Processing In noncanonical mode input processing, input bytes are not assembled into -lines, and erase and kill processing does not occur. The values of the +lines, and erase and kill processing does not occur. +The values of the .Dv VMIN and .Dv VTIME @@ -366,12 +387,14 @@ function successfully returns. .Dv VTIME is a timer of 0.1 second granularity that is used to time out bursty and short term data -transmissions. If +transmissions. +If .Dv VMIN is greater than .Pf \&{ Dv MAX_INPUT Ns \&} , the response to the -request is undefined. The four possible values for +request is undefined. +The four possible values for .Dv VMIN and .Dv VTIME @@ -381,24 +404,29 @@ their interactions are described below. In this case .Dv VTIME serves as an inter-byte timer and is activated after -the first byte is received. Since it is an inter-byte timer, it is reset -after a byte is received. The interaction between +the first byte is received. +Since it is an inter-byte timer, it is reset after a byte is received. +The interaction between .Dv VMIN and .Dv VTIME is as -follows: as soon as one byte is received, the inter-byte timer is -started. If +follows: as soon as one byte is received, the inter-byte timer is +started. +If .Dv VMIN bytes are received before the inter-byte timer expires (remember that the timer is reset upon receipt of each byte), the read is -satisfied. If the timer expires before +satisfied. +If the timer expires before .Dv VMIN bytes are received, the -characters received to that point are returned to the user. Note that if +characters received to that point are returned to the user. +Note that if .Dv VTIME expires at least one byte is returned because the timer would -not have been enabled unless a byte was received. In this case +not have been enabled unless a byte was received. +In this case .Pf \&( Dv VMIN > 0, .Dv VTIME @@ -407,8 +435,8 @@ not have been enabled unless a byte was received. In this case and .Dv VTIME mechanisms are -activated by the receipt of the first byte, or a signal is received. If -data is in the buffer at the time of the read(), the result is as +activated by the receipt of the first byte, or a signal is received. +If data is in the buffer at the time of the read(), the result is as if data had been received immediately after the read(). .Ss "Case B: VMIN > 0, VTIME = 0" In this case, since the value of @@ -416,13 +444,14 @@ In this case, since the value of is zero, the timer plays no role and only .Dv VMIN -is significant. A pending read is not satisfied until +is significant. +A pending read is not satisfied until .Dv VMIN bytes are received (i.e., the pending read blocks until .Dv VMIN bytes -are received), or a signal is received. A program that uses this case to -read record-based terminal +are received), or a signal is received. +A program that uses this case to read record-based terminal .Dv I/O may block indefinitely in the read operation. @@ -432,30 +461,35 @@ In this case, since = 0, .Dv VTIME no longer represents an inter-byte -timer. It now serves as a read timer that is activated as soon as the -read function is processed. A read is satisfied as soon as a single -byte is received or the read timer expires. Note that in this case if -the timer expires, no bytes are returned. If the timer does not -expire, the only way the read can be satisfied is if a byte is received. +timer. +It now serves as a read timer that is activated as soon as the +read function is processed. +A read is satisfied as soon as a single byte is received or the read +timer expires. +Note that in this case if the timer expires, no bytes are returned. +If the timer does not expire, the only way the read can be satisfied is +if a byte is received. In this case the read will not block indefinitely waiting for a byte; if no byte is received within .Dv VTIME Ns *0.1 seconds after the read is initiated, -the read returns a value of zero, having read no data. If data is -in the buffer at the time of the read, the timer is started as if -data had been received immediately after the read. +the read returns a value of zero, having read no data. +If data is in the buffer at the time of the read, the timer is started +as if data had been received immediately after the read. .Ss Case D: VMIN = 0, VTIME = 0 The minimum of either the number of bytes requested or the number of bytes currently available is returned without waiting for more -bytes to be input. If no characters are available, read returns a -value of zero, having read no data. +bytes to be input. +If no characters are available, read returns a value of zero, having +read no data. .Ss Writing Data and Output Processing When a process writes one or more bytes to a terminal device file, they are processed according to the .Fa c_oflag field (see the .Sx "Output Modes -section). The +section). +The implementation may provide a buffering mechanism; as such, when a call to write() completes, all of the bytes written have been scheduled for transmission to the device, but the transmission will not necessarily @@ -472,11 +506,13 @@ Special character on input and is recognized if the .Dv ISIG flag (see the .Sx "Local Modes" -section) is enabled. Generates a +section) is enabled. +Generates a .Dv SIGINT signal which is sent to all processes in the foreground process group for which the terminal is the controlling -terminal. If +terminal. +If .Dv ISIG is set, the .Dv INTR @@ -485,11 +521,13 @@ discarded when processed. .It Dv QUIT Special character on input and is recognized if the .Dv ISIG -flag is enabled. Generates a +flag is enabled. +Generates a .Dv SIGQUIT signal which is sent to all processes in the foreground process group -for which the terminal is the controlling terminal. If +for which the terminal is the controlling terminal. +If .Dv ISIG is set, the .Dv QUIT @@ -498,16 +536,16 @@ processed. .It Dv ERASE Special character on input and is recognized if the .Dv ICANON -flag is set. Erases the last character in the -current line; see +flag is set. +Erases the last character in the current line; see .Sx "Canonical Mode Input Processing" . -It does not erase beyond -the start of a line, as delimited by a +It does not erase beyond the start of a line, as delimited by a .Dv NL , .Dv EOF , or .Dv EOL -character. If +character. +If .Dv ICANON is set, the .Dv ERASE @@ -516,13 +554,14 @@ discarded when processed. .It Dv KILL Special character on input and is recognized if the .Dv ICANON -flag is set. Deletes the entire line, as -delimited by a +flag is set. +Deletes the entire line, as delimited by a .Dv NL , .Dv EOF , or .Dv EOL -character. If +character. +If .Dv ICANON is set, the .Dv KILL @@ -530,16 +569,18 @@ character is discarded when processed. .It Dv EOF Special character on input and is recognized if the .Dv ICANON -flag is set. When received, all the bytes -waiting to be read are immediately passed to the +flag is set. +When received, all the bytes waiting to be read are immediately passed to the process, without waiting for a newline, and the .Dv EOF -is discarded. Thus, if there are no bytes waiting (that +is discarded. +Thus, if there are no bytes waiting (that is, the .Dv EOF occurred at the beginning of a line), a byte count of zero is returned from the read(), -representing an end-of-file indication. If +representing an end-of-file indication. +If .Dv ICANON is set, the @@ -548,12 +589,14 @@ character is discarded when processed. .Dv NL Special character on input and is recognized if the .Dv ICANON -flag is set. It is the line delimiter +flag is set. +It is the line delimiter .Ql \&\en . .It Dv EOL Special character on input and is recognized if the .Dv ICANON -flag is set. Is an additional line delimiter, +flag is set. +Is an additional line delimiter, like .Dv NL . .It Dv SUSP @@ -576,9 +619,10 @@ recognized if the (output control) or .Dv IXOFF (input -control) flag is set. Can be used to temporarily -suspend output. It is useful with fast terminals to -prevent output from disappearing before it can be read. +control) flag is set. +Can be used to temporarily suspend output. +It is useful with fast terminals to prevent output from disappearing +before it can be read. If .Dv IXON is set, the @@ -592,10 +636,11 @@ recognized if the (output control) or .Dv IXOFF (input -control) flag is set. Can be used to resume output that -has been suspended by a +control) flag is set. +Can be used to resume output that has been suspended by a .Dv STOP -character. If +character. +If .Dv IXON is set, the .Dv START @@ -607,7 +652,8 @@ flag is set; it is the .Ql \&\er , as denoted in the .Tn \&C -Standard {2}. When +Standard {2}. +When .Dv ICANON and .Dv ICRNL @@ -627,17 +673,21 @@ system and are not a part of 1003.1 termios. .It Dv EOL2 Secondary .Dv EOL -character. Same function as +character. +Same function as .Dv EOL. .It Dv WERASE Special character on input and is recognized if the .Dv ICANON -flag is set. Erases the last word in the current -line according to one of two algorithms. If the +flag is set. +Erases the last word in the current +line according to one of two algorithms. +If the .Dv ALTWERASE flag is not set, first any preceding whitespace is erased, and then the maximal sequence of non-whitespace -characters. If +characters. +If .Dv ALTWERASE is set, first any preceding whitespace is erased, and then the maximal sequence @@ -645,12 +695,13 @@ of alphabetic/underscores or non alphabetic/underscores. As a special case in this second algorithm, the first previous non-whitespace character is skipped in determining whether the preceding word is a sequence of -alphabetic/underscores. This sounds confusing but turns -out to be quite practical. +alphabetic/underscores. +This sounds confusing but turns out to be quite practical. .It Dv REPRINT Special character on input and is recognized if the .Dv ICANON -flag is set. Causes the current input edit line +flag is set. +Causes the current input edit line to be retyped. .It Dv DSUSP Has similar actions to the @@ -664,20 +715,22 @@ controlling terminal. .It Dv LNEXT Special character on input and is recognized if the .Dv IEXTEN -flag is set. Receipt of this character causes the next -character to be taken literally. +flag is set. +Receipt of this character causes the next character to be taken literally. .It Dv DISCARD Special character on input and is recognized if the .Dv IEXTEN -flag is set. Receipt of this character toggles the flushing -of terminal output. +flag is set. +Receipt of this character toggles the flushing of terminal output. .It Dv STATUS Special character on input and is recognized if the .Dv ICANON -flag is set. Receipt of this character causes a +flag is set. +Receipt of this character causes a .Dv SIGINFO signal to be sent to the foreground process group of the -terminal. Also, if the +terminal. +Also, if the .Dv NOKERNINFO flag is not set, it causes the kernel to write a status message to the terminal @@ -716,12 +769,13 @@ field for the terminal, the .Dv SIGHUP signal is sent to the controlling -process associated with the terminal. Unless other arrangements have -been made, this causes the controlling process to terminate. +process associated with the terminal. +Unless other arrangements have been made, this causes the controlling +process to terminate. Any subsequent call to the read() function returns the value zero, -indicating end of file. Thus, processes that read a terminal -file and test for end-of-file can terminate appropriately after a -disconnect. +indicating end of file. +Thus, processes that read a terminal file and test for end-of-file can +terminate appropriately after a disconnect. .\" If the .\" .Er EIO .\" condition specified in 6.1.1.4 that applies @@ -740,7 +794,8 @@ until the device is closed. .Sh General Terminal Interface .Ss Closing a Terminal Device File The last process to close a terminal device file causes any output -to be sent to the device and any input to be discarded. Then, if +to be sent to the device and any input to be discarded. +Then, if .Dv HUPCL is set in the control modes, and the communications port supports a disconnect function, the terminal device performs a disconnect. @@ -751,7 +806,8 @@ characteristics do so by using the termios structure as defined in the header .Aq Pa termios.h . This structure contains minimally four scalar elements of bit flags -and one array of special characters. The scalar flag elements are +and one array of special characters. +The scalar flag elements are named: .Fa c_iflag , .Fa c_oflag , @@ -802,16 +858,17 @@ following masks: .Pp In the context of asynchronous serial data transmission, a break condition is defined as a sequence of zero-valued bits that continues for -more than the time to send one byte. The entire sequence of zero-valued -bits is interpreted as a single break condition, even if it continues for -a time equivalent to more than one byte. In contexts other than -asynchronous serial data transmission the definition of a break condition -is implementation defined. +more than the time to send one byte. +The entire sequence of zero-valued bits is interpreted as a single break +condition, even if it continues for a time equivalent to more than one byte. +In contexts other than asynchronous serial data transmission the definition +of a break condition is implementation defined. .Pp If .Dv IGNBRK is set, a break condition detected on input is ignored, that -is, not put on the input queue and therefore not read by any process. If +is, not put on the input queue and therefore not read by any process. +If .Dv IGNBRK is not set and .Dv BRKINT @@ -820,7 +877,8 @@ input and output queues and if the terminal is the controlling terminal of a foreground process group, the break condition generates a single .Dv SIGINT -signal to that foreground process group. If neither +signal to that foreground process group. +If neither .Dv IGNBRK nor .Dv BRKINT @@ -852,7 +910,8 @@ X, where .Ql \&\e0 is a two-character flag preceding each sequence and X is the data of the character received -in error. To avoid ambiguity in this case, if +in error. +To avoid ambiguity in this case, if .Dv ISTRIP is not set, a valid character of @@ -871,13 +930,14 @@ break) is given to the application as a single character .Pp If .Dv INPCK -is set, input parity checking is enabled. If +is set, input parity checking is enabled. +If .Dv INPCK is not set, input parity checking is disabled, allowing output parity generation -without input parity errors. Note that whether input parity checking is -enabled or disabled is independent of whether parity detection is enabled -or disabled (see +without input parity errors. +Note that whether input parity checking is enabled or disabled is independent +of whether parity detection is enabled or disabled (see .Sx "Control Modes" ) . If parity detection is enabled but input parity checking is disabled, the hardware to which the terminal is @@ -895,12 +955,14 @@ is set, a received .Dv NL character is translated into a .Dv CR -character. If +character. +If .Dv IGNCR is set, a received .Dv CR character is ignored (not -read). If +read). +If .Dv IGNCR is not set and .Dv ICRNL @@ -913,22 +975,26 @@ character. .Pp If .Dv IXON -is set, start/stop output control is enabled. A received +is set, start/stop output control is enabled. +A received .Dv STOP character suspends output and a received .Dv START character -restarts output. If +restarts output. +If .Dv IXANY is also set, then any character may -restart output. When +restart output. +When .Dv IXON is set, .Dv START and .Dv STOP characters are not -read, but merely perform flow control functions. When +read, but merely perform flow control functions. +When .Dv IXON is not set, the @@ -939,8 +1005,8 @@ characters are read. .Pp If .Dv IXOFF -is set, start/stop input control is enabled. The system shall -transmit one or more +is set, start/stop input control is enabled. +The system shall transmit one or more .Dv STOP characters, which are intended to cause the terminal device to stop transmitting data, as needed to prevent the input @@ -951,7 +1017,8 @@ and shall transmit one or more characters, which are intended to cause the terminal device to resume transmitting data, as soon as the device can continue transmitting data without risk of -overflowing the input queue. The precise conditions under which +overflowing the input queue. +The precise conditions under which .Dv STOP and START @@ -1087,7 +1154,8 @@ flow control of output */ The .Dv CSIZE bits specify the byte size in bits for both transmission and -reception. The +reception. +The .Fa c_cflag is masked with .Dv CSIZE @@ -1098,25 +1166,26 @@ values .Dv CS7 , or .Dv CS8 . -This size does not include the parity bit, if any. If +This size does not include the parity bit, if any. +If .Dv CSTOPB -is set, two stop bits are used, otherwise one stop bit. For example, at -110 baud, two stop bits are normally used. +is set, two stop bits are used, otherwise one stop bit. +For example, at 110 baud, two stop bits are normally used. .Pp If .Dv CREAD -is set, the receiver is enabled. Otherwise, no character is -received. -Not all hardware supports this bit. In fact, this flag -is pretty silly and if it were not part of the +is set, the receiver is enabled. +Otherwise, no character is received. +Not all hardware supports this bit. +In fact, this flag is pretty silly and if it were not part of the .Nm -specification -it would be omitted. +specification it would be omitted. .Pp If .Dv PARENB is set, parity generation and detection are enabled and a parity -bit is added to each character. If parity is enabled, +bit is added to each character. +If parity is enabled, .Dv PARODD specifies odd parity if set, otherwise even parity is used. @@ -1125,18 +1194,21 @@ If .Dv HUPCL is set, the modem control lines for the port are lowered when the last process with the port open closes the port or the process -terminates. The modem connection is broken. +terminates. +The modem connection is broken. .Pp If .Dv CLOCAL is set, a connection does not depend on the state of the modem -status lines. If +status lines. +If .Dv CLOCAL is clear, the modem status lines are monitored. .Pp Under normal circumstances, a call to the open() function waits for -the modem connection to complete. However, if the +the modem connection to complete. +However, if the .Dv O_NONBLOCK flag is set or if @@ -1222,7 +1294,8 @@ and .Pp If .Dv ECHO -is set, input characters are echoed back to the terminal. If +is set, input characters are echoed back to the terminal. +If .Dv ECHO is not set, input characters are not echoed. .Pp @@ -1234,7 +1307,8 @@ are set, the .Dv ERASE character causes the terminal to erase the last character in the current line from the display, if -possible. If there is no character to erase, an implementation may echo +possible. +If there is no character to erase, an implementation may echo an indication that this was the case or do nothing. .Pp If @@ -1256,17 +1330,14 @@ and .Dv ICANON are set, the .Dv KILL -character causes -the current line to be discarded and the system causes -the terminal -to erase the line from the display. +character causes the current line to be discarded and the system causes +the terminal to erase the line from the display. .Pp If .Dv ECHOPRT and .Dv ICANON -are set, the system assumes -that the display is a printing device and prints a +are set, the system assumes that the display is a printing device and prints a backslash and the erased characters when processing .Dv ERASE characters, followed by a forward slash. @@ -1296,9 +1367,9 @@ is not set. .Pp If .Dv ICANON -is set, canonical processing is enabled. This enables the -erase and kill edit functions, and the assembly of input characters into -lines delimited by +is set, canonical processing is enabled. +This enables the erase and kill edit functions, and the assembly of input +characters into lines delimited by .Dv NL, .Dv EOF , and @@ -1309,13 +1380,14 @@ as described in If .Dv ICANON is not set, read requests are satisfied directly from the input -queue. A read is not satisfied until at least +queue. +A read is not satisfied until at least .Dv VMIN -bytes have been -received or the timeout value +bytes have been received or the timeout value .Dv VTIME -expired between bytes. The time value -represents tenths of seconds. See +expired between bytes. +The time value represents tenths of seconds. +See .Sx "Noncanonical Mode Input Processing" for more details. .Pp @@ -1327,12 +1399,14 @@ control characters .Dv QUIT , and .Dv SUSP -(job control only). If an input -character matches one of these control characters, the function -associated with that character is performed. If +(job control only). +If an input character matches one of these control characters, the function +associated with that character is performed. +If .Dv ISIG is not set, no -checking is done. Thus these special input functions are possible only +checking is done. +Thus these special input functions are possible only if .Dv ISIG is set. @@ -1340,7 +1414,8 @@ is set. If .Dv IEXTEN is set, implementation-defined functions are recognized -from the input data. How +from the input data. +How .Dv IEXTEN being set interacts with @@ -1377,8 +1452,8 @@ If and .Dv ICANON is set, an upper case character is preserved on input if prefixed by -a \\ character. In addition, this prefix is added to upper case -characters on output. +a \\ character. +In addition, this prefix is added to upper case characters on output. .Pp In addition, the following special character translations are in effect: .Pp @@ -1398,9 +1473,11 @@ is set, the signal .Dv SIGTTOU is sent to the process group of a process that tries to write to its controlling terminal if it is not in the foreground process group for -that terminal. This signal, by default, stops the members of the process -group. Otherwise, the output generated by that process is output to the -current output stream. Processes that are blocking or ignoring +that terminal. +This signal, by default, stops the members of the process group. +Otherwise, the output generated by that process is output to the +current output stream. +Processes that are blocking or ignoring .Dv SIGTTOU signals are excepted and allowed to produce output and the .Dv SIGTTOU @@ -1418,8 +1495,8 @@ characters (see The special control characters values are defined by the array .Fa c_cc . This table lists the array index, the corresponding special character, -and the system default value. For an accurate list of -the system defaults, consult the header file +and the system default value. +For an accurate list of the system defaults, consult the header file .Aq Pa ttydefaults.h . .Pp .Bl -column "Index Name" "Special Character" -offset indent -compact @@ -1465,8 +1542,7 @@ entries of the array. .Pp The initial values of the flags and control characters -after open() is set according to -the values in the header +after open() is set according to the values in the header .Aq Pa sys/ttydefaults.h . .Sh SEE ALSO .Xr tcgetattr 3 , diff --git a/share/man/man4/ti.4 b/share/man/man4/ti.4 index d3a6af73cd7..3ad9c120b72 100644 --- a/share/man/man4/ti.4 +++ b/share/man/man4/ti.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ti.4,v 1.15 2001/07/21 06:37:41 jason Exp $ +.\" $OpenBSD: ti.4,v 1.16 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1997, 1998, 1999 .\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved. @@ -163,8 +163,8 @@ A fatal initialization error has occurred. The driver failed to allocate memory for per-device instance information during initialization. .It "ti%d: failed to enable memory mapping!" -The driver failed to initialize PCI shared memory mapping. This might -happen if the card is not in a bus-master slot. +The driver failed to initialize PCI shared memory mapping. +This might happen if the card is not in a bus-master slot. .It "ti%d: no memory for jumbo buffers!" The driver failed to allocate memory for jumbo frames during initialization. diff --git a/share/man/man4/tl.4 b/share/man/man4/tl.4 index 6f1888af082..bd00525661d 100644 --- a/share/man/man4/tl.4 +++ b/share/man/man4/tl.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tl.4,v 1.8 2000/11/10 20:02:17 todd Exp $ +.\" $OpenBSD: tl.4,v 1.9 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1997, 1998 .\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved. @@ -30,7 +30,7 @@ .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF .\" THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $Id: tl.4,v 1.8 2000/11/10 20:02:17 todd Exp $ +.\" $Id: tl.4,v 1.9 2001/10/05 14:45:53 mpech Exp $ .\" .Dd May 1, 1998 .Dt TL 4 @@ -44,23 +44,23 @@ The .Nm driver provides support for PCI Ethernet adapters based on the Texas -Instruments ThunderLAN Ethernet controller chip. This includes a large -number of Compaq PCI-bus Ethernet adapters as well as the integrated -Ethernet controllers built in to several models of Compaq Prosignia -servers and Compaq Deskpro desktop machines. This driver also supports -the Olicom OC-2135/2138, OC-2325 and OC-2326 10/100 TX UTP adapters -and the Racore 8165 10/100baseTX and 8148 10baseT/100baseTX/100baseFX -multi-personality cards. +Instruments ThunderLAN Ethernet controller chip. +This includes a large number of Compaq PCI-bus Ethernet adapters as well as +the integrated Ethernet controllers built in to several models +of Compaq Prosignia servers and Compaq Deskpro desktop machines. +This driver also supports the Olicom OC-2135/2138, OC-2325 and OC-2326 +10/100 TX UTP adapters and the Racore 8165 10/100baseTX and 8148 +10baseT/100baseTX/100baseFX multi-personality cards. .Pp The ThunderLAN controller has a standard MII interface that supports -up to 32 physical interface devices (PHYs). It also has a built-in -10baseT PHY hardwired at MII address 31, which may be used in some -10Mbps-only hardware configurations. In 100Mbps configurations, a -National Semiconductor DP83840A or other MII-compliant PHY may be -attached to the ThunderLAN's MII bus. If a DP83840A or equivalent -is available, the ThunderLAN chip can operate at either 100Mbps or -10Mbps in either half-duplex or full-duplex modes. The ThunderLAN's -built-in PHY and the DP83840A also support autonegotiation. +up to 32 physical interface devices (PHYs). +It also has a built-in 10baseT PHY hardwired at MII address 31, which may be +used in some 10Mbps-only hardware configurations. +In 100Mbps configurations, a National Semiconductor DP83840A or other +MII-compliant PHY may be attached to the ThunderLAN's MII bus. +If a DP83840A or equivalent is available, the ThunderLAN chip can operate +at either 100Mbps or 10Mbps in either half-duplex or full-duplex modes. +The ThunderLAN's built-in PHY and the DP83840A also support autonegotiation. .Pp The .Nm @@ -68,8 +68,9 @@ driver supports the following media types: .Pp .Bl -tag -width xxxxxxxxxxxxxxxxxxxx .It autoselect -Enable autoselection of the media type and options. Note that this -option is only available on those PHYs that support autonegotiation. +Enable autoselection of the media type and options. +Note that this option is only available on those PHYs that support +autonegotiation. Also, the PHY will not advertise those modes that have been explicitly disabled using the following media options. .It 10baseT/UTP diff --git a/share/man/man4/tp.4 b/share/man/man4/tp.4 index 129f1325555..65417ad0097 100644 --- a/share/man/man4/tp.4 +++ b/share/man/man4/tp.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tp.4,v 1.12 2000/12/21 21:01:21 aaron Exp $ +.\" $OpenBSD: tp.4,v 1.13 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: tp.4,v 1.4 1994/11/30 16:22:38 jtc Exp $ .\" .\" Copyright (c) 1990, 1991, 1993 @@ -71,7 +71,8 @@ Sockets utilizing the tp protocol are either or .Dq passive . Active sockets initiate connections to passive -sockets. By default +sockets. +By default .Tn TCP sockets are created active; to create a passive socket the @@ -79,19 +80,19 @@ passive socket the system call must be used after binding the socket with the .Xr bind 2 -system call. Only -passive sockets may use the +system call. +Only passive sockets may use the .Xr accept 2 -call to accept incoming connections. Only active sockets may -use the +call to accept incoming connections. +Only active sockets may use the .Xr connect 2 call to initiate connections. .Pp Passive sockets may .Dq underspecify their location to match -incoming connection requests from multiple networks. This -technique, termed +incoming connection requests from multiple networks. +This technique, termed .Dq wildcard addressing , allows a single server to provide service to clients on multiple networks. @@ -102,9 +103,10 @@ of the bound address must be void (of length zero). The Transport Selector may still be specified at this time; if the port is not specified the system will assign one. Once a connection has been established the socket's address is -fixed by the peer entity's location. The address assigned the -socket is the address associated with the network interface -through which packets are being transmitted and received. +fixed by the peer entity's location. +The address assigned the socket is the address associated with +the network interface through which packets are being transmitted +and received. .Pp The .Tn ISO @@ -283,7 +285,8 @@ The structure it returns is described in See .Xr tpperf 8 . .It Dv TPOPT_FLAGS -unsigned integer. [0x0] +unsigned integer. +[0x0] .br This command can only be used with .Xr getsockopt . @@ -378,7 +381,8 @@ to keep an inactive connection open (to prevent the peer's inactivity control function from closing the connection). This parameter applies only to class 4. .It Ar p_winsize -short integer between 128 and 16384. [4096 bytes] +short integer between 128 and 16384. +[4096 bytes] .br The buffer space limits in bytes for incoming and outgoing data. There is no way to specify different limits for incoming and outgoing @@ -501,7 +505,8 @@ indications (signals) when a .Tn TP connection is disconnected. .It Ar p_dont_change_params -Boolean. [false] +Boolean. +[false] .br If .Em true diff --git a/share/man/man4/tty.4 b/share/man/man4/tty.4 index f2edf1add38..161f6b4b372 100644 --- a/share/man/man4/tty.4 +++ b/share/man/man4/tty.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tty.4,v 1.18 2001/09/11 15:32:49 fgsch Exp $ +.\" $OpenBSD: tty.4,v 1.19 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: tty.4,v 1.4 1996/03/19 04:26:01 paulus Exp $ .\" .\" Copyright (c) 1991, 1992, 1993 @@ -66,36 +66,41 @@ system when logging in over a network (using .Xr rlogin 1 , or .Xr telnet 1 -for example). Even in these cases the details of how the terminal +for example). +Even in these cases the details of how the terminal file was opened and set up is already handled by special software in the system. Thus, users do not normally need to worry about the details of how these lines are opened or used. .Pp For hardware terminal ports, dial-out is supported through matching -device nodes called calling units. For instance, the terminal called +device nodes called calling units. +For instance, the terminal called .Pa /dev/tty03 would have a matching calling unit called .Pa /dev/cua03 . These two devices are normally differentiated by creating the calling unit device node with a minor number 128 greater than the dial-in -device node. Whereas the dial-in device (the +device node. +Whereas the dial-in device (the .Em tty ) normally requires a hardware signal to indicate to the system that it is active, the dial-out device (the .Em cua ) does not, and hence can communicate unimpeded -with a device such as a modem. This means that a process like +with a device such as a modem. +This means that a process like .Xr getty 8 will wait on a dial-in device until a connection is established. Meanwhile, a dial-out connection can be established on the dial-out device (for the very same hardware terminal port) without disturbing -anything else on the system. The +anything else on the system. +The .Xr getty 8 process does not even notice that anything is happening on the terminal -port. If a connecting call comes in after the dial-out connection has -finished, the +port. +If a connecting call comes in after the dial-out connection has finished, the .Xr getty 8 process will deal with it properly, without having noticed the intervening dial-out action. @@ -111,20 +116,23 @@ the particular details of which is described in .Xr stty 1 at the command level, and in .Xr termios 4 -at the programming level. A user may be concerned with changing -settings associated with his particular login terminal and should refer -to the preceding man pages for the common cases. The remainder of -this man page is concerned -with describing details of using and controlling terminal devices -at a low level, such as that possibly required by a program wishing -to provide features similar to those provided by the system. +at the programming level. +A user may be concerned with changing settings associated with his particular +login terminal and should refer to the preceding man pages for the common +cases. +The remainder of this man page is concerned with describing details of using +and controlling terminal devices at a low level, such as that possibly +required by a program wishing to provide features similar to those provided +by the system. .Ss Line disciplines A terminal file is used like any other file in the system in that it can be opened, read, and written to using standard system -calls. For each existing terminal file, there is a software processing module +calls. +For each existing terminal file, there is a software processing module called a .Em "line discipline" -is associated with it. The +is associated with it. +The .Em "line discipline" essentially glues the low level device driver code with the high level generic interface routines (such as @@ -132,14 +140,15 @@ level generic interface routines (such as and .Xr write 2 ) , and is responsible for implementing the semantics associated -with the device. When a terminal file is first opened by a program, -the default +with the device. +When a terminal file is first opened by a program, the default .Em "line discipline" called the .Dv termios -line discipline is associated with the file. This is the primary -line discipline that is used in most cases and provides the semantics -that users normally associate with a terminal. When the +line discipline is associated with the file. +This is the primary line discipline that is used in most cases and provides +the semantics that users normally associate with a terminal. +When the .Dv termios line discipline is in effect, the terminal file behaves and is operated according to the rules described in @@ -158,8 +167,8 @@ hardware (or lack thereof, as in the case of ptys). .Ss Terminal File Operations All of the following operations are invoked using the .Xr ioctl 2 -system call. Refer to that man page for a description of -the +system call. +Refer to that man page for a description of the .Em request and .Em argp @@ -173,11 +182,12 @@ specific to it (actually .Xr termios 4 defines them as function calls, not ioctl .Em requests . ) -The following section lists the available ioctl requests. The -name of the request, a description of its purpose, and the typed +The following section lists the available ioctl requests. +The name of the request, a description of its purpose, and the typed .Em argp parameter (if any) -are listed. For example, the first entry says +are listed. +For example, the first entry says .Pp .D1 Em "TIOCSETD int *ldisc" .Pp @@ -276,20 +286,22 @@ Place the current number of characters in the output queue in the integer pointed to by .Fa num . .It Dv TIOCSTI Fa char *cp -Simulate typed input. Pretend as if the terminal received the -character pointed to by +Simulate typed input. +Pretend as if the terminal received the character pointed to by .Fa cp . .It Dv TIOCNOTTY Fa void -This call is obsolete but left for compatibility. In the past, when -a process that didn't have a controlling terminal (see +This call is obsolete but left for compatibility. +In the past, when a process that didn't have a controlling terminal +(see .Em The Controlling Terminal in .Xr termios 4 ) first opened a terminal device, it acquired that terminal as its -controlling terminal. For some programs this was a hazard as they -didn't want a controlling terminal in the first place, and this -provided a mechanism to disassociate the controlling terminal from -the calling process. It +controlling terminal. +For some programs this was a hazard as they didn't want a controlling +terminal in the first place, and this provided a mechanism to disassociate +the controlling terminal from the calling process. +It .Em must be called by opening the file .Pa /dev/tty @@ -309,8 +321,8 @@ In addition, a program can and call the .Fn setsid system call which will place the process into its own session - which -has the effect of disassociating it from the controlling terminal. This -is the new and preferred method for programs to lose their controlling +has the effect of disassociating it from the controlling terminal. +This is the new and preferred method for programs to lose their controlling terminal. .It Dv TIOCSTOP Fa void Stop output on the terminal (like typing ^S at the keyboard). @@ -322,12 +334,14 @@ must not currently have a controlling terminal). .It Dv TIOCDRAIN Fa void Wait until all output is drained. .It Dv TIOCEXCL Fa void -Set exclusive use on the terminal. No further opens are permitted -except by root. Of course, this means that programs that are run by -root (or setuid) will not obey the exclusive setting - which limits -the usefulness of this feature. +Set exclusive use on the terminal. +No further opens are permitted except by root. +Of course, this means that programs that are run by root (or setuid) +will not obey the exclusive setting - which limits the usefulness +of this feature. .It Dv TIOCNXCL Fa void -Clear exclusive use of the terminal. Further opens are permitted. +Clear exclusive use of the terminal. +Further opens are permitted. .It Dv TIOCFLUSH Fa int *what If the value of the int pointed to by .Fa what @@ -335,24 +349,25 @@ contains the .Dv FREAD bit as defined in .Pa Aq sys/fcntl.h , -then all characters in the input queue are cleared. If it contains -the +then all characters in the input queue are cleared. +If it contains the .Dv FWRITE -bit, then all characters in the output queue are cleared. If the -value of the integer is zero, then it behaves as if both the +bit, then all characters in the output queue are cleared. +If the value of the integer is zero, then it behaves as if both the .Dv FREAD and .Dv FWRITE -bits were set (i.e. clears both queues). +bits were set (i.e., clears both queues). .It Dv TIOCGWINSZ Fa struct winsize *ws Put the window size information associated with the terminal in the .Va winsize structure pointed to by .Fa ws . The window size structure contains the number of rows and columns (and pixels -if appropriate) of the devices attached to the terminal. It is set by user software -and is the means by which most full\&-screen oriented programs determine the -screen size. The +if appropriate) of the devices attached to the terminal. +It is set by user software and is the means by which most full\&-screen +oriented programs determine the screen size. +The .Va winsize structure is defined in .Pa Aq sys/ioctl.h . @@ -375,13 +390,14 @@ to this terminal. If .Fa on points to a zero integer, redirect kernel console output back to the normal -console. This is usually used on workstations to redirect kernel messages +console. +This is usually used on workstations to redirect kernel messages to a particular window. .It Dv TIOCMSET Fa int *state The integer pointed to by .Fa state -contains bits that correspond to modem state. Following is a list -of defined variables and the modem state they represent: +contains bits that correspond to modem state. +Following is a list of defined variables and the modem state they represent: .Pp .Bl -tag -width TIOCMXCTS -compact .It TIOCM_LE @@ -430,8 +446,9 @@ is cleared in the terminal. .It Dv TIOCSFLAGS Fa int *state The bits in the integer pointed to by .Fa state -contain bits that correspond to serial port state. Following is a list -of defined variables and the serial port state they represent: +contain bits that correspond to serial port state. +Following is a list of defined variables and the serial port state they +represent: .Pp .Bl -tag -width TIOCFLAG_SOFTCAR -compact .It TIOCFLAG_SOFTCAR diff --git a/share/man/man4/tun.4 b/share/man/man4/tun.4 index 5ffbdfda730..584114dadb1 100644 --- a/share/man/man4/tun.4 +++ b/share/man/man4/tun.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tun.4,v 1.19 2001/06/22 12:15:47 mpech Exp $ +.\" $OpenBSD: tun.4,v 1.20 2001/10/05 14:45:53 mpech Exp $ .\" .Dd March 10, 1996 .Dt TUN 4 @@ -40,7 +40,8 @@ etc, as many in all as the .Ar count figure given on the .Sy pseudo-device -line. Each one supports the usual network-interface +line. +Each one supports the usual network-interface .Xr ioctl 2 Ns s , such as .Dv SIOCSIFADDR @@ -48,18 +49,20 @@ and .Dv SIOCSIFNETMASK , and thus can be used with .Xr ifconfig 8 -like any other interface. At boot time, they are +like any other interface. +At boot time, they are .Dv POINTOPOINT interfaces, but this can be changed; see the description of the control -device, below. When the system chooses to transmit a packet on the -network interface, the packet can be read from the control device (it -appears as +device, below. +When the system chooses to transmit a packet on the network interface, +the packet can be read from the control device (it appears as .Dq input there); writing a packet to the control device generates an input packet on the network interface, as if the (nonexistent) hardware had just received it. .Pp -There are two control interfaces. The +There are two control interfaces. +The .Em data interface, normally .Pa /dev/tun Ns Sy N , @@ -68,7 +71,8 @@ normally restricted to the superuser, and can .Dq transmit and .Dq receive -packets. The +packets. +The .Em control interface, normally .Pa /dev/tunc Ns Sy N , @@ -76,10 +80,10 @@ cannot send and receive packets, but can be opened by many processes at once; it is intended for status queries and changes (many of which can also be implemented with .Fn ioctl -calls on the data interface). There are a number of status bits that -can be set or cleared via the control interfaces; they are mentioned -below where applicable, and they are all summarized in the discussions -of the control interfaces. +calls on the data interface). +There are a number of status bits that can be set or cleared via the control +interfaces; they are mentioned below where applicable, and they are all +summarized in the discussions of the control interfaces. .\" Why isn't .Ss documented in mdoc(7) and mdoc.samples(7)? .Ss The data interface The data interface supports @@ -91,11 +95,12 @@ calls to, respectively, collect .Dq output packets, generate .Dq input -packets, and perform control functions. As mentioned above, this -interface is exclusive-open; if the +packets, and perform control functions. +As mentioned above, this interface is exclusive-open; if the .Dv SUONLY bit is set (which it is by default), it cannot be opened at all except -by the superuser. By default, a +by the superuser. +By default, a .Fn read call will return an error .Pf ( Er EHOSTDOWN ) @@ -107,25 +112,26 @@ address has been set); if preferred, the bit can be set, in which case a .Fn read call will block (even if non-blocking I/O has been enabled) until the -interface is ready. Once the interface is ready, +interface is ready. +Once the interface is ready, .Fn read will return a packet if one is available; if not, it will either block until one is or return .Er EWOULDBLOCK , -depending on whether non-blocking I/O has been enabled. If the packet -is longer than is allowed for in the buffer passed to +depending on whether non-blocking I/O has been enabled. +If the packet is longer than is allowed for in the buffer passed to .Fn read , the extra data will be silently dropped. .Pp The first u_int32_t of data will always be the address family (eg, .Dv AF_INET ) -of the packet in network byte order. By default, the packet data follows -immediately, but if +of the packet in network byte order. +By default, the packet data follows immediately, but if the .Dv PREPADDR bit is set, the address to which the packet is to be sent is placed -after the address family u_int32_t and before the packet data. The size and -layout of the address depends on the address family; for +after the address family u_int32_t and before the packet data. +The size and layout of the address depends on the address family; for .Dv AF_INET , for example, it is a .Va struct in_addr . @@ -133,7 +139,8 @@ A .Xr write 2 call passes a packet in to be .Dq received -on the pseudo-interface. Each +on the pseudo-interface. +Each .Fn write call supplies exactly one packet; the packet length is taken from the amount of data provided to @@ -144,20 +151,21 @@ byte order, much as in packets returned by the packet data always follows immediately. A .Fn write -with an invalid address family (e.g. not specified or in the wrong byte -order) will return +with an invalid address family (e.g. +not specified or in the wrong byte order) will return .Er ENOSUPPORT . A large number of .Xr ioctl 2 -calls are also supported. They are defined in +calls are also supported. +They are defined in .Aq Pa net/if_tun.h Ns . .Bl -tag -width TUN_PREPADDR .It Dv TUNSDEBUG The argument should be a pointer to an .Va int ; -this sets the internal debugging variable to that value. What, if -anything, this variable controls is not documented here; see the source -code. +this sets the internal debugging variable to that value. +What, if anything, this variable controls is not documented here; +see the source code. .It Dv TUNGDEBUG The argument should be a pointer to an .Va int ; @@ -171,10 +179,11 @@ or .Dv IFF_BROADCAST . The type of the corresponding .Em tun Ns Sy n -interface is set to the supplied type. If the value is anything else, -an +interface is set to the supplied type. +If the value is anything else, an .Er EINVAL -error occurs. The interface must be down at the time; if it is up, an +error occurs. +The interface must be down at the time; if it is up, an .Er EBUSY error occurs. .\" X .It Dv TUNSFLAG @@ -245,8 +254,8 @@ The data control device also supports .Xr select 2 for read; selecting for write is pointless, and always succeeds, since writes are always nonblocking (if the packet cannot be accepted for a -transient reason (eg, no buffer space available), it is silently -dropped; if the reason is not transient (eg, packet too large), an +transient reason (e.g., no buffer space available), it is silently +dropped; if the reason is not transient (e.g., packet too large), an error is returned). .Pp On the last close of the data device, by default, the interface is @@ -254,9 +263,10 @@ brought down (as if with .Dq ifconfig tun Ns Sy n down ) ; if the .Dv STAYUP -bit is set, this is not done. In either case, all queued packets are -thrown away. (If the interface is up when the data device is not open, -either because of +bit is set, this is not done. +In either case, all queued packets are thrown away. +(If the interface is up when the data device is not open, either +because of .Dv STAYUP or because it was explicitly brought up, output packets are always thrown away rather than letting them pile up.) @@ -271,8 +281,8 @@ calls on the data interface, and a few more as well. on the control interface always return a single line of text (or just the beginning of the line, if the buffer passed to .Xr read 2 -was too small to take the whole line). The line contains items in the -general format +was too small to take the whole line). +The line contains items in the general format .Do .Li item=value .Dc , @@ -280,11 +290,11 @@ where .Li item is a keyword and .Li value -is a value appropriate to the keyword. This line is intended for human -use; programs should use the +is a value appropriate to the keyword. +This line is intended for human use; programs should use the .Fn ioctl -interface. Here is an actual example (broken because of width -restrictions): +interface. +Here is an actual example (broken because of width restrictions): .Bd -literal unit=0 flags=(open,inited,!rcoll,iaset,!dstaddr,!rwait,!async, !nbio,!brdaddr,prepaddr,stayup,suonly,rrwait) type=broadcast @@ -293,19 +303,23 @@ mtu=1500 coll=0 ipkts=0/0 opkts=0/0 pgrp=0 .Pp Note that the current file offset is ignored for reads, so using a tool like .Xr cat 1 -will result in infinite output. Use something more like +will result in infinite output. +Use something more like .Dq head\ \&-1 -for command-line use. It is possible to +for command-line use. +It is possible to .Xr select 2 for reading on this device, which will indicate that the device is readable whenever the state is changed. .Pp Writes to the control interface are interpreted as modifications to the -state. Each +state. +Each .Fn write -call is treated separately. The data written is broken at whitespace -(blanks, tabs, newlines); each resulting fragment has its first -character examined. If this character is a +call is treated separately. +The data written is broken at whitespace (blanks, tabs, newlines); +each resulting fragment has its first character examined. +If this character is a .Ql \&+ or .Ql \&\- , @@ -318,7 +332,8 @@ or off (for .Dv TUN_ Ns Em xxx constants, with the leading .Dv TUN_ -removed and the rest lowercased.) If the first character is +removed and the rest lowercased.) +If the first character is .Ql t , the second character must be .Ql b @@ -328,7 +343,8 @@ and the interface type is set to .Dv IFF_BROADCAST or .Dv IFF_POINTOPOINT , -respectively. If the first character is +respectively. +If the first character is .Ql g or .Ql m , @@ -348,8 +364,8 @@ or MTU, for The .Dv SUONLY bit is a botch, especially since the control interface, which is never -restricted by the kernel, can change it. Access control really should -be handled by the permission bits on the +restricted by the kernel, can change it. +Access control really should be handled by the permission bits on the .Pa /dev entries for the data and control devices; this bit is a historical artifact. @@ -358,17 +374,17 @@ The process-group values for .Dv SIGIO signals should be checked; as it stands, the driver can be used (by anyone who can open the control or data device) to send any desired -signal to an arbitrary process or process group. (Until this is fixed, -you should be careful to set the permission bits to allow only root to -open the control device, and either do the same for the data device or -leave the +signal to an arbitrary process or process group. +(Until this is fixed, you should be careful to set the permission bits to +allow only root to open the control device, and either do the same for +the data device or leave the .Dv SUONLY bit set.) .Sh NOTES Very old versions of the tunnel device did not include the address -family at the start of the packet. More recent versions passed the -address family as a single byte, but this caused problems with bpf, -hence the current version passes a u_int32_t of address family. This was -initially pass in host byte order, but the current version now uses +family at the start of the packet. +More recent versions passed the address family as a single byte, but this +caused problems with bpf, hence the current version passes a u_int32_t +of address family. +This was initially pass in host byte order, but the current version now uses network byte order. - diff --git a/share/man/man4/tx.4 b/share/man/man4/tx.4 index e3fa890c27b..6925015b628 100644 --- a/share/man/man4/tx.4 +++ b/share/man/man4/tx.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: tx.4,v 1.8 2001/02/23 23:08:08 jason Exp $ +.\" $OpenBSD: tx.4,v 1.9 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1998 Jason L. Wright (jason@thought.net) .\" All rights reserved. @@ -63,9 +63,9 @@ network. When a .Nm interface is brought up, by default, it will attempt to auto-negotiate the -link speed and duplex. The speeds, in order of attempt, are: -100Mb/s Full Duplex, 100Mb/s Half Duplex, 10 Mb/s Full Duplex, and -10 Mb/s Half Duplex. +link speed and duplex. +The speeds, in order of attempt, are: 100Mb/s Full Duplex, 100Mb/s Half Duplex, +10 Mb/s Full Duplex, and 10 Mb/s Half Duplex. .Pp The .Nm @@ -96,15 +96,18 @@ Put the interface into loopback mode .Sh DIAGNOSTICS .Bl -diag .It "tx%d: device timeout %d packets" -The device stopped responding. Device and driver reset follows this error. +The device stopped responding. +Device and driver reset follows this error. .It "tx%d: PCI fatal error occurred (%s)" One of following errors occurred: PCI Target Abort, PCI Master Abort, Data -Parity Error or Address Parity Error. Device and driver reset follows -this error. +Parity Error or Address Parity Error. +Device and driver reset follows this error. .It "tx%d: WARNING! no link established" -No media connected. Displayed at startup only. +No media connected. +Displayed at startup only. .It "tx%d: cannot allocate mbuf header/cluster" -Failed to allocate memory for a received packet. Packet was dropped. +Failed to allocate memory for a received packet. +Packet was dropped. .It "tx%d: can't stop %s DMA" While resetting, the driver failed to stop the device correctly. .El diff --git a/share/man/man4/txp.4 b/share/man/man4/txp.4 index 1820451eb64..954fa1b17e6 100644 --- a/share/man/man4/txp.4 +++ b/share/man/man4/txp.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: txp.4,v 1.8 2001/06/26 02:09:11 pjanzen Exp $ +.\" $OpenBSD: txp.4,v 1.9 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 2001 Jason L. Wright (jason@thought.net) .\" All rights reserved. @@ -98,9 +98,9 @@ network. When a .Nm interface is brought up, by default, it will attempt to auto-negotiate the -link speed and duplex mode. The speeds, in order of attempt, are: -100Mb/s Full Duplex, 100Mb/s Half Duplex, 10 Mb/s Full Duplex, and -10 Mb/s Half Duplex. +link speed and duplex mode. +The speeds, in order of attempt, are: 100Mb/s Full Duplex, 100Mb/s Half Duplex, +10 Mb/s Full Duplex, and 10 Mb/s Half Duplex. .Pp The .Nm diff --git a/share/man/man4/udp.4 b/share/man/man4/udp.4 index 49eec886b66..17f6171db7c 100644 --- a/share/man/man4/udp.4 +++ b/share/man/man4/udp.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: udp.4,v 1.8 2000/12/21 21:01:21 aaron Exp $ +.\" $OpenBSD: udp.4,v 1.9 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: udp.4,v 1.3 1994/11/30 16:22:41 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -79,7 +79,8 @@ address formats are identical to those used by In particular .Tn UDP provides a port identifier in addition -to the normal Internet address format. Note that the +to the normal Internet address format. +Note that the .Tn UDP port space is separate from the @@ -91,9 +92,9 @@ may not be .Dq connected to a .Tn TCP -port). In addition broadcast -packets may be sent (assuming the underlying network supports -this) by using a reserved +port). +In addition broadcast packets may be sent (assuming the underlying network +supports this) by using a reserved .Dq broadcast address ; this address is network interface dependent. diff --git a/share/man/man4/ugen.4 b/share/man/man4/ugen.4 index 71852468428..1503106c2e6 100644 --- a/share/man/man4/ugen.4 +++ b/share/man/man4/ugen.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ugen.4,v 1.5 2001/08/03 15:21:16 mpech Exp $ +.\" $OpenBSD: ugen.4,v 1.6 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: ugen.4,v 1.7 1999/07/30 01:32:05 augustss Exp $ .\" .\" Copyright (c) 1999 The NetBSD Foundation, Inc. @@ -47,16 +47,18 @@ The .Nm driver provides support for all USB devices that do not have -a special driver. It supports access to all parts of the device, -but not in a way that is as convenient as a special purpose driver. +a special driver. +It supports access to all parts of the device, but not in a way that is as +convenient as a special purpose driver. .Pp There can be up to 127 USB devices connected to a USB bus. -Each USB device can have up to 16 endpoints. Each of these endpoints -will communicate in one of four different modes: control, isochronous, -bulk, or interrupt. Each of the endpoints will have a different -device node. The four least significant bits in the minor device -number determine which endpoint the device accesses and the rest -of the bits determine which USB device. +Each USB device can have up to 16 endpoints. +Each of these endpoints will communicate in one of four different modes: +control, isochronous, bulk, or interrupt. +Each of the endpoints will have a different device node. +The four least significant bits in the minor device number determine which +endpoint the device accesses and the rest of the bits determine which +USB device. .Pp If an endpoint address is used both for input and output the device can be opened for both read or write, but an @@ -71,8 +73,8 @@ operations available for the control endpoint that return the USB descriptors of the device, configurations, interfaces, and endpoints. .Pp The control transfer mode can only happen on the control endpoint, -which is always endpoint 0. Control requests -are issued by +which is always endpoint 0. +Control requests are issued by .Xr ioctl 2 calls. .\" .Pp @@ -90,7 +92,8 @@ calls. .\" about 1 second of data. .Pp The bulk transfer mode can be in or out depending on the -endpoint. To perform I/O on a bulk endpoint +endpoint. +To perform I/O on a bulk endpoint .Xr read 2 and .Xr write 2 @@ -100,8 +103,8 @@ All I/O operations on a bulk endpoint are unbuffered. The interrupt transfer mode can only be in. To perform input from an interrupt endpoint .Xr read 2 -should be used. A moderate amount of buffering is done -by the driver. +should be used. +A moderate amount of buffering is done by the driver. .Pp The control endpoint (endpoint 0) handles the following .Xr ioctl 2 @@ -109,9 +112,9 @@ calls: .Pp .Bl -tag -width indent -compact .It Dv USB_SET_SHORT_XFER (int) -Allow short read transfer. Normally a transfer from the device -which is shorter than the request specified is reported as an -error. +Allow short read transfer. +Normally a transfer from the device which is shorter than the request +specified is reported as an error. .Pp .It Dv USB_GET_CONFIG (int) Get the device configuration number. @@ -205,7 +208,8 @@ The .Fa data field should point to a memory area of the size given in the .Fa size -field. The proper size can be determined by first issuing a +field. +The proper size can be determined by first issuing a .Dv USB_GET_CONFIG_DESC and inspecting the .Fa wTotalLength @@ -239,20 +243,22 @@ struct usb_ctl_request { }; .Ed This is a dangerous operation in that it can perform arbitrary operations -on the device. Some of the most dangerous (e.g., changing the device -address) are not allowed. +on the device. +Some of the most dangerous (e.g., changing the device address) are not +allowed. .Pp .It Dv USB_GET_DEVICEINFO (struct usb_device_info) -Get an information summary for the device. This call will not -issue any USB transactions. +Get an information summary for the device. +This call will not issue any USB transactions. .El .Pp Note that there are two different ways of addressing configurations, interfaces, alternatives, and endpoints: by index or by number. The index is the ordinal number (starting from 0) of the descriptor -as presented by the device. The number is the respective number of -the entity as found in its descriptor. Enumeration of descriptors -use the index, getting and setting typically uses numbers. +as presented by the device. +The number is the respective number of the entity as found in its descriptor. +Enumeration of descriptors use the index, getting and setting typically uses +numbers. .Pp Example: All endpoints (except the control endpoint) for the current configuration diff --git a/share/man/man4/uhid.4 b/share/man/man4/uhid.4 index bf8c3cbe2f5..68e302835c2 100644 --- a/share/man/man4/uhid.4 +++ b/share/man/man4/uhid.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: uhid.4,v 1.7 2001/09/02 18:01:54 pvalchev Exp $ +.\" $OpenBSD: uhid.4,v 1.8 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: uhid.4,v 1.6 1999/05/11 21:05:09 augustss Exp $ .\" .\" Copyright (c) 1999 The NetBSD Foundation, Inc. @@ -55,10 +55,10 @@ calls: .Pp .Bl -tag -width indent -compact .It Dv USB_GET_REPORT_DESC (struct usb_ctl_report_desc) -Get the HID report descriptor. Using -this descriptor the exact layout and meaning of data to/from -the device can be found. The report descriptor is delivered -without any processing. +Get the HID report descriptor. +Using this descriptor the exact layout and meaning of data to/from +the device can be found. +The report descriptor is delivered without any processing. .Bd -literal struct usb_ctl_report_desc { int size; @@ -68,17 +68,19 @@ struct usb_ctl_report_desc { .It Dv USB_SET_IMMED (int) Sets the device in a mode where each .Xr read 2 -will return the current value of the input report. Normally -a +will return the current value of the input report. +Normally a .Xr read 2 will only return the data that the device reports on its -interrupt pipe. This call may fail if the device does not support -this feature. +interrupt pipe. +This call may fail if the device does not support this feature. .It Dv USB_GET_REPORT (struct usb_ctl_report) Get a report from the device without waiting for data on -the interrupt pipe. The +the interrupt pipe. +The .Fa report -field indicates which report is requested. It should be +field indicates which report is requested. +It should be .Dv UHID_INPUT_REPORT , .Dv UHID_OUTPUT_REPORT , or @@ -95,13 +97,14 @@ struct usb_ctl_report { .Pp Use .Xr read 2 -to get data from the device. Data should be read in chunks of the -size prescribed by the report descriptor. +to get data from the device. +Data should be read in chunks of the size prescribed by the report descriptor. .Pp Use .Xr write 2 -send data to the device. Data should be written in chunks of the -size prescribed by the report descriptor. +send data to the device. +Data should be written in chunks of the size prescribed by the report +descriptor. .Sh SEE ALSO .Xr usbhidctl 1 , .Xr usb 3 , diff --git a/share/man/man4/uk.4 b/share/man/man4/uk.4 index d3c6c0b7f21..040cc29a841 100644 --- a/share/man/man4/uk.4 +++ b/share/man/man4/uk.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: uk.4,v 1.8 2001/06/23 07:04:00 pjanzen Exp $ +.\" $OpenBSD: uk.4,v 1.9 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: uk.4,v 1.3 1996/10/20 23:15:26 explorer Exp $ .\" .\" Copyright (c) 1996 @@ -53,7 +53,8 @@ The driver has no ioctls of its own but rather acts as a medium for the generic .Xr scsi 4 -ioctls. These are described in +ioctls. +These are described in .Em sys/scsiio.h. .Sh FILES .Bl -tag -width /dev/uk[0-255] -compact diff --git a/share/man/man4/ukphy.4 b/share/man/man4/ukphy.4 index 133d8bff038..504997a546c 100644 --- a/share/man/man4/ukphy.4 +++ b/share/man/man4/ukphy.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ukphy.4,v 1.4 2000/10/18 02:38:24 aaron Exp $ +.\" $OpenBSD: ukphy.4,v 1.5 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: ukphy.4,v 1.1 1999/09/08 13:59:07 soren Exp $ .\" .\" Copyright (c) 1998 The NetBSD Foundation, Inc. @@ -51,8 +51,8 @@ driver supports the basic functionality of most Ethernet PHYs. .Sh CAVEAT In areas where the programming interface for PHYs differ, such as detecting the currently active medium, this driver often -does not work optimally. When available, it is best to use a -PHY-specific driver. +does not work optimally. +When available, it is best to use a PHY-specific driver. .Sh SEE ALSO .Xr ifmedia 4 , .Xr intro 4 , diff --git a/share/man/man4/vlan.4 b/share/man/man4/vlan.4 index 02bd44c9c9e..149b4dd118d 100644 --- a/share/man/man4/vlan.4 +++ b/share/man/man4/vlan.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: vlan.4,v 1.13 2001/08/20 05:57:55 mpech Exp $ +.\" $OpenBSD: vlan.4,v 1.14 2001/10/05 14:45:53 mpech Exp $ .\" .Dd January 9, 2000 .Dt VLAN 4 @@ -68,15 +68,15 @@ The parent interface will participate in the tagging and untagging of frames. .It "vlan%d: initialized with non-standard mtu %d (parent %s)" The IFCAP_VLAN_MTU capability was not set on the parent interface. We assume in this event that the parent interface is not capable of handling -frames larger then its MTU. This will generally result in a non-compliant -802.1Q implementation. +frames larger then its MTU. +This will generally result in a non-compliant 802.1Q implementation. .Pp Some Ethernet chips will either discard or truncate -Ethernet frames that are larger then 1514 bytes. This causes a problem as -802.1Q tagged frames can be up to 1518 bytes. +Ethernet frames that are larger then 1514 bytes. +This causes a problem as 802.1Q tagged frames can be up to 1518 bytes. Most controller chips can be told not to discard large frames -and/or to increase the allowed frame size. Refer to the hardware manual -for your chip to do this. +and/or to increase the allowed frame size. +Refer to the hardware manual for your chip to do this. .El .Pp If the IFCAP_VLAN_MTU capability is set on a vlan parent, diff --git a/share/man/man4/vnd.4 b/share/man/man4/vnd.4 index f8c7bde302f..3aeb341f58a 100644 --- a/share/man/man4/vnd.4 +++ b/share/man/man4/vnd.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: vnd.4,v 1.13 2000/06/28 19:01:17 art Exp $ +.\" $OpenBSD: vnd.4,v 1.14 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: vnd.4,v 1.1 1995/12/30 18:10:48 thorpej Exp $ .\" .\" Copyright (c) 1995 Jason R. Thorpe. @@ -43,9 +43,10 @@ .Sh DESCRIPTION The .Nm -driver provides a disk-like interface to a file. This is useful for -a variety of applications, including swap files and building miniroot -or floppy disk images. There are two variants, the traditional +driver provides a disk-like interface to a file. +This is useful for a variety of applications, including swap files and +building miniroot or floppy disk images. +There are two variants, the traditional .Nm that bypasses the buffercache and thus is suitable for swap on files, but not for building disk-images, and the @@ -71,7 +72,8 @@ pseudo-device vnd 4 # vnode disk driver .Pp The count argument is how many .Nm vnds -memory is allocated for a boot time. In this example, no more than 4 +memory is allocated for a boot time. +In this example, no more than 4 .Nm vnds may be configured. .Pp @@ -91,7 +93,8 @@ variant does. /dev/{,r}{,s}vnd* - vnd device special files. .Sh HISTORY The vnode disk driver was originally written at the University of -Utah. The svnd variant was first seen in +Utah. +The svnd variant was first seen in .Ox 2.1 . .Sh SEE ALSO .Xr MAKEDEV 8 , diff --git a/share/man/man4/wd.4 b/share/man/man4/wd.4 index 48f929c451b..98a897c3561 100644 --- a/share/man/man4/wd.4 +++ b/share/man/man4/wd.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: wd.4,v 1.6 2000/04/21 15:38:18 aaron Exp $ +.\" $OpenBSD: wd.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: wd.4,v 1.4 1999/04/25 00:00:05 mjl Exp $ .\" .\" Copyright (c) 1994 James A. Jegers @@ -46,8 +46,9 @@ mode settings (like some controllers). The lowest order (rightmost) nibble of the .Cm flags -define the PIO mode to use. The next four bits indicate the DMA mode and the -third nibble the UltraDMA mode. +define the PIO mode to use. +The next four bits indicate the DMA mode and the third nibble the UltraDMA +mode. .Pp For each set of four bits, the 3 lower bits define the mode to use and the last bit must be set to 1 for this setting to be used. diff --git a/share/man/man4/wdc.4 b/share/man/man4/wdc.4 index 6efbf2472de..46516ed3b23 100644 --- a/share/man/man4/wdc.4 +++ b/share/man/man4/wdc.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: wdc.4,v 1.4 2001/07/06 18:08:56 deraadt Exp $ +.\" $OpenBSD: wdc.4,v 1.5 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: wdc.4,v 1.4 1999/05/19 14:44:02 bouyer Exp $ .\" .\" Copyright (c) 1998 Manuel Bouyer. @@ -51,8 +51,10 @@ driver provides the basic functions for the .Xr wd 4 and .Xr atapiscsi 4 -drivers. It supports IDE and EIDE controllers, as well as MFM, RLL, and ESDI on -the ISA bus. PCI IDE controllers in legacy mode are also supported, but the +drivers. +It supports IDE and EIDE controllers, as well as MFM, RLL, and ESDI on +the ISA bus. +PCI IDE controllers in legacy mode are also supported, but the .Xr pciide 4 driver may provide more functionality. .Pp diff --git a/share/man/man4/we.4 b/share/man/man4/we.4 index 12a4e628212..f8105aa28bf 100644 --- a/share/man/man4/we.4 +++ b/share/man/man4/we.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: we.4,v 1.6 2001/08/20 05:57:55 mpech Exp $ +.\" $OpenBSD: we.4,v 1.7 2001/10/05 14:45:53 mpech Exp $ .\" $NetBSD: we.4,v 1.4 1998/08/09 00:39:02 thorpej Exp $ .\" .\" Copyright (c) 1997 The NetBSD Foundation, Inc. @@ -54,20 +54,24 @@ device driver supports Western Digital/SMC WD80x3, SMC Elite Ultra, and SMC EtherEZ Ethernet cards. .Sh MEDIA SELECTION The ability to select media from software is dependent on the particular -model of WD/SMC card. The following models support only manual configuration: -WD8003S, WD8003E, and WD8013EBT. +model of WD/SMC card. +The following models support only manual configuration: WD8003S, WD8003E, +and WD8013EBT. .Pp Other WD/SMC 80x3 interfaces support two types of media on a single card. -All support the AUI media type. The other media is either BNC or UTP -being a transceiver. Software cannot differentiate between BNC and UTP -cards. On some models, the AUI port is always active. +All support the AUI media type. +The other media is either BNC or UTP being a transceiver. +Software cannot differentiate between BNC and UTP cards. +On some models, the AUI port is always active. .Pp The SMC Elite Ultra and SMC EtherEZ interfaces support three media on -a single card: AUI, BNC, and UTP. If the transceiver is active, the BNC -media is selected. Otherwise, the AUI and UTP ports are both active. +a single card: AUI, BNC, and UTP. +If the transceiver is active, the BNC media is selected. +Otherwise, the AUI and UTP ports are both active. Cards of this vintage may also be found which lack one or two of the -connectors. These cards also know what interrupt they are configured -for, and will correct such problems (for further interrupt issues, see +connectors. +These cards also know what interrupt they are configured for, and will +correct such problems (for further interrupt issues, see .Xr isa 4 and .Xr pci 4 ) . @@ -87,7 +91,8 @@ or media type with .Xr ifconfig 8 's .Sq media -directive. To select the other media (transceiver), select the +directive. +To select the other media (transceiver), select the .Em 10base2 or .Em bnc @@ -96,15 +101,17 @@ media type. .Bl -diag .It "we0: overriding IRQ <n> to <m>" The IRQ specified in the kernel configuration file is different from that -found in the card's configuration registers. The value in the kernel -configuration file is being overridden by the one configured into the card. +found in the card's configuration registers. +The value in the kernel configuration file is being overridden by the one +configured into the card. .It "we0: can't wildcard IRQ on a <model>" The IRQ was wildcarded in the kernel configuration file, and the card is a WD8003S, WD8003E, or WD8013EBT, which do not support software IRQ configuration. .It "we0: failed to clear shared memory at offset <off>" The memory test was unable to clear shared the interface's shared memory -region. This often indicates that the card is configured at a conflicting +region. +This often indicates that the card is configured at a conflicting .Em iomem address. .El diff --git a/share/man/man4/wi.4 b/share/man/man4/wi.4 index 5358ef04f93..0a4271b0d90 100644 --- a/share/man/man4/wi.4 +++ b/share/man/man4/wi.4 @@ -1,4 +1,4 @@ -.\" $OpenBSD: wi.4,v 1.15 2001/08/19 20:55:02 miod Exp $ +.\" $OpenBSD: wi.4,v 1.16 2001/10/05 14:45:53 mpech Exp $ .\" .\" Copyright (c) 1997, 1998, 1999 .\" Bill Paul <wpaul@ctr.columbia.edu>. All rights reserved. @@ -71,10 +71,11 @@ The compatible cards supported are: .Pp Note that while Lucent sells PCI, ISA and PCMCIA WaveLAN/IEEE devices, the PCI and ISA products are actually a PCMCIA card in a -PCMCIA bridge adapter. Consequently, the +PCMCIA bridge adapter. +Consequently, the .Nm -driver is required for PCI, ISA and PCMCIA NICs. The original -WaveLAN/IEEE cards (2Mbps), the WaveLAN/IEEE Turbo (6Mbps), the +driver is required for PCI, ISA and PCMCIA NICs. +The original WaveLAN/IEEE cards (2Mbps), the WaveLAN/IEEE Turbo (6Mbps), the WaveLAN/IEEE Bronze Turbo (8Mbps), and the WaveLAN/IEEE Silver/Gold (11Mbps) adapters are supported. .Pp @@ -99,8 +100,8 @@ Also note that some of the PRISM-II adapters only work at 3.3V, hence support is required for those cards to set VCC correctly, even though they are really 16bit cards. .Pp -The core of the WaveLAN/IEEE is the Lucent Hermes controller. All -host/device interaction is via programmed I/O with the Hermes. +The core of the WaveLAN/IEEE is the Lucent Hermes controller. +All host/device interaction is via programmed I/O with the Hermes. The Hermes supports 802.11 and 802.3 frames, power management, BSS, WDS and ad-hoc operation modes. .Pp diff --git a/share/man/man5/bsd.port.mk.5 b/share/man/man5/bsd.port.mk.5 index 331aa933957..1f0d94bd3f9 100644 --- a/share/man/man5/bsd.port.mk.5 +++ b/share/man/man5/bsd.port.mk.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: bsd.port.mk.5,v 1.52 2001/10/04 10:28:20 wilfried Exp $ +.\" $OpenBSD: bsd.port.mk.5,v 1.53 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 2000 Marc Espie .\" @@ -251,7 +251,8 @@ Invoked as make show=name, show the contents of variable name. .It Ev ALLFILES List of all files that need to be retrieved by .Ar fetch , -with master site selection extension removed. Read-only. +with master site selection extension removed. +Read-only. .It Ev ALL_TARGET Target used to build software. Default is @@ -847,7 +848,8 @@ checksum off ftp.openbsd.org, in the directory See BUILD_DEPENDS for specification. Regress dependencies are only checked if the regress stage is invoked. .It Ev REGRESS_TARGET -Target to run regression tests. Defaults to +Target to run regression tests. +Defaults to .Sq regress , except for .Sq perl @@ -917,7 +919,8 @@ Add other variables as needed. .It Ev SUPDISTFILES Supplementary files that need to be retrieved under some specific -circumstances. For instance, a port might need architecture-specific files. +circumstances. +For instance, a port might need architecture-specific files. .Ev SUPDISTFILES should hold a list of all distfiles and patchfiles that are not always needed, so that a mirror will be able to grab all files, or that diff --git a/share/man/man5/login.conf.5 b/share/man/man5/login.conf.5 index 8f94b84df0c..d53872ab9f5 100644 --- a/share/man/man5/login.conf.5 +++ b/share/man/man5/login.conf.5 @@ -30,7 +30,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $OpenBSD: login.conf.5,v 1.13 2001/08/20 05:57:55 mpech Exp $ +.\" $OpenBSD: login.conf.5,v 1.14 2001/10/05 14:45:54 mpech Exp $ .\" BSDI $From: login.conf.5,v 2.20 2000/06/26 14:50:38 prb Exp $ .\" .Dd June 18, 2001 @@ -231,8 +231,8 @@ Maximum number of open files per process. Length of time a password may be expired but not quite dead yet. When set (for both the client and remote server machine when doing remote authentication), a user is allowed to log in just one more -time after their password (but not account) has expired. This allows -a grace period for updating their password. +time after their password (but not account) has expired. +This allows a grace period for updating their password. .\" .sp .It password-warn Ta time Ta Dv 2w Ta @@ -405,24 +405,29 @@ For example, to indicate 1 and 1/2 hours, the following string could be used: .\" .Sh AUTHENTICATION \*(oSuses BSD Authentication, which is made up of a variety of -authentication styles. The authentication styles currently provided are: +authentication styles. +The authentication styles currently provided are: .Bl -tag -width kerberosxx .\" .It Li activ -Authenticate using an ActivCard token. See +Authenticate using an ActivCard token. +See .Xr login_activ 8 . .\" .It Li auth Authenticate using the remote authentication protocol. -Normally linked to another authentication type. See +Normally linked to another authentication type. +See .Xr login_auth 8 . .\" .It Li chpass -Change user's password. See +Change user's password. +See .Xr login_chpass 8 . .\" .It Li crypto -Authenticate using a CRYPTOCard token. See +Authenticate using a CRYPTOCard token. +See .Xr login_crypto 8 . .\" .It Li kerberos @@ -440,7 +445,8 @@ See .Xr kerberos 1 . .\" .It Li lchpass -Change user's local password. See +Change user's local password. +See .Xr login_chpass 8 . .\" .It Li passwd @@ -448,15 +454,18 @@ Request a password and check it against the password in the master.passwd file. .\" .It Li radius Normally linked to another authentication type, contact the radius server -to do authentication. See +to do authentication. +See .Xr login_radius 8 . .\" .It Li rchpass -Change user's rpasswd password. See +Change user's rpasswd password. +See .Xr login_rchpass 8 . .\" .It Li reject -Request a password and reject any request. See +Request a password and reject any request. +See .Xr login_reject 8 . .\" .It Li rpasswd @@ -464,20 +473,24 @@ Request a password and check it against the password in the rpasswd.db file. .\" .It Li skey Send a challenge and request a response, checking it -with S/Key\(tm authentication. See +with S/Key\(tm authentication. +See .Xr skey 1 . .\" .It Li snk -Authenticate using a SecureNet Key token. See +Authenticate using a SecureNet Key token. +See .Xr login_snk 8 . .\" .It Li token -Authenticate using a generic X9.9 token. See +Authenticate using a generic X9.9 token. +See .Xr login_token 8 . .El .Pp Local authentication styles may be added by creating the login script -for the style (see below). To prevent collisions with future official BSD +for the style (see below). +To prevent collisions with future official BSD Authentication style names all local style names should start with a dash (-). Current plans are for all official BSD Authentication style names to begin with a lower case alphabetic character. @@ -542,7 +555,7 @@ Users may enter usernames of the form to optionally specify the authentication style.) The requesting program may also specify the type of authentication that will be done. -Most programs will only have a single type, if any at all, i.e. +Most programs will only have a single type, if any at all, i.e., .Xr ftpd 8 will always request the .Li ftp @@ -598,7 +611,8 @@ The synopsis of this program is: The .Fl v option is used to specify arbitrary information to the authentication -programs. Any number of +programs. +Any number of .Fl v options may be used. The @@ -668,8 +682,9 @@ The user has been authorized. .\" .It Li authorize secure The user has been authorized and root should be allowed to -login even if this is not a secure terminal. This should only be -sent by authentication styles that are secure over insecure lines. +login even if this is not a secure terminal. +This should only be sent by authentication styles that are secure +over insecure lines. .\" .It Li reject Authorization is rejected. @@ -736,8 +751,8 @@ The following values are currently defined: .It Li challenge See section on challenges below. .It Li errormsg -If set, the value is the reason authentication failed. The calling -program may choose to display this when rejecting the user, but +If set, the value is the reason authentication failed. +The calling program may choose to display this when rejecting the user, but display is not required. .El .El @@ -751,9 +766,10 @@ or statement on file descriptor 3. .Pp An authentication program must not assume it will be called as root, -nor must it assume it will not be called as root. If it needs special -permissions to access files it should be setuid or setgid to the -appropriate user/group. See +nor must it assume it will not be called as root. +If it needs special permissions to access files it should be setuid or +setgid to the appropriate user/group. +See .Xr chmod 1 . .Sh CHALLENGES When an authentication program is called with a service of @@ -763,8 +779,8 @@ it should do one of three things: If this style of authentication supports challenge response it should set the internal variable .Li challenge -to be the appropriate challenge for the user. This is done -by the +to be the appropriate challenge for the user. +This is done by the .Li value command listed above. The program should also issue a diff --git a/share/man/man5/nat.conf.5 b/share/man/man5/nat.conf.5 index 1008d362a28..e9c7fbb7ba6 100644 --- a/share/man/man5/nat.conf.5 +++ b/share/man/man5/nat.conf.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: nat.conf.5,v 1.14 2001/10/04 10:28:20 wilfried Exp $ +.\" $OpenBSD: nat.conf.5,v 1.15 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 2001 Ian Darwin. All rights reserved. .\" @@ -122,8 +122,8 @@ when they are going out any interface except vlan12. This has the net effect of making traffic from the 192.168.168.0/24 network appear as though it is the Internet routeable address 204.92.77.111 to nodes behind any interface on the router except -for the nodes on vlan12. (Thus, 192.168.168.1 can talk to the -192.168.168.0/24 nodes.) +for the nodes on vlan12. +(Thus, 192.168.168.1 can talk to the 192.168.168.0/24 nodes.) .Bd -literal nat on ! vlan12 from 192.168.168.0/24 to any -> 204.92.77.111 .Ed @@ -136,14 +136,16 @@ nat on fxp1 from 144.19.74/24 to any -> 204.92.77.100 .Pp In the example below, fxp0 is the outside interface; a 1:1 bidirectional map is created between the private address 192.168.1.5 -and the routable external address 204.92.77.113. (Thus, incoming -traffic to 204.92.77.113 is mapped to the internal address 192.168.1.5.) +and the routable external address 204.92.77.113. +(Thus, incoming traffic to 204.92.77.113 is mapped to the internal +address 192.168.1.5.) .Bd -literal binat on fxp0 from 192.168.1.5 to any -> 204.92.77.113 .Ed .Pp -This longer example uses both a NAT and a redirection. Interface -kue0 is the outside interface, and its external address is 157.161.48.183. +This longer example uses both a NAT and a redirection. +Interface kue0 is the outside interface, and its external address is +157.161.48.183. Interface fxp0 is the inside interface, and we are running .Xr ftp-proxy 8 listening for outbound ftp sessions captured to port 8081. diff --git a/share/man/man5/pf.conf.5 b/share/man/man5/pf.conf.5 index b0c184a4f40..497e49179fa 100644 --- a/share/man/man5/pf.conf.5 +++ b/share/man/man5/pf.conf.5 @@ -1,4 +1,4 @@ -.\" $OpenBSD: pf.conf.5,v 1.19 2001/10/01 19:04:16 dhartmei Exp $ +.\" $OpenBSD: pf.conf.5,v 1.20 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 2001, Daniel Hartmeier .\" All rights reserved. @@ -140,13 +140,15 @@ the connection. .Pp The logged packets are sent to the .Em pflog0 -interface. This interfece is monitored by +interface. +This interfece is monitored by .Xr pflogd 8 logging daemon which dumps the logged packets to the file .Em /var/log/pflog in .Xr tcpdump 8 -binary format. The log files can be read using tcpdump: +binary format. +The log files can be read using tcpdump: .Bd -literal .Cm # tcpdump -n -e -ttt -r /var/log/pflog .Ed @@ -228,7 +230,8 @@ This is more restrictive than the previous example. .It Em flags S If the second set is not specified, it defaults to FSRPAU. Hence, only packets with SYN set and all other flags unset match this -rule. This is more restrictive than the previous example. +rule. +This is more restrictive than the previous example. .It Em flags /SFRA If the first set is not specified, it defaults to none. All of SYN, FIN, RST and ACK must be unset. @@ -335,11 +338,11 @@ see implicitely create state for connections. .Sh STATE MODULATION Much of the security derived from TCP is attributable to how well the -initial sequence numbers (ISN) are chosen. Some popular stack implementations -choose +initial sequence numbers (ISN) are chosen. +Some popular stack implementations choose .Cm very -poor ISNs thus are normally susceptible to ISN prediction exploits. By -applying a "modulate state" rule to a TCP connection, +poor ISNs thus are normally susceptible to ISN prediction exploits. +By applying a "modulate state" rule to a TCP connection, .Em pf will create a high quality random sequence number for each connection endpoint. @@ -364,13 +367,13 @@ connection. .Pp Caveat: If the state table is flushed or the firewall is rebooted, currently established modulated connections can not be continued or picked -up again by the firewall. The sequence numbers will be out of sync without -the modulator. - +up again by the firewall. +The sequence numbers will be out of sync without the modulator. .Sh NORMALIZATION Packet normalization is envoked via the .Pa scrub -directive. Normalization is used to sanitize packet content in such +directive. +Normalization is used to sanitize packet content in such a way that there are no ambiguities in packet interpretation on the receiver side. .Pp diff --git a/share/man/man7/hostname.7 b/share/man/man7/hostname.7 index ff009ebf124..47e539f1df2 100644 --- a/share/man/man7/hostname.7 +++ b/share/man/man7/hostname.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: hostname.7,v 1.5 2000/03/04 22:19:33 aaron Exp $ +.\" $OpenBSD: hostname.7,v 1.6 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: hostname.7,v 1.4 1994/11/30 19:07:14 jtc Exp $ .\" .\" Copyright (c) 1987, 1990, 1993 @@ -56,7 +56,7 @@ which must generally translate the name to an address for use. Hostnames are resolved by the Internet name resolver in the following fashion. .Pp -If the name consists of a single component, i.e. contains no dot, +If the name consists of a single component, i.e., contains no dot, and if the environment variable .Ev HOSTALIASES is set to the name of a file, diff --git a/share/man/man7/mdoc.7 b/share/man/man7/mdoc.7 index 75d5fb7308c..cc82b147b74 100644 --- a/share/man/man7/mdoc.7 +++ b/share/man/man7/mdoc.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mdoc.7,v 1.21 2001/08/02 18:00:10 millert Exp $ +.\" $OpenBSD: mdoc.7,v 1.22 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -87,7 +87,8 @@ Section Headers. Valid headers, in the order of presentation: .Bl -tag -width "RETURN VALUES" -compact .It Ar NAME -Name section. Should include the +Name section. +Should include the .Ql \&.Nm or .Ql \&.Fn diff --git a/share/man/man7/mdoc.samples.7 b/share/man/man7/mdoc.samples.7 index b785ad6b1fb..46db9fce7a7 100644 --- a/share/man/man7/mdoc.samples.7 +++ b/share/man/man7/mdoc.samples.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mdoc.samples.7,v 1.32 2001/08/06 10:08:24 mpech Exp $ +.\" $OpenBSD: mdoc.samples.7,v 1.33 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: mdoc.samples.7,v 1.5 1996/04/03 20:17:34 jtc Exp $ .\" .\" Copyright (c) 1990, 1993 @@ -2374,8 +2374,9 @@ may have an offset specifier for indentation: .It Fl ragged Fill, but do not adjust the right margin. .It Fl unfilled -Do not fill. Display a block of text as typed. The right (and left) margin -edges are left ragged. +Do not fill. +Display a block of text as typed. +The right (and left) margin edges are left ragged. .It Fl filled Display a filled (formatted) block. The block of text is formatted (the edges are filled, diff --git a/share/man/man7/mirroring-ports.7 b/share/man/man7/mirroring-ports.7 index 25543ac6c9f..2342b91717c 100644 --- a/share/man/man7/mirroring-ports.7 +++ b/share/man/man7/mirroring-ports.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: mirroring-ports.7,v 1.5 2001/03/01 16:11:22 aaron Exp $ +.\" $OpenBSD: mirroring-ports.7,v 1.6 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 2000 Marc Espie .\" @@ -167,21 +167,23 @@ directory. Changing checksums is a recurring problem that is outside the direct control of the .Ox -Project. Some software distributors change distribution files without -warning, without changing the file name proper. Once the problem has been -identified, the port maintainer should usually contact the software author -to fix the problem, or, if the software author is unresponsive, the -maintainer should use +Project. +Some software distributors change distribution files without +warning, without changing the file name proper. +Once the problem has been identified, the port maintainer should usually +contact the software author to fix the problem, or, if the software author +is unresponsive, the maintainer should use .Ev DIST_SUBDIR to provide some state to guard against shifting checksums. .Pp However, a more robust approach is also needed, so that ports users can depend on distfiles mirrors to carry what they need irregardless of those -synchronization issues. The +synchronization issues. +The .Pa link-checksums script creates another access to the distfiles, indexed through the actual -checksums that the files should match. Provided mirroring is run -sufficiently often, together with +checksums that the files should match. +Provided mirroring is run sufficiently often, together with .Pa link-checksums , two versions of the same distfile with respective checksums cksum1 and cksum2 will be available under the names diff --git a/share/man/man7/packages-specs.7 b/share/man/man7/packages-specs.7 index 23e9ad3201e..31f83d1d826 100644 --- a/share/man/man7/packages-specs.7 +++ b/share/man/man7/packages-specs.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: packages-specs.7,v 1.2 2001/07/16 00:27:02 espie Exp $ +.\" $OpenBSD: packages-specs.7,v 1.3 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 2001 Marc Espie .\" @@ -84,8 +84,8 @@ start with a digit. Usually, flavored packages are slightly different versions of the same package that offer very similar functionalities. .Sh CONFLICTS -Most conflicts between packages are handled on a package name basis. Unless -the packages have been specially prepared, it is +Most conflicts between packages are handled on a package name basis. +Unless the packages have been specially prepared, it is normally not possible to install two packages with the same .Ar stem . .Pp @@ -93,7 +93,8 @@ Note that the .Ar stem ends at the .Ar version -part. So, for instance, +part. +So, for instance, .Qq kdelibs-1.1.2 and .Qq kdelibs-2.1.1 @@ -138,7 +139,8 @@ and 1.5. .Pp If the flavor specification is left blank, any flavor will do. Note that most default package names don't contain flavor specification, -which means that any flavor will do. For instance, in +which means that any flavor will do. +For instance, in .Bd -literal -offset indent LIB_DEPENDS=aa.1.2::graphics/aalib .Ed diff --git a/share/man/man7/packages.7 b/share/man/man7/packages.7 index c8400e23843..4926231c478 100644 --- a/share/man/man7/packages.7 +++ b/share/man/man7/packages.7 @@ -1,4 +1,4 @@ -.\" $OpenBSD: packages.7,v 1.12 2001/10/04 16:56:52 mpech Exp $ +.\" $OpenBSD: packages.7,v 1.13 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 2000 Marc Espie .\" @@ -52,7 +52,8 @@ The packages are not as thoroughly audited as the main .Ox source tree (in many cases, they have not been audited at all). This is in part a scale issue: the source tree is under 100MB, compressed, -whereas source to the ports tree approaches 600MB. Also, most +whereas source to the ports tree approaches 600MB. +Also, most .Ox developers concentrate on making the release as safe as possible and, correspondingly, human resources for the ports tree are somewhat lacking. @@ -112,7 +113,8 @@ Bear in mind that the package database is normally stored in /var/db/pkg, which is usually not shared across machines. .Pp Always installing packages on the same machine, and exporting /usr/local -to other machines should mostly work. In such a case, always run +to other machines should mostly work. +In such a case, always run .Xr pkg_add 1 in .Qq "verbose, don't actually install the package" diff --git a/share/man/man8/afterboot.8 b/share/man/man8/afterboot.8 index de85cbf825d..5829150c004 100644 --- a/share/man/man8/afterboot.8 +++ b/share/man/man8/afterboot.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: afterboot.8,v 1.63 2001/10/04 16:56:52 mpech Exp $ +.\" $OpenBSD: afterboot.8,v 1.64 2001/10/05 14:45:54 mpech Exp $ .Dd October 20, 1997 .Dt AFTERBOOT 8 \!\" Originally created by Marshall M. Midden -- 1997-10-20, m4@umn.edu @@ -389,9 +389,9 @@ Note that the .Pa /etc/motd file is modified by .Pa /etc/rc -whenever the system is booted. To keep any custom message intact, ensure -that you leave two blank lines at the top, or your message will be -overwritten. +whenever the system is booted. +To keep any custom message intact, ensure that you leave two blank lines +at the top, or your message will be overwritten. .Ss Add new users Add users. There is an @@ -510,11 +510,12 @@ To cause sendmail to accept network connections, modify the variable in .Pa /etc/rc.conf in accordance with the comments therein. -Note that sendmail now also listens on port 587 by default. This -is to implement the RFC2476 message submission protocol. You may -disable this via the +Note that sendmail now also listens on port 587 by default. +This is to implement the RFC2476 message submission protocol. +You may disable this via the .Dq no_default_msa -option in your sendmail .mc file. See +option in your sendmail .mc file. +See .Pa /usr/share/sendmail/README for more information. .Ss DHCP server @@ -582,8 +583,8 @@ filling up disk space from normal running processes and database updates. (You probably do not need to understand them.) .Pp The /altroot filesystem can optionally be used to provide a backup of the -root filesystem on a daily basis. To take advantage of this, you must -have an entry in +root filesystem on a daily basis. +To take advantage of this, you must have an entry in .Pa /etc/fstab with .Dq xx diff --git a/share/man/man8/boot_config.8 b/share/man/man8/boot_config.8 index 28f9efba581..80c11d91576 100644 --- a/share/man/man8/boot_config.8 +++ b/share/man/man8/boot_config.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: boot_config.8,v 1.16 2001/08/17 11:13:58 mpech Exp $ +.\" $OpenBSD: boot_config.8,v 1.17 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1996 Mats O Jansson .\" All rights reserved. @@ -121,10 +121,11 @@ driver. UKC> .Ed .Pp -ne1 seems to match the configuration except it uses IRQ 5 instead of IRQ 10. So -the irq on ne1 should be changed via the +ne1 seems to match the configuration except it uses IRQ 5 instead of IRQ 10. +So the irq on ne1 should be changed via the .Fa change -command. The device can be specified by either name or number. +command. +The device can be specified by either name or number. .Pp .Bd -literal .No UKC> Ic change ne1 @@ -146,8 +147,8 @@ UKC> Another case is a mistakenly detected non-existing device instead of another device at the probed location. One known case is the Mitsumi -CD-ROM in OpenBSD/i386. The simplest thing to solve that problem is to -disable mcd0. +CD-ROM in OpenBSD/i386. +The simplest thing to solve that problem is to disable mcd0. .Pp .Bd -literal .No UKC> Ic find mcd0 @@ -178,7 +179,8 @@ UKC> .Ed .Pp It is possible to add new devices, but only devices that were linked into the -kernel. If a new device is added, following devices will be renumbered. +kernel. +If a new device is added, following devices will be renumbered. .Pp .Bd -literal .No UKC> Ic find ep diff --git a/share/man/man8/compat_bsdos.8 b/share/man/man8/compat_bsdos.8 index 62503c8a049..1e19b26357a 100644 --- a/share/man/man8/compat_bsdos.8 +++ b/share/man/man8/compat_bsdos.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: compat_bsdos.8,v 1.4 2001/08/17 11:13:58 mpech Exp $ +.\" $OpenBSD: compat_bsdos.8,v 1.5 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1997, Jason Downs. All rights reserved. .\" @@ -53,7 +53,8 @@ follows the standard .Dq emul filesystem scheme, using .Pa /emul/bsdos -as the prefix. This means that all BSDI executables first look in +as the prefix. +This means that all BSDI executables first look in .Pa /emul/bsdos whenever opening a file; configuration information, shared library images, etc., for BSDI binaries should all be installed under the emulation @@ -65,13 +66,14 @@ Although many commercial BSDI binaries are compiled/linked with the BSDI .\" no .Xr here because we don't have junk like shlicc. .Nm shlicc -program require the appropriate shared library images. These may be -found in the +program require the appropriate shared library images. +These may be found in the .Pa /shlib directory on a BSDI system, and must be copied to .Pa /emul/bsdos/shlib -in order for such binaries to work. The user is responsible for having -the appropriate BSDI licenses in order to use the shared library images. +in order for such binaries to work. +The user is responsible for having the appropriate BSDI licenses in order +to use the shared library images. .Sh BUGS If BSDI ever manages to port their system to more architectures or switch to real dynamically linked libraries these instructions may have to change. diff --git a/share/man/man8/compat_freebsd.8 b/share/man/man8/compat_freebsd.8 index 3dd260d8d29..4e308cc49e0 100644 --- a/share/man/man8/compat_freebsd.8 +++ b/share/man/man8/compat_freebsd.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: compat_freebsd.8,v 1.8 2001/08/17 11:13:58 mpech Exp $ +.\" $OpenBSD: compat_freebsd.8,v 1.9 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: compat_linux.8,v 1.1 1995/03/05 23:30:36 fvdl Exp $ .\" .\" Copyright (c) 1995 Frank van der Linden @@ -55,8 +55,8 @@ with the .Nm COMPAT_FREEBSD option enabled. .Pp -A lot of programs are dynamically linked. This means, that you will -also need the +A lot of programs are dynamically linked. +This means, that you will also need the .Fx shared libraries that the program depends on, and the runtime linker. Also, you will need to create a "shadow root" directory for @@ -115,7 +115,8 @@ Install the port named .Nm freebsd_lib in the .Nm emulators -category. The +category. +The .Nm freebsd_lib port contains the shared libraries, binaries, and other related files necessary to run @@ -151,8 +152,8 @@ system you have access to, and check which shared libraries it needs by running .El .Pp You would need go get all the files from the last column, and -put them under /emul/freebsd. This means you eventually have -these files on your +put them under /emul/freebsd. +This means you eventually have these files on your .Ox system: .Pp @@ -171,7 +172,8 @@ column of the 'ldd' output, you won't need to copy the file named in the last column to your system, the one you already have should work. It is advisable to copy the shared library anyway if it is a newer version, though. -You can remove the old one. So, if you have these libraries on your system: +You can remove the old one. +So, if you have these libraries on your system: .Pp .nf /emul/freebsd/usr/lib/libc.so.2.0 @@ -298,7 +300,8 @@ of shared libraries that the program depends on, in the form -l<majorname> => <fullname>. .Pp If it prints "not found" instead of <fullname> it means that -you need an extra library. Which library this is, is shown +you need an extra library. +Which library this is, is shown in <majorname>, which will be of the form XXXX.<N> You will need to find a libXXXX.so.<N>.<mm> on a .Fx @@ -320,8 +323,8 @@ distribution is available on a lot of ftp sites. Sometimes the files are unpacked, and you can get the individual files you need, but mostly they are stored in distribution sets, usually consisting of subdirectories -with gzipped tar files in them. The primary ftp sites for the -distributions are: +with gzipped tar files in them. +The primary ftp sites for the distributions are: .Pp .nf ftp.freebsd.org:/pub/FreeBSD @@ -335,9 +338,11 @@ ftp.freebsd.org:/pub/FreeBSD/MIRROR.SITES .Pp This distribution consists of a number of tar-ed and gzipped files, Normally, they're controlled by an install program, but you can -retrieve files "by hand" too. The way to look something up is to retrieve all +retrieve files "by hand" too. +The way to look something up is to retrieve all the files in the distribution, and ``tar ztvf'' through them for the file -you need. Here is an example of a list of files that you might need. +you need. +Here is an example of a list of files that you might need. .Pp .Bd -unfilled -offset indent Needed Files diff --git a/share/man/man8/compat_ibcs2.8 b/share/man/man8/compat_ibcs2.8 index 29af1686ff8..519b9ce28ad 100644 --- a/share/man/man8/compat_ibcs2.8 +++ b/share/man/man8/compat_ibcs2.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: compat_ibcs2.8,v 1.7 2001/08/17 11:13:58 mpech Exp $ +.\" $OpenBSD: compat_ibcs2.8,v 1.8 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1998 Scott Bartram .\" Copyright (c) 1995 Frank van der Linden @@ -41,18 +41,20 @@ .Sh DESCRIPTION .Ox supports running Intel Binary Compatibility Standard 2 (iBCS2) -binaries. This only applies to i386 systems for now. Binaries -are supported from SCO UNIX and other systems derived from UNIX -System V Release 3. iBCS2 support is only well tested using SCO -binaries. XENIX binaries are also supported although not as well -tested. SVR4 binaries are supported by the +binaries. +This only applies to i386 systems for now. +Binaries are supported from SCO UNIX and other systems derived from UNIX +System V Release 3. +iBCS2 support is only well tested using SCO binaries. +XENIX binaries are also supported although not as well tested. +SVR4 binaries are supported by the .Dv COMPAT_SVR4 option. .Pp -iBCS2 supports COFF, ELF, and x.out (XENIX) binary formats. Binaries -from SCO OpenServer (version 5.x) are the only ELF binaries that have -been tested. Most programs should work, but not ones that use or -depend on: +iBCS2 supports COFF, ELF, and x.out (XENIX) binary formats. +Binaries from SCO OpenServer (version 5.x) are the only ELF binaries +that have been tested. +Most programs should work, but not ones that use or depend on: .sp .Bl -tag -width 123 -compact -offset indent .It kernel internal data structures @@ -67,24 +69,27 @@ depend on: The iBCS2 compatibility feature is active for kernels compiled with the .Dv COMPAT_IBCS2 -option enabled. If support for iBCS2 ELF executables is desired, +option enabled. +If support for iBCS2 ELF executables is desired, the .Dv EXEC_ELF32 option should be enabled in addition to .Dv COMPAT_IBCS2 . .Pp Many COFF-format programs and most ELF-format programs are dynamically -linked. This means that you will also need the shared libraries that -the program depends on. Also, you will need to create a "shadow root" -directory for iBCS2 binaries on your +linked. +This means that you will also need the shared libraries that the program +depends on. +Also, you will need to create a "shadow root" directory for iBCS2 binaries +on your .Ox system. This directory is named /emul/ibcs2. Any file operations done by iBCS2 programs run under .Ox -will look in this directory first. So, if an iBCS2 -program opens, for example, /etc/passwd, +will look in this directory first. +So, if an iBCS2 program opens, for example, /etc/passwd, .Ox will first try to open /emul/ibcs2/etc/passwd, and if that does not exist open the 'real' /etc/passwd file. @@ -106,17 +111,19 @@ any extra work. .Ss Setting up shared libraries How to get to know which shared libraries iBCS2 binaries need, and -where to get them? Depending on the file type of the executable, there -are different possibilities (when following these instructions: you -will need to be root on your +where to get them? +Depending on the file type of the executable, there are different +possibilities (when following these instructions: you will need to be +root on your .Ox system to do the necessary installation steps). - +.Pp .Bl -tag -width 123 -compact .It 1. COFF binaries You can simply copy all of the available shared libraries since they -are fairly small in size. The COFF shared libraries are typically -found in /shlib and can be obtained from the following sources: +are fairly small in size. +The COFF shared libraries are typically found in /shlib and can be +obtained from the following sources: .sp .nf SCO UNIX version 3.x (aka ODT) @@ -151,11 +158,12 @@ following files on your system: .Pp .El If you don't have access to a SCO system, you will need to get the -extra files you need from a SCO distribution. As of January 1998, SCO -sells a copy of SCO OpenServer (iBCS2) and/or SCO UnixWare (SVR4) for -personal/non-commercial use for only the cost of shipping (about -$20US). The distribution comes on an ISO9660-format CDROM which can be -mounted and used to copy the necessary files. +extra files you need from a SCO distribution. +As of January 1998, SCO sells a copy of SCO OpenServer (iBCS2) and/or +SCO UnixWare (SVR4) for personal/non-commercial use for only the cost +of shipping (about $20US). +The distribution comes on an ISO9660-format CDROM which can be mounted +and used to copy the necessary files. .Sh BUGS The information about SCO distributions may become outdated. .Pp diff --git a/share/man/man8/compat_linux.8 b/share/man/man8/compat_linux.8 index a68d1e9cef6..5b8158d694c 100644 --- a/share/man/man8/compat_linux.8 +++ b/share/man/man8/compat_linux.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: compat_linux.8,v 1.19 2001/10/04 16:56:52 mpech Exp $ +.\" $OpenBSD: compat_linux.8,v 1.20 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: compat_linux.8,v 1.2 1995/10/16 20:17:59 fvdl Exp $ .\" .\" Copyright (c) 1995 Frank van der Linden @@ -38,12 +38,14 @@ .Nd setup procedure for running Linux binaries under emulation .Sh DESCRIPTION .Ox -supports running Linux binaries. This only applies to i386 systems -for now. Both the a.out and ELF binary formats are supported. Most programs -should work, including the ones that use the Linux SVGAlib. Additionally, -OSS audio is emulated, so Linux bins can access the native audio -transparently. Programs that will not work include those that use the Linux -/proc filesystem (which is different from the optional +supports running Linux binaries. +This only applies to i386 systems for now. +Both the a.out and ELF binary formats are supported. +Most programs should work, including the ones that use the Linux SVGAlib. +Additionally, OSS audio is emulated, so Linux bins can access the native audio +transparently. +Programs that will not work include those that use the Linux /proc filesystem +(which is different from the optional .Ox /proc filesystem), and i386-specific calls, such as enabling virtual 8086 mode. @@ -53,22 +55,23 @@ for kernels compiled with the .Nm COMPAT_LINUX option enabled. .Pp -A lot of programs are dynamically linked. This means, that you will -also need the Linux shared libraries that the program depends on, and -the runtime linker. Also, you will need to create a "shadow root" -directory for Linux binaries on your +A lot of programs are dynamically linked. +This means, that you will also need the Linux shared libraries that +the program depends on, and the runtime linker. +Also, you will need to create a "shadow root" directory for Linux binaries +on your .Ox -system. This directory -is named /emul/linux. Any file operations done by Linux programs -run under +system. +This directory is named /emul/linux. +Any file operations done by Linux programs run under .Ox -will look in this directory first. So, if a Linux -program opens, for example, /etc/passwd, +will look in this directory first. +So, if a Linux program opens, for example, /etc/passwd, .Ox will first try to open /emul/linux/etc/passwd, and if that does not exist -open the 'real' /etc/passwd file. It is recommended that you install -Linux packages that include configuration files, etc under /emul/linux, -to avoid naming conflicts with possible +open the 'real' /etc/passwd file. +It is recommended that you install Linux packages that include configuration +files, etc under /emul/linux, to avoid naming conflicts with possible .Ox counterparts. Shared libraries should also be installed in the shadow tree. @@ -83,28 +86,31 @@ on your system to be able to run newly imported Linux binaries without any extra work. .Ss Setting up shared libraries How to get to know which shared libraries Linux binaries need, and where -to get them? Basically, there are 3 possibilities (when following -these instructions: you will need to be root on your OpenBSD system to -do the necessary installation steps). - +to get them? +Basically, there are 3 possibilities (when following these instructions: +you will need to be root on your OpenBSD system to do the necessary +installation steps). +.Pp .Bl -tag -width 123 -compact .It 1. You have access to the OpenBSD .Xr ports 7 -system. Install the port named +system. +Install the port named .Nm redhat_base in the .Nm emulators -category. The +category. +The .Nm redhat_base port contains the shared libraries, binaries, and other related files -necessary to run Linux applications. Access to a Linux system is not -needed. +necessary to run Linux applications. +Access to a Linux system is not needed. .Pp .It 2. -You have access to a Linux system. In this case you can -temporarily install the binary there, see what shared libraries -it needs, and copy them to your +You have access to a Linux system. +In this case you can temporarily install the binary there, see what +shared libraries it needs, and copy them to your .Ox system. Example: you have just ftp-ed the Linux binary of Doom. @@ -122,8 +128,8 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 .Pp You would need go get all the files from the last column, and put them under /emul/linux, with the names in the first column -as symbolic links pointing to them. This means you eventually have -these files on your +as symbolic links pointing to them. +This means you eventually have these files on your .Ox system: .Pp @@ -139,11 +145,12 @@ system: Note that if you already have a Linux shared library with a matching major revision number to the first column of the 'ldd' output, you won't need to copy the file named in the last column -to your system, the one you already have should work. It is -advisable to copy the shared library anyway if it is a newer version, -though. You can remove the old one, as long as you make the symbolic -link point to the new one. So, if you have these libraries -on your system: +to your system, the one you already have should work. +It is advisable to copy the shared library anyway if it is a newer version, +though. +You can remove the old one, as long as you make the symbolic +link point to the new one. +So, if you have these libraries on your system: .Pp .nf /emul/linux/lib/libc.so.4.6.27 @@ -175,9 +182,9 @@ runtime linker takes care of looking for matching major revision numbers itself, you don't need to worry about that. .Pp Finally, you must make sure that you have the Linux runtime linker -and its config files on your system. You should copy these -files from the Linux system to their appropriate place on your -OpenBSD system (in the /emul/linux tree): +and its config files on your system. +You should copy these files from the Linux system to their appropriate +place on your OpenBSD system (in the /emul/linux tree): .Pp .nf /lib/ld.so @@ -186,10 +193,12 @@ OpenBSD system (in the /emul/linux tree): .fi .Pp .It 3. -You don't have access to a Linux system. In that case, you -should get the extra files you need from various ftp sites. +You don't have access to a Linux system. +In that case, you should get the extra files you need from various +ftp sites. Information on where to look for the various files is appended -below. For now, let's assume you know where to get the files. +below. +For now, let's assume you know where to get the files. .Pp Retrieve the following files (from _one_ ftp site to avoid any version mismatches), and install them under /emul/linux @@ -203,8 +212,8 @@ any version mismatches), and install them under /emul/linux .fi .Pp ldconfig and ldd don't necessarily need to be under /emul/linux, -you can install them elsewhere in the system too. Just make sure -they don't conflict with their +you can install them elsewhere in the system too. +Just make sure they don't conflict with their .Ox counterparts. A good idea would be to install them in /usr/local/bin as ldconfig-linux @@ -212,9 +221,10 @@ and ldd-linux. .Pp Create the file /emul/linux/etc/ld.so.conf, containing the directories in which the Linux runtime linker should look -for shared libs. It is a plain text file, containing a directory -name on each line. /lib and /usr/lib are standard, you could -add the following: +for shared libs. +It is a plain text file, containing a directory +name on each line. +/lib and /usr/lib are standard, you could add the following: .Pp .nf /usr/X11/lib @@ -223,17 +233,19 @@ add the following: .Pp Note that these are mapped to /emul/linux/XXXX by OpenBSD's compat code, and should exist as such on your system. - -Run the Linux ldconfig program. It should be statically -linked, so it doesn't need any shared libraries by itself. +.Pp +Run the Linux ldconfig program. +It should be statically linked, so it doesn't need any shared libraries +by itself. It will create the file /emul/linux/etc/ld.so.cache You should rerun the Linux version of the ldconfig program each time you add a new shared library. .Pp You should now be set up for Linux binaries which only need -a shared libc. You can test this by running the Linux ldd -on itself. Suppose that you have it installed as ldd-linux, it -should produce something like: +a shared libc. +You can test this by running the Linux ldd on itself. +Suppose that you have it installed as ldd-linux, it should produce +something like: .Pp .Bl -tag -width 123 -compact -offset indent .It % ldd-linux `which ldd-linux` @@ -243,8 +255,9 @@ libc.so.4 (DLL Jump 4.5pl26) => /lib/libc.so.4.6.29 This been done, you are ready to install new Linux binaries. Whenever you install a new Linux program, you should check if it needs shared libraries, and if so, whether you have -them installed in the /emul/linux tree. To do this, you run -the Linux version ldd on the new program, and watch its output. +them installed in the /emul/linux tree. +To do this, you run the Linux version ldd on the new program, and +watch its output. ldd (see also the manual page for ldd(1)) will print a list of shared libraries that the program depends on, in the form <majorname> (<jumpversion>) => <fullname>. @@ -253,30 +266,30 @@ If it prints "not found" instead of <fullname> it means that you need an extra library. Which library this is, is shown in <majorname>, which will be of the form libXXXX.so.<N> You will need to find a libXXXX.so.<N>.<mm> on a Linux ftp site, -and install it on your system. The XXXX (name) and <N> (major -revision number) should match; the minor number(s) <mm> are -less important, though it is advised to take the most -recent version. +and install it on your system. +The XXXX (name) and <N> (major revision number) should match; +the minor number(s) <mm> are less important, though it is +advised to take the most recent version. .El .Ss Finding the necessary files. .Nm Note: the information below is valid as of the time this document was written (March, 1995), but certain details such as names of ftp sites, directories and distribution names -may have changed by the time you read this. You can also -save yourself a lot of headaches by using the +may have changed by the time you read this. +You can also save yourself a lot of headaches by using the .Ox .Xr ports 7 system (possibility 3, above). .Pp Linux is distributed by several groups that make their own set -of binaries that they distribute. Each distribution has its own -name, like "Slackware" or "Yggdrasil". The distributions are -available on a lot of ftp sites. Sometimes the files are unpacked, -and you can get the individual files you need, but mostly they -are stored in distribution sets, usually consisting of subdirectories -with gzipped tar files in them. The primary ftp sites for the -distributions are: +of binaries that they distribute. +Each distribution has its own name, like "Slackware" or "Yggdrasil". +The distributions are available on a lot of ftp sites. +Sometimes the files are unpacked, and you can get the individual +files you need, but mostly they are stored in distribution sets, +usually consisting of subdirectories with gzipped tar files in them. +The primary ftp sites for the distributions are: .Pp .nf sunsite.unc.edu:/pub/Linux/distributions @@ -291,17 +304,20 @@ ftp.demon.co.uk:/pub/linux/distributions src.doc.ic.ac.uk:/packages/linux/distributions .fi .Pp -For simplicity, let's concentrate on Slackware here. This distribution -consists of a number of subdirectories, containing separate packages. +For simplicity, let's concentrate on Slackware here. +This distribution consists of a number of subdirectories, containing +separate packages. Normally, they're controlled by an install program, but you can -retrieve files "by hand" too. First of all, you will need to look -in the "contents" subdir of the distribution. You will find -a lot of small textfiles here describing the contents of the separate -packages. The fastest way to look something up is to retrieve all +retrieve files "by hand" too. +First of all, you will need to look in the "contents" subdir of +the distribution. +You will find a lot of small textfiles here describing the contents of +the separate packages. +The fastest way to look something up is to retrieve all the files in the contents subdirectory, and grep through them for the file -you need. Here is an example of a list of files that you might need, and +you need. +Here is an example of a list of files that you might need, and in which contents-file you will find it by grepping through them: -.Pp .Bd -unfilled -offset indent Needed Package @@ -320,7 +336,6 @@ In each of the contents-files for these packages, look for a line saying "PACKAGE LOCATION", it will tell you on which 'disk' the package is, in our case it will tell us in which subdirectory we need to look. For our example, we would find the following locations: -.Pp .Bd -unfilled -offset indent Package Location @@ -347,9 +362,10 @@ Extract the files from these gzipped tarfiles in your /emul/linux directory (possibly omitting or afterwards removing files you don't need), and you are done. .Ss Programs using SVGAlib -SVGAlib binaries require some extra care. The pcvt virtual console driver -has to be in the kernel for them to work, and you will also have to create -some symbolic links in the /emul/linux/dev directory, namely: +SVGAlib binaries require some extra care. +The pcvt virtual console driver has to be in the kernel for them to work, +and you will also have to create some symbolic links in the /emul/linux/dev +directory, namely: .Pp .nf /emul/linux/dev/console -> /dev/tty diff --git a/share/man/man8/compat_sunos.8 b/share/man/man8/compat_sunos.8 index d5069e7fc04..c91bb938a12 100644 --- a/share/man/man8/compat_sunos.8 +++ b/share/man/man8/compat_sunos.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: compat_sunos.8,v 1.10 2001/08/17 11:13:58 mpech Exp $ +.\" $OpenBSD: compat_sunos.8,v 1.11 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: compat_sunos.8,v 1.6 1995/06/11 23:05:17 pk Exp $ .\" .\" Copyright (c) 1994 Theo de Raadt @@ -39,7 +39,8 @@ .Nd setup procedure for running SunOS binaries under emulation .Sh DESCRIPTION OpenBSD/sparc and some of the OpenBSD/m68k architectures can run -SunOS executables. Most executables will work. +SunOS executables. +Most executables will work. .Pp The SunOS compatibility feature is active for kernels compiled with the diff --git a/share/man/man8/compat_svr4.8 b/share/man/man8/compat_svr4.8 index 18817f3a48a..0bb6665c588 100644 --- a/share/man/man8/compat_svr4.8 +++ b/share/man/man8/compat_svr4.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: compat_svr4.8,v 1.9 2000/12/22 16:54:38 avsm Exp $ +.\" $OpenBSD: compat_svr4.8,v 1.10 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: compat_svr4.8,v 1.1 1996/07/06 17:14:50 christos Exp $ .\" .\" Copyright (c) 1996 Christos Zoulas @@ -40,9 +40,9 @@ .Nd setup procedure for running SVR4/iBCS2 binaries under emulation .Sh DESCRIPTION .Ox -supports running SVR4/iBCS2 binaries. This code has been tested on -i386 and sparc systems. Most programs should work, but not ones that use -or depend on: +supports running SVR4/iBCS2 binaries. +This code has been tested on i386 and sparc systems. +Most programs should work, but not ones that use or depend on: .Pp .Bl -tag -width 123 -compact -offset indent .It kernel internal data structures @@ -63,26 +63,27 @@ for kernels compiled with the .Nm COMPAT_SVR4 option enabled. .Pp -Most SVR4 programs are dynamically linked. This means that you will -also need the shared libraries that the program depends on and the -runtime linker. Also, you will need to create a "shadow root" -directory for SVR4 binaries on your +Most SVR4 programs are dynamically linked. +This means that you will also need the shared libraries that the program +depends on and the runtime linker. +Also, you will need to create a "shadow root" directory for SVR4 binaries +on your .Ox -system. This directory -is named /emul/svr4. Any file operations done by SVR4 programs -run under +system. +This directory is named /emul/svr4. +Any file operations done by SVR4 programs run under .Ox -will look in this directory first. So, if a SVR4 -program opens, for example, /etc/passwd, +will look in this directory first. +So, if a SVR4 program opens, for example, /etc/passwd, .Ox will first try to open /emul/svr4/etc/passwd, and if that does not exist -open the 'real' /etc/passwd file. It is recommended that you install -SVR4 packages that include configuration files, etc under /emul/svr4, -to avoid naming conflicts with possible +open the 'real' /etc/passwd file. +It is recommended that you install SVR4 packages that include configuration +files, etc under /emul/svr4, to avoid naming conflicts with possible .Ox -counterparts. Shared -libraries should also be installed in the shadow tree. +counterparts. +Shared libraries should also be installed in the shadow tree. .Pp The simplest way to setup your system for SVR4 binaries is: .Bl -tag -width 123 -compact @@ -147,17 +148,18 @@ need to be .Ox device nodes. .Sh BUGS -Many system calls are still not emulated. The streams emulation is -incomplete (socketpair does not work yet). +Many system calls are still not emulated. +The streams emulation is incomplete (socketpair does not work yet). .Pp Most SVR4 executables can not handle directory offset cookies > 32 -bits. More recent ones, compiled for large file support (Solaris 2.6 -and up) can. With older programs, you will see the message "svr4_getdents: -dir offset too large for emulated program" when this happens. Currently, -this can only happen on NFS mounted filesystems, mounted from servers -that return offsets with information in the upper 32 bits. These errors -should rarely happen, but can be avoided by mounting this filesystem with -the +bits. +More recent ones, compiled for large file support (Solaris 2.6 and up) can. +With older programs, you will see the message "svr4_getdents: dir offset +too large for emulated program" when this happens. +Currently, this can only happen on NFS mounted filesystems, mounted from +servers that return offsets with information in the upper 32 bits. +These errors should rarely happen, but can be avoided by mounting this +filesystem with the .Fl 2 option to .Xr mount_nfs 8 . diff --git a/share/man/man8/compat_ultrix.8 b/share/man/man8/compat_ultrix.8 index 7df6a0e0231..7fa3759d8ba 100644 --- a/share/man/man8/compat_ultrix.8 +++ b/share/man/man8/compat_ultrix.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: compat_ultrix.8,v 1.9 2001/10/04 16:56:52 mpech Exp $ +.\" $OpenBSD: compat_ultrix.8,v 1.10 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1997 Jonathan Stone .\" All rights reserved. @@ -38,22 +38,24 @@ .Nd setup procedure for running Ultrix binaries under emulation .Sh DESCRIPTION OpenBSD/mips and OpenBSD/vax architectures can run Risc ULTRIX and Vax -ULTRIX executables, respectively. However, you have to worry about +ULTRIX executables, respectively. +However, you have to worry about the legal issues of ensuring that you have a right to use any ULTRIX binaries on your machine. .Pp -Most executables will work. The exceptions include programs that use +Most executables will work. +The exceptions include programs that use proprietary, Ultrix-specific features (LAT, CI support, DECnet support) and various system calls, ioctl()'s, or Ultrix kernel semantics that are difficult to emulate (e.g., Ultrix packetfilter) or buggy (e.g., Ultrix YP). .Pp All Ultrix executables are static, so no shared libraries are required -for Ultrix compatibility. However, Ultrix is based on a +for Ultrix compatibility. +However, Ultrix is based on a .Bx 4.3 -alpha -release. Ultrix commands and libraries are often much older than -their +alpha release. +Ultrix commands and libraries are often much older than their .Ox or even SunOS 4.x equivalents, and may require incompatible configuration files. @@ -77,22 +79,22 @@ and lines in .Xr /etc/resolv.conf 5 . You should create a copy of /etc/resolv.conf containing only those -commands and put it in /emul/ultrix/etc/resolv.conf. Note that the -domain search order used by Ultrix executables may not be the same as -native binaries; there is no good way around this. +commands and put it in /emul/ultrix/etc/resolv.conf. +Note that the domain search order used by Ultrix executables may +not be the same as native binaries; there is no good way around this. .Ss /etc/svc.conf Ultrix uses /etc/svc.conf to select an ordered search of YP, Hesiod, -or local flat-file mappings. You should create an -/emul/ultrix/etc/svc.conf specifying either local files or bind (DNS) -lookups for all Ultrix name services. +or local flat-file mappings. +You should create an /emul/ultrix/etc/svc.conf specifying either +local files or bind (DNS) lookups for all Ultrix name services. .Sh BUGS -RISC Ultrix YP(NIS) is known to not work. The Ultrix YP libraries have -a consistent endian-ness bug. Ultrix YP client will not inter-operate -with the +RISC Ultrix YP(NIS) is known to not work. +The Ultrix YP libraries have a consistent endian-ness bug. +Ultrix YP client will not inter-operate with the .Ox .Xr ypbind 8 -process. The only workaround is to use -/etc/svc.conf to disable YP(NIS). +process. +The only workaround is to use /etc/svc.conf to disable YP(NIS). .Pp The ndbm hashed-password file used by Ultrix are incompatible with the db hashed-password file used by @@ -101,8 +103,9 @@ There is no good solution for this. (YP would be a good one, if Ultrix YP worked.) .Pp The API used by Xservers to talk to the kernel is currently compatible -with Ultrix 4.1. An implementation of the Ultrix 4.2 Xws interface -(used by X11R6) is in progress. +with Ultrix 4.1. +An implementation of the Ultrix 4.2 Xws interface (used by X11R6) is +in progress. .Pp A complete list of things which fail to work in Ultrix compatibility mode should be added here. diff --git a/share/man/man8/crash.8 b/share/man/man8/crash.8 index 4948fd39a20..6126b08a231 100644 --- a/share/man/man8/crash.8 +++ b/share/man/man8/crash.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: crash.8,v 1.13 2001/08/22 08:16:50 niklas Exp $ +.\" $OpenBSD: crash.8,v 1.14 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1980, 1991 The Regents of the University of California. .\" All rights reserved. @@ -162,7 +162,8 @@ Copyright 1996 Free Software Foundation, Inc. GDB is free software, covered by the GNU General Public License, and you are welcome to change it and/or distribute copies of it under certain conditions. Type "show copying" to see the conditions. -There is absolutely no warranty for GDB. Type "show warranty" for details. +There is absolutely no warranty for GDB. +Type "show warranty" for details. This GDB was configured as "i386-unknown-openbsd2.8". (gdb) file /var/crash/bsd.0 Reading symbols from /var/crash/bsd.0...(no debugging symbols found)...done. @@ -301,9 +302,9 @@ The first number is the offset. Find the offset that you got in the ddb trace (in this case it's 4711). .Pp -When reporting data collected in this way, include ~20 lines before and ~10 lines -after the offset from the objdump output in the crash report, as well as the output -of +When reporting data collected in this way, include ~20 lines before and ~10 +lines after the offset from the objdump output in the crash report, as well +as the output of .Xr ddb 4 Ns 's "show registers" command. It's important that the output from objdump includes at least two or diff --git a/share/man/man8/dhcp.8 b/share/man/man8/dhcp.8 index e491cbe49bd..85f7577128a 100644 --- a/share/man/man8/dhcp.8 +++ b/share/man/man8/dhcp.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: dhcp.8,v 1.8 2001/10/04 10:28:20 wilfried Exp $ +.\" $OpenBSD: dhcp.8,v 1.9 2001/10/05 14:45:54 mpech Exp $ .\" .Dd July 8, 1999 .Dt DHCP 8 @@ -11,9 +11,9 @@ for DHCP .Sh DESCRIPTION The Dynamic Host Configuration Protocol (DHCP) allows hosts on a TCP/IP network to configure one or more network interfaces based on information collected from -a DHCP server in response to a DHCP request. This mechanism is often used, for -example, by cable modem and DSL network providers to simplify network -configurations for their clients/customers. +a DHCP server in response to a DHCP request. +This mechanism is often used, for example, by cable modem and DSL network +providers to simplify network configurations for their clients/customers. .Pp Information typically contained within a DHCP response includes an IP address for the interface, subnet mask, broadcast address, router (gateway) @@ -29,7 +29,8 @@ For each interface that is to be configured via DHCP, create a file (where XXX is the interface's identifier, e.g., ep1) that starts with the word .Dq dhcp , -optionally followed by additional interface options. See +optionally followed by additional interface options. +See .Xr hostname.if 5 for more information on the format of these files. .Pp @@ -57,7 +58,8 @@ as a DHCP server: .It Edit .Pa /etc/dhcpd.conf . -This file is shipped with the system. See +This file is shipped with the system. +See .Xr dhcpd.conf 5 and .Xr dhcpd 8 @@ -68,8 +70,8 @@ Edit This file should contain a list of interfaces you wish to serve by .Xr dhcpd 8 . If you have only one broadcast network interface or you wish to serve all -interfaces, this step is not required. Be sure to leave this file empty (or -even delete it) if this is the case. +interfaces, this step is not required. +Be sure to leave this file empty (or even delete it) if this is the case. .It Edit .Pa /etc/rc.conf @@ -79,8 +81,8 @@ This will cause .Ox to start the .Xr dhcpd 8 -daemon at boot-time and listen for DHCP requests on the local network. To -start it manually, execute the following commands: +daemon at boot-time and listen for DHCP requests on the local network. +To start it manually, execute the following commands: .Pp .Dl # touch /var/db/dhcpd.leases .Dl # /usr/sbin/dhcpd -q [netif1 netif2 ...] diff --git a/share/man/man8/diskless.8 b/share/man/man8/diskless.8 index 6b8290b1a6d..e3569c81394 100644 --- a/share/man/man8/diskless.8 +++ b/share/man/man8/diskless.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: diskless.8,v 1.15 2001/09/20 15:39:57 miod Exp $ +.\" $OpenBSD: diskless.8,v 1.16 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: diskless.8,v 1.7.4.1 1996/05/30 18:58:10 cgd Exp $ .\" .\" @@ -78,8 +78,8 @@ Other machines may load a network boot program either from diskette or using a special PROM on the network card. .Pp -In phase 2, the boot program loads a kernel. Operation in -this phase depends on the design of the boot program. +In phase 2, the boot program loads a kernel. +Operation in this phase depends on the design of the boot program. The boot program: .Pp .Bl -tag -width 2.2 -compact @@ -207,7 +207,8 @@ For example: .Ed .Pp Some architectures, such as the Sun3 and Ultrasparc machines, do not append the -architecture name. It this case, the name would be just C0C5600C. +architecture name. +It this case, the name would be just C0C5600C. The name used is architecture dependent, it simply has to match what the booting client's PROM wishes to it to be. If the client's PROM fails to fetch the expected file, @@ -230,10 +231,10 @@ Add myclient to the bootparams database myclient root=server:/export/myclient/root \\ swap=server:/export/myclient/swap .Ed -Note that some bootparam servers are somewhat sensitive. Some require -fully qualified hostnames or partially qualified hostnames (which can -be solved by having both fully and partially qualified entries). Other -servers are case sensitive. +Note that some bootparam servers are somewhat sensitive. +Some require fully qualified hostnames or partially qualified hostnames +(which can be solved by having both fully and partially qualified entries). +Other servers are case sensitive. .Pp .It 6. Build the swap file for myclient: @@ -247,8 +248,8 @@ This creates a 16 Megabyte swap file. .It 7. Populate myclient's .Pa / -filesystem on the server. How this is done depends on the -client architecture and the version of the +filesystem on the server. +How this is done depends on the client architecture and the version of the .Ox distribution. It can be as simple as copying and modifying the server's root diff --git a/share/man/man8/makedev.8 b/share/man/man8/makedev.8 index 139f43dbe9d..0083709acb5 100644 --- a/share/man/man8/makedev.8 +++ b/share/man/man8/makedev.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: makedev.8,v 1.5 2000/12/22 16:54:38 avsm Exp $ +.\" $OpenBSD: makedev.8,v 1.6 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: makedev.8,v 1.3 1994/11/30 19:36:25 jtc Exp $ .\" .\" Copyright (c) 1983, 1991, 1993 @@ -46,7 +46,8 @@ .Sh DESCRIPTION .Nm MAKEDEV is a shell script normally used to install -special files. It resides in the +special files. +It resides in the .Pa /dev directory, as this is the normal location of special files. Arguments to @@ -58,8 +59,8 @@ where is one of the supported devices listed in section 4 of the manual and .Dq Sy \&? -is a logical unit number (0-9). A few -special arguments create assorted collections of devices and are +is a logical unit number (0-9). +A few special arguments create assorted collections of devices and are listed below. .Bl -tag -width Ds .It Sy std @@ -83,11 +84,11 @@ console cassette device(s), .Pa /dev/tu? devices would be made for the appropriate system. .It Sy local -Create those devices specific to the local site. This -request causes the shell file +Create those devices specific to the local site. +This request causes the shell file .Pa /dev/MAKEDEV.local -to be executed. Site specific commands, such as those -used to setup dialup lines as +to be executed. +Site specific commands, such as those used to setup dialup lines as .Pa ttyd? should be included in this file. @@ -98,7 +99,8 @@ Since all devices are created using this shell script is useful only to the superuser. .Sh DIAGNOSTICS Either self-explanatory, or generated by one of the programs -called from the script. Use +called from the script. +Use .Ql sh -x MAKEDEV in case of trouble. diff --git a/share/man/man8/man8.alpha/boot_alpha.8 b/share/man/man8/man8.alpha/boot_alpha.8 index 5ca7b691721..f5c9d903f37 100644 --- a/share/man/man8/man8.alpha/boot_alpha.8 +++ b/share/man/man8/man8.alpha/boot_alpha.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: boot_alpha.8,v 1.2 2001/01/29 02:11:14 niklas Exp $ +.\" $OpenBSD: boot_alpha.8,v 1.3 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: boot.8,v 1.3 2000/06/14 17:25:48 cgd Exp $ .\" .\" Copyright (c) 1999 Christopher G. Demetriou @@ -82,10 +82,10 @@ When the .Ox .Ns Tn /alpha kernel is booted normally -it initializes itself and proceeds to start the system. An automatic -consistency check of the file systems takes place, and unless this -fails, the system comes up to multi-user operation. The proper way -to shut the system down is with the +it initializes itself and proceeds to start the system. +An automatic consistency check of the file systems takes place, and unless +this fails, the system comes up to multi-user operation. +The proper way to shut the system down is with the .Xr shutdown 8 command. .Pp diff --git a/share/man/man8/man8.vax/drtest.8 b/share/man/man8/man8.vax/drtest.8 index 16ddd835bd6..f409657d1a7 100644 --- a/share/man/man8/man8.vax/drtest.8 +++ b/share/man/man8/man8.vax/drtest.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: drtest.8,v 1.8 2001/04/18 11:14:23 bjc Exp $ +.\" $OpenBSD: drtest.8,v 1.9 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1983, 1991 Regents of the University of California. .\" All rights reserved. @@ -47,8 +47,8 @@ It was primarily intended as a test program for new standalone drivers, but has shown useful in other contexts as well, such as verifying disks and running speed -tests. For example, when a disk has been formatted -(by +tests. +For example, when a disk has been formatted (by .Xr format 8 ) , you can check that hard errors has been taken care of by running @@ -71,7 +71,8 @@ In this example (using a 750), is loaded from the root file system; usually it will be loaded from the machine's -console storage device. Boldface means user input. +console storage device. +Boldface means user input. As usual, ``#'' and ``@'' may be used to edit input. .Pp .Bd -unfilled -offset indent -compact @@ -95,9 +96,9 @@ As usual, ``#'' and ``@'' may be used to edit input. .Em (...to abort halt machine with \&^P) .Ed .Sh DIAGNOSTICS -The diagnostics are intended to be self explanatory. Note, however, that -the device number -in the diagnostic messages is identified as +The diagnostics are intended to be self explanatory. +Note, however, that the device number in the diagnostic messages +is identified as .Em typeX instead of .Em type(a,u) diff --git a/share/man/man8/man8.vax/format.8 b/share/man/man8/man8.vax/format.8 index ed21ce86639..04b24143d19 100644 --- a/share/man/man8/man8.vax/format.8 +++ b/share/man/man8/man8.vax/format.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: format.8,v 1.9 2001/10/04 16:56:52 mpech Exp $ +.\" $OpenBSD: format.8,v 1.10 2001/10/05 14:45:54 mpech Exp $ .\" Copyright (c) 1980, 1983 The Regents of the University of California. .\" All rights reserved. .\" @@ -39,10 +39,11 @@ .Nm format .Nd how to format disk packs .Sh DESCRIPTION -There are two ways to format disk packs. The simplest is to -use the +There are two ways to format disk packs. +The simplest is to use the .Nm -program. The alternative is to use the DEC standard formatting +program. +The alternative is to use the DEC standard formatting software which operates under the DEC diagnostic supervisor. This manual page describes the operation of .Nm format , @@ -129,8 +130,8 @@ amiss.) .Pp .Nm uses the standard notation of the standalone I/O library -in identifying a drive to be formatted. A drive is -specified as +in identifying a drive to be formatted. +A drive is specified as .Do .Ar zz Ns (x,y), .Dc @@ -161,15 +162,15 @@ should be formatted. Before each formatting attempt, .Nm prompts the user in case debugging should be enabled -in the appropriate device driver. A carriage return -disables debugging information. +in the appropriate device driver. +A carriage return disables debugging information. .Pp .Nm should be used prior to building file systems (with .Xr newfs 8 to ensure that all sectors with uncorrectable media errors -are remapped. If a drive develops uncorrectable -defects after formatting, either +are remapped. +If a drive develops uncorrectable defects after formatting, either .Xr bad144 8 or .Xr badsect 8 @@ -242,13 +243,13 @@ The diagnostics are intended to be self explanatory. The steps needed for 11/750 or 11/730 CPUs are similar, but not covered in detail here. .Pp -The formatting procedures are different for each type of disk. Listed -here are the formatting procedures for RK07's, RP0X, and RM0X -disks. +The formatting procedures are different for each type of disk. +Listed here are the formatting procedures for RK07's, RP0X, and RM0X disks. .Pp You should shut down UNIX and halt the machine to do any disk formatting. -Make certain you put in the pack you want formatted. It is also a good idea -to spin down or write protect the disks you don't want to format, just in case. +Make certain you put in the pack you want formatted. +It is also a good idea to spin down or write protect the disks you don't +want to format, just in case. .Ss Formatting an RK07 Load the console floppy labeled, "RX11 VAX DSK LD DEV #1" in the console disk drive, and type the following commands: diff --git a/share/man/man8/rc.8 b/share/man/man8/rc.8 index a8cd87f5290..ff60b0b987a 100644 --- a/share/man/man8/rc.8 +++ b/share/man/man8/rc.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rc.8,v 1.16 2001/08/03 15:21:17 mpech Exp $ +.\" $OpenBSD: rc.8,v 1.17 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1980, 1991, 1993 .\" The Regents of the University of California. All rights reserved. @@ -152,8 +152,9 @@ of course) by .Pa /etc/rc . Various comments in .Nm rc.conf -make it clear what each variable does. Refer to the specific man pages -for each daemon to determine what that subsystem does. +make it clear what each variable does. +Refer to the specific man pages for each daemon to determine what that +subsystem does. .Pp For example, the .Xr sendmail 8 @@ -164,7 +165,8 @@ daemon is controlled by the line .Pp This does not start .Xr sendmail 8 -at system startup. But +at system startup. +But .Xr sendmail 8 is started with the specified flags if the specification is modified to be .Bd -literal diff --git a/share/man/man8/rc.shutdown.8 b/share/man/man8/rc.shutdown.8 index 7fd4711ba55..231274e32a3 100644 --- a/share/man/man8/rc.shutdown.8 +++ b/share/man/man8/rc.shutdown.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: rc.shutdown.8,v 1.2 1999/09/03 22:14:08 deraadt Exp $ +.\" $OpenBSD: rc.shutdown.8,v 1.3 2001/10/05 14:45:54 mpech Exp $ .Dd July 20, 1999 .Dt RC.SHUTDOWN 8 .Os @@ -12,7 +12,8 @@ or .Xr halt 8 command, either of these programs checks for the existence of a .Pa /etc/rc.shutdown -script to run before halting the system. It will also be executed by +script to run before halting the system. +It will also be executed by .Xr init 8 if a keyboard-requested halt is issued (for architectures that support this). .Pp diff --git a/share/man/man8/release.8 b/share/man/man8/release.8 index 4d693b5e611..69023431aad 100644 --- a/share/man/man8/release.8 +++ b/share/man/man8/release.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: release.8,v 1.18 2001/10/04 16:56:52 mpech Exp $ +.\" $OpenBSD: release.8,v 1.19 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 2000 Marco S. Hyman .\" @@ -319,7 +319,9 @@ the build process is: .Pa XF86Setup , built and installed above, requires version 8.3 of the .Pa tcl/tk -libraries. They must be installed to do a proper build. Version 8.3 of +libraries. +They must be installed to do a proper build. +Version 8.3 of .Pa tcl/tk can be found in the ports tree at .Pa /usr/ports/lang/tcl/8.3/ @@ -340,7 +342,8 @@ However, the install phase of the build does .Em not overwrite .Pa /etc/X11/xdm . -That directory must be installed by hand. Or you can +That directory must be installed by hand. +Or you can .Ic "cd /etc/X11 && mv xdm xdm-" before the build and copy any local configuration from .Pa xdm- @@ -357,7 +360,8 @@ mechanism noted in the section on building a system release, above. They may be the same values used above, but be warned that the contents of .Va DESTDIR -will be removed if you follow this procedure. However, +will be removed if you follow this procedure. +However, .Va DESTDIR should not be the same directory used to build the system release. It may be the same if you don't care to keep the contents of the diff --git a/share/man/man8/ssl.8 b/share/man/man8/ssl.8 index 2dea2892415..fd61ef864f5 100644 --- a/share/man/man8/ssl.8 +++ b/share/man/man8/ssl.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: ssl.8,v 1.35 2001/09/19 19:42:00 millert Exp $ +.\" $OpenBSD: ssl.8,v 1.36 2001/10/05 14:45:54 mpech Exp $ .\" .Dd September 19, 2001 .Dt SSL 8 @@ -174,9 +174,9 @@ transactions with your machine on port 443. You will most likely want to generate a self-signed certificate in the manner above along with your certificate signing request to test your server's functionality even if you are going to have the certificate -signed by another Certifying Authority. Once your Certifying -Authority returns the signed certificate to you, you can switch to -using the new certificate by replacing the self-signed +signed by another Certifying Authority. +Once your Certifying Authority returns the signed certificate to you, +you can switch to using the new certificate by replacing the self-signed .Pa /etc/ssl/server.crt with the certificate signed by your Certifying Authority, and then restarting diff --git a/share/man/man8/update.8 b/share/man/man8/update.8 index 8d55a63fd5c..6b1b47fdfa2 100644 --- a/share/man/man8/update.8 +++ b/share/man/man8/update.8 @@ -27,7 +27,7 @@ .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. .\" -.\" $OpenBSD: update.8,v 1.6 1998/09/01 16:38:22 deraadt Exp $ +.\" $OpenBSD: update.8,v 1.7 2001/10/05 14:45:54 mpech Exp $ .\" .Dd June 8, 1996 .Dt UPDATE 8 @@ -58,7 +58,8 @@ process will do this in a staggered manner. It is possible on some systems, that a .Xr sync occurring simultaneously with a crash may cause -file system damage. See +file system damage. +See .Xr fsck 8 . .Sh HISTORY An diff --git a/share/man/man8/vpn.8 b/share/man/man8/vpn.8 index c4901cd6cb1..dad740624bb 100644 --- a/share/man/man8/vpn.8 +++ b/share/man/man8/vpn.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: vpn.8,v 1.55 2001/10/04 16:56:52 mpech Exp $ +.\" $OpenBSD: vpn.8,v 1.56 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright 1998 Niels Provos <provos@physnet.uni-hamburg.de> .\" All rights reserved. @@ -38,7 +38,8 @@ .Nd configuring the system for virtual private networks .Sh DESCRIPTION A virtual private network is used to securely connect two or more subnets -over the internet. For each subnet there is a security gateway which is +over the internet. +For each subnet there is a security gateway which is linked via a cryptographically secured tunnel to the security gateway of the other subnet. .Xr ipsec 4 @@ -107,12 +108,14 @@ For more permanent operation, these options should be enabled in your .Ss Generating Manual Keys [manual keying] The shared secret symmetric keys used to create a VPN can be any hexadecimal value, so long as both sides of the connection use -the same values. Since the security of the VPN is based on these keys +the same values. +Since the security of the VPN is based on these keys being unguessable, it is very important that the keys be chosen using a -strong random source. One practical method of generating them -is by using the +strong random source. +One practical method of generating them is by using the .Xr random 4 -device. To produce 160 bits (20 bytes) of randomness, for example, do: +device. +To produce 160 bits (20 bytes) of randomness, for example, do: .Bd -literal # openssl rand 20 | hexdump -e '20/1 "%02x"' .Ed @@ -139,8 +142,9 @@ Furthermore, recent attacks on SKIPJACK have shown severe weaknesses in its structure. .Pp Note that DES requires 8 bytes to form a 56-bit key and 3DES requires 24 bytes -to form its 168-bit key. This is because the most significant bit of each byte -is ignored by both algorithms. +to form its 168-bit key. +This is because the most significant bit of each byte is ignored by both +algorithms. .Ss Creating Security Associations [manual keying] Before the IPsec flows can be defined, two Security Associations (SAs) must be defined on each end of the VPN, e.g.: @@ -161,7 +165,8 @@ and .Fl authkey options may be used to specify the keys directly in the .Xr ipsecadm 8 -command line. However, another user could view the keys by using the +command line. +However, another user could view the keys by using the .Xr ps 1 command at the appropriate time (or use a program for doing so). .Ss Creating IPsec Flows [manual keying] @@ -250,7 +255,8 @@ either the .Xr isakmpd 8 or .Xr photurisd 8 -key management daemon. To make sure the daemon is properly configured +key management daemon. +To make sure the daemon is properly configured to provide the required security services (typically, encryption and authentication) start the daemon with debugging or verbose output. .Pp @@ -591,10 +597,11 @@ Suites= QM-ESP-3DES-SHA-SUITE .Ed .Pp .It -Read through the configuration one more time. The only real -differences between the two files in this example is +Read through the configuration one more time. +The only real differences between the two files in this example is the IP-addresses, and ordering of Local- and Remote-ID for the VPN -itself. Note that the shared secret (the +itself. +Note that the shared secret (the .Em Authentication tag) must match between machineA and machineB. .Pp diff --git a/share/man/man8/yp.8 b/share/man/man8/yp.8 index 2461013a5ad..3ea012df2ae 100644 --- a/share/man/man8/yp.8 +++ b/share/man/man8/yp.8 @@ -1,4 +1,4 @@ -.\" $OpenBSD: yp.8,v 1.12 2000/04/17 02:32:48 aaron Exp $ +.\" $OpenBSD: yp.8,v 1.13 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: yp.8,v 1.9 1995/08/11 01:16:52 thorpej Exp $ .\" .\" Copyright (c) 1992, 1993, 1996 Theo de Raadt <deraadt@theos.com> @@ -127,16 +127,18 @@ of their maps through .Nm ypinit is used to initialize .Nm YP -as a server or master. This creates -various files in +as a server or master. +This creates various files in .Pa /var/yp . By default the .Nm YP -server will be setup in backwards compatible mode. To enable +server will be setup in backwards compatible mode. +To enable .Dq secure mode, the file .Pa /var/yp/Makefile.yp -must be edited. This +must be edited. +This .Dq secure mode is compatible with .Ox @@ -202,8 +204,8 @@ YP maps Makefile .Sh HISTORY This free .Nm YP -subsystem is thought to be compatible with Sun's implementation. It is, -of course, not compatible with +subsystem is thought to be compatible with Sun's implementation. +It is, of course, not compatible with .Nm NIS+ or any other .Dq secure diff --git a/share/man/man9/bus_space.9 b/share/man/man9/bus_space.9 index c7576cce04b..079b94b446b 100644 --- a/share/man/man9/bus_space.9 +++ b/share/man/man9/bus_space.9 @@ -1,4 +1,4 @@ -.\" $OpenBSD: bus_space.9,v 1.5 2001/06/28 22:14:23 millert Exp $ +.\" $OpenBSD: bus_space.9,v 1.6 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: bus_space.9,v 1.15 2000/08/09 03:11:00 tv Exp $ .\" .\" Copyright (c) 1997 The NetBSD Foundation, Inc. @@ -451,7 +451,7 @@ In that case, they may cause the system to halt, either intentionally (via panic) or unintentionally (by causing a fatal trap of by some other means) or may cause improper operation which is not immediately fatal. Functions which return void or which return data read from bus space -(i.e., functions which don't obviously return an error code) do not +(i.e. functions which don't obviously return an error code) do not fail. They could only fail if given invalid arguments, and in that case their behaviour is undefined. diff --git a/share/man/man9/md5.9 b/share/man/man9/md5.9 index 09f46cbc209..e2ef10c25bf 100644 --- a/share/man/man9/md5.9 +++ b/share/man/man9/md5.9 @@ -1,4 +1,4 @@ -.\" $OpenBSD: md5.9,v 1.5 2001/08/03 15:21:17 mpech Exp $ +.\" $OpenBSD: md5.9,v 1.6 2001/10/05 14:45:54 mpech Exp $ .\" .\" Copyright (c) 1996 Michael Shalayeff .\" All rights reserved. @@ -43,8 +43,8 @@ .Sh DESCRIPTION The .Nm -module implements the RSA Data Security, Inc. MD5 Message-Digest Algorithm -(MD5). +module implements the RSA Data Security, Inc. +MD5 Message-Digest Algorithm (MD5). It produces 128-bit MD5 Digest of data. .Pp .Bl -hang -width MD5Transform diff --git a/share/man/man9/style.9 b/share/man/man9/style.9 index c8b8320c19d..398a180a88f 100644 --- a/share/man/man9/style.9 +++ b/share/man/man9/style.9 @@ -22,7 +22,7 @@ .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF .\" SUCH DAMAGE. .\" -.\" $OpenBSD: style.9,v 1.21 2001/10/04 10:28:20 wilfried Exp $ +.\" $OpenBSD: style.9,v 1.22 2001/10/05 14:45:54 mpech Exp $ .\" .Dd June 18, 2001 .Dt STYLE 9 @@ -438,7 +438,8 @@ undesirable and will elicit complaints from a good compiler, such as .Pp Casts and .Fn sizeof -calls are not followed by a space. Note that +calls are not followed by a space. +Note that .Xr indent 1 does not understand this rule. .Pp diff --git a/share/man/man9/uvm.9 b/share/man/man9/uvm.9 index 6dfcc3da68e..2efc0500948 100644 --- a/share/man/man9/uvm.9 +++ b/share/man/man9/uvm.9 @@ -1,4 +1,4 @@ -.\" $OpenBSD: uvm.9,v 1.7 2001/08/03 15:21:17 mpech Exp $ +.\" $OpenBSD: uvm.9,v 1.8 2001/10/05 14:45:54 mpech Exp $ .\" $NetBSD: uvm.9,v 1.14 2000/06/29 06:08:44 mrg Exp $ .\" .\" Copyright (c) 1998 Matthew R. Green @@ -41,8 +41,10 @@ .Fd #include <uvm/uvm.h> .Sh DESCRIPTION The UVM virtual memory system manages access to the computer's memory -resources. User processes and the kernel access these resources through -UVM's external interface. UVM's external interface includes functions that: +resources. +User processes and the kernel access these resources through +UVM's external interface. +UVM's external interface includes functions that: .Pp .Bl -hyphen -compact .It @@ -62,10 +64,12 @@ allocate and free physical memory .El .Pp In addition to exporting these services, UVM has two kernel-level processes: -pagedaemon and swapper. The pagedaemon process sleeps until physical memory -becomes scarce. When that happens, pagedaemon is awoken. It scans physical -memory, paging out and freeing memory that has not been recently used. The -swapper process swaps in runnable processes that are currently swapped out, +pagedaemon and swapper. +The pagedaemon process sleeps until physical memory becomes scarce. +When that happens, pagedaemon is awoken. +It scans physical memory, paging out and freeing memory that has not been +recently used. +The swapper process swaps in runnable processes that are currently swapped out, if there is room. .Pp There are also several miscellaneous functions. @@ -84,21 +88,21 @@ There are also several miscellaneous functions. .Pp .Fn uvm_init sets up the UVM system at system boot time, after the -copyright has been printed. It initialises -global state, the page, map, kernel virtual memory state, +copyright has been printed. +It initialises global state, the page, map, kernel virtual memory state, machine-dependent physical map, kernel memory allocator, pager and anonymous memory sub-systems, and then enables paging of kernel objects. .Pp .Fn uvm_init_limits -initialises process limits for the named process. This is for use by -the system startup for process zero, before any other processes are -created. +initialises process limits for the named process. +This is for use by the system startup for process zero, before any other +processes are created. .Pp .Fn uvm_setpagesize initialises the uvmexp members pagesize (if not already done by -machine-dependent code), pageshift and pagemask. It should be called by -machine-dependent code early in the +machine-dependent code), pageshift and pagemask. +It should be called by machine-dependent code early in the .Xr pmap_init 9 call. .Pp @@ -134,15 +138,18 @@ initialises the swap sub-system. .Fn uvm_map establishes a valid mapping in map .Fa map , -which must be unlocked. The new mapping has size +which must be unlocked. +The new mapping has size .Fa size , which must be in .Dv PAGE_SIZE -units. The +units. +The .Fa uobj and .Fa uoffset -arguments can have four meanings. When +arguments can have four meanings. +When .Fa uobj is .Dv NULL @@ -153,7 +160,8 @@ is .Fn uvm_map does not use the machine-dependent .Dv PMAP_PREFER -function. If +function. +If .Fa uoffset is any other value, it is used as the hint to .Dv PMAP_PREFER . @@ -170,8 +178,8 @@ finds the offset based upon the virtual address, passed as .Fa startp . If .Fa uoffset -is any other value, we are doing a normal mapping at this offset. The -start address of the map will be returned in +is any other value, we are doing a normal mapping at this offset. +The start address of the map will be returned in .Fa startp . .Pp .Fa flags @@ -236,11 +244,13 @@ can take are: .Pp The .Dv UVM_MAPFLAG -macro arguments can be combined with an or operator. There are -several special purpose macros for checking protection combinations, e.g. the +macro arguments can be combined with an or operator. +There are several special purpose macros for checking protection combinations, +e.g., the .Dv UVM_PROT_WX -macro. There are also some additional macros to extract bits from -the flags. The +macro. +There are also some additional macros to extract bits from the flags. +The .Dv UVM_PROTECTION , .Dv UVM_INHERIT , .Dv UVM_MAXPROTECTION @@ -290,7 +300,8 @@ also setting the maximum protection to the region to .Fa new_prot if .Fa set_max -is non-zero. This function returns a standard UVM return value. +is non-zero. +This function returns a standard UVM return value. .Pp .Fn uvm_deallocate deallocates kernel memory in map @@ -345,7 +356,8 @@ necessary by calling .nr nS 0 .Pp .Fn uvm_fault -is the main entry point for faults. It takes +is the main entry point for faults. +It takes .Fa orig_map as the map the fault originated in, a .Fa vaddr @@ -373,16 +385,18 @@ returns a standard UVM return value. .Fn uvn_attach attaches a UVM object to vnode .Fa arg , -creating the object if necessary. The object is returned. +creating the object if necessary. +The object is returned. .Pp .Fn uvm_vnp_setsize sets the size of vnode .Fa vp to .Fa newsize . -Caller must hold a reference to the vnode. If the vnode shrinks, pages -no longer used are discarded. This function will be removed when the -filesystem and VM buffer caches are merged. +Caller must hold a reference to the vnode. +If the vnode shrinks, pages no longer used are discarded. +This function will be removed when the filesystem and VM buffer caches +are merged. .Pp .Fn uvm_vnp_sync flushes dirty vnodes from either the mount point passed in @@ -398,15 +412,17 @@ are merged. frees all VM resources allocated to vnode .Fa vp . If the vnode still has references, it will not be destroyed; however -all future operations using this vnode will fail. This function will be -removed when the filesystem and VM buffer caches are merged. +all future operations using this vnode will fail. +This function will be removed when the filesystem and VM buffer caches +are merged. .Pp .Fn uvm_vnp_uncache disables vnode .Fa vp -from persisting when all references are freed. This function will be -removed when the file-system and UVM caches are unified. Returns -true if there is no active vnode. +from persisting when all references are freed. +This function will be removed when the file-system and UVM caches +are unified. +Returns true if there is no active vnode. .Sh VIRTUAL MEMORY I/O .nr nS 1 .Ft int @@ -449,8 +465,8 @@ bytes of wired kernel memory in map .Fa map . In addition to allocation, .Fn uvm_km_zalloc -zeros the memory. Both of these functions are defined as macros in -terms of +zeros the memory. +Both of these functions are defined as macros in terms of .Fn uvm_km_alloc1 , and should almost always be used in preference to .Fn uvm_km_alloc1 . @@ -518,7 +534,8 @@ in either the object .Fa uobj or the anonymous memory .Fa anon , -which must be locked by the caller. Only one of +which must be locked by the caller. +Only one of .Fa off and .Fa uobj @@ -547,10 +564,12 @@ byte under various constraints. .Fa low and .Fa high -describe the lowest and highest addresses acceptable for the list. If +describe the lowest and highest addresses acceptable for the list. +If .Fa alignment is non-zero, it describes the required alignment of the list, in -power-of-two notation. If +power-of-two notation. +If .Fa boundary is non-zero, no segment of the list may cross this power-of-two boundary, relative to zero. @@ -565,9 +584,10 @@ frees the list of pages pointed to by .Fa list . .Pp .Fn uvm_page_physload -loads physical memory segments into VM space. It must be called at system -boot time to setup physical memory management pages. The arguments describe -the +loads physical memory segments into VM space. +It must be called at system boot time to setup physical memory management +pages. +The arguments describe the .Fa start and .Fa end @@ -586,7 +606,8 @@ The addresses of the submap can be specified exactly by setting the .Fa fixed argument to non-zero, which causes the .Fa min -argument specify the beginning of the address in thes submap. If +argument specify the beginning of the address in thes submap. +If .Fa fixed is zero, any address of size .Fa size @@ -626,8 +647,8 @@ is the main loop for the page daemon. .Pp .Fn uvm_scheduler is the process zero main loop, which is to be called after the -system has finished starting other processes. It handles the -swapping in of runnable, swapped out processes in priority +system has finished starting other processes. +It handles the swapping in of runnable, swapped out processes in priority order. .Pp .Fn uvm_swapin @@ -740,11 +761,12 @@ handles the and .Dv VM_UVMEXP calls, which return the current load averages, calculates current VM -totals, and returns the uvmexp structure respectively. The load averages -are access from userland using the +totals, and returns the uvmexp structure respectively. +The load averages are access from userland using the .Xr getloadavg 3 -function. The uvmexp structure has all global state of the UVM system, -and has the following members: +function. +The uvmexp structure has all global state of the UVM system, and has +the following members: .Bd -literal /* vm_page constants */ int pagesize; /* size of a page (PAGE_SIZE): must be power of 2 */ @@ -835,9 +857,9 @@ and (new) If the .Fa shared argument is non zero, p1 shares its address space with p2, -otherwise a new address space is created. This function -currently has no return value, and thus cannot fail. In -the future, this function will changed to allowed it to +otherwise a new address space is created. +This function currently has no return value, and thus cannot fail. +In the future, this function will changed to allowed it to fail in low memory conditions. .Pp .Fn uvm_grow @@ -857,8 +879,9 @@ and core header description in .Fa chdr . .Sh STANDARD UVM RETURN VALUES This section documents the standard return values that callers of UVM -functions can expect. They are derived from the Mach VM values -of the same function. The full list of values can be seen below. +functions can expect. +They are derived from the Mach VM values of the same function. +The full list of values can be seen below. .Bd -literal #define KERN_SUCCESS 0 #define KERN_INVALID_ADDRESS 1 @@ -892,20 +915,25 @@ The manual page is not yet written. .Sh HISTORY UVM is a new VM system developed at Washington University in St. Louis -(Missouri). UVM's roots lie partly in the Mach-based +(Missouri). +UVM's roots lie partly in the Mach-based .Bx 4.4 VM system, the .Fx -VM system, and the SunOS4 VM system. UVM's basic structure is based on the +VM system, and the SunOS4 VM system. +UVM's basic structure is based on the .Bx 4.4 -VM system. UVM's new anonymous memory system is based on the +VM system. +UVM's new anonymous memory system is based on the anonymous memory system found in the SunOS4 VM (as described in papers by -published Sun Microsystems, Inc.). UVM also includes a number of feature +published Sun Microsystems, Inc.). +UVM also includes a number of feature new to .Bx including page loanout, map entry passing, simplified -copy-on-write, and clustered anonymous memory pageout. UVM is also -further documented in a August 1998 dissertation by Charles D. Cranor. +copy-on-write, and clustered anonymous memory pageout. +UVM is also further documented in a August 1998 dissertation +by Charles D. Cranor. .Pp UVM appeared in .Nx 1.4 . diff --git a/share/man/man9/vn_lock.9 b/share/man/man9/vn_lock.9 index 70e121d2bd5..32cfc18c90e 100644 --- a/share/man/man9/vn_lock.9 +++ b/share/man/man9/vn_lock.9 @@ -1,6 +1,6 @@ .Dd March 9, 2001 -.Dt vn_lock 9 -.Os OpenBSD 2.9 +.Dt VN_LOCK 9 +.Os .Sh NAME .Nm vn_lock .Nd acquire the vnode lock @@ -12,17 +12,19 @@ .Sh DESCRIPTION The .Fn vn_lock -function is used to acquire the vnode lock. Certain file system -operations require that the vnode lock be held when they are -called. See sys/kern/vnode_if.src for more details. - +function is used to acquire the vnode lock. +Certain file system operations require that the vnode lock be held when +they are called. +See sys/kern/vnode_if.src for more details. +.Pp The .Fn vn_lock function must not be called when the vnode's reference count is -zero. Instead, the +zero. +Instead, the .Fn vget function should be used. - +.Pp The .Fa flags fields may contain the following flags: @@ -33,57 +35,56 @@ Return the vnode even if it has been reclaimed. Must be set if the caller owns the vnode interlock. .It Dv LK_NOWAIT Ta Don't wait if the vnode lock is held by someone else (may still -wait on reclamation lock on or interlock). Must not be used -with LK_RETRY. +wait on reclamation lock on or interlock). +Must not be used with LK_RETRY. .It Dv LK_EXCLUSIVE Ta Acquire an exclusive lock .It Dv LK_SHARED Ta Acquire a shared lock .El - +.Pp The .Fn vn_lock -function can sleep. The +function can sleep. +The .Fn vn_lock releases the vnode interlock before exit. - - .Sh RETURN VALUES Upon successful completion, a value of 0 is returned. Otherwise, one of the following errors is returned. - .Sh ERRORS .Bl -tag -width Er .It Bq Er ENOENT -The vnode has been reclaimed and is dead. This error is only -returned if the LK_RETRY flag is not passed. +The vnode has been reclaimed and is dead. +This error is only returned if the LK_RETRY flag is not passed. .It Bq Er EBUSY The LK_NOWAIT flag was set and the vn_lock would have slept. .El - .Sh SEE ALSO .Xr vnode 9 - .Sh BUGS -The locking discipline is bizarre. Many vnode operations are -passed locked vnodes on entry but release the lock before they -exit. Discussions with Kirk McKusick indicate that locking +The locking discipline is bizarre. +Many vnode operations are passed locked vnodes on entry but release +the lock before they exit. +Discussions with Kirk McKusick indicate that locking discipline evolved out of the pre-VFS way of doing inode locking. In addition, the current locking discipline may actually save lines of code, esp. if the number of file systems is fewer -then the number of call sites. However, the VFS interface would +then the number of call sites. +However, the VFS interface would require less wizardry if the locking discipline were simpler. - +.Pp The locking discipline is used in some places to attempt to make a -series of operations atomic (e.g. permissions check + -operation). This does not work for non-local file systems that do not -support locking (e.g. NFS). - -Are vnode locks even necessary? The security checks can be -moved into the individual file systems. Each file system can -have the responsibility of ensuring that vnode operations are suitably -atomic. - +series of operations atomic (e.g., permissions check + +operation). +This does not work for non-local file systems that do not +support locking (e.g., NFS). +.Pp +Are vnode locks even necessary? +The security checks can be moved into the individual file systems. +Each file system can have the responsibility of ensuring that vnode +operations are suitably atomic. +.Pp The LK_NOWAIT flag does prevent the caller from sleeping. - +.Pp The locking discipline as it relates to shared locks has yet to be defined. diff --git a/share/man/man9/vnode.9 b/share/man/man9/vnode.9 index 8fa37b19dc4..ba8f7c069d5 100644 --- a/share/man/man9/vnode.9 +++ b/share/man/man9/vnode.9 @@ -15,12 +15,12 @@ are dispatched through function pointers. .Pp In addition, the VFS has functions for maintaining a pool of vnodes, associating vnodes with mount points, and associating vnodes with buffers. -The individual file systems cannot override these functions. As such, -individual file systems cannot allocate their own vnodes. +The individual file systems cannot override these functions. +As such, individual file systems cannot allocate their own vnodes. .Pp In general, the contents of a struct vnode should not be examined or -modified by the users of vnode methods. There are some rather common -exceptions detailed later in this document. +modified by the users of vnode methods. +There are some rather common exceptions detailed later in this document. .Pp The vast majority of the vnode functions CANNOT be called from interrupt context. @@ -29,11 +29,13 @@ All the vnodes in the kernel are allocated out of a shared pool. The .Xr getnewvnode 9 system call returns a fresh vnode from the vnode -pool. The vnode returned has a reference count (v_usecount) of 1. +pool. +The vnode returned has a reference count (v_usecount) of 1. .Pp The .Xr vref 9 -call increments the reference count on the vnode. The +call increments the reference count on the vnode. +The .Xr vrele 9 and .Xr vput 9 @@ -51,22 +53,25 @@ method to inform the file system that the reference count has reached zero. When placed in the pool of free vnodes, the vnode is not otherwise altered. In fact, it can often be retrieved before it is reassigned to a different file. This is useful when the system closes a file and opens it again in rapid -succession. The +succession. +The .Xr vget 9 -call is used to revive the vnode. Note, callers should ensure the vnode +call is used to revive the vnode. +Note, callers should ensure the vnode they get back has not been reassigned to a different file. .Pp When the vnode pool decides to reclaim the vnode to satisfy a getnewvnode request, it calls the .Xr vop_reclaim 9 -method. File systems -often use this method to free any file-system specific data they +method. +File systems often use this method to free any file-system specific data they attach to the vnode. .Pp A file system can force a vnode with a reference count of zero to be reclaimed earlier by calling the .Xr vrecycle 9 -call. The +call. +The .Xr vrecycle 9 call is a null operation if the reference count is greater than zero. .Pp @@ -75,28 +80,30 @@ The and .Xr vgonel 9 calls will force the pool to reclaim -the vnode even if it has a non-zero reference count. If the vnode had -a non-zero reference count, the vnode is then assigned an operations -vector corresponding to the "dead" file system. In this operations -vector, most operations return errors. +the vnode even if it has a non-zero reference count. +If the vnode had a non-zero reference count, the vnode is then assigned +an operations vector corresponding to the "dead" file system. +In this operations vector, most operations return errors. .Ss Vnode locks Note to beginners: locks don't actually prevent memory from being read -or overwritten. Instead, they are an object that, where used, allows -only one piece of code to proceed through the locked section. If you -do not surround a stretch of code with a lock, it can and probably +or overwritten. +Instead, they are an object that, where used, allows only one piece of code +to proceed through the locked section. +If you do not surround a stretch of code with a lock, it can and probably will eventually be executed simultaneously with other stretches of code -(including stretches ). Chances are the results will be unexpected and -disappointing to both the user and you. +(including stretches ). +Chances are the results will be unexpected and disappointing to both the +user and you. .Pp The vnode actually has three different types of lock: the vnode lock, the vnode interlock, and the vnode reclamation lock (VXLOCK). .Ss The vnode lock -The most general lock is the vnode lock. This lock is acquired by -calling +The most general lock is the vnode lock. +This lock is acquired by calling .Xr vn_lock 9 and released by calling -.Xr vn_unlock 9 -. The vnode lock is used to serialize operations through the file system for +.Xr vn_unlock 9 . +The vnode lock is used to serialize operations through the file system for a given file when there are multiple concurrent requests on the same file. Many file system functions require that you hold the vnode lock on entry. The vnode lock may be held when sleeping. @@ -105,39 +112,42 @@ The .Xr revoke 2 and forcible unmount features in BSD UNIX allows a user to invalidate files and their associated vnodes at almost any -time, even if there are active open files on it. While in a region of code -protected by the vnode lock, the process is guaranteed that the vnode -will not be reclaimed or invalidated. +time, even if there are active open files on it. +While in a region of code protected by the vnode lock, the process is +guaranteed that the vnode will not be reclaimed or invalidated. .Pp -The vnode lock is a multiple-reader or single-writer lock. An -exclusive vnode lock may be acquired multiple times by the same +The vnode lock is a multiple-reader or single-writer lock. +An exclusive vnode lock may be acquired multiple times by the same process. .Pp The vnode lock is somewhat messy because it is used for many purposes. Some clients of the vnode interface use it to try to bundle a series -of VOP_ method calls into an atomic group. Many file systems rely on -it to prevent race conditions in updating file system specific data -structures (as opposed to having their own locks). +of VOP_ method calls into an atomic group. +Many file systems rely on it to prevent race conditions in updating file +system specific data structures (as opposed to having their own locks). .Pp The implementation of the vnode lock is the responsibility of the individual -file systems. Not all file system implement it. +file systems. +Not all file system implement it. .Pp To prevent deadlocks, when acquiring locks on multiple vnodes, the lock of parent directory must be acquired before the lock on the child directory. .Pp Interrupt handlers must not acquire vnode locks. .Ss Vnode interlock -The vnode interlock (vp->v_interlock) is a spinlock. It is useful on -multi-processor systems for acquiring a quick exclusive lock on the -contents of the vnode. It MUST NOT be held while sleeping. (What -fields does it cover? What about splbio/interrupt issues?) +The vnode interlock (vp->v_interlock) is a spinlock. +It is useful on multi-processor systems for acquiring a quick exclusive +lock on the contents of the vnode. +It MUST NOT be held while sleeping. +(What fields does it cover? What about splbio/interrupt issues?) .Pp Operations on this lock are a no-op on uniprocessor systems. .Ss Other Vnode synchronization The vnode reclamation lock (VXLOCK) is used to prevent multiple -processes from entering the vnode reclamation code. It is also used as -a flag to indicate that reclamation is in progress. The VXWANT flag is -set by processes that wish to woken up when reclamation is finished. +processes from entering the vnode reclamation code. +It is also used as a flag to indicate that reclamation is in progress. +The VXWANT flag is set by processes that wish to woken up when reclamation +is finished. .Pp The .Xr vwaitforio 9 @@ -146,11 +156,12 @@ vnode to complete. .Ss Version number/capability The vnode capability, v_id, is a 32-bit version number on the vnode. Every time a vnode is reassigned to a new file, the vnode capability -is changed. This is used by code that wish to keep pointers to vnodes -but doesn't want to hold a reference (e.g. caches). The code keeps -both a vnode * and a copy of the capability. The code can later compare -the vnode's capability to its copy and see if the vnode still -points to the same file. +is changed. +This is used by code that wish to keep pointers to vnodes but doesn't want +to hold a reference (e.g., caches). +The code keeps both a vnode * and a copy of the capability. +The code can later compare the vnode's capability to its copy and see +if the vnode still points to the same file. .Pp Note: for this to work, memory assigned to hold a struct vnode can only be used for another purpose when all pointers to it have disappeared. @@ -158,8 +169,8 @@ Since the vnode pool has no way of knowing when all pointers have disappeared, it never frees memory it has allocated for vnodes. .Ss Vnode fields Most of the fields of the vnode structure should be treated as opaque -and only manipulated through the proper APIs. This section describes -the fields that are manipulated directly. +and only manipulated through the proper APIs. +This section describes the fields that are manipulated directly. .Pp The v_flag attribute contains random flags related to various functions. They are summarized in table ... @@ -167,33 +178,39 @@ They are summarized in table ... The v_tag attribute indicates what file system the vnode belongs to. Very little code actually uses this attribute and its use is deprecated. Programmers should seriously consider using more object-oriented approaches -(e.g. function tables). There is no safe way of defining new v_tags -for loadable file systems. The v_tag attribute is read-only. +(e.g. function tables). +There is no safe way of defining new v_tags for loadable file systems. +The v_tag attribute is read-only. .Pp The v_type attribute indicates what type of file (e.g. directory, -regular, fifo) this vnode is. This is used by the generic code to -ensure for various checks. For example, the +regular, fifo) this vnode is. +This is used by the generic code to ensure for various checks. +For example, the .Xr read 2 system call returns an error when a read is attempted on a directory. .Pp The v_data attribute allows a file system to attach piece of file -system specific memory to the vnode. This contains information about -the file that is specific to the file system. +system specific memory to the vnode. +This contains information about the file that is specific to +the file system. .Pp The v_numoutput attribute indicates the number of pending synchronous -and asynchronous writes on the vnode. It does not track the number of -dirty buffers attached to the vnode. The attribute is used by code -like fsync to wait for all writes to complete before returning to the -user. This attribute must be manipulated at splbio(). +and asynchronous writes on the vnode. +It does not track the number of dirty buffers attached to the vnode. +The attribute is used by code like fsync to wait for all writes +to complete before returning to the user. +This attribute must be manipulated at splbio(). .Pp The v_writecount attribute tracks the number of write calls pending on the vnode. .Ss RULES The vast majority of vnode functions may not be called from interrupt -context. The exceptions are bgetvp and brelvp. The following -fields of the vnode are manipulated at interrupt level: v_numoutput, -v_holdcnt, v_dirtyblkhd, v_cleanblkhd, v_bioflag, v_freelist, and -v_synclist. Any accesses to these field should be protected by splbio, +context. +The exceptions are bgetvp and brelvp. +The following fields of the vnode are manipulated at interrupt level: +v_numoutput, v_holdcnt, v_dirtyblkhd, v_cleanblkhd, v_bioflag, v_freelist, +and v_synclist. +Any accesses to these field should be protected by splbio, unless you are certain that there is no chance an interrupt handler will modify them. .Pp @@ -202,14 +219,9 @@ reaches zero and the vnode lock is freed. .Pp A vnode will not be reclaimed as long as the vnode lock is held. If the vnode reference count drops to zero while a process is holding -the vnode lock, the vnode MAY be queued for reclamation. Increasing -the reference count from 0 to 1 while holding the lock will most likely -cause intermittent kernel panics. -.Sh SEE ALSO - +the vnode lock, the vnode MAY be queued for reclamation. +Increasing the reference count from 0 to 1 while holding the lock will +most likely cause intermittent kernel panics. .Sh HISTORY This document first appeared in -.Ox 2.9 -. - - +.Ox 2.9 . diff --git a/share/man/man9/vwaitforio.9 b/share/man/man9/vwaitforio.9 index 39f2d106504..630a814124b 100644 --- a/share/man/man9/vwaitforio.9 +++ b/share/man/man9/vwaitforio.9 @@ -14,7 +14,8 @@ The .Fn vwaitforio call sleeps until all asynchronous writes associated with the vnode .Nm vp -finish. This is used by functions that need to make sure +finish. +This is used by functions that need to make sure that the writes they initiated have completed. .Pp The @@ -30,14 +31,15 @@ flags indicate flags to be passed to This function must be called at splbio(). .Pp It may be important to ensure that no other process submits asynchronous -writes while you are waiting for I/O on this vnode. Otherwise, -vwaitforio may never return. +writes while you are waiting for I/O on this vnode. +Otherwise, vwaitforio may never return. .Pp (Vnode interlock??) .Sh RETURN VALUES The .Fn vwaitforio -function returns 0 on success. See +function returns 0 on success. +See .Xr tsleep 9 for possible error returns. .Sh SEE ALSO |