separate ural(4) man page from ral(4) man page.

3 files changed, 327 insertions, 60 deletions

diff --git a/share/man/man4/Makefile b/share/man/man4/Makefile
index efd6b9aa136..71cb20791a0 100644
--- a/share/man/man4/Makefile
+++ b/share/man/man4/Makefile
@@ -1,4 +1,4 @@
-#	$OpenBSD: Makefile,v 1.436 2007/11/16 16:25:27 deraadt Exp $
+#	$OpenBSD: Makefile,v 1.437 2007/11/17 12:20:50 damien Exp $
 
 MAN=	aac.4 ac97.4 acphy.4 \
 	acpi.4 acpiac.4 acpibat.4 acpibtn.4 acpicpu.4 acpidock.4 \
@@ -51,7 +51,7 @@ MAN=	aac.4 ac97.4 acphy.4 \
 	ucom.4 uchcom.4 ucycom.4 udav.4 udcf.4 udp.4 udsbr.4 \
 	ueagle.4 uftdi.4 ugen.4 uhci.4 uhid.4 uhidev.4 uipaq.4 uk.4 ukbd.4 \
 	ukphy.4 ulpt.4 umass.4 umbg.4 umct.4 umidi.4 umodem.4 ums.4 umsm.4 \
-	unix.4 uow.4 upl.4 uplcom.4 urio.4 url.4 urlphy.4 usb.4 usbf.4 \
+	unix.4 uow.4 upl.4 uplcom.4 ural.4 urio.4 url.4 urlphy.4 usb.4 usbf.4 \
 	uscanner.4 uslcom.4 usscanner.4 uticom.4 uts.4 uvisor.4 uvscom.4 \
 	uyap.4 vga.4 vgafb.4 vge.4 viaenv.4 viapm.4 viasio.4 vic.4 \
 	vlan.4 vnd.4 vr.4 watchdog.4 wb.4 wbenv.4 wbng.4 wd.4 wdc.4 \
@@ -70,7 +70,6 @@ MLINKS+=netintro.4 networking.4
 MLINKS+=pcmcia.4 pcic.4
 MLINKS+=pms.4 pmsi.4
 MLINKS+=pty.4 ptm.4
-MLINKS+=ral.4 ural.4
 MLINKS+=random.4 arandom.4
 MLINKS+=random.4 srandom.4 random.4 urandom.4 random.4 prandom.4
 MLINKS+=scsi.4 scsibus.4
diff --git a/share/man/man4/ral.4 b/share/man/man4/ral.4
index 8cfa58b8d78..64e211b0c67 100644
--- a/share/man/man4/ral.4
+++ b/share/man/man4/ral.4
@@ -1,4 +1,4 @@
-.\" $OpenBSD: ral.4,v 1.73 2007/11/17 12:01:46 damien Exp $
+.\" $OpenBSD: ral.4,v 1.74 2007/11/17 12:20:50 damien Exp $
 .\"
 .\" Copyright (c) 2005-2007
 .\"	Damien Bergamini <damien.bergamini@free.fr>
@@ -19,26 +19,20 @@
 .Os
 .Dt RAL 4
 .Sh NAME
-.Nm ral ,
-.Nm ural
+.Nm ral
 .Nd Ralink Technology IEEE 802.11a/b/g/Draft-N wireless network device
 .Sh SYNOPSIS
 .Cd "ral* at cardbus?"
 .Cd "ral* at pci?"
-.Cd "ural* at uhub? port ?"
 .Sh DESCRIPTION
 The
 .Nm
 driver supports PCI/PCIe/CardBus wireless adapters based on the Ralink RT2500,
 RT2501, RT2600 and RT2800 chipsets.
-The
-.Nm ural
-driver supports USB 2.0 wireless adapters based on the Ralink RT2500USB
-chipset.
 .Pp
 The RT2500 chipset is the first generation of 802.11b/g adapters from Ralink.
-It consists of two integrated chips, an RT2560 or RT2570(USB) MAC/BBP
-and an RT2525 or RT2526(USB) radio transceiver.
+It consists of two integrated chips, an RT2560 MAC/BBP and an RT2525 radio
+transceiver.
 .Pp
 The RT2501 chipset is the second generation of 802.11a/b/g adapters from
 Ralink.
