- Add manpage for rum(4)
authorSepherosa Ziehau <sephe@dragonflybsd.org>
Sun, 10 Dec 2006 05:03:20 +0000 (05:03 +0000)
committerSepherosa Ziehau <sephe@dragonflybsd.org>
Sun, 10 Dec 2006 05:03:20 +0000 (05:03 +0000)
  Obtained-from: OpenBSD
- Add manpage for ural(4)
  Obatined-frim: FreeBSD

Reviewed-by: swildner@
share/man/man4/Makefile
share/man/man4/rum.4 [new file with mode: 0644]
share/man/man4/ural.4 [new file with mode: 0644]

index 04acbd6..71ac078 100644 (file)
@@ -1,6 +1,6 @@
 #      @(#)Makefile    8.1 (Berkeley) 6/18/93
 # $FreeBSD: src/share/man/man4/Makefile,v 1.83.2.66 2003/06/04 17:10:30 sam Exp $
-# $DragonFly: src/share/man/man4/Makefile,v 1.47 2006/11/20 19:57:03 swildner Exp $
+# $DragonFly: src/share/man/man4/Makefile,v 1.48 2006/12/10 05:03:20 sephe Exp $
 
 MAN=   aac.4 \
        acpi.4 \
@@ -185,6 +185,7 @@ MAN=        aac.4 \
        rp.4 \
        rtw.4 \
        rue.4 \
+       rum.4 \
        sa.4 \
        sbc.4 \
        sbp.4 \
@@ -245,6 +246,7 @@ MAN=        aac.4 \
        ums.4 \
        unix.4 \
        uplcom.4 \
+       ural.4 \
        urio.4 \
        usb.4 \
        uscanner.4 \
