xref: /freebsd/share/man/man4/urtw.4 (revision 82431678fce5c893ef9c7418ad6d998ad4187de6)
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 November 15 2008 $
28.Dt URTW 4
29.Os
30.Sh NAME
31.Nm urtw
32.Nd Realtek RTL8187L 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 RTL8187L.
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 following adapters should work:
68.Pp
69.Bl -column "Card                        " "Radio    " "Bus" -compact -offset 6n
70.It Em "Card	Radio	Bus"
71.It Li "Netgear WG111v2" Ta RTL8225 Ta USB
72.It Li "Safehome WLG-1500SMA5" Ta RTL8225 Ta USB
73.It Li "Shuttle XPC Accessory PN20" Ta RTL8225 Ta USB
74.El
75.Sh EXAMPLES
76Join an existing BSS network (i.e., connect to an access point):
77.Pp
78.Bd -literal -offset indent
79ifconfig wlan create wlandev urtw0 inet 192.168.0.20 \e
80    netmask 0xffffff00
81.Ed
82.Pp
83Join a specific BSS network with network name
84.Dq Li my_net :
85.Pp
86.Dl "ifconfig wlan create wlandev urtw0 ssid my_net up"
87.Pp
88Join a specific BSS network with 64-bit WEP encryption:
89.Bd -literal -offset indent
90ifconfig wlan create wlandev urtw0 ssid my_net \e
91	wepmode on wepkey 0x1234567890 weptxkey 1 up
92.Ed
93.Sh SEE ALSO
94.Xr intro 4 ,
95.Xr netintro 4 ,
96.Xr usb 4 ,
97.Xr wlan 4 ,
98.Xr wlan_ccmp 4 ,
99.Xr wlan_tkip 4 ,
100.Xr wlan_wep 4 ,
101.Xr ifconfig 8 ,
102.Xr wpa_supplicant 8
103.Rs
104.%T Realtek
105.%O http://www.realtek.com.tw
106.Re
107.Sh HISTORY
108The
109.Nm
110device driver first appeared in
111.Fx 8.0 .
112.Sh AUTHORS
113.An -nosplit
114The
115.Nm
116driver was written by
117.An Weongyo Jeong
118.Aq weongyo@FreeBSD.org .
119