@@ -380,45 +374,6 @@ MSI MS-6833.
 Tonze PC-620C.
 Zinwell ZWX-G360.
 .Ed
-.Pp
-The following USB 2.0 adapters should work:
-.Bd -filled
-AMIT WL532U.
-ASUS WL-167g v1.
-Belkin F5D7050 v2000.
-Buffalo WLI-U2-KG54.
-Buffalo WLI-U2-KG54-AI.
-Buffalo WLI-U2-KG54-YB.
-CNet CWD-854.
-Compex WLU54G 2A1100.
-Conceptronic C54RU.
-D-Link DWL-G122 (b1).
-Dynalink WLG25USB.
-E-Tech WGUS02.
-Eminent EM3035.
-Gigabyte GN-WBKG.
-Hercules HWGUSB2-54.
-KCORP LifeStyle KLS-685.
-Linksys HU200-TS.
-Linksys WUSB54G v4.
-Linksys WUSB54GP v4.
-MSI MS-6861.
-MSI MS-6865.
-MSI MS-6869.
-Nintendo Wi-Fi USB Connector.
-Nova Tech NV-902W.
-OvisLink Evo-W54USB.
-SerComm UB801R.
-SparkLAN WL-685R.
-Sphairon UB801R.
-Surecom EP-9001-g rev 3A.
-Sweex LC100060.
-Tonze UW-6200C.
-Zaapa ZNWUSB-54.
-Zinwell ZPlus-G250.
-Zinwell ZWX-G261.
-Zonet ZEW2500P.
-.Ed
 .Sh EXAMPLES
 The following
 .Xr hostname.if 5
@@ -478,7 +433,6 @@ This should not happen.
 .Xr intro 4 ,
 .Xr netintro 4 ,
 .Xr pci 4 ,
-.Xr usb 4 ,
 .Xr hostname.if 5 ,
 .Xr hostapd 8 ,
 .Xr ifconfig 8
@@ -514,10 +468,3 @@ adapters seem to strictly require a system supporting PCI 2.2 or greater and
 will likely not work in systems based on older revisions of the PCI
 specification.
 Check the board's PCI version before purchasing the card.
