From olli@lurza.secnetix.de  Sun Nov 20 20:25:25 2005
Return-Path: <olli@lurza.secnetix.de>
Received: from mx1.FreeBSD.org (mx1.freebsd.org [216.136.204.125])
	by hub.freebsd.org (Postfix) with ESMTP id 937D716A41F
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 20 Nov 2005 20:25:25 +0000 (GMT)
	(envelope-from olli@lurza.secnetix.de)
Received: from lurza.secnetix.de (lurza.secnetix.de [83.120.8.8])
	by mx1.FreeBSD.org (Postfix) with ESMTP id C758E43D4C
	for <FreeBSD-gnats-submit@freebsd.org>; Sun, 20 Nov 2005 20:25:24 +0000 (GMT)
	(envelope-from olli@lurza.secnetix.de)
Received: from lurza.secnetix.de (pknwlu@localhost [127.0.0.1])
	by lurza.secnetix.de (8.13.4/8.13.4) with ESMTP id jAKKPN0J078884;
	Sun, 20 Nov 2005 21:25:23 +0100 (CET)
	(envelope-from oliver.fromme@secnetix.de)
Received: (from olli@localhost)
	by lurza.secnetix.de (8.13.4/8.13.1/Submit) id jAKKPNIg078883;
	Sun, 20 Nov 2005 21:25:23 +0100 (CET)
	(envelope-from olli)
Message-Id: <200511202025.jAKKPNIg078883@lurza.secnetix.de>
Date: Sun, 20 Nov 2005 21:25:23 +0100 (CET)
From: Oliver Fromme <olli@secnetix.de>
Reply-To: Oliver Fromme <olli@secnetix.de>
To: FreeBSD-gnats-submit@freebsd.org
Cc: Oliver Fromme <olli@secnetix.de>
Subject: [PATCH] Clarification of kbdmap(5), atkbd(4) and kbdcontrol(1) manpages
X-Send-Pr-Version: 3.113
X-GNATS-Notify:

>Number:         89325
>Category:       docs
>Synopsis:       [patch] Clarification of kbdmap(5), atkbd(4) and kbdcontrol(1) manpages
>Confidential:   no
>Severity:       non-critical
>Priority:       low
>Responsible:    trhodes
>State:          closed
>Quarter:        
>Keywords:       
>Date-Required:  
>Class:          doc-bug
>Submitter-Id:   current-users
>Arrival-Date:   Sun Nov 20 20:30:34 GMT 2005
>Closed-Date:    Sat Jul 21 15:43:55 UTC 2012
>Last-Modified:  Sat Jul 21 15:43:55 UTC 2012
>Originator:     Oliver Fromme
>Release:        FreeBSD 6.0-STABLE i386
>Organization:
secnetix GmbH & Co. KG, Munich Germany
		http://www.secnetix.de/bsd
>Environment:
System: FreeBSD epia.fromme.com 6.0-STABLE FreeBSD 6.0-STABLE #0: Fri Nov  4 21:35:33 CET 2005     olli@epia.fromme.com:/usr/src/sys/i386/compile/EPIA  i386

>Description:

NOTE:  PR has been re-sent because of wrong Reply-To
       address in the previous one!

When I tried to configure my keyboard under syscons so that
I can use Ctrl-Left and Ctrl-Right to jump word-wise left
and right, it turned out that the documentation was somewhat
sub-optimal.  There is no "big picture", and information is
spread across various manual pages, which are sometimes not
even mentioned in the "SEE ALSO" sections.  In fact, I had
to resort to reading kernel sources to find out the number
of function keys that are supported, among other things --
this isn't documented at all.

The small patch below clarifies a few things in the kbdmap(5)
manual page and points people in the right direction who try
to do similar things.

>How-To-Repeat:

man 5 kbdmap

>Fix:

