usr.sbin/pcvt/keycap/keycap.3

   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.3, 3.00, Last Edit-Date: [Sun Jan  2 13:46:43 1994]
  37 .\" $FreeBSD: src/usr.sbin/pcvt/keycap/keycap.3,v 1.8.2.3 2001/08/16 15:56:13 ru Exp $
  38 .\"
  39 .Dd January 3, 1993
  40 .Dt KEYCAP 3
  41 .Os
  42 .Sh NAME
  43 .Nm kgetent ,
  44 .Nm kgetnum ,
  45 .Nm kgetflag ,
  46 .Nm kgetstr
  47 .Nd routines for accessing the keycap database
  48 .Sh SYNOPSIS
  49 .Ft int
  50 .Fn kgetent "char *bp" "char *name"
  51 .Ft int
  52 .Fn kgetnum "char *id"
  53 .Ft int
  54 .Fn kgetflag "char *id"
  55 .Ft char *
  56 .Fn kgetstr "char *id" "char **area"
  57 .Sh DESCRIPTION
  58 These functions extract and use capabilities from a keyboard capability data
  59 base, usually
  60 .Pa /usr/share/misc/keycap.pcvt ,
  61 the format of which is described in
  62 .Xr keycap 5 .
  63 .Pp
  64 The
  65 .Fn kgetent
  66 function
  67 extracts the entry for keyboard mapping
  68 .Fa name
  69 into the buffer at
  70 .Fa bp .
  71 The
  72 .Fa bp
  73 argument
  74 should be a character buffer of size
  75 1024 and must be retained through all subsequent calls to
  76 .Fn kgetnum ,
  77 .Fn kgetflag ,
  78 and
  79 .Fn kgetstr .
  80 The
  81 .Fn kgetent
  82 function
  83 returns \-1 if none of the
  84 .Nm keycap
  85 data base files could be opened,
  86 0 if the map name given does not have an entry,
  87 and 1 if all goes well.
  88 .Pp
  89 The
  90 .Fn kgetnum
  91 function
  92 gets the numeric value of capability
  93 .Fa id ,
  94 returning \-1 if is not given for the map.
  95 .Pp
  96 The
  97 .Fn kgetflag
  98 function
  99 returns 1 if the specified capability is present in
 100 the map's entry, 0 if it is not.
 101 .Pp
 102 The
 103 .Fn kgetstr
 104 function
 105 returns the string value of the capability
 106 .Fa id ,
 107 places it in the buffer at
 108 .Fa area ,
 109 and advances the
 110 .Fa area
 111 pointer.
 112 The
 113 .Fn kgetstr
 114 function
 115 returns
 116 .Dv NULL
 117 if the capability was not found.
 118 .Sh FILES
 119 .Bl -tag -width /usr/share/misc/keycap.pcvt -compact
 120 .It Pa /usr/share/misc/keycap.pcvt
 121 Keyboard capabilities database (if nothing else chosen during installation).
 122 .El
 123 .Sh SEE ALSO
 124 .Xr kcon 1 ,
 125 .Xr keycap 5