-.Pp
-The
-.Nm ural
-driver supports automatic control of the transmit speed in BSS mode only.
-Therefore the use of a
-.Nm ural
-adapter in Host AP mode is discouraged.
diff --git a/share/man/man4/ural.4 b/share/man/man4/ural.4
new file mode 100644
index 00000000000..4acf059cc37
--- /dev/null
+++ b/share/man/man4/ural.4
@@ -0,0 +1,321 @@
+.\" $OpenBSD: ural.4,v 1.1 2007/11/17 12:20:50 damien Exp $
+.\"
+.\" Copyright (c) 2005-2007
+.\"	Damien Bergamini <damien.bergamini@free.fr>
+.\"
+.\" Permission to use, copy, modify, and distribute this software for any
+.\" purpose with or without fee is hereby granted, provided that the above
+.\" copyright notice and this permission notice appear in all copies.
+.\"
+.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
+.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
+.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
+.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
+.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
+.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
+.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
+.\"
+.Dd $Mdocdate: November 17 2007 $
+.Os
+.Dt URAL 4
+.Sh NAME
+.Nm ural
+.Nd Ralink Technology USB IEEE 802.11a/b/g wireless network device
+.Sh SYNOPSIS
+.Cd "ural* at uhub? port ?"
+.Sh DESCRIPTION
+The
+.Nm
+driver supports USB 2.0 wireless adapters based on the Ralink RT2500USB
+chipset.
+.Pp
+The RT2500USB chipset is the first generation of 802.11b/g adapters from Ralink.
+It consists of two integrated chips, an RT2570 MAC/BBP and an RT2526 radio
+transceiver.
+.Pp
+These are the modes the
+.Nm
+driver can operate in:
+.Bl -tag -width "IBSS-masterXX"
+.It BSS mode
+Also known as
+.Em infrastructure
+mode, this is used when associating with an access point, through
+which all traffic passes.
+This mode is the default.
+.It IBSS mode
+Also known as
+.Em IEEE ad-hoc
+mode or
+.Em peer-to-peer
+mode.
+This is the standardized method of operating without an access point.
+Stations associate with a service set.
+However, actual connections between stations are peer-to-peer.
+.It Host AP
+In this mode the driver acts as an access point (base station)
+for other cards.
+.It monitor mode
+In this mode the driver is able to receive packets without
+associating with an access point.
+This disables the internal receive filter and enables the card to
+capture packets from networks which it wouldn't normally have access to,
+or to scan for access points.
+.El
+.Pp
+.Nm
+supports software WEP.
+Wired Equivalent Privacy (WEP) is the de facto encryption standard
+for wireless networks.
+It can be typically configured in one of three modes:
+no encryption; 40-bit encryption; or 104-bit encryption.
+Unfortunately, due to serious weaknesses in WEP protocol
+it is strongly recommended that it not be used as the
+sole mechanism to secure wireless communication.
+WEP is not enabled by default.
+.Pp
+The transmit speed is user-selectable or can be adapted automatically by the
+driver depending on the number of hardware transmission retries.
+.Sh CONFIGURATION
+The
+.Nm
+driver can be configured at runtime with
+.Xr ifconfig 8
+or on boot with
+.Xr hostname.if 5
+using the following parameters:
+.Bl -tag -width Ds
+.It Cm bssid Ar bssid
+Set the desired BSSID.
+.It Fl bssid
+Unset the desired BSSID.
+The interface will automatically select a BSSID in this mode, which is
+the default.
+.It Cm chan Ar n
+Set the channel (radio frequency) to be used by the driver based on
+the given channel ID
+.Ar n .
+.It Fl chan
+Unset the desired channel to be used by the driver.
+The driver will automatically select a channel in this mode, which is
+the default.
+.It Cm media Ar media
+The
+.Nm
+driver supports the following
+.Ar media
+types:
+.Pp
+.Bl -tag -width autoselect -compact
+.It Cm autoselect
+Enable autoselection of the media type and options.
+.It Cm DS1
+Set 802.11b DS 1Mbps operation.
+.It Cm DS2
+Set 802.11b DS 2Mbps operation.
+.It Cm DS5
+Set 802.11b DS 5.5Mbps operation.
+.It Cm DS11
+Set 802.11b DS 11Mbps operation.
+.It Cm OFDM6
+Set 802.11a/g OFDM 6Mbps operation.
+.It Cm OFDM9
+Set 802.11a/g OFDM 9Mbps operation.
+.It Cm OFDM12
+Set 802.11a/g OFDM 12Mbps operation.
+.It Cm OFDM18
+Set 802.11a/g OFDM 18Mbps operation.
+.It Cm OFDM24
+Set 802.11a/g OFDM 24Mbps operation.
+.It Cm OFDM36
+Set 802.11a/g OFDM 36Mbps operation.
+.It Cm OFDM48
+Set 802.11a/g OFDM 48Mbps operation.
+.It Cm OFDM54
+Set 802.11a/g OFDM 54Mbps operation.
+.El
+.It Cm mediaopt Ar opts
+The
+.Nm
+driver supports the following media options:
+.Pp
+.Bl -tag -width monitor -compact
+.It Cm hostap
+Select Host AP operation.
+.It Cm ibss
+Select IBSS operation.
+.It Cm monitor
+Select monitor mode.
+.El
+.It Fl mediaopt Ar opts
+Disable the specified media options on the driver and return it to the
+default mode of operation (BSS).
+.It Cm mode Ar mode
+The
+.Nm
+driver supports the following modes:
+.Pp
+.Bl -tag -width 11b -compact
+.It Cm 11a
+Force 802.11a operation.
+.It Cm 11b
+Force 802.11b operation.
+.It Cm 11g
+Force 802.11g operation.
+.El
+.It Cm nwid Ar id
+Set the network ID.
+The
+.Ar id
+can either be any text string up to 32 characters in length,
+or a series of hexadecimal digits up to 64 digits.
+An empty
+.Ar id
+string allows the interface to connect to any available access points.
+By default the
+.Nm
+driver uses an empty string.
+Note that network ID is synonymous with Extended Service Set ID (ESSID).
+.It Fl nwid
+Set the network ID to the empty string to allow the interface to connect
+to any available access point.
+.It Cm nwkey Ar key
+Enable WEP encryption using the specified
+.Ar key .
+The
+.Ar key
+can either be a string, a series of hexadecimal digits (preceded by
+.Sq 0x ) ,
+or a set of keys of the form
+.Dq n:k1,k2,k3,k4 ,
+where
+.Sq n
+specifies which of the keys will be used for transmitted packets,
+and the four keys,
+.Dq k1
+through
+.Dq k4 ,
+are configured as WEP keys.
+If a set of keys is specified, a comma
+.Pq Sq \&,
+within the key must be escaped with a backslash.
+Note that if multiple keys are used, their order must be the same within
+the network.
+.Nm
+is capable of using both 40-bit (5 characters or 10 hexadecimal digits)
+or 104-bit (13 characters or 26 hexadecimal digits) keys.
+.It Fl nwkey
+Disable WEP encryption.
+This is the default mode of operation.
+.El
+.Sh HARDWARE
+The following adapters should work:
+.Bd -filled
+AMIT WL532U.
+ASUS WL-167g v1.
+Belkin F5D7050 v2000.
+Buffalo WLI-U2-KG54.
+Buffalo WLI-U2-KG54-AI.
+Buffalo WLI-U2-KG54-YB.
+CNet CWD-854.
+Compex WLU54G 2A1100.
+Conceptronic C54RU.
+D-Link DWL-G122 (b1).
+Dynalink WLG25USB.
+E-Tech WGUS02.
+Eminent EM3035.
+Gigabyte GN-WBKG.
+Hercules HWGUSB2-54.
+KCORP LifeStyle KLS-685.
+Linksys HU200-TS.
+Linksys WUSB54G v4.
+Linksys WUSB54GP v4.
+MSI MS-6861.
+MSI MS-6865.
+MSI MS-6869.
+Nintendo Wi-Fi USB Connector.
+Nova Tech NV-902W.
+OvisLink Evo-W54USB.
+SerComm UB801R.
+SparkLAN WL-685R.
+Sphairon UB801R.
+Surecom EP-9001-g rev 3A.
+Sweex LC100060.
+Tonze UW-6200C.
+Zaapa ZNWUSB-54.
+Zinwell ZPlus-G250.
+Zinwell ZWX-G261.
+Zonet ZEW2500P.
+.Ed
+.Sh EXAMPLES
+The following
+.Xr hostname.if 5
+example configures ural0 to join whatever network is available on boot,
+using WEP key
+.Dq 0x1deadbeef1 ,
+channel 11, obtaining an IP address using DHCP:
+.Bd -literal -offset indent
+dhcp NONE NONE NONE nwkey 0x1deadbeef1 chan 11
+.Ed
+.Pp
+The following
+.Xr hostname.if 5
+example creates a host-based access point on boot:
+.Bd -literal -offset indent
+inet 192.168.1.1 255.255.255.0 NONE media autoselect \e
+	mediaopt hostap nwid my_net chan 11
+.Ed
+.Pp
+Configure ural0 for WEP, using hex key
+.Dq 0x1deadbeef1 :
+.Bd -literal -offset indent
+# ifconfig ural0 nwkey 0x1deadbeef1
+.Ed
+.Pp
+Return ural0 to its default settings:
+.Bd -literal -offset indent
+# ifconfig ural0 -bssid -chan media autoselect \e
+	nwid "" -nwkey
+.Ed
+.Pp
+Join an existing BSS network,
+.Dq my_net :
+.Bd -literal -offset indent
+# ifconfig ural0 192.168.1.1 netmask 0xffffff00 nwid my_net
+.Ed
+.Sh DIAGNOSTICS
+.Bl -diag
+.It "ural%d: device timeout"
+A frame dispatched to the hardware for transmission did not complete in time.
+The driver will reset the hardware.
+This should not happen.
+.El
+.Sh SEE ALSO
+.Xr arp 4 ,
+.Xr ifmedia 4 ,
+.Xr intro 4 ,
+.Xr netintro 4 ,
+.Xr usb 4 ,
+.Xr hostname.if 5 ,
+.Xr hostapd 8 ,
+.Xr ifconfig 8
+.Pp
+Ralink Technology:
+.Pa http://www.ralinktech.com/
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Ox 3.7 .
+.Sh AUTHORS
+The
+.Nm
+driver was written by
+.An Damien Bergamini Aq damien@openbsd.org .
+.Sh CAVEATS
+The
+.Nm
+driver supports automatic control of the transmit speed in BSS mode only.
+Therefore the use of an
+.Nm
+adapter in Host AP mode is discouraged.