bnx: Add manpage
authorSepherosa Ziehau <sephe@dragonflybsd.org>
Thu, 19 Jul 2012 07:29:30 +0000 (15:29 +0800)
committerSepherosa Ziehau <sephe@dragonflybsd.org>
Thu, 19 Jul 2012 07:29:30 +0000 (15:29 +0800)
Reminded-by: swildner@
share/man/man4/Makefile
share/man/man4/bnx.4 [new file with mode: 0644]

index 82908f2..6799600 100644 (file)
@@ -50,6 +50,7 @@ MAN=  aac.4 \
        bktr.4 \
        blackhole.4 \
        bluetooth.4 \
+       bnx.4 \
        bpf.4 \
        bridge.4 \
        bt.4 \
diff --git a/share/man/man4/bnx.4 b/share/man/man4/bnx.4
new file mode 100644 (file)
index 0000000..4a741a1
--- /dev/null
@@ -0,0 +1,133 @@
+.\"
+.\" Copyright (c) 2012 The DragonFly Project.  All rights reserved.
+.\" 
+.\" Redistribution and use in source and binary forms, with or without
+.\" modification, are permitted provided that the following conditions
+.\" are met:
+.\" 
+.\" 1. Redistributions of source code must retain the above copyright
+.\"    notice, this list of conditions and the following disclaimer.
+.\" 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.
+.\" 3. Neither the name of The DragonFly Project nor the names of its
+.\"    contributors may be used to endorse or promote products derived
+.\"    from this software without specific, prior written permission.
+.\" 
+.\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS 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 ARE DISCLAIMED.  IN NO EVENT SHALL THE
+.\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
+.\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
+.\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
+.\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
+.\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 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.
+.\"
+.Dd July 19, 2012
+.Dt BNX 4
+.Os
+.Sh NAME
+.Nm bnx
+.Nd "Broadcom BCM57785/BCM5718 families 10/100/Gigabit Ethernet device"
+.Sh SYNOPSIS
+.Cd "device miibus"
+.Cd "device bnx"
+.Pp
+Alternatively, to load the driver as a module at boot time, place the
+following line in
+.Pa /boot/loader.conf :
+.Bd -literal -offset indent
+if_bnx_load="YES"
+.Ed
+.Sh DESCRIPTION
+The
+.Nm
+driver supports the PCIe Ethernet adapters based on
+Broadcom BCM57785/BCM5718 families chips.
+.Pp
+The
+.Nm
+driver supports the following
+.Ar media
+types:
+.Pp
+.Bl -tag -width 10baseT/UTP -compact
+.It Cm autoselect
+Enable autoselection of the media types and options
+.Pp
+.It Cm 10baseT/UTP
+Set 10Mbps operation.
+The
+.Ar mediaopt
+option can also be used to select either
+.Ar full-duplex
+or
+.Ar half-duplex
+modes.
+.Pp
+.It Cm 100baseTX
+Set 100Mbps (Fast Ethernet) operation.
+The
+.Ar mediaopt
+option can also be used to select either
+.Ar full-duplex
+or
+.Ar half-duplex
+modes.
+.Pp
+.It Cm 1000baseT
+Set 1000Mbps (Gigabit Ethernet) operation.
+The
+.Ar mediaopt
+option can only be set
+.Ar full-duplex
+mode.
+.El
+.Pp
+The
+.Nm
+driver supports the following
+.Ar media
+options:
+.Pp
+.Bl -tag -width full-duplex -compact
+.It Cm full-duplex
+Force full duplex operation.
+.Pp
+.It Cm half-duplex
+Force half duplex operation.
+.El
+.Pp
+Note that the 1000baseT media type is only available
+if it is supported by the adapter.
+For more information on configuring this device,
+see
+.Xr ifconfig 8 .
+.Sh SEE ALSO
+.Xr arp 4 ,
+.Xr bge 4 ,
+.Xr ifmedia 4 ,
+.Xr miibus 4 ,
+.Xr netintro 4 ,
+.Xr ng_ether 4 ,
+.Xr vlan 4 ,
+.Xr ifconfig 8
+.Sh HISTORY
+The
+.Nm
+device driver first appeared in
+.Dx 3.1 .
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was based on
+.Xr bge 4
+written by
+.An Bill Paul
+.Aq wpaul@windriver.com .