From jester@panix.com  Wed Oct  9 07:02:44 2002
Return-Path: <jester@panix.com>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id C227F37B401
	for <FreeBSD-gnats-submit@freebsd.org>; Wed,  9 Oct 2002 07:02:44 -0700 (PDT)
Received: from mail3.panix.com (mail3.panix.com [166.84.1.74])
	by mx1.FreeBSD.org (Postfix) with ESMTP id 1D17343E65
	for <FreeBSD-gnats-submit@freebsd.org>; Wed,  9 Oct 2002 07:02:44 -0700 (PDT)
	(envelope-from jester@panix.com)
Received: from panix2.panix.com (panix2.panix.com [166.84.1.2])
	by mail3.panix.com (Postfix) with ESMTP id AF4F8984F5
	for <FreeBSD-gnats-submit@freebsd.org>; Wed,  9 Oct 2002 10:02:42 -0400 (EDT)
Received: (from jester@localhost)
	by panix2.panix.com (8.11.6/8.8.8/PanixN1.0) id g99E2gs04098
	for FreeBSD-gnats-submit@freebsd.org; Wed, 9 Oct 2002 10:02:42 -0400 (EDT)
Message-Id: <20021009140242.GA4096@panix.com>
Date: Wed, 9 Oct 2002 10:02:42 -0400
From: Jesse Sheidlower <jester@panix.com>
To: FreeBSD-gnats-submit@freebsd.org
Subject: non-trivial typo in wicontrol man page

>Number:         43861
>Category:       docs
>Synopsis:       non-trivial typo in wicontrol(8) man page
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    freebsd-doc
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Wed Oct 09 07:10:00 PDT 2002
>Closed-Date:    Thu Oct 12 13:02:51 GMT 2006
>Last-Modified:  Mon Oct 16 12:00:57 GMT 2006
>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:

From: Adam Weinberger <adam@vectors.cx>
To: Jesse Sheidlower <jester@panix.com>
Cc: FreeBSD-gnats-submit@FreeBSD.ORG
Subject: Re: docs/43861: non-trivial typo in wicontrol man page
Date: Wed, 9 Oct 2002 11:41:11 -0700

 AFAIK, it's -i that's optional. 'wicontrol wi0' is the same thing as
 'wicontrol -i wi0'.
 
 -Adam

From: Igor Sobrado <sobrado@string1.ciencias.uniovi.es>
To: FreeBSD-gnats-submit@FreeBSD.ORG
Cc:  
Subject: Re: docs/43861: non-trivial typo in wicontrol man page
Date: Wed, 01 Jan 2003 17:59:07 +0100

 In that case, the right synopsis for this command should be:
 
   wicontrol [[-i] iface] ...
 
 Not only "-i" is optional, it is the "iface" field also (that defaults
 to wi0 if it is not specified.); an error is specifying "-i" without
 an interface.
 
 Cheers,
 Igor.
 
 -- 
 Igor Sobrado, UK34436 - sobrado@acm.org
State-Changed-From-To: open->closed 
State-Changed-By: ru 
State-Changed-When: Thu Oct 12 13:02:36 UTC 2006 
State-Changed-Why:  
Fixed in HEAD. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=43861 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/43861: commit references a PR
Date: Thu, 12 Oct 2006 13:02:56 +0000 (UTC)

 ru          2006-10-12 13:01:34 UTC
 
   FreeBSD src repository
 
   Modified files:
     usr.sbin/wicontrol   wicontrol.8 wicontrol.c 
   Log:
   Fix manpage's SYNOPSIS and program's usage().
   XXX: some options are still left undocumented.
   
   PR:             docs/43861
   
   Revision  Changes    Path
   1.49      +74 -70    src/usr.sbin/wicontrol/wicontrol.8
   1.40      +23 -23    src/usr.sbin/wicontrol/wicontrol.c
 _______________________________________________
 cvs-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/cvs-all
 To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
 

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/43861: commit references a PR
Date: Mon, 16 Oct 2006 11:57:32 +0000 (UTC)

 ru          2006-10-16 11:57:06 UTC
 
   FreeBSD src repository
 
   Modified files:        (Branch: RELENG_6)
     usr.sbin/wicontrol   wicontrol.8 wicontrol.c 
   Log:
   MFC: Fix manpage's SYNOPSIS and program's usage().
   
   PR:             docs/43861
   Approved by:    re (hrs)
   
   Revision  Changes    Path
   1.47.2.1  +74 -70    src/usr.sbin/wicontrol/wicontrol.8
   1.38.2.1  +23 -23    src/usr.sbin/wicontrol/wicontrol.c
 _______________________________________________
 cvs-all@freebsd.org mailing list
 http://lists.freebsd.org/mailman/listinfo/cvs-all
 To unsubscribe, send any mail to "cvs-all-unsubscribe@freebsd.org"
 
>Unformatted:
