xref: /openbsd-src/share/man/man4/urtw.4 (revision 2b0358df1d88d06ef4139321dd05bd5e05d91eaf)
1.\" $OpenBSD: urtw.4,v 1.4 2009/03/03 07:49:27 kevlo 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: March 3 2009 $
18.Os
19.Dt URTW 4
20.Sh NAME
21.Nm urtw
22.Nd Realtek RTL8187L 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.
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 IBSS mode
42Also known as
43.Em IEEE ad-hoc
44mode or
45.Em peer-to-peer
46mode.
47This is the standardized method of operating without an access point.
48Stations associate with a service set.
49However, actual connections between stations are peer-to-peer.
50.It monitor mode
51In this mode the driver is able to receive packets without
52associating with an access point.
53This disables the internal receive filter and enables the card to
54capture packets from networks which it wouldn't normally have access to,
55or to scan for access points.
56.El
57.Pp
58The
59.Nm
60driver can be configured to use
61Wireless Equivalent Privacy (WEP) or
62Wi-Fi Protected Access (WPA-PSK and WPA2-PSK).
63WPA is the de facto encryption standard for wireless networks.
64It is strongly recommended that WEP
65not be used as the sole mechanism
66to secure wireless communication,
67due to serious weaknesses in it.
68The
69.Nm
70driver relies on the software 802.11 stack for both encryption and decryption
71of data frames.
72.Pp
73The
74.Nm
75driver can be configured at runtime with
76.Xr ifconfig 8
77or on boot with
78.Xr hostname.if 5 .
79.Sh HARDWARE
80The following adapters should work:
81.Pp
82.Bl -tag -width Ds -offset indent -compact
83.It Netgear WG111v2
84.It Shuttle XPC Accessory PN20
85.It Surecom EP-9001-g rev 2A
86.El
87.Sh EXAMPLES
88The following
89.Xr hostname.if 5
90example configures urtw0 to join whatever network is available on boot,
91using WEP key
92.Dq 0x1deadbeef1 ,
93channel 11, obtaining an IP address using DHCP:
94.Bd -literal -offset indent
95dhcp NONE NONE NONE nwkey 0x1deadbeef1 chan 11
96.Ed
97.Pp
98The following
99.Xr hostname.if 5
100example creates a host-based access point on boot:
101.Bd -literal -offset indent
102inet 192.168.1.1 255.255.255.0 NONE media autoselect \e
103	mediaopt hostap nwid my_net chan 11
104.Ed
105.Pp
106Configure urtw0 to join network
107.Dq my_net
108using WPA-PSK with passphrase
109.Dq my_passphrase :
110.Bd -literal -offset indent
111# ifconfig urtw0 nwid my_net wpa wpapsk \e
112	`wpa-psk my_net my_passphrase`
113.Ed
114.Pp
115Return urtw0 to its default settings:
116.Bd -literal -offset indent
117# ifconfig urtw0 -bssid -chan media autoselect \e
118	nwid "" -nwkey -wpa -wpapsk
119.Ed
120.Pp
121Join an existing BSS network,
122.Dq my_net :
123.Bd -literal -offset indent
124# ifconfig urtw0 192.168.1.1 netmask 0xffffff00 nwid my_net
125.Ed
126.Sh SEE ALSO
127.Xr arp 4 ,
128.Xr ifmedia 4 ,
129.Xr intro 4 ,
130.Xr netintro 4 ,
131.Xr usb 4 ,
132.Xr hostname.if 5 ,
133.Xr hostapd 8 ,
134.Xr ifconfig 8 ,
135.Xr wpa-psk 8
136.Pp
137RealTek Semiconductor:
138.Pa http://www.realtek.com.tw/
139.Sh HISTORY
140The
141.Nm
142device driver first appeared in
143.Ox 4.5 .
144.Sh AUTHORS
145The
146.Nm
147driver was written by
148.An Weongyo Jeong Aq weongyo@FreeBSD.org .
149