Bug 18520

Summary: kbdcontrol manpage incomplete
Product: Documentation Reporter: Nick Hibma <n_hibma>
Component: Books & ArticlesAssignee: ben <ben>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description Nick Hibma freebsd_committer freebsd_triage 2000-05-13 01:10:00 UTC
	The manpage for kbdcontrol is incomplete. It does not mention that
some commands only apply to /dev/console or the virtual terminals. It would
be useful to see an example along the lines of

	kbdcontrol -k /dev/ukbd0 < /dev/console

to show how to change the keyboard when in an xterm (or when using an automatic
changer line in usbd.conf).
Comment 1 ben freebsd_committer freebsd_triage 2000-07-12 19:24:15 UTC
n_hibma@freebsd.org wrote:

> 	The manpage for kbdcontrol is incomplete. It does not mention that
> some commands only apply to /dev/console or the virtual terminals. It would
> be useful to see an example along the lines of
> 
> 	kbdcontrol -k /dev/ukbd0 < /dev/console
> 
> to show how to change the keyboard when in an xterm (or when using an automatic
> changer line in usbd.conf).

What sort of text do you think is needed?  I don't really know enough
about USB and stuff to see exactly what you mean.  I assume that command
will mean that the USB keyboard acts as the console keyboard from that
point forward?  How do you change it back?

Anyway, how about:

        To change the default console keyboard to the first USB keyboard
        (see ukbd(4)) when not working on the console or a virtual
        terminal, use this command:

		kbdcontrol -k /dev/ukbd0 < /dev/console

The ukbd(4) manpage seems to have a bit more about this, so I explicitly
added a reference to it there rather than expecting people to find it in
the SEE ALSO bit.

-- 
Ben Smithurst / ben@FreeBSD.org / PGP: 0x99392F7D
Comment 2 n_hibma 2000-07-14 22:18:28 UTC
> What sort of text do you think is needed?  I don't really know enough
> about USB and stuff to see exactly what you mean.  I assume that command
> will mean that the USB keyboard acts as the console keyboard from that
> point forward?  How do you change it back?

By using the same command again. A slightly modified / corected version
of the text you suggested below:

	To change the default console keyboard to the another
	keyboard, for example the first USB keyboard (see ukbd(4)), use
	the following commands:

		kbdcontrol -k /dev/kbd1 < /dev/console

	To switch back to the default keyboard, use

		kbdcontrol -k /dev/kbd0

> The ukbd(4) manpage seems to have a bit more about this, so I explicitly
> added a reference to it there rather than expecting people to find it in
> the SEE ALSO bit.

Yes, that is a good idea.

Thanks,

Nick

--
n_hibma@webweaving.org
n_hibma@freebsd.org                                          USB project
http://www.etla.net/~n_hibma/
Comment 3 ben freebsd_committer freebsd_triage 2000-07-15 16:50:01 UTC
Nick Hibma wrote:

> 	To change the default console keyboard to the another
> 	keyboard, for example the first USB keyboard (see ukbd(4)), use
> 	the following commands:
> 
> 		kbdcontrol -k /dev/kbd1 < /dev/console
> 
> 	To switch back to the default keyboard, use
> 
> 		kbdcontrol -k /dev/kbd0

ok, I'll commit this soon.

-- 
Ben Smithurst                 / ben@FreeBSD.org / PGP: 0x99392F7D
FreeBSD Documentation Project /
Comment 4 ben freebsd_committer freebsd_triage 2000-07-15 16:59:00 UTC
Nick Hibma wrote:

> 	To change the default console keyboard to the another
> 	keyboard, for example the first USB keyboard (see ukbd(4)), use
> 	the following commands:
> 
> 		kbdcontrol -k /dev/kbd1 < /dev/console
> 
> 	To switch back to the default keyboard, use
> 
> 		kbdcontrol -k /dev/kbd0

how about this addition as well:

 .It Fl k Ar keyboard_device
 Use the specified device as the console keyboard.
+When using this option, the standard input of the
+.Nm
+process should be redirected from
+.Pa /dev/console
+if you are not working on the system console or a virtual terminal
+(see
+.Sx EXAMPLES
+section).

Or, if you don't speak mdoc:

     -k keyboard_device
             Use the specified device as the console keyboard.  When using
             this option, the standard input of the kbdcontrol process should
             be redirected from /dev/console if you are not working on the
             system console or a virtual terminal (see EXAMPLES section).

-- 
Ben Smithurst                 / ben@FreeBSD.org / PGP: 0x99392F7D
FreeBSD Documentation Project /
Comment 5 ben freebsd_committer freebsd_triage 2000-07-18 17:29:18 UTC
Responsible Changed
From-To: freebsd-doc->ben

I'm looking at this.
Comment 6 ben freebsd_committer freebsd_triage 2000-07-19 20:13:16 UTC
State Changed
From-To: open->closed

committed in current and stable, thanks!