aboutsummaryrefslogtreecommitdiff
path: root/share/man/man4
diff options
context:
space:
mode:
authorSheldon Hearn <sheldonh@FreeBSD.org>2000-03-02 14:54:02 +0000
committerSheldon Hearn <sheldonh@FreeBSD.org>2000-03-02 14:54:02 +0000
commit4e86fcacf69e8dac21f67db61babdcae80903dc2 (patch)
tree11e6c1004800534c82bd3b37f48ff4dda29e2989 /share/man/man4
parentb22b0eaef005d00199fe216b0544647dc3682cf0 (diff)
Notes
Diffstat (limited to 'share/man/man4')
-rw-r--r--share/man/man4/an.49
-rw-r--r--share/man/man4/ccd.43
-rw-r--r--share/man/man4/ch.43
-rw-r--r--share/man/man4/ed.463
-rw-r--r--share/man/man4/en.43
-rw-r--r--share/man/man4/intpm.43
-rw-r--r--share/man/man4/ipfirewall.46
-rw-r--r--share/man/man4/isp.43
-rw-r--r--share/man/man4/man4.i386/dgb.439
-rw-r--r--share/man/man4/man4.i386/ed.463
-rw-r--r--share/man/man4/man4.i386/en.43
-rw-r--r--share/man/man4/man4.i386/ep.46
-rw-r--r--share/man/man4/man4.i386/gsc.497
-rw-r--r--share/man/man4/man4.i386/mcd.415
-rw-r--r--share/man/man4/man4.i386/mse.433
-rw-r--r--share/man/man4/man4.i386/pnp.433
-rw-r--r--share/man/man4/man4.i386/wi.424
-rw-r--r--share/man/man4/pcvt.412
-rw-r--r--share/man/man4/ppbus.46
-rw-r--r--share/man/man4/rl.43
-rw-r--r--share/man/man4/wi.424
-rw-r--r--share/man/man4/xl.457
-rw-r--r--share/man/man4/yp.490
23 files changed, 399 insertions, 199 deletions
diff --git a/share/man/man4/an.4 b/share/man/man4/an.4
index 2743c67064935..65d72b1f6dbd1 100644
--- a/share/man/man4/an.4
+++ b/share/man/man4/an.4
@@ -62,8 +62,10 @@ kernel pccard driver support and the
daemon.
ISA cards can either be configured to use ISA Plug and Play
or to use a particular I/O address and IRQ
-by properly setting the DIP switches on the board. (The default
-switch setting is for plug and play.) The
+by properly setting the DIP switches on the board.
+(The default
+switch setting is for plug and play.)
+The
.Nm
driver has Plug and Play support and will work in either configuration,
however when using a hard-wired I/O address and IRQ, the driver
@@ -86,7 +88,8 @@ selectable between 1Mbps, 2Mbps, 5.5Mbps, 11Mbps or
By default, the
.Nm
driver configures the Aironet card for ad-hoc operation with an SSID
-of "ANY." In this mode,
+of "ANY."
+In this mode,
stations can communicate among each other without the aid of an access
point.
To join a service set, the driver must be set for BSS mode using
diff --git a/share/man/man4/ccd.4 b/share/man/man4/ccd.4
index 27ffa2f147ca6..d93871c21cdcf 100644
--- a/share/man/man4/ccd.4
+++ b/share/man/man4/ccd.4
@@ -100,7 +100,8 @@ effect is achieved, which can increase sequential read/write
performance. The interleave factor is expressed in units of DEV_BSIZE
(usually 512 bytes). For large writes, the optimum interleave factor
is typically the size of a track, while for large reads, it is about a
-quarter of a track. (Note that this changes greatly depending on the
+quarter of a track.
+(Note that this changes greatly depending on the
number and speed of disks.) For instance, with eight 7,200 RPM drives
on two Fast-Wide SCSI buses, this translates to about 128 for writes
and 32 for reads. A larger interleave tends to work better when the
diff --git a/share/man/man4/ch.4 b/share/man/man4/ch.4
index d000c1474d822..dea964b3c72e7 100644
--- a/share/man/man4/ch.4
+++ b/share/man/man4/ch.4
@@ -70,7 +70,8 @@ In configuring, if an optional
.Ar count
is given in the specification, that number of SCSI media changers
are configured; Most storage for them is allocated only when found
-so a large number of configured devices is cheap. (once the first
+so a large number of configured devices is cheap.
+(once the first
has included the driver).
.Pp
diff --git a/share/man/man4/ed.4 b/share/man/man4/ed.4
index b0818e3e1f349..1138ccd022a37 100644
--- a/share/man/man4/ed.4
+++ b/share/man/man4/ed.4
@@ -67,24 +67,31 @@ are a bit field, and are summarized as follows:
.Pp
.Bl -hang -offset indent
.It Em 0x01
-Disable tranceiver. On those cards which support it, this flag causes the tranceiver to
+Disable tranceiver.
+On those cards which support it, this flag causes the tranceiver to
be disabled and the AUI connection to be used by default.
.It Em 0x02
-Force 8bit mode. This flag forces the card to 8bit mode regardless of how the
-card identifies itself. This may be needed for some clones which incorrectly
+Force 8bit mode.
+This flag forces the card to 8bit mode regardless of how the
+card identifies itself.
+This may be needed for some clones which incorrectly
identify themselves as 16bit, even though they only have an 8bit interface.
.It Em 0x04
-Force 16bit mode. This flag forces the card to 16bit mode regardless of how the
-card identifies itself. This may be needed for some clones which incorrectly
+Force 16bit mode.
+This flag forces the card to 16bit mode regardless of how the
+card identifies itself.
+This may be needed for some clones which incorrectly
identify themselves as 8bit, even though they have a 16bit ISA interface.
.It Em 0x08
-Disable transmitter multi-buffering. This flag disables the use of multiple
+Disable transmitter multi-buffering.
+This flag disables the use of multiple
transmit buffers and may be necessary in rare cases where packets are sent out
faster than a machine on the other end can handle (as evidenced by severe packet
lossage). Some
.Pf ( No non- Ns Tn FreeBSD
:-)) machines have terrible ethernet performance
-and simply can't cope with 1100K+ data rates. Use of this flag also provides
+and simply can't cope with 1100K+ data rates.
+Use of this flag also provides
one more packet worth of receiver buffering, and on 8bit cards, this may help
reduce receiver lossage.
.El
@@ -102,61 +109,75 @@ into the kernel) differs from the irq that has been set on the interface card.
.It "ed%d: failed to clear shared memory at %x - check configuration."
When the card was probed at system boot time, the
.Nm ed
-driver found that it could not clear the card's shared memory. This is most commonly
+driver found that it could not clear the card's shared memory.
+This is most commonly
caused by a BIOS extension ROM being configured in the same address space as the
-ethernet card's shared memory. Either find the offending card and change its BIOS
+ethernet card's shared memory.
+Either find the offending card and change its BIOS
ROM to be at an address that doesn't conflict, or change the
.Em iomem
option in the kernel config file so that the card's shared memory is mapped at a
non-conflicting address.
.It "ed%d: Invalid irq configuration (%d) must be 2-5 for 3c503."
The irq number that was specified in the kernel config file is not valid for
-the 3Com 3c503 card. The 3c503 can only be assigned to irqs 2 through 5.
+the 3Com 3c503 card.
+The 3c503 can only be assigned to irqs 2 through 5.
.It "ed%d: Cannot find start of RAM."
.It "ed%d: Cannot find any RAM, start : %d, x = %d."
The probe of a Gateway card was unsuccessful in configuring the card's packet memory.
This likely indicates that the card was improperly recognized as a Gateway or that
the card is defective.
.It "ed: packets buffered, but transmitter idle."
-Indicates a logic problem in the driver. Should never happen.
+Indicates a logic problem in the driver.
+Should never happen.
.It "ed%d: device timeout"
-Indicates that an expected transmitter interrupt didn't occur. Usually caused by an
+Indicates that an expected transmitter interrupt didn't occur.
+Usually caused by an
interrupt conflict with another card on the ISA bus.
.It "ed%d: NIC memory corrupt - invalid packet length %d."
Indicates that a packet was received with a packet length that was either larger than
-the maximum size or smaller than the minimum size allowed by the IEEE 802.3 standard. Usually
+the maximum size or smaller than the minimum size allowed by the IEEE 802.3 standard.
+Usually
caused by a conflict with another card on the ISA bus, but in some cases may also
indicate faulty cabling.
.It "ed%d: remote transmit DMA failed to complete."
This indicates that a programmed I/O transfer to an NE1000 or NE2000 style card
-has failed to properly complete. Usually caused by the ISA bus speed being set
+has failed to properly complete.
+Usually caused by the ISA bus speed being set
too fast.
.El
.Sh CAVEATS
-Early revision DS8390 chips have problems. They lock up whenever the receive
-ring-buffer overflows. They occasionally switch the byte order
+Early revision DS8390 chips have problems.
+They lock up whenever the receive
+ring-buffer overflows.
+They occasionally switch the byte order
of the length field in the packet ring header (several different causes
of this related to an off-by-one byte alignment) - resulting in "NIC
-memory corrupt - invalid packet length" messages. The card is reset
+memory corrupt - invalid packet length" messages.
+The card is reset
whenever these problems occur, but otherwise there is no problem with
recovering from these conditions.
.Pp
The NIC memory access to 3Com and Novell cards is much slower than it is on
WD/SMC cards; it's less than 1MB/second on 8bit boards and less than 2MB/second
-on the 16bit cards. This can lead to ring-buffer overruns resulting in
+on the 16bit cards.
+This can lead to ring-buffer overruns resulting in
dropped packets during heavy network traffic.
.Pp
-16bit Compex cards identify themselves as being 8bit. While these cards will
+16bit Compex cards identify themselves as being 8bit.
+While these cards will
work in 8bit mode, much higher performance can be achieved by specifying
.Em "flags 0x04"
-(force 16bit mode) in your kernel config file. In addition, you should also specify
+(force 16bit mode) in your kernel config file.
+In addition, you should also specify
.Em "iosize 16384"
to take advantage of the extra 8k of shared memory that 16bit mode provides.
.Sh BUGS
The
.Nm ed
driver is a bit too aggressive about resetting the card whenever any bad
-packets are received. As a result, it may throw out some good packets which
+packets are received.
+As a result, it may throw out some good packets which
have been received but not yet transfered from the card to main memory.
.Sh SEE ALSO
.Xr arp 4 ,
diff --git a/share/man/man4/en.4 b/share/man/man4/en.4
index 392506f4be75f..1fef5526cbd94 100644
--- a/share/man/man4/en.4
+++ b/share/man/man4/en.4
@@ -48,7 +48,8 @@ To enable the link use the following commands:
.It "en0: 7 32KB receive buffers, 8 32KB transmit buffers allocated"
.El
.Sh CAVEATS
-The driver extensively uses DMA on PCI. The first
+The driver extensively uses DMA on PCI.
+The first
generation PCI chipsets do not work or exhibit poor performance.
.Sh SEE ALSO
.Xr ifconfig 8 ,
diff --git a/share/man/man4/intpm.4 b/share/man/man4/intpm.4
index 68c04b6cbb9d8..e46dfb8342f81 100644
--- a/share/man/man4/intpm.4
+++ b/share/man/man4/intpm.4
@@ -44,7 +44,8 @@ This driver provides access to
.Tn Intel PIIX4 PCI Controller function 3 ,
Power management controller.
Currently, only smbus controller
-function is implemented. But it also have bus idle monitoring function.
+function is implemented.
+But it also have bus idle monitoring function.
It
will display mapped I/O address for bus monitoring function when attaching.
diff --git a/share/man/man4/ipfirewall.4 b/share/man/man4/ipfirewall.4
index 970246577c071..f69e23efe01b8 100644
--- a/share/man/man4/ipfirewall.4
+++ b/share/man/man4/ipfirewall.4
@@ -24,7 +24,8 @@ which point the corresponding action is taken.
Rules are numbered
from 1 to 65534; multiple rules may share the same number.
.Pp
-There is one rule that always exists, rule number 65535. This rule
+There is one rule that always exists, rule number 65535.
+This rule
normally causes all packets to be dropped.
Hence, any packet which does not
match a lower numbered rule will be dropped. However, a kernel compile
@@ -34,7 +35,8 @@ allows the administrator to change this fixed rule to permit everything.
.Pp
The value passed to
.Fn setsockopt
-is a struct ip_fw describing the rule (see below). In some cases
+is a struct ip_fw describing the rule (see below).
+In some cases
(such as IP_FW_DEL), only the rule number is significant.
.Sh COMMANDS
The following socket options are used to manage the rule list:
diff --git a/share/man/man4/isp.4 b/share/man/man4/isp.4
index c16c7329e7cc4..92ddaff48656f 100644
--- a/share/man/man4/isp.4
+++ b/share/man/man4/isp.4
@@ -198,7 +198,8 @@ as they should.
Sometimes, when booting, the driver gets stuck waiting for the Fibre Channel
f/w to tell it that the loop port database is ready.
In this case you'll
-see an announcement that the loop state has a value of 0x1. To unwedge
+see an announcement that the loop state has a value of 0x1.
+To unwedge
the system, unplug and replug the fibre channel connection, or otherwise
cause a LIP (Loop Initialization Primitive sequence)- this will kick the f/w
into getting unstuck.
diff --git a/share/man/man4/man4.i386/dgb.4 b/share/man/man4/man4.i386/dgb.4
index c1898aacd2ef7..29003f0e3e989 100644
--- a/share/man/man4/man4.i386/dgb.4
+++ b/share/man/man4/man4.i386/dgb.4
@@ -49,14 +49,16 @@
All values are just examples.
.Pp
The \fBNDGBPORTS\fR option defines the total number of ports on all cards
-installed in the system. When not defined the number is computed:
+installed in the system.
+When not defined the number is computed:
.br
default \fBNDGBPORTS\fR = number_of_described_DigiBoard_cards * 16
If it is less than the actual number of ports
the system will be able to use only the
-first \fBNDGBPORTS\fR ports. If it is greater then all ports will be usable
+first \fBNDGBPORTS\fR ports.
+If it is greater then all ports will be usable
but some memory will be wasted.
.Pp
Meaning of \fBflags\fR:
@@ -97,10 +99,12 @@ Input and output for each line may set to one of following baud rates;
.Pp
The driver doesn't use any interrupts, it is ``polling-based''. This means that
it uses clock interrupts instead of interrupts generated by DigiBoard cards and
-checks the state of cards 25 times per second. This is practical because the
+checks the state of cards 25 times per second.
+This is practical because the
DigiBoard cards have large input and output buffers (more than 1Kbyte per
port) and hardware that allows efficiently finding the port that needs
-attention. The only problem seen with this policy is slower
+attention.
+The only problem seen with this policy is slower
SLIP and PPP response.
.Pp
Each line in the kernel configuration file describes one card, not one port
@@ -145,15 +149,18 @@ for all the DigiBoards installed
(but not for any other card or real memory). DigiBoards
with a large amount of memory (256K or 512K and perhaps
even 128K) must be mapped
-to memory addresses outside of the first megabyte. If the computer
+to memory addresses outside of the first megabyte.
+If the computer
has more than 15 megabytes of memory then there is no free address space
outside of the first megabyte where such DigiBoards can be mapped.
In this case you
may need to reduce the amount of memory in the computer.
-But many machines provide a better solution. They have the ability to
+But many machines provide a better solution.
+They have the ability to
``turn off'' the memory in the 16th megabyte (addresses 0xF00000 - 0xFFFFFF)
using the
-BIOS setup. Then the DigiBoard's address space can be set to this ``hole''.
+BIOS setup.
+Then the DigiBoard's address space can be set to this ``hole''.
.\" XXX the following should be true for all serial drivers and
.\" should not be repeated in the man pages for all serial drivers.
.\" It was copied from sio.4. The only changes were s/sio/dgb/g.
@@ -267,12 +274,14 @@ the wrong \fBiomem\fR value is specified in the kernel config file.
.El
.Bl -diag
.It dgb\fIX\fB: BIOS start failed
-Problems with starting the on-board BIOS. Probably the memory addresses of the
+Problems with starting the on-board BIOS.
+Probably the memory addresses of the
DigiBoard overlap with some other device or with RAM.
.El
.Bl -diag
.It dgb\fIX\fB: BIOS download failed
-Problems with the on-board BIOS. Probably the memory addresses of the
+Problems with the on-board BIOS.
+Probably the memory addresses of the
DigiBoard overlap with some other device or with RAM.
.El
.Bl -diag
@@ -319,12 +328,14 @@ unusable due to misconfiguration.
.El
.Bl -diag
.It dgb\fIX\fB: port \fIY\fB: event \fIN\fB mstat \fIM\fB lstat \fIK\fB
-The driver got a strange event from card. Probably this means that you have a
+The driver got a strange event from card.
+Probably this means that you have a
newer card with an extended list of events or some other hardware problem.
.El
.Bl -diag
.It dgb\fIX\fB: port \fIY\fB: overrun
-Input buffer has filled up. Problems in polling logic of driver.
+Input buffer has filled up.
+Problems in polling logic of driver.
.El
.Bl -diag
.It dgb\fIX\fB: port \fIY\fB: FEP command on disabled port
@@ -357,6 +368,8 @@ There was a bug in implementation of
.Xr select 2 .
It is fixed now but not widely tested yet.
.Pp
-There is no ditty command. Most of its functions (alternate pinout,
-speed up to 115200 baud, etc.) are implemented in the driver itself. Some
+There is no ditty command.
+Most of its functions (alternate pinout,
+speed up to 115200 baud, etc.) are implemented in the driver itself.
+Some
other functions are missing.
diff --git a/share/man/man4/man4.i386/ed.4 b/share/man/man4/man4.i386/ed.4
index b0818e3e1f349..1138ccd022a37 100644
--- a/share/man/man4/man4.i386/ed.4
+++ b/share/man/man4/man4.i386/ed.4
@@ -67,24 +67,31 @@ are a bit field, and are summarized as follows:
.Pp
.Bl -hang -offset indent
.It Em 0x01
-Disable tranceiver. On those cards which support it, this flag causes the tranceiver to
+Disable tranceiver.
+On those cards which support it, this flag causes the tranceiver to
be disabled and the AUI connection to be used by default.
.It Em 0x02
-Force 8bit mode. This flag forces the card to 8bit mode regardless of how the
-card identifies itself. This may be needed for some clones which incorrectly
+Force 8bit mode.
+This flag forces the card to 8bit mode regardless of how the
+card identifies itself.
+This may be needed for some clones which incorrectly
identify themselves as 16bit, even though they only have an 8bit interface.
.It Em 0x04
-Force 16bit mode. This flag forces the card to 16bit mode regardless of how the
-card identifies itself. This may be needed for some clones which incorrectly
+Force 16bit mode.
+This flag forces the card to 16bit mode regardless of how the
+card identifies itself.
+This may be needed for some clones which incorrectly
identify themselves as 8bit, even though they have a 16bit ISA interface.
.It Em 0x08
-Disable transmitter multi-buffering. This flag disables the use of multiple
+Disable transmitter multi-buffering.
+This flag disables the use of multiple
transmit buffers and may be necessary in rare cases where packets are sent out
faster than a machine on the other end can handle (as evidenced by severe packet
lossage). Some
.Pf ( No non- Ns Tn FreeBSD
:-)) machines have terrible ethernet performance
-and simply can't cope with 1100K+ data rates. Use of this flag also provides
+and simply can't cope with 1100K+ data rates.
+Use of this flag also provides
one more packet worth of receiver buffering, and on 8bit cards, this may help
reduce receiver lossage.
.El
@@ -102,61 +109,75 @@ into the kernel) differs from the irq that has been set on the interface card.
.It "ed%d: failed to clear shared memory at %x - check configuration."
When the card was probed at system boot time, the
.Nm ed
-driver found that it could not clear the card's shared memory. This is most commonly
+driver found that it could not clear the card's shared memory.
+This is most commonly
caused by a BIOS extension ROM being configured in the same address space as the
-ethernet card's shared memory. Either find the offending card and change its BIOS
+ethernet card's shared memory.
+Either find the offending card and change its BIOS
ROM to be at an address that doesn't conflict, or change the
.Em iomem
option in the kernel config file so that the card's shared memory is mapped at a
non-conflicting address.
.It "ed%d: Invalid irq configuration (%d) must be 2-5 for 3c503."
The irq number that was specified in the kernel config file is not valid for
-the 3Com 3c503 card. The 3c503 can only be assigned to irqs 2 through 5.
+the 3Com 3c503 card.
+The 3c503 can only be assigned to irqs 2 through 5.
.It "ed%d: Cannot find start of RAM."
.It "ed%d: Cannot find any RAM, start : %d, x = %d."
The probe of a Gateway card was unsuccessful in configuring the card's packet memory.
This likely indicates that the card was improperly recognized as a Gateway or that
the card is defective.
.It "ed: packets buffered, but transmitter idle."
-Indicates a logic problem in the driver. Should never happen.
+Indicates a logic problem in the driver.
+Should never happen.
.It "ed%d: device timeout"
-Indicates that an expected transmitter interrupt didn't occur. Usually caused by an
+Indicates that an expected transmitter interrupt didn't occur.
+Usually caused by an
interrupt conflict with another card on the ISA bus.
.It "ed%d: NIC memory corrupt - invalid packet length %d."
Indicates that a packet was received with a packet length that was either larger than
-the maximum size or smaller than the minimum size allowed by the IEEE 802.3 standard. Usually
+the maximum size or smaller than the minimum size allowed by the IEEE 802.3 standard.
+Usually
caused by a conflict with another card on the ISA bus, but in some cases may also
indicate faulty cabling.
.It "ed%d: remote transmit DMA failed to complete."
This indicates that a programmed I/O transfer to an NE1000 or NE2000 style card
-has failed to properly complete. Usually caused by the ISA bus speed being set
+has failed to properly complete.
+Usually caused by the ISA bus speed being set
too fast.
.El
.Sh CAVEATS
-Early revision DS8390 chips have problems. They lock up whenever the receive
-ring-buffer overflows. They occasionally switch the byte order
+Early revision DS8390 chips have problems.
+They lock up whenever the receive
+ring-buffer overflows.
+They occasionally switch the byte order
of the length field in the packet ring header (several different causes
of this related to an off-by-one byte alignment) - resulting in "NIC
-memory corrupt - invalid packet length" messages. The card is reset
+memory corrupt - invalid packet length" messages.
+The card is reset
whenever these problems occur, but otherwise there is no problem with
recovering from these conditions.
.Pp
The NIC memory access to 3Com and Novell cards is much slower than it is on
WD/SMC cards; it's less than 1MB/second on 8bit boards and less than 2MB/second
-on the 16bit cards. This can lead to ring-buffer overruns resulting in
+on the 16bit cards.
+This can lead to ring-buffer overruns resulting in
dropped packets during heavy network traffic.
.Pp
-16bit Compex cards identify themselves as being 8bit. While these cards will
+16bit Compex cards identify themselves as being 8bit.
+While these cards will
work in 8bit mode, much higher performance can be achieved by specifying
.Em "flags 0x04"
-(force 16bit mode) in your kernel config file. In addition, you should also specify
+(force 16bit mode) in your kernel config file.
+In addition, you should also specify
.Em "iosize 16384"
to take advantage of the extra 8k of shared memory that 16bit mode provides.
.Sh BUGS
The
.Nm ed
driver is a bit too aggressive about resetting the card whenever any bad
-packets are received. As a result, it may throw out some good packets which
+packets are received.
+As a result, it may throw out some good packets which
have been received but not yet transfered from the card to main memory.
.Sh SEE ALSO
.Xr arp 4 ,
diff --git a/share/man/man4/man4.i386/en.4 b/share/man/man4/man4.i386/en.4
index 392506f4be75f..1fef5526cbd94 100644
--- a/share/man/man4/man4.i386/en.4
+++ b/share/man/man4/man4.i386/en.4
@@ -48,7 +48,8 @@ To enable the link use the following commands:
.It "en0: 7 32KB receive buffers, 8 32KB transmit buffers allocated"
.El
.Sh CAVEATS
-The driver extensively uses DMA on PCI. The first
+The driver extensively uses DMA on PCI.
+The first
generation PCI chipsets do not work or exhibit poor performance.
.Sh SEE ALSO
.Xr ifconfig 8 ,
diff --git a/share/man/man4/man4.i386/ep.4 b/share/man/man4/man4.i386/ep.4
index cdfe7eeed3da2..f4c57d6acf8c3 100644
--- a/share/man/man4/man4.i386/ep.4
+++ b/share/man/man4/man4.i386/ep.4
@@ -55,7 +55,8 @@ UTP, also known as twisted pair
.El
.Pp
The default port to use is the port that has been selected with the
-setup utility. To override this, use the following media options with
+setup utility.
+To override this, use the following media options with
.Xr ifconfig 8
or in your
.Pa /etc/rc.conf
@@ -107,4 +108,5 @@ Erase the pencil mark and reboot.
.Xr ifconfig 8 ,
.Xr ng_ether 8
.Sh STANDARDS
-are great. There's so many to choose from.
+are great.
+There's so many to choose from.
diff --git a/share/man/man4/man4.i386/gsc.4 b/share/man/man4/man4.i386/gsc.4
index 6ae7e35905621..8c097b5830101 100644
--- a/share/man/man4/man4.i386/gsc.4
+++ b/share/man/man4/man4.i386/gsc.4
@@ -65,16 +65,20 @@ output
The
.Nm gsc
character device driver currently handles only the
-Genius GS-4500 handy scanner. It operates in pure DMA modes, although
-the hardware could be set up to work with irq. I had neither enough
+Genius GS-4500 handy scanner.
+It operates in pure DMA modes, although
+the hardware could be set up to work with irq.
+I had neither enough
documentation nor experience in writing interrupt driven device
drivers.
.Pp
The device can operate at four different
.Em resolutions :
100, 200,
-300 and 400dpi. It produces a simple bitmap with the most significant
-bit at the left side. The driver can optionally output the famous and
+300 and 400dpi.
+It produces a simple bitmap with the most significant
+bit at the left side.
+The driver can optionally output the famous and
likely simple portable bitmap file format
.Xr pbm 5
by Jef Poskanzer.
@@ -87,7 +91,8 @@ only to name some of them ...). In
.Em raw
mode a
bit which is set means a black pixel because the scanner detects black
-points on white paper. On the other hand, because pnm format describes
+points on white paper.
+On the other hand, because pnm format describes
intensities of electron beams in video screens a set bit in
.Em pbm
mode means a white pixel.
@@ -95,13 +100,15 @@ mode means a white pixel.
The
.Em width
of the output bitmap is fixed as given by the
-resolution value. However, the
+resolution value.
+However, the
.Em height
of the bitmap must be
supplied in
.Em pnm
mode since the driver must know at what time the
-'end-of-file' shall be reached. With this feature you are able to
+'end-of-file' shall be reached.
+With this feature you are able to
directly copy the scanner output into a pbm file with
.Xr cat .
Of course you can obtain a similar effect by using
@@ -114,7 +121,8 @@ The
.Em graymap
output mode is not yet implemented into the driver.
It is even questionable if external programs would not do this job
-better thereby not counting to the size of the kernel. Even though, I
+better thereby not counting to the size of the kernel.
+Even though, I
do not know of tools which produce a graymap from a halftone bitmap.
.Pp
The ioctl requests that are served by
@@ -126,22 +134,26 @@ requests from within shell.
.It GSC_SRES int
Set the
.Em resolution
-value. If this call is made after the first
+value.
+If this call is made after the first
read access to the device there will be no effect unless the device is
closed and opened again.
.It GSC_GRES int
Get current resolution in dots per inch (dpi).
.It GSC_SRESSSW void
-Set resolution value from selector switch. The driver must be in an
+Set resolution value from selector switch.
+The driver must be in an
open though untouched state otherwise the request will fail and
.Xr errno 2
is set to EBUSY.
.It GSC_SWIDTH int
Set the
.Em width
-of the bitmap. Actually, this is an alternative
+of the bitmap.
+Actually, this is an alternative
way of setting the resolution, since any allowed resolution matches
-exactly one width. Allowed are listed in the table below.
+exactly one width.
+Allowed are listed in the table below.
.Bl -tag -width resolution -compact -offset indent
.It resolution
width
@@ -167,10 +179,13 @@ call to fail with
set to
.Er EINVAL .
.Pp
-As you can see, there are width values > 1696. This does, however, not
+As you can see, there are width values > 1696.
+This does, however, not
mean that you can obtain scanned lines longer than the width of your
-scanner or by higher resolutions. Actually, the resolution is selected
-by only by the hardware switch. Any line that is longer than what is
+scanner or by higher resolutions.
+Actually, the resolution is selected
+by only by the hardware switch.
+Any line that is longer than what is
defined for the actual resolution will be undefined (usually white) on
the right part that is exceeding the standard line.
.It GSC_GWIDTH int
@@ -180,35 +195,46 @@ Set the
.Em height
of the bitmap in
.Em pnm
-mode. This is actually
+mode.
+This is actually
a limit on the amount of lines scannable after the first read
-operation. When the limit is reached read will return 0. However, the
+operation.
+When the limit is reached read will return 0. However, the
device is turned off only when a close is performed (either
explicitly or implicitly on exit of the calling process).
.It GSC_GHEIGHT int
Get the current height of the bitmap.
.It GSC_SBLEN int
Set the length of the buffer used internally to do the DMA transfer.
-The buffer length is supplied in lines of the bitmap. Since the buffer
+The buffer length is supplied in lines of the bitmap.
+Since the buffer
size limit is (currently) 0x3000 bytes the maximum number of lines
-allowed will vary with the width of each line. This upper limit is
+allowed will vary with the width of each line.
+This upper limit is
checked before it overwrites the current value and pases an ENOMEM in
the
.Xr errno 2
-variable. However, since the bitmap width can change
+variable.
+However, since the bitmap width can change
after a buffer length was selected a read request may fail with ENOMEM
-if the buffer length turns out too high. It is generally wise to
+if the buffer length turns out too high.
+It is generally wise to
choose long buffers rather than go save in order to obtain better
output.
.It GSC_GBLEN int
Get the current buffer length in lines.
.It GSC_SBTIME int
-Set the timeout for the completion of reading one buffer. Since a
+Set the timeout for the completion of reading one buffer.
+Since a
handy scanner is a human/computer interface timeout values are usually
-higher than those of a flat scanner. Default is 15 seconds. After
-timeout is reached the read operation will fail with EBUSY. Note that
+higher than those of a flat scanner.
+Default is 15 seconds.
+After
+timeout is reached the read operation will fail with EBUSY.
+Note that
the timeout timer starts anew for each buffer to be read and thus does
-not cause you to scan faster for longer images. BLEN/BTIME is similar
+not cause you to scan faster for longer images.
+BLEN/BTIME is similar
as MIN/TIME in termios(4).
.It GSC_GBTIME int
Get the current buffer timeout.
@@ -216,19 +242,24 @@ Get the current buffer timeout.
.Pp
All ioctl requests that modify a parameter except GSC_SBTIME do not
have an effect on an ongoing scan process, i.e. after the first read
-request that follows open. You must close the device and open it again
-for the new selections to take effect. Consequently, the selections
+request that follows open.
+You must close the device and open it again
+for the new selections to take effect.
+Consequently, the selections
are not reset when you close or open the device.
.Pp
Similarly, requests that read a value do not report the value that is
-used for the ongoing scan process. The values needed during the scan
+used for the ongoing scan process.
+The values needed during the scan
process are saved when it starts and thus are not accessed by ioctl
requests.
.Pp
The BTIME value does, however, have an immediate effect on the ongoing
-scan. Thus the timeout can for example be set to long until the user
+scan.
+Thus the timeout can for example be set to long until the user
starts scanning. It can then be set to a short amount to react
-(nearly) immediately when the user stops. Note that the user should be
+(nearly) immediately when the user stops.
+Note that the user should be
left time to at least fill one buffer without having to haste.
.Pp
Note that the
@@ -236,7 +267,8 @@ Note that the
versus
.Em raw
mode selection is done by the
-minor number not by ioctl requests. In
+minor number not by ioctl requests.
+In
.Em raw
mode the selected
height of the bitmap will have no effect.
@@ -295,6 +327,7 @@ whose debug bit (i.e. bit 5 out of 7) is set.
.Sh BUGS
Even though the scanner device has a little switch by which you should
be able to select one of the four resolution modes, I could not yet
-determine how to read its status. Unless this is not fixed the driver
+determine how to read its status.
+Unless this is not fixed the driver
depends on the value passed by means of ioctl(2) which need not match
what is selected by the hardware.
diff --git a/share/man/man4/man4.i386/mcd.4 b/share/man/man4/man4.i386/mcd.4
index 42f49539f8295..fd65713de937c 100644
--- a/share/man/man4/man4.i386/mcd.4
+++ b/share/man/man4/man4.i386/mcd.4
@@ -38,8 +38,10 @@
The
.Nm mcd
driver provides a data and audio interface to the Mitsumi-brand CD-ROM
-player. The CD-ROM player must be interfaced to the ISA bus through
-one of the Mitsumi proprietary controller boards. The controller
+player.
+The CD-ROM player must be interfaced to the ISA bus through
+one of the Mitsumi proprietary controller boards.
+The controller
boards supported are the LU002S, LU005S, the FX001 and the quite
common FX001D.
.Pp
@@ -62,7 +64,8 @@ The
.Nm mcd
driver also responds to special CD-ROM
.Fn ioctl
-commands. These commands
+commands.
+These commands
control the CD-ROM player's audio features.
The commands are:
.Pp
@@ -107,7 +110,8 @@ The
.Fn ioctl
commands defined above are the only ones that the
.Nm mcd
-driver supports. There are other CD-ROM related
+driver supports.
+There are other CD-ROM related
.Fn ioctl
commands (such as
.Dv CDIOCSETVOL
@@ -132,7 +136,8 @@ CD-ROM player as the performance on data is abysmal.
.Pp
The current version of the driver uses neither the DMA or IRQ
features of the interface board, although it has an interrupt handler
-for any IRQ requests that are generated. Until the DMA features are
+for any IRQ requests that are generated.
+Until the DMA features are
supported, the only interrupts that the board generates are those that
aren't supported by the driver anyway.
.Sh SEE ALSO
diff --git a/share/man/man4/man4.i386/mse.4 b/share/man/man4/man4.i386/mse.4
index d3b8638f63ee5..369d15ca3732a 100644
--- a/share/man/man4/man4.i386/mse.4
+++ b/share/man/man4/man4.i386/mse.4
@@ -35,19 +35,23 @@ and a D-sub 9-pin male connector or a round DIN 9-pin
male connector.
.Pp
The primary port address of the bus and InPort mouse interface cards
-is usually 0x23c. Some cards may also be set to use the secondary port
-address at 0x238. The interface cards require a single IRQ, which may be
+is usually 0x23c.
+Some cards may also be set to use the secondary port
+address at 0x238.
+The interface cards require a single IRQ, which may be
2, 3, 4 or 5. Some cards may offer additional IRQs.
The port number and the IRQ number are configured by jumpers on the cards
or by software provided with the card.
.Pp
Frequency, or report rate, at which the device sends movement
and button state reports to the host system, may also be configurable on
-some interface cards. It may be 15, 30, 60 or 120Hz.
+some interface cards.
+It may be 15, 30, 60 or 120Hz.
.Pp
The difference between the two types of the mice is not in mouse devices
(in fact they are exactly the same). But in the circuit on the interface
-cards. This means that the device from a bus mouse package can be
+cards.
+This means that the device from a bus mouse package can be
connected to the interface card from an InPort mouse package, or vice
versa, provided that their connectors match.
.Ss Operation Levels
@@ -71,7 +75,8 @@ Always zero.
.It bit 2
Left button status; cleared if pressed, otherwise set.
.It bit 1
-Middle button status; cleared if pressed, otherwise set. Always one,
+Middle button status; cleared if pressed, otherwise set.
+Always one,
if the device does not have the middle button.
.It bit 0
Right button status; cleared if pressed, otherwise set.
@@ -101,7 +106,8 @@ driver can somewhat `accelerate' the movement of the pointing device.
The faster you move the device, the further the pointer
travels on the screen.
The driver has an internal variable which governs the effect of
-the acceleration. Its value can be modified via the driver flag
+the acceleration.
+Its value can be modified via the driver flag
or via an ioctl call.
.Ss Device Number
The minor device number of the
@@ -124,7 +130,8 @@ for device node names.
.Ss Driver Flags
The
.Nm
-driver accepts the following driver flag. Set it in the
+driver accepts the following driver flag.
+Set it in the
kernel configuration file
.Pq see Xr config 8
or in the User Configuration Menu at
@@ -136,7 +143,8 @@ the boot time
This flag controls the amount of acceleration effect.
The smaller the value of this flag is, more sensitive the movement becomes.
The minimum value allowed, thus the value for the most sensitive setting,
-is one. Setting this flag to zero will completely disables the
+is one.
+Setting this flag to zero will completely disables the
acceleration effect.
.El
.Sh IOCTLS
@@ -258,7 +266,8 @@ If it is zero, acceleration is disabled.
.Pp
The
.Dv packetsize
-field specifies the length of the data packet. It depends on the
+field specifies the length of the data packet.
+It depends on the
operation level.
.Pp
.Bl -tag -width level_0__ -compact
@@ -273,7 +282,8 @@ The array
holds a bit mask and pattern to detect the first byte of the
data packet.
.Dv syncmask[0]
-is the bit mask to be ANDed with a byte. If the result is equal to
+is the bit mask to be ANDed with a byte.
+If the result is equal to
.Dv syncmask[1] ,
the byte is likely to be the first byte of the data packet.
Note that this detection method is not 100% reliable,
@@ -296,7 +306,8 @@ Only
.Dv level
and
.Dv accelfactor
-may be modifiable. Setting values in the other field does not generate
+may be modifiable.
+Setting values in the other field does not generate
error and has no effect.
.\" .Pp
.\" .It Dv MOUSE_GETVARS Ar mousevar_t *vars
diff --git a/share/man/man4/man4.i386/pnp.4 b/share/man/man4/man4.i386/pnp.4
index df9adec6a9c34..9970232d39a18 100644
--- a/share/man/man4/man4.i386/pnp.4
+++ b/share/man/man4/man4.i386/pnp.4
@@ -46,26 +46,31 @@ parameters in the card's configuration space.
The manual override mechanism requires the kernel to be compiled with
.Cd options USERCONFIG.
In this case, the kernel keeps a table of fixed size (20 entries as a
-default) where configuration data are held for PnP devices. Each
+default) where configuration data are held for PnP devices.
+Each
PnP card can contain several independent devices (5 or 6 is not
unusual).
.Pp
By booting the kernel with the
.Dq Fl c
flag, commands are available to
-modify the configuration of PnP cards. Commands start with the
+modify the configuration of PnP cards.
+Commands start with the
sequence:
.Dl pnp CSN LDN
where CSN and LDN are the Card Select Number and Logical Device Number
-associated to the device. Following this sequence any combination of
+associated to the device.
+Following this sequence any combination of
the following commands can be used:
.Bl -tag -width "mmmmmmmmmm""
.It Dv irqN line
-Sets the irq line for interrupt 0 or 1 on the card. Line=0 means the line
+Sets the irq line for interrupt 0 or 1 on the card.
+Line=0 means the line
is unused.
.It Dv drqN n
-Sets the drq channel used for DMA 0 or 1 on the card. Channel=4 means
+Sets the drq channel used for DMA 0 or 1 on the card.
+Channel=4 means
the channel is unused.
.It Dv portN address
Sets the base address for the N-th port's range (N=0..7). address=0
@@ -74,7 +79,8 @@ means that the port is not used.
Sets the base address for the N-th memory's range (N=0..3). address=0
means that the memory range is not used.
.It Dv bios
-Makes the PnP device use the configuration set by the BIOS. This
+Makes the PnP device use the configuration set by the BIOS.
+This
is the default, and is generally ok if your BIOS has PnP support.
If BIOS is used, then other parameters are ignored except "flags".
.It Dv os
@@ -88,13 +94,15 @@ Frees the entry used for the device, so that it can be used for
another device with a different CSN/LDN pair.
.It Dv flags
Sets the value of a 32-bit flags entry which is passed to the device
-driver. This can be used to set special operation modes (e.g. SB vs. WSS
+driver.
+This can be used to set special operation modes (e.g. SB vs. WSS
emulation on some sound cards, etc.).
.El
.Pp
The current content of the table can be printed using the
.Ic ls
-command in userconfig. In addition to modifications done by the user,
+command in userconfig.
+In addition to modifications done by the user,
the table contains an entry for
all logical devices accessed by a PnP device driver.
.Pp
@@ -137,15 +145,18 @@ This data structure (defined in /sys/i386/isa/pnp.h) contains all
informations related to a PnP logical device.
.It Fn read_pnp_parms "struct pnp_cinfo *d" "int ldn"
This function returns the configuration of the requested
-logical device. It is not possible to specify a CSN since this function
+logical device.
+It is not possible to specify a CSN since this function
is only meant to be used during probe and attach routines
.It Fn write_pnp_parms "struct pnp_cinfo *d" "int ldn"
-This function sets the parameters of the requested logical device. At
+This function sets the parameters of the requested logical device.
+At
the same time, it updates the entry in the kernel override table.
Device drivers in general should
.Em not
modify the configuration of a device, since either the BIOS or the user
-(through userconfig) should know better what to do. In particular,
+(through userconfig) should know better what to do.
+In particular,
device driver
.Em should not enable
a logical device which has
diff --git a/share/man/man4/man4.i386/wi.4 b/share/man/man4/man4.i386/wi.4
index 7246daf1663b6..9e40cdfd668be 100644
--- a/share/man/man4/man4.i386/wi.4
+++ b/share/man/man4/man4.i386/wi.4
@@ -45,27 +45,35 @@ The
driver provides support for WaveLAN/IEEE PCCARD adapters (also known
as WaveLAN II cards). Note that while Lucent sells both ISA and PCMCIA
WaveLAN/IEEE devices, the ISA product is actually a PCMCIA card in an
-ISA to PCMCIA bridge adapter. Consequently, the
+ISA to PCMCIA bridge adapter.
+Consequently, the
.Nm
-driver is required for both the ISA and PCMCIA NICs. Both the original
+driver is required for both the ISA and PCMCIA NICs.
+Both the original
2Mbps WaveLAN/IEEE cards and the newer 6Mbps WaveLAN/IEEE Turbo
adapters are supported.
.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
+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. The
+and ad-hoc operation modes.
+The
.Nm
driver encapsulates all IP and ARP traffic as 802.11 frames, however
-it can receive either 802.11 or 802.3 frames. Transmit speed is
+it can receive either 802.11 or 802.3 frames.
+Transmit speed is
selectable between 1Mbps fixed, 2Mbps fixed or 2Mbps with auto fallback.
For WaveLAN/IEEE Turbo adapters, speeds up to 6Mbps are available.
.Pp
By default, the
.Nm
-driver configures the WaveLAN card for ad-hoc operation. In this mode,
+driver configures the WaveLAN card for ad-hoc operation.
+In this mode,
stations can communicate among each other without the aid of an access
-point. To join a service set, the driver must be set for BSS mode using
+point.
+To join a service set, the driver must be set for BSS mode using
the
.Xr wicontrol 8
utility.
diff --git a/share/man/man4/pcvt.4 b/share/man/man4/pcvt.4
index 89c5fc966f225..230a9e01ee044 100644
--- a/share/man/man4/pcvt.4
+++ b/share/man/man4/pcvt.4
@@ -234,7 +234,8 @@ If an option is given with no value, a value of 1
.Pq activated
is substituted.
If an option value is given as 0, this options is
-deactivated. Any other value is substituted by 1, too.
+deactivated.
+Any other value is substituted by 1, too.
If an option
is omitted, a built-in default is assumed.
@@ -303,7 +304,8 @@ Default: off
.It Em PCVT_EMU_MOUSE
Emulate a three-button mouse via the keypad.
Useful for notebooks when
-running XFree86. See
+running XFree86.
+See
.Sx Mouse emulation
below.
.br
@@ -524,7 +526,8 @@ were the mouse emulator device.
The mouse emulation is turned on by
pressing the
.Aq Em NumLock
-key. The pointer is moved by the numerical keypad keys, into the
+key.
+The pointer is moved by the numerical keypad keys, into the
obvious directions.
The pointer is initially moved in single steps,
and is accelerated after an adjustable time
@@ -729,7 +732,8 @@ sets the number of columns for the current screen,
.El
its parameter is a pointer to an integer containing either a value of 80,
-or a value of 132. Note that setting the number of columns to 132 is
+or a value of 132.
+Note that setting the number of columns to 132 is
only supported on VGA adaptors.
Any unsupported numbers cause the ioctl
to fail with
diff --git a/share/man/man4/ppbus.4 b/share/man/man4/ppbus.4
index 3ca7453c06d91..1ee649cc9570d 100644
--- a/share/man/man4/ppbus.4
+++ b/share/man/man4/ppbus.4
@@ -178,7 +178,8 @@ operate at close to the same performance levels as an equivalent ISA plug-in
card.
.Pp
At software level, you may implement the protocol you wish, using data and
-address cycles as you want. This is for the IEEE1284 compatible part.
+address cycles as you want.
+This is for the IEEE1284 compatible part.
Then,
peripheral vendors may implement protocol handshake with the following
status lines: PError, nFault and Select.
@@ -224,7 +225,8 @@ states.
.Pp
At any time, the slave may want to send data to the host.
This is only
-possible from forward idle states (nibble, byte, ecp...). So, the
+possible from forward idle states (nibble, byte, ecp...).
+So, the
host must have previously negotiated to permit the peripheral to
request transfer.
Interrupt lines may be dedicated to the requesting signals
diff --git a/share/man/man4/rl.4 b/share/man/man4/rl.4
index 40fa7e19d88b1..9709841d57781 100644
--- a/share/man/man4/rl.4
+++ b/share/man/man4/rl.4
@@ -207,7 +207,8 @@ DMAing all of it.
.Pp
The driver can check for an incomplete frame by inspecting the frame
length in the header preceeding the actual packet data: an incomplete
-frame will have the magic length of 0xFFF0. When the driver encounters
+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
diff --git a/share/man/man4/wi.4 b/share/man/man4/wi.4
index 7246daf1663b6..9e40cdfd668be 100644
--- a/share/man/man4/wi.4
+++ b/share/man/man4/wi.4
@@ -45,27 +45,35 @@ The
driver provides support for WaveLAN/IEEE PCCARD adapters (also known
as WaveLAN II cards). Note that while Lucent sells both ISA and PCMCIA
WaveLAN/IEEE devices, the ISA product is actually a PCMCIA card in an
-ISA to PCMCIA bridge adapter. Consequently, the
+ISA to PCMCIA bridge adapter.
+Consequently, the
.Nm
-driver is required for both the ISA and PCMCIA NICs. Both the original
+driver is required for both the ISA and PCMCIA NICs.
+Both the original
2Mbps WaveLAN/IEEE cards and the newer 6Mbps WaveLAN/IEEE Turbo
adapters are supported.
.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
+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. The
+and ad-hoc operation modes.
+The
.Nm
driver encapsulates all IP and ARP traffic as 802.11 frames, however
-it can receive either 802.11 or 802.3 frames. Transmit speed is
+it can receive either 802.11 or 802.3 frames.
+Transmit speed is
selectable between 1Mbps fixed, 2Mbps fixed or 2Mbps with auto fallback.
For WaveLAN/IEEE Turbo adapters, speeds up to 6Mbps are available.
.Pp
By default, the
.Nm
-driver configures the WaveLAN card for ad-hoc operation. In this mode,
+driver configures the WaveLAN card for ad-hoc operation.
+In this mode,
stations can communicate among each other without the aid of an access
-point. To join a service set, the driver must be set for BSS mode using
+point.
+To join a service set, the driver must be set for BSS mode using
the
.Xr wicontrol 8
utility.
diff --git a/share/man/man4/xl.4 b/share/man/man4/xl.4
index 3bd9edb9439ff..86be2a97cfc4b 100644
--- a/share/man/man4/xl.4
+++ b/share/man/man4/xl.4
@@ -45,7 +45,8 @@ The
.Nm
driver provides support for PCI ethernet adapters and embedded
controllers based on the 3Com "boomerang" and "cyclone" bus-master
-Etherlink XL chips. This includes the 3c900-TP, 3c900-COMBO, 3c905-TX,
+Etherlink XL chips.
+This includes the 3c900-TP, 3c900-COMBO, 3c905-TX,
3c905-T4, 3c905B-TP, 3c905B-T4 and 3c905B-TX, and embedded 3c905-TX
and 3c905B-TX ethernet hardware in certain Dell Optiplex and Dell
Precision desktop machines, and certain Dell Latitude laptop docking
@@ -53,10 +54,12 @@ stations.
.Pp
The Etherlink XL chips support built-in 10baseT, 10base2 and 10base5
transceivers as well as an MII bus for externally attached PHY
-transceivers. The 3c905 series typically uses a National Semiconductor
+transceivers.
+The 3c905 series typically uses a National Semiconductor
NS 83840A 10/100 PHY for 10/100 Mbps support in full or half-duplex.
The 3c905B adapters have built-in autonegotiation logic mapped onto
-the MII for compatibility with previous drivers. Fast Etherlink XL
+the MII for compatibility with previous drivers.
+Fast Etherlink XL
adapters such as the 3c905-TX and 3c905B-TX are capable of 10 or
100Mbps data rates in either full or half duplex and can be manually
configured for any supported mode or automatically negotiate the highest
@@ -68,22 +71,27 @@ driver supports the following media types:
.Pp
.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
.It autoselect
-Enable autoselection of the media type and options. Note that this
+Enable autoselection of the media type and options.
+Note that this
option is only available with the 3c905 and 3c905B adapters with
-external PHYs or built-in autonegotiation logic. For 3c900 adapters,
-the driver will choose the mode specified in the EEPROM. The user can
+external PHYs or built-in autonegotiation logic.
+For 3c900 adapters,
+the driver will choose the mode specified in the EEPROM.
+The user can
change this by adding media options to the
.Pa /etc/rc.conf
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
or
.Ar half-duplex modes.
.It 100baseTX
-Set 100Mbps (fast ethernet) operation. The
+Set 100Mbps (fast ethernet) operation.
+The
.Ar mediaopt
option can abso be used to select either
.Ar full-duplex
@@ -127,39 +135,50 @@ allocating a pad buffer or collapsing an mbuf chain into a cluster.
.It "xl%d: command never completed!"
Some commands issued to the 3c90x ASIC take time to complete: the
driver is supposed to wait until the 'command in progress' bit in
-the status register clears before continuing. In rare instances, this
-bit may not clear. To avoid getting caught in an infinite wait loop,
+the status register clears before continuing.
+In rare instances, this
+bit may not clear.
+To avoid getting caught in an infinite wait loop,
the driver only polls the bit for a finite number of times before
-giving up, at which point it issues this message. This message may
-be printed during driver initialization on slower machines. If you
+giving up, at which point it issues this message.
+This message may
+be printed during driver initialization on slower machines.
+If you
see this message but the driver continues to function normally, the
message can probably be ignored.
.It "xl%d: chip is in D3 power state -- setting to D0"
This message applies only to 3c905B adapters, which support power
-management. Some operating systems place the 3c905B in low power
+management.
+Some operating systems place the 3c905B in low power
mode when shutting down, and some PCI BIOSes fail to bring the chip
-out of this state before configuring it. The 3c905B loses all of
+out of this state before configuring it.
+The 3c905B 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
+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
.Fx ,
the card should be configured correctly.
.It "xl%d: WARNING: no media options bits set in the media options register!"
This warning may appear when using the driver on some Dell Latitude
-docking stations with built-in 3c905-TX adapters. For whatever the
+docking stations with built-in 3c905-TX adapters.
+For whatever the
reason, the 'MII available' bit in the media options register on
this particular equipment is not set, even though it should be (the
3c905-TX always uses an external PHY transceiver). The driver will
attempt to guess the proper media type based on the PCI device ID
-word. The driver makes a lot of noise about this condition because
+word.
+The driver makes a lot of noise about this condition because
the author considers it a manufacturing defect.
.El
.Sh SEE ALSO
diff --git a/share/man/man4/yp.4 b/share/man/man4/yp.4
index bc268565d29ec..dda8944bb79e5 100644
--- a/share/man/man4/yp.4
+++ b/share/man/man4/yp.4
@@ -88,7 +88,8 @@ is an
client/server system that allows a group of
machines within an
.Tn NIS
-domain to share a common set of configuration files. This permits a system
+domain to share a common set of configuration files.
+This permits a system
administrator to set up
.Tn NIS
client systems with only minimal configuration
@@ -109,11 +110,13 @@ where
.Pa [domainname]
is the name of the
.Tn NIS
-domain being served. A single
+domain being served.
+A single
.Tn NIS
server can
support several domains at once, therefore it is possible to have several
-such directories, one for each supported domain. Each domain will have
+such directories, one for each supported domain.
+Each domain will have
its own independent set of maps.
.Pp
In
@@ -137,8 +140,10 @@ into
and
.Em .pag
files which the ndbm code uses to hold separate parts of the hash
-database. The Berkeley DB hash method instead uses a single file for
-both pieces of information. This means that while you may have
+database.
+The Berkeley DB hash method instead uses a single file for
+both pieces of information.
+This means that while you may have
.Pa passwd.byname.dir
and
.Pa passwd.byname.pag
@@ -153,7 +158,8 @@ server,
.Xr ypserv 8 ,
and related tools need to know the database format of the
.Tn NIS
-maps. Client
+maps.
+Client
.Tn NIS
systems receive all
.Tn NIS
@@ -200,20 +206,24 @@ command) and begins broadcasting
requests on the local network.
These requests specify the name of the domain for which
.Xr ypbind 8
-is attempting to establish a binding. If a server that has been
+is attempting to establish a binding.
+If a server that has been
configured to serve the requested domain receives one of the broadcasts,
it will respond to
.Xr ypbind 8 ,
-which will record the server's address. If there are several servers
+which will record the server's address.
+If there are several servers
available (a master and several slaves, for example),
.Xr ypbind 8
-will use the address of the first one to respond. From that point
+will use the address of the first one to respond.
+From that point
on, the client system will direct all of its
.Tn NIS
requests to that server.
.Xr Ypbind 8
will occasionally ``ping'' the server to make sure it's still up
-and running. If it fails to receive a reply to one of its pings
+and running.
+If it fails to receive a reply to one of its pings
within a reasonable amount of time,
.Xr ypbind 8
will mark the domain as unbound and begin broadcasting again in the
@@ -231,7 +241,8 @@ is responsible for receiving incoming requests from
clients,
translating the requested domain and map name to a path to the
corresponding database file and transmitting data from the database
-back to the client. There is a specific set of requests that
+back to the client.
+There is a specific set of requests that
.Xr ypserv 8
is designed to handle, most of which are implemented as functions
within the standard C library:
@@ -280,11 +291,13 @@ and are not meant to be used by standard utilities.
.Pp
On networks with a large number of hosts, it is often a good idea to
use a master server and several slaves rather than just a single master
-server. A slave server provides the exact same information as a master
+server.
+A slave server provides the exact same information as a master
server: whenever the maps on the master server are updated, the new
data should be propagated to the slave systems using the
.Xr yppush 8
-command. The
+command.
+The
.Tn NIS
Makefile
.Pf ( Pa /var/yp/Makefile )
@@ -305,8 +318,10 @@ master server using
automatically from within
.Xr ypserv 8 ;
therefore it is not usually necessary for the administrator
-to use it directly. It can be run manually if
-desired, however.) Maintaining
+to use it directly.
+It can be run manually if
+desired, however.)
+Maintaining
slave servers helps improve
.Tn NIS
performance on large
@@ -328,11 +343,13 @@ domain to extend beyond
a local network (the
.Xr ypbind 8
daemon might not be able to locate a server automatically if it resides on
-a network outside the reach of its broadcasts. It is possible to force
+a network outside the reach of its broadcasts.
+It is possible to force
.Xr ypbind 8
to bind to a particular server with
.Xr ypset 8
-but this is sometimes inconvenient. This problem can be avoided simply by
+but this is sometimes inconvenient.
+This problem can be avoided simply by
placing a slave server on the local network.)
.El
.Pp
@@ -345,7 +362,8 @@ other
implementations) when used exclusively with
.Bx Free
client
-systems. The
+systems.
+The
.Bx Free
password database system (which is derived directly
from
@@ -373,8 +391,10 @@ in a special way: the server will only provide access to these
maps in response to requests that originate on privileged ports.
Since only the super-user is allowed to bind to a privileged port,
the server assumes that all such requests come from privileged
-users. All other requests are denied: requests from non-privileged
-ports will receive only an error code from the server. Additionally,
+users.
+All other requests are denied: requests from non-privileged
+ports will receive only an error code from the server.
+Additionally,
.Bx Free Ns 's
.Xr ypserv 8
includes support for Wietse Venema's tcp wrapper package; with tcp
@@ -384,7 +404,8 @@ to respond only to selected client machines.
.Pp
While these enhancements provide better security than stock
.Tn NIS Ns ,
-they are by no means 100% effective. It is still possible for
+they are by no means 100% effective.
+It is still possible for
someone with access to your network to spoof the server into disclosing
the shadow password maps.
.Pp
@@ -393,9 +414,11 @@ On the client side,
.Fn getpwent 3
functions will automatically search for the
.Pa master.passwd
-maps and use them if they exist. If they do, they will be used, and
+maps and use them if they exist.
+If they do, they will be used, and
all fields in these special maps (class, password age and account
-expiration) will be decoded. If they aren't found, the standard
+expiration) will be decoded.
+If they aren't found, the standard
.Pa passwd
maps will be used instead.
.Sh COMPATIBILITY
@@ -405,7 +428,8 @@ to be running in order
for their hostname resolution functions (
.Fn gethostbyname ,
.Fn gethostbyaddr ,
-etc) to work properly. On these systems,
+etc) to work properly.
+On these systems,
.Xr ypserv 8
performs
.Tn DNS
@@ -425,12 +449,14 @@ if desired), therefore its
server doesn't do
.Tn DNS
lookups
-by default. However,
+by default.
+However,
.Xr ypserv 8
can be made to perform
.Tn DNS
lookups if it is started with a special
-flag. It can also be made to register itself as an
+flag.
+It can also be made to register itself as an
.Tn NIS
v1 server
in order to placate certain systems that insist on the presence of
@@ -463,7 +489,8 @@ client and server capabilities, it does not yet have support for
.Xr ypupdated 8
or the
.Fn yp_update
-function. Both of these require secure
+function.
+Both of these require secure
.Tn RPC Ns ,
which
.Bx Free
@@ -476,7 +503,8 @@ and
.Xr getprotoent 3
functions do not yet have
.Tn NIS
-support. Fortunately, these files
+support.
+Fortunately, these files
don't need to be updated that often.
.Pp
Many more manual pages should be written, especially
@@ -492,7 +520,8 @@ The
.Nm YP
subsystem was written from the ground up by
.An Theo de Raadt
-to be compatible to Sun's implementation. Bug fixes, improvements
+to be compatible to Sun's implementation.
+Bug fixes, improvements
and
.Tn NIS
server support were later added by
@@ -501,5 +530,6 @@ The server-side code was originally written by
.An Peter Eriksson
and
.An Tobias Reber
-and is subject to the GNU Public License. No Sun code was
+and is subject to the GNU Public License.
+No Sun code was
referenced.