--- src/usr.sbin/kbdcontrol/kbdcontrol.1.orig	Sat Aug  6 16:45:18 2005
+++ src/usr.sbin/kbdcontrol/kbdcontrol.1	Sun Nov 20 20:42:27 2005
@@ -118,6 +118,9 @@
 .Ar keymap_file .
 You may load the keyboard map file from a menu-driven command,
 .Xr kbdmap 1 .
+The format of keyboard map files is documented in the
+.Xr kbdmap 5
+manual page.
 .It Fl d
 Dump the current keyboard map onto stdout.
 The output may be redirected to a file and can be loaded
--- src/usr.sbin/kbdcontrol/kbdmap.5.orig	Sat Aug 21 14:58:09 2004
+++ src/usr.sbin/kbdcontrol/kbdmap.5	Sun Nov 20 20:24:15 2005
@@ -165,7 +165,15 @@
 function key,
 where
 .Ar N
-is a decimal number.
+is a decimal number in the range from 1 to 96.
+Refer to the
+.Xr atkbd 4
+manual page for a list of predefined function keys.
+You can use the
+.Fl f
+option of the 
+.Xr kbdcontrol 1
+utility to assign arbitrary strings to funktion keys.
 .It lshift
 Act as left shift key.
 .It rshift
--- src/share/man/man4/atkbd.4.orig	Thu Dec 16 00:01:45 2004
+++ src/share/man/man4/atkbd.4	Sun Nov 20 20:51:45 2005
@@ -70,6 +70,11 @@
 by the
 .Xr kbdcontrol 1
 command.
+You can use a keyboard map file (see
+.Xr kbdmap 5 )
+to map them to arbitrary keys, particularly
+the functions in the range from 65 to 96
+which are not used by default.
 .Pp
 .Bl -tag -width "Function Key Number" -compact
 .It "Function Key number"
@@ -114,6 +119,8 @@
 Right GUI Key
 .It 64
 Menu
+.It "65, 66,...96"
+free (not used by default)
 .El
 .Pp
 See the man page for the
@@ -209,6 +216,7 @@
 .Xr pcvt 4 ,
 .Xr psm 4 ,
 .Xr syscons 4 ,
+.Xr kbdmap 5 ,
 .Xr loader 8
 .Sh HISTORY
 The

>Release-Note:
>Audit-Trail:
State-Changed-From-To: open->patched 
State-Changed-By: trhodes 
State-Changed-When: Tue Jan 29 18:28:59 UTC 2008 
State-Changed-Why:  
Patched in HEAD with very minor changes.  Thanks for the submission! 


Responsible-Changed-From-To: freebsd-doc->trhodes 
Responsible-Changed-By: trhodes 
Responsible-Changed-When: Tue Jan 29 18:28:59 UTC 2008 
Responsible-Changed-Why:  
Over to me, MFC reminder. 

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

From: dfilter@FreeBSD.ORG (dfilter service)
To: bug-followup@FreeBSD.org
Cc:  
Subject: Re: docs/89325: commit references a PR
Date: Tue, 29 Jan 2008 18:28:57 +0000 (UTC)

 trhodes     2008-01-29 18:28:50 UTC
 
   FreeBSD src repository
 
   Modified files:
     share/man/man4       atkbd.4 
     usr.sbin/kbdcontrol  kbdcontrol.1 kbdmap.5 
   Log:
   Some clarifications to make keyboard configuration under syscons.
   
   PR:             89325
   Submitted by:   Oliver Fromme <olli@secnetix.de>
   Reviewed by:    emax
   
   Revision  Changes    Path
   1.29      +9 -1      src/share/man/man4/atkbd.4
   1.43      +4 -1      src/usr.sbin/kbdcontrol/kbdcontrol.1
   1.8       +10 -2     src/usr.sbin/kbdcontrol/kbdmap.5
 _______________________________________________
 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"
 
State-Changed-From-To: patched->closed 
State-Changed-By: trhodes 
State-Changed-When: Sat Jul 21 15:43:34 UTC 2012 
State-Changed-Why:  
Changes have been merged for awhile now, thanks. 

http://www.freebsd.org/cgi/query-pr.cgi?pr=89325 
>Unformatted:
