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 FreeBSD
  36 .Sh NAME
  37 .Nm wicontrol
  38 .Nd configure WaveLAN/IEEE devices
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Fl i Ar iface Op Fl oa
  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 oa
 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. Using
 118 the additional
 119 .Fl a
 120 flag will cause
 121 .Nm
 122 to print out encryption keys as ascii characters instead of in hex.
 123 Encryption keys are only displayed if wicontrol is run as root.
 124 .It Fl i Ar iface Fl t Ar tx rate
 125 Set the transmit rate of the specified interface.
 126 The legal values
 127 for the transmit rate vary depending on whether the interface is a
 128 standard WaveLAN/IEEE or a WaveLAN/IEEE Turbo adapter.
 129 The standard
 130 NICs support a maximum transmit rate of 2Mbps while the turbo NICs
 131 support a maximum speed of 6Mbps.
 132 The following table shows the
 133 legal transmit rate settings and the corresponding transmit speeds:
 134 .Bl -column "TX rate " "NIC speed " -offset indent
 135 .Em "TX rate    NIC speed"
 136 1       Fixed Low (1Mbps)
 137 2       Fixed Standard (2Mbps)
 138 3       Auto Rate Select (High)
 139 4       Fixed Medium (4Mbps)
 140 5       Fixed High (6Mbps)
 141 6       Auto Rate Select (Standard)
 142 7       Auto Rate Select (Medium)
 143 .El
 144 .Pp
 145 The standard NICs support only settings 1 through 3. Turbo NICs support
 146 all the above listed speed settings.
 147 The default driver setting is 3 (auto rate select).
 148 .It Fl i Ar iface Fl n Ar network name
 149 Set the name of the service set (IBSS) that this station wishes to
 150 join.
 151 The
 152 .Ar network name
 153 can be any text string up to 30 characters in length.
 154 The default name
 155 is the string "ANY" which should allow the station to connect to the first
 156 available access point.
 157 The interface should be set for BSS mode using
 158 the
 159 .Fl p
 160 flag in order for this to work.
 161 .Pp
 162 Note: the WaveLAN manual indicates that an empty string will allow the
 163 host to connect to any access point, however I have also seen a reference
 164 in another driver which indicates that the "ANY" string works as well.
 165 .It Fl i Ar iface Fl s Ar station name
 166 Sets the
 167 .Ar station name
 168 for the specified interface.
 169 The
 170 .Ar station name
 171 is used for diagnostic purposes.
 172 The Lucent WaveMANAGER software can
 173 poll the names of remote hosts.
 174 .It Fl i Ar iface Fl c Ar 0|1
 175 Allow the station to create a service set (IBSS). Permitted values
 176 are 0 (don't create IBSS) and 1 (enable creation of IBSS). The default
 177 is 0.
 178 .Pp
 179 Note: this option is provided for experimental purposes only: enabling
 180 the creation of an IBSS on a host system doesn't appear to actually work.
 181 .It Fl i Ar iface Fl q Ar SSID
 182 Specify the name of an IBSS (SSID) to create on a given interface.
 183 The
 184 .Ar SSID
 185 can be any text string up to 30 characters long.
 186 .Pp
 187 Note: this option is provided for experimental purposes only: enabling
 188 the creation of an IBSS on a host system doesn't appear to actually work.
 189 .It Fl i Ar iface Fl p Ar port type
 190 Set the
 191 .Ar port type
 192 for a specified interface.
 193 The legal values for
 194 .Ar port type
 195 are 1 (BSS mode) and 3 (ad-hoc) mode.
 196 In ad-hoc mode, the station can
 197 communicate directly with any other stations within direct radio range
 198 (provided that they are also operating in ad-hoc mode). In BSS mode,
 199 hosts must associate with a service set controlled by an access point,
 200 which relays traffic between end stations.
 201 The default setting is 3
 202 (ad-hoc mode).
 203 .It Fl i Ar iface Fl a Ar access_point_density
 204 Specify the
 205 .Ar access point density
 206 for a given interface.
 207 Legal values are 1 (low), 2 (medium) and 3 (high).
 208 This setting influences some of the radio modem threshold settings.
 209 .It Fl i Ar iface Fl m Ar mac address
 210 Set the station address for the specified interface.
 211 The
 212 .Ar mac address
 213 is specified as a series of six hexadecimal values separated by colons,
 214 e.g.: 00:60:1d:12:34:56.
 215 This programs the new address into the card
 216 and updates the interface as well.
 217 .It Fl i Ar iface Fl d Ar max_data_length
 218 Set the maximum receive and transmit frame size for a specified interface.
 219 The
 220 .Ar max data length
 221 can be any number from 350 to 2304.
 222 The default is 2304.
 223 .It Fl i Ar iface Fl e Ar 0|1
 224 Enable or disable WEP encryption.
 225 Permitted values are
 226 .Ar 0
 227 (encryption disabled) or
 228 .Ar 1
 229 (encryption enabled). Encryption is off by default.
 230 .It Fl i Ar iface Fl k Ar key "[-v 1|2|3|4]"
 231 Set WEP encryption keys.
 232 There are four default encryption keys
 233 that can be programmed.
 234 A specific key can be set using
 235 the
 236 .Fl v
 237 flag.
 238 If the
 239 .Fl v
 240 flag is not specified, the first key will be set.
 241 Encryption keys
 242 can either be normal text (i.e. "hello") or a series of hexadecimal
 243 digits (i.e. "0x1234512345"). For
 244 WaveLAN Turbo Silver cards, the key is restricted to 40 bits, hence
 245 the key can be either a 5 character text string or 10 hex digits.
 246 For WaveLAN Turbo Gold cards, the key can also be 104 bits,
 247 which means the key can be specified as either a 13 character text
 248 string or 26 hex digits in addition to the formats supported by the
 249 Silver cards.
 250 .It Fl i Ar iface Fl T Ar 1|2|3|4
 251 Specify which of the four WEP encryption keys will be used to
 252 encrypt transmitted packets.
 253 .It Fl i Ar iface Fl r Ar RTS threshold
 254 Set the RTS/CTS threshold for a given interface.
 255 This controls the
 256 number of bytes used for the RTS/CTS handshake boundary.
 257 The
 258 .Ar RTS threshold
 259 can be any value between 0 and 2047.
 260 The default is 2347.
 261 .It Fl i Ar iface Fl f Ar frequency
 262 Set the radio frequency of a given interface.
 263 The
 264 .Ar frequency
 265 should be specified as a channel ID as shown in the table below.
 266 The
 267 list of available frequencies is dependent on radio regulations specified
 268 by regional authorities.
 269 Recognized regulatory authorities include
 270 the FCC (United States), ETSI (Europe), France and Japan.
 271 Frequencies
 272 in the table are specified in Mhz.
 273 .Bl -column "Channel ID " "FCC " "ETSI " "France " "Japan " -offset indent
 274 .Em "Channel ID FCC     ETSI    France  Japan"
 275 1       2412    2412    -       2412
 276 2       2417    2417    -       2417
 277 3       2422    2422    -       2422
 278 4       2427    2427    -       2427
 279 5       2432    2432    -       2432
 280 6       2437    2437    -       2437
 281 7       2442    2442    -       2442
 282 8       2447    2447    -       2447
 283 9       2452    2452    -       2452
 284 10      2457    2457    2457    2457
 285 11      2462    2462    2462    2462
 286 12      -       2467    2467    2467
 287 13      -       2472    2472    2472
 288 14      -       -       -       2484
 289 .El
 290 .Pp
 291 If an illegal channel is specified, the
 292 NIC will revert to its default channel.
 293 For NICs sold in the United States
 294 and Europe, the default channel is 3. For NICs sold in France, the default
 295 channel is 11.
 296 For NICs sold in Japan, the default channel is 14,
 297 and it is the only available channel for pre-11Mbps NICs.
 298 Note that two stations must be set to the same channel in order to
 299 communicate.
 300 .It Fl i Ar iface Fl P Ar 0|1
 301 Enable or disable power management on a given interface.
 302 Enabling
 303 power management uses an alternating sleep/wake protocol to help
 304 conserve power on mobile stations, at the cost of some increased
 305 receive latency.
 306 Power management is off by default.
 307 Note that power
 308 management requires the cooperation of an access point in order to
 309 function; it is not functional in ad-hoc mode.
 310 Also, power management
 311 is only implemented in Lucent WavePOINT firmware version 2.03 or
 312 later, and in WaveLAN PCMCIA adapter firmware 2.00 or later.
 313 Older
 314 revisions will silently ignore the power management setting.
 315 Legal
 316 values for this parameter are 0 (off) and 1 (on).
 317 .It Fl i Ar iface Fl S Ar max_sleep_interval
 318 Specify the sleep interval to use when power management is enabled.
 319 The
 320 .Ar max_sleep_interval
 321 is specified in milliseconds.
 322 The default is 100.
 323 .It Fl i Ar iface Fl Z
 324 Clear the signal strength cache maintained internally by the
 325 .Nm wi
 326 driver.
 327 .It Fl i Ar iface Fl C
 328 Display the cached signal strength information maintained by the
 329 .Nm wi
 330 driver.
 331 The driver retains information about signal strength and
 332 noise level for packets received from different hosts.
 333 The signal
 334 strength and noise level values are displayed in units of dBms.
 335 The signal quality values is produced by subtracting the noise level
 336 from the signal strength (i.e. less noise and better signal yields
 337 better signal quality).
 338 .El
 339 .Sh SEE ALSO
 340 .Xr wi 4 ,
 341 .Xr ifconfig 8
 342 .Sh HISTORY
 343 The
 344 .Nm
 345 command first appeared in
 346 .Fx 3.0 .
 347 .Sh AUTHORS
 348 The
 349 .Nm
 350 command was written by
 351 .An Bill Paul Aq wpaul@ctr.columbia.edu .