specs/XKB: Convert to funcsynopsis+variablelist instead of informaltable

Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
This commit is contained in:
Alan Coopersmith 2014-07-06 15:57:41 -07:00
parent b41d43d4cf
commit b16ee69a01
19 changed files with 9393 additions and 8033 deletions

View file

@ -92,39 +92,42 @@ version of the library, although this should not normally occur.)
To determine the compatibility of a library at runtime, call <emphasis>
XkbLibraryVersion</emphasis>.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbLibraryVersion</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbLibraryVersion"><primary><function>XkbLibraryVersion</function></primary></indexterm>
<funcsynopsis id="XkbLibraryVersion">
<funcprototype>
<funcdef>Bool <function>XkbLibraryVersion</function></funcdef>
<!-- (<emphasis>
lib_major_in_out</emphasis>
, <emphasis>
lib_minor_in_out</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
int * <emphasis>
lib_major_in_out;</emphasis>
/* specifies and returns the major Xkb library version. */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int * <emphasis>
lib_minor_in_out;</emphasis>
/* specifies and returns the minor Xkb library version. */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>int *<parameter>lib_major_in_out</parameter></paramdef>
<paramdef>int *<parameter>lib_minor_in_out</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>lib_major_in_out</parameter>
</term>
<listitem>
<para>
specifies and returns the major Xkb library version.
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>lib_minor_in_out</parameter>
</term>
<listitem>
<para>
specifies and returns the minor Xkb library version.
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
Pass the symbolic value <emphasis>
@ -201,65 +204,84 @@ XkbQueryExtension</emphasis>
and initializes the extension when it is present.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbQueryExtension</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbQueryExtension"><primary><function>XkbQueryExtension</function></primary></indexterm>
<funcsynopsis id="XkbQueryExtension">
<funcprototype>
<funcdef>Bool <function>XkbQueryExtension</function></funcdef>
<!-- (<emphasis>
dpy, opcode_rtrn, event_rtrn, error_rtrn, major_in_out, minor_in_out</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
dpy; </emphasis>
/* connection to the X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int * <emphasis>
opcode_rtrn</emphasis>
; /* backfilled with the major extension opcode */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int * <emphasis>
event_rtrn</emphasis>
; /* backfilled with the extension base event code */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int * <emphasis>
error_rtrn</emphasis>
; /* backfilled with the extension base error code */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int * <emphasis>
major_in_out</emphasis>
; /* compile time lib major version in, server major version out */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int * <emphasis>
minor_in_out; </emphasis>
/* compile time lib min version in, server minor version out */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
<paramdef>int *<parameter>opcode_rtrn</parameter></paramdef>
<paramdef>int *<parameter>event_rtrn</parameter></paramdef>
<paramdef>int *<parameter>error_rtrn</parameter></paramdef>
<paramdef>int *<parameter>major_in_out</parameter></paramdef>
<paramdef>int *<parameter>minor_in_out</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>dpy</parameter>
</term>
<listitem>
<para>
connection to the X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>opcode_rtrn</parameter>
</term>
<listitem>
<para>
backfilled with the major extension opcode
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>event_rtrn</parameter>
</term>
<listitem>
<para>
backfilled with the extension base event code
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>error_rtrn</parameter>
</term>
<listitem>
<para>
backfilled with the extension base error code
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>major_in_out</parameter>
</term>
<listitem>
<para>
compile time lib major version in, server major version out
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>minor_in_out</parameter>
</term>
<listitem>
<para>
compile time lib min version in, server minor version out
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The <emphasis>
@ -304,66 +326,85 @@ for a compatible version of the Xkb extension in both the library and the
server, and initialize the extension for use.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Display *<emphasis>
XkbOpenDisplay</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbOpenDisplay"><primary><function>XkbOpenDisplay</function></primary></indexterm>
<funcsynopsis id="XkbOpenDisplay">
<funcprototype>
<funcdef>Display *<function>XkbOpenDisplay</function></funcdef>
<!-- (<emphasis>
display_name, event_rtrn, error_rtrn, major_in_out, minor_in_out,
reason_rtrn)</emphasis>
</entry>
</row>
<row>
<entry role='functionargdecl'>
char * <emphasis>
display_name</emphasis>
; /* hardware display name, which determines the display and
communications domain to be used */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int * <emphasis>
event_rtrn</emphasis>
; /* backfilled with the extension base event code */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int * <emphasis>
error_rtrn</emphasis>
; /* backfilled with the extension base error code */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int * <emphasis>
major_in_out</emphasis>
; /* compile time lib major version in, server major version out */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int * <emphasis>
minor_in_out</emphasis>
; /* compile time lib minor version in, server minor version out */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int * <emphasis>
reason_rtrn</emphasis>
; /* backfilled with a status code */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
reason_rtrn)</emphasis> -->
<paramdef>char *<parameter>display_name</parameter></paramdef>
<paramdef>int *<parameter>event_rtrn</parameter></paramdef>
<paramdef>int *<parameter>error_rtrn</parameter></paramdef>
<paramdef>int *<parameter>major_in_out</parameter></paramdef>
<paramdef>int *<parameter>minor_in_out</parameter></paramdef>
<paramdef>int *<parameter>reason_rtrn</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display_name</parameter>
</term>
<listitem>
<para>
hardware display name, which determines the display and
communications domain to be used
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>event_rtrn</parameter>
</term>
<listitem>
<para>
backfilled with the extension base event code
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>error_rtrn</parameter>
</term>
<listitem>
<para>
backfilled with the extension base error code
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>major_in_out</parameter>
</term>
<listitem>
<para>
compile time lib major version in, server major version out
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>minor_in_out</parameter>
</term>
<listitem>
<para>
compile time lib minor version in, server minor version out
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>reason_rtrn</parameter>
</term>
<listitem>
<para>
backfilled with a status code
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -493,32 +534,29 @@ XkbIgnoreExtension</emphasis>
disable use of the extension once a connection is established.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool<emphasis>
XkbIgnoreExtension</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbIgnoreExtension"><primary><function>XkbIgnoreExtension</function></primary></indexterm>
<funcsynopsis id="XkbIgnoreExtension">
<funcprototype>
<funcdef>Bool <function>XkbIgnoreExtension</function></funcdef>
<!-- (<emphasis>
ignore</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Bool <emphasis>
ignore</emphasis>
; /* <emphasis>
True</emphasis>
means ignore the extension */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Bool <parameter>ignore</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>ignore</parameter>
</term>
<listitem>
<para>
<emphasis>True</emphasis> means ignore the extension
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>

View file

@ -388,55 +388,62 @@ XkbSelectEvents</emphasis>
.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbSelectEvents</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbSelectEvents"><primary><function>XkbSelectEvents</function></primary></indexterm>
<funcsynopsis id="XkbSelectEvents">
<funcprototype>
<funcdef>Bool <function>XkbSelectEvents</function></funcdef>
<!-- (<emphasis>
display, device_spec, bits_to_change, values_for_bits</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
display</emphasis>
; /* connection to the X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
device_spec</emphasis>
; /* device ID, or <emphasis>
XkbUseCoreKbd</emphasis>
*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned long int <emphasis>
bits_to_change; </emphasis>
/* determines events to be selected / deselected */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned long int <emphasis>
values_for_bits</emphasis>
; /* 1=&gt;select, 0-&gt;deselect; for events in <emphasis>
bits_to_change</emphasis>
*/
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
<paramdef>unsigned long int <parameter>bits_to_change</parameter></paramdef>
<paramdef>unsigned long int <parameter>values_for_bits</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to the X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>device_spec</parameter>
</term>
<listitem>
<para>
device ID, or <emphasis>XkbUseCoreKbd</emphasis>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>bits_to_change</parameter>
</term>
<listitem>
<para>
determines events to be selected / deselected
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>values_for_bits</parameter>
</term>
<listitem>
<para>
1=&gt;select, 0-&gt;deselect; for events in <parameter>bits_to_change</parameter>
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
This request changes the Xkb event selection mask for the keyboard specified by
@ -518,64 +525,75 @@ XkbSelectEvents</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbSelectEventDetails</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbSelectEventDetails"><primary><function>XkbSelectEventDetails</function></primary></indexterm>
<funcsynopsis id="XkbSelectEventDetails">
<funcprototype>
<funcdef>Bool <function>XkbSelectEventDetails</function></funcdef>
<!-- (<emphasis>
display, device_spec, event_type, bits_to_change</emphasis>
, <emphasis>
values_for_bits</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
display</emphasis>
; /* connection to the X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
device_spec</emphasis>
; /* device ID, or <emphasis>
XkbUseCoreKbd</emphasis>
*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
event_type</emphasis>
; /* Xkb event type of interest */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned long int <emphasis>
bits_to_change</emphasis>
; /* event selection details */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned long int <emphasis>
values_for_bits</emphasis>
; /* values for bits selected by <emphasis>
bits_to_change</emphasis>
*/
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
<paramdef>unsigned int <parameter>event_type</parameter></paramdef>
<paramdef>unsigned long int <parameter>bits_to_change</parameter></paramdef>
<paramdef>unsigned long int <parameter>values_for_bits</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to the X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>device_spec</parameter>
</term>
<listitem>
<para>
device ID, or <emphasis>XkbUseCoreKbd</emphasis>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>event_type</parameter>
</term>
<listitem>
<para>
Xkb event type of interest
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>bits_to_change</parameter>
</term>
<listitem>
<para>
event selection details
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>values_for_bits</parameter>
</term>
<listitem>
<para>
values for bits selected by <parameter>bits_to_change</parameter>
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
While <emphasis>

View file

@ -348,54 +348,62 @@ To lock and unlock any of the eight real keyboard modifiers, use <emphasis>
XkbLockModifiers:</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis> XkbLockModifiers</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbLockModifiers"><primary><function>XkbLockModifiers</function></primary></indexterm>
<funcsynopsis id="XkbLockModifiers">
<funcprototype>
<funcdef>Bool <function>XkbLockModifiers</function></funcdef>
<!-- (<emphasis>
display, device_spec, affect, values</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
display</emphasis>
; /* connection to the X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
device_spec</emphasis>
; /* device ID, or <emphasis>
XkbUseCoreKbd</emphasis>
*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
affect</emphasis>
; /* mask of real modifiers whose lock state is to change */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
values</emphasis>
; /* 1 =&gt; lock, 0 =&gt; unlock; only for modifiers selected by <emphasis>
affect</emphasis>
*/
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
<paramdef>unsigned int <parameter>affect</parameter></paramdef>
<paramdef>unsigned int <parameter>values</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to the X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>device_spec</parameter>
</term>
<listitem>
<para>
device ID, or <emphasis>XkbUseCoreKbd</emphasis>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>affect</parameter>
</term>
<listitem>
<para>
mask of real modifiers whose lock state is to change
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>values</parameter>
</term>
<listitem>
<para>
1 =&gt; lock, 0 =&gt; unlock; only for modifiers selected by <parameter>affect</parameter>
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -424,54 +432,62 @@ XkbLatchModifiers:</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbLatchModifiers</emphasis>
(d<emphasis>
<indexterm significance="preferred" zone="XkbLatchModifiers"><primary><function>XkbLatchModifiers</function></primary></indexterm>
<funcsynopsis id="XkbLatchModifiers">
<funcprototype>
<funcdef>Bool <function>XkbLatchModifiers</function></funcdef>
<!-- (d<emphasis>
isplay, device_spec, affect, values</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
display</emphasis>
; /* connection to the X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
device_spec</emphasis>
; /* device ID, or <emphasis>
XkbUseCoreKbd</emphasis>
*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
affect</emphasis>
; /* mask of modifiers whose latch state is to change */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>values</emphasis>;
/* 1 =&gt; latch, 0 =&gt; unlatch; only for mods selected by <emphasis>
affect</emphasis>
*/
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
<paramdef>unsigned int <parameter>affect</parameter></paramdef>
<paramdef>unsigned int <parameter>values</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to the X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>device_spec</parameter>
</term>
<listitem>
<para>
device ID, or <emphasis>XkbUseCoreKbd</emphasis>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>affect</parameter>
</term>
<listitem>
<para>
mask of modifiers whose latch state is to change
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>values</parameter>
</term>
<listitem>
<para>
1 =&gt; latch, 0 =&gt; unlatch; only for mods selected by <parameter>affect</parameter>
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -538,46 +554,51 @@ To lock the keysym group, use <emphasis>
XkbLockGroup. </emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbLockGroup</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbLockGroup"><primary><function>XkbLockGroup</function></primary></indexterm>
<funcsynopsis id="XkbLockGroup">
<funcprototype>
<funcdef>Bool <function>XkbLockGroup</function></funcdef>
<!-- (<emphasis>
display, device_spec, group</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
display</emphasis>
; /* connection to the X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
device_spec</emphasis>
; /* device ID, or <emphasis>
XkbUseCoreKbd</emphasis>
*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
group</emphasis>
; /* index of the keysym group to lock */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
<paramdef>unsigned int <parameter>group</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to the X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>device_spec</parameter>
</term>
<listitem>
<para>
device ID, or <emphasis>XkbUseCoreKbd</emphasis>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>group</parameter>
</term>
<listitem>
<para>
index of the keysym group to lock
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -598,46 +619,51 @@ XkbLatchGroup.</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbLatchGroup</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbLatchGroup"><primary><function>XkbLatchGroup</function></primary></indexterm>
<funcsynopsis id="XkbLatchGroup">
<funcprototype>
<funcdef>Bool <function>XkbLatchGroup</function></funcdef>
<!-- (<emphasis>
display, device_spec, group</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
display</emphasis>
; /* connection to the X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
device_spec</emphasis>
; /* device ID, or <emphasis>
XkbUseCoreKbd</emphasis>
*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
group</emphasis>
; /* index of the keysym group to latch */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
<paramdef>unsigned int <parameter>group</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to the X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>device_spec</parameter>
</term>
<listitem>
<para>
device ID, or <emphasis>XkbUseCoreKbd</emphasis>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>group</parameter>
</term>
<listitem>
<para>
index of the keysym group to latch
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -687,50 +713,55 @@ To obtain the keyboard state, use <emphasis>
XkbGetState.</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Status <emphasis>
XkbGetState</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbGetState"><primary><function>XkbGetState</function></primary></indexterm>
<funcsynopsis id="XkbGetState">
<funcprototype>
<funcdef>Status <function>XkbGetState</function></funcdef>
<!-- (<emphasis>
display</emphasis>
, <emphasis>
device_spec</emphasis>
, <emphasis>
state_return</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
display</emphasis>
; /* connection to the X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
device_spec</emphasis>
; /* device ID, or <emphasis>
XkbUseCoreKbd</emphasis>
*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbStatePtr <emphasis>
state_return</emphasis>
; /* backfilled with Xkb state */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
<paramdef>XkbStatePtr <parameter>state_return</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to the X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>device_spec</parameter>
</term>
<listitem>
<para>
device ID, or <emphasis>XkbUseCoreKbd</emphasis>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>state_return</parameter>
</term>
<listitem>
<para>
backfilled with Xkb state
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The <emphasis>

View file

@ -203,46 +203,52 @@ XkbGetKeyboardbyName</emphasis>
).
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
XkbDescPtr <emphasis>
XkbGetKeyboard</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbGetKeyboard"><primary><function>XkbGetKeyboard</function></primary></indexterm>
<funcsynopsis id="XkbGetKeyboard">
<funcprototype>
<funcdef>XkbDescPtr <function>XkbGetKeyboard</function></funcdef>
<!-- (<emphasis>
display, which, device_spec</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
display</emphasis>
; /* connection to X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
which</emphasis>
; /* mask indicating components to return */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
device_spec</emphasis>
; /* device for which to fetch description, or <emphasis>
XkbUseCoreKbd</emphasis>
*/
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
<paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>which</parameter>
</term>
<listitem>
<para>
mask indicating components to return
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>device_spec</parameter>
</term>
<listitem>
<para>
device for which to fetch description, or <emphasis>
XkbUseCoreKbd</emphasis>
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -308,21 +314,14 @@ Xmalloc</emphasis>
.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
XkbDescRec * <emphasis>
XkbAllocKeyboard</emphasis>
(void)
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<indexterm significance="preferred" zone="XkbAllocKeyboard"><primary><function>XkbAllocKeyboard</function></primary></indexterm>
<funcsynopsis id="XkbAllocKeyboard">
<funcprototype>
<funcdef>XkbDescRec *<function>XkbAllocKeyboard</function></funcdef>
<void />
</funcprototype>
</funcsynopsis>
<para>
If <emphasis>
@ -347,48 +346,51 @@ XkbFreeKeyboard.</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
void <emphasis>
XkbFreeKeyboard</emphasis>
<emphasis>
<indexterm significance="preferred" zone="XkbFreeKeyboard"><primary><function>XkbFreeKeyboard</function></primary></indexterm>
<funcsynopsis id="XkbFreeKeyboard">
<funcprototype>
<funcdef>void <function>XkbFreeKeyboard</function></funcdef>
<!-- <emphasis>
(xkb, which, free_all</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb</emphasis>
; /* keyboard description with components to free */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
which</emphasis>
; /* mask selecting components to free */
</entry>
</row>
<row>
<entry role='functionargdecl'>
Bool <emphasis>
free_all</emphasis>
; /* <emphasis>
True</emphasis>
=&gt; free all components and <emphasis>
xkb</emphasis>
*/
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
<paramdef>Bool <parameter>free_all</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description with components to free
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>which</parameter>
</term>
<listitem>
<para>
mask selecting components to free
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>free_all</parameter>
</term>
<listitem>
<para>
<emphasis>True</emphasis> =&gt; free all components and <parameter>xkb</parameter>
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>

View file

@ -251,44 +251,51 @@ XkbVirtualModsToReal</emphasis>
.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbVirtualModsToReal</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbVirtualModsToReal"><primary><function>XkbVirtualModsToReal</function></primary></indexterm>
<funcsynopsis id="XkbVirtualModsToReal">
<funcprototype>
<funcdef>Bool <function>XkbVirtualModsToReal</function></funcdef>
<!-- (<emphasis>
xkb, virtual_mask, mask_rtrn</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb</emphasis>
; /* keyboard description for input device */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
virtual_mask</emphasis>
; /* virtual modifier mask to translate */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int * <emphasis>
mask_rtrn</emphasis>
; /* backfilled with real modifiers */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>unsigned int <parameter>virtual_mask</parameter></paramdef>
<paramdef>unsigned int *<parameter>mask_rtrn</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description for input device
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>virtual_mask</parameter>
</term>
<listitem>
<para>
virtual modifier mask to translate
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>mask_rtrn</parameter>
</term>
<listitem>
<para>
backfilled with real modifiers
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
If the keyboard description defined by <emphasis>

File diff suppressed because it is too large Load diff

View file

@ -345,76 +345,95 @@ To ring the bell on an X input extension device or the default keyboard, use
XkbDeviceBell.</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbDeviceBell</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbDeviceBell"><primary><function>XkbDeviceBell</function></primary></indexterm>
<funcsynopsis id="XkbDeviceBell">
<funcprototype>
<funcdef>Bool <function>XkbDeviceBell</function></funcdef>
<!-- (<emphasis>
display, window, device_id, bell_class, bell_id, percent, name</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display *<emphasis>
display</emphasis>
; /* connection to the X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
Window<emphasis>
window</emphasis>
; /* window for which the bell is generated, or None */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
device_spec</emphasis>
; /* device ID, or <emphasis>
XkbUseCoreKbd</emphasis>
*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
bell_class</emphasis>
; /* X input extension bell class of the bell to be rung */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
bell_id</emphasis>
; /* X input extension bell ID of the bell to be rung */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int <emphasis>
percent</emphasis>
; /* bell volume, from -100 to 100 inclusive */
</entry>
</row>
<row>
<entry role='functionargdecl'>
Atom <emphasis>
name</emphasis>
; /* a name for the bell, or <emphasis>
NULL</emphasis>
*/
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>Window <parameter>window</parameter></paramdef>
<paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
<paramdef>unsigned int <parameter>bell_class</parameter></paramdef>
<paramdef>unsigned int <parameter>bell_id</parameter></paramdef>
<paramdef>int <parameter>percent</parameter></paramdef>
<paramdef>Atom <parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to the X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>window</parameter>
</term>
<listitem>
<para>
window for which the bell is generated, or None
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>device_spec</parameter>
</term>
<listitem>
<para>
device ID, or <emphasis>XkbUseCoreKbd</emphasis>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>bell_class</parameter>
</term>
<listitem>
<para>
X input extension bell class of the bell to be rung
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>bell_id</parameter>
</term>
<listitem>
<para>
X input extension bell ID of the bell to be rung
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>percent</parameter>
</term>
<listitem>
<para>
bell volume, from -100 to 100 inclusive
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>name</parameter>
</term>
<listitem>
<para>
a name for the bell, or <emphasis>NULL</emphasis>
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
Set <emphasis>
@ -471,53 +490,62 @@ default keyboard: <emphasis>
XkbBell.</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbBell</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbBell"><primary><function>XkbBell</function></primary></indexterm>
<funcsynopsis id="XkbBell">
<funcprototype>
<funcdef>Bool <function>XkbBell</function></funcdef>
<!-- (<emphasis>
display, window, percent, name</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
display</emphasis>
; /* connection to the X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
Window<emphasis>
window</emphasis>
; /* event window, or None*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
int<emphasis>
percent</emphasis>
; /* relative volume, which can range from -100 to 100 inclusive */
</entry>
</row>
<row>
<entry role='functionargdecl'>
Atom<emphasis>
name</emphasis>
; /* a bell name, or <emphasis>
NULL</emphasis>
*/
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>Window <parameter>window</parameter></paramdef>
<paramdef>int <parameter>percent</parameter></paramdef>
<paramdef>Atom <parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to the X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>window</parameter>
</term>
<listitem>
<para>
event window, or None
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>percent</parameter>
</term>
<listitem>
<para>
relative volume, which can range from -100 to 100 inclusive
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>name</parameter>
</term>
<listitem>
<para>
a bell name, or <emphasis>NULL</emphasis>
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
If a compatible keyboard extension isnt present in the X server, <emphasis>
@ -592,76 +620,95 @@ without ringing the corresponding bell, use <emphasis>
XkbDeviceBellEvent.</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbDeviceBellEvent</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbDeviceBellEvent"><primary><function>XkbDeviceBellEvent</function></primary></indexterm>
<funcsynopsis id="XkbDeviceBellEvent">
<funcprototype>
<funcdef>Bool <function>XkbDeviceBellEvent</function></funcdef>
<!-- (<emphasis>
display, window, device_spec, bell_class, bell_id, percent, name</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
display</emphasis>
; /* connection to the X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
Window <emphasis>
window</emphasis>
; /* event window, or None*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
device_spec</emphasis>
; /* device ID, or <emphasis>
XkbUseCoreKbd</emphasis>
*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
bell_class;</emphasis>
/* input extension bell class for the event */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
bell_id</emphasis>
; /* input extension bell ID for the event */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int <emphasis>
percent</emphasis>
; /* volume for the bell, which can range from -100 to 100 inclusive */
</entry>
</row>
<row>
<entry role='functionargdecl'>
Atom <emphasis>
name</emphasis>
; /* a bell name, or <emphasis>
NULL</emphasis>
*/
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>Window <parameter>window</parameter></paramdef>
<paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
<paramdef>unsigned int <parameter>bell_class</parameter></paramdef>
<paramdef>unsigned int <parameter>bell_id</parameter></paramdef>
<paramdef>int <parameter>percent</parameter></paramdef>
<paramdef>Atom <parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to the X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>window</parameter>
</term>
<listitem>
<para>
event window, or None
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>device_spec</parameter>
</term>
<listitem>
<para>
device ID, or <emphasis>XkbUseCoreKbd</emphasis>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>bell_class</parameter>
</term>
<listitem>
<para>
input extension bell class for the event
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>bell_id</parameter>
</term>
<listitem>
<para>
input extension bell ID for the event
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>percent</parameter>
</term>
<listitem>
<para>
volume for the bell, which can range from -100 to 100 inclusive
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>name</parameter>
</term>
<listitem>
<para>
a bell name, or <emphasis>NULL</emphasis>
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
If a compatible keyboard extension isnt present in the X server, <emphasis>
@ -701,53 +748,62 @@ XkbBellEvent.</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbBellEvent</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbBellEvent"><primary><function>XkbBellEvent</function></primary></indexterm>
<funcsynopsis id="XkbBellEvent">
<funcprototype>
<funcdef>Bool <function>XkbBellEvent</function></funcdef>
<!-- (<emphasis>
display, window, percent, name</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
display</emphasis>
; /* connection to the X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
Window <emphasis>
window</emphasis>
; /* the event window, or None */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int <emphasis>
percent</emphasis>
; /* relative volume, which can range from -100 to 100 inclusive */
</entry>
</row>
<row>
<entry role='functionargdecl'>
Atom <emphasis>
name</emphasis>
; /* a bell name, or <emphasis>
NULL</emphasis>
*/
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>Window <parameter>window</parameter></paramdef>
<paramdef>int <parameter>percent</parameter></paramdef>
<paramdef>Atom <parameter>name</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to the X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>window</parameter>
</term>
<listitem>
<para>
the event window, or None
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>percent</parameter>
</term>
<listitem>
<para>
relative volume, which can range from -100 to 100 inclusive
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>name</parameter>
</term>
<listitem>
<para>
a bell name, or <emphasis>NULL</emphasis>
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
If a compatible keyboard extension isnt present in the X server, <emphasis>
@ -801,67 +857,84 @@ To ring the bell on any keyboard, overriding user preference settings for
audible bells, use <emphasis>XkbForceDeviceBell</emphasis>.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbForceDeviceBell</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbForceDeviceBell"><primary><function>XkbForceDeviceBell</function></primary></indexterm>
<funcsynopsis id="XkbForceDeviceBell">
<funcprototype>
<funcdef>Bool <function>XkbForceDeviceBell</function></funcdef>
<!-- (<emphasis>
display, window, device_spec, bell_class, bell_id, percent</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
display</emphasis>
; /* connection to the X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
Window <emphasis>
window</emphasis>
; /* event window, or None */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
device_spec</emphasis>
; /* device ID, or <emphasis>
XkbUseCoreKbd</emphasis>
*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
bell_class</emphasis>
; /* input extension class of the bell to be rung */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
bell_id</emphasis>
; /* input extension ID of the bell to be rung */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int <emphasis>
percent</emphasis>
; /* relative volume, which can range from -100 to 100 inclusive */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>Window <parameter>window</parameter></paramdef>
<paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
<paramdef>unsigned int <parameter>bell_class</parameter></paramdef>
<paramdef>unsigned int <parameter>bell_id</parameter></paramdef>
<paramdef>int <parameter>percent</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to the X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>window</parameter>
</term>
<listitem>
<para>
event window, or None
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>device_spec</parameter>
</term>
<listitem>
<para>
device ID, or <emphasis>XkbUseCoreKbd</emphasis>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>bell_class</parameter>
</term>
<listitem>
<para>
input extension class of the bell to be rung
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>bell_id</parameter>
</term>
<listitem>
<para>
input extension ID of the bell to be rung
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>percent</parameter>
</term>
<listitem>
<para>
relative volume, which can range from -100 to 100 inclusive
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
If a compatible keyboard extension isnt present in the X server, <emphasis>
@ -899,36 +972,39 @@ for audible bells, use <emphasis>
XkbForceBell</emphasis>.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbForceBell</emphasis>
(<emphasis>
display, percent)</emphasis>
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
display</emphasis>
; /* connection to the X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int <emphasis>
percent</emphasis>
; /* volume for the bell, which can range from -100 to 100 inclusive */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<indexterm significance="preferred" zone="XkbForceBell"><primary><function>XkbForceBell</function></primary></indexterm>
<funcsynopsis id="XkbForceBell">
<funcprototype>
<funcdef>Bool <function>XkbForceBell</function></funcdef>
<!-- (<emphasis>
display, percent)</emphasis> -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>int <parameter>percent</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to the X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>percent</parameter>
</term>
<listitem>
<para>
volume for the bell, which can range from -100 to 100 inclusive
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
If a compatible keyboard extension isnt present in the X server, <emphasis>

File diff suppressed because it is too large Load diff

View file

@ -427,30 +427,29 @@ To determine which Library Controls are actually
implemented, use <emphasis>XkbXlibControlsImplemented</emphasis>.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
unsigned int <emphasis>
XkbXlibControlsImplemented</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbXlibControlsImplemented"><primary><function>XkbXlibControlsImplemented</function></primary></indexterm>
<funcsynopsis id="XkbXlibControlsImplemented">
<funcprototype>
<funcdef>unsigned int <function>XkbXlibControlsImplemented</function></funcdef>
<!-- (<emphasis>
display</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display *<emphasis>
display</emphasis>
; /* connection to X server */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to X server
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -470,30 +469,29 @@ XkbGetXlibControls</emphasis>
.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
unsigned int <emphasis>
XkbGetXlibControls</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbGetXlibControls"><primary><function>XkbGetXlibControls</function></primary></indexterm>
<funcsynopsis id="XkbGetXlibControls">
<funcprototype>
<funcdef>unsigned int <function>XkbGetXlibControls</function></funcdef>
<!-- (<emphasis>
display</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display *<emphasis>
display</emphasis>
; /* connection to X server */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to X server
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -513,44 +511,51 @@ To change the state of the Library Controls, use
<emphasis>XkbSetXlibControls</emphasis>.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbSetXlibControls</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbSetXlibControls"><primary><function>XkbSetXlibControls</function></primary></indexterm>
<funcsynopsis id="XkbSetXlibControls">
<funcprototype>
<funcdef>Bool <function>XkbSetXlibControls</function></funcdef>
<!-- (<emphasis>
display, bits_to_change, values_for_bits</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display *<emphasis>
display</emphasis>
; /* connection to X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned long <emphasis>
bits_to_change</emphasis>
; /* selects controls to be modified */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned long <emphasis>
values_for_bits</emphasis>
; /* turns selected controls on (1) or off (0) */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>unsigned long <parameter>bits_to_change</parameter></paramdef>
<paramdef>unsigned long <parameter>values_for_bits</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>bits_to_change</parameter>
</term>
<listitem>
<para>
selects controls to be modified
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>values_for_bits</parameter>
</term>
<listitem>
<para>
turns selected controls on (1) or off (0)
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>

View file

@ -236,43 +236,62 @@ To find the keysym bound to a particular key at a specified group and shift
level, use <emphasis>XkbKeycodeToKeysym</emphasis>.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
KeySym <emphasis>
XkbKeycodeToKeysym</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbKeycodeToKeysym"><primary><function>XkbKeycodeToKeysym</function></primary></indexterm>
<funcsynopsis id="XkbKeycodeToKeysym">
<funcprototype>
<funcdef>KeySym <function>XkbKeycodeToKeysym</function></funcdef>
<!-- (<emphasis>
dpy, kc, group, level</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>dpy</emphasis>; /* connection to X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
KeyCode <emphasis>kc</emphasis>; /* key of interest */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>group</emphasis>; /* group of interest */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>level</emphasis>; /* shift level of interest */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
<paramdef>KeyCode <parameter>kc</parameter></paramdef>
<paramdef>unsigned int <parameter>group</parameter></paramdef>
<paramdef>unsigned int <parameter>level</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>dpy</parameter>
</term>
<listitem>
<para>
connection to X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>kc</parameter>
</term>
<listitem>
<para>
key of interest
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>group</parameter>
</term>
<listitem>
<para>
group of interest
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>level</parameter>
</term>
<listitem>
<para>
shift level of interest
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -300,39 +319,42 @@ XkbKeysymToModifiers</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
unsigned int <emphasis>
XkbKeysymToModifiers</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbKeysymToModifiers"><primary><function>XkbKeysymToModifiers</function></primary></indexterm>
<funcsynopsis id="XkbKeysymToModifiers">
<funcprototype>
<funcdef>unsigned int <function>XkbKeysymToModifiers</function></funcdef>
<!-- (<emphasis>
dpy</emphasis>
,<emphasis>
ks</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display *<emphasis>
dpy</emphasis>
; /* connection to X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
KeySym <emphasis>
ks</emphasis>
; /* keysym of interest */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
<paramdef>KeySym <parameter>ks</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>dpy</parameter>
</term>
<listitem>
<para>
connection to X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>ks</parameter>
</term>
<listitem>
<para>
keysym of interest
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -372,16 +394,11 @@ XkbLookupKeySym</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbLookupKeySym</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbLookupKeySym"><primary><function>XkbLookupKeySym</function></primary></indexterm>
<funcsynopsis id="XkbLookupKeySym">
<funcprototype>
<funcdef>Bool <function>XkbLookupKeySym</function></funcdef>
<!-- (<emphasis>
dpy</emphasis>
,<emphasis>
key</emphasis>
@ -391,47 +408,67 @@ dpy</emphasis>
mods_rtrn</emphasis>
,<emphasis>
sym_rtrn</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
dpy</emphasis>
; /* connection to X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
KeyCode <emphasis>
key</emphasis>
; /* key for which symbols are to be found */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
state</emphasis>
; /* state for which symbol should be found */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int * <emphasis>
mods_rtrn</emphasis>
; /* backfilled with unconsumed modifiers */
</entry>
</row>
<row>
<entry role='functionargdecl'>
KeySym *<emphasis>
sym_rtrn</emphasis>
; /* backfilled with symbol associated with key + state */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
<paramdef>KeyCode <parameter>key</parameter></paramdef>
<paramdef>unsigned int <parameter>state</parameter></paramdef>
<paramdef>unsigned int *<parameter>mods_rtrn</parameter></paramdef>
<paramdef>KeySym *<parameter>sym_rtrn</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>dpy</parameter>
</term>
<listitem>
<para>
connection to X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>key</parameter>
</term>
<listitem>
<para>
key for which symbols are to be found
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>state</parameter>
</term>
<listitem>
<para>
state for which symbol should be found
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>mods_rtrn</parameter>
</term>
<listitem>
<para>
backfilled with unconsumed modifiers
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>sym_rtrn</parameter>
</term>
<listitem>
<para>
backfilled with symbol associated with key + state
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -475,16 +512,11 @@ XLookupString</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
int <emphasis>
XkbLookupKeyBinding</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbLookupKeyBinding"><primary><function>XkbLookupKeyBinding</function></primary></indexterm>
<funcsynopsis id="XkbLookupKeyBinding">
<funcprototype>
<funcdef>int <function>XkbLookupKeyBinding</function></funcdef>
<!-- (<emphasis>
dpy</emphasis>
,<emphasis>
sym</emphasis>
@ -496,54 +528,78 @@ dpy</emphasis>
nbytes</emphasis>
,<emphasis>
extra_rtrn</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
dpy</emphasis>
; /* connection to server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
KeySym<emphasis>
sym</emphasis>
; /* symbol to be looked up */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
state</emphasis>
; /* state for which string is to be looked up */
</entry>
</row>
<row>
<entry role='functionargdecl'>
char * <emphasis>
buf</emphasis>
; /* buffer into which returned string is written */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int <emphasis>
nbytes</emphasis>
; /* size of buffer in bytes */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int * <emphasis>
extra_rtrn</emphasis>
; /* backfilled with number bytes overflow */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
<paramdef>KeySym <parameter>sym</parameter></paramdef>
<paramdef>unsigned int <parameter>state</parameter></paramdef>
<paramdef>char *<parameter>buf</parameter></paramdef>
<paramdef>int <parameter>nbytes</parameter></paramdef>
<paramdef>int *<parameter>extra_rtrn</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>dpy</parameter>
</term>
<listitem>
<para>
connection to server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>sym</parameter>
</term>
<listitem>
<para>
symbol to be looked up
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>state</parameter>
</term>
<listitem>
<para>
state for which string is to be looked up
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>buf</parameter>
</term>
<listitem>
<para>
buffer into which returned string is written
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>nbytes</parameter>
</term>
<listitem>
<para>
size of buffer in bytes
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>extra_rtrn</parameter>
</term>
<listitem>
<para>
backfilled with number bytes overflow
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -582,16 +638,11 @@ XkbTranslateKeySym</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
int <emphasis>
XkbTranslateKeySym</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbTranslateKeySym"><primary><function>XkbTranslateKeySym</function></primary></indexterm>
<funcsynopsis id="XkbTranslateKeySym">
<funcprototype>
<funcdef>int <function>XkbTranslateKeySym</function></funcdef>
<!-- (<emphasis>
dpy</emphasis>
,<emphasis>
sym_inout</emphasis>
@ -603,56 +654,78 @@ dpy</emphasis>
nbytes</emphasis>
, <emphasis>
extra_rtrn</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
dpy</emphasis>
; /* connection to X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
KeySym * <emphasis>
sym_inout</emphasis>
; /* symbol to be translated; result of translation */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
mods</emphasis>
; /* modifiers to apply to <emphasis>
sym_inout</emphasis>
*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
char * <emphasis>
buf</emphasis>
; /* buffer into which returned string is written */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int <emphasis>
nbytes</emphasis>
; /* size of buffer in bytes */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int *<emphasis>
extra_rtrn</emphasis>
; /* number of bytes overflow*/
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
<paramdef>KeySym *<parameter>sym_inout</parameter></paramdef>
<paramdef>unsigned int <parameter>mods</parameter></paramdef>
<paramdef>char *<parameter>buf</parameter></paramdef>
<paramdef>int <parameter>nbytes</parameter></paramdef>
<paramdef>int *<parameter>extra_rtrn</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>dpy</parameter>
</term>
<listitem>
<para>
connection to X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>sym_inout</parameter>
</term>
<listitem>
<para>
symbol to be translated; result of translation
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>mods</parameter>
</term>
<listitem>
<para>
modifiers to apply to <parameter>sym_inout</parameter>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>buf</parameter>
</term>
<listitem>
<para>
buffer into which returned string is written
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>nbytes</parameter>
</term>
<listitem>
<para>
size of buffer in bytes
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>extra_rtrn</parameter>
</term>
<listitem>
<para>
number of bytes overflow
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -687,29 +760,28 @@ XkbRefreshKeyboardMapping</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Status <emphasis>
XkbRefreshKeyboardMapping</emphasis>
(<emphasis>
event)</emphasis>
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbMapNotifyEvent * <emphasis>
event</emphasis>
; /* event initiating remapping */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<indexterm significance="preferred" zone="XkbRefreshKeyboardMapping"><primary><function>XkbRefreshKeyboardMapping</function></primary></indexterm>
<funcsynopsis id="XkbRefreshKeyboardMapping">
<funcprototype>
<funcdef>Status <function>XkbRefreshKeyboardMapping</function></funcdef>
<!-- (<emphasis>
event)</emphasis> -->
<paramdef>XkbMapNotifyEvent *<parameter>event</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>event</parameter>
</term>
<listitem>
<para>
event initiating remapping
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -752,59 +824,72 @@ XkbTranslateKeyCode</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Booll <emphasis>
XkbTranslateKeyCode</emphasis>
(<emphasis>
xkb, key, mods, mods_rtrn, keysym_rtrn)</emphasis>
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb</emphasis>
; /* keyboard description to use for translation */
</entry>
</row>
<row>
<entry role='functionargdecl'>
KeyCode <emphasis>
key</emphasis>
; /* keycode to translate */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
mods</emphasis>
; /* modifiers to apply when translating <emphasis>
key</emphasis>
*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int * <emphasis>
mods_rtrn</emphasis>
; /* backfilled with unconsumed modifiers */
</entry>
</row>
<row>
<entry role='functionargdecl'>
KeySym * <emphasis>
keysym_rtrn</emphasis>
; /* keysym resulting from translation */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<indexterm significance="preferred" zone="XkbTranslateKeyCode"><primary><function>XkbTranslateKeyCode</function></primary></indexterm>
<funcsynopsis id="XkbTranslateKeyCode">
<funcprototype>
<funcdef>Booll <function>XkbTranslateKeyCode</function></funcdef>
<!-- (<emphasis>
xkb, key, mods, mods_rtrn, keysym_rtrn)</emphasis> -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>KeyCode <parameter>key</parameter></paramdef>
<paramdef>unsigned int <parameter>mods</parameter></paramdef>
<paramdef>unsigned int *<parameter>mods_rtrn</parameter></paramdef>
<paramdef>KeySym *<parameter>keysym_rtrn</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description to use for translation
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>key</parameter>
</term>
<listitem>
<para>
keycode to translate
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>mods</parameter>
</term>
<listitem>
<para>
modifiers to apply when translating <parameter>key</parameter>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>mods_rtrn</parameter>
</term>
<listitem>
<para>
backfilled with unconsumed modifiers
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>keysym_rtrn</parameter>
</term>
<listitem>
<para>
keysym resulting from translation
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>

File diff suppressed because it is too large Load diff

View file

@ -248,46 +248,51 @@ XkbGetMap</emphasis>
can be instructed to return a partially populated component.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
XkbDescPtr <emphasis>
XkbGetMap</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbGetMap"><primary><function>XkbGetMap</function></primary></indexterm>
<funcsynopsis id="XkbGetMap">
<funcprototype>
<funcdef>XkbDescPtr <function>XkbGetMap</function></funcdef>
<!-- (<emphasis>
display, which, device_spec</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
display</emphasis>
; /* connection to X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
which</emphasis>
; /* mask selecting subcomponents to populate */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
device_spec</emphasis>
; /* device_id, or <emphasis>
XkbUseCoreKbd</emphasis>
*/
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
<paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>which</parameter>
</term>
<listitem>
<para>
mask selecting subcomponents to populate
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>device_spec</parameter>
</term>
<listitem>
<para>
device_id, or <emphasis>XkbUseCoreKbd</emphasis>
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The <emphasis>
@ -497,44 +502,51 @@ description, use <emphasis>XkbGetUpdatedMap</emphasis>.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Status <emphasis>
XkbGetUpdatedMap</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbGetUpdatedMap"><primary><function>XkbGetUpdatedMap</function></primary></indexterm>
<funcsynopsis id="XkbGetUpdatedMap">
<funcprototype>
<funcdef>Status <function>XkbGetUpdatedMap</function></funcdef>
<!-- (<emphasis>
display, which, xkb</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
display</emphasis>
; /* connection to X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
which</emphasis>
; /* mask selecting subcomponents to populate */
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb</emphasis>
; /* keyboard description to be updated */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>which</parameter>
</term>
<listitem>
<para>
mask selecting subcomponents to populate
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description to be updated
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The <emphasis>
@ -592,48 +604,55 @@ an<emphasis>
structure and call <emphasis>XkbChangeMap</emphasis>.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbSetMap</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbSetMap"><primary><function>XkbSetMap</function></primary></indexterm>
<funcsynopsis id="XkbSetMap">
<funcprototype>
<funcdef>Bool <function>XkbSetMap</function></funcdef>
<!-- (<emphasis>
dpy</emphasis>
,<emphasis>
which</emphasis>
,<emphasis>
xkb</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display *<emphasis>
dpy</emphasis>
; /* connection to X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
which</emphasis>
; /* mask selecting subcomponents to update */
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb</emphasis>
; /* description from which new values are taken */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>dpy</parameter>
</term>
<listitem>
<para>
connection to X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>which</parameter>
</term>
<listitem>
<para>
mask selecting subcomponents to update
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
description from which new values are taken
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
Use <emphasis>
@ -871,48 +890,55 @@ XkbMapChangesRec</emphasis>
structure indicating which components have changed.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbChangeMap</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbChangeMap"><primary><function>XkbChangeMap</function></primary></indexterm>
<funcsynopsis id="XkbChangeMap">
<funcprototype>
<funcdef>Bool <function>XkbChangeMap</function></funcdef>
<!-- (<emphasis>
dpy</emphasis>
,<emphasis>
xkb</emphasis>
,<emphasis>
changes</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display *<emphasis>
dpy</emphasis>
; /* connection to X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb</emphasis>
; /* description from which new values are taken */
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbMapChangesPtr <emphasis>
changes</emphasis>
; /*identifies component parts to update */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>XkbMapChangesPtr <parameter>changes</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>dpy</parameter>
</term>
<listitem>
<para>
connection to X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
description from which new values are taken
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>changes</parameter>
</term>
<listitem>
<para>
identifies component parts to update
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -1104,46 +1130,51 @@ To allocate and initialize an empty client map description record, use
XkbAllocClientMap.</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Status <emphasis>
XkbAllocClientMap</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbAllocClientMap"><primary><function>XkbAllocClientMap</function></primary></indexterm>
<funcsynopsis id="XkbAllocClientMap">
<funcprototype>
<funcdef>Status <function>XkbAllocClientMap</function></funcdef>
<!-- (<emphasis>
xkb, which, type_count</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb</emphasis>
; /* keyboard description in which to allocate client map */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
which</emphasis>
; /* mask selecting map components to allocate */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
type_count</emphasis>
; /* value of <emphasis>
num_types</emphasis>
field in map to be allocated */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
<paramdef>unsigned int <parameter>type_count</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description in which to allocate client map
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>which</parameter>
</term>
<listitem>
<para>
mask selecting map components to allocate
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>type_count</parameter>
</term>
<listitem>
<para>
value of <emphasis>num_types</emphasis> field in map to be allocated
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -1297,46 +1328,52 @@ XkbDescRec</emphasis>
XkbFreeClientMap.</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
void <emphasis>
XkbFreeClientMap</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbFreeClientMap"><primary><function>XkbFreeClientMap</function></primary></indexterm>
<funcsynopsis id="XkbFreeClientMap">
<funcprototype>
<funcdef>void <function>XkbFreeClientMap</function></funcdef>
<!-- (<emphasis>
xkb, which, free_all</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb</emphasis>
; /* keyboard description containing client map to free */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
which</emphasis>
; /* mask identifying components of map to free */
</entry>
</row>
<row>
<entry role='functionargdecl'>
Bool <emphasis>
free_all</emphasis>
; /* <emphasis>
True</emphasis>
=&gt; free all client components and map itself */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
<paramdef>Bool <parameter>free_all</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description containing client map to free
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>which</parameter>
</term>
<listitem>
<para>
mask identifying components of map to free
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>free_all</parameter>
</term>
<listitem>
<para>
<emphasis>True</emphasis>
=&gt; free all client components and map itself
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -1389,46 +1426,51 @@ To allocate and initialize an empty server map description record, use
XkbAllocServerMap.</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Status <emphasis>
XkbAllocServerMap</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbAllocServerMap"><primary><function>XkbAllocServerMap</function></primary></indexterm>
<funcsynopsis id="XkbAllocServerMap">
<funcprototype>
<funcdef>Status <function>XkbAllocServerMap</function></funcdef>
<!-- (<emphasis>
xkb, which, count_acts</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb</emphasis>
; /* keyboard description in which to allocate server map */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
which</emphasis>
; /* mask selecting map components to allocate */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
count_acts</emphasis>
; /* value of <emphasis>
num_acts</emphasis>
field in map to be allocated */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
<paramdef>unsigned int <parameter>count_acts</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description in which to allocate server map
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>which</parameter>
</term>
<listitem>
<para>
mask selecting map components to allocate
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>count_acts</parameter>
</term>
<listitem>
<para>
value of <emphasis>num_acts</emphasis> field in map to be allocated
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -1578,46 +1620,52 @@ XkbDescRec</emphasis>
XkbFreeServerMap.</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
void <emphasis>
XkbFreeServerMap</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbFreeServerMap"><primary><function>XkbFreeServerMap</function></primary></indexterm>
<funcsynopsis id="XkbFreeServerMap">
<funcprototype>
<funcdef>void <function>XkbFreeServerMap</function></funcdef>
<!-- (<emphasis>
xkb, which, free_all</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb</emphasis>
; /* keyboard description containing server map to free */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
which</emphasis>
; /* mask identifying components of map to free */
</entry>
</row>
<row>
<entry role='functionargdecl'>
Bool <emphasis>
free_all</emphasis>
; /* <emphasis>
True</emphasis>
=&gt; free all server map components and server itself */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
<paramdef>Bool <parameter>free_all</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description containing server map to free
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>which</parameter>
</term>
<listitem>
<para>
mask identifying components of map to free
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>free_all</parameter>
</term>
<listitem>
<para>
<emphasis>True</emphasis>
=&gt; free all server map components and server itself
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The <emphasis>

File diff suppressed because it is too large Load diff

File diff suppressed because it is too large Load diff

View file

@ -760,44 +760,51 @@ compatibility map may be used to reconfigure other servers.
<note><para>To make a complete matching configuration you must also update the
explicit override components of the server state.</para></note>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Status <emphasis>
XkbGetCompatMap</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbGetCompatMap"><primary><function>XkbGetCompatMap</function></primary></indexterm>
<funcsynopsis id="XkbGetCompatMap">
<funcprototype>
<funcdef>Status <function>XkbGetCompatMap</function></funcdef>
<!-- (<emphasis>
display, which, xkb</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
display</emphasis>
; /* connection to server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
which</emphasis>
; /* mask of compatibility map components to fetch */
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescRec * <emphasis>
xkb</emphasis>
; /* keyboard description where results placed */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
<paramdef>XkbDescRec *<parameter>xkb</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>which</parameter>
</term>
<listitem>
<para>
mask of compatibility map components to fetch
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description where results placed
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -911,16 +918,11 @@ XkbUpdateMapFromCore</emphasis>
.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbUpdateMapFromCore</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbUpdateMapFromCore"><primary><function>XkbUpdateMapFromCore</function></primary></indexterm>
<funcsynopsis id="XkbUpdateMapFromCore">
<funcprototype>
<funcdef>Bool <function>XkbUpdateMapFromCore</function></funcdef>
<!-- (<emphasis>
xkb</emphasis>
,<emphasis>
first_key</emphasis>
@ -932,54 +934,78 @@ xkb</emphasis>
core_keysyms</emphasis>
,<emphasis>
changes</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb</emphasis>
; /* keyboard description to update */
</entry>
</row>
<row>
<entry role='functionargdecl'>
KeyCode <emphasis>
first_key</emphasis>
; /* keycode of first key description to update */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int <emphasis>
num_keys</emphasis>
; /* number of key descriptions to update */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int <emphasis>
map_width</emphasis>
; /* width of core protocol keymap */
</entry>
</row>
<row>
<entry role='functionargdecl'>
KeySym *<emphasis>
core_keysyms</emphasis>
; /* symbols in core protocol keymap */
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbChangesPtr <emphasis>
changes</emphasis>
; /* backfilled with changes made to Xkb */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>KeyCode <parameter>first_key</parameter></paramdef>
<paramdef>int <parameter>num_keys</parameter></paramdef>
<paramdef>int <parameter>map_width</parameter></paramdef>
<paramdef>KeySym *<parameter>core_keysyms</parameter></paramdef>
<paramdef>XkbChangesPtr <parameter>changes</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description to update
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>first_key</parameter>
</term>
<listitem>
<para>
keycode of first key description to update
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>num_keys</parameter>
</term>
<listitem>
<para>
number of key descriptions to update
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>map_width</parameter>
</term>
<listitem>
<para>
width of core protocol keymap
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>core_keysyms</parameter>
</term>
<listitem>
<para>
symbols in core protocol keymap
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>changes</parameter>
</term>
<listitem>
<para>
backfilled with changes made to Xkb
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -1053,72 +1079,89 @@ XkbKeyTypesForCoreSymbols</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
int <emphasis>
XkbKeyTypesForCoreSymbols</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbKeyTypesForCoreSymbols"><primary><function>XkbKeyTypesForCoreSymbols</function></primary></indexterm>
<funcsynopsis id="XkbKeyTypesForCoreSymbols">
<funcprototype>
<funcdef>int <function>XkbKeyTypesForCoreSymbols</function></funcdef>
<!-- (<emphasis>
map_width</emphasis>
,<emphasis>
core_syms</emphasis>
,<emphasis>
protected, types_inout, xkb_syms_rtrn</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr<emphasis>
xkb</emphasis>
; /* keyboard description in which to place symbols*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
int<emphasis>
map_width</emphasis>
; /* width of core protocol keymap in <emphasis>
xkb_syms_rtrn</emphasis>
*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
KeySym *<emphasis>
core_syms</emphasis>
; /* core protocol format array of KeySyms */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
protected</emphasis>
; /* explicit key types */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int *<emphasis>
types_inout;</emphasis>
/* backfilled with the canonical types bound to groups one and two
for the key */
</entry>
</row>
<row>
<entry role='functionargdecl'>
KeySym * <emphasis>
xkb_syms_rtrn</emphasis>
; /* backfilled with symbols bound to the key in the Xkb mapping */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>int <parameter>map_width</parameter></paramdef>
<paramdef>KeySym *<parameter>core_syms</parameter></paramdef>
<paramdef>unsigned int <parameter>protected</parameter></paramdef>
<paramdef>int *<parameter>types_inout</parameter></paramdef>
<paramdef>KeySym *<parameter>xkb_syms_rtrn</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description in which to place symbols
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>map_width</parameter>
</term>
<listitem>
<para>
width of core protocol keymap in <parameter>xkb_syms_rtrn</parameter>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>core_syms</parameter>
</term>
<listitem>
<para>
core protocol format array of KeySyms
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>protected</parameter>
</term>
<listitem>
<para>
explicit key types
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>types_inout</parameter>
</term>
<listitem>
<para>
backfilled with the canonical types bound to groups one and two
for the key
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>xkb_syms_rtrn</parameter>
</term>
<listitem>
<para>
backfilled with symbols bound to the key in the Xkb mapping
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -1200,48 +1243,55 @@ XkbApplyCompatMapToKey</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbApplyCompatMapToKey</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbApplyCompatMapToKey"><primary><function>XkbApplyCompatMapToKey</function></primary></indexterm>
<funcsynopsis id="XkbApplyCompatMapToKey">
<funcprototype>
<funcdef>Bool <function>XkbApplyCompatMapToKey</function></funcdef>
<!-- (<emphasis>
xkb</emphasis>
,<emphasis>
key</emphasis>
,<emphasis>
changes</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr<emphasis>
xkb; </emphasis>
/* keyboard description to be updated */
</entry>
</row>
<row>
<entry role='functionargdecl'>
KeyCode<emphasis>
key</emphasis>
; /* key to be updated */
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbChangesPtr<emphasis>
changes</emphasis>
; /* notes changes to the Xkb keyboard description */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>KeyCode <parameter>key</parameter></paramdef>
<paramdef>XkbChangesPtr <parameter>changes</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description to be updated
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>key</parameter>
</term>
<listitem>
<para>
key to be updated
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>changes</parameter>
</term>
<listitem>
<para>
notes changes to the Xkb keyboard description
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -1275,53 +1325,62 @@ XkbSymInterpretRec</emphasis>
structures) are also allocated using this same function.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbSetCompatMap</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbSetCompatMap"><primary><function>XkbSetCompatMap</function></primary></indexterm>
<funcsynopsis id="XkbSetCompatMap">
<funcprototype>
<funcdef>Bool <function>XkbSetCompatMap</function></funcdef>
<!-- (<emphasis>
display, which, xkb, update_actions</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
display</emphasis>
; /* connection to server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
which</emphasis>
; /* mask of compat map components to set */
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb</emphasis>
; /* source for compat map components */
</entry>
</row>
<row>
<entry role='functionargdecl'>
Bool <emphasis>
update_actions</emphasis>
; /* <emphasis>
True</emphasis>
=&gt; apply to servers keyboard map */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>Bool <parameter>update_actions</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>which</parameter>
</term>
<listitem>
<para>
mask of compat map components to set
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
source for compat map components
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>update_actions</parameter>
</term>
<listitem>
<para>
<emphasis>True</emphasis> =&gt; apply to servers keyboard map
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -1392,53 +1451,62 @@ XkbAddSymInterpret</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
XkbSymInterpretPtr <emphasis>
XkbAddSymInterpret</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbAddSymInterpret"><primary><function>XkbAddSymInterpret</function></primary></indexterm>
<funcsynopsis id="XkbAddSymInterpret">
<funcprototype>
<funcdef>XkbSymInterpretPtr <function>XkbAddSymInterpret</function></funcdef>
<!-- (<emphasis>
xkb, si, updateMap, changes</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr<emphasis>
xkb</emphasis>
; /* keyboard description to be updated */
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbSymInterpretPtr<emphasis>
si</emphasis>
; /* symbol interpretation to be added */
</entry>
</row>
<row>
<entry role='functionargdecl'>
Bool<emphasis>
updateMap</emphasis>
; /* <emphasis>
True</emphasis>
=&gt;apply compatibility map to keys */
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbChangesPtr<emphasis>
changes</emphasis>
; /* changes are put here */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>XkbSymInterpretPtr <parameter>si</parameter></paramdef>
<paramdef>Bool <parameter>updateMap</parameter></paramdef>
<paramdef>XkbChangesPtr <parameter>changes</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description to be updated
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>si</parameter>
</term>
<listitem>
<para>
symbol interpretation to be added
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>updateMap</parameter>
</term>
<listitem>
<para>
<emphasis>True</emphasis>=&gt;apply compatibility map to keys
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>changes</parameter>
</term>
<listitem>
<para>
changes are put here
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -1610,44 +1678,51 @@ XkbAllocCompatMap</emphasis>
.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Status <emphasis>
XkbAllocCompatMap</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbAllocCompatMap"><primary><function>XkbAllocCompatMap</function></primary></indexterm>
<funcsynopsis id="XkbAllocCompatMap">
<funcprototype>
<funcdef>Status <function>XkbAllocCompatMap</function></funcdef>
<!-- (<emphasis>
xkb, which, num_si</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb</emphasis>
; /* keyboard description in which to allocate compat map */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
which</emphasis>
; /* mask of compatibility map components to allocate */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
num_si</emphasis>
; /* number of symbol interpretations to allocate */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
<paramdef>unsigned int <parameter>num_si</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description in which to allocate compat map
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>which</parameter>
</term>
<listitem>
<para>
mask of compatibility map components to allocate
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>num_si</parameter>
</term>
<listitem>
<para>
number of symbol interpretations to allocate
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -1723,48 +1798,52 @@ XkbFreeCompatMap</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
void <emphasis>
XkbFreeCompatMap</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbFreeCompatMap"><primary><function>XkbFreeCompatMap</function></primary></indexterm>
<funcsynopsis id="XkbFreeCompatMap">
<funcprototype>
<funcdef>void <function>XkbFreeCompatMap</function></funcdef>
<!-- (<emphasis>
xkb, which, free_map</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb</emphasis>
; /* Xkb description in which to free compatibility map */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
which</emphasis>
; /* mask of compatibility map components to free */
</entry>
</row>
<row>
<entry role='functionargdecl'>
Bool <emphasis>
free_map</emphasis>
; /* <emphasis>
True</emphasis>
=&gt; free <emphasis>
XkbCompatMap</emphasis>
structure itself */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
<paramdef>Bool <parameter>free_map</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
Xkb description in which to free compatibility map
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>which</parameter>
</term>
<listitem>
<para>
mask of compatibility map components to free
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>free_map</parameter>
</term>
<listitem>
<para>
<emphasis>True</emphasis> =&gt; free <emphasis>XkbCompatMap</emphasis>
structure itself
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>

View file

@ -371,44 +371,51 @@ XkbGetNames</emphasis>
.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Status <emphasis>
XkbGetNames</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbGetNames"><primary><function>XkbGetNames</function></primary></indexterm>
<funcsynopsis id="XkbGetNames">
<funcprototype>
<funcdef>Status <function>XkbGetNames</function></funcdef>
<!-- (<emphasis>
dpy, which, Xkb</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
dpy</emphasis>
; /* connection to the X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
which</emphasis>
; /* mask of names or map components to be updated */
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb</emphasis>
/* keyboard description to be updated */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>dpy</parameter>
</term>
<listitem>
<para>
connection to the X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>which</parameter>
</term>
<listitem>
<para>
mask of names or map components to be updated
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description to be updated
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -525,58 +532,73 @@ BadImplementation</emphasis>
errors.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbSetNames</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbSetNames"><primary><function>XkbSetNames</function></primary></indexterm>
<funcsynopsis id="XkbSetNames">
<funcprototype>
<funcdef>Bool <function>XkbSetNames</function></funcdef>
<!-- (<emphasis>
dpy, which, first_type, num_types, xkb</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
dpy</emphasis>
; /* connection to the X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
which</emphasis>
; /* mask of names or map components to be changed */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
first_type</emphasis>
; /* first type whose name is to be changed */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
num_types</emphasis>
; /* number of types for which names are to be changed */
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb</emphasis>
; /* keyboard description from which names are to be taken */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
<paramdef>unsigned int <parameter>first_type</parameter></paramdef>
<paramdef>unsigned int <parameter>num_types</parameter></paramdef>
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>dpy</parameter>
</term>
<listitem>
<para>
connection to the X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>which</parameter>
</term>
<listitem>
<para>
mask of names or map components to be changed
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>first_type</parameter>
</term>
<listitem>
<para>
first type whose name is to be changed
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>num_types</parameter>
</term>
<listitem>
<para>
number of types for which names are to be changed
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description from which names are to be taken
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
Use<emphasis>
@ -759,44 +781,51 @@ XkbNameChangesRec</emphasis>
structure.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbChangeNames</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbChangeNames"><primary><function>XkbChangeNames</function></primary></indexterm>
<funcsynopsis id="XkbChangeNames">
<funcprototype>
<funcdef>Bool <function>XkbChangeNames</function></funcdef>
<!-- (<emphasis>
dpy, xkb, changes</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
dpy</emphasis>
; /* connection to the X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb</emphasis>
; /* keyboard description from which names are to be taken */
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbNameChangesPtr <emphasis>
changes</emphasis>
; /* names map components to be updated on the server */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>XkbNameChangesPtr <parameter>changes</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>dpy</parameter>
</term>
<listitem>
<para>
connection to the X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description from which names are to be taken
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>changes</parameter>
</term>
<listitem>
<para>
names map components to be updated on the server
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -911,50 +940,55 @@ XkbNoteNameChanges</emphasis>
.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
void <emphasis>
XkbNoteNameChanges</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbNoteNameChanges"><primary><function>XkbNoteNameChanges</function></primary></indexterm>
<funcsynopsis id="XkbNoteNameChanges">
<funcprototype>
<funcdef>void <function>XkbNoteNameChanges</function></funcdef>
<!-- (<emphasis>
old</emphasis>
,<emphasis>
new</emphasis>
,<emphasis>
wanted</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbNameChangesPtr <emphasis>
old</emphasis>
; /* <emphasis>
XkbNameChanges</emphasis>
structure to be updated */
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbNamesNotifyEvent * <emphasis>
new</emphasis>
; /* event from which changes are to be copied */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
wanted</emphasis>
; /* types of names for which changes are to be noted */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>XkbNameChangesPtr <parameter>old</parameter></paramdef>
<paramdef>XkbNamesNotifyEvent *<parameter>new</parameter></paramdef>
<paramdef>unsigned int <parameter>wanted</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>old</parameter>
</term>
<listitem>
<para>
<emphasis>XkbNameChanges</emphasis> structure to be updated
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>new</parameter>
</term>
<listitem>
<para>
event from which changes are to be copied
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>wanted</parameter>
</term>
<listitem>
<para>
types of names for which changes are to be noted
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The <emphasis>
@ -982,48 +1016,55 @@ XkbNoteNameChanges</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Status <emphasis>
XkbGetNameChanges</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbGetNameChanges"><primary><function>XkbGetNameChanges</function></primary></indexterm>
<funcsynopsis id="XkbGetNameChanges">
<funcprototype>
<funcdef>Status <function>XkbGetNameChanges</function></funcdef>
<!-- (<emphasis>
dpy</emphasis>
,<emphasis>
xkb</emphasis>
,<emphasis>
changes</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
dpy</emphasis>
; /* connection to the X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb</emphasis>
; /* keyboard description to which names are copied */
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbNameChangesPtr <emphasis>
changes</emphasis>
; /* names components to be obtained from the server */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>XkbNameChangesPtr <parameter>changes</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>dpy</parameter>
</term>
<listitem>
<para>
connection to the X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description to which names are copied
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>changes</parameter>
</term>
<listitem>
<para>
names components to be obtained from the server
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -1067,50 +1108,61 @@ XkbAllocNames</emphasis>
.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Status <emphasis>
XkbAllocNames</emphasis>
(<emphasis>
xkb, which, num_rg, num_key_aliases)</emphasis>
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb;</emphasis>
/* keyboard description for which names are to be allocated */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
which;</emphasis>
/* mask of names to be allocated */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int <emphasis>
num_rg;</emphasis>
/* total number of radio group names needed */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int <emphasis>
num_key_aliases;</emphasis>
/* total number of key aliases needed */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<indexterm significance="preferred" zone="XkbAllocNames"><primary><function>XkbAllocNames</function></primary></indexterm>
<funcsynopsis id="XkbAllocNames">
<funcprototype>
<funcdef>Status <function>XkbAllocNames</function></funcdef>
<!-- (<emphasis>
xkb, which, num_rg, num_key_aliases)</emphasis> -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
<paramdef>int <parameter>num_rg</parameter></paramdef>
<paramdef>int <parameter>num_key_aliases</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description for which names are to be allocated
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>which</parameter>
</term>
<listitem>
<para>
mask of names to be allocated
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>num_rg</parameter>
</term>
<listitem>
<para>
total number of radio group names needed
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>num_key_aliases</parameter>
</term>
<listitem>
<para>
total number of key aliases needed
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -1141,45 +1193,51 @@ XkbFreeNames</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
void <emphasis>
XkbFreeNames</emphasis>
(<emphasis>
xkb, which, free_map)</emphasis>
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbDescPtr <emphasis>
xkb</emphasis>
; /* keyboard description for which names are to be freed */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
which</emphasis>
; /* mask of names components to be freed */
</entry>
</row>
<row>
<entry role='functionargdecl'>
Bool <emphasis>
free_map</emphasis>
; /* <emphasis>
True</emphasis>
=&gt; XkbNamesRec structure itself should be freed */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<indexterm significance="preferred" zone="XkbFreeNames"><primary><function>XkbFreeNames</function></primary></indexterm>
<funcsynopsis id="XkbFreeNames">
<funcprototype>
<funcdef>void <function>XkbFreeNames</function></funcdef>
<!-- (<emphasis>
xkb, which, free_map)</emphasis> -->
<paramdef>XkbDescPtr <parameter>xkb</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
<paramdef>Bool <parameter>free_map</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>xkb</parameter>
</term>
<listitem>
<para>
keyboard description for which names are to be freed
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>which</parameter>
</term>
<listitem>
<para>
mask of names components to be freed
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>free_map</parameter>
</term>
<listitem>
<para>
<emphasis>True</emphasis>
=&gt; XkbNamesRec structure itself should be freed
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
The <emphasis>

View file

@ -164,16 +164,11 @@ XkbListComponents</emphasis>
.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
XkbComponentListPtr<emphasis>
XkbListComponents</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbListComponents"><primary><function>XkbListComponents</function></primary></indexterm>
<funcsynopsis id="XkbListComponents">
<funcprototype>
<funcdef>XkbComponentListPtr <function>XkbListComponents</function></funcdef>
<!-- (<emphasis>
dpy</emphasis>
, <emphasis>
device_spec</emphasis>
@ -181,42 +176,56 @@ device_spec</emphasis>
ptrns</emphasis>
, <emphasis>
max_inout</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
dpy</emphasis>
; /* connection to X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
device_spec</emphasis>
; /* device ID, or <emphasis>
XkbUseCoreKbd</emphasis>
*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbComponentNamesPtr <emphasis>
ptrns</emphasis>
; /* namelist for components of interest */
</entry>
</row>
<row>
<entry role='functionargdecl'>
int * <emphasis>
max_inout</emphasis>
; /* max # returned names, # left over */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
<paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
<paramdef>XkbComponentNamesPtr <parameter>ptrns</parameter></paramdef>
<paramdef>int *<parameter>max_inout</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>dpy</parameter>
</term>
<listitem>
<para>
connection to X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>device_spec</parameter>
</term>
<listitem>
<para>
device ID, or <emphasis>XkbUseCoreKbd</emphasis>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>ptrns</parameter>
</term>
<listitem>
<para>
namelist for components of interest
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>max_inout</parameter>
</term>
<listitem>
<para>
max # returned names, # left over
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -367,28 +376,27 @@ XkbFreeComponentList</emphasis>
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
void <emphasis>
XkbFreeComponentList</emphasis>
(list)
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbComponentListPtr list; /* pointer to <emphasis>
XkbComponentListRec</emphasis>
to free */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
<indexterm significance="preferred" zone="XkbFreeComponentList"><primary><function>XkbFreeComponentList</function></primary></indexterm>
<funcsynopsis id="XkbFreeComponentList">
<funcprototype>
<funcdef>void <function>XkbFreeComponentList</function></funcdef>
<!-- (list) -->
<paramdef>XkbComponentListPtr <parameter>list</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>list</parameter>
</term>
<listitem>
<para>
pointer to <emphasis>XkbComponentListRec</emphasis> to free
</para>
</listitem>
</varlistentry>
</variablelist>
</sect1>
@ -552,16 +560,11 @@ XkbGetKeyboardByName</emphasis>
.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
XkbDescPtr <emphasis>
XkbGetKeyboardByName</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbGetKeyboardByName"><primary><function>XkbGetKeyboardByName</function></primary></indexterm>
<funcsynopsis id="XkbGetKeyboardByName">
<funcprototype>
<funcdef>XkbDescPtr <function>XkbGetKeyboardByName</function></funcdef>
<!-- (<emphasis>
dpy</emphasis>
, <emphasis>
device_spec</emphasis>
@ -573,60 +576,78 @@ want</emphasis>
need</emphasis>
, <emphasis>
load</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
dpy</emphasis>
; /* connection to X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
device_spec</emphasis>
; /* device ID, or <emphasis>
XkbUseCoreKbd</emphasis>
*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
XkbComponentNamesPtr <emphasis>
names</emphasis>
; /* names of components to fetch */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
want</emphasis>
; /* desired structures in returned record */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
need</emphasis>
; /* mandatory structures in returned record */
</entry>
</row>
<row>
<entry role='functionargdecl'>
Bool <emphasis>
load</emphasis>
; /* <emphasis>
True</emphasis>
=&gt; load into <emphasis>
device_spec</emphasis>
*/
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
<paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
<paramdef>XkbComponentNamesPtr <parameter>names</parameter></paramdef>
<paramdef>unsigned int <parameter>want</parameter></paramdef>
<paramdef>unsigned int <parameter>need</parameter></paramdef>
<paramdef>Bool <parameter>load</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>dpy</parameter>
</term>
<listitem>
<para>
connection to X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>device_spec</parameter>
</term>
<listitem>
<para>
device ID, or <emphasis>XkbUseCoreKbd</emphasis>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>names</parameter>
</term>
<listitem>
<para>
names of components to fetch
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>want</parameter>
</term>
<listitem>
<para>
desired structures in returned record
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>need</parameter>
</term>
<listitem>
<para>
mandatory structures in returned record
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>load</parameter>
</term>
<listitem>
<para>
<emphasis>True</emphasis> =&gt; load into <parameter>device_spec</parameter>
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>
@ -1119,50 +1140,55 @@ XkbGetKeyboard</emphasis>
(see section 6.2).
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
XkbDescPtr <emphasis>
XkbGetKeyboard</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbGetKeyboard"><primary><function>XkbGetKeyboard</function></primary></indexterm>
<funcsynopsis id="XkbGetKeyboard.20">
<funcprototype>
<funcdef>XkbDescPtr <function>XkbGetKeyboard</function></funcdef>
<!-- (<emphasis>
dpy</emphasis>
, <emphasis>
which</emphasis>
, <emphasis>
device_spec</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
dpy</emphasis>
; /* connection to X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int<emphasis>
which</emphasis>
; /* mask of components of <emphasis>
XkbDescRec</emphasis>
of interest */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
device_spec</emphasis>
; /* device ID */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>dpy</parameter></paramdef>
<paramdef>unsigned int <parameter>which</parameter></paramdef>
<paramdef>unsigned int <parameter>device_spec</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>dpy</parameter>
</term>
<listitem>
<para>
connection to X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>which</parameter>
</term>
<listitem>
<para>
mask of components of <emphasis>XkbDescRec</emphasis> of interest
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>device_spec</parameter>
</term>
<listitem>
<para>
device ID
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>

File diff suppressed because it is too large Load diff

View file

@ -20,83 +20,106 @@ XkbSetDebuggingFlags</emphasis>
.
</para>
<informaltable frame='none'>
<?dbfo keep-together="always" ?>
<tgroup cols='1' align='left' colsep='0' rowsep='0'>
<colspec colname='c1' colwidth='1.0*'/>
<tbody>
<row>
<entry role='functiondecl'>
Bool <emphasis>
XkbSetDebuggingFlags</emphasis>
(<emphasis>
<indexterm significance="preferred" zone="XkbSetDebuggingFlags"><primary><function>XkbSetDebuggingFlags</function></primary></indexterm>
<funcsynopsis id="XkbSetDebuggingFlags">
<funcprototype>
<funcdef>Bool <function>XkbSetDebuggingFlags</function></funcdef>
<!-- (<emphasis>
display, mask, flags, msg, ctrls_mask, ctrls, ret_flags, ret_ctrls</emphasis>
)
</entry>
</row>
<row>
<entry role='functionargdecl'>
Display * <emphasis>
display</emphasis>
; /* connection to X server */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
mask</emphasis>
; /* mask selecting debug output flags to change */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
flags</emphasis>
; /* values for debug output flags selected by <emphasis>
mask</emphasis>
*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
char * <emphasis>
msg</emphasis>
; /* message to print right now */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
ctrls_mask</emphasis>
; /* mask selecting debug controls to change */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int <emphasis>
ctrls</emphasis>
; /* values for debug controls selected by <emphasis>
ctrls_mask</emphasis>
*/
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int * <emphasis>
ret_flags</emphasis>
; /* resulting state of all debug output flags */
</entry>
</row>
<row>
<entry role='functionargdecl'>
unsigned int * <emphasis>
ret_ctrls</emphasis>
; /* resulting state of all debug controls */
</entry>
</row>
</tbody>
</tgroup>
</informaltable>
) -->
<paramdef>Display *<parameter>display</parameter></paramdef>
<paramdef>unsigned int <parameter>mask</parameter></paramdef>
<paramdef>unsigned int <parameter>flags</parameter></paramdef>
<paramdef>char *<parameter>msg</parameter></paramdef>
<paramdef>unsigned int <parameter>ctrls_mask</parameter></paramdef>
<paramdef>unsigned int <parameter>ctrls</parameter></paramdef>
<paramdef>unsigned int *<parameter>ret_flags</parameter></paramdef>
<paramdef>unsigned int *<parameter>ret_ctrls</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<variablelist>
<varlistentry>
<term>
<parameter>display</parameter>
</term>
<listitem>
<para>
connection to X server
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>mask</parameter>
</term>
<listitem>
<para>
mask selecting debug output flags to change
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>flags</parameter>
</term>
<listitem>
<para>
values for debug output flags selected by <parameter>mask</parameter>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>msg</parameter>
</term>
<listitem>
<para>
message to print right now
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>ctrls_mask</parameter>
</term>
<listitem>
<para>
mask selecting debug controls to change
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>ctrls</parameter>
</term>
<listitem>
<para>
values for debug controls selected by <parameter>ctrls_mask</parameter>
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>ret_flags</parameter>
</term>
<listitem>
<para>
resulting state of all debug output flags
</para>
</listitem>
</varlistentry>
<varlistentry>
<term>
<parameter>ret_ctrls</parameter>
</term>
<listitem>
<para>
resulting state of all debug controls
</para>
</listitem>
</varlistentry>
</variablelist>
<para>
<emphasis>