wireless_tools/iwconfig.8

   1 .\" Jean II - HPLB - 96
   2 .\" iwconfig.8
   3 .\"
   4 .TH IWCONFIG 8 "31 October 1996" "net-tools" "Linux Programmer's Manual"
   5 .\"
   6 .\" NAME part
   7 .\"
   8 .SH NAME
   9 iwconfig \- configure a wireless network interface
  10 .\"
  11 .\" SYNOPSIS part
  12 .\"
  13 .SH SYNOPSIS
  14 .BI "iwconfig [" interface ]
  15 .br
  16 .BI "iwconfig " interface " [essid " X "] [nwid " N "] [freq " F "] [channel " C ]
  17 .br
  18 .BI "                   [sens " S "] [mode " M "] [ap " A "] [nick " NN ]
  19 .br
  20 .BI "                   [rate " R "] [rts " RT "] [frag " FT "] [txpower " T ]
  21 .br
  22 .BI "                   [enc " E "] [key " K "] [power " P "] [retry " R ]
  23 .br
  24 .BI "                   [commit]
  25 .\"
  26 .\" DESCRIPTION part
  27 .\"
  28 .SH DESCRIPTION
  29 .B Iwconfig
  30 is similar to
  31 .IR ifconfig (8),
  32 but is dedicated to the wireless interfaces. It is used to set the
  33 parameters of the network interface which are specific to the wireless
  34 operation (for example : the frequency).
  35 .B Iwconfig
  36 may also be used to display those parameters, and the wireless
  37 statistics (extracted from
  38 .IR /proc/net/wireless ).
  39 .PP
  40 All these parameters and statistics are device dependant. Each driver
  41 will provide only some of them depending on the hardware support, and
  42 the range of value may change. Please refer to the man page of each
  43 device for details.
  44 .\"
  45 .\" PARAMETER part
  46 .\"
  47 .SH PARAMETERS
  48 .TP
  49 .B essid
  50 Set the ESSID (or Network Name - in some products it may also called
  51 Domain ID). The ESSID is used to identify cells which are part of the
  52 same virtual network.
  53 .br
  54 As opposed to the NWID which defines a single cell, the ESSID defines
  55 a group of cell connected via repeaters or infrastructure, where the
  56 user may roam.  With some card, you may disable the ESSID checking
  57 (ESSID promiscuous) with
  58 .IR off " or " any " (and " on
  59 to reenable it).
  60 .br
  61 .B Examples :
  62 .br
  63 .I "    iwconfig eth0 essid any"
  64 .br
  65 .I "    iwconfig eth0 essid ""My Network""
  66 .TP
  67 .BR nwid / domain
  68 Set the Network ID (in some products it is also called Domain ID). As
  69 all adjacent wireless networks share the same medium, this parameter
  70 is used to differenciate them (create logical colocated networks) and
  71 identify nodes belonguing to the same cell. With some card, you may
  72 disable the Network ID checking (NWID promiscuous) with
  73 .IR off " (and " on
  74 to reenable it).
  75 .br
  76 .B Examples :
  77 .br
  78 .I "    iwconfig eth0 nwid AB34
  79 .br
  80 .I "    iwconfig eth0 nwid off"
  81 .TP
  82 .BR freq / channel
  83 Set the operating frequency or channel in the device. Value below 1000
  84 are the channel number, value over this is the frequency in Hz. You
  85 must append the suffix k, M or G to the value (for example, "2.46G"
  86 for 2.46 GHz frequency), or add enough '0'.
  87 .br
  88 Channels are usually numbered starting at 1,
  89 and you may use
  90 .IR iwpriv (8)
  91 to get the total number of channels and list the available
  92 frequencies. Depending on regulations, some frequencies/channels may
  93 not be available.
  94 .br
  95 .B Examples :
  96 .br
  97 .I "    iwconfig eth0 freq 2.422G"
  98 .br
  99 .I "    iwconfig eth0 channel 3"
 100 .TP
 101 .B sens
 102 Set the sensitivity threshold. This is the lowest signal level for
 103 which we attempt a packet reception, signal lower than this are not
 104 received. This is used to avoid receiving background noise, so you
 105 should set it according to the average noise level. Positive values
 106 are assumed to be the raw value used by the hardware or a percentage,
 107 negative values are assumed to be dBm.
 108 .br
 109 With some hardware, this parameter also control the defer threshold
 110 (lowest signal level for which we consider the channel busy) and the
 111 handover threshold (lowest signal level where we stay associated with
 112 the current access point).
 113 .br
 114 .B Example :
 115 .br
 116 .I "    iwconfig eth0 sens -80"
 117 .TP
 118 .B mode
 119 Set the operating mode of the device, which depends on the network
 120 topology. The mode can be
 121 .I Ad-hoc
 122 (network composed of only one cell and without Access Point),
 123 .I Managed
 124 (network composed of many cells, with roaming or with an Access Point),
 125 .I Master
 126 (the node is the synchronisation master or act as an Access Point),
 127 .I Repeater
 128 (the node forward packets on the air),
 129 .I Secondary
 130 (the node act as a backup master/repeater) or
 131 .IR Auto .
 132 .br
 133 .B Example :
 134 .br
 135 .I "    iwconfig eth0 mode Managed"
 136 .TP
 137 .B ap
 138 Force the card to register to the Access Point given by the address,
 139 if it is possible. When the quality of the connection goes too low,
 140 the driver may revert back to automatic mode (the card finds the best
 141 Access Point in range).
 142 .br
 143 You may also use
 144 .I off
 145 to re-enable automatic mode without changing the current Access Point,
 146 or you may use
 147 .I any
 148 or
 149 .I auto
 150 to force the card to reassociate with the current best Access Point.
 151 .br
 152 .B Example :
 153 .br
 154 .I "    iwconfig eth0 ap 00:60:1D:01:23:45"
 155 .br
 156 .I "    iwconfig eth0 ap any"
 157 .br
 158 .I "    iwconfig eth0 ap off"
 159 .TP
 160 .BR nick [name]
 161 Set the nickname, or the station name. Most 802.11 products do define
 162 it, but this is not used as far as the protocols (MAC, IP, TCP) are
 163 concerned and completely accessory as far as configuration goes. In
 164 fact only some diagnostic tools may use it.
 165 .br
 166 .B Example :
 167 .br
 168 .I "    iwconfig eth0 nickname ""My Linux Node""
 169 .TP
 170 .BR rate / bit [rate]
 171 For cards supporting multiple bit rates, set the bit-rate in b/s. The
 172 bit-rate is the speed at which bits are transmitted over the medium,
 173 the user speed of the link is lower due to medium sharing and
 174 overhead.
 175 .br
 176 You must append the suffix k, M or G to the value (decimal multiplier
 177 : 10^3, 10^6 and 10^9 b/s), or add enough '0'. Values below 1000 are
 178 card specific, usually an index in the bit-rate list. Use
 179 .I auto
 180 to select the automatic bit-rate mode (fallback to lower rate on noisy
 181 channels), which is the default for most cards, and
 182 .I fixed
 183 to revert back to fixed setting. If you specify a bit-rate value and append
 184 .IR auto ,
 185 the driver will use all bit lower and equal than this value.
 186 .br
 187 .B Examples :
 188 .br
 189 .I "    iwconfig eth0 rate 11M"
 190 .br
 191 .I "    iwconfig eth0 rate auto"
 192 .br
 193 .I "    iwconfig eth0 rate 5.5M auto"
 194 .TP
 195 .BR rts [_threshold]
 196 RTS/CTS adds a handshake before each packet transmission to make sure
 197 that the channel is clear. This adds overhead, but increase
 198 performance in case of hidden nodes or large number of active
 199 nodes. This parameters set the size of the smallest packet for which
 200 the node sends RTS, a value equal to the maximum packet size disable
 201 the scheme. You may also set this parameter to
 202 .IR auto ", " fixed " or " off .
 203 .br
 204 .B Examples :
 205 .br
 206 .I "    iwconfig eth0 rts 250"
 207 .br
 208 .I "    iwconfig eth0 rts off"
 209 .TP
 210 .BR frag [mentation_threshold]
 211 Fragmentation allow to split a IP packet in a burst of smaller
 212 fragments transmitted on the medium. In most cases this adds overhead,
 213 but in very noisy environment this reduce the error penalty. This
 214 parameter set the maximum fragment size, a value equal to the maximum
 215 packet size disable the scheme. You may also set this parameter to
 216 .IR auto ", " fixed " or " off .
 217 .br
 218 .B Examples :
 219 .br
 220 .I "    iwconfig eth0 frag 512"
 221 .br
 222 .I "    iwconfig eth0 frag off"
 223 .TP
 224 .BR key / enc [ryption]
 225 Used to manipulate encryption or scrambling keys and encryption mode.
 226 .br
 227 To set the current encryption key, just enter the key in hex digits as
 228 .IR XXXX-XXXX-XXXX-XXXX " or " XXXXXXXX .
 229 To set a key other than the current key, append
 230 .I [index]
 231 to the key itself. You can also enter the key as an ASCII string by
 232 using the
 233 .I s:
 234 prefix.
 235 .br
 236 To change which key is the current active key, just enter
 237 .I [index]
 238 (without entering any key value).
 239 .br
 240 .IR off " and " on
 241 disable and reenable encryption,
 242 .I open
 243 set the system in open mode (accept non-encrypted packets) and
 244 .I restricted
 245 discard non-encrypted packets.
 246 .br
 247 .B Examples :
 248 .br
 249 .I "    iwconfig eth0 key 0123-4567-89"
 250 .br
 251 .I "    iwconfig eth0 key s:password [2]"
 252 .br
 253 .I "    iwconfig eth0 key [2] open"
 254 .br
 255 .I "    iwconfig eth0 key off"
 256 .TP
 257 .BR power
 258 Used to manipulate power management scheme parameters and mode.
 259 .br
 260 To set the period between wake up, enter
 261 .IR "period `value'" .
 262 To set the timeout before going back to sleep, enter
 263 .IR "timeout `value'" .
 264 You can also add the
 265 .IR min " and " max
 266 modifiers. By defaults, those values are in seconds, append the
 267 suffix m or u to specify values un milliseconds or
 268 microseconds. Sometimes, those values are without units (number of
 269 dwell or the like).
 270 .br
 271 .IR off " and " on
 272 disable and reenable power management. Finally, you may set the power
 273 management mode to
 274 .I all
 275 (receive all packets),
 276 .I unicast
 277 (receive unicast packets only, discard multicast and broadcast) and
 278 .I multicast
 279 (receive multicast and broadcast only, discard unicast packets).
 280 .br
 281 .B Examples :
 282 .br
 283 .I "    iwconfig eth0 power period 2"
 284 .br
 285 .I "    iwconfig eth0 power 500m unicast"
 286 .br
 287 .I "    iwconfig eth0 power timeout 300u all"
 288 .br
 289 .I "    iwconfig eth0 power off"
 290 .br
 291 .I "    iwconfig eth0 power min period 2 power max period 4"
 292 .TP
 293 .BR txpower
 294 For cards supporting multiple transmit powers, set the transmit power in dBm. If
 295 .I W
 296 is the power in Watt, the power in dBm is
 297 .IR "P = 30 + 10.log(W)" .
 298 If the value is postfixed by
 299 .IR mW ,
 300 it will be automatically converted to dBm.
 301 .br
 302 In addition,
 303 .IR on " and " off
 304 enable and disable the radio, and
 305 .IR auto " and " fixed
 306 enable and disable power control (if those features are available).
 307 .br
 308 .B Examples :
 309 .br
 310 .I "    iwconfig eth0 txpower 15"
 311 .br
 312 .I "    iwconfig eth0 txpower 30mW"
 313 .br
 314 .I "    iwconfig eth0 txpower auto"
 315 .br
 316 .I "    iwconfig eth0 txpower off"
 317 .TP
 318 .BR retry
 319 Most cards have MAC retransmissions, and some allow to set the
 320 behaviour of the retry mechanism.
 321 .br
 322 To set the maximum number of retries, enter
 323 .IR "limit `value'" .
 324 This is an absolute value (without unit).
 325 The set the maximum length of time the MAC should retry, enter
 326 .IR "lifetime `value'" .
 327 By defaults, this value in in seconds, append the suffix m or u to
 328 specify values un milliseconds or microseconds.
 329 .br
 330 You can also add the
 331 .IR min " and " max
 332 modifiers. If the card support automatic mode, they define the bounds
 333 of the limit or lifetime. Some other cards define different values
 334 depending on packet size, for example in 802.11
 335 .I min limit
 336 is the short retry limit (non RTS/CTS packets).
 337 .br
 338 .B Examples :
 339 .br
 340 .I "    iwconfig eth0 retry 16"
 341 .br
 342 .I "    iwconfig eth0 retry lifetime 300m"
 343 .br
 344 .I "    iwconfig eth0 retry min limit 8"
 345 .TP
 346 .BR commit
 347 Some cards may not apply changes done through Wireless Extensions
 348 immediately (they may wait to agregate the changes or apply it only
 349 when the card is brought up via ifconfig). This command (when
 350 available) force the card to apply all pending changes.
 351 .br
 352 This is normally not needed, because the card will eventually apply
 353 the changes, but can be usefull for debugging.
 354 .\"
 355 .\" DISPLAY part
 356 .\"
 357 .SH DISPLAY
 358 For each device which support wireless extensions,
 359 .I iwconfig
 360 will display the name of the
 361 .B MAC protocol
 362 used (name of device for proprietary protocols), the
 363 .B ESSID
 364 (Network Name), the
 365 .BR NWID ,
 366 the
 367 .B frequency
 368 (or channel), the
 369 .BR sensitivity ,
 370 the
 371 .B mode
 372 of operation, the
 373 .B Access Point
 374 address, the
 375 .B bit-rate
 376 the
 377 .BR "RTS threshold" ", the " "fragmentation threshold" ,
 378 the
 379 .B encryption key
 380 and the
 381 .B power management
 382 settings (depending on availability).
 383 .br
 384 See above for explanations of what these parameters mean.
 385 .br
 386 If the label for bitrate is followed by
 387 .RB ` = ',
 388 it means that the parameter is fixed and forced to that value, if it
 389 is followed by
 390 .RB ` : '
 391 it is only the current value (device in normal auto mode).
 392 .PP
 393 If
 394 .I /proc/net/wireless
 395 exists,
 396 .I iwconfig
 397 will also display its content :
 398 .TP
 399 .B Link quality
 400 Quality of the link or the modulation (what is the level of contention
 401 or interference, or how good the received signal is).
 402 .TP
 403 .B Signal level
 404 Received signal strength (how strong the received signal is).
 405 .TP
 406 .B Noise level
 407 Background noise level (when no packet is transmited).
 408 .TP
 409 .B invalid nwid
 410 Number of packets received with a different NWID. Used to detect
 411 configuration problems or adjacent network existence.
 412 .TP
 413 .B invalid crypt
 414 Number of packets that the hardware was unable to decrypt.
 415 .TP
 416 .B invalid misc
 417 Other packets lost in relation with specific wireless operations.
 418 .\"
 419 .\" AUTHOR part
 420 .\"
 421 .SH AUTHOR
 422 Jean Tourrilhes \- jt@hpl.hp.com
 423 .\"
 424 .\" FILES part
 425 .\"
 426 .SH FILES
 427 .I /proc/net/wireless
 428 .\"
 429 .\" SEE ALSO part
 430 .\"
 431 .SH SEE ALSO
 432 .BR ifconfig (8),
 433 .BR iwspy (8),
 434 .BR iwlist (8),
 435 .BR iwpriv (8),
 436 .BR wavelan (4),
 437 .BR wavelan_cs (4),
 438 .BR wvlan_cs (4),
 439 .BR netwave_cs (4).