sync code with last improvements from OpenBSD
This commit is contained in:
commit
88965415ff
GPG key ID:
F42C07F07E2E35B7
26235 changed files with 29195616 additions and 0 deletions
178
lib/libX11/man/xkb/XkbChangeNames.man
Normal file
178
lib/libX11/man/xkb/XkbChangeNames.man
Normal file
|
|
@ -0,0 +1,178 @@
|
|||
'\" t
|
||||
.\" Copyright 1999 Oracle and/or its affiliates. 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, sublicense,
|
||||
.\" and/or sell copies of the Software, and to permit persons to whom the
|
||||
.\" Software is furnished to do so, subject to the following conditions:
|
||||
.\"
|
||||
.\" The above copyright notice and this permission notice (including the next
|
||||
.\" paragraph) shall be included in all copies or substantial portions of the
|
||||
.\" Software.
|
||||
.\"
|
||||
.\" 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. IN NO EVENT SHALL
|
||||
.\" THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
|
||||
.\" LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
|
||||
.\" FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
|
||||
.\" DEALINGS IN THE SOFTWARE.
|
||||
.\"
|
||||
.TH XkbChangeNames __libmansuffix__ __xorgversion__ "XKB FUNCTIONS"
|
||||
.SH NAME
|
||||
XkbChangeNames \- _summary-line_
|
||||
.SH SYNOPSIS
|
||||
.HP
|
||||
.B Bool XkbChangeNames
|
||||
.BI "(\^Display *" "dpy" "\^,"
|
||||
.BI "unsigned int " "which" "\^,"
|
||||
.BI "XkbDescPtr " "Xkb" "\^);"
|
||||
.if n .ti +5n
|
||||
.if t .ti +.5i
|
||||
.SH ARGUMENTS
|
||||
.TP
|
||||
.I \- dpy
|
||||
connection to the X server
|
||||
.TP
|
||||
.I \- which
|
||||
mask of names or map components to be updated
|
||||
.TP
|
||||
.I \- Xkb
|
||||
keyboard description to be updated
|
||||
.SH DESCRIPTION
|
||||
.LP
|
||||
.I XkbChangeNames
|
||||
provides a more flexible method for changing symbolic names than
|
||||
.I XkbSetNames
|
||||
and requires the use of an XkbNameChangesRec structure.
|
||||
|
||||
.I XkbChangeNames
|
||||
copies any names specified by
|
||||
.I changes
|
||||
from the keyboard description,
|
||||
.I xkb,
|
||||
to the X server specified by
|
||||
.I dpy. XkbChangeNames
|
||||
aborts and returns False if any illegal type names or type shift level names are
|
||||
specified by changes.
|
||||
|
||||
To change the symbolic names in the server, first modify a local copy of the
|
||||
keyboard description and then use either
|
||||
.I XkbSetNames,
|
||||
or, to save network traffic, use a XkbNameChangesRec structure and call
|
||||
.I XkbChangeNames
|
||||
to download the changes to the server.
|
||||
.I XkbSetNames
|
||||
and
|
||||
.I XkbChangeNames
|
||||
can generate BadAlloc, BadAtom, BadLength, BadMatch, and BadImplementation
|
||||
errors.
|
||||
.SH STRUCTURES
|
||||
.LP
|
||||
The XkbNameChangesRec allows applications to identify small modifications to the
|
||||
symbolic names and
|
||||
effectively reduces the amount of traffic sent to the server:
|
||||
.nf
|
||||
|
||||
typedef struct _XkbNameChanges {
|
||||
unsigned int changed; /\&* name components that have changed */
|
||||
unsigned char first_type; /\&* first key type with a new name */
|
||||
unsigned char num_types; /\&* number of types with new names */
|
||||
unsigned char first_lvl; /\&* first key type with new level names */
|
||||
unsigned char num_lvls; /\&* number of key types with new level names */
|
||||
unsigned char num_aliases; /\&* if key aliases changed, total number of key aliases */
|
||||
unsigned char num_rg; /\&* if radio groups changed, total number of radio groups */
|
||||
unsigned char first_key; /\&* first key with a new name */
|
||||
unsigned char num_keys; /\&* number of keys with new names */
|
||||
unsigned short changed_vmods; /\&* mask of virtual modifiers for which names have changed */
|
||||
unsigned long changed_indicators; /\&* mask of indicators for which names were changed */
|
||||
unsigned char changed_groups; /\&* mask of groups for which names were changed */
|
||||
} XkbNameChangesRec, *XkbNameChangesPtr
|
||||
|
||||
.fi
|
||||
The
|
||||
.I changed
|
||||
field specifies the name components that have changed and is the bitwise
|
||||
inclusive OR of the valid names
|
||||
mask bits defined in Table 1. The rest of the fields in the structure specify
|
||||
the ranges that have changed
|
||||
for the various kinds of symbolic names, as shown in Table 2.
|
||||
|
||||
Xkb provides several functions that work with symbolic names. Each of these
|
||||
functions uses a mask to
|
||||
specify individual fields of the structures described above. These masks and
|
||||
their relationships to the
|
||||
fields in a keyboard description are shown in Table 1.
|
||||
|
||||
.TS
|
||||
c s s s
|
||||
l l l l.
|
||||
Table 1 Symbolic Names Masks
|
||||
_
|
||||
Mask Bit Value Keyboard Field
|
||||
Component
|
||||
_
|
||||
XkbKeycodesNameMask (1<<0) Xkb->names keycodes
|
||||
XkbGeometryNameMask (1<<1) Xkb->names geometry
|
||||
XkbSymbolsNameMask (1<<2) Xkb->names symbols
|
||||
XkbPhysSymbolsNameMask (1<<3) Xkb->names phys_symbols
|
||||
XkbTypesNameMask (1<<4) Xkb->names type
|
||||
XkbCompatNameMask (1<<5) Xkb->names compat
|
||||
XkbKeyTypeNamesMask (1<<6) Xkb->map type[*].name
|
||||
XkbKTLevelNamesMask (1<<7) Xkb->map type[*].lvl_names[*]
|
||||
XkbIndicatorNamesMask (1<<8) Xkb->names indicators[*]
|
||||
XkbKeyNamesMask (1<<9) Xkb->names keys[*], num_keys
|
||||
XkbKeyAliasesMask (1<<10) Xkb->names key_aliases[*], num_key_aliases
|
||||
XkbVirtualModNamesMask (1<<11) Xkb->names vmods[*]
|
||||
XkbGroupNamesMask (1<<12) Xkb->names groups[*]
|
||||
XkbRGNamesMask (1<<13) Xkb->names radio_groups[*], num_rg
|
||||
XkbComponentNamesMask (0x3f) Xkb->names keycodes,
|
||||
geometry,
|
||||
symbols,
|
||||
physical symbols,
|
||||
types, and
|
||||
compatibility map
|
||||
XkbAllNamesMask (0x3fff) Xkb->names all name components
|
||||
.TE
|
||||
|
||||
.TS
|
||||
c s s s
|
||||
l l l l.
|
||||
Table 2 XkbNameChanges Fields
|
||||
_
|
||||
Mask Fields Component Field
|
||||
_
|
||||
XkbKeyTypeNamesMask first_type, Xkb->map type[*].name
|
||||
num_types
|
||||
XkbKTLevelNamesMask first_lvl, Xkb->map type[*].lvl_names[*]
|
||||
num_lvls
|
||||
XkbKeyAliasesMask num_aliases Xkb->names key_aliases[*]
|
||||
XkbRGNamesMask num_rg Xkb->names radio_groups[*]
|
||||
XkbKeyNamesMask first_key, Xkb->names keys[*]
|
||||
num_keys
|
||||
XkbVirtualModNamesMask changed_vmods Xkb->names vmods[*]
|
||||
XkbIndicatorNamesMask changed_indicators Xkb->names indicators[*]
|
||||
XkbGroupNamesMask changed_groups Xkb->names groups[*]
|
||||
.TE
|
||||
.SH DIAGNOSTICS
|
||||
.TP 15
|
||||
.B BadAlloc
|
||||
Unable to allocate storage
|
||||
.TP 15
|
||||
.B BadAtom
|
||||
A name is neither a valid Atom or None
|
||||
.TP 15
|
||||
.B BadImplementation
|
||||
Invalid reply from server
|
||||
.TP 15
|
||||
.B BadLength
|
||||
The length of a request is shorter or longer than that required to minimally
|
||||
contain the arguments
|
||||
.TP 15
|
||||
.B BadMatch
|
||||
A compatible version of Xkb was not available in the server or an argument has
|
||||
correct type and range, but is otherwise invalid
|
||||
.SH "SEE ALSO"
|
||||
.BR XkbSetNames (__libmansuffix__)
|
||||
Loading…
Add table
Add a link
Reference in a new issue