summaryrefslogtreecommitdiffstats
path: root/share/man
diff options
context:
space:
mode:
authorru <ru@FreeBSD.org>2003-05-29 21:28:36 +0000
committerru <ru@FreeBSD.org>2003-05-29 21:28:36 +0000
commitef7bd611e1004a79a0ea0cf2cea1f15b71549179 (patch)
tree74b70200b0d17eb96b38ad3ff190ecc1b98308df /share/man
parent2618a96d5eaa02adcc4f5043ef029e9c1bc51c81 (diff)
downloadFreeBSD-src-ef7bd611e1004a79a0ea0cf2cea1f15b71549179.zip
FreeBSD-src-ef7bd611e1004a79a0ea0cf2cea1f15b71549179.tar.gz
Assorted mdoc(7) fixes.
Approved by: re (blanket)
Diffstat (limited to 'share/man')
-rw-r--r--share/man/man4/axe.439
-rw-r--r--share/man/man4/mac_portacl.469
-rw-r--r--share/man/man4/man4.i386/pae.433
-rw-r--r--share/man/man4/man4.i386/sbni.4108
-rw-r--r--share/man/man4/man4.i386/vpd.440
-rw-r--r--share/man/man4/my.49
-rw-r--r--share/man/man4/rndtest.414
-rw-r--r--share/man/man4/rue.450
-rw-r--r--share/man/man4/sbsh.432
9 files changed, 227 insertions, 167 deletions
diff --git a/share/man/man4/axe.4 b/share/man/man4/axe.4
index e759d18..a2f2966 100644
--- a/share/man/man4/axe.4
+++ b/share/man/man4/axe.4
@@ -58,12 +58,13 @@ LinkSys USB200M
Netgear FA120
.El
.Pp
-The AX88172 is a USB 2.0 device which contains a 10/100
+The AX88172 is a USB 2.0 device which contains a 10/100
ethernet MAC with MII interface and is designed to work with both
-ethernet and HomePNA transceivers. The AX88172 will operate with
+ethernet and HomePNA transceivers.
+The AX88172 will operate with
both USB 1.x and USB 2.0 controllers, however performace with 1.x
contollers will be limited since the USB 1.x standard specifies a
-maximum transfer speed of 12Mbps.
+maximum transfer speed of 12Mbps.
Users with USB 1.x controllers should therefore not expect to actually
achieve 100Mbps speeds with these devices.
.Pp
@@ -75,46 +76,44 @@ received and transmitted over separate USB bulk transfer endpoints.
The
.Nm
driver supports the following media types:
-.Pp
-.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
-.It autoselect
+.Bl -tag -width ".Cm 10baseT/UTP"
+.It Cm autoselect
Enable autoselection of the media type and options.
The user can manually override
the autoselected mode by adding media options to the
.Pa /etc/rc.conf
file.
-.It 10baseT/UTP
+.It Cm 10baseT/UTP
Set 10Mbps operation.
The
-.Ar mediaopt
+.Cm mediaopt
option can also be used to enable
-.Ar full-duplex
+.Cm full-duplex
operation.
Not specifying
-.Ar full duplex
+.Cm full-duplex
implies
-.Ar half-duplex
+.Cm half-duplex
mode.
-.It 100baseTX
+.It Cm 100baseTX
Set 100Mbps (fast ethernet) operation.
The
-.Ar mediaopt
+.Cm mediaopt
option can also be used to enable
-.Ar full-duplex
+.Cm full-duplex
operation.
Not specifying
-.Ar full duplex
+.Cm full-duplex
implies
-.Ar half-duplex
+.Cm half-duplex
mode.
.El
.Pp
The
.Nm
driver supports the following media options:
-.Pp
-.Bl -tag -width xxxxxxxxxxxxxxxxxxxx
-.It full-duplex
+.Bl -tag -width ".Cm 10baseT/UTP"
+.It Cm full-duplex
Force full duplex operation.
The interface will operate in
half duplex mode if this media option is not specified.
@@ -138,7 +137,7 @@ The driver failed to allocate an mbuf for the receiver ring.
.Xr ng_ether 4 ,
.Xr ifconfig 8
.Rs
-.%T ASIX AX88172 data sheet
+.%T "ASIX AX88172 data sheet"
.%O http://www.asix.com.tw
.Re
.Sh HISTORY
diff --git a/share/man/man4/mac_portacl.4 b/share/man/man4/mac_portacl.4
index 41a2fd8..1fba379 100644
--- a/share/man/man4/mac_portacl.4
+++ b/share/man/man4/mac_portacl.4
@@ -1,12 +1,12 @@
.\" Copyright (c) 2003 Networks Associates Technology, Inc.
.\" All rights reserved.
-.\"
+.\"
.\" This software was developed for the FreeBSD Project by Chris Costello
.\" at Safeport Network Services and Network Associates Labs, the
.\" Security Research Division of Network Associates, Inc. under
.\" DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"), as part of the
.\" DARPA CHATS research program.
-.\"
+.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
@@ -15,7 +15,7 @@
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
-.\"
+.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHORS AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -27,10 +27,12 @@
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
-.\"
+.\"
.\" $FreeBSD$
-.Dd MARCH 11, 2003
+.\"
+.Dd March 11, 2003
.Dt MAC_PORTACL 4
+.Os
.Sh NAME
.Nm mac_portacl
.Nd network port access control policy
@@ -38,21 +40,30 @@
To compile the port access control policy into your kernel,
place the following lines in your kernel
configuration file:
+.Bd -ragged -offset indent
.Cd "options MAC"
.Cd "options MAC_PORTACL"
+.Ed
.Pp
Alternately, to load the port access control policy module at boot time,
place the following line in your kernel configuration file:
+.Bd -ragged -offset indent
.Cd "options MAC"
+.Ed
.Pp
-and in
+and in
.Xr loader.conf 5 :
-.Cd mac_portacl_load= Ns \&"YES"
+.Pp
+.Dl "mac_portacl_load=""YES"""
.Sh DESCRIPTION
The
.Nm
policy allows administrators to administratively limit binding to
-local UDP and TCP ports via the
+local
+.Tn UDP
+and
+.Tn TCP
+ports via the
.Xr sysctl 8
interface.
.Pp
@@ -78,49 +89,52 @@ MIB in the following format:
.Pp
.Sm off
.Bd -literal -offset indent
-.Sy idtype
+.Ar idtype
.Li :
-.Sy id
+.Ar id
.Li :
-.Sy protocol
+.Ar protocol
.Li :
-.Sy port
-.Li [,
-.Sy idtype
+.Ar port
+.Oo
+.Li ,
+.Ar idtype
.Li :
-.Sy id
+.Ar id
.Li :
-.Sy protocol
+.Ar protocol
.Li :
-.Sy port
-.Li ,...]
+.Ar port
+.Li ,
+.Ar ...
+.Oc
.Ed
.Sm on
.Pp
-.Bl -tag -width protocol
-.It Sy idtype
+.Bl -tag -width ".Ar protocol"
+.It Ar idtype
Describes the type of subject match to be performed.
Either
.Li uid
-for userid matching, or
+for user ID matching, or
.Li gid
for group ID matching.
-.It Sy id
+.It Ar id
The user or group ID (depending on
-.Sy idtype )
+.Ar idtype )
allowed to bind to the specified port.
.Bf -emphasis
NOTE: User and group names are not valid; only the actual ID numbers
may be used.
.Ef
-.It Sy protocol
+.It Ar protocol
Describes which protocol this entry applies to.
Either
.Li tcp
or
.Li udp
are supported.
-.It Sy port
+.It Ar port
Describes which port this entry applies to.
.Bf -emphasis
NOTE: MAC security policies may not override other security system policies
@@ -131,7 +145,7 @@ by allowing accesses that they may deny, such as
If the specified port falls within the range specified, the
.Nm
entry will not function
-(i.e. even the specified user/group may not be able to bind to the specified
+(i.e., even the specified user/group may not be able to bind to the specified
port).
.El
.Sh SEE ALSO
@@ -152,5 +166,6 @@ MAC first appeared in
This software was contributed to the
.Fx
Project by NAI Labs, the Security Research Division of Network Associates
-Inc. under DARPA/SPAWAR contract N66001-01-C-8035 ("CBOSS"),
+Inc. under DARPA/SPAWAR contract N66001-01-C-8035
+.Pq Dq CBOSS ,
as part of the DARPA CHATS research program.
diff --git a/share/man/man4/man4.i386/pae.4 b/share/man/man4/man4.i386/pae.4
index 30e3596..6ec0306 100644
--- a/share/man/man4/man4.i386/pae.4
+++ b/share/man/man4/man4.i386/pae.4
@@ -37,10 +37,10 @@
.Sh NAME
.Nm PAE
.Sh SYNOPSIS
-.Cd options PAE
+.Cd "options PAE"
.Sh DESCRIPTION
The
-.Nm
+.Dv PAE
option provides support for the physical address extensions capability
of the
.Tn Intel
@@ -49,35 +49,35 @@ and above CPUs,
and allows for up to 64 gigabytes of memory to be used in systems capable
of supporting it.
With the
-.Nm
+.Dv PAE
option, memory above 4 gigabytes is simply added to the general page pool.
The system makes no distinction between memory above or below 4 gigabytes,
and no specific facility is provided for a process or the kernel to access
more memory than they would otherwise be able to access, through a sliding
window or otherwise.
.Sh SEE ALSO
-.Xr smp 4
-.Xr tuning 7
+.Xr smp 4 ,
+.Xr tuning 7 ,
.Xr config 8
.Sh HISTORY
The
-.Nm
+.Dv PAE
option first appeared in
.Fx 5.1 .
.Sh AUTHORS
.An Jake Burkholder Aq jake@FreeBSD.org
.Sh BUGS
-Since kld modules are not compiled with the same options headers that
+Since KLD modules are not compiled with the same options headers that
the kernel is compiled with,
they must not be loaded into a kernel compiled with the
-.Nm
+.Dv PAE
option.
.Pp
Many devices or their device drivers are not capable of direct memory access
to physical addresses above 4 gigabytes.
In order to make use of direct memory access IO in a system with more than
4 gigabytes of memory when the
-.Nm
+.Dv PAE
option is used,
these drivers must use a facility for remapping or substituting physical
memory which is not accessible to the device.
@@ -86,16 +86,16 @@ One such facility is provided by the
interface.
Device drivers which do not account for such devices will not work reliably
in a system with more than 4 gigabytes of memory when the
-.Nm
+.Dv PAE
option is used,
and may cause data corruption.
The
-.Nm
+.Pa PAE
kernel configuration file includes the
-.Nm
+.Dv PAE
option, and explicitly excludes all device drivers which are known to not work
or have not been tested in a system with the
-.Nm
+.Dv PAE
option and more than 4 gigabytes of memory.
.Pp
Many parameters which determine how memory is used in the kernel are based on
@@ -110,11 +110,12 @@ to the kernel,
or to reduce the amount of a specific resource that is heavily used,
in order to avoid running out of virtual address space.
The
-.Nm KVA_PAGES
+.Dv KVA_PAGES
option may be used to increase the kernel virtual address space,
and the
-.Nm kern.maxvnodes
-sysctl may be used to decrease the number of vnodes allowed,
+.Va kern.maxvnodes
+.Xr sysctl 8
+may be used to decrease the number of vnodes allowed,
an example of a resource that the kernel is likely to overallocate in
large memory configurations.
For optimal performance and stability it may be necessary to consult the
diff --git a/share/man/man4/man4.i386/sbni.4 b/share/man/man4/man4.i386/sbni.4
index b7d4fa5..31cf610 100644
--- a/share/man/man4/man4.i386/sbni.4
+++ b/share/man/man4/man4.i386/sbni.4
@@ -1,5 +1,5 @@
.\" Written by Denis I. Timofeev, 2002.
-.\"
+.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
@@ -8,7 +8,7 @@
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
-.\"
+.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -25,7 +25,7 @@
.\"
.Dd January 8, 2002
.Dt SBNI 4 i386
-.Os FreeBSD
+.Os
.Sh NAME
.Nm sbni
.Nd Granch SBNI12 leased line modem driver
@@ -33,44 +33,67 @@
.Cd "device sbni"
.Sh DESCRIPTION
The
-.Nm sbni
+.Nm
driver provides support for leased line modems of following models:
.Pp
-.Bl -tag -compact
-.It Pa SBNI12-02, SBNI12D-02
-.It Pa SBNI12-04, SBNI12D-04
-.It Pa SBNI12-05, SBNI12D-05, ISA and PCI
-.It Pa SBNI12-10, SBNI12D-10, ISA and PCI
+.Bl -bullet -compact
+.It
+SBNI12-02, SBNI12D-02
+.It
+SBNI12-04, SBNI12D-04
+.It
+SBNI12-05, SBNI12D-05, ISA and PCI
+.It
+SBNI12-10, SBNI12D-10, ISA and PCI
.El
.Pp
-and a kit for data link over a voice band
-SBNI12-11, SBNI12D-11, ISA and PCI.
+and a kit for data link over a voice band:
+.Bl -bullet
+.It
+SBNI12-11, SBNI12D-11, ISA and PCI.
+.El
.Pp
-In addition to the standard port and irq specifications, the
+In addition to the standard port and IRQ specifications, the
.Nm
driver also supports a number of
-.Em flags
+.Va flags
which can set baud rate, receive level, and low three bytes of Ethernet
-MAC-address (high three always are 00:ff:01), because Granch modems is
-presented to the system as Ethernet-like netcards.
+MAC-address (high three are always
+.Li 00:ff:01 ) ,
+because Granch modems are
+presented to the system as Ethernet-like network cards.
.Pp
The high byte of the
-.Em flags
-is a bit field, it's used to specify SBNI adapter receive level/baud rate:
-.Bd -literal
- Bits 0-3: receive level (0x00..0x0f)
- Bits 4-5: baud rate number:
- 00 - 0 baud rate (2Mb in fast mode/500kb in slow)
- 01 - 1 baud rate (1Mb/250kb)
- 10 - 2 baud rate (500kb/125kb)
- 11 - 3 baud rate (250kb/62.5kb)
- Bit 6 : use fixed receive level
- if bit 6 is set then receive level will be set according
- to bits 0-3 value, otherwise receive level will be
- autodetected
- Bit 7 : use fixed baud rate
- if bit 7 is set then baud rate will be set according to
- bits 4-5 value, otherwise baud rate is set to 2Mb
+.Va flags
+is a bit field, it is used to specify SBNI adapter receive level/baud rate:
+.Bl -tag -width "Bits 0-3:" -offset indent
+.It "Bits 0-3:"
+receive level (0x00..0x0f)
+.It "Bits 4-5:"
+baud rate number:
+.Pp
+.Bl -inset -compact
+.It "00 -"
+0 baud rate (2Mb in fast mode/500kb in slow)
+.It "01 -"
+1 baud rate (1Mb/250kb)
+.It "10 -"
+2 baud rate (500kb/125kb)
+.It "11 -"
+3 baud rate (250kb/62.5kb)
+.El
+.It "Bit 6:"
+use fixed receive level
+.Pp
+if bit 6 is set then receive level will be set according
+to bits 0-3 value, otherwise receive level will be
+autodetected
+.It "Bit 7:"
+use fixed baud rate
+.Pp
+if bit 7 is set then baud rate will be set according to
+bits 4-5 value, otherwise baud rate is set to 2Mb
+.El
.Sh FILES
The sources for the driver reside in:
.Pp
@@ -89,12 +112,21 @@ The
device driver first appeared in
.Fx 4.6 .
.Sh AUTHORS
+.An -nosplit
The
-.Nm sbni
-device driver for FreeBSD 4.x was written by Denis I. Timofeev, partially
-based on David Greenman's
-.Nm ed
-driver. Earlier versions (available on ftp.granch.com) were written by
-Alexey V. Zverev.
+.Nm
+device driver for
+.Fx
+4.x was written by
+.An Denis I. Timofeev ,
+partially based on
+.An David Greenman Ns 's
+.Xr ed 4
+driver.
+Earlier versions (available on
+.Pa ftp.granch.com )
+were written by
+.An Alexey V. Zverev .
.Pp
-SBNI12 hardware was designed by Alexey V. Chirkov.
+SBNI12 hardware was designed by
+.An Alexey V. Chirkov .
diff --git a/share/man/man4/man4.i386/vpd.4 b/share/man/man4/man4.i386/vpd.4
index 89325c5..f47c5c9 100644
--- a/share/man/man4/man4.i386/vpd.4
+++ b/share/man/man4/man4.i386/vpd.4
@@ -24,8 +24,6 @@
.\"
.\" $FreeBSD$
.\"
-.\" Note: The date here should be updated whenever a non-trivial
-.\" change is made to the manual page.
.Dd April 4, 2003
.Dt VPD 4 i386
.Os
@@ -35,36 +33,42 @@
.Sh SYNOPSIS
.Cd "device vpd"
.Sh DESCRIPTION
-IBM ThinkPad notebooks (and most IBM desktop PCs) have a 48-byte
+.Tn IBM ThinkPad
+notebooks (and most
+.Tn IBM
+desktop PCs) have a 48-byte
Vital Product Data (VPD) structure located in the BIOS Shadow RAM.
.Pp
The VPD provides machine type and model information, the build ID
(this is roughly the BIOS version) and serial number information.
.Pp
The
-.Nm vpd
+.Nm
driver scans the BIOS area and claims the memory used by the VPD
-structure. It provides the
+structure.
+It provides the
.Xr sysctl 3
-branch hw.vpd to allow this information
-to be accessed by the userland.
+branch
+.Va hw.vpd
+to allow this information to be accessed by the userland.
The following variables are provided, one per VPD attachment (there should
only be one):
-.Bl -tag -width -indent
+.Pp
+.Bl -tag -width ".Dv MACHINE_MODEL" -compact
.It Dv MACHINE_TYPE
-.Pq machine.type
+.Pq Va machine.type
Machine type.
.It Dv MACHINE_MODEL
-.Pq machine.model
+.Pq Va machine.model
Machine model.
.It Dv BUILD_ID
-.Pq build.id
+.Pq Va build.id
BIOS Build ID.
.It Dv SERIAL_BOX
-.Pq serial.box
+.Pq Va serial.box
Box Serial Number.
.It Dv SERIAL_PLANAR
-.Pq serial.planar
+.Pq Va serial.planar
Motherboard Serial Number.
.El
.Sh SEE ALSO
@@ -77,13 +81,13 @@ Motherboard Serial Number.
.Sh HISTORY
The
.Nm
-driver and manual page example first appeared in
+driver first appeared in
.Fx 5.1 .
-.Pp
.Sh AUTHORS
-This
-manual page was written by
+The
+.Nm
+driver and this manual page were written by
.An Matthew N. Dodd Aq mdodd@FreeBSD.org .
.Sh BUGS
-The checksum code isn't quite correct so we're not able to detect
+The checksum code is not quite correct so we are not able to detect
a corrupt VPD structure.
diff --git a/share/man/man4/my.4 b/share/man/man4/my.4
index 096e5af..69f2712 100644
--- a/share/man/man4/my.4
+++ b/share/man/man4/my.4
@@ -23,12 +23,13 @@
.\" POSSIBILITY OF SUCH DAMAGE.
.\"
.\" $FreeBSD$
+.\"
.Dd May 16, 2003
.Dt MY 4
.Os
.Sh NAME
.Nm my
-.Nd Myson Technology Ethernet PCI Driver
+.Nd "Myson Technology Ethernet PCI driver"
.Sh SYNOPSIS
.Cd "device miibus"
.Cd "device my"
@@ -37,8 +38,8 @@ The
.Nm
driver provides support for various NICs based on the Myson chipset.
The Myson chipset is a variant of the DEC Tulip NIC chipset.
-.Pp
Supported models include:
+.Pp
.Bl -bullet -compact
.It
Myson MTD800 PCI Fast Ethernet chip
@@ -64,8 +65,8 @@ The
.Nm
driver was written by Myson Technology Inc.
.Pp
-This manual page is written by
-.An Hiten M. Pandya Aq hmp@FreeBSD.ORG .
+This manual page was written by
+.An Hiten M. Pandya Aq hmp@FreeBSD.org .
.Sh BUGS
The
.Nm
diff --git a/share/man/man4/rndtest.4 b/share/man/man4/rndtest.4
index b633a33..fe00c45 100644
--- a/share/man/man4/rndtest.4
+++ b/share/man/man4/rndtest.4
@@ -32,18 +32,21 @@
.Nm rndtest
.Nd FIPS 140-2 random number generator test monitor
.Sh SYNOPSIS
-.Cd device rndtest
+.Cd "device rndtest"
.Sh DESCRIPTION
The
.Nm
-driver ``hooks up'' to hardware crypto devices to monitor the
+driver
+.Dq "hooks up"
+to hardware crypto devices to monitor the
entropy data passed to the
.Xr random 4
subsystem.
This data is periodically tested for FIPS 140-2 compliance and
statistics are collected.
If the harvested entropy fails any of the FIPS test suite, then
-it is discarded and testing is continuously applied until ``good data''
+it is discarded and testing is continuously applied until
+.Dq "good data"
is received from the device.
Failures are optionally reported on the console.
.Sh SEE ALSO
@@ -53,7 +56,8 @@ Failures are optionally reported on the console.
.Xr ubsec 4 ,
.Xr crypto 9
.Sh HISTORY
-The idea for this and the original code came from Jason L. Wright.
+The idea for this and the original code came from
+.An "Jason L. Wright" .
The
.Nm
device driver first appeared in
@@ -64,4 +68,4 @@ this should not be necessary.
This feature might better be integrated into the
.Xr random 4
subsystem where it can be used applied to devices that claim to supply
-``pure entropy''.
+.Dq "pure entropy" .
diff --git a/share/man/man4/rue.4 b/share/man/man4/rue.4
index 3b69068..d0e29b5 100644
--- a/share/man/man4/rue.4
+++ b/share/man/man4/rue.4
@@ -1,7 +1,7 @@
-.\"
+.\"
.\" Copyright (c) 2001-2003, Shunsuke Akiyama <akiyama@FreeBSD.org>.
.\" All rights reserved.
-.\"
+.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
@@ -10,7 +10,7 @@
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
-.\"
+.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -22,16 +22,15 @@
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
-.\"
+.\"
.\" $FreeBSD$
-.\"
+.\"
.Dd May 3, 2003
.Dt RUE 4
-.Os FreeBSD
+.Os
.Sh NAME
.Nm rue
-.Nd
-RealTek RTL8150 USB To Fast Ethernet controller driver
+.Nd "RealTek RTL8150 USB To Fast Ethernet controller driver"
.Sh SYNOPSIS
.Cd "device uhci"
.Cd "device ohci"
@@ -45,7 +44,7 @@ driver provides support for USB Ethernet adapters based on the RealTek
RTL8150 USB to Fast Ethernet controller chip.
This includes the Melco Inc. LUA-KTX and the GREEN HOUSE GH-USB100B.
.Pp
-The RTL8150 contains a integrated Fast Ethernet MAC, which supports
+The RTL8150 contains an integrated Fast Ethernet MAC, which supports
both 10 and 100Mbps speeds in either full or half duplex.
Although designed to interface with
100Mbps peripheral, the existing USB standard specifies a maximum
@@ -56,42 +55,40 @@ achieve 100Mbps speeds with this device.
The
.Nm
driver supports the following media types:
-.Pp
-.Bl -tag -width xxxxxxxxxxxxxxxx
-.It autoselect
+.Bl -tag -width ".Cm 10baseT/UTP"
+.It Cm autoselect
Enable auto selection of the media type and options.
The user can manually override
the auto selected mode by adding media options to the
.Pa /etc/rc.conf
file.
-.It 10baseT/UTP
+.It Cm 10baseT/UTP
Set 10Mbps operation.
The
-.Ar mediaopt
+.Cm mediaopt
option can also be used to select either
-.Ar full-duplex
+.Cm full-duplex
or
-.Ar half-duplex
+.Cm half-duplex
modes.
-.It 100baseTX
+.It Cm 100baseTX
Set 100Mbps (Fast Ethernet) operation.
The
-.Ar mediaopt
+.Cm mediaopt
option can also be used to select either
-.Ar full-duplex
+.Cm full-duplex
or
-.Ar half-duplex
+.Cm half-duplex
modes.
.El
.Pp
The
.Nm
driver supports the following media options:
-.Pp
-.Bl -tag -width xxxxxxxxxxxxxxxx
-.It full-duplex
+.Bl -tag -width ".Cm 10baseT/UTP"
+.It Cm full-duplex
Force full duplex operation.
-.It half-duplex
+.It Cm half-duplex
Force half duplex operation.
.El
.Pp
@@ -107,13 +104,14 @@ before a timeout expired.
The driver failed to allocate an mbuf for the transmitter ring.
.It "rue%d: no memory for rx list"
The driver failed to allocate an mbuf for the receiver ring.
+.El
.Sh SEE ALSO
.Xr arp 4 ,
-.Xr netintro 4 ,
+.Xr netintro 4 ,
.Xr ng_ether 4 ,
.Xr ifconfig 8
.Rs
-.%T ReakTek RTL8150 data sheet
+.%T "ReakTek RTL8150 data sheet"
.%O ftp://ftp.realtek.com.tw/lancard/data_sheet/8150/
.Re
.Sh HISTORY
diff --git a/share/man/man4/sbsh.4 b/share/man/man4/sbsh.4
index be04486..fbd1dd4 100644
--- a/share/man/man4/sbsh.4
+++ b/share/man/man4/sbsh.4
@@ -1,5 +1,5 @@
.\" Written by Denis I. Timofeev, 2003.
-.\"
+.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
@@ -8,7 +8,7 @@
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
-.\"
+.\"
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
@@ -34,13 +34,15 @@
.Sh DESCRIPTION
The
.Nm
-driver provides support for an internal PCI modem SBNI16-SHDSL. A device
-is introduced to OS as common ethernet-like netcard which must be
-configured with
+driver provides support for an internal PCI modem SBNI16-SHDSL.
+A device is introduced to the OS as a common Ethernet-like network
+card which must be configured with
.Xr ifconfig 8
-(all standard network interface parameters could be set). Modem-specific
-parameters (master/slave mode, line rate etc.) must be set with the
-sb16config utility before interface activation.
+(all standard network interface parameters could be set).
+Modem-specific
+parameters (master/slave mode, line rate, etc.) must be set with the
+.Nm sb16config
+utility before interface activation.
.Sh DIAGNOSTICS
.Bl -diag
.It "sbsh%d: couldn't map memory"
@@ -48,10 +50,13 @@ sb16config utility before interface activation.
.It "sbsh%d: couldn't set up irq"
A fatal initialization error has occurred.
.It "sbsh%d: unable to load firmware"
-A fatal error has occurred while sb16config running.
+A fatal error has occurred while
+.Nm sb16config
+was running.
.It "sbsh%d: firmware wasn't loaded"
-ifconfig...up has failed because device hadn't been configured with
-sb16config.
+.Dq Nm ifconfig Ar ... Cm up
+has failed because device has not been configured with
+.Nm sb16config .
.It "sbsh%d: transmit timeout"
.It "sbsh%d: interrupt posted but not delivered"
Probably, a hardware error or incompatibility.
@@ -69,8 +74,9 @@ The sources for the driver reside in:
.Sh SEE ALSO
.Xr arp 4 ,
.Xr netintro 4 ,
-.Xr ifconfig 8 ,
-.Xr /usr/ports/sysutils/sb16config
+.Xr ifconfig 8
+.Pp
+.Pa ports/sysutils/sb16config
.Sh HISTORY
The
.Nm
OpenPOWER on IntegriCloud