Bug 13763

Summary:	ambiguity in vidcontrol(1) manpage
Product:	Documentation	Reporter:	Alex Kapranoff <alex>
Component:	Books & Articles	Assignee:	freebsd-doc (Nobody) <doc>
Status:	Closed FIXED
Severity:	Affects Only Me
Priority:	Normal
Version:	Latest
Hardware:	Any
OS:	Any

Description Alex Kapranoff 1999-09-15 18:50:00 UTC

vidcontrol.1 manpage specifies the "-i" command-line switch in somewhat
obscure manner: 

-i adapter
  Shows info about current video adapter.

-i mode
  Shows the possible videomodes with the current video hardware.

And the arguments "adapter" and "modes" are hilited as if they're
user-supplied values while they're just words "adapter" or "mode".

This is likely to be not-the-right-way in vidcontrol program itself, but
also could be somehow emphasized in the manpage.

How-To-Repeat: 
man vidcontrol | col -b | grep -A 2 -e ' -i'

Comment 1 Neil Blakey-Milner 1999-10-19 14:26:38 UTC

On Wed 1999-09-15 (20:24), Alex Kapranoff wrote:
> >Number:         13763
> >Category:       docs
> >Synopsis:       ambiguity in vidcontrol(1) manpage
> >Responsible:    freebsd-doc
> >State:          open
> >Originator:     Alex Kapranoff
> >Release:        FreeBSD 3.0-RELEASE i386
> 
> vidcontrol.1 manpage specifies the "-i" command-line switch in somewhat
> obscure manner: 
> 
> -i adapter
>   Shows info about current video adapter.
> 
> -i mode
>   Shows the possible videomodes with the current video hardware.
> 
> And the arguments "adapter" and "modes" are hilited as if they're
> user-supplied values while they're just words "adapter" or "mode".
> 
> This is likely to be not-the-right-way in vidcontrol program itself, but
> also could be somehow emphasized in the manpage.

This has been fixed in revisions 1.14.2 and 1.17 of
src/usr.sbin/vidcontrol/vidcontrol.1 by yokota.

Neil
-- 
Neil Blakey-Milner
nbm@rucus.ru.ac.za

Comment 2 nik freebsd_committer

1999-10-26 22:38:34 UTC

State Changed
From-To: open->closed

PR fixed some time ago (see commentary for revisions).