diff --git a/share/man/man4/rum.4 b/share/man/man4/rum.4
new file mode 100644 (file)
index 0000000..51bd910
--- /dev/null
@@ -0,0 +1,160 @@
+.\" $OpenBSD: rum.4,v 1.16 2006/10/19 16:53:48 jsg Exp $
+.\" $DragonFly: src/share/man/man4/rum.4,v 1.1 2006/12/10 05:03:20 sephe Exp $
+.\"
+.\" Copyright (c) 2005, 2006
+.\"    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 November 26, 2006
+.Os
+.Dt RUM 4
+.Sh NAME
+.Nm rum
+.Nd "Ralink Technology RT2501USB/RT2601USB IEEE 802.11 driver"
+.Sh SYNOPSIS
+To compile this driver into the kernel,
+place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
+.Cd "device ehci"
+.Cd "device uhci"
+.Cd "device ohci"
+.Cd "device usb"
+.Cd "device rum"
+.Cd "device wlan"
+.Cd "device wlan_ratectl_onoe"
+.Ed
+.Pp
+Alternatively, to load the driver as a
+module at boot time, place the following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+if_rum_load="YES"
+.Ed
+.Sh DESCRIPTION
+The
+.Nm
+driver supports USB 2.0 wireless adapters based on the Ralink RT2501USB
+and RT2601USB chipsets.
+.Pp
+The RT2501USB chipset is the second generation of 802.11a/b/g adapters
+from Ralink.
+It consists of two integrated chips,
+an RT2571W MAC/BBP and an RT2528 or RT5226 radio transceiver.
+.Pp
+The RT2601USB chipset consists of two integrated chips,
+an RT2671 MAC/BBP and an RT2527 or RT5225 radio transceiver.
+This chipset uses the MIMO (multiple-input multiple-output) technology with
+multiple antennas to extend the operating range of the adapter and to achieve
+higher throughput.
+MIMO is the basis of the forthcoming IEEE 802.11n standard.
+.Sh HARDWARE
+The
+.Nm
+driver supports the following adapters:
+.Pp
+.Bl -bullet -compact
+.It
+Airlink101 AWLL5025
+.It
+ASUS WL-167g ver 2
+.It
+Belkin F5D7050 ver 3
+.It
+Belkin F5D9050 ver 3
+.It
+CNet CWD-854 ver F
+.It
+Conceptronic C54RU ver 2
+.It
+D-Link DWL-G122 rev C1
+.It
+D-Link WUA-1340
+.It
+Gigabyte GN-WB01GS
+.It
+Hawking HWUG1
+.It
+Linksys WUSB54G rev C
+.It
+Planex GW-USMM
+.It
+Senao NUB-3701
+.It
+Sitecom WL-113 ver 2
+.It
+Sitecom WL-172
+.It
+TP-LINK TL-WN321G
+.El
+.Sh EXAMPLES
+Join an existing BSS network (i.e., connect to an access point):
+.Pp
+.Dl "ifconfig rum0 inet 192.168.0.20 netmask 0xffffff00"
+.Pp
+Join a specific BSS network with network name
+.Dq Li my_net :
+.Pp
+.Dl "ifconfig rum0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
+.Pp
+Join a specific BSS network with 40-bit WEP encryption:
+.Bd -literal -offset indent
+ifconfig rum0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
+    wepmode on wepkey 0x1234567890 weptxkey 1
+.Ed
+.Pp
+Join a specific BSS network with 104-bit WEP encryption:
+.Bd -literal -offset indent
+ifconfig rum0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
+    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
+.Ed
+.Sh DIAGNOSTICS
+.Bl -diag
+.It "rum%d: could not load 8051 microcode"
+An error occurred while attempting to upload the microcode to the onboard 8051
+microcontroller unit.
+.It "rum%d: device timeout"
+The driver will reset the hardware.
+This should not happen.
+.El
+.Sh SEE ALSO
+.Xr arp 4 ,
+.Xr netintro 4 ,
+.Xr usb 4 ,
+.Xr wlan 4 ,
+.Xr ifconfig 8
+.Rs
+.%T "Ralink Technology"
+.%O http://www.ralinktech.com/
+.Re
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Ox 4.0 .
+.Sh CAVEATS
+.Pp
+The
+.Nm
+driver supports automatic adaptation of the transmit speed in IBSS
+and HostAP operating modes,
+but it does not work well if there are more than one peer node.
+.Sh AUTHORS
+.An -nosplit
+The
+.Nm
+driver was written by
+.An Niall O'Higgins Aq niallo@openbsd.org
+and
+.An Damien Bergamini Aq damien@openbsd.org .
diff --git a/share/man/man4/ural.4 b/share/man/man4/ural.4
new file mode 100644 (file)
index 0000000..c9d6ecf
--- /dev/null
@@ -0,0 +1,173 @@
+.\" Copyright (c) 2005, 2006
+.\"     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.
+.\"
+.\" $FreeBSD: src/share/man/man4/ural.4,v 1.11 2006/10/07 18:18:40 flz Exp $
+.\" $DragonFly: src/share/man/man4/ural.4,v 1.1 2006/12/10 05:03:20 sephe Exp $
+.\"
+.Dd November 26, 2006
+.Os
+.Dt URAL 4
+.Sh NAME
+.Nm ural
+.Nd "Ralink Technology RT2500USB IEEE 802.11 driver"
+.Sh SYNOPSIS
+To compile this driver into the kernel,
+place the following lines in your
+kernel configuration file:
+.Bd -ragged -offset indent
+.Cd "device ehci"
+.Cd "device uhci"
+.Cd "device ohci"
+.Cd "device usb"
+.Cd "device ural"
+.Cd "device wlan"
+.Cd "device wlan_ratectl_onoe"
+.Ed
+.Pp
+Alternatively, to load the driver as a
+module at boot time, place the following line in
+.Xr loader.conf 5 :
+.Bd -literal -offset indent
+if_ural_load="YES"
+.Ed
+.Sh DESCRIPTION
+The
+.Nm
+driver supports USB 2.0 wireless adapters based on the RT2500USB chipset.
+.Pp
+The RT2500USB chipset consists of two integrated chips, a RT2570 MAC/BBP
+and a radio transceiver (the model of which depends on the card revision).
+.Pp
+The RT2522, RT2523, RT2524, RT2525, RT2525e and RT2526 radio transceivers
+operate in the 2.4GHz band (802.11b/g) whereas the RT5222 is a dual-band radio
+transceiver that can operate in the 2.4GHz and 5.2GHz bands (802.11a).
+.Sh HARDWARE
+The
+.Nm
+driver supports the following adapters:
+.Pp
+.Bl -bullet -compact
+.It
+AMIT WL532U
+.It
+ASUS WL-167g
+.It
+Belkin F5D7050 v2000
+.It
+Buffalo WLI-U2-KG54-AI
+.It
+CNet CWD-854
+.It
+Compex WLU54G 2A1100
+.It
+Conceptronic C54RU
+.It
+D-Link DWL-G122 b1
+.It
+Dynalink WLG25USB
+.It
+E-Tech WGUS02
+.It
+Gigabyte GN-WBKG
+.It
+Hercules HWGUSB2-54
+.It
+KCORP LifeStyle KLS-685
+.It
+Linksys WUSB54G v4
+.It
+Linksys WUSB54GP v4
+.It
+MSI MS-6861
+.It
+MSI MS-6865
+.It
+MSI MS-6869
+.It
+NovaTech NV-902
+.It
+OvisLink Evo-W54USB
+.It
+SerComm UB801R
+.It
+SparkLAN WL-685R
+.It
+Surecom EP-9001-g
+.It
+Sweex LC100060
+.It
+Tonze UW-6200C
+.It
+Zinwell ZWX-G261
+.It
+Zonet ZEW2500P
+.El
+.Pp
+An up to date list can be found at
+.Pa http://ralink.rapla.net/ .
+.Sh EXAMPLES
+Join an existing BSS network (i.e., connect to an access point):
+.Pp
+.Dl "ifconfig ural0 inet 192.168.0.20 netmask 0xffffff00"
+.Pp
+Join a specific BSS network with network name
+.Dq Li my_net :
+.Pp
+.Dl "ifconfig ural0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net"
+.Pp
+Join a specific BSS network with 40-bit WEP encryption:
+.Bd -literal -offset indent
+ifconfig ural0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
+    wepmode on wepkey 0x1234567890 weptxkey 1
+.Ed
+.Pp
+Join a specific BSS network with 104-bit WEP encryption:
+.Bd -literal -offset indent
+ifconfig ural0 inet 192.168.0.20 netmask 0xffffff00 ssid my_net \e
+    wepmode on wepkey 0x01020304050607080910111213 weptxkey 1
+.Ed
+.Sh DIAGNOSTICS
+.Bl -diag
+.It "ural%d: device timeout"
+The driver will reset the hardware.
+This should not happen.
+.El
+.Sh SEE ALSO
+.Xr arp 4 ,
+.Xr netintro 4 ,
+.Xr usb 4 ,
+.Xr wlan 4 ,
+.Xr ifconfig 8
+.Rs
+.%T "Ralink Technology"
+.%O http://www.ralinktech.com/
+.Re
+.Sh HISTORY
+The
+.Nm
+driver first appeared in
+.Ox 3.7 .
+.Sh CAVEATS
+.Pp
+The
+.Nm
+driver supports automatic adaptation of the transmit speed in IBSS
+and HostAP operating modes,
+but it does not work well if there are more than one peer node.
+.Sh AUTHORS
+The
+.Nm
+driver was written by
+.An Damien Bergamini Aq damien@FreeBSD.org .