d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

mdoc(7) police: fix markup and a SYNOPSIS bug from revision 1.24.

Browse Source
This commit is contained in:
Ruslan Ermilov 2001-08-10 10:45:59 +00:00
parent 3ce0d6e846
commit 6bd44d4d24
1 changed files with 150 additions and 98 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

248
usr.sbin/wicontrol/wicontrol.8
View File

@ -39,53 +39,53 @@
.Sh SYNOPSIS
.Nm
.Op Fl i
.Ar iface Op Fl oa
.Ar iface Op Fl o
.Nm
.Op Fl i
.Ar iface Fl t Ar tx rate
.Ar iface Fl t Ar tx_rate
.Nm
.Op Fl i
.Ar iface Fl n Ar network name
.Ar iface Fl n Ar network_name
.Nm
.Op Fl i
.Ar iface Fl s Ar station name
.Ar iface Fl s Ar station_name
.Nm
.Op Fl i
.Ar iface Fl c Ar 0|1
.Ar iface Fl c Cm 0 | 1
.Nm
.Op Fl i
.Ar iface Fl q Ar SSID
.Nm
.Op Fl i
.Ar iface Fl p Ar port type
.Ar iface Fl p Ar port_type
.Nm
.Op Fl i
.Ar iface Fl a Ar access point density
.Ar iface Fl a Ar access_point_density
.Nm
.Op Fl i
.Ar iface Fl m Ar mac address
.Ar iface Fl m Ar mac_address
.Nm
.Op Fl i
.Ar iface Fl d Ar max data length
.Ar iface Fl d Ar max_data_length
.Nm
.Op Fl i
.Ar iface Fl e Ar 0|1
.Ar iface Fl e Cm 0 | 1
.Nm
.Op Fl i
.Ar iface Fl k Ar key
.Op Fl v Ar 1|2|3|4
.Op Fl v Cm 1 | 2 | 3 | 4
.Nm
.Op Fl i
.Ar iface Fl T Ar 1|2|3|4
.Ar iface Fl T Cm 1 | 2 | 3 | 4
.Nm
.Op Fl i
.Ar iface Fl r Ar RTS threshold
.Ar iface Fl r Ar RTS_threshold
.Nm
.Op Fl i
.Ar iface Fl f Ar frequency
.Nm
.Op Fl i
.Ar iface Fl P Ar 0|1
.Ar iface Fl P Cm 0 | 1
.Nm
.Op Fl i
.Ar iface Fl S Ar max_sleep_duration
@ -120,12 +120,16 @@ The
argument given to
.Nm
should be the logical interface name associated with the WaveLAN/IEEE
device (wi0, wi1, etc...). If none is specified then wi0 is used
as default.
device
.Li ( wi0 , wi1 ,
etc.).
If none is specified then
.Dq Li wi0
is used as default.
.Sh OPTIONS
The options are as follows:
.Bl -tag -width Fl
.It Fl i Ar iface Op Fl o
.Bl -tag -width indent
.It Oo Fl i Oc Ar iface Op Fl o
Display the current settings of the specified WaveLAN/IEEE interface.
This retrieves the current card settings from the driver and prints them
out.
@ -134,8 +138,10 @@ Using the additional
flag will cause
.Nm
to print out the statistics counters instead of the card settings.
Encryption keys are only displayed if wicontrol is run as root.
.It Fl i Ar iface Fl t Ar tx rate
Encryption keys are only displayed if
.Nm
is run as root.
.It Oo Fl i Oc Ar iface Fl t Ar tx_rate
Set the transmit rate of the specified interface.
The legal values
for the transmit rate vary depending on whether the interface is a
@ -145,28 +151,35 @@ NICs support a maximum transmit rate of 2Mbps while the turbo NICs
support a maximum speed of 6Mbps.
The following table shows the
legal transmit rate settings and the corresponding transmit speeds:
.Bl -column "TX rate " "NIC speed " -offset indent
.Bl -column ".Em TX\ rate" ".Em NIC\ speed" -offset indent
.Em "TX rate NIC speed"
1 Fixed Low (1Mbps)
2 Fixed Standard (2Mbps)
3 Auto Rate Select (High)
4 Fixed Medium (4Mbps)
5 Fixed High (6Mbps)
6 Auto Rate Select (Standard)
7 Auto Rate Select (Medium)
.It Cm 1 Ta "Fixed Low (1Mbps)"
.It Cm 2 Ta "Fixed Standard (2Mbps)"
.It Cm 3 Ta "Auto Rate Select (High)"
.It Cm 4 Ta "Fixed Medium (4Mbps)"
.It Cm 5 Ta "Fixed High (6Mbps)"
.It Cm 6 Ta "Auto Rate Select (Standard)"
.It Cm 7 Ta "Auto Rate Select (Medium)"
.El
.Pp
The standard NICs support only settings 1 through 3. Turbo NICs support
all the above listed speed settings.
The default driver setting is 3 (auto rate select).
.It Fl i Ar iface Fl n Ar network name
The standard NICs support only settings
.Cm 1
through
.Cm 3 .
Turbo NICs support all the above listed speed settings.
The default driver setting is
.Cm 3
(auto rate select).
.It Oo Fl i Oc Ar iface Fl n Ar network_name
Set the name of the service set (IBSS) that this station wishes to
join.
The
.Ar network name
.Ar network_name
can be any text string up to 30 characters in length.
The default name
is the string "ANY" which should allow the station to connect to the first
is the string
.Dq Li ANY
which should allow the station to connect to the first
available access point.
The interface should be set for BSS mode using
the
@ -175,24 +188,33 @@ flag in order for this to work.
.Pp
Note: the WaveLAN manual indicates that an empty string will allow the
host to connect to any access point, however I have also seen a reference
in another driver which indicates that the "ANY" string works as well.
.It Fl i Ar iface Fl s Ar station name
in another driver which indicates that the
.Dq Li ANY
string works as well.
.It Oo Fl i Oc Ar iface Fl s Ar station_name
Sets the
.Ar station name
station name
for the specified interface.
The
.Ar station name
.Ar station_name
is used for diagnostic purposes.
The Lucent WaveMANAGER software can
The
.Tn "Lucent WaveMANAGER"
software can
poll the names of remote hosts.
.It Fl i Ar iface Fl c Ar 0|1
Allow the station to create a service set (IBSS). Permitted values
are 0 (don't create IBSS) and 1 (enable creation of IBSS). The default
is 0.
.It Oo Fl i Oc Ar iface Fl c Cm 0 | 1
Allow the station to create a service set (IBSS).
Permitted values are
.Cm 0
(don't create IBSS) and
.Cm 1
(enable creation of IBSS).
The default is
.Cm 0 .
.Pp
Note: this option is provided for experimental purposes only: enabling
the creation of an IBSS on a host system doesn't appear to actually work.
.It Fl i Ar iface Fl q Ar SSID
.It Oo Fl i Oc Ar iface Fl q Ar SSID
Specify the name of an IBSS (SSID) to create on a given interface.
The
.Ar SSID
@ -200,52 +222,67 @@ can be any text string up to 30 characters long.
.Pp
Note: this option is provided for experimental purposes only: enabling
the creation of an IBSS on a host system doesn't appear to actually work.
.It Fl i Ar iface Fl p Ar port type
.It Oo Fl i Oc Ar iface Fl p Ar port_type
Set the
.Ar port type
port type
for a specified interface.
The legal values for
.Ar port type
are 1 (BSS mode) and 3 (ad-hoc) mode.
.Ar port_type
are
.Cm 1
(BSS mode) and
.Cm 3
(ad-hoc) mode.
In ad-hoc mode, the station can
communicate directly with any other stations within direct radio range
(provided that they are also operating in ad-hoc mode). In BSS mode,
(provided that they are also operating in ad-hoc mode).
In BSS mode,
hosts must associate with a service set controlled by an access point,
which relays traffic between end stations.
The default setting is 3
The default setting is
.Cm 3
(ad-hoc mode).
.It Fl i Ar iface Fl a Ar access_point_density
.It Oo Fl i Oc Ar iface Fl a Ar access_point_density
Specify the
.Ar access point density
access point density
for a given interface.
Legal values are 1 (low), 2 (medium) and 3 (high).
Legal values are
.Cm 1
(low),
.Cm 2
(medium) and
.Cm 3
(high).
This setting influences some of the radio modem threshold settings.
.It Fl i Ar iface Fl m Ar mac address
.It Oo Fl i Oc Ar iface Fl m Ar mac_address
Set the station address for the specified interface.
The
.Ar mac address
.Ar mac_address
is specified as a series of six hexadecimal values separated by colons,
e.g.: 00:60:1d:12:34:56.
e.g.,
.Dq Li 00:60:1d:12:34:56 .
This programs the new address into the card
and updates the interface as well.
.It Fl i Ar iface Fl d Ar max_data_length
.It Oo Fl i Oc Ar iface Fl d Ar max_data_length
Set the maximum receive and transmit frame size for a specified interface.
The
.Ar max data length
.Ar max_data_length
can be any number from 350 to 2304.
The default is 2304.
.It Fl i Ar iface Fl e Ar 0|1
.It Oo Fl i Oc Ar iface Fl e Cm 0 | 1
Enable or disable WEP encryption.
Permitted values are
.Ar 0
.Cm 0
(encryption disabled) or
.Ar 1
.Cm 1
(encryption enabled).
Encryption is off by default.
.Pp
Both 128-bit and 64-bit WEP have been broken.
See the BUGS section for details.
.It Fl i Ar iface Fl k Ar key "[-v 1|2|3|4]"
See the
.Sx BUGS
section for details.
.It Oo Fl i Oc Ar iface Fl k Ar key Op Fl v Cm 1 | 2 | 3 | 4
Set WEP encryption keys.
There are four default encryption keys
that can be programmed.
@ -257,8 +294,11 @@ If the
.Fl v
flag is not specified, the first key will be set.
Encryption keys
can either be normal text (i.e. "hello") or a series of hexadecimal
digits (i.e. "0x1234512345"). For
can either be normal text (i.e.\&
.Dq Li hello )
or a series of hexadecimal digits (i.e.\&
.Dq Li 0x1234512345 ) .
For
WaveLAN Turbo Silver cards, the key is restricted to 40 bits, hence
the key can be either a 5 character text string or 10 hex digits.
For WaveLAN Turbo Gold cards, the key can also be 104 bits,
@ -267,22 +307,26 @@ string or 26 hex digits in addition to the formats supported by the
Silver cards.
.Pp
Note: Both 128-bit and 64-bit WEP have been broken.
See the BUGS section for details.
.It Fl i Ar iface Fl T Ar 1|2|3|4
See the
.Sx BUGS
section for details.
.It Oo Fl i Oc Ar iface Fl T Cm 1 | 2 | 3 | 4
Specify which of the four WEP encryption keys will be used to
encrypt transmitted packets.
.Pp
Note: Both 128-bit and 64-bit WEP have been broken.
See the BUGS section for details.
.It Fl i Ar iface Fl r Ar RTS threshold
See the
.Sx BUGS
section for details.
.It Oo Fl i Oc Ar iface Fl r Ar RTS_threshold
Set the RTS/CTS threshold for a given interface.
This controls the
number of bytes used for the RTS/CTS handshake boundary.
The
.Ar RTS threshold
.Ar RTS_threshold
can be any value between 0 and 2047.
The default is 2347.
.It Fl i Ar iface Fl f Ar frequency
.It Oo Fl i Oc Ar iface Fl f Ar frequency
Set the radio frequency of a given interface.
The
.Ar frequency
@ -294,34 +338,37 @@ Recognized regulatory authorities include
the FCC (United States), ETSI (Europe), France and Japan.
Frequencies
in the table are specified in Mhz.
.Bl -column "Channel ID " "FCC " "ETSI " "France " "Japan " -offset indent
.Bl -column ".Em Channel\ ID" ".Em FCC" ".Em ETSI" ".Em France" ".Em Japan" -offset indent
.Em "Channel ID FCC ETSI France Japan"
1 2412 2412 - 2412
2 2417 2417 - 2417
3 2422 2422 - 2422
4 2427 2427 - 2427
5 2432 2432 - 2432
6 2437 2437 - 2437
7 2442 2442 - 2442
8 2447 2447 - 2447
9 2452 2452 - 2452
10 2457 2457 2457 2457
11 2462 2462 2462 2462
12 - 2467 2467 2467
13 - 2472 2472 2472
14 - - - 2484
.It Cm 1 Ta "2412 2412 - 2412"
.It Cm 2 Ta "2417 2417 - 2417"
.It Cm 3 Ta "2422 2422 - 2422"
.It Cm 4 Ta "2427 2427 - 2427"
.It Cm 5 Ta "2432 2432 - 2432"
.It Cm 6 Ta "2437 2437 - 2437"
.It Cm 7 Ta "2442 2442 - 2442"
.It Cm 8 Ta "2447 2447 - 2447"
.It Cm 9 Ta "2452 2452 - 2452"
.It Cm 10 Ta "2457 2457 2457 2457"
.It Cm 11 Ta "2462 2462 2462 2462"
.It Cm 12 Ta "- 2467 2467 2467"
.It Cm 13 Ta "- 2472 2472 2472"
.It Cm 14 Ta "- - - 2484"
.El
.Pp
If an illegal channel is specified, the
NIC will revert to its default channel.
For NICs sold in the United States
and Europe, the default channel is 3. For NICs sold in France, the default
channel is 11.
For NICs sold in Japan, the default channel is 14,
and Europe, the default channel is
.Cm 3 .
For NICs sold in France, the default channel is
.Cm 11 .
For NICs sold in Japan, the default channel is
.Cm 14 ,
and it is the only available channel for pre-11Mbps NICs.
Note that two stations must be set to the same channel in order to
communicate.
.It Fl i Ar iface Fl P Ar 0|1
.It Oo Fl i Oc Ar iface Fl P Cm 0 | 1
Enable or disable power management on a given interface.
Enabling
power management uses an alternating sleep/wake protocol to help
@ -337,20 +384,24 @@ later, and in WaveLAN PCMCIA adapter firmware 2.00 or later.
Older
revisions will silently ignore the power management setting.
Legal
values for this parameter are 0 (off) and 1 (on).
.It Fl i Ar iface Fl S Ar max_sleep_interval
values for this parameter are
.Cm 0
(off) and
.Cm 1
(on).
.It Oo Fl i Oc Ar iface Fl S Ar max_sleep_interval
Specify the sleep interval to use when power management is enabled.
The
.Ar max_sleep_interval
is specified in milliseconds.
The default is 100.
.It Fl i Ar iface Fl Z
.It Oo Fl i Oc Ar iface Fl Z
Clear the signal strength cache maintained internally by the
.Nm wi
.Xr wi 4
driver.
.It Fl i Ar iface Fl C
.It Oo Fl i Oc Ar iface Fl C
Display the cached signal strength information maintained by the
.Nm wi
.Xr wi 4
driver.
The driver retains information about signal strength and
noise level for packets received from different hosts.
@ -389,8 +440,9 @@ hours on a partially loaded network.
Once a key has been compromised, the only remedial action is to
discontinue it and use a new key.
.Pp
See http://www.cs.rice.edu/~astubble/wep/wep_attack.html for details
of the attack.
See
.Pa http://www.cs.rice.edu/~astubble/wep/wep_attack.html
for details of the attack.
.Pp
If you must use WEP, you are strongly encouraged to pick keys whose
bytes are random and not confined to ASCII characters.