usr.sbin/wicontrol/wicontrol.8

   1 .\" Copyright (c) 1997, 1998, 1999
   2 .\"     Bill Paul <wpaul@ctr.columbia.edu> 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 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by Bill Paul.
  15 .\" 4. Neither the name of the author nor the names of any co-contributors
  16 .\"    may be used to endorse or promote products derived from this software
  17 .\"   without specific prior written permission.
  18 .\"
  19 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  20 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  23 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  29 .\" THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd April 21, 1999
  34 .Dt WICONTROL 8
  35 .Os
  36 .Sh NAME
  37 .Nm wicontrol
  38 .Nd configure WaveLAN/IEEE devices
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Fl i Ar iface Op Fl o
  42 .Nm
  43 .Fl i Ar iface Fl t Ar tx rate
  44 .Nm
  45 .Fl i Ar iface Fl n Ar network name
  46 .Nm
  47 .Fl i Ar iface Fl s Ar station name
  48 .Nm
  49 .Fl i Ar iface Fl c Ar 0|1
  50 .Nm
  51 .Fl i Ar iface Fl q Ar SSID
  52 .Nm
  53 .Fl i Ar iface Fl p Ar port type
  54 .Nm
  55 .Fl i Ar iface Fl a Ar access point density
  56 .Nm
  57 .Fl i Ar iface Fl m Ar mac address
  58 .Nm
  59 .Fl i Ar iface Fl d Ar max data length
  60 .Nm
  61 .Fl i Ar iface Fl e Ar 0|1
  62 .Nm
  63 .Fl i Ar iface Fl k Ar key
  64 .Op Fl v Ar 1|2|3|4
  65 .Nm
  66 .Fl i Ar iface Fl T Ar 1|2|3|4
  67 .Nm
  68 .Fl i Ar iface Fl r Ar RTS threshold
  69 .Nm
  70 .Fl i Ar iface Fl f Ar frequency
  71 .Nm
  72 .Fl i Ar iface Fl P Ar 0|1
  73 .Nm
  74 .Fl i Ar iface Fl S Ar max_sleep_duration
  75 .Nm
  76 .Fl i Ar iface Fl Z
  77 (zero signal cache)
  78 .Nm
  79 .Fl i Ar iface Fl C
  80 (display signal cache)
  81 .Sh DESCRIPTION
  82 The
  83 .Nm
  84 command controls the operation of WaveLAN/IEEE wireless networking
  85 devices via the
  86 .Xr wi 4
  87 driver.
  88 Most of the parameters that can be changed relate to the
  89 IEEE 802.11 protocol which the WaveLAN implements.
  90 This includes
  91 the station name, whether the station is operating in ad-hoc (point
  92 to point) or BSS (service set) mode, and the network name of a service
  93 set to join (IBSS) if BSS mode is enabled.
  94 The
  95 .Nm
  96 command can also be used to view the current settings of these parameters
  97 and to dump out the values of the card's statistics counters.
  98 .Pp
  99 The
 100 .Ar iface
 101 argument given to
 102 .Nm
 103 should be the logical interface name associated with the WaveLAN/IEEE
 104 device (wi0, wi1, etc...). If none is specified then wi0 is used
 105 as default.
 106 .Sh OPTIONS
 107 The options are as follows:
 108 .Bl -tag -width Fl
 109 .It Fl i Ar iface Op Fl o
 110 Display the current settings of the specified WaveLAN/IEEE interface.
 111 This retrieves the current card settings from the driver and prints them
 112 out.
 113 Using the additional
 114 .Fl o
 115 flag will cause
 116 .Nm
 117 to print out the statistics counters instead of the card settings.
 118 Encryption keys are only displayed if wicontrol is run as root.
 119 .It Fl i Ar iface Fl t Ar tx rate
 120 Set the transmit rate of the specified interface.
 121 The legal values
 122 for the transmit rate vary depending on whether the interface is a
 123 standard WaveLAN/IEEE or a WaveLAN/IEEE Turbo adapter.
 124 The standard
 125 NICs support a maximum transmit rate of 2Mbps while the turbo NICs
 126 support a maximum speed of 6Mbps.
 127 The following table shows the
 128 legal transmit rate settings and the corresponding transmit speeds:
 129 .Bl -column "TX rate " "NIC speed " -offset indent
 130 .Em "TX rate    NIC speed"
 131 1       Fixed Low (1Mbps)
 132 2       Fixed Standard (2Mbps)
 133 3       Auto Rate Select (High)
 134 4       Fixed Medium (4Mbps)
 135 5       Fixed High (6Mbps)
 136 6       Auto Rate Select (Standard)
 137 7       Auto Rate Select (Medium)
 138 .El
 139 .Pp
 140 The standard NICs support only settings 1 through 3. Turbo NICs support
 141 all the above listed speed settings.
 142 The default driver setting is 3 (auto rate select).
 143 .It Fl i Ar iface Fl n Ar network name
 144 Set the name of the service set (IBSS) that this station wishes to
 145 join.
 146 The
 147 .Ar network name
 148 can be any text string up to 30 characters in length.
 149 The default name
 150 is the string "ANY" which should allow the station to connect to the first
 151 available access point.
 152 The interface should be set for BSS mode using
 153 the
 154 .Fl p
 155 flag in order for this to work.
 156 .Pp
 157 Note: the WaveLAN manual indicates that an empty string will allow the
 158 host to connect to any access point, however I have also seen a reference
 159 in another driver which indicates that the "ANY" string works as well.
 160 .It Fl i Ar iface Fl s Ar station name
 161 Sets the
 162 .Ar station name
 163 for the specified interface.
 164 The
 165 .Ar station name
 166 is used for diagnostic purposes.
 167 The Lucent WaveMANAGER software can
 168 poll the names of remote hosts.
 169 .It Fl i Ar iface Fl c Ar 0|1
 170 Allow the station to create a service set (IBSS). Permitted values
 171 are 0 (don't create IBSS) and 1 (enable creation of IBSS). The default
 172 is 0.
 173 .Pp
 174 Note: this option is provided for experimental purposes only: enabling
 175 the creation of an IBSS on a host system doesn't appear to actually work.
 176 .It Fl i Ar iface Fl q Ar SSID
 177 Specify the name of an IBSS (SSID) to create on a given interface.
 178 The
 179 .Ar SSID
 180 can be any text string up to 30 characters long.
 181 .Pp
 182 Note: this option is provided for experimental purposes only: enabling
 183 the creation of an IBSS on a host system doesn't appear to actually work.
 184 .It Fl i Ar iface Fl p Ar port type
 185 Set the
 186 .Ar port type
 187 for a specified interface.
 188 The legal values for
 189 .Ar port type
 190 are 1 (BSS mode) and 3 (ad-hoc) mode.
 191 In ad-hoc mode, the station can
 192 communicate directly with any other stations within direct radio range
 193 (provided that they are also operating in ad-hoc mode). In BSS mode,
 194 hosts must associate with a service set controlled by an access point,
 195 which relays traffic between end stations.
 196 The default setting is 3
 197 (ad-hoc mode).
 198 .It Fl i Ar iface Fl a Ar access_point_density
 199 Specify the
 200 .Ar access point density
 201 for a given interface.
 202 Legal values are 1 (low), 2 (medium) and 3 (high).
 203 This setting influences some of the radio modem threshold settings.
 204 .It Fl i Ar iface Fl m Ar mac address
 205 Set the station address for the specified interface.
 206 The
 207 .Ar mac address
 208 is specified as a series of six hexadecimal values separated by colons,
 209 e.g.: 00:60:1d:12:34:56.
 210 This programs the new address into the card
 211 and updates the interface as well.
 212 .It Fl i Ar iface Fl d Ar max_data_length
 213 Set the maximum receive and transmit frame size for a specified interface.
 214 The
 215 .Ar max data length
 216 can be any number from 350 to 2304.
 217 The default is 2304.
 218 .It Fl i Ar iface Fl e Ar 0|1
 219 Enable or disable WEP encryption.
 220 Permitted values are
 221 .Ar 0
 222 (encryption disabled) or
 223 .Ar 1
 224 (encryption enabled). Encryption is off by default.
 225 .It Fl i Ar iface Fl k Ar key "[-v 1|2|3|4]"
 226 Set WEP encryption keys.
 227 There are four default encryption keys
 228 that can be programmed.
 229 A specific key can be set using
 230 the
 231 .Fl v
 232 flag.
 233 If the
 234 .Fl v
 235 flag is not specified, the first key will be set.
 236 Encryption keys
 237 can either be normal text (i.e. "hello") or a series of hexadecimal
 238 digits (i.e. "0x1234512345"). For
 239 WaveLAN Turbo Silver cards, the key is restricted to 40 bits, hence
 240 the key can be either a 5 character text string or 10 hex digits.
 241 For WaveLAN Turbo Gold cards, the key can also be 104 bits,
 242 which means the key can be specified as either a 13 character text
 243 string or 26 hex digits in addition to the formats supported by the
 244 Silver cards.
 245 .It Fl i Ar iface Fl T Ar 1|2|3|4
 246 Specify which of the four WEP encryption keys will be used to
 247 encrypt transmitted packets.
 248 .It Fl i Ar iface Fl r Ar RTS threshold
 249 Set the RTS/CTS threshold for a given interface.
 250 This controls the
 251 number of bytes used for the RTS/CTS handshake boundary.
 252 The
 253 .Ar RTS threshold
 254 can be any value between 0 and 2047.
 255 The default is 2347.
 256 .It Fl i Ar iface Fl f Ar frequency
 257 Set the radio frequency of a given interface.
 258 The
 259 .Ar frequency
 260 should be specified as a channel ID as shown in the table below.
 261 The
 262 list of available frequencies is dependent on radio regulations specified
 263 by regional authorities.
 264 Recognized regulatory authorities include
 265 the FCC (United States), ETSI (Europe), France and Japan.
 266 Frequencies
 267 in the table are specified in Mhz.
 268 .Bl -column "Channel ID " "FCC " "ETSI " "France " "Japan " -offset indent
 269 .Em "Channel ID FCC     ETSI    France  Japan"
 270 1       2412    2412    -       2412
 271 2       2417    2417    -       2417
 272 3       2422    2422    -       2422
 273 4       2427    2427    -       2427
 274 5       2432    2432    -       2432
 275 6       2437    2437    -       2437
 276 7       2442    2442    -       2442
 277 8       2447    2447    -       2447
 278 9       2452    2452    -       2452
 279 10      2457    2457    2457    2457
 280 11      2462    2462    2462    2462
 281 12      -       2467    2467    2467
 282 13      -       2472    2472    2472
 283 14      -       -       -       2484
 284 .El
 285 .Pp
 286 If an illegal channel is specified, the
 287 NIC will revert to its default channel.
 288 For NICs sold in the United States
 289 and Europe, the default channel is 3. For NICs sold in France, the default
 290 channel is 11.
 291 For NICs sold in Japan, the default channel is 14,
 292 and it is the only available channel for pre-11Mbps NICs.
 293 Note that two stations must be set to the same channel in order to
 294 communicate.
 295 .It Fl i Ar iface Fl P Ar 0|1
 296 Enable or disable power management on a given interface.
 297 Enabling
 298 power management uses an alternating sleep/wake protocol to help
 299 conserve power on mobile stations, at the cost of some increased
 300 receive latency.
 301 Power management is off by default.
 302 Note that power
 303 management requires the cooperation of an access point in order to
 304 function; it is not functional in ad-hoc mode.
 305 Also, power management
 306 is only implemented in Lucent WavePOINT firmware version 2.03 or
 307 later, and in WaveLAN PCMCIA adapter firmware 2.00 or later.
 308 Older
 309 revisions will silently ignore the power management setting.
 310 Legal
 311 values for this parameter are 0 (off) and 1 (on).
 312 .It Fl i Ar iface Fl S Ar max_sleep_interval
 313 Specify the sleep interval to use when power management is enabled.
 314 The
 315 .Ar max_sleep_interval
 316 is specified in milliseconds.
 317 The default is 100.
 318 .It Fl i Ar iface Fl Z
 319 Clear the signal strength cache maintained internally by the
 320 .Nm wi
 321 driver.
 322 .It Fl i Ar iface Fl C
 323 Display the cached signal strength information maintained by the
 324 .Nm wi
 325 driver.
 326 The driver retains information about signal strength and
 327 noise level for packets received from different hosts.
 328 The signal
 329 strength and noise level values are displayed in units of dBms.
 330 The signal quality values is produced by subtracting the noise level
 331 from the signal strength (i.e. less noise and better signal yields
 332 better signal quality).
 333 .El
 334 .Sh SEE ALSO
 335 .Xr wi 4 ,
 336 .Xr ifconfig 8
 337 .Sh HISTORY
 338 The
 339 .Nm
 340 command first appeared in
 341 .Fx 3.0 .
 342 .Sh AUTHORS
 343 The
 344 .Nm
 345 command was written by
 346 .An Bill Paul Aq wpaul@ctr.columbia.edu .