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$
  38 .\"
  39 .Dd January 3, 1993
  40 .Dt KEYCAP 5
  41 .Sh NAME
  42 .Nm keycap
  43 .Nd keyboard mapping data base
  44 .Sh SYNOPSIS
  45 .Nm keycap
  46 .Sh DESCRIPTION
  47 The
  48 .Nm keycap
  49 file
  50 is a data base describing keyboard mappings, used by
  51 .Xr kcon 1 .
  52 .Pp
  53 Entries in
  54 .Nm keycap
  55 consist of a number of `:'-separated fields.
  56 The first entry for each mapping gives the names that are known for the
  57 mapping, separated by `|' characters.
  58 All names but the first and last
  59 should be in lower case and contain no blanks;
  60 the last name may well contain
  61 upper case and blanks for readability.
  62 .Sh CAPABILITIES
  63 .Pp
  64 .Bl -column indent indent
  65 .Sy Name        Type    Description
  66 .It "de bool    Resets Keyboard mapping to compiled-in default"
  67 .It "D<n>       bool    Disables key <n> completely"
  68
  69 .It "m<n>       num     specify key numbers for ALT keys
  70 .It "l<n>       num     specify key numbers for ALTGR keys
  71 .It "h<n>       num     specify key numbers for SHIFT keys
  72 .It "t<n>       num     specify key numbers for CONTROL keys
  73 .It "ca<n>      num     specify key number for the CAPS LOCK key
  74 .It "sh<n>      num     specify key number for the SHIFT LOCK key
  75 .It "nl<n>      num     specify key number for the NUM LOCK key
  76 .It "sc<n>      num     specify key number for the SCROLL LOCK key
  77
  78 .It "K<n>       str     bind a string to a unshifted (normal) key
  79 .It "S<n>       str     bind a string to a shifted key
  80 .It "C<n>       str     bind a string to a control key
  81 .It "A<n>       str     bind a string to a altgr key
  82
  83 .It "tc str     Entry of similar map \- must be last."
  84 .El
  85
  86 Parameter <n> describing the key number can have values from 1 to 128.
  87
  88 A string parameter may have up to 15 characters.
  89
  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 keycap
  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
 102 .Ed
 103 .Pp
 104 Entries may continue onto multiple lines by giving a \e as the last
 105 character of a line.
 106 Comments may be included on lines beginning with
 107 .Dq # .
 108 .Sh FILES
 109 .Bl -tag -width /usr/share/misc/keycap.pcvt -compact
 110 .It Pa /usr/share/misc/keycap.pcvt
 111 File containing keyboard mapping descriptions.
 112 .El
 113 .Sh SEE ALSO
 114 .Xr kcon 1 ,
 115 .Xr keycap 3
 116 .Sh EXAMPLES
 117 The entry
 118 .Dq Li l1#60
 119 sets the keynumber for the ALTGR key to 60.
 120
 121 The entry
 122 .Dq Li K100=hugo
 123 binds the string 'hugo' to the key number 100.
 124
 125 The entry
 126 .Dq Li K100=^D
 127 binds the control character EOT (0x04) to the key number 100.
 128
 129 The entry
 130 .Dq Li K100=\e000
 131 binds the control character NUL (0x00) to the key number 100.