Debian Codegraph @

upstream/debian-unstable/man8/iwconfig.8

raw
1 .\" Jean II - HPLB - 1996 => HPL - 2004
2 .\" iwconfig.8
3 .\"
4 .TH IWCONFIG 8 "30 March 2006" "wireless-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 "] [mode " M "] [freq " F "]
17 .br
18 .BI " [channel " C ] [sens " S "] [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 " [modu " M "] [commit]
25 .br
26 .BI "iwconfig --help"
27 .br
28 .BI "iwconfig --version"
29 .\"
30 .\" DESCRIPTION part
31 .\"
32 .SH DESCRIPTION
33 .B Iwconfig
34 is similar to
35 .IR ifconfig (8),
36 but is dedicated to the wireless interfaces. It is used to set the
37 parameters of the network interface which are specific to the wireless
38 operation (for example : the frequency).
39 .B Iwconfig
40 may also be used to display those parameters, and the wireless
41 statistics (extracted from
42 .IR /proc/net/wireless ).
43 .PP
44 All these parameters and statistics are device dependent. Each driver
45 will provide only some of them depending on hardware support, and the
46 range of values may change. Please refer to the man page of each
47 device for details.
48 .\"
49 .\" PARAMETER part
50 .\"
51 .SH PARAMETERS
52 .TP
53 .B essid
54 Set the ESSID (or Network Name - in some products it may also be
55 called Domain ID). The ESSID is used to identify cells which are part
56 of the same virtual network.
57 .br
58 As opposed to the AP Address or NWID which define a single cell, the
59 ESSID defines a group of cells connected via repeaters or
60 infrastructure, where the user may roam transparently.
61 .br
62 With some cards, you may disable the ESSID checking (ESSID
63 promiscuous) with
64 .IR off " or " any " (and " on
65 to reenable it).
66 .br
67 If the ESSID of your network is one of the special keywords
68 .RI ( off ", " on " or " any ),
69 you should use
70 .I --
71 to escape it.
72 .br
73 .B Examples :
74 .br
75 .I " iwconfig eth0 essid any"
76 .br
77 .I " iwconfig eth0 essid ""My Network""
78 .br
79 .I " iwconfig eth0 essid -- ""ANY""
80 .TP
81 .BR nwid
82 Set the Network ID. As all adjacent wireless networks share the same
83 medium, this parameter is used to differentiate them (create logical
84 colocated networks) and identify nodes belonging to the same cell.
85 .br
86 This parameter is only used for pre-802.11 hardware, the 802.11
87 protocol uses the ESSID and AP Address for this function.
88 .br
89 With some cards, you may disable the Network ID checking (NWID
90 promiscuous) with
91 .IR off " (and " on
92 to reenable it).
93 .br
94 .B Examples :
95 .br
96 .I " iwconfig eth0 nwid AB34
97 .br
98 .I " iwconfig eth0 nwid off"
99 .TP
100 .BR nick [name]
101 Set the nickname, or the station name. Some 802.11 products do define
102 it, but this is not used as far as the protocols (MAC, IP, TCP) are
103 concerned and completely useless as far as configuration goes. Only
104 some wireless diagnostic tools may use it.
105 .br
106 .B Example :
107 .br
108 .I " iwconfig eth0 nickname ""My Linux Node""
109 .TP
110 .B mode
111 Set the operating mode of the device, which depends on the network
112 topology. The mode can be
113 .I Ad-Hoc
114 (network composed of only one cell and without Access Point),
115 .I Managed
116 (node connects to a network composed of many Access Points, with roaming),
117 .I Master
118 (the node is the synchronisation master or acts as an Access Point),
119 .I Repeater
120 (the node forwards packets between other wireless nodes),
121 .I Secondary
122 (the node acts as a backup master/repeater),
123 .I Monitor
124 (the node is not associated with any cell and passively monitor all
125 packets on the frequency) or
126 .IR Auto .
127 .br
128 .B Example :
129 .br
130 .I " iwconfig eth0 mode Managed"
131 .br
132 .I " iwconfig eth0 mode Ad-Hoc"
133 .TP
134 .BR freq / channel
135 Set the operating frequency or channel in the device. A value below
136 1000 indicates a channel number, a value greater than 1000 is a
137 frequency in Hz. You may append the suffix k, M or G to the value (for
138 example, "2.46G" for 2.46 GHz frequency), or add enough '0'.
139 .br
140 Channels are usually numbered starting at 1, and you may use
141 .IR iwlist (8)
142 to get the total number of channels, list the available frequencies,
143 and display the current frequency as a channel. Depending on
144 regulations, some frequencies/channels may not be available.
145 .br
146 When using Managed mode, most often the Access Point dictates the
147 channel and the driver may refuse the setting of the frequency. In
148 Ad-Hoc mode, the frequency setting may only be used at initial cell
149 creation, and may be ignored when joining an existing cell.
150 .br
151 You may also use
152 .I off
153 or
154 .I auto
155 to let the card pick up the best channel (when supported).
156 .br
157 .B Examples :
158 .br
159 .I " iwconfig eth0 freq 2422000000"
160 .br
161 .I " iwconfig eth0 freq 2.422G"
162 .br
163 .I " iwconfig eth0 channel 3"
164 .br
165 .I " iwconfig eth0 channel auto"
166 .TP
167 .B ap
168 Force the card to register to the Access Point given by the address,
169 if it is possible. This address is the cell identity of the Access
170 Point, as reported by wireless scanning, which may be different from
171 its network MAC address. If the wireless link is point to point, set
172 the address of the other end of the link. If the link is ad-hoc, set
173 the cell identity of the ad-hoc network.
174 .br
175 When the quality of the connection goes too low, the driver may revert
176 back to automatic mode (the card selects the best Access Point in
177 range).
178 .br
179 You may also use
180 .I off
181 to re-enable automatic mode without changing the current Access Point,
182 or you may use
183 .I any
184 or
185 .I auto
186 to force the card to reassociate with the currently best Access Point.
187 .br
188 .B Example :
189 .br
190 .I " iwconfig eth0 ap 00:60:1D:01:23:45"
191 .br
192 .I " iwconfig eth0 ap any"
193 .br
194 .I " iwconfig eth0 ap off"
195 .TP
196 .BR rate / bit [rate]
197 For cards supporting multiple bit rates, set the bit-rate in b/s. The
198 bit-rate is the speed at which bits are transmitted over the medium,
199 the user speed of the link is lower due to medium sharing and
200 various overhead.
201 .br
202 You may append the suffix k, M or G to the value (decimal multiplier :
203 10^3, 10^6 and 10^9 b/s), or add enough '0'. Values below 1000 are
204 card specific, usually an index in the bit-rate list. Use
205 .I auto
206 to select automatic bit-rate mode (fallback to lower rate on noisy
207 channels), which is the default for most cards, and
208 .I fixed
209 to revert back to fixed setting. If you specify a bit-rate value and append
210 .IR auto ,
211 the driver will use all bit-rates lower and equal than this value.
212 .br
213 .B Examples :
214 .br
215 .I " iwconfig eth0 rate 11M"
216 .br
217 .I " iwconfig eth0 rate auto"
218 .br
219 .I " iwconfig eth0 rate 5.5M auto"
220 .TP
221 .BR txpower
222 For cards supporting multiple transmit powers, sets the transmit power
223 in dBm. If
224 .I W
225 is the power in Watt, the power in dBm is
226 .IR "P = 30 + 10.log(W)" ,
227 where log is decimal log.
228 If the value is postfixed by
229 .IR mW ,
230 it will be automatically converted to dBm.
231 .br
232 In addition,
233 .IR on " and " off
234 enable and disable the radio, and
235 .IR auto " and " fixed
236 enable and disable power control (if those features are available).
237 .br
238 .B Examples :
239 .br
240 .I " iwconfig eth0 txpower 15"
241 .br
242 .I " iwconfig eth0 txpower 30mW"
243 .br
244 .I " iwconfig eth0 txpower auto"
245 .br
246 .I " iwconfig eth0 txpower off"
247 .TP
248 .B sens
249 Set the sensitivity threshold. This define how sensitive is the card
250 to poor operating conditions (low signal, interference). Positive
251 values are assumed to be the raw value used by the hardware or a
252 percentage, negative values are assumed to be dBm. Depending on the
253 hardware implementation, this parameter may control various functions.
254 .br
255 On modern cards, this parameter usually control handover/roaming
256 threshold, the lowest signal level for which the hardware remains
257 associated with the current Access Point. When the signal level goes
258 below this threshold the card starts looking for a new/better Access
259 Point. Some cards may use the number of missed beacons to trigger
260 this. For high density of Access Points, a higher threshold make sure
261 the card is always associated with the best AP, for low density of
262 APs, a lower threshold minimise the number of failed handoffs.
263 .br
264 On more ancient card this parameter usually controls the defer
265 threshold, the lowest signal level for which the hardware considers
266 the channel busy. Signal levels above this threshold make the hardware
267 inhibits its own transmission whereas signals weaker than this are
268 ignored and the hardware is free to transmit. This is usually strongly
269 linked to the receive threshold, the lowest signal level for which the
270 hardware attempts packet reception. Proper setting of these thresholds
271 prevent the card to waste time on background noise while still
272 receiving weak transmissions. Modern designs seems to control those
273 thresholds automatically.
274 .br
275 .br
276 .B Example :
277 .br
278 .I " iwconfig eth0 sens -80"
279 .br
280 .I " iwconfig eth0 sens 2"
281 .TP
282 .BR retry
283 Most cards have MAC retransmissions, and some allow to set the
284 behaviour of the retry mechanism.
285 .br
286 To set the maximum number of retries, enter
287 .IR "limit `value'" .
288 This is an absolute value (without unit), and the default (when
289 nothing is specified).
290 To set the maximum length of time the MAC should retry, enter
291 .IR "lifetime `value'" .
292 By defaults, this value is in seconds, append the suffix m or u to
293 specify values in milliseconds or microseconds.
294 .br
295 You can also add the
296 .IR short ", " long ", " min " and " max
297 modifiers. If the card supports automatic mode, they define the bounds
298 of the limit or lifetime. Some other cards define different values
299 depending on packet size, for example in 802.11
300 .I min limit
301 is the short retry limit (non RTS/CTS packets).
302 .br
303 .B Examples :
304 .br
305 .I " iwconfig eth0 retry 16"
306 .br
307 .I " iwconfig eth0 retry lifetime 300m"
308 .br
309 .I " iwconfig eth0 retry short 12"
310 .br
311 .I " iwconfig eth0 retry min limit 8"
312 .TP
313 .BR rts [_threshold]
314 RTS/CTS adds a handshake before each packet transmission to make sure
315 that the channel is clear. This adds overhead, but increases
316 performance in case of hidden nodes or a large number of active
317 nodes. This parameter sets the size of the smallest packet for which
318 the node sends RTS ; a value equal to the maximum packet size disables
319 the mechanism. You may also set this parameter to
320 .IR auto ", " fixed " or " off .
321 .br
322 .B Examples :
323 .br
324 .I " iwconfig eth0 rts 250"
325 .br
326 .I " iwconfig eth0 rts off"
327 .TP
328 .BR frag [mentation_threshold]
329 Fragmentation allows to split an IP packet in a burst of smaller
330 fragments transmitted on the medium. In most cases this adds overhead,
331 but in a very noisy environment this reduces the error penalty and
332 allow packets to get through interference bursts. This parameter sets
333 the maximum fragment size which is always lower than the maximum
334 packet size.
335 .br
336 This parameter may also control Frame Bursting available on some
337 cards, the ability to send multiple IP packets together. This
338 mechanism would be enabled if the fragment size is larger than the
339 maximum packet size.
340 .br
341 You may also set this parameter to
342 .IR auto ", " fixed " or " off .
343 .br
344 .B Examples :
345 .br
346 .I " iwconfig eth0 frag 512"
347 .br
348 .I " iwconfig eth0 frag off"
349 .TP
350 .BR key / enc [ryption]
351 Used to manipulate encryption or scrambling keys and security mode.
352 .br
353 To set the current encryption key, just enter the key in hex digits as
354 .IR XXXX-XXXX-XXXX-XXXX " or " XXXXXXXX .
355 To set a key other than the current key, prepend or append
356 .I [index]
357 to the key itself (this won't change which is the active key). You can
358 also enter the key as an ASCII string by using the
359 .I s:
360 prefix. Passphrase is currently not supported.
361 .br
362 To change which key is the currently active key, just enter
363 .I [index]
364 (without entering any key value).
365 .br
366 .IR off " and " on
367 disable and reenable encryption.
368 .br
369 The security mode may be
370 .I open
371 or
372 .IR restricted ,
373 and its meaning depends on the card used. With most cards, in
374 .I open
375 mode no authentication is used and the card may also accept
376 non-encrypted sessions, whereas in
377 .I restricted
378 mode only encrypted sessions are accepted and the card will use
379 authentication if available.
380 .br
381 If you need to set multiple keys, or set a key and change the active
382 key, you need to use multiple
383 .B key
384 directives. Arguments can be put in any order, the last one will take
385 precedence.
386 .br
387 .B Examples :
388 .br
389 .I " iwconfig eth0 key 0123-4567-89"
390 .br
391 .I " iwconfig eth0 key [3] 0123-4567-89"
392 .br
393 .I " iwconfig eth0 key s:password [2]"
394 .br
395 .I " iwconfig eth0 key [2]"
396 .br
397 .I " iwconfig eth0 key open"
398 .br
399 .I " iwconfig eth0 key off"
400 .br
401 .I " iwconfig eth0 key restricted [3] 0123456789"
402 .br
403 .I " iwconfig eth0 key 01-23 key 45-67 [4] key [4]"
404 .TP
405 .BR power
406 Used to manipulate power management scheme parameters and mode.
407 .br
408 To set the period between wake ups, enter
409 .IR "period `value'" .
410 To set the timeout before going back to sleep, enter
411 .IR "timeout `value'" .
412 To set the generic level of power saving, enter
413 .IR "saving `value'" .
414 You can also add the
415 .IR min " and " max
416 modifiers. By default, those values are in seconds, append the suffix
417 m or u to specify values in milliseconds or microseconds. Sometimes,
418 those values are without units (number of beacon periods, dwell,
419 percentage or similar).
420 .br
421 .IR off " and " on
422 disable and reenable power management. Finally, you may set the power
423 management mode to
424 .I all
425 (receive all packets),
426 .I unicast
427 (receive unicast packets only, discard multicast and broadcast) and
428 .I multicast
429 (receive multicast and broadcast only, discard unicast packets).
430 .br
431 .B Examples :
432 .br
433 .I " iwconfig eth0 power period 2"
434 .br
435 .I " iwconfig eth0 power 500m unicast"
436 .br
437 .I " iwconfig eth0 power timeout 300u all"
438 .br
439 .I " iwconfig eth0 power saving 3"
440 .br
441 .I " iwconfig eth0 power off"
442 .br
443 .I " iwconfig eth0 power min period 2 power max period 4"
444 .TP
445 .BR modu [lation]
446 Force the card to use a specific set of modulations. Modern cards
447 support various modulations, some which are standard, such as 802.11b
448 or 802.11g, and some proprietary. This command force the card to only
449 use the specific set of modulations listed on the command line. This
450 can be used to fix interoperability issues.
451 .br
452 The list of available modulations depend on the card/driver and can be
453 displayed using
454 .IR "iwlist modulation" .
455 Note that some card/driver may not be able to select each modulation
456 listed independently, some may come as a group. You may also set this
457 parameter to
458 .IR auto
459 let the card/driver do its best.
460 .br
461 .B Examples :
462 .br
463 .I " iwconfig eth0 modu 11g"
464 .br
465 .I " iwconfig eth0 modu CCK OFDMa"
466 .br
467 .I " iwconfig eth0 modu auto"
468 .TP
469 .BR commit
470 Some cards may not apply changes done through Wireless Extensions
471 immediately (they may wait to aggregate the changes or apply it only
472 when the card is brought up via
473 .IR ifconfig ).
474 This command (when available) forces the card to apply all pending
475 changes.
476 .br
477 This is normally not needed, because the card will eventually apply
478 the changes, but can be useful for debugging.
479 .\"
480 .\" DISPLAY part
481 .\"
482 .SH DISPLAY
483 For each device which supports wireless extensions,
484 .I iwconfig
485 will display the name of the
486 .B MAC protocol
487 used (name of device for proprietary protocols), the
488 .B ESSID
489 (Network Name), the
490 .BR NWID ,
491 the
492 .B frequency
493 (or channel), the
494 .BR sensitivity ,
495 the
496 .B mode
497 of operation, the
498 .B Access Point
499 address, the
500 .BR bit-rate ,
501 the
502 .BR "RTS threshold" ", the " "fragmentation threshold" ,
503 the
504 .B encryption key
505 and the
506 .B power management
507 settings (depending on availability).
508 .PP
509 The parameters displayed have the same meaning and values as the
510 parameters you can set, please refer to the previous part for a
511 detailed explanation of them.
512 .br
513 Some parameters are only displayed in short/abbreviated form (such as
514 encryption). You may use
515 .IR iwlist (8)
516 to get all the details.
517 .br
518 Some parameters have two modes (such as bitrate). If the value is
519 prefixed by
520 .RB ` = ',
521 it means that the parameter is fixed and forced to that value, if it
522 is prefixed by
523 .RB ` : ',
524 the parameter is in automatic mode and the current value is shown (and
525 may change).
526 .TP
527 .BR "Access Point" / Cell
528 An address equal to 00:00:00:00:00:00 means that the card failed to
529 associate with an Access Point (most likely a configuration
530 issue). The
531 .B Access Point
532 parameter will be shown as
533 .B Cell
534 in ad-hoc mode (for obvious reasons), but otherwise works the same.
535 .PP
536 If
537 .I /proc/net/wireless
538 exists,
539 .I iwconfig
540 will also display its content. Note that those values will depend on
541 the driver and the hardware specifics, so you need to refer to your
542 driver documentation for proper interpretation of those values.
543 .TP
544 .B Link quality
545 Overall quality of the link. May be based on the level of contention
546 or interference, the bit or frame error rate, how good the received
547 signal is, some timing synchronisation, or other hardware metric. This
548 is an aggregate value, and depends totally on the driver and hardware.
549 .TP
550 .B Signal level
551 Received signal strength (RSSI - how strong the received signal
552 is). May be arbitrary units or dBm,
553 .I iwconfig
554 uses driver meta information to interpret the raw value given by
555 .I /proc/net/wireless
556 and display the proper unit or maximum value (using 8 bit arithmetic). In
557 .I Ad-Hoc
558 mode, this may be undefined and you should use
559 .IR iwspy .
560 .TP
561 .B Noise level
562 Background noise level (when no packet is transmitted). Similar
563 comments as for
564 .BR "Signal level" .
565 .TP
566 .B Rx invalid nwid
567 Number of packets received with a different NWID or ESSID. Used to
568 detect configuration problems or adjacent network existence (on the
569 same frequency).
570 .TP
571 .B Rx invalid crypt
572 Number of packets that the hardware was unable to decrypt. This can be
573 used to detect invalid encryption settings.
574 .TP
575 .B Rx invalid frag
576 Number of packets for which the hardware was not able to properly
577 re-assemble the link layer fragments (most likely one was missing).
578 .TP
579 .B Tx excessive retries
580 Number of packets that the hardware failed to deliver. Most MAC
581 protocols will retry the packet a number of times before giving up.
582 .TP
583 .B Invalid misc
584 Other packets lost in relation with specific wireless operations.
585 .TP
586 .B Missed beacon
587 Number of periodic beacons from the Cell or the Access Point we have
588 missed. Beacons are sent at regular intervals to maintain the cell
589 coordination, failure to receive them usually indicates that the card
590 is out of range.
591 .\"
592 .\" AUTHOR part
593 .\"
594 .SH AUTHOR
595 Jean Tourrilhes \- [email protected]
596 .\"
597 .\" FILES part
598 .\"
599 .SH FILES
600 .I /proc/net/wireless
601 .\"
602 .\" SEE ALSO part
603 .\"
604 .SH SEE ALSO
605 .BR ifconfig (8),
606 .BR iwspy (8),
607 .BR iwlist (8),
608 .BR iwevent (8),
609 .BR iwpriv (8),
610 .BR wireless (7)
611 .BR ifrename (8),
612 .BR iftab (5),
613 .BR iwgetid (8).