3 .\"Dr. Duncan McLennan Barclay, dmlb@ragnet.demon.co.uk.
5 .\" All rights reserved.
7 .\"Redistribution and use in source and binary forms, with or without
8 .\"modification, are permitted provided that the following conditions
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.
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
31 .\" Copyright (c) 1997, 1998, 1999
32 .\" Bill Paul <wpaul@ctr.columbia.edu> All rights reserved.
34 .\" Redistribution and use in source and binary forms, with or without
35 .\" modification, are permitted provided that the following conditions
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.
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.
68 .Nd configure Raytheon Raylink/Webgear Aviator devices
71 .Fl i Ar iface Op Fl o
73 .Fl i Ar iface Fl t Ar tx rate
75 .Fl i Ar iface Fl n Ar network name
77 .Fl i Ar iface Fl c Ar ap status
79 .Fl i Ar iface Fl p Ar port type
81 .Fl i Ar iface Fl m Ar mac address
83 .Fl i Ar iface Fl d Ar max data length
85 .Fl i Ar iface Fl r Ar RTS threshold
87 .Fl i Ar iface Fl f Ar hopset
89 .Fl i Ar iface Fl P Ar 0|1
91 .Fl i Ar iface Fl S Ar max_sleep_duration
93 .Fl i Ar iface Fl Z Ar zero signal cache
95 .Fl i Ar iface Fl C Ar display signal cache
99 command controls the operation of Raylink/Webgear wireless networking
103 Most of the parameters that can be changed relate to the
104 IEEE 802.11 protocol which the card implements.
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.
111 command 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.
118 should be the logical interface name associated with the Raylink/Webgear
119 device (ray0, ray1, etc...).
121 The options are as follows:
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
127 The results from this command are a snapshot of the card settings.
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.
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"
147 The version 4 firmware may ignore this setting.
148 Note, that the IEEE 802.11
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
153 .It Fl i Ar iface Fl n Ar network name
154 Set the name of the service set that this station wishes to
158 can be any text string up to 32 characters in length.
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
165 for a specified interface.
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 inrastructure 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
178 When in ad-hoc mode the station will create a BSS with the network name
181 option if it cannot find an existing network of that name on the
182 currently configured hopset (see the
185 .It Fl i Ar iface Fl m Ar mac address
186 Set the station address for the specified interface.
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.
197 can be any number from 350 to 2304 or -1 to disable fragmentation.
199 .It Fl i Ar iface Fl r Ar RTS threshold
200 Set the RTS/CTS threshold for a given interface.
202 number of bytes used for the RTS/CTS handshake boundary.
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.
211 should be specified as a country code as shown in the table below.
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"
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).
234 Note that all stations must be set to the same hopset in order to
236 .It Fl i Ar iface Fl P Ar 0|1
237 Enable or disable power management on a given interface.
239 power management uses an alternating sleep/wake protocol to help
240 conserve power on mobile stations, at the cost of some increased
242 Power management is off by default.
245 management requires the cooperation of an access point in order to
246 function; it is not functional in ad-hoc mode.
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.
252 .Ar max_sleep_interval
253 is specified in milliseconds.
255 .It Fl i Ar iface Fl Z
256 Clear the signal strength cache maintained internally by the
259 .It Fl i Ar iface Fl C
260 Display the cached signal strength information maintained by the
263 The driver retains information about signal strength and
264 noise level for packets received from different hosts.
266 infrastructure networks the cache stores the signal strength of the
269 The driver also uses the cache to pick the best antenna when
278 command first appeared in
284 command was written by
285 .An Duncan Barclay Aq dmlb@ragnet.demon.co.uk
289 .An Bill Paul Aq wpaul@ctr.columbia.edu .
297 options aren't implemented yet.
298 No access point was available for testing
301 Not tested with Version 5 firmware.
303 Hopset changing may not work with version 4 firmware.
307 option is un-documented on purpose.