docs/57327: [patch] wicontrol man page fixes

[Matt Peterson]

>Number:         57327
>Category:       docs
>Synopsis:       [patch] wicontrol man page fixes
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          open
>Quarter:        
>Keywords:       
>Date-Required:
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Sep 28 14:00:31 PDT 2003
>Closed-Date:
>Last-Modified:
>Originator:     Matt Peterson
>Release:        FreeBSD 4.9-PRERELEASE i386
>Organization:
Bay Area Wireless Users Group
>Environment:

>Description:

The following patch updates the wicontrol page with the following:

* s/WaveLAN/Lucent, Intersil, & Atheros/g
(since all three chipets use this utility)

* Sort synopsis in sync with wicontrol -h order

* Document -l & -L

Additionally, add -L for -h in wicontrol

>How-To-Repeat:
>Fix:

--- wicontrol.8.old	Sun Sep 28 12:52:25 2003
+++ wicontrol.8	Sun Sep 28 13:46:26 2003
@@ -35,13 +35,21 @@
 .Os
 .Sh NAME
 .Nm wicontrol
-.Nd configure WaveLAN/IEEE devices
+.Nd configure Lucent, Intersil, & Atheros wireless devices
 .Sh SYNOPSIS
 .Nm
 .Op Fl i
 .Ar iface Op Fl o
 .Nm
 .Op Fl i
+.Ar iface Fl l
+(dump associated stations)
+.Nm
+.Op Fl i
+.Ar iface Fl L
+(list avail access points)
+.Nm
+.Op Fl i
 .Ar iface Fl t Ar tx_rate
 .Nm
 .Op Fl i
@@ -97,39 +105,34 @@
 .Op Fl i
 .Ar iface Fl C
 (display signal cache)
-.Nm
-.Op Fl i
-.Ar iface Fl L
-(list avail access points)
-.Nm
-.Op Fl i
-.Ar iface Fl l
-(dump associated stations)
 .Sh DESCRIPTION
 The
 .Nm
-utility controls the operation of WaveLAN/IEEE wireless networking
-devices via the
+utility controls the operation of Lucent, Intersil, & Atheros-based wireless
+networking devices via
 .Xr wi 4
+or
+.Xr ath 4
 driver.
 .Pp
 You should not use this program to configure IEEE 802.11 paramters.
 Use
 .Xr ifconfig 8
-instead to do those tasks.
+instead to do those tasks (ie: set SSID, WEP key, etc).
 .Pp
 The
 .Nm
-utility can also be used to view the current settings of these parameters
-and to dump out the values of the card's statistics counters.
+utility can also be used to view the current settings of these parameters,
+dump out the values of the card's statistics counters, list assoicated
+stations (in HostAP mode), and scan for available access points.
 .Pp
 The
 .Ar iface
 argument given to
 .Nm
-should be the logical interface name associated with the WaveLAN/IEEE
-device
-.Li ( wi0 , wi1 ,
+should be the logical interface name associated with the Lucent, Intersil, 
+& Atheros device
+.Li ( wi0 , wi1 , ath0 ,
 etc.).
 If none is specified then
 .Dq Li wi0
@@ -138,7 +141,7 @@
 The options are as follows:
 .Bl -tag -width indent
 .It Oo Fl i Oc Ar iface Op Fl o
-Display the current settings of the specified WaveLAN/IEEE interface.
+Display the current settings of the specified wireless interface.
 This retrieves the current card settings from the driver and prints them
 out.
 Using the additional
@@ -149,6 +152,20 @@
 Encryption keys are only displayed if
 .Nm
 is run as root.
+.It Oo Fl i Oc Ar iface Op Fl l
+Dump a list of connected stations (in HostAP mode).
+.It Oo Fl i Oc Ar iface Op Fl L
+Dump a list of available access points in tabular format.
+.Bl -column ".Em TX\ rate" ".Em NIC\ speed" -offset indent  
+.Em "Key	Value"
+.It Cm SSID Ta "Network name/service set identifier"
+.It Cm BSSID Ta "Broadcast network identifier"
+.It Cm Chan Ta "Channel"
+.It Cm SN S N Ta "Signal noise ratio, signal, & noise"
+.It Cm Intrvl Ta "Beacon interval"
+.It Cm Capinfo Ta "AP capabilities"
+.El
+.Pp
 .It Oo Fl i Oc Ar iface Fl a Ar access_point_density
 Specify the
 access point density
@@ -520,6 +537,7 @@
 The default is 100.
 .El
 .Sh SEE ALSO
+.Xr ath 4 ,
 .Xr awi 4 ,
 .Xr ipsec 4 ,
 .Xr wi 4 ,
--- wicontrol.c.old	Sun Sep 28 13:47:29 2003
+++ wicontrol.c	Sun Sep 28 13:48:05 2003
@@ -892,6 +892,7 @@
 	fprintf(stderr, "usage:  %s -i iface\n", p);
 	fprintf(stderr, "\t%s -i iface -o\n", p);
 	fprintf(stderr, "\t%s -i iface -l\n", p);
+	fprintf(stderr, "\t%s -i iface -L\n", p);
 	fprintf(stderr, "\t%s -i iface -t tx rate\n", p);
 	fprintf(stderr, "\t%s -i iface -n network name\n", p);
 	fprintf(stderr, "\t%s -i iface -s station name\n", p);

>Release-Note:
>Audit-Trail:
>Unformatted: