Bug 43861
| Summary: | non-trivial typo in wicontrol(8) man page | ||
|---|---|---|---|
| Product: | Documentation | Reporter: | Jesse Sheidlower <jester> |
| Component: | Books & Articles | Assignee: | freebsd-doc (Nobody) <doc> |
| Status: | Closed FIXED | ||
| Severity: | Affects Only Me | ||
| Priority: | Normal | ||
| Version: | Latest | ||
| Hardware: | Any | ||
| OS: | Any | ||
AFAIK, it's -i that's optional. 'wicontrol wi0' is the same thing as 'wicontrol -i wi0'. -Adam 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 Fixed in HEAD. 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"
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"
|
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. Fix: Change all instances of "[-i] iface" to "[-i iface]", or explain what the -i flag does. How-To-Repeat: man wicontrol