diff options
Diffstat (limited to 'libX11/specs/XKB/ch22.xml')
| -rw-r--r-- | libX11/specs/XKB/ch22.xml | 323 |
1 files changed, 173 insertions, 150 deletions
diff --git a/libX11/specs/XKB/ch22.xml b/libX11/specs/XKB/ch22.xml index 4dea73387..4a3981afa 100644 --- a/libX11/specs/XKB/ch22.xml +++ b/libX11/specs/XKB/ch22.xml @@ -1,3 +1,6 @@ +<?xml version="1.0" encoding="UTF-8" ?> +<!DOCTYPE chapter PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" + "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd"> <chapter id='Debugging_Aids'> <title>Debugging Aids</title> @@ -15,153 +18,175 @@ Both bitmasks are initially all zeros. <para> -To change the values of any of the debug controls, use <emphasis> -XkbSetDebuggingFlags</emphasis> -. +To change the values of any of the debug controls, use +<function>XkbSetDebuggingFlags</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> -XkbSetDebuggingFlags</emphasis> -(<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> +<indexterm significance="preferred" zone="XkbSetDebuggingFlags"><primary><function>XkbSetDebuggingFlags</function></primary></indexterm> +<funcsynopsis id="XkbSetDebuggingFlags"> + <funcprototype> + <funcdef>Bool <function>XkbSetDebuggingFlags</function></funcdef> +<!-- ( +<parameter>display, mask, flags, msg, ctrls_mask, ctrls, ret_flags, ret_ctrls</parameter> +) --> + + <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> -XkbSetDebuggingFlags</emphasis> - modifies the debug output flags as specified by <emphasis> -mask</emphasis> - and <emphasis> -flags</emphasis> -, modifies the debug controls flags as specified by <emphasis> -ctrls_mask</emphasis> - and <emphasis> -ctrls</emphasis> -, prints the message <emphasis> -msg</emphasis> -, and backfills <emphasis> -ret_flags</emphasis> - and <emphasis> -ret_ctrls</emphasis> - with the resulting debug output and debug controls flags. +<function>XkbSetDebuggingFlags</function> +modifies the debug output flags as specified by +<parameter>mask</parameter> +and +<parameter>flags</parameter>, +modifies the debug controls flags as specified by +<parameter>ctrls_mask</parameter> +and +<parameter>ctrls</parameter>, +prints the message +<parameter>msg</parameter>, +and backfills +<parameter>ret_flags</parameter> +and +<parameter>ret_ctrls</parameter> +with the resulting debug output and debug controls flags. </para> <para> -When bits are set in the debug output masks, <emphasis> -mask</emphasis> - and <emphasis> -flags</emphasis> -, Xkb prints debug information corresponding to each bit at appropriate points +When bits are set in the debug output masks, +<parameter>mask</parameter> +and +<parameter>flags</parameter>, +Xkb prints debug information corresponding to each bit at appropriate points during its processing. The device to which the output is written is implementation-dependent, but is normally the same device to which X server -error messages are directed; thus the bits that can be set in <emphasis> -mask</emphasis> - and <emphasis> -flags</emphasis> - is implementation-specific. To turn on a debug output selection, set the bit -for the output in the <emphasis> -mask</emphasis> - parameter and set the corresponding bit in the <emphasis> -flags</emphasis> - parameter. To turn off event selection for an event, set the bit for the -output in the <emphasis> -mask</emphasis> - parameter and do not set the corresponding bit in the <emphasis> -flags</emphasis> - parameter. +error messages are directed; thus the bits that can be set in +<parameter>mask</parameter> +and +<parameter>flags</parameter> +is implementation-specific. To turn on a debug output selection, set the bit +for the output in the +<parameter>mask</parameter> +parameter and set the corresponding bit in the +<parameter>flags</parameter> +parameter. To turn off event selection for an event, set the bit for the +output in the +<parameter>mask</parameter> +parameter and do not set the corresponding bit in the +<parameter>flags</parameter> +parameter. </para> <para> -When bits are set in the debug controls masks, <emphasis> -ctrls_mask</emphasis> - and <emphasis> -ctrls</emphasis> -, Xkb modifies its behavior according to each controls bit. <emphasis> -ctrls_mask</emphasis> - and <emphasis> -ctrls</emphasis> - are related in the same way that <emphasis> -mask</emphasis> - and <emphasis> -flags</emphasis> - are. The valid controls bits are defined in Table 22.1. +When bits are set in the debug controls masks, +<parameter>ctrls_mask</parameter> +and +<parameter>ctrls</parameter>, +Xkb modifies its behavior according to each controls bit. +<parameter>ctrls_mask</parameter> +and +<parameter>ctrls</parameter> +are related in the same way that +<parameter>mask</parameter> +and +<parameter>flags</parameter> +are. The valid controls bits are defined in +<link linkend="table22.1">Table 22.1</link>. </para> -<table frame='topbot'> +<table id='table22.1' frame='topbot'> <title>Debug Control Masks</title> <?dbfo keep-together="always" ?> <tgroup cols='3' align='left' colsep='0' rowsep='0'> @@ -177,7 +202,7 @@ flags</emphasis> </thead> <tbody> <row> - <entry>XkbDF_DisableLocks</entry> + <entry><symbol>XkbDF_DisableLocks</symbol></entry> <entry>(1 << 0)</entry> <entry>Disable actions that lock modifiers</entry> </row> @@ -186,32 +211,30 @@ flags</emphasis> </table> <para> -<emphasis> -XkbSetDebuggingFlags</emphasis> - returns <emphasis> -True</emphasis> - if successful and <emphasis> -False</emphasis> - otherwise. The only protocol error it may generate is <emphasis> -BadAlloc</emphasis> -, if for some reason it is unable to allocate storage. +<function>XkbSetDebuggingFlags</function> +returns +<symbol>True</symbol> +if successful and +<symbol>False</symbol> +otherwise. The only protocol error it may generate is +<errorname>BadAlloc</errorname>, +if for some reason it is unable to allocate storage. </para> <para> -<emphasis> -XkbSetDebuggingFlags</emphasis> - is intended for developer use and may be disabled in production X servers. If -it is disabled, <emphasis> -XkbSetDebuggingFlags</emphasis> - has no effect and does not generate any protocol errors. +<function>XkbSetDebuggingFlags</function> +is intended for developer use and may be disabled in production X servers. If +it is disabled, +<function>XkbSetDebuggingFlags</function> +has no effect and does not generate any protocol errors. </para> <para> -The message in <emphasis> -msg</emphasis> - is written immediately. The device to which it is written is implementation +The message in +<parameter>msg</parameter> +is written immediately. The device to which it is written is implementation dependent but is normally the same device where X server error messages are directed. </para> |