OSDN Git Service

814861f8859b43a2595e77115d4a1f8ca18f4fb9
[android-x86/external-wireless-tools.git] / 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 Register to the Access Point given by the address, if it is
139 possible. When the quality of the connection goes too low, the driver
140 may revert back to automatic mode.
141 .br
142 .B Example :
143 .br
144 .I "    iwconfig eth0 ap 00:60:1D:01:23:45"
145 .TP
146 .BR nick [name]
147 Set the nickname, or the station name. Most 802.11 products do define
148 it, but this is not used as far as the protocols (MAC, IP, TCP) are
149 concerned and completely accessory as far as configuration goes. In
150 fact only some diagnostic tools may use it.
151 .br
152 .B Example :
153 .br
154 .I "    iwconfig eth0 nickname ""My Linux Node""
155 .TP
156 .BR rate / bit [rate]
157 For cards supporting multiple bit rates, set the bit-rate in b/s. The
158 bit-rate is the speed at which bits are transmitted over the medium,
159 the user speed of the link is lower due to medium sharing and
160 overhead.
161 .br
162 You must append the suffix k, M or G to the value (decimal multiplier
163 : 10^3, 10^6 and 10^9 b/s), or add enough '0'. Values below 1000 are
164 card specific, usually an index in the bit-rate list. Use
165 .I auto
166 to select the automatic bit-rate mode (fallback to lower rate on noisy
167 channels), which is the default for most cards, and
168 .I fixed
169 to revert back to fixed setting. If you specify a bit-rate value and append
170 .IR auto ,
171 the driver will use all bit lower and equal than this value.
172 .br
173 .B Examples :
174 .br
175 .I "    iwconfig eth0 rate 11M"
176 .br
177 .I "    iwconfig eth0 rate auto"
178 .TP
179 .BR rts [_threshold]
180 RTS/CTS adds a handshake before each packet transmission to make sure
181 that the channel is clear. This adds overhead, but increase
182 performance in case of hidden nodes or large number of active
183 nodes. This parameters set the size of the smallest packet for which
184 the node sends RTS, a value equal to the maximum packet size disable
185 the scheme. You may also set this parameter to
186 .IR auto ", " fixed " or " off .
187 .br
188 .B Examples :
189 .br
190 .I "    iwconfig eth0 rts 250"
191 .br
192 .I "    iwconfig eth0 rts off"
193 .TP
194 .BR frag [mentation_threshold]
195 Fragmentation allow to split a IP packet in a burst of smaller
196 fragments transmitted on the medium. In most cases this adds overhead,
197 but in very noisy environment this reduce the error penalty. This
198 parameter set the maximum fragment size, a value equal to the maximum
199 packet size disable the scheme. You may also set this parameter to
200 .IR auto ", " fixed " or " off .
201 .br
202 .B Examples :
203 .br
204 .I "    iwconfig eth0 frag 512"
205 .br
206 .I "    iwconfig eth0 frag off"
207 .TP
208 .BR key / enc [ryption]
209 Used to manipulate encryption or scrambling keys and encryption mode.
210 .br
211 To set the current encryption key, just enter the key in hex digits as
212 .IR XXXX-XXXX-XXXX-XXXX " or " XXXXXXXX .
213 To set a key other than the current key, append
214 .I [index]
215 to the key itself. You can also enter the key as an ASCII string by
216 using the
217 .I s:
218 prefix.
219 .br
220 To change which key is the current active key, just enter
221 .I [index]
222 (without entering any key value).
223 .br
224 .IR off " and " on
225 disable and reenable encryption,
226 .I open
227 set the system in open mode (accept non-encrypted packets) and
228 .I restricted
229 discard non-encrypted packets.
230 .br
231 .B Examples :
232 .br
233 .I "    iwconfig eth0 key 0123-4567-89"
234 .br
235 .I "    iwconfig eth0 key s:password [2]"
236 .br
237 .I "    iwconfig eth0 key [2] open"
238 .br
239 .I "    iwconfig eth0 key off"
240 .TP
241 .BR power
242 Used to manipulate power management scheme parameters and mode.
243 .br
244 To set the period between wake up, enter
245 .IR "period `value'" .
246 To set the timeout before going back to sleep, enter
247 .IR "timeout `value'" .
248 You can also add the
249 .IR min " and " max
250 modifiers. By defaults, those values are in seconds, append the
251 suffix m or u to specify values un milliseconds or
252 microseconds. Sometimes, those values are without units (number of
253 dwell or the like).
254 .br
255 .IR off " and " on
256 disable and reenable power management. Finally, you may set the power
257 management mode to
258 .I all
259 (receive all packets),
260 .I unicast
261 (receive unicast packets only, discard multicast and broadcast) and
262 .I multicast
263 (receive multicast and broadcast only, discard unicast packets).
264 .br
265 .B Examples :
266 .br
267 .I "    iwconfig eth0 power period 2"
268 .br
269 .I "    iwconfig eth0 power 500m unicast"
270 .br
271 .I "    iwconfig eth0 power timeout 300u all"
272 .br
273 .I "    iwconfig eth0 power off"
274 .br
275 .I "    iwconfig eth0 power min period 2 power max period 4"
276 .TP
277 .BR txpower
278 For cards supporting multiple transmit powers, set the transmit power in dBm. If 
279 .I W
280 is the power in Watt, the power in dBm is
281 .IR "P = 30 + 10.log(W)" .
282 If the value is postfixed by
283 .IR mW ,
284 it will be automatically converted to dBm.
285 .br
286 In addition, 
287 .IR on " and " off
288 enable and disable the radio, and
289 .IR auto " and " fixed
290 enable and disable power control (if those features are available).
291 .br
292 .B Examples :
293 .br
294 .I "    iwconfig eth0 txpower 15"
295 .br
296 .I "    iwconfig eth0 txpower 30mW"
297 .br
298 .I "    iwconfig eth0 txpower auto"
299 .br
300 .I "    iwconfig eth0 txpower off"
301 .TP
302 .BR retry
303 Most cards have MAC retransmissions, and some allow to set the
304 behaviour of the retry mechanism.
305 .br
306 To set the maximum number of retries, enter
307 .IR "limit `value'" .
308 This is an absolute value (without unit).
309 The set the maximum length of time the MAC should retry, enter
310 .IR "lifetime `value'" .
311 By defaults, this value in in seconds, append the suffix m or u to
312 specify values un milliseconds or microseconds.
313 .br
314 You can also add the
315 .IR min " and " max
316 modifiers. If the card support automatic mode, they define the bounds
317 of the limit or lifetime. Some other cards define different values
318 depending on packet size, for example in 802.11
319 .I min limit
320 is the short retry limit (non RTS/CTS packets).
321 .br
322 .B Examples :
323 .br
324 .I "    iwconfig eth0 retry 16"
325 .br
326 .I "    iwconfig eth0 retry lifetime 300m"
327 .br
328 .I "    iwconfig eth0 retry min limit 8"
329 .TP
330 .BR commit
331 Some cards may not apply changes done through Wireless Extensions
332 immediately (they may wait to agregate the changes or apply it only
333 when the card is brought up). This command (when available) force
334 the card to apply all pending changes.
335 .br
336 This is normally not needed, because the card will eventually apply
337 the changes, but can be usefull for debugging.
338 .\"
339 .\" DISPLAY part
340 .\"
341 .SH DISPLAY
342 For each device which support wireless extensions,
343 .I iwconfig
344 will display the name of the
345 .B MAC protocol
346 used (name of device for proprietary protocols), the
347 .B ESSID
348 (Network Name), the
349 .BR NWID ,
350 the
351 .B frequency
352 (or channel), the
353 .BR sensitivity ,
354 the
355 .B mode
356 of operation, the
357 .B Access Point
358 address, the
359 .B bit-rate
360 the
361 .BR "RTS threshold" ", the " "fragmentation threshold" ,
362 the
363 .B encryption key
364 and the
365 .B power management
366 settings (depending on availability).
367 .br
368 See above for explanations of what these parameters mean.
369 .br
370 If the label for bitrate is followed by
371 .RB ` = ',
372 it means that the parameter is fixed and forced to that value, if it
373 is followed by
374 .RB ` : '
375 it is only the current value (device in normal auto mode).
376 .PP
377 If
378 .I /proc/net/wireless
379 exists,
380 .I iwconfig
381 will also display its content :
382 .TP
383 .B Link quality
384 Quality of the link or the modulation (what is the level of contention
385 or interference, or how good the received signal is).
386 .TP
387 .B Signal level
388 Received signal strength (how strong the received signal is).
389 .TP
390 .B Noise level
391 Background noise level (when no packet is transmited).
392 .TP
393 .B invalid nwid
394 Number of packets received with a different NWID. Used to detect
395 configuration problems or adjacent network existence.
396 .TP
397 .B invalid crypt
398 Number of packets that the hardware was unable to decrypt.
399 .TP
400 .B invalid misc
401 Other packets lost in relation with specific wireless operations.
402 .\"
403 .\" AUTHOR part
404 .\"
405 .SH AUTHOR
406 Jean Tourrilhes \- jt@hpl.hp.com
407 .\"
408 .\" FILES part
409 .\"
410 .SH FILES
411 .I /proc/net/wireless
412 .\"
413 .\" SEE ALSO part
414 .\"
415 .SH SEE ALSO
416 .BR ifconfig (8),
417 .BR iwspy (8),
418 .BR iwlist (8),
419 .BR iwpriv (8),
420 .BR wavelan (4),
421 .BR wavelan_cs (4),
422 .BR wvlan_cs (4),
423 .BR netwave_cs (4).