xref: /freebsd/share/man/man4/urtw.4 (revision d8b878873e7aa8df1972cc6a642804b17eb61087)
1.\" Copyright (c) 2008 Weongyo Jeong
2.\" All rights reserved.
3.\"
4.\" Redistribution and use in source and binary forms, with or without
5.\" modification, are permitted provided that the following conditions
6.\" are met:
7.\" 1. Redistributions of source code must retain the above copyright
8.\"    notice, this list of conditions and the following disclaimer.
9.\" 2. Redistributions in binary form must reproduce the above copyright
10.\"    notice, this list of conditions and the following disclaimer in the
11.\"    documentation and/or other materials provided with the distribution.
12.\"
13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16.\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
23.\" SUCH DAMAGE.
24.\"
25.\" $FreeBSD$
26.\"
27.Dd October 17, 2009
28.Dt URTW 4
29.Os
30.Sh NAME
31.Nm urtw
32.Nd Realtek RTL8187B/L USB IEEE 802.11b/g wireless network device
33.Sh SYNOPSIS
34To compile this driver into the kernel,
35place the following lines in your kernel configuration file:
36.Bd -ragged -offset indent
37.Cd "device ehci"
38.Cd "device uhci"
39.Cd "device ohci"
40.Cd "device usb"
41.Cd "device urtw"
42.Cd "device wlan"
43.Ed
44.Pp
45Alternatively, to load the driver as a module at boot time,
46place the following line in
47.Xr loader.conf 5 :
48.Bd -literal -offset indent
49if_urtw_load="YES"
50.Ed
51.Sh DESCRIPTION
52The
53.Nm
54driver supports USB 802.11b/g wireless adapters based on the
55Realtek RTL8187B/L.
56.Pp
57.Nm
58supports
59.Cm station
60and
61.Cm monitor
62mode operation.
63Only one virtual interface may be configured at any time.
64For more information on configuring this device, see
65.Xr ifconfig 8 .
66.Sh HARDWARE
67The
68.Nm
69driver supports Realtek RTL8187B/L based wireless network devices, including:
70.Pp
71.Bl -column "Shuttle XPC Accessory PN20" "RTL8225" "USB" -compact -offset 6n
72.It Em "Card	Radio	Bus"
73.It "Belkin F5D7050E	RTL8225	USB"
74.It "Linksys WUSB54GCv2	RTL8225	USB"
75.It "Netgear WG111v2	RTL8225	USB"
76.It "Netgear WG111v3	RTL8225	USB"
77.It "Safehome WLG-1500SMA5	RTL8225	USB"
78.It "Shuttle XPC Accessory PN20	RTL8225	USB"
79.It "Sitecom WL168v1	RTL8225	USB"
80.It "Sitecom WL168v4	RTL8225	USB"
81.It "SureCom EP-9001-g(2A)	RTL8225	USB"
82.It "TRENDnet TEW-424UB V3.xR	RTL8225	USB"
83.El
84.Sh EXAMPLES
85Join an existing BSS network (i.e., connect to an access point):
86.Pp
87.Bd -literal -offset indent
88ifconfig wlan create wlandev urtw0 inet 192.168.0.20 \e
89    netmask 0xffffff00
90.Ed
91.Pp
92Join a specific BSS network with network name
93.Dq Li my_net :
94.Pp
95.Dl "ifconfig wlan create wlandev urtw0 ssid my_net up"
96.Pp
97Join a specific BSS network with 64-bit WEP encryption:
98.Bd -literal -offset indent
99ifconfig wlan create wlandev urtw0 ssid my_net \e
100	wepmode on wepkey 0x1234567890 weptxkey 1 up
101.Ed
102.Sh SEE ALSO
103.Xr intro 4 ,
104.Xr netintro 4 ,
105.Xr usb 4 ,
106.Xr wlan 4 ,
107.Xr wlan_ccmp 4 ,
108.Xr wlan_tkip 4 ,
109.Xr wlan_wep 4 ,
110.Xr ifconfig 8 ,
111.Xr wpa_supplicant 8
112.Rs
113.%T Realtek
114.%U http://www.realtek.com.tw
115.Re
116.Sh HISTORY
117The
118.Nm
119device driver first appeared in
120.Fx 8.0 .
121.Sh AUTHORS
122.An -nosplit
123The
124.Nm
125driver was written by
126.An Weongyo Jeong
127.Aq weongyo@FreeBSD.org .
128