Skip site navigation (1)Skip section navigation (2)
Date:      Wed, 9 Oct 2002 10:02:42 -0400
From:      Jesse Sheidlower <jester@panix.com>
To:        FreeBSD-gnats-submit@FreeBSD.org
Subject:   docs/43861: non-trivial typo in wicontrol man page
Message-ID:  <20021009140242.GA4096@panix.com>

index | next in thread | raw e-mail


>Number:         43861
>Category:       docs
>Synopsis:       non-trivial typo in wicontrol man page
>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:   Wed Oct 09 07:10:00 PDT 2002
>Closed-Date:
>Last-Modified:
>Originator:     Jesse Sheidlower
>Release:        FreeBSD 4.7-RC i386
>Organization:
>Environment:
System: FreeBSD monopoly.jessesword.com 4.7-RC FreeBSD 4.7-RC #2: Thu Oct 10 17:55:13 EDT 2002 root@monopoly.jessesword.com:/usr/obj/usr/src/sys/MONOPOLY i386

>Description:

The man page for wicontrol, in both the Synopsis and the Options
sections, lists an -i flag in brackets by itself:

	wicontrol [-i] iface [-o]
     	wicontrol [-i] iface -t tx_rate
	[...]

It's not clear what this flag does, unless this is a typo throughout
for "[-i iface]" instead of "[-i] iface", i.e. if you choose to
specify iface you must precede it with -i, otherwise you specify
nothing and wi0 is used as the default. If the point is that you
must always specify an iface and the -i is optional with some
particular meaning, this meaning is never explained, and this
doesn't seem to be how the command works.

I also note that in the table at [-i] iface -t tx_rate in the
Options section, the list tops out at 7, while current wireless
cards support higher rates and these can be specified. I assume
this is a case of the man page not matching up with the source,
which I am not competent to check.

>How-To-Repeat:

man wicontrol

>Fix:

Change all instances of "[-i] iface" to "[-i iface]", or explain
what the -i flag does.

>Release-Note:
>Audit-Trail:
>Unformatted:
 To: FreeBSD-gnats-submit@freebsd.org
 Subject: non-trivial typo in wicontrol man page
 From: Jesse Sheidlower <jester@panix.com>
 Reply-To: Jesse Sheidlower <jester@panix.com>
 Cc: 
 Bcc: Ben Rosengart <ben@panix.com>
 X-send-pr-version: 3.113
 X-GNATS-Notify: 
 
 

To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message



home | help

Want to link to this message? Use this
URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?20021009140242.GA4096>