xref: /openbsd/share/man/man4/urtw.4 (revision 76d0caae)
1.\" $OpenBSD: urtw.4,v 1.28 2021/10/24 12:32:42 kn Exp $
2.\"
3.\" Copyright (c) 2008 Weongyo Jeong <weongyo@FreeBSD.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: October 24 2021 $
18.Dt URTW 4
19.Os
20.Sh NAME
21.Nm urtw
22.Nd Realtek RTL8187L/RTL8187B USB IEEE 802.11b/g wireless network device
23.Sh SYNOPSIS
24.Cd "urtw* at uhub? port ?"
25.Sh DESCRIPTION
26The
27.Nm
28driver supports USB 802.11b/g wireless adapters based on the
29Realtek RTL8187L and RTL8187B.
30.Pp
31These are the modes the
32.Nm
33driver can operate in:
34.Bl -tag -width "IBSS-masterXX"
35.It BSS mode
36Also known as
37.Em infrastructure
38mode, this is used when associating with an access point, through
39which all traffic passes.
40This mode is the default.
41.It monitor mode
42In this mode the driver is able to receive packets without
43associating with an access point.
44This disables the internal receive filter and enables the card to
45capture packets from networks which it wouldn't normally have access to,
46or to scan for access points.
47.El
48.Pp
49The
50.Nm
51driver can be configured to use
52Wired Equivalent Privacy (WEP) or
53Wi-Fi Protected Access (WPA1 and WPA2).
54WPA2 is the current encryption standard for wireless networks.
55It is strongly recommended that neither WEP nor WPA1
56are used as the sole mechanism to secure wireless communication,
57due to serious weaknesses.
58WPA1 is disabled by default and may be enabled using the option
59.Qq Cm wpaprotos Ar wpa1,wpa2 .
60For standard WPA networks which use pre-shared keys (PSK),
61keys are configured using the
62.Qq Cm wpakey
63option.
64WPA-Enterprise networks require use of the wpa_supplicant package.
65The
66.Nm
67driver relies on the software 802.11 stack for both encryption and decryption
68of data frames.
69.Pp
70The
71.Nm
72driver can be configured at runtime with
73.Xr ifconfig 8
74or on boot with
75.Xr hostname.if 5 .
76.Sh HARDWARE
77The following adapters should work:
78.Pp
79.Bl -tag -width Ds -offset indent -compact
80.It Alfa AWUS036H
81.It ASUS P5B Deluxe
82.It Belkin F5D7050E
83.It Digitus DN-7003GT
84.It Linksys WUSB54GC v2
85.It Netgear WG111v2
86.It Netgear WG111v3
87.It Shuttle XPC Accessory PN20
88.It Sitecom WL-168 v1
89.It Sitecom WL-168 v4
90.It Surecom EP-9001-g rev 2A
91.It TRENDnet TEW-424UB V3.xR
92.El
93.Sh EXAMPLES
94The following example scans for available networks:
95.Pp
96.Dl # ifconfig urtw0 scan
97.Pp
98The following
99.Xr hostname.if 5
100example configures urtw0 to join network
101.Dq mynwid ,
102using WPA key
103.Dq mywpakey ,
104obtaining an IP address using DHCP:
105.Bd -literal -offset indent
106join mynwid wpakey mywpakey
107inet autoconf
108.Ed
109.Sh SEE ALSO
110.Xr arp 4 ,
111.Xr ifmedia 4 ,
112.Xr intro 4 ,
113.Xr netintro 4 ,
114.Xr usb 4 ,
115.Xr hostname.if 5 ,
116.\".Xr hostapd 8 ,
117.Xr ifconfig 8
118.Pp
119Realtek Semiconductor:
120.Lk http://www.realtek.com.tw/
121.Sh HISTORY
122The
123.Nm
124device driver first appeared in
125.Ox 4.5 .
126.Sh AUTHORS
127The
128.Nm
129driver was written by
130.An Weongyo Jeong Aq Mt weongyo@FreeBSD.org .
131.Sh CAVEATS
132This driver does not support powersave mode.
133