share/man/man4/urtw.4

   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 July 25, 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
  34 To compile this driver into the kernel,
  35 place 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
  45 Alternatively, to load the driver as a module at boot time,
  46 place the following line in
  47 .Xr loader.conf 5 :
  48 .Bd -literal -offset indent
  49 if_urtw_load="YES"
  50 .Ed
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 driver supports USB 802.11b/g wireless adapters based on the
  55 Realtek RTL8187B/L.
  56 .Pp
  57 .Nm
  58 supports
  59 .Cm station
  60 and
  61 .Cm monitor
  62 mode operation.
  63 Only one virtual interface may be configured at any time.
  64 For more information on configuring this device, see
  65 .Xr ifconfig 8 .
  66 .Sh HARDWARE
  67 The
  68 .Nm
  69 driver 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 "Netgear WG111v2    RTL8225 USB"
  74 .It "Safehome WLG-1500SMA5      RTL8225 USB"
  75 .It "Shuttle XPC Accessory PN20 RTL8225 USB"
  76 .El
  77 .Sh EXAMPLES
  78 Join an existing BSS network (i.e., connect to an access point):
  79 .Pp
  80 .Bd -literal -offset indent
  81 ifconfig wlan create wlandev urtw0 inet 192.168.0.20 \e
  82     netmask 0xffffff00
  83 .Ed
  84 .Pp
  85 Join a specific BSS network with network name
  86 .Dq Li my_net :
  87 .Pp
  88 .Dl "ifconfig wlan create wlandev urtw0 ssid my_net up"
  89 .Pp
  90 Join a specific BSS network with 64-bit WEP encryption:
  91 .Bd -literal -offset indent
  92 ifconfig wlan create wlandev urtw0 ssid my_net \e
  93         wepmode on wepkey 0x1234567890 weptxkey 1 up
  94 .Ed
  95 .Sh SEE ALSO
  96 .Xr intro 4 ,
  97 .Xr netintro 4 ,
  98 .Xr usb 4 ,
  99 .Xr wlan 4 ,
 100 .Xr wlan_ccmp 4 ,
 101 .Xr wlan_tkip 4 ,
 102 .Xr wlan_wep 4 ,
 103 .Xr ifconfig 8 ,
 104 .Xr wpa_supplicant 8
 105 .Rs
 106 .%T Realtek
 107 .%O http://www.realtek.com.tw
 108 .Re
 109 .Sh HISTORY
 110 The
 111 .Nm
 112 device driver first appeared in
 113 .Fx 8.0 .
 114 .Sh AUTHORS
 115 .An -nosplit
 116 The
 117 .Nm
 118 driver was written by
 119 .An Weongyo Jeong
 120 .Aq weongyo@FreeBSD.org .