[src/trunk]: src/share/man/man4 Work this man page over for mdoc(7) issues, n...

[fair <fair%NetBSD.org@localhost>]

details:   https://anonhg.NetBSD.org/src/rev/03279408183a
branches:  trunk
changeset: 471682:03279408183a
user:      fair <fair%NetBSD.org@localhost>
date:      Wed Apr 07 21:39:34 1999 +0000

description:
Work this man page over for mdoc(7) issues, nroff issues, a few
mispellings, etc. It should be reviewed before being pulled up to
the 1.4 branch.

diffstat:

 share/man/man4/ec.4 |  125 ++++++++++++++++++++++++++++++++++++++-------------
 1 files changed, 93 insertions(+), 32 deletions(-)

diffs (170 lines):

diff -r 101a273387df -r 03279408183a share/man/man4/ec.4
--- a/share/man/man4/ec.4       Wed Apr 07 21:37:11 1999 +0000
+++ b/share/man/man4/ec.4       Wed Apr 07 21:39:34 1999 +0000
@@ -1,4 +1,4 @@
-.\"    $NetBSD: ec.4,v 1.6 1999/03/16 01:19:15 garbled Exp $
+.\"    $NetBSD: ec.4,v 1.7 1999/04/07 21:39:34 fair Exp $
 .\"
 .\" Copyright (c) 1997 The NetBSD Foundation, Inc.
 .\" All rights reserved.
@@ -40,17 +40,38 @@
 .Os
 .Sh NAME
 .Nm ec
-.Nd device driver for 3Com Etherlink II (3c503) Ethernet cards
+.Nd driver for 3Com Etherlink II (3c503)
+.Tn ISA
+bus
+.Tn Ethernet
+cards
 .Sh SYNOPSIS
 .Cd "ec0 at isa? port 0x250 iomem 0xd8000 irq 9"
 .Sh DESCRIPTION
 The
 .Nm
-device driver supports 3Com Etherlink II (3c503) Ethernet cards.
+device driver supports 3Com Etherlink II (3c503)
+.Tn Ethernet
+cards for
+.Tn ISA
+bus which are based on the National Semiconductor DP8390/WD83C690
+.Tn Ethernet
+interface chips.
 .Sh MEDIA SELECTION
-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
-transciever.  Software cannot differentiate between BNC and UTP cards.
+The Etherlink II supports two media types on a single card.
+All support the
+.Tn AUI
+media type.
+The other media is either
+.Tn BNC
+or
+.Tn UTP
+behind a transceiver.
+Software cannot differentiate between
+.Tn BNC
+and
+.Tn UTP
+cards.
 .Pp
 To enable the AUI media, select the
 .Em 10base5
@@ -59,7 +80,14 @@
 media type with
 .Xr ifconfig 8 's
 .Sq media
-directive.  To select the other media (BNC or UTP), select the
+directive.
+To select the other media
+.Po
+.Tn BNC
+or
+.Tn UTP
+.Pc ,
+select the
 .Em 10base2
 or
 .Em bnc
@@ -67,42 +95,75 @@
 .Sh DIAGNOSTICS
 .Bl -diag
 .It "ec0: wildcarded IRQ is not allowed"
-The IRQ was wildcarded in the kernel configuration file.  This is not
-supported.
+.Pp
+The
+.Tn 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.
+.Pp
+An
+.Tn IRQ
+other than the above
+.Tn IRQ
+values was specified in the kernel configuration file.
+The Etherlink II hardware only supports the above listed
+.Tn IRQ
+values.
 .It "ec0: failed to clear shared memory at offset <off>"
+.Pp
 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.
-.It ec0: warning - receiver ring buffer overrun
-The DP8390 Ethernet chip used by this board implements a shared-memory
+.It "ec0: warning - receiver ring buffer overrun"
+.Pp
+The DP8390
+.Tn Ethernet
+chip used by this board implements a shared-memory
 ring-buffer to store incoming packets.
-
-The 3c503 usually has only 8k bytes of shared memory.  This is only
-enough room for about 4 full-size (1500 byte) packets.  This can
-sometimes be a problem, especially on the original 3c503, because
+The 3c503 usually has only 8K bytes of shared memory.
+This is only enough room for about 4 full-size (1500 byte) packets.
+This can sometimes be a problem, especially on the original 3c503, because
 these boards' shared-memory access speed is quite slow; typically only
-about 1MB/second.  The overhead of this slow memory access, and the
-fact that there is only room for 4 full-sized packets means that the
-ring-buffer will occassionally overrun.  When this happens, the board
-must be reset to avoid a lockup problem in early revision 8390's.
+about 1MB/second.
+The overhead of this slow memory access, and the fact that there
+is only room for 4 full-sized packets means that the ring-buffer
+will occassionally overrun.
+.Pp
+When an overrun occurrs, the board must be reset to avoid a lockup
+problem in early revision DP8390
+.Tn Ethernet
+chips.
 Resetting the board causes all of the data in the ring-buffer to be
-lost, requiring it to be retransmitted/received, congesting the board
-further.  Because of this, maximum throughput on these boards is only
-about 400-600k per second.
+lost, requiring the data to be retransmitted/received, congesting the board
+further.
+Because of this, maximum throughput on these boards is only about
+400-600K bytes per second.
 .Pp
-This problem is exasperated by NFS because the 8bit boards lack
-sufficient memory to support the default 8k byte packets that NFS and
-other protocols use as their default.  If these cards must be used
-with NFS, use the NFS -r and -w options in /etc/fstab to limit NFS's
-packet size.  4096k byte packets generally work.
+This problem is exacerbated by
+.Tn NFS
+because the 8-bit boards lack sufficient packet buffer memory to
+support the default 8K byte packets that
+.Tn NFS
+and other protocols use as their default.
+If these cards must be used
+with
+.Tn NFS ,
+use the
+.Xr mount_nfs 8
+.Fl \&r
+and
+.Fl \&w
+options in
+.Pa /etc/fstab
+to limit NFS's packet size.
+4K (4096) byte packets generally work.
 .El
 .Sh SEE ALSO
 .Xr ifmedia 4 ,
 .Xr intro 4 ,
 .Xr isa 4 ,
-.Xr ifconfig 8
+.Xr ifconfig 8 ,
+.Xr mount_nfs 8