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 "] [enc " E "] [ap " A "] [nick " NN ]
  19 .br
  20 .BI "                   [rate " R "] [rts " RT "] [frag " FT ]
  21 .\"
  22 .\" DESCRIPTION part
  23 .\"
  24 .SH DESCRIPTION
  25 .B Iwconfig
  26 is similar to
  27 .IR ifconfig (8),
  28 but is dedicated to the wireless interfaces. It is used to set the
  29 parameters of the network interface which are specific to the wireless
  30 operation (for example : the frequency).
  31 .B Iwconfig
  32 may also be used to display those parameters, and the wireless
  33 statistics (extracted from
  34 .IR /proc/net/wireless ).
  35 .PP
  36 All these parameters and statistics are device dependant. Each driver
  37 will provide only some of them depending on the hardware support, and
  38 the range of value may change. Please refer to the man page of each
  39 device for details.
  40 .\"
  41 .\" PARAMETER part
  42 .\"
  43 .SH PARAMETERS
  44 .TP
  45 .B essid
  46 Set the ESSID (or Network Name - in some products it may also called
  47 Domain ID). The ESSID is used to identify cells which are part of the
  48 same virtual network.
  49 .br
  50 As opposed to the NWID which defines a single cell, the ESSID defines
  51 a group of cell connected via repeaters or infrastructure, where the
  52 user may roam.  With some card, you may disable the ESSID checking
  53 (ESSID promiscuous) with
  54 .IR off " (and " on
  55 to reenable it).
  56 .TP
  57 .BR nwid / domain
  58 Set the Network ID (in some products it is also called Domain ID). As
  59 all adjacent wireless networks share the same medium, this parameter
  60 is used to differenciate them (create logical colocated networks) and
  61 identify nodes belonguing to the same cell. With some card, you may
  62 disable the Network ID checking (NWID promiscuous) with
  63 .IR off " (and " on
  64 to reenable it).
  65 .TP
  66 .BR freq / channel
  67 Set the operating frequency or channel in the device. Value below 1000
  68 are the channel number, value over this is the frequency in Hz. You
  69 must prepend the suffix k, M or G to the value (for example, "2.46G"
  70 for 2.46 GHz frequency), or add enough '0'.
  71 .br
  72 Channels are usually numbered starting at 1,
  73 and you may use
  74 .IR iwpriv (8)
  75 to get the total number of channels and list the available
  76 frequencies. Depending on regulations, some frequencies/channels may
  77 not be available.
  78 .TP
  79 .B sens
  80 Set the sensitivity threshold. This is the lowest signal level for
  81 which we attempt a packet reception, signal lower than this are not
  82 received. This is used to avoid receiving background noise, so you
  83 should set it according to the average noise level. Positive values
  84 are assumed to be the raw value used by the hardware or a percentage,
  85 negative values are assumed to be dBm.
  86 .br
  87 With some hardware, this parameter also control the defer threshold
  88 (lowest signal level for which we consider the channel busy) and the
  89 handover threshold (lowest signal level where we stay associated with
  90 the current access point).
  91 .TP
  92 .B enc
  93 Set the encryption or scrambing key (the syntax is
  94 .IR XXXX-XXXX-XXXX-XXXX " or " XXXXXXXX ).
  95 Used also to control the encryption feature
  96 .RI ( on / off ).
  97 .TP
  98 .B ap
  99 Register to the Access Point given by the address, if it is
 100 possible. When the quality of the connection goes too low, the driver
 101 may revert back to automatic mode.
 102 .TP
 103 .BR nick [ name ]
 104 Set the nickname, or the station name. Most 802.11 products do define
 105 it, but this is not used as far as the protocols (MAC, IP, TCP) are
 106 concerned and completely accessory as far as configuration goes. In
 107 fact only some diagnostic tools may use it.
 108 .TP
 109 .BR rate / bit [ rate ]
 110 For cards supporting multiple bit rates, set the bit-rate in b/s. The
 111 bit-rate is the speed at which bits are transmitted over the medium,
 112 the user speed of the link is lower due to medium sharing and
 113 overhead.
 114 .br
 115 You must prepend the suffix k, M or G to the value (decimal multiplier
 116 : 10^3, 10^6 and 10^9 b/s), or add enough '0'. Values below 1000 are
 117 card specific, usually an index in the bit-rate list. Use
 118 .I auto
 119 to select the automatic bit-rate mode (fallback to lower rate on noisy
 120 channels), which is the default for most cards, and
 121 .I fixed
 122 to revert back to fixed setting.
 123 .TP
 124 .BR rts [ _threshold ]
 125 RTS/CTS adds a handshake before each packet transmission to make sure
 126 that the channel is clear. This adds overhead, but increase
 127 performance in case of hidden nodes or large number of active
 128 nodes. This parameters set the size of the smallest packet for which
 129 the node sends RTS, a value equal to the maximum packet size disable
 130 the scheme. You may also set this parameter to
 131 .IR auto ", " fixed " or " off .
 132 .TP
 133 .BR frag [ mentation_threshold ]
 134 Fragmentation allow to split a IP packet in a burst of smaller
 135 fragments transmitted on the medium. In most cases this adds overhead,
 136 but in very noisy environment this reduce the error penalty. This
 137 parameter set the maximum fragment size, a value equal to the maximum
 138 packet size disable the scheme. You may also set this parameter to
 139 .IR auto ", " fixed " or " off .
 140 .\"
 141 .\" DISPLAY part
 142 .\"
 143 .SH DISPLAY
 144 For each device which support wireless extensions,
 145 .I iwconfig
 146 will display the name of the
 147 .B MAC protocol
 148 used (name of device for proprietary protocols), the
 149 .B ESSID
 150 (Network Name), the
 151 .BR NWID ,
 152 the
 153 .B frequency
 154 (or channel), the
 155 .BR sensitivity ,
 156 the
 157 .B Access Point
 158 address, the
 159 .B bit-rate
 160 (with
 161 .B (f)
 162 if fixed), the
 163 .BR "RTS threshold" ", the " "fragmentation threshold" ,
 164 and the
 165 .B encryption key
 166 (depending on availability). See above for explanations.
 167 .PP
 168 If
 169 .I /proc/net/wireless
 170 exists,
 171 .I iwconfig
 172 will also display its content :
 173 .TP
 174 .B Link quality
 175 Quality of the link or the modulation (how good the received signal is).
 176 .TP
 177 .B Signal level
 178 Received signal strength (how strong the received signal is).
 179 .TP
 180 .B Noise level
 181 Background noise level (when no packet is transmited).
 182 .TP
 183 .B invalid nwid
 184 Number of packets received with a different NWID. Used to detect
 185 configuration problems or adjacent network existence.
 186 .TP
 187 .B invalid crypt
 188 Number of packets that the hardware was unable to decrypt.
 189 .TP
 190 .B invalid misc
 191 Other packets lost in relation with specific wireless operations.
 192 .\"
 193 .\" AUTHOR part
 194 .\"
 195 .SH AUTHOR
 196 Jean Tourrilhes \- jt@hplb.hpl.hp.com
 197 .\"
 198 .\" FILES part
 199 .\"
 200 .SH FILES
 201 .I /proc/net/wireless
 202 .\"
 203 .\" SEE ALSO part
 204 .\"
 205 .SH SEE ALSO
 206 .BR ifconfig (8),
 207 .BR iwspy (8),
 208 .BR iwpriv (8),
 209 .BR wavelan (4),
 210 .BR wavelan_cs (4),
 211 .BR xircnw_cs (4).