usr.sbin/arlcontrol/arlcontrol.8

   1 .\" Copyright (c) 2004
   2 .\"     <ran@styx.aic.net>. All right reserved.
   3 .\"
   4 .\" Redistribution and use in source and binary forms, with or without
   5 .\" modification, are permitted provided that the following conditions
   6 .\" are met:
   7 .\" 1. Redistributions of source code must retain the above copyright
   8 .\"    notice, this list of conditions and the following disclaimer.
   9 .\" 2. Redistributions in binary form must reproduce the above copyright
  10 .\"    notice, this list of conditions and the following disclaimer in the
  11 .\"    documentation and/or other materials provided with the distribution.
  12 .\" 3. All advertising materials mentioning features or use of this software
  13 .\"    must display the following acknowledgement:
  14 .\"     This product includes software developed by <ran@styx.aic.net>
  15 .\" 4. 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 ran@styx.aic.net 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 <ran@styx.aic.net> OR THE VOICES IN HIS
  23 .\" HEAD BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
  24 .\" CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
  25 .\" SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
  26 .\" INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
  27 .\" CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
  28 .\" ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF
  29 .\" THE POSSIBILITY OF SUCH DAMAGE.
  30 .\"
  31 .\" $FreeBSD$
  32 .\"
  33 .Dd March 15, 2004
  34 .Dt ARLCONTROL 8 i386
  35 .Os
  36 .Sh NAME
  37 .Nm arlcontrol
  38 .Nd configure Aironet Arlan 655 device
  39 .Sh SYNOPSIS
  40 .Nm
  41 .Ar iface
  42 .Nm
  43 .Ar iface Cm country Ar country Pq Cm 9 Ns - Ns Cm 15
  44 .Nm
  45 .Ar iface Cm priority Ar priority Pq Cm normal , high , highest
  46 .Nm
  47 .Ar iface Cm txretry Ar txretry
  48 .Nm
  49 .Ar iface Cm stat
  50 .Nm
  51 .Ar iface Cm quality
  52 .Sh DESCRIPTION
  53 The
  54 .Nm
  55 utility controls the operation of Aironet Arlan 655 wireless networking
  56 devices via the
  57 .Xr arl 4
  58 driver.
  59 Most of the parameters that can be changed are related to the
  60 Aironet protocol which the Aironet Arlan 655 card implements.
  61 The
  62 .Nm
  63 utility can also be used to view the current NIC status, configuration,
  64 and to dump out the values of the card's statistics counters.
  65 .Pp
  66 The
  67 .Ar iface
  68 argument given to
  69 .Nm
  70 should be the logical interface name associated with the Aironet Arlan 655
  71 device
  72 .Li ( arl0 , arl1 ,
  73 etc.) and must be specified.
  74 .Sh OPTIONS
  75 The options are as follows:
  76 .Bl -tag -width indent
  77 .It Ar iface
  78 Display current settings of the specified wireless interface.
  79 This retrieves current card settings from the driver and prints
  80 them out.
  81 .It Ar iface Cm country Ar country Pq Cm 9 Ns - Ns Cm 15
  82 Chose
  83 .Ar country , channel
  84 parameters that depend on the
  85 .Ar country
  86 according to the following table:
  87 .Bl -column ".No North America" ".Em Channel" ".Em MHz"
  88 .Em "Country    Ch_Set  MHz"
  89 .It "North America" Ta 9 Ta "2412, 2427, 2442, 2457, 2465"
  90 .It "U.S.A" Ta 9 Ta "2412, 2427, 2442, 2457, 2465"
  91 .It "Canada" Ta 9 Ta "2412, 2427, 2442, 2457, 2465"
  92 .It "Mexico" Ta 9 Ta "2412, 2427, 2442, 2457, 2465"
  93 .It "New Zealand" Ta 9 Ta "2412, 2427, 2442, 2457, 2465"
  94 .It "E.T.S.I" Ta 10 Ta "2412, 2427, 2442, 2457, 2472"
  95 .It "Japan" Ta 11 Ta "2484"
  96 .It "France" Ta 12 Ta "2457, 2465, 2475"
  97 .It "Australia" Ta 13 Ta "2411, 2425, 2439"
  98 .It "Germany" Ta 14 Ta "2427, 2442, 2457"
  99 .It "U.K.(MPT1349)" Ta 15 Ta "2460"
 100 .It "U.K." Ta 15 Ta "2460"
 101 .It "Spain" Ta 15 Ta "2460"
 102 .El
 103 .It Ar iface Cm priority Ar priority Pq Cm normal , high , highest
 104 Use the
 105 .Ar priority
 106 parameter to set the priority of the Arlan 655 Radio Media Access Control
 107 the values are
 108 .Cm normal , high
 109 or
 110 .Cm highest .
 111 The higher the priority is set, the more likely this unit will be the first
 112 to successfully transmit a packet when multiple units are trying
 113 to transmit at the same time.
 114 .Pp
 115 The percentage of units on your network that you set to values other than
 116 .Cm normal
 117 should be kept small - 10 percent or less.
 118 .It Ar iface Cm txretry Ar txretry
 119 Set transmit retries.
 120 Default is 0.
 121 .It Ar iface Cm stat
 122 Print internal Arlan 655 statistics block.
 123 .It Ar iface Cm quality
 124 Display the cached signal level and quality maintained by the
 125 .Xr arl 4
 126 driver.
 127 The driver retains information about quality and level for packets
 128 received from different hosts.
 129 Also the driver extracts values from ACK packets.
 130 .El
 131 .Sh EXAMPLES
 132 .Bd -literal -offset indent
 133 arlcontrol arl0 country 11 priority high
 134 arlcontrol arl0 quality
 135 arlcontrol arl0 stat
 136 arlcontrol arl0
 137 .Ed
 138 .Pp
 139 You can configure the Arlan 655 card from
 140 .Pa /etc/start_if.arl0 .
 141 For example:
 142 .Bd -literal -offset indent
 143 #!/bin/sh
 144 /usr/sbin/arlcontrol country 9 priority highest
 145 .Ed
 146 .Sh SEE ALSO
 147 .Xr arl 4
 148 .Rs
 149 .%T "Arlan 655 ISA Wireless LAN Client Card User Guide"
 150 .Re
 151 .Sh HISTORY
 152 The
 153 .Nm
 154 utility first appeared in
 155 .Fx 5.3 .
 156 .Sh AUTHORS
 157 .An -nosplit
 158 The
 159 .Nm
 160 utility was written by
 161 .Aq ran@styx.aic.net .
 162 This manpage was written by
 163 .An Yuri Kurenkov Aq y.kurenkov@init.ru .
 164 .Sh BUGS
 165 Aironet Arlan 640 bridges and Arlan 630 access points do not understand
 166 country codes other than 9.