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