usr.sbin/raycontrol/raycontrol.8

   1 .\"
   2 .\"Copyright (C) 2000
   3 .\"Dr. Duncan McLennan Barclay, dmlb@ragnet.demon.co.uk.
   4 .\"
   5 .\" All rights reserved.
   6 .\"
   7 .\"Redistribution and use in source and binary forms, with or without
   8 .\"modification, are permitted provided that the following conditions
   9 .\"are met:
  10 .\"1. Redistributions of source code must retain the above copyright
  11 .\"   notice, this list of conditions and the following disclaimer.
  12 .\"2. Redistributions in binary form must reproduce the above copyright
  13 .\"   notice, this list of conditions and the following disclaimer in the
  14 .\"   documentation and/or other materials provided with the distribution.
  15 .\"3. Neither the name of the author nor the names of any co-contributors
  16 .\"   may be used to endorse or promote products derived from this software
  17 .\"   without specific prior written permission.
  18 .\"
  19 .\"THIS SOFTWARE IS PROVIDED BY DUNCAN BARCLAY AND CONTRIBUTORS ``AS IS'' AND
  20 .\"ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  21 .\"IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  22 .\"ARE DISCLAIMED.  IN NO EVENT SHALL DUNCAN BARCLAY OR CONTRIBUTORS BE LIABLE
  23 .\"FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  24 .\"DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  25 .\"OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  26 .\"HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  27 .\"LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  28 .\"OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  29 .\"SUCH DAMAGE.
  30 .\"
  31 .\" Copyright (c) 1997, 1998, 1999
  32 .\"     Bill Paul <wpaul@ctr.columbia.edu> All rights reserved.
  33 .\"
  34 .\" Redistribution and use in source and binary forms, with or without
  35 .\" modification, are permitted provided that the following conditions
  36 .\" are met:
  37 .\" 1. Redistributions of source code must retain the above copyright
  38 .\"    notice, this list of conditions and the following disclaimer.
  39 .\" 2. Redistributions in binary form must reproduce the above copyright
  40 .\"    notice, this list of conditions and the following disclaimer in the
  41 .\"    documentation and/or other materials provided with the distribution.
  42 .\" 3. All advertising materials mentioning features or use of this software
  43 .\"    must display the following acknowledgement:
  44 .\"     This product includes software developed by Bill Paul.
  45 .\" 4. Neither the name of the author nor the names of any co-contributors
  46 .\"    may be used to endorse or promote products derived from this software
  47 .\"   without specific prior written permission.
  48 .\"
  49 .\" THIS SOFTWARE IS PROVIDED BY Bill Paul AND CONTRIBUTORS ``AS IS'' AND
  50 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  51 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  52 .\" ARE DISCLAIMED.  IN NO EVENT SHALL Bill Paul OR THE VOICES IN HIS HEAD
  53 .\" BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  54 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  55 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  56 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  57 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  58 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  59 .\" THE POSSIBILITY OF SUCH DAMAGE.
  60 .\"
  61 .\" $FreeBSD: src/usr.sbin/raycontrol/raycontrol.8,v 1.5.2.5 2003/03/11 22:31:31 trhodes Exp $
  62 .\"
  63 .Dd March 21, 2000
  64 .Dt RAYCONTROL 8
  65 .Os
  66 .Sh NAME
  67 .Nm raycontrol
  68 .Nd configure Raytheon Raylink/Webgear Aviator devices
  69 .Sh SYNOPSIS
  70 .Nm
  71 .Fl i Ar iface Op Fl o
  72 .Nm
  73 .Fl i Ar iface Fl t Ar tx rate
  74 .Nm
  75 .Fl i Ar iface Fl n Ar network name
  76 .Nm
  77 .Fl i Ar iface Fl c Ar ap status
  78 .Nm
  79 .Fl i Ar iface Fl p Ar port type
  80 .Nm
  81 .Fl i Ar iface Fl m Ar mac address
  82 .Nm
  83 .Fl i Ar iface Fl d Ar max data length
  84 .Nm
  85 .Fl i Ar iface Fl r Ar RTS threshold
  86 .Nm
  87 .Fl i Ar iface Fl f Ar hopset
  88 .Nm
  89 .Fl i Ar iface Fl P Ar 0|1
  90 .Nm
  91 .Fl i Ar iface Fl S Ar max_sleep_duration
  92 .Nm
  93 .Fl i Ar iface Fl Z Ar zero signal cache
  94 .Nm
  95 .Fl i Ar iface Fl C Ar display signal cache
  96 .Sh DESCRIPTION
  97 The
  98 .Nm
  99 utility controls the operation of Raylink/Webgear wireless networking
 100 devices via the
 101 .Xr ray 4
 102 driver.
 103 Most of the parameters that can be changed relate to the
 104 IEEE 802.11 protocol which the card implements.
 105 This includes
 106 the station name, whether the station is operating in ad-hoc
 107 or infrastructure mode, and the network name of a service
 108 set to join - the BSS in ad-hoc mode or ESS if infrastructure mode is enabled.
 109 The
 110 .Nm
 111 utility can also be used to view the current settings of these parameters
 112 and to dump out the values of the card's statistics counters.
 113 .Pp
 114 The
 115 .Ar iface
 116 argument given to
 117 .Nm
 118 should be the logical interface name associated with the Raylink/Webgear
 119 device (ray0, ray1, ...).
 120 .Sh OPTIONS
 121 The options are as follows:
 122 .Bl -tag -width Fl
 123 .It Fl i Ar iface Op Fl o
 124 Display the current settings of the specified Raylink/Webgear interface.
 125 This retrieves the current card settings from the driver and prints them
 126 out.
 127 The results from this command are a snapshot of the card settings.
 128 Using the additional
 129 .Fl o
 130 flag will cause
 131 .Nm
 132 to print out the statistics counters instead of the card settings.
 133 .It Fl i Ar iface Fl t Ar tx rate
 134 Set the transmit rate of the specified interface.
 135 The
 136 NICs support a maximum transmit rate of 2Mbps.
 137 The following table shows the
 138 legal transmit rate settings and the corresponding transmit speeds:
 139 .Bl -column "TX rate " "NIC speed " -offset indent
 140 .Em "TX rate    NIC speed"
 141 1       Very Low (0.5Mbps)
 142 2       Low (1Mbps)
 143 3       Medium (1.5Mbps)
 144 4       High (2Mbps)
 145 .El
 146 .Pp
 147 The version 4 firmware may ignore this setting.
 148 Note, that the IEEE 802.11
 149 standard
 150 only allows 1Mbps or 2Mbps operation, and that the generally accepted
 151 reading of the IEEE 802.11 standard is that 2Mbps is only allowed in
 152 infrastructure mode.
 153 .It Fl i Ar iface Fl n Ar network name
 154 Set the name of the service set that this station wishes to
 155 join.
 156 The
 157 .Ar network name
 158 can be any text string up to 32 characters in length.
 159 The default name
 160 is the string "NETWORK_NAME" which should allow the station to connect to
 161 the default Webgear ad-hoc network.
 162 .It Fl i Ar iface Fl p Ar port type
 163 Set the
 164 .Ar port type
 165 for a specified interface.
 166 The legal values for
 167 .Ar port type
 168 are 0 (ad-hoc mode) and 1 (infrastructure mode).
 169 In ad-hoc mode, the station can
 170 communicate directly with any other stations within direct radio range
 171 (provided that they are also operating in ad-hoc mode).
 172 In infrastructure mode,
 173 hosts must associate with a service set controlled by an access point,
 174 that relays traffic between end stations.
 175 The default setting is 0
 176 (ad-hoc mode).
 177 .Pp
 178 When in ad-hoc mode the station will create a BSS with the network name
 179 specified by the
 180 .Fl n
 181 option if it cannot find an existing network of that name on the
 182 currently configured hopset (see the
 183 .Fl f
 184 option).
 185 .It Fl i Ar iface Fl m Ar mac address
 186 Set the station address for the specified interface.
 187 The
 188 .Ar mac address
 189 is specified as a series of six hexadecimal values separated by colons,
 190 e.g.: 00:60:1d:12:34:56.
 191 This programs the new address into the card
 192 and updates the interface as well.
 193 .It Fl i Ar iface Fl d Ar max_data_length
 194 Set the maximum transmit frame size for a specified interface.
 195 The
 196 .Ar max data length
 197 can be any number from 350 to 2304 or -1 to disable fragmentation.
 198 The default is -1.
 199 .It Fl i Ar iface Fl r Ar RTS threshold
 200 Set the RTS/CTS threshold for a given interface.
 201 This controls the
 202 number of bytes used for the RTS/CTS handshake boundary.
 203 The
 204 .Ar RTS threshold
 205 can be any value between -1 and 2047.
 206 The default is -1 (disable).
 207 .It Fl i Ar iface Fl f Ar hopset
 208 Set the radio hopset of a given interface.
 209 The
 210 .Ar hopset
 211 should be specified as a country code as shown in the table below.
 212 The
 213 hopset varies both the number of RF channels and their frequencies
 214 and is dependent on radio regulations specified
 215 by regional authorities.
 216 .Bl -column "Hopset ID " "Country " -offset indent
 217 .Em "Hopset ID  Country"
 218 1       USA
 219 2       Europe
 220 3       Japan
 221 4       Korea
 222 5       Spain
 223 6       France
 224 7       Israel
 225 8       Australia
 226 9       Japan Test
 227 .El
 228 .Pp
 229 Whilst the card can be programmed to work with any hopset it makes
 230 sense to use the hopset for your own region to avoid interference from
 231 and interfering with other users of the RF spectrum (in places like
 232 France this is the military).
 233 .Pp
 234 Note that all stations must be set to the same hopset in order to
 235 communicate.
 236 .It Fl i Ar iface Fl P Ar 0|1
 237 Enable or disable power management on a given interface.
 238 Enabling
 239 power management uses an alternating sleep/wake protocol to help
 240 conserve power on mobile stations, at the cost of some increased
 241 receive latency.
 242 Power management is off by default.
 243 .Pp
 244 Note that power
 245 management requires the cooperation of an access point in order to
 246 function; it is not functional in ad-hoc mode.
 247 Legal
 248 values for this parameter are 0 (off) and 1 (on).
 249 .It Fl i Ar iface Fl S Ar max_sleep_interval
 250 Specify the sleep interval to use when power management is enabled.
 251 The
 252 .Ar max_sleep_interval
 253 is specified in milliseconds.
 254 The default is 100.
 255 .It Fl i Ar iface Fl Z
 256 Clear the signal strength cache maintained internally by the
 257 .Xr ray 4
 258 driver.
 259 .It Fl i Ar iface Fl C
 260 Display the cached signal strength information maintained by the
 261 .Xr ray 4
 262 driver.
 263 The driver retains information about signal strength and
 264 noise level for packets received from different hosts.
 265 For
 266 infrastructure networks the cache stores the signal strength of the
 267 access point.
 268 .Pp
 269 The driver also uses the cache to pick the best antenna when
 270 transmitting.
 271 .El
 272 .Sh SEE ALSO
 273 .Xr ray 4 ,
 274 .Xr ifconfig 8
 275 .Sh HISTORY
 276 The
 277 .Nm
 278 utility first appeared in
 279 .Fx 4.0 .
 280 .Sh AUTHORS
 281 .An -nosplit
 282 The
 283 .Nm
 284 utility was written by
 285 .An Duncan Barclay Aq dmlb@ragnet.demon.co.uk
 286 and based on the
 287 .Nm wicontrol
 288 utility by
 289 .An Bill Paul Aq wpaul@ctr.columbia.edu .
 290 .Sh BUGS
 291 The
 292 .Fl m ,
 293 .Fl P ,
 294 .Fl S
 295 and
 296 .Fl Z
 297 options aren't implemented yet.
 298 No access point was available for testing
 299 against.
 300 .Pp
 301 Not tested with Version 5 firmware.
 302 .Pp
 303 Hopset changing may not work with version 4 firmware.
 304 .Pp
 305 The
 306 .Fl W
 307 option is un-documented on purpose.