usr.sbin/wiconfig/wiconfig.8

   1 .\"     $NetBSD: wiconfig.8,v 1.31 2009/07/02 17:45:26 dyoung Exp $
   2 .\"
   3 .\" Copyright (c) 1997, 1998, 1999
   4 .\"     Bill Paul <wpaul@ctr.columbia.edu> All rights reserved.
   5 .\"
   6 .\" Redistribution and use in source and binary forms, with or without
   7 .\" modification, are permitted provided that the following conditions
   8 .\" are met:
   9 .\" 1. Redistributions of source code must retain the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer.
  11 .\" 2. Redistributions in binary form must reproduce the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer in the
  13 .\"    documentation and/or other materials provided with the distribution.
  14 .\" 3. All advertising materials mentioning features or use of this software
  15 .\"    must display the following acknowledgement:
  16 .\"     This product includes software developed by Bill Paul.
  17 .\" 4. Neither the name of the author nor the names of any co-contributors
  18 .\"    may be used to endorse or promote products derived from this software
  19 .\"    without specific prior written permission.
  20 .\"
  21 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  22 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  23 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  24 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  25 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  26 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  27 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  28 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  29 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  30 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  31 .\" THE POSSIBILITY OF SUCH DAMAGE.
  32 .\"
  33 .\"     From: wicontrol.8,v 1.6 1999/05/22 16:12:47 wpaul Exp $
  34 .\"
  35 .Dd July 2, 2009
  36 .Dt WICONFIG 8
  37 .Os
  38 .Sh NAME
  39 .Nm wiconfig
  40 .Nd configure WaveLAN/IEEE devices
  41 .Sh SYNOPSIS
  42 .Nm wiconfig
  43 .Ar interface
  44 .Op Fl \&Dho
  45 .Op Fl A Ar 1|2
  46 .Op Fl a Ar access_point_density
  47 .Op Fl d Ar max_data_length
  48 .Op Fl M Ar 0|1
  49 .Op Fl R Ar 1|3
  50 .Op Fl s Ar station_name
  51 .Sh DESCRIPTION
  52 The
  53 .Nm
  54 command controls the operation of
  55 .Tn WaveLAN/IEEE
  56 wireless networking devices via the
  57 .Xr wi 4
  58 and
  59 .Xr awi 4
  60 drivers.
  61 The
  62 .Nm
  63 command can also be used to view the current settings of these parameters
  64 and to dump out the values of the card's statistics counters.
  65 .Pp
  66 Most of the parameters that can be changed relate to the
  67 .Tn IEEE
  68 802.11 protocol which the
  69 .Tn WaveLAN
  70 implements.
  71 This includes the station name, whether the station is operating
  72 in ad-hoc (point to point) or BSS (service set) mode, and the
  73 network name of a service set to join (IBSS) if BSS mode is enabled.
  74 .Pp
  75 The
  76 .Ar interface
  77 argument given to
  78 .Nm
  79 should be the logical interface name associated with the
  80 .Tn WaveLAN/IEEE
  81 device (e.g., wi0, wi1, etc.).
  82 .Sh OPTIONS
  83 With no extra options,
  84 .Nm
  85 will display the current settings of the specified
  86 .Tn WaveLAN/IEEE
  87 interface.
  88 .Pp
  89 The options are as follows:
  90 .Pp
  91 .Bl -tag -width Fl
  92 .It Fl A Ar 1|2
  93 Set the authentication type for a specified interface.
  94 Permitted values are
  95 .Ar 1
  96 (Open System Authentication) or
  97 .Ar 2
  98 (Shared Key Authentication).
  99 The default is 1.
 100 .It Fl a Ar access_point_density
 101 Specify the
 102 .Ar access point density
 103 for a given interface.
 104 Legal values are 1 (low), 2 (medium), and 3 (high).
 105 This setting influences some of the radio modem threshold settings.
 106 .It Fl D
 107 This forces the driver to initiate one round of access point scanning.
 108 All of the access points found are displayed.
 109 .It Fl d Ar max_data_length
 110 Set the maximum receive and transmit frame size for a specified interface.
 111 The
 112 .Ar max data length
 113 can be any number from 256 to 2346.
 114 The default is 2304.
 115 .It Fl h
 116 Display a short help.
 117 .It Fl M Ar 0|1
 118 Enable or disable
 119 .Qq microwave oven robustness
 120 on a given interface.
 121 This should only be used if needed.
 122 .Pp
 123 In cases of slow performance where there is a good quality signal but
 124 also high levels of noise (i.e., the signal to noise ratio is bad but
 125 the signal strength is good), or a microwave oven is operating near the
 126 antenna of the WLAN peer or access point, this option may be of use.
 127 .Pp
 128 In bad signal-to-noise conditions, the link layer will switch to lower
 129 transmit rates.
 130 However at lower transmit rates, individual frames
 131 take longer to transmit, making them more vulnerable to bursty
 132 noise.
 133 The option works by enabling data fragmentation in the link
 134 layer as the transmit speed lowers in an attempt to shorten the
 135 transmit time of each frame so that individual frames are more likely
 136 to be transmitted without error.
 137 .Pp
 138 Note that this does not impact the visible MTU of the link.
 139 .It Fl o
 140 Print out the statistics counters instead of the card settings.
 141 Note that, however, the statistics will only be updated every minute or so.
 142 .It Fl R Ar 1|3
 143 Enable or disable roaming function on a given interface.
 144 The legal values are
 145 .Ar 1
 146 (Roaming handled by firmware) and
 147 .Ar 3
 148 (Roaming Disabled).
 149 The default is 1.
 150 .It Fl r Ar RTS_threshold
 151 .It Fl f Ar fragmentation_threshold
 152 .It Fl m Ar MAC_address
 153 These options are deprecated since
 154 .Nx 6.0 .
 155 Use
 156 .Xr ifconfig 8
 157 to set the link-layer address, the fragmentation threshold, and the RTS
 158 threshold.
 159 .It Fl s Ar station_name
 160 Sets the
 161 .Ar station_name
 162 for the specified interface.
 163 The
 164 .Ar station_name
 165 is used for diagnostic purposes.
 166 The
 167 .Tn Lucent
 168 .Tn WaveMANAGER
 169 software can poll the names of remote hosts.
 170 .El
 171 .Sh SEE ALSO
 172 .Xr awi 4 ,
 173 .Xr wi 4 ,
 174 .Xr ifconfig 8
 175 .Sh HISTORY
 176 The
 177 .Nm
 178 command first appeared in
 179 .Fx 3.0 ,
 180 as
 181 .Ic wicontrol .
 182 It was added to
 183 .Nx 1.5
 184 under its present name.
 185 .Sh AUTHORS
 186 The
 187 .Nm
 188 command was written by
 189 .An Bill Paul Aq wpaul@ctr.columbia.edu .