diff options
author | jkh <jkh@FreeBSD.org> | 1995-02-05 13:49:25 +0000 |
---|---|---|
committer | jkh <jkh@FreeBSD.org> | 1995-02-05 13:49:25 +0000 |
commit | 839ad527396286b846e58e11836f9091ceccc6d9 (patch) | |
tree | 50f3988ee320fe96b2fce23c40e51b297dbe8754 /usr.sbin/pcvt/keycap/keycap.3 | |
parent | 8e4f208589200093617b1a41bc21915a81e2751b (diff) | |
download | FreeBSD-src-839ad527396286b846e58e11836f9091ceccc6d9.zip FreeBSD-src-839ad527396286b846e58e11836f9091ceccc6d9.tar.gz |
PCVT userland utilities.
Submitted by: hm
Diffstat (limited to 'usr.sbin/pcvt/keycap/keycap.3')
-rw-r--r-- | usr.sbin/pcvt/keycap/keycap.3 | 121 |
1 files changed, 121 insertions, 0 deletions
diff --git a/usr.sbin/pcvt/keycap/keycap.3 b/usr.sbin/pcvt/keycap/keycap.3 new file mode 100644 index 0000000..7eb59dc --- /dev/null +++ b/usr.sbin/pcvt/keycap/keycap.3 @@ -0,0 +1,121 @@ +.\" +.\" Copyright (c) 1992,1993,1994 Hellmuth Michaelis +.\" +.\" Copyright (c) 1990 The Regents of the University of California. +.\" +.\" All rights reserved. +.\" +.\" Redistribution and use in source and binary forms, with or without +.\" modification, are permitted provided that the following conditions +.\" are met: +.\" 1. Redistributions of source code must retain the above copyright +.\" notice, this list of conditions and the following disclaimer. +.\" 2. Redistributions in binary form must reproduce the above copyright +.\" notice, this list of conditions and the following disclaimer in the +.\" documentation and/or other materials provided with the distribution. +.\" 3. All advertising materials mentioning features or use of this software +.\" must display the following acknowledgement: +.\" This product includes software developed by the University of +.\" California, Berkeley and its contributors. +.\" 4. Neither the name of the University nor the names of its contributors +.\" may be used to endorse or promote products derived from this software +.\" without specific prior written permission. +.\" +.\" THIS SOFTWARE IS PROVIDED BY THE REGENTS AND CONTRIBUTORS ``AS IS'' AND +.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE +.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE +.\" ARE DISCLAIMED. IN NO EVENT SHALL THE REGENTS OR CONTRIBUTORS BE LIABLE +.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL +.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS +.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) +.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT +.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY +.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF +.\" SUCH DAMAGE. +.\" +.\" @(#)keycap.3, 3.00, Last Edit-Date: [Sun Jan 2 13:46:43 1994] +.\" +.Dd January 3, 1993 +.Dt KEYCAP 3 +.Sh NAME +.Nm kgetent , +.Nm kgetnum , +.Nm kgetflag , +.Nm kgetstr +.Nd routines for accessing the keycap database +.Sh SYNOPSIS +.Fn kgetent "char *bp" "char *name" +.Fn kgetnum "char *id" +.Fn kgetflag "char *id" +.Ft char * +.Fn kgetstr "char *id" "char *area" +.Sh DESCRIPTION +These functions extract and use capabilities from a keyboard capability data +base, usually +.Pa /usr/share/misc/keycap , +the format of which is described in +.Xr keycap 5 . +.Pp +The +.Fn kgetent +function +extracts the entry for keyboard mapping +.Fa name +into the buffer at +.Fa bp . +The +.Fa bp +argument +should be a character buffer of size +1024 and must be retained through all subsequent calls to +.Fn kgetnum , +.Fn kgetflag , +and +.Fn kgetstr . +The +.Fn kgetent +function +returns \-1 if none of the +.Nm keycap +data base files could be opened, +0 if the map name given does not have an entry, +and 1 if all goes well. +.Pp +The +.Fn kgetnum +function +gets the numeric value of capability +.Fa id , +returning \-1 if is not given for the map. +.Pp +The +.Fn kgetflag +function +returns 1 if the specified capability is present in +the map's entry, 0 if it is not. +.Pp +The +.Fn kgetstr +function +returns the string value of the capability +.Fa id , +places it in the buffer at +.Fa area , +and advances the +.Fa area +pointer. +The +.Fn kgetstr +function +returns +.Dv NULL +if the capability was not found. +.Pp +.Sh FILES +.Bl -tag -width /usr/share/misc/keycap -compact +.It Pa /usr/share/misc/keycap +Keyboard capabilities database (if nothing else chosen during installation). +.El +.Sh SEE ALSO +.Xr kcon 1 , +.Xr keycap 5 |