OSDN Git Service

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