usr.sbin/pcvt/keycap/man5/keycap.5

   1 .\"
   2 .\" Copyright (c) 1992,1993,1994 Hellmuth Michaelis
   3 .\"
   4 .\" Copyright (c) 1990 The Regents of the University of California.
   5 .\"
   6 .\" All rights reserved.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. All advertising materials mentioning features or use of this software
  17 .\"    must display the following acknowledgement:
  18 .\"     This product includes software developed by the University of
  19 .\"     California, Berkeley and its contributors.
  20 .\" 4. Neither the name of the University nor the names of its contributors
  21 .\"    may be used to endorse or promote products derived from this software
  22 .\"    without specific prior written permission.
  23 .\"
  24 .\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND
  25 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  26 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  27 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE
  28 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  29 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  30 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  31 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  32 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  33 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  34 .\" SUCH DAMAGE.
  35 .\"
  36 .\" @(#)keycap.5, 3.00, Last Edit-Date: [Sun Jan  2 13:45:59 1994]
  37 .\" $FreeBSD: src/usr.sbin/pcvt/keycap/man5/keycap.5,v 1.9.2.7 2003/03/11 22:31:30 trhodes Exp $
  38 .\" $DragonFly: src/usr.sbin/pcvt/keycap/man5/Attic/keycap.5,v 1.2 2003/06/17 04:29:59 dillon Exp $
  39 .\"
  40 .Dd January 3, 1993
  41 .Dt KEYCAP 5
  42 .Os
  43 .Sh NAME
  44 .Nm keycap
  45 .Nd keyboard mapping data base
  46 .Sh SYNOPSIS
  47 .Nm
  48 .Sh DESCRIPTION
  49 The
  50 .Nm
  51 file
  52 is a data base describing keyboard mappings, used by
  53 .Xr kcon 1 .
  54 .Pp
  55 Entries in
  56 .Nm
  57 consist of a number of `:'-separated fields.
  58 The first entry for each mapping gives the names that are known for the
  59 mapping, separated by `|' characters.
  60 All names but the first and last
  61 should be in lower case and contain no blanks;
  62 the last name may well contain
  63 upper case and blanks for readability.
  64 .Sh CAPABILITIES
  65 .Bl -column indent indent
  66 .Sy "Name       Type    Description
  67 .It "de bool    Resets Keyboard mapping to compiled-in default"
  68 .It "D<n>       bool    Disables key <n> completely"
  69 .It "
  70 .It "m<n>       num     specify key numbers for ALT keys
  71 .It "l<n>       num     specify key numbers for ALTGR keys
  72 .It "h<n>       num     specify key numbers for SHIFT keys
  73 .It "t<n>       num     specify key numbers for CONTROL keys
  74 .It "ca<n>      num     specify key number for the CAPS LOCK key
  75 .It "sh<n>      num     specify key number for the SHIFT LOCK key
  76 .It "nl<n>      num     specify key number for the NUM LOCK key
  77 .It "sc<n>      num     specify key number for the SCROLL LOCK key
  78 .It "
  79 .It "K<n>       str     bind a string to an unshifted (normal) key
  80 .It "S<n>       str     bind a string to a shifted key
  81 .It "C<n>       str     bind a string to a control key
  82 .It "A<n>       str     bind a string to an altgr key
  83 .It "
  84 .It "tc str     Entry of similar map \- must be last."
  85 .El
  86 .Pp
  87 Parameter <n> describing the key number can have values from 1 to 128.
  88 .Pp
  89 A string parameter may have up to 15 characters.
  90 .Pp
  91 .Ss A Sample Entry
  92 The following entry, which describes a test entry, is among the very
  93 easy entries in the
  94 .Nm
  95 file as of this writing.
  96 .Pp
  97 .Bd -literal
  98 tt\||test\||Test entry which swaps y and z:\e
  99         :K22=z:S22=Z:C22=\e032:\e
 100         :K46=y:S46=Y:C46=\e031:
 101 .Ed
 102 .Pp
 103 Entries may continue onto multiple lines by giving a \e as the last
 104 character of a line.
 105 Comments may be included on lines beginning with
 106 .Dq # .
 107 .Sh FILES
 108 .Bl -tag -width /usr/share/misc/keycap.pcvt -compact
 109 .It Pa /usr/share/misc/keycap.pcvt
 110 File containing keyboard mapping descriptions.
 111 .El
 112 .Sh SEE ALSO
 113 .Xr kcon 1 ,
 114 .Xr keycap 3
 115 .Sh EXAMPLES
 116 The entry
 117 .Dq Li l1#60
 118 sets the keynumber for the ALTGR key to 60.
 119 .Pp
 120 The entry
 121 .Dq Li K100=hugo
 122 binds the string 'hugo' to the key number 100.
 123 .Pp
 124 The entry
 125 .Dq Li K100=^D
 126 binds the control character EOT (0x04) to the key number 100.
 127 .Pp
 128 The entry
 129 .Dq Li K100=\e000
 130 binds the control character NUL (0x00) to the key number 100.