77 lines
2.4 KiB
Groff
77 lines
2.4 KiB
Groff
.\" Copyright (c) 1999 - Sun Microsystems, Inc.
|
|
.\" All rights reserved.
|
|
.\"
|
|
.\" Permission is hereby granted, free of charge, to any person obtaining a
|
|
.\" copy of this software and associated documentation files (the
|
|
.\" "Software"), to deal in the Software without restriction, including
|
|
.\" without limitation the rights to use, copy, modify, merge, publish,
|
|
.\" distribute, and/or sell copies of the Software, and to permit persons
|
|
.\" to whom the Software is furnished to do so, provided that the above
|
|
.\" copyright notice(s) and this permission notice appear in all copies of
|
|
.\" the Software and that both the above copyright notice(s) and this
|
|
.\" permission notice appear in supporting documentation.
|
|
.\"
|
|
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
|
|
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
|
|
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
|
|
.\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
|
|
.\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
|
|
.\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
|
|
.\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
|
|
.\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
|
|
.\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
|
|
.\"
|
|
.\" Except as contained in this notice, the name of a copyright holder
|
|
.\" shall not be used in advertising or otherwise to promote the sale, use
|
|
.\" or other dealings in this Software without prior written authorization
|
|
.\" of the copyright holder.
|
|
.\"
|
|
.TH XkbFreeKeyboard __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
|
|
.SH NAME
|
|
XkbFreeKeyboard \- Destroys either an entire XkbDescRec or just some of its
|
|
members
|
|
.SH SYNOPSIS
|
|
.B void XkbFreeKeyboard
|
|
(
|
|
.I xkb,
|
|
.I which,
|
|
.I free_all
|
|
)
|
|
.br
|
|
XkbDescPtr \fIxkb\fP\^;
|
|
.br
|
|
unsigned int \fIwhich\fP\^;
|
|
.br
|
|
Bool \fIfree_all\fP\^;
|
|
.if n .ti +5n
|
|
.if t .ti +.5i
|
|
.SH ARGUMENTS
|
|
.TP
|
|
.I xkb
|
|
keyboard description with components to free
|
|
.TP
|
|
.I which
|
|
mask selecting components to free
|
|
.TP
|
|
.I free_all
|
|
True => free all components and
|
|
.I xkb
|
|
.SH DESCRIPTION
|
|
.LP
|
|
.I XkbFreeKeyboard
|
|
frees the components of
|
|
.I xkb
|
|
specified by
|
|
.I which
|
|
and sets the corresponding values to NULL. If
|
|
.I
|
|
free_all
|
|
is True,
|
|
.I XkbFreeKeyboard
|
|
frees every non-NULL component of
|
|
.I xkb
|
|
and then frees the
|
|
.I xkb
|
|
structure itself.
|
|
|