2 .\" Copyright (c) 1992,1993,1994 Hellmuth Michaelis
4 .\" Copyright (c) 1990 The Regents of the University of California.
6 .\" All rights reserved.
8 .\" Redistribution and use in source and binary forms, with or without
9 .\" modification, are permitted provided that the following conditions
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.
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
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 $
47 .Nd routines for accessing the keycap database
50 .Fn kgetent "char *bp" "char *name"
52 .Fn kgetnum "char *id"
54 .Fn kgetflag "char *id"
56 .Fn kgetstr "char *id" "char **area"
58 These functions extract and use capabilities from a keyboard capability data
60 .Pa /usr/share/misc/keycap.pcvt ,
61 the format of which is described in
67 extracts the entry for keyboard mapping
74 should be a character buffer of size
75 1024 and must be retained through all subsequent calls to
83 returns \-1 if none of the
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.
92 gets the numeric value of capability
94 returning \-1 if is not given for the map.
99 returns 1 if the specified capability is present in
100 the map's entry, 0 if it is not.
105 returns the string value of the capability
107 places it in the buffer at
117 if the capability was not found.
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).