diff options
Diffstat (limited to 'libX11/specs')
| -rw-r--r-- | libX11/specs/libX11/AppA.xml | 3 | ||||
| -rw-r--r-- | libX11/specs/libX11/AppB.xml | 3 | ||||
| -rw-r--r-- | libX11/specs/libX11/AppC.xml | 298 | ||||
| -rw-r--r-- | libX11/specs/libX11/AppD.xml | 131 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH01.xml | 705 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH02.xml | 8 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH03.xml | 12 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH04.xml | 375 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH05.xml | 3 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH06.xml | 35 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH07.xml | 20 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH08.xml | 8 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH09.xml | 5 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH10.xml | 26 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH11.xml | 5 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH12.xml | 13 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH13.xml | 3 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH14.xml | 262 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH15.xml | 20 | ||||
| -rw-r--r-- | libX11/specs/libX11/CH16.xml | 60 | ||||
| -rw-r--r-- | libX11/specs/libX11/credits.xml | 3 | ||||
| -rw-r--r-- | libX11/specs/libX11/glossary.xml | 19 | ||||
| -rw-r--r-- | libX11/specs/libX11/libX11.xml | 2 |
23 files changed, 998 insertions, 1021 deletions
diff --git a/libX11/specs/libX11/AppA.xml b/libX11/specs/libX11/AppA.xml index a59bda63b..fca0003c0 100644 --- a/libX11/specs/libX11/AppA.xml +++ b/libX11/specs/libX11/AppA.xml @@ -1,3 +1,6 @@ +<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<appendix id="xlib_functions_and_protocol_requests">
<title>Xlib Functions and Protocol Requests</title>
<para>
diff --git a/libX11/specs/libX11/AppB.xml b/libX11/specs/libX11/AppB.xml index 8d9886aac..ca435fb01 100644 --- a/libX11/specs/libX11/AppB.xml +++ b/libX11/specs/libX11/AppB.xml @@ -1,3 +1,6 @@ +<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<appendix id="x_font_cursors">
<title>X Font Cursors</title>
<para>
diff --git a/libX11/specs/libX11/AppC.xml b/libX11/specs/libX11/AppC.xml index 69838dc8b..16f7dfddb 100644 --- a/libX11/specs/libX11/AppC.xml +++ b/libX11/specs/libX11/AppC.xml @@ -1,3 +1,6 @@ +<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<appendix id="extensions">
<title>Extensions</title>
<para>
@@ -239,16 +242,16 @@ and is defined in <!-- .LP -->
<indexterm significance="preferred"><primary>XExtCodes</primary></indexterm>
<!-- .sM -->
-<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
+<synopsis>
typedef struct _XExtCodes { /* public to extension, cannot be changed */
- int extension; /* extension number */
+ int extension; /* extension number */
int major_opcode; /* major op-code assigned by server */
int first_event; /* first event number for the extension */
int first_error; /* first error number for the extension */
} XExtCodes;
-</literallayout>
+</synopsis>
</para>
<para>
<!-- .LP -->
@@ -428,12 +431,14 @@ When is called,
your procedure is called
with these arguments:
+<funcsynopsis>
+<funcprototype>
+ <funcdef>int <function>(*<replaceable>proc</replaceable>)</function></funcdef>
+ <paramdef>Display *<parameter>display</parameter></paramdef>
+ <paramdef>XExtCodes *<parameter>codes</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
</para>
-<literallayout class="monospaced">
-(*<emphasis remap='I'>proc</emphasis>)(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>codes</emphasis>)
- Display *<emphasis remap='I'>display</emphasis>;
- XExtCodes *<emphasis remap='I'>codes</emphasis>;
-</literallayout>
<para>
<indexterm significance="preferred"><primary>XESetCreateGC</primary></indexterm>
<!-- .sM -->
@@ -492,16 +497,16 @@ It returns any previously defined procedure, usually NULL. <!-- .LP -->
When a GC is created,
your procedure is called with these arguments:
-</para>
-<para>
<!-- .LP -->
<!-- .sM -->
-<literallayout class="monospaced">
-(*<emphasis remap='I'>proc</emphasis>)(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>gc</emphasis>, <emphasis remap='I'>codes</emphasis>)
- Display *<emphasis remap='I'>display</emphasis>;
- GC <emphasis remap='I'>gc</emphasis>;
- XExtCodes *<emphasis remap='I'>codes</emphasis>;
-</literallayout>
+<funcsynopsis>
+<funcprototype>
+ <funcdef>int <function>(*<replaceable>proc</replaceable>)</function></funcdef>
+ <paramdef>Display *<parameter>display</parameter></paramdef>
+ <paramdef>GC <parameter>gc</parameter></paramdef>
+ <paramdef>XExtCodes *<parameter>codes</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
</para>
<indexterm significance="preferred"><primary>XESetCopyGC</primary></indexterm>
<!-- .sM -->
@@ -559,13 +564,15 @@ It returns any previously defined procedure, usually NULL. <!-- .LP -->
When a GC is copied,
your procedure is called with these arguments:
+<funcsynopsis>
+<funcprototype>
+ <funcdef>int <function>(*<replaceable>proc</replaceable>)</function></funcdef>
+ <paramdef>Display *<parameter>display</parameter></paramdef>
+ <paramdef>GC <parameter>gc</parameter></paramdef>
+ <paramdef>XExtCodes *<parameter>codes</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
</para>
-<literallayout class="monospaced">
-(*<emphasis remap='I'>proc</emphasis>)(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>gc</emphasis>, <emphasis remap='I'>codes</emphasis>)
- Display *<emphasis remap='I'>display</emphasis>;
- GC <emphasis remap='I'>gc</emphasis>;
- XExtCodes *<emphasis remap='I'>codes</emphasis>;
-</literallayout>
<funcsynopsis>
<funcprototype>
<funcdef>int *<function>XESetFreeGC</function></funcdef>
@@ -619,19 +626,19 @@ It returns any previously defined procedure, usually NULL. <!-- .LP -->
When a GC is freed,
your procedure is called with these arguments:
-</para>
-<para>
<!-- .LP -->
<!-- .sM -->
-<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
<!-- .R -->
-(*<emphasis remap='I'>proc</emphasis>)(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>gc</emphasis>, <emphasis remap='I'>codes</emphasis>)
- Display *<emphasis remap='I'>display</emphasis>;
- GC <emphasis remap='I'>gc</emphasis>;
- XExtCodes *<emphasis remap='I'>codes</emphasis>;
-</literallayout>
+<funcsynopsis>
+<funcprototype>
+ <funcdef>int <function>(*<replaceable>proc</replaceable>)</function></funcdef>
+ <paramdef>Display *<parameter>display</parameter></paramdef>
+ <paramdef>GC <parameter>gc</parameter></paramdef>
+ <paramdef>XExtCodes *<parameter>codes</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
</para>
<para>
<!-- .LP -->
@@ -700,19 +707,19 @@ or <function>XQueryFont</function>
is called,
your procedure is called with these arguments:
-</para>
-<para>
<!-- .LP -->
<!-- .sM -->
-<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
<!-- .R -->
-(*<emphasis remap='I'>proc</emphasis>)(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>fs</emphasis>, <emphasis remap='I'>codes</emphasis>)
- Display *<emphasis remap='I'>display</emphasis>;
- XFontStruct *<emphasis remap='I'>fs</emphasis>;
- XExtCodes *<emphasis remap='I'>codes</emphasis>;
-</literallayout>
+<funcsynopsis>
+<funcprototype>
+ <funcdef>int <function>(*<replaceable>proc</replaceable>)</function></funcdef>
+ <paramdef>Display *<parameter>display</parameter></paramdef>
+ <paramdef>XFontStruct *<parameter>fs</parameter></paramdef>
+ <paramdef>XExtCodes *<parameter>codes</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
</para>
<para>
<!-- .LP -->
@@ -776,19 +783,19 @@ It returns any previously defined procedure, usually NULL. When
<function>XFreeFont</function>
is called, your procedure is called with these arguments:
-</para>
-<para>
<!-- .LP -->
<!-- .sM -->
-<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
<!-- .R -->
-(*<emphasis remap='I'>proc</emphasis>)(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>fs</emphasis>, <emphasis remap='I'>codes</emphasis>)
- Display *<emphasis remap='I'>display</emphasis>;
- XFontStruct *<emphasis remap='I'>fs</emphasis>;
- XExtCodes *<emphasis remap='I'>codes</emphasis>;
-</literallayout>
+<funcsynopsis>
+<funcprototype>
+ <funcdef>int <function>(*<replaceable>proc</replaceable>)</function></funcdef>
+ <paramdef>Display *<parameter>display</parameter></paramdef>
+ <paramdef>XFontStruct *<parameter>fs</parameter></paramdef>
+ <paramdef>XExtCodes *<parameter>codes</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
</para>
<para>
<!-- .LP -->
@@ -895,21 +902,19 @@ and modify it before being placed in the queue or otherwise examined. <!-- .NE -->
When Xlib needs to convert an event from wire format to host
format, your procedure is called with these arguments:
-</para>
-<para>
<!-- .LP -->
<!-- .sM -->
-<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
<!-- .R -->
-Status (*<emphasis remap='I'>proc</emphasis>)(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>re</emphasis>, <emphasis remap='I'>event</emphasis>)
- Display *<emphasis remap='I'>display</emphasis>;
- XEvent *<emphasis remap='I'>re</emphasis>;
- xEvent *<emphasis remap='I'>event</emphasis>;
-</literallayout>
-</para>
-<para>
+<funcsynopsis>
+<funcprototype>
+ <funcdef>int <function>(*<replaceable>proc</replaceable>)</function></funcdef>
+ <paramdef>Display *<parameter>display</parameter></paramdef>
+ <paramdef>XEvent *<parameter>re</parameter></paramdef>
+ <paramdef>xEvent *<parameter>event</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
<!-- .LP -->
<!-- .eM -->
Your procedure must return status to indicate if the conversion succeeded.
@@ -1053,21 +1058,19 @@ and modify it before being sent to another client. <!-- .NE -->
When Xlib needs to convert an event from host format to wire format,
your procedure is called with these arguments:
-</para>
-<para>
<!-- .LP -->
<!-- .sM -->
-<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
<!-- .R -->
-(*<emphasis remap='I'>proc</emphasis>)(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>re</emphasis>, <emphasis remap='I'>event</emphasis>)
- Display *<emphasis remap='I'>display</emphasis>;
- XEvent *<emphasis remap='I'>re</emphasis>;
- xEvent *<emphasis remap='I'>event</emphasis>;
-</literallayout>
-</para>
-<para>
+<funcsynopsis>
+<funcprototype>
+ <funcdef>int <function>(*<replaceable>proc</replaceable>)</function></funcdef>
+ <paramdef>Display *<parameter>display</parameter></paramdef>
+ <paramdef>XEvent *<parameter>re</parameter></paramdef>
+ <paramdef>xEvent *<parameter>event</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
<!-- .LP -->
<!-- .eM -->
The re argument is a pointer to the host format event,
@@ -1146,21 +1149,19 @@ X error before it is otherwise examined. <!-- .LP -->
When Xlib needs to convert an error from wire format to host format,
the procedure is called with these arguments:
-</para>
-<para>
<!-- .LP -->
<!-- .sM -->
-<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
<!-- .R -->
-Bool (*<emphasis remap='I'>proc</emphasis>)(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>he</emphasis>, <emphasis remap='I'>we</emphasis>)
- Display *<emphasis remap='I'>display</emphasis>;
- XErrorEvent *<emphasis remap='I'>he</emphasis>;
- xError *<emphasis remap='I'>we</emphasis>;
-</literallayout>
-</para>
-<para>
+<funcsynopsis>
+<funcprototype>
+ <funcdef>int <function>(*<replaceable>proc</replaceable>)</function></funcdef>
+ <paramdef>Display *<parameter>display</parameter></paramdef>
+ <paramdef>XErrorEvent *<parameter>he</parameter></paramdef>
+ <paramdef>xError *<parameter>we</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
<!-- .LP -->
<!-- .eM -->
The he argument is a pointer to where the host format error should be stored.
@@ -1234,22 +1235,20 @@ case, and are typically programmed to be synchronous). When Xlib detects a protocol error in
<function>_XReply</function>,
it calls your procedure with these arguments:
-</para>
-<para>
<!-- .LP -->
<!-- .sM -->
-<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
<!-- .R -->
-int (*<emphasis remap='I'>proc</emphasis>)(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>err</emphasis>, <emphasis remap='I'>codes</emphasis>, <emphasis remap='I'>ret_code</emphasis>)
- Display *<emphasis remap='I'>display</emphasis>;
- xError *<emphasis remap='I'>err</emphasis>;
- XExtCodes *<emphasis remap='I'>codes</emphasis>;
- int *<emphasis remap='I'>ret_code</emphasis>;
-</literallayout>
-</para>
-<para>
+<funcsynopsis>
+<funcprototype>
+ <funcdef>int <function>(*<replaceable>proc</replaceable>)</function></funcdef>
+ <paramdef>Display *<parameter>display</parameter></paramdef>
+ <paramdef>xError *<parameter>err</parameter></paramdef>
+ <paramdef>XExtCodes *<parameter>codes</parameter></paramdef>
+ <paramdef>int *<parameter>ret_code</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
<!-- .LP -->
<!-- .eM -->
The err argument is a pointer to the 32-byte wire format error.
@@ -1326,19 +1325,19 @@ The following is an example. <para>
<!-- .LP -->
<!-- .sM -->
-<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
<!-- .R -->
-(*<emphasis remap='I'>proc</emphasis>)(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>code</emphasis>, <emphasis remap='I'>codes</emphasis>, <emphasis remap='I'>buffer</emphasis>, <emphasis remap='I'>nbytes</emphasis>)
- Display *<emphasis remap='I'>display</emphasis>;
- int <emphasis remap='I'>code</emphasis>;
- XExtCodes *<emphasis remap='I'>codes</emphasis>;
- char *<emphasis remap='I'>buffer</emphasis>;
- int <emphasis remap='I'>nbytes</emphasis>;
-</literallayout>
-</para>
-<para>
+<funcsynopsis>
+<funcprototype>
+ <funcdef>int <function>(*<replaceable>proc</replaceable>)</function></funcdef>
+ <paramdef>Display *<parameter>display</parameter></paramdef>
+ <paramdef>int <parameter>code</parameter></paramdef>
+ <paramdef>XExtCodes *<parameter>codes</parameter></paramdef>
+ <paramdef>char *<parameter>buffer</parameter></paramdef>
+ <paramdef>int <parameter>nbytes</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
<!-- .LP -->
<!-- .eM -->
Your procedure is called with the error code for every error detected.
@@ -1403,21 +1402,19 @@ It returns any previously defined procedure. <!-- .LP -->
When Xlib needs to print an error,
the procedure is called with these arguments:
-</para>
-<para>
<!-- .LP -->
<!-- .sM -->
-<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
<!-- .R -->
-void (*<emphasis remap='I'>proc</emphasis>)(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>ev</emphasis>, <emphasis remap='I'>fp</emphasis>)
- Display *<emphasis remap='I'>display</emphasis>;
- XErrorEvent *<emphasis remap='I'>ev</emphasis>;
- void *<emphasis remap='I'>fp</emphasis>;
-</literallayout>
-</para>
-<para>
+<funcsynopsis>
+<funcprototype>
+ <funcdef>void <function>(*<replaceable>proc</replaceable>)</function></funcdef>
+ <paramdef>Display *<parameter>display</parameter></paramdef>
+ <paramdef>XErrorEvent *<parameter>ev</parameter></paramdef>
+ <paramdef>void *<parameter>fp</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
<!-- .LP -->
<!-- .eM -->
The structure pointed at by ev is guaranteed to be as large as an
@@ -1532,22 +1529,20 @@ The function defines a procedure to be called when data is about to be
sent to the server. When data is about to be sent, your procedure is
called one or more times with these arguments:
-</para>
-<para>
<!-- .LP -->
<!-- .sM -->
-<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
<!-- .R -->
-void (*<emphasis remap='I'>proc</emphasis>)(<emphasis remap='I'>display</emphasis>, <emphasis remap='I'>codes</emphasis>, <emphasis remap='I'>data</emphasis>, <emphasis remap='I'>len</emphasis>)
- Display *<emphasis remap='I'>display</emphasis>;
- XExtCodes *<emphasis remap='I'>codes</emphasis>;
- char *<emphasis remap='I'>data</emphasis>;
- long <emphasis remap='I'>len</emphasis>;
-</literallayout>
-</para>
-<para>
+<funcsynopsis>
+<funcprototype>
+ <funcdef>void <function>(*<replaceable>proc</replaceable>)</function></funcdef>
+ <paramdef>Display *<parameter>display</parameter></paramdef>
+ <paramdef>XExtCodes *<parameter>codes</parameter></paramdef>
+ <paramdef>char *<parameter>data</parameter></paramdef>
+ <paramdef>long <parameter>len</parameter></paramdef>
+</funcprototype>
+</funcsynopsis>
<!-- .LP -->
<!-- .eM -->
The data argument specifies a portion of the outgoing data buffer,
@@ -1583,16 +1578,16 @@ and is defined in <!-- .LP -->
<indexterm significance="preferred"><primary>XExtData</primary></indexterm>
<!-- .sM -->
-<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
+<synopsis>
typedef struct _XExtData {
int number; /* number returned by XInitExtension */
struct _XExtData *next; /* next item on list of data for structure */
int (*free_private)(); /* if defined, called to free private */
XPointer private_data; /* data private to this extension. */
} XExtData;
-</literallayout>
+</synopsis>
</para>
<para>
<!-- .LP -->
@@ -1606,16 +1601,16 @@ and the structure itself. <para>
<!-- .LP -->
<!-- .sM -->
-<literallayout class="monospaced">
<!-- .TA .5i -->
<!-- .ta .5i -->
+<synopsis>
union { Display *display;
GC gc;
Visual *visual;
Screen *screen;
ScreenFormat *pixmap_format;
XFontStruct *font } XEDataObject;
-</literallayout>
+</synopsis>
</para>
<para>
<!-- .LP -->
@@ -1971,12 +1966,9 @@ For example, here is the source for the stub.
(Writing extension stubs is discussed in the next section.)
</para>
-<itemizedlist>
- <listitem>
- <para>
<!-- .sM -->
<!-- .nf -->
-
+<programlisting>
#include <X11/Xlibint.h>
/* precompute the maximum size of batching request allowed */
@@ -2020,10 +2012,8 @@ XDrawPoint(dpy, d, gc, x, y) UnlockDisplay(dpy);
SyncHandle();
}
+</programlisting>
<!-- .fi -->
- </para>
- </listitem>
-</itemizedlist>
<para>
<!-- .LP -->
<!-- .eM -->
@@ -2088,10 +2078,10 @@ that looks similar to this: </para>
<para>
<!-- .LP -->
-<literallayout class="monospaced">
<!-- .R -->
+<programlisting>
#define X_DoSomething 42
-</literallayout>
+</programlisting>
In your extension header file,
this will be a minor opcode,
instead of a major opcode.
@@ -2151,18 +2141,18 @@ which looks like: <!-- .LP -->
<indexterm significance="preferred"><primary>xDoSomethingReq</primary></indexterm>
<!-- .sM -->
-<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
+<synopsis>
typedef struct _DoSomethingReq {
- CARD8 reqType; /* X_DoSomething */
+ CARD8 reqType; /* X_DoSomething */
CARD8 someDatum; /* used differently in different requests */
CARD16 length B16; /* total # of bytes in request, divided by 4 */
...
/* request-specific data */
...
} xDoSomethingReq;
-</literallayout>
+</synopsis>
</para>
<para>
<!-- .LP -->
@@ -2189,16 +2179,16 @@ or <!-- .LP -->
<indexterm significance="preferred"><primary>xResourceReq</primary></indexterm>
<!-- .sM -->
-<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
+<synopsis>
typedef struct _ResourceReq {
CARD8 reqType; /* the request type, e.g. X_DoSomething */
BYTE pad; /* not used */
CARD16 length B16; /* 2 (= total # of bytes in request, divided by 4) */
CARD32 id B32; /* the Window, Drawable, Font, GContext, etc. */
} xResourceReq;
-</literallayout>
+</synopsis>
</para>
<para>
<!-- .LP -->
@@ -2239,9 +2229,9 @@ also contains a reply structure typedef: <!-- .LP -->
<indexterm significance="preferred"><primary>xDoSomethingReply</primary></indexterm>
<!-- .sM -->
-<literallayout class="monospaced">
<!-- .TA .5i 3i -->
<!-- .ta .5i 3i -->
+<synopsis>
typedef struct _DoSomethingReply {
BYTE type; /* always X_Reply */
BYTE someDatum; /* used differently in different requests */
@@ -2251,7 +2241,7 @@ typedef struct _DoSomethingReply { /* request-specific data */
...
} xDoSomethingReply;
-</literallayout>
+</synopsis>
</para>
<para>
<!-- .LP -->
@@ -2305,8 +2295,8 @@ An Xlib stub procedure should start like this: </para>
<para>
<!-- .LP -->
-<literallayout class="monospaced">
<!-- .R -->
+<programlisting>
#include "<X11/Xlibint.h>
XDoSomething (arguments, ... )
@@ -2315,17 +2305,17 @@ XDoSomething (arguments, ... ) register XDoSomethingReq *req;
...
-</literallayout>
+</programlisting>
If the protocol request has a reply,
then the variable declarations should include the reply structure for the request.
The following is an example:
</para>
<para>
<!-- .LP -->
-<literallayout class="monospaced">
<!-- .R -->
+<programlisting>
xDoSomethingReply rep;
-</literallayout>
+</programlisting>
<!-- .SH -->
Locking Data Structures
</para>
@@ -2408,10 +2398,10 @@ then use </para>
<para>
<!-- .LP -->
-<literallayout class="monospaced">
<!-- .R -->
+<programlisting>
GetEmptyReq (DoSomething, req);
-</literallayout>
+</programlisting>
If the protocol request has a single 32-bit argument (such as a
<type>Pixmap</type>,
<type>Window</type>,
@@ -2426,10 +2416,10 @@ is a good example. </para>
<para>
<!-- .LP -->
-<literallayout class="monospaced">
<!-- .R -->
+<programlisting>
GetResReq (DoSomething, rid, req);
-</literallayout>
+</programlisting>
The rid argument is the
<type>Pixmap</type>,
<type>Window</type>,
@@ -2447,14 +2437,14 @@ usually from arguments to the stub procedure. </para>
<para>
<!-- .LP -->
-<literallayout class="monospaced">
<!-- .R -->
+<programlisting>
GetReq (DoSomething, req);
/* fill in arguments here */
req->arg1 = arg1;
req->arg2 = arg2;
...
-</literallayout>
+</programlisting>
A few stub procedures (such as
<function>XCreateGC</function>
and
@@ -2468,12 +2458,12 @@ that were assigned to this client when it opened the connection. </para>
<para>
<!-- .LP -->
-<literallayout class="monospaced">
<!-- .R -->
+<programlisting>
rid = req->rid = XAllocID();
...
return (rid);
-</literallayout>
+</programlisting>
Finally, some stub procedures transmit a fixed amount of variable-length
data after the request.
Typically, these procedures (such as
@@ -2515,10 +2505,10 @@ then you must round the length up and shift it before adding: </para>
<para>
<!-- .LP -->
-<literallayout class="monospaced">
<!-- .R -->
+<programlisting>
req->length += (nbytes+3)>>2;
-</literallayout>
+</programlisting>
To transmit variable-length data, use the
<function>Data</function>
macros.
@@ -2736,8 +2726,8 @@ data, you write something like: </para>
<para>
<!-- .LP -->
-<literallayout class="monospaced">
<!-- .R -->
+<programlisting>
_XReply(display, (xReply *)&rep, 0, True);
*ret1 = rep.ret1;
*ret2 = rep.ret2;
@@ -2747,7 +2737,7 @@ UnlockDisplay(dpy); SyncHandle();
return (rep.ret4);
}
-</literallayout>
+</programlisting>
If there is variable-length data after the reply,
change the
<symbol>True</symbol>
diff --git a/libX11/specs/libX11/AppD.xml b/libX11/specs/libX11/AppD.xml index 40778f124..0d060069e 100644 --- a/libX11/specs/libX11/AppD.xml +++ b/libX11/specs/libX11/AppD.xml @@ -1,17 +1,17 @@ +<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE appendix PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<appendix id="compatibility_functions">
<title>Compatibility Functions</title>
<para>
-<!-- .LP -->
The X Version 11 and X Version 10 functions discussed in this appendix
are obsolete, have been superseded by newer X Version 11 functions,
and are maintained for compatibility reasons only.
-<!-- .SH -->
-X Version 11 Compatibility Functions
</para>
+<sect1 id="X_Version_11_Compatibility_Functions">
+<title>X Version 11 Compatibility Functions</title>
<para>
-<!-- .LP -->
You can use the X Version 11 compatibility functions to:
-</para>
<itemizedlist>
<listitem>
<para>
@@ -38,21 +38,21 @@ Parse window geometry <listitem>
<para>
Get X environment defaults
-<!-- .SH -->
-Setting Standard Properties
</para>
</listitem>
</itemizedlist>
+</para>
+<sect2 id="Setting_Standard_Properties">
+<title>Setting Standard Properties</title>
<para>
-<!-- .LP -->
To specify a minimum set of properties describing the simplest application,
use
<function>XSetStandardProperties</function>.
This function has been superseded by
<function>XSetWMProperties</function>
and sets all or portions of the
-WM_NAME, WM_ICON_NAME, WM_HINTS, WM_COMMAND,
-and WM_NORMAL_HINTS properties.
+<property>WM_NAME</property>, <property>WM_ICON_NAME</property>, <property>WM_HINTS</property>, <property>WM_COMMAND</property>,
+and <property>WM_NORMAL_HINTS</property> properties.
<indexterm significance="preferred"><primary>XSetStandardProperties</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@@ -180,19 +180,20 @@ can generate and
<errorname>BadWindow</errorname>
errors.
-<!-- .SH -->
</para>
+</sect2>
+<sect2 id="Setting_and_Getting_Window_Sizing_Hints">
+<title>Setting and Getting Window Sizing Hints</title>
<para>
-Setting and Getting Window Sizing Hints
-</para>
-<para>
-<!-- .LP -->
Xlib provides functions that you can use to set or get window sizing hints.
The functions discussed in this section use the flags and the
<structname>XSizeHints</structname>
structure, as defined in the
-<<filename class="headerfile">X11/Xutil.h</filename>>
-header file and use the WM_NORMAL_HINTS property.
+<filename class="headerfile"><X11/Xutil.h></filename>
+<indexterm type="file"><primary><filename class="headerfile">X11/Xutil.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
+header file and use the <property>WM_NORMAL_HINTS</property> property.
</para>
<para>
<!-- .LP -->
@@ -353,7 +354,7 @@ error. <para>
<!-- .LP -->
<!-- .sp -->
-The next two functions set and read the WM_ZOOM_HINTS property.
+The next two functions set and read the <property>WM_ZOOM_HINTS</property> property.
</para>
<para>
<!-- .LP -->
@@ -494,7 +495,7 @@ error. <para>
<!-- .LP -->
<!-- .sp -->
-To set the value of any property of type WM_SIZE_HINTS, use
+To set the value of any property of type <property>WM_SIZE_HINTS</property>, use
<function>XSetSizeHints</function>.
This function has been superseded by
<function>XSetWMSizeHints</function>.
@@ -565,7 +566,7 @@ This is used by <function>XSetNormalHints</function>
and
<function>XSetZoomHints</function>
-and can be used to set the value of any property of type WM_SIZE_HINTS.
+and can be used to set the value of any property of type <property>WM_SIZE_HINTS</property>.
Thus, it may be useful if other properties of that type get defined.
</para>
<para>
@@ -581,7 +582,7 @@ errors. <para>
<!-- .LP -->
<!-- .sp -->
-To read the value of any property of type WM_SIZE_HINTS, use
+To read the value of any property of type <property>WM_SIZE_HINTS</property>, use
<function>XGetSizeHints</function>.
This function has been superseded by
<function>XGetWMSizeHints</function>.
@@ -653,7 +654,7 @@ This is used by and
<function>XGetZoomHints</function>.
It also can be used to retrieve the value of any property of type
-WM_SIZE_HINTS.
+<property>WM_SIZE_HINTS</property>.
Thus, it may be useful if other properties of that type get defined.
<function>XGetSizeHints</function>
returns a nonzero status if a size hint was defined
@@ -667,11 +668,11 @@ can generate and
<errorname>BadWindow</errorname>
errors.
-<!-- .SH -->
-Getting and Setting an XStandardColormap Structure
</para>
+</sect2>
+<sect2 id="Getting_and_Setting_an_XStandardColormap_Structure">
+<title>Getting and Setting an XStandardColormap Structure</title>
<para>
-<!-- .LP -->
To get the
<structname>XStandardColormap</structname>
structure associated with one of the described atoms, use
@@ -749,19 +750,9 @@ colormap for a display, you use
<function>XGetStandardColormap</function>
with the following syntax:
-</para>
-<para>
-<!-- .LP -->
-<!-- .sM -->
-<literallayout class="monospaced">
-<!-- .TA .5i 1.5i -->
-<!-- .ta .5i 1.5i -->
+<programlisting>
XGetStandardColormap(dpy, DefaultRootWindow(dpy), &cmap, XA_RGB_GRAY_MAP);
-</literallayout>
-</para>
-<para>
-<!-- .LP -->
-<!-- .eM -->
+</programlisting>
See section 14.3 for the semantics of standard colormaps.
</para>
<para>
@@ -852,11 +843,11 @@ can generate and
<errorname>BadWindow</errorname>
errors.
-<!-- .SH -->
-Parsing Window Geometry
</para>
+</sect2>
+<sect2 id="Parsing_Window_Geometry">
+<title>Parsing Window Geometry</title>
<para>
-<!-- .LP -->
To parse window geometry given a user-specified position
and a default position, use
<function>XGeometry</function>.
@@ -1051,13 +1042,11 @@ The x and y coordinates are computed by using the border width, the screen width and height, padding as specified by xadder and yadder,
and the fheight and fwidth times the width and height from the
geometry specifications.
-<!-- .SH -->
-</para>
-<para>
-Getting the X Environment Defaults
</para>
+</sect2>
+<sect2 id="Getting_the_X_Environment_Defaults">
+<title>Getting the X Environment Defaults</title>
<para>
-<!-- .LP -->
The
<function>XGetDefault</function>
function provides a primitive interface to the resource manager facilities
@@ -1161,13 +1150,13 @@ looks for "<filename>$HOME/.Xdefaults-<replaceable>name</replaceable></filename>" ,
where <replaceable>name</replaceable> specifies the name of the machine on which the application
is running.
-<!-- .SH -->
-X Version 10 Compatibility Functions
</para>
+</sect2>
+</sect1>
+<sect1 id="X_Version_10_Compatibility_Functions">
+<title>X Version 10 Compatibility Functions</title>
<para>
-<!-- .LP -->
You can use the X Version 10 compatibility functions to:
-</para>
<itemizedlist>
<listitem>
<para>
@@ -1177,11 +1166,12 @@ Draw and fill polygons and curves <listitem>
<para>
Associate user data with a value
-<!-- .SH -->
-Drawing and Filling Polygons and Curves
</para>
</listitem>
</itemizedlist>
+</para>
+<sect2 id="Drawing_and_Filling_Polygons_and_Curves">
+<title>Drawing and Filling Polygons and Curves</title>
<para>
<!-- .LP -->
Xlib provides functions that you can use to draw or fill
@@ -1339,25 +1329,18 @@ vertex structure. <para>
<!-- .LP -->
Each Vertex, as defined in
-<<filename class="headerfile">X11/X10.h</filename>>,
+<filename class="headerfile"><X11/X10.h></filename>,
+<indexterm type="file"><primary><filename class="headerfile">X11/X10.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/X10.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/X10.h></filename></secondary></indexterm>
is a structure with the following members:
-</para>
-<para>
-<!-- .LP -->
<indexterm significance="preferred"><primary>Vertex</primary></indexterm>
-<!-- .sM -->
-<literallayout class="monospaced">
-<!-- .TA .5i 1.5i -->
-<!-- .ta .5i 1.5i -->
+<synopsis>
typedef struct _Vertex {
short x,y;
unsigned short flags;
} Vertex;
-</literallayout>
-</para>
-<para>
-<!-- .LP -->
-<!-- .eM -->
+</synopsis>
The x and y members are the coordinates of the vertex
that are relative to either the upper left inside corner of the drawable
(if
@@ -1369,7 +1352,10 @@ is one). <para>
<!-- .LP -->
The flags, as defined in
-<<filename class="headerfile">X11/X10.h</filename>>,
+<filename class="headerfile"><X11/X10.h></filename>,
+<indexterm type="file"><primary><filename class="headerfile">X11/X10.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/X10.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/X10.h></filename></secondary></indexterm>
are as follows:
<indexterm significance="preferred"><primary>VertexRelative</primary></indexterm>
<indexterm significance="preferred"><primary>VertexDontDraw</primary></indexterm>
@@ -1377,15 +1363,14 @@ are as follows: <indexterm significance="preferred"><primary>VertexStartClosed</primary></indexterm>
<indexterm significance="preferred"><primary>VertexEndClosed</primary></indexterm>
<!-- .sM -->
-</para>
-<literallayout class="monospaced">
+<synopsis>
VertexRelative 0x0001 /* else absolute */
VertexDontDraw 0x0002 /* else draw */
VertexCurved 0x0004 /* else straight */
VertexStartClosed 0x0008 /* else not */
VertexEndClosed 0x0010 /* else not */
-</literallayout>
+</synopsis>
<itemizedlist>
<listitem>
@@ -1449,6 +1434,7 @@ and successor vertices for the spline algorithm. </para>
</listitem>
</itemizedlist>
+</para>
<para>
<!-- .LP -->
This function uses these GC components:
@@ -1555,9 +1541,10 @@ It also uses these GC mode-dependent components: foreground, background, tile, stipple,
tile-stipple-x-origin, tile-stipple-y-origin,
dash-offset, dash-list, fill-style, and fill-rule.
-<!-- .SH -->
-Associating User Data with a Value
</para>
+</sect2>
+<sect2 id="Associating_User_Data_with_a_Value">
+<title>Associating User Data with a Value</title>
<para>
<!-- .LP -->
These functions have been superseded by the context management functions
@@ -1865,7 +1852,7 @@ function deletes an association in an <function>XAssocTable</function>
keyed on its XID.
Redundant deletes (and deletes of nonexistent XIDs) are ignored.
-Deleting associations in no way impairs the performance of an
+Deleting associations in no way impairs the performance of an
<function>XAssocTable</function>.
</para>
<para>
@@ -1897,4 +1884,6 @@ Specifies the assoc table. </listitem>
</varlistentry>
</variablelist>
+</sect2>
+</sect1>
</appendix>
diff --git a/libX11/specs/libX11/CH01.xml b/libX11/specs/libX11/CH01.xml index 523eedad0..c8d8dcc6c 100644 --- a/libX11/specs/libX11/CH01.xml +++ b/libX11/specs/libX11/CH01.xml @@ -1,70 +1,74 @@ -<chapter><title>Introduction to Xlib</title>
+<?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="Introduction_to_Xlib"><title>Introduction to Xlib</title>
-<para>
-The X Window System is a network-transparent window system that was designed at MIT. X
-display servers run on computers with either monochrome or color bitmap display hardware. The
-server distributes user input to and accepts output requests from various client programs located
-either on the same machine or elsewhere in the network. Xlib is a C subroutine library that appli-
-cation programs (clients) use to interface with the window system by means of a stream connec-
-tion. Although a client usually runs on the same machine as the X server it is talking to, this need
-not be the case.
-</para>
-<para>
-Xlib − C Language X Interface is a reference guide to the low-level C language interface to the X
-Window System protocol. It is neither a tutorial nor a user’s guide to programming the X Win-
-dow System. Rather, it provides a detailed description of each function in the library as well as a
-discussion of the related background information. Xlib − C Language X Interface assumes a
-basic understanding of a graphics window system and of the C programming language. Other
-higher-level abstractions (for example, those provided by the toolkits for X) are built on top of the
-Xlib library. For further information about these higher-level libraries, see the appropriate toolkit
-documentation. The X Window System Protocol provides the definitive word on the behavior of
-X. Although additional information appears here, the protocol document is the ruling document.
-</para>
-<para>
+ <para>
+The X Window System is a network-transparent window system that was
+designed at MIT. X display servers run on computers with either
+monochrome or color bitmap display hardware. The server distributes
+user input to and accepts output requests from various client programs
+located either on the same machine or elsewhere in the network. Xlib
+is a C subroutine library that application programs (clients) use to
+interface with the window system by means of a stream connection.
+Although a client usually runs on the same machine as the X server
+it is talking to, this need not be the case.
+ </para>
+ <para>
+<citetitle>Xlib − C Language X Interface</citetitle> is a reference
+guide to the low-level C language interface to the X Window System
+protocol. It is neither a tutorial nor a user’s guide to programming
+the X Window System. Rather, it provides a detailed description of
+each function in the library as well as a discussion of the related
+background information. <citetitle>Xlib − C Language X Interface</citetitle>
+assumes a basic understanding of a graphics window system and of the C
+programming language. Other higher-level abstractions (for example,
+those provided by the toolkits for X) are built on top of the Xlib
+library. For further information about these higher-level libraries,
+see the appropriate toolkit documentation.
+The <citetitle>X Window System Protocol</citetitle> provides the
+definitive word on the behavior of X.
+Although additional information appears here, the protocol document is
+the ruling document.
+ </para>
+ <para>
To provide an introduction to X programming, this chapter discusses:
-</para>
-<itemizedlist>
- <listitem><para>Overview of the X Window System</para></listitem>
- <listitem><para>Errors</para></listitem>
- <listitem><para>Standard header files</para></listitem>
- <listitem><para>Generic values and types</para></listitem>
- <listitem><para>Naming and argument conventions within Xlib</para></listitem>
- <listitem><para>Programming considerations</para></listitem>
- <listitem><para>Character sets and encodings</para></listitem>
- <listitem><para>Formatting conventions</para></listitem>
-</itemizedlist>
+ <itemizedlist>
+ <listitem><para><link linkend="Overview_of_the_X_Window_System">Overview of the X Window System</link></para></listitem>
+ <listitem><para><link linkend="Errors">Errors</link></para></listitem>
+ <listitem><para><link linkend="Standard_Header_Files">Standard header files</link></para></listitem>
+ <listitem><para><link linkend="Generic_Values_and_Types">Generic values and types</link></para></listitem>
+ <listitem><para><link linkend="Naming_and_Argument_Conventions_within_Xlib">Naming and argument conventions within Xlib</link></para></listitem>
+ <listitem><para><link linkend="Programming_Considerations">Programming considerations</link></para></listitem>
+ <listitem><para><link linkend="Character_Sets_and_Encodings">Character sets and encodings</link></para></listitem>
+ <listitem><para><link linkend="Formatting_Conventions">Formatting conventions</link></para></listitem>
+ </itemizedlist>
+ </para>
-
-<sect1 id="Overview_of_the_X_Window_System">
-<title>Overview of the X Window System</title>
-<!-- .XS -->
-<!-- (SN Overview of the X Window System -->
-<!-- .XE -->
-<para>
-<!-- .LP -->
+ <sect1 id="Overview_of_the_X_Window_System">
+ <title>Overview of the X Window System</title>
+ <para>
Some of the terms used in this book are unique to X,
-and other terms that are common to other window systems
-have different meanings in X.
-You may find it helpful to refer to the glossary,
+and other terms that are common to other window systems
+have different meanings in X. You may find it helpful to refer to
+<link linkend="glossary">the glossary</link>,
which is located at the end of the book.
-</para>
-<para>
-<!-- .LP -->
+ </para>
+ <para>
The X Window System supports one or more screens containing
overlapping windows or subwindows.
-A screen is a physical monitor and hardware
+<indexterm><primary>Screen</primary></indexterm>
+A <firstterm>screen</firstterm> is a physical monitor and hardware
that can be color, grayscale, or monochrome.
There can be multiple screens for each display or workstation.
A single X server can provide display services for any number of screens.
A set of screens for a single user with one keyboard and one pointer
-(usually a mouse) is called a display.
-</para>
-<para>
-<!-- .LP -->
-<indexterm><primary>Screen</primary></indexterm>
+(usually a mouse) is called a <firstterm>display</firstterm>.
+ </para>
+ <para>
All the windows in an X server are arranged in strict hierarchies.
-At the top of each hierarchy is a root window,
+At the top of each hierarchy is a <firstterm>root window</firstterm>,
which covers each of the display screens.
Each root window is partially or completely covered by child windows.
All windows, except for root windows, have parents.
@@ -72,29 +76,27 @@ There is usually at least one window for each application program. <indexterm><primary>Child window</primary></indexterm>
<indexterm><primary>Parent Window</primary></indexterm>
Child windows may in turn have their own children.
-In this way,
-an application program can create an arbitrarily deep tree
+In this way,
+an application program can create an arbitrarily deep tree
on each screen.
X provides graphics, text, and raster operations for windows.
-</para>
-<para>
-<!-- .LP -->
-A child window can be larger than its parent.
+ </para>
+ <para>
+A child window can be larger than its parent.
That is, part or all of
the child window can extend beyond the boundaries of the parent,
but all output to a window is clipped by its parent.
<indexterm><primary>Stacking order</primary></indexterm>
-If several children of a window have overlapping locations,
+If several children of a window have overlapping locations,
one of the children is considered to be on top of or raised over the
others, thus obscuring them.
Output to areas covered by other windows is suppressed by the window
system unless the window has backing store.
-If a window is obscured by a second window,
+If a window is obscured by a second window,
the second window obscures only those ancestors of the second window
that are also ancestors of the first window.
-</para>
-<para>
-<!-- .LP -->
+ </para>
+ <para>
<indexterm significance="preferred"><primary>Window</primary></indexterm>
A window has a border zero or more pixels in width, which can
be any pattern (pixmap) or solid color you like.
@@ -103,43 +105,40 @@ which will be repainted by the window system when uncovered. Child windows obscure their parents,
and graphic operations in the parent window usually
are clipped by the children.
-</para>
-<para>
-<!-- .LP -->
+ </para>
+ <para>
Each window and pixmap has its own coordinate system.
The coordinate system has the X axis horizontal and the Y axis vertical
with the origin [0, 0] at the upper-left corner.
Coordinates are integral,
in terms of pixels,
and coincide with pixel centers.
-For a window,
+For a window,
the origin is inside the border at the inside, upper-left corner.
-</para>
-<para>
-<!-- .LP -->
-X does not guarantee to preserve the contents of windows.
+ </para>
+ <para>
+X does not guarantee to preserve the contents of windows.
When part or all of a window is hidden and then brought back onto the screen,
-its contents may be lost.
+its contents may be lost.
The server then sends the client program an
-<symbol>Expose</symbol>
+<systemitem class="event">Expose</systemitem>
event to notify it that part or all of the window needs to be repainted.
Programs must be prepared to regenerate the contents of windows on demand.
-</para>
-<para>
-<!-- .LP -->
+ </para>
+ <para>
<indexterm><primary>Pixmap</primary></indexterm>
<indexterm><primary>Drawable</primary></indexterm>
<indexterm><primary>Tile</primary></indexterm>
<indexterm><primary>Bitmap</primary></indexterm>
X also provides off-screen storage of graphics objects,
-called pixmaps.
-Single plane (depth 1) pixmaps are sometimes referred to as bitmaps.
+called <firstterm linkend="glossary:Pixmap">pixmaps</firstterm>.
+Single plane (depth 1) pixmaps are sometimes referred to as
+<firstterm>bitmaps</firstterm>.
Pixmaps can be used in most graphics functions interchangeably with
windows and are used in various graphics operations to define patterns or tiles.
Windows and pixmaps together are referred to as drawables.
-</para>
-<para>
-<!-- .LP -->
+ </para>
+ <para>
Most of the functions in Xlib just add requests to an output buffer.
These requests later execute asynchronously on the X server.
Functions that return values of information stored in
@@ -147,39 +146,41 @@ the server do not return (that is, they block) until an explicit reply is received or an error occurs.
You can provide an error handler,
which will be called when the error is reported.
-</para>
-<para>
-<!-- .LP -->
+ </para>
+ <para>
<indexterm><primary>XSync</primary></indexterm>
-If a client does not want a request to execute asynchronously,
-it can follow the request with a call to
+If a client does not want a request to execute asynchronously,
+it can follow the request with a call to
<function>XSync</function>,
which blocks until all previously buffered
asynchronous events have been sent and acted on.
-As an important side effect,
+As an important side effect,
the output buffer in Xlib is always flushed by a call to any function
that returns a value from the server or waits for input.
-</para>
-<para>
-<!-- .LP -->
+ </para>
+ <para>
<indexterm><primary>Resource IDs</primary></indexterm>
<indexterm><primary>Resource IDs</primary><secondary>Window</secondary></indexterm>
<indexterm><primary>Resource IDs</primary><secondary>Font</secondary></indexterm>
<indexterm><primary>Resource IDs</primary><secondary>Pixmap</secondary></indexterm>
+<indexterm><primary>Resource IDs</primary><secondary>Colormap</secondary></indexterm>
<indexterm><primary>Resource IDs</primary><secondary>Cursor</secondary></indexterm>
<indexterm><primary>Resource IDs</primary><secondary>GContext</secondary></indexterm>
Many Xlib functions will return an integer resource ID,
which allows you to refer to objects stored on the X server.
-These can be of type
+These can be of type
<type>Window</type>,
<type>Font</type>,
<type>Pixmap</type>,
<type>Colormap</type>,
<type>Cursor</type>,
-and
+and
<type>GContext</type>,
as defined in the file
-<<filename class="headerfile">X11/X.h</filename>>.
+<filename class="headerfile"><X11/X.h></filename>.
+<indexterm type="file"><primary><filename class="headerfile">X11/X.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/X.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/X.h></filename></secondary></indexterm>
These resources are created by requests and are destroyed
(or freed) by requests or when connections are closed.
Most of these resources are potentially sharable between
@@ -189,23 +190,21 @@ Fonts and cursors are shared automatically across multiple screens. Fonts are loaded and unloaded as needed and are shared by multiple clients.
Fonts are often cached in the server.
Xlib provides no support for sharing graphics contexts between applications.
-</para>
-<para>
-<!-- .LP -->
+ </para>
+ <para>
<indexterm><primary>Event</primary></indexterm>
Client programs are informed of events.
Events may either be side effects of a request (for example, restacking windows
-generates
-<symbol>Expose</symbol>
+generates
+<systemitem class="event">Expose</systemitem>
events) or completely asynchronous (for example, from the keyboard).
A client program asks to be informed of events.
Because other applications can send events to your application,
programs must be prepared to handle (or ignore) events of all types.
-</para>
-<para>
-<!-- .LP -->
-Input events (for example, a key pressed or the pointer moved)
-arrive asynchronously from the server and are queued until they are
+ </para>
+ <para>
+Input events (for example, a key pressed or the pointer moved)
+arrive asynchronously from the server and are queued until they are
requested by an explicit call (for example,
<function>XNextEvent</function>
or
@@ -213,7 +212,7 @@ or In addition, some library
functions (for example,
<function>XRaiseWindow</function>)
-generate
+generate
<symbol>Expose</symbol>
and
<symbol>ConfigureRequest</symbol>
@@ -223,70 +222,66 @@ These events also arrive asynchronously, but the client may wish to explicitly wait for them by calling
<function>XSync</function>
after calling a function that can cause the server to generate events.
-</para>
-</sect1>
-<sect1 id="Errors">
-<title>Errors</title>
-<!-- .XS -->
-<!-- (SN Errors -->
-<!-- .XE -->
-<para>
-<!-- .LP -->
-Some functions return
+ </para>
+ </sect1>
+
+ <sect1 id="Errors">
+ <title>Errors</title>
+
+ <para>
+Some functions return
<type>Status</type>,
an integer error indication.
If the function fails, it returns a zero.
If the function returns a status of zero,
it has not updated the return arguments.
<indexterm><primary>Status</primary></indexterm>
-Because C does not provide multiple return values,
-many functions must return their results by writing into client-passed storage.
+Because C does not provide multiple return values,
+many functions must return their results by writing into client-passed storage.
<indexterm><primary>Error</primary><secondary>handling</secondary></indexterm>
By default, errors are handled either by a standard library function
or by one that you provide.
Functions that return pointers to strings return NULL pointers if
the string does not exist.
-</para>
-<para>
-<!-- .LP -->
+ </para>
+ <para>
The X server reports protocol errors at the time that it detects them.
If more than one error could be generated for a given request,
the server can report any of them.
-</para>
-<para>
-<!-- .LP -->
+ </para>
+ <para>
Because Xlib usually does not transmit requests to the server immediately
(that is, it buffers them), errors can be reported much later than they
actually occur.
For debugging purposes, however,
-Xlib provides a mechanism for forcing synchronous behavior
+Xlib provides a mechanism for forcing synchronous behavior
(see section 11.8.1). <!-- xref -->
-When synchronization is enabled,
+When synchronization is enabled,
errors are reported as they are generated.
-</para>
-<para>
-<!-- .LP -->
+ </para>
+ <para>
When Xlib detects an error,
it calls an error handler,
which your program can provide.
If you do not provide an error handler,
the error is printed, and your program terminates.
-</para>
-</sect1>
-<sect1 id="Standard_Header_Files">
-<title>Standard Header Files</title>
-<!-- .XS -->
-<!-- (SN Standard Header Files -->
-<!-- .XE -->
-<para>
-<!-- .LP -->
+ </para>
+ </sect1>
+
+ <sect1 id="Standard_Header_Files">
+ <title>Standard Header Files</title>
+
+ <para>
The following include files are part of the Xlib standard:
-</para>
+<indexterm><primary>Headers</primary></indexterm>
<variablelist>
- <varlistentry>
- <term><<filename class="headerfile">X11/Xlib.h</filename>></term>
+ <varlistentry id="Standard_Header_Files:Xlib.h">
+ <term><filename class="headerfile"><X11/Xlib.h></filename></term>
<listitem>
+ <indexterm type="file"><primary><filename class="headerfile">X11/Xlib.h</filename></primary></indexterm>
+ <indexterm><primary>Files</primary><secondary><X11/Xlib.h></secondary></indexterm>
+ <indexterm><primary>Headers</primary><secondary><X11/Xlib.h></secondary></indexterm>
<para>
This is the main header file for Xlib.
The majority of all Xlib symbols are declared by including this file.
@@ -298,212 +293,262 @@ This symbol is defined to have the 6 in this release of the standard. </para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><X11/X.h></term>
+ <varlistentry id="Standard_Header_Files:X.h">
+ <term><filename class="headerfile"><X11/X.h></filename></term>
<listitem>
+ <indexterm type="file"><primary><filename class="headerfile">X11/X.h</filename></primary></indexterm>
+ <indexterm><primary>Files</primary><secondary><X11/X.h></secondary></indexterm>
+ <indexterm><primary>Headers</primary><secondary><X11/X.h></secondary></indexterm>
<para>
This file declares types and constants for the X protocol that are
to be used by applications. It is included automatically from
->X11/Xlib.h< so application code should never need to
+<filename class="headerfile"><X11/Xlib.h></filename>
+so application code should never need to
reference this file directly.
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><X11/Xcms.h></term>
+ <varlistentry id="Standard_Header_Files:Xcms.h">
+ <term><filename class="headerfile"><X11/Xcms.h></filename></term>
<listitem>
+ <indexterm type="file"><primary><filename class="headerfile">X11/Xcms.h</filename></primary></indexterm>
+ <indexterm><primary>Files</primary><secondary><X11/Xcms.h></secondary></indexterm>
+ <indexterm><primary>Headers</primary><secondary><X11/Xcms.h></secondary></indexterm>
<para>
This file contains symbols for much of the color management facilities
-described in chapter 6. All functions, types, and symbols with the
+described in chapter 6. All functions, types, and symbols with the
prefix "Xcms", <!-- xref -->
plus the Color Conversion Contexts macros, are declared in this file.
-<X11/Xlib.h> must be included before including this file.
+<filename class="headerfile"><X11/Xlib.h></filename>
+must be included before including this file.
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><X11/Xutil.h></term>
+ <varlistentry id="Standard_Header_Files:Xutil.h">
+ <term><filename class="headerfile"><X11/Xutil.h></filename></term>
<listitem>
+ <indexterm type="file"><primary><filename class="headerfile">X11/Xutil.h</filename></primary></indexterm>
+ <indexterm><primary>Files</primary><secondary><X11/Xutil.h></secondary></indexterm>
+ <indexterm><primary>Headers</primary><secondary><X11/Xutil.h></secondary></indexterm>
<para>
This file declares various functions, types, and symbols used for
inter-client communication and application utility functions,
which are described in chapters 14 and 16. <!-- xref -->
-<X11/Xlib.h> must be included before including this file.
+<filename class="headerfile"><X11/Xlib.h></filename> must be included before including this file.
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><X11/Xresource.h></term>
+ <varlistentry id="Standard_Header_Files:Xresource.h">
+ <term><filename class="headerfile"><X11/Xresource.h></filename></term>
<listitem>
+ <indexterm type="file"><primary><filename class="headerfile">X11/Xresource.h</filename></primary></indexterm>
+ <indexterm><primary>Files</primary><secondary><X11/Xresource.h></secondary></indexterm>
+ <indexterm><primary>Headers</primary><secondary><X11/Xresource.h></secondary></indexterm>
<para>
This file declares all functions, types, and symbols for the
resource manager facilities, which are described in chapter 15.
-<X11/Xlib.h> <!-- xref -->
+<filename class="headerfile"><X11/Xlib.h></filename> <!-- xref -->
must be included before including this file.
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><X11/Xatom.h></term>
+ <varlistentry id="Standard_Header_Files:Xatom.h">
+ <term><filename class="headerfile"><X11/Xatom.h></filename></term>
<listitem>
+ <indexterm type="file"><primary><filename class="headerfile">X11/Xatom.h</filename></primary></indexterm>
+ <indexterm><primary>Files</primary><secondary><X11/Xatom.h></secondary></indexterm>
+ <indexterm><primary>Headers</primary><secondary><X11/Xatom.h></secondary></indexterm>
<para>
-This file declares all predefined atoms,
+This file declares all predefined atoms,
which are symbols with the prefix "XA_".
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><X11/cursorfont.h></term>
+ <varlistentry id="Standard_Header_Files:cursorfont.h">
+ <term><filename class="headerfile"><X11/cursorfont.h></filename></term>
<listitem>
+ <indexterm type="file"><primary><filename class="headerfile">X11/cursorfont.h</filename></primary></indexterm>
+ <indexterm><primary>Files</primary><secondary><X11/cursorfont.h></secondary></indexterm>
+ <indexterm><primary>Headers</primary><secondary><X11/cursorfont.h></secondary></indexterm>
<para>
This file declares the cursor symbols for the standard cursor font,
-which are listed in appendix B.
+which are listed in <link linkend="x_font_cursors">Appendix B</link>.
All cursor symbols have the prefix "XC_".
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><X11/keysymdef.h></term>
+ <varlistentry id="Standard_Header_Files:keysymdef.h">
+ <term><filename class="headerfile"><X11/keysymdef.h></filename></term>
<listitem>
+ <indexterm type="file"><primary><filename class="headerfile">X11/keysymdef.h</filename></primary></indexterm>
+ <indexterm><primary>Files</primary><secondary><X11/keysymdef.h></secondary></indexterm>
+ <indexterm><primary>Headers</primary><secondary><X11/keysymdef.h></secondary></indexterm>
<para>
This file declares all standard KeySym values,
which are symbols with the prefix "XK_".
The KeySyms are arranged in groups, and a preprocessor symbol controls
inclusion of each group. The preprocessor symbol must be defined
prior to inclusion of the file to obtain the associated values.
-The preprocessor symbols are <function>XK_MISCELLANY, XK_XKB_KEYS, XK_3270,
-XK_LATIN1, XK_LATIN2, XK_LATIN3, XK_LATIN4, XK_KATAKANA, XK_ARABIC,
-XK_CYRILLIC, XK_GREEK, XK_TECHNICAL, XK_SPECIAL, XK_PUBLISHING, XK_APL,
-XK_HEBREW, XK_THAI, and XK_KOREAN</function>.
+The preprocessor symbols are
+<symbol>XK_MISCELLANY</symbol>,
+<symbol>XK_XKB_KEYS</symbol>,
+<symbol>XK_3270</symbol>,
+<symbol>XK_LATIN1</symbol>,
+<symbol>XK_LATIN2</symbol>,
+<symbol>XK_LATIN3</symbol>,
+<symbol>XK_LATIN4</symbol>,
+<symbol>XK_KATAKANA</symbol>,
+<symbol>XK_ARABIC</symbol>,
+<symbol>XK_CYRILLIC</symbol>,
+<symbol>XK_GREEK</symbol>,
+<symbol>XK_TECHNICAL</symbol>,
+<symbol>XK_SPECIAL</symbol>,
+<symbol>XK_PUBLISHING</symbol>,
+<symbol>XK_APL</symbol>,
+<symbol>XK_HEBREW</symbol>,
+<symbol>XK_THAI</symbol>, and
+<symbol>XK_KOREAN</symbol>.
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><X11/keysym.h></term>
+ <varlistentry id="Standard_Header_Files:keysym.h">
+ <term><filename class="headerfile"><X11/keysym.h></filename></term>
<listitem>
+ <indexterm type="file"><primary><filename class="headerfile">X11/keysym.h</filename></primary></indexterm>
+ <indexterm><primary>Files</primary><secondary><X11/keysym.h></secondary></indexterm>
+ <indexterm><primary>Headers</primary><secondary><X11/keysym.h></secondary></indexterm>
<para>
This file defines the preprocessor symbols
-XK_MISCELLANY, XK_XKB_KEYS, XK_LATIN1, XK_LATIN2, XK_LATIN3,
-XK_LATIN4, and XK_GREEK
-and then includes <X11/keysymdef.h>
+<symbol>XK_MISCELLANY</symbol>,
+<symbol>XK_XKB_KEYS</symbol>,
+<symbol>XK_LATIN1</symbol>,
+<symbol>XK_LATIN2</symbol>,
+<symbol>XK_LATIN3</symbol>,
+<symbol>XK_LATIN4</symbol>, and
+<symbol>XK_GREEK</symbol>
+and then includes <filename class="headerfile"><X11/keysymdef.h></filename>.
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><X11/Xlibint.h></term>
+ <varlistentry id="Standard_Header_Files:Xlibint.h">
+ <term><filename class="headerfile"><X11/Xlibint.h></filename></term>
<listitem>
+ <indexterm type="file"><primary><filename class="headerfile">X11/Xlibint.h</filename></primary></indexterm>
+ <indexterm><primary>Files</primary><secondary><X11/Xlibint.h></secondary></indexterm>
+ <indexterm><primary>Headers</primary><secondary><X11/Xlibint.h></secondary></indexterm>
<para>
This file declares all the functions, types, and symbols used for
-extensions, which are described in appendix C.
+extensions, which are described in <link linkend="extensions">Appendix C</link>.
This file automatically includes
-<X11/Xlib.h<.
+<filename class="headerfile"><X11/Xlib.h></filename>.
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><X11/Xproto.h></term>
+ <varlistentry id="Standard_Header_Files:Xproto.h">
+ <term><filename class="headerfile"><X11/Xproto.h></filename></term>
<listitem>
+ <indexterm type="file"><primary><filename class="headerfile">X11/Xproto.h</filename></primary></indexterm>
+ <indexterm><primary>Files</primary><secondary><X11/Xproto.h></secondary></indexterm>
+ <indexterm><primary>Headers</primary><secondary><X11/Xproto.h></secondary></indexterm>
<para>
This file declares types and symbols for the basic X protocol,
for use in implementing extensions.
It is included automatically from
-<X11/Xlibint.h<,
+<filename class="headerfile"><X11/Xlibint.h></filename>,
so application and extension code should never need to
reference this file directly.
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><X11/Xprotostr.h></term>
+ <varlistentry id="Standard_Header_Files:Xprotostr.h">
+ <term><filename class="headerfile"><X11/Xprotostr.h></filename></term>
<listitem>
+ <indexterm type="file"><primary><filename class="headerfile">X11/Xprotostr.h</filename></primary></indexterm>
+ <indexterm><primary>Files</primary><secondary><X11/Xprotostr.h></secondary></indexterm>
+ <indexterm><primary>Headers</primary><secondary><X11/Xprotostr.h></secondary></indexterm>
<para>
This file declares types and symbols for the basic X protocol,
for use in implementing extensions.
It is included automatically from
-<X11/Xproto.h<,
+<filename class="headerfile"><X11/Xproto.h></filename>,
so application and extension code should never need to
reference this file directly.
</para>
</listitem>
</varlistentry>
- <varlistentry>
- <term><X11/X10.h></term>
+ <varlistentry id="Standard_Header_Files:X10.h">
+ <term><filename class="headerfile"><X11/X10.h></filename></term>
<listitem>
+ <indexterm type="file"><primary><filename class="headerfile">X11/X10.h</filename></primary></indexterm>
+ <indexterm><primary>Files</primary><secondary><X11/X10.h></secondary></indexterm>
+ <indexterm><primary>Headers</primary><secondary><X11/X10.h></secondary></indexterm>
<para>
This file declares all the functions, types, and symbols used for the
-X10 compatibility functions, which are described in appendix D.
+X10 compatibility functions, which are described in
+<link linkend="X_Version_10_Compatibility_Functions">Appendix D</link>.
</para>
</listitem>
</varlistentry>
</variablelist>
-</sect1>
-
+ </para>
+ </sect1>
+ <sect1 id="Generic_Values_and_Types">
+ <title>Generic Values and Types</title>
-<sect1 id="Generic_Values_and_Types">
-<title>Generic Values and Types</title>
-<!-- .XS -->
-<!-- (SN Generic Values and Types -->
-<!-- .XE -->
-<para>
-<!-- .LP -->
+ <para>
The following symbols are defined by Xlib and used throughout the manual:
-<indexterm significance="preferred"><primary>Bool</primary></indexterm>
-<indexterm significance="preferred"><primary>True</primary></indexterm>
-<indexterm significance="preferred"><primary>False</primary></indexterm>
-</para>
<itemizedlist>
<listitem>
<para>
+<indexterm significance="preferred"><primary>Bool</primary></indexterm>
+<indexterm significance="preferred"><primary>True</primary></indexterm>
+<indexterm significance="preferred"><primary>False</primary></indexterm>
Xlib defines the type
<type>Bool</type>
and the Boolean values
<symbol>True</symbol>
and
<symbol>False</symbol>.
-<indexterm significance="preferred"><primary>None</primary></indexterm>
</para>
</listitem>
<listitem>
<para>
+<indexterm significance="preferred"><primary>None</primary></indexterm>
<symbol>None</symbol>
is the universal null resource ID or atom.
-<indexterm significance="preferred"><primary>XID</primary></indexterm>
</para>
</listitem>
<listitem>
<para>
+<indexterm significance="preferred"><primary>XID</primary></indexterm>
The type
<type>XID</type>
is used for generic resource IDs.
-<indexterm significance="preferred"><primary>XPointer</primary></indexterm>
</para>
</listitem>
<listitem>
<para>
-The type
-<type>XPointer</type>
-is defined to be char\^* and is used as a generic opaque pointer to data.
+<indexterm significance="preferred"><primary>XPointer</primary></indexterm>
+The type <type>XPointer</type> is defined to be <type>char *</type>
+and is used as a generic opaque pointer to data.
</para>
</listitem>
</itemizedlist>
-</sect1>
-<sect1 id="Naming_and_Argument_Conventions_within_Xlib">
-<title>Naming and Argument Conventions within Xlib</title>
-<!-- .XS -->
-<!-- (SN Naming and Argument Conventions within Xlib -->
-<!-- .XE -->
-<para>
-<!-- .LP -->
+ </para>
+ </sect1>
+
+ <sect1 id="Naming_and_Argument_Conventions_within_Xlib">
+ <title>Naming and Argument Conventions within Xlib</title>
+
+ <para>
Xlib follows a number of conventions for the naming and syntax of the functions.
Given that you remember what information the function requires,
-these conventions are intended to make the syntax of the functions more
+these conventions are intended to make the syntax of the functions more
predictable.
-</para>
-<para>
-<!-- .LP -->
+ </para>
+ <para>
The major naming conventions are:
-</para>
<itemizedlist>
<listitem>
<para>
@@ -591,16 +636,14 @@ the mask always precedes the pointer to the structure in the argument list. </para>
</listitem>
</itemizedlist>
-</sect1>
-<sect1 id="Programming_Considerations">
-<title>Programming Considerations</title>
-<!-- .XS -->
-<!-- (SN Programming Considerations -->
-<!-- .XE -->
-<para>
-<!-- .LP -->
+ </para>
+ </sect1>
+
+ <sect1 id="Programming_Considerations">
+ <title>Programming Considerations</title>
+
+ <para>
The major programming considerations are:
-</para>
<itemizedlist>
<listitem>
<para>
@@ -638,133 +681,111 @@ What you do inside of your top-level window, however, is up to your application.
For further information,
see chapter 14 <!-- xref -->
-and the <emphasis remap='I'>Inter-Client Communication Conventions Manual</emphasis>.
+and the <citetitle>Inter-Client Communication Conventions Manual</citetitle>.
</para>
</listitem>
</itemizedlist>
-</sect1>
-<sect1 id="Character_Sets_and_Encodings">
-<title>Character Sets and Encodings</title>
-<!-- .XS -->
-<!-- (SN Character Sets and Encodings -->
-<!-- .XE -->
-<para>
-<!-- .LP -->
+ </para>
+ </sect1>
+
+ <sect1 id="Character_Sets_and_Encodings">
+ <title>Character Sets and Encodings</title>
+
+ <para>
Some of the Xlib functions make reference to specific character sets
and character encodings.
The following are the most common:
-</para>
-<itemizedlist>
- <listitem>
- <para>
-X Portable Character Set
- </para>
- </listitem>
- <listitem>
- <para>
-A basic set of 97 characters,
+
+<variablelist>
+ <varlistentry>
+ <term><firstterm>X Portable Character Set</firstterm></term>
+ <listitem><para>
+A basic set of 97 characters,
which are assumed to exist in all locales supported by Xlib.
This set contains the following characters:
- </para>
- </listitem>
- <listitem>
- <para>
+<literallayout>
a..z A..Z 0..9 !"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~ <space>, <tab>, and <newline>
- </para>
- </listitem>
- <listitem>
- <para>
+</literallayout>
+ </para>
+ <para>
This set is the left/lower half
of the graphic character set of ISO8859-1 plus space, tab, and newline.
It is also the set of graphic characters in 7-bit ASCII plus the same
three control characters.
The actual encoding of these characters on the host is system dependent.
- </para>
- </listitem>
- <listitem>
- <para>
-Host Portable Character Encoding
- </para>
- </listitem>
- <listitem>
- <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><firstterm>Host Portable Character Encoding</firstterm></term>
+ <listitem>
+ <para>
The encoding of the X Portable Character Set on the host.
The encoding itself is not defined by this standard,
but the encoding must be the same in all locales supported by Xlib on the host.
If a string is said to be in the Host Portable Character Encoding,
then it only contains characters from the X Portable Character Set,
in the host encoding.
- </para>
- </listitem>
- <listitem>
- <para>
-Latin-1
- </para>
- </listitem>
- <listitem>
- <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><firstterm>Latin-1</firstterm></term>
+ <listitem>
+ <para>
The coded character set defined by the ISO8859-1 standard.
- </para>
- </listitem>
- <listitem>
- <para>
-Latin Portable Character Encoding
- </para>
- </listitem>
- <listitem>
- <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><firstterm>Latin Portable Character Encoding</firstterm></term>
+ <listitem>
+ <para>
The encoding of the X Portable Character Set using the Latin-1 codepoints
plus ASCII control characters.
If a string is said to be in the Latin Portable Character Encoding,
then it only contains characters from the X Portable Character Set,
not all of Latin-1.
- </para>
- </listitem>
- <listitem>
- <para>
-STRING Encoding
- </para>
- </listitem>
- <listitem>
- <para>
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><firstterm>STRING Encoding</firstterm></term>
+ <listitem>
+ <para>
Latin-1, plus tab and newline.
- </para>
- </listitem>
- <listitem>
- <para>
-<acronym>POSIX</acronym> Portable Filename Character Set
- </para>
- </listitem>
- <listitem>
- <para>
-The set of 65 characters,
+ </para>
+ </listitem>
+ </varlistentry>
+ <varlistentry>
+ <term><firstterm><acronym>POSIX</acronym> Portable Filename Character Set</firstterm></term>
+ <listitem>
+ <para>
+The set of 65 characters,
which can be used in naming files on a <acronym>POSIX</acronym>-compliant host,
that are correctly processed in all locales.
The set is:
- </para>
- </listitem>
- <listitem>
- <para>
-<literallayout class="monospaced">
+<literallayout>
a..z A..Z 0..9 ._-
</literallayout>
+ </para>
+ </listitem>
+ </varlistentry>
+</variablelist>
</para>
- </listitem>
-</itemizedlist>
-</sect1>
-<sect1 id="Formatting_Conventions">
-<title>Formatting Conventions</title>
-<!-- .XS -->
-<!-- (SN Formatting Conventions -->
-<!-- .XE -->
-<para>
-<!-- .LP -->
-<emphasis remap='I'>Xlib \- C Language X Interface</emphasis> uses the following conventions:
-</para>
-<itemizedlist>
- <listitem>
+ </sect1>
+
+ <sect1 id="Formatting_Conventions">
+ <title>Formatting Conventions</title>
+
<para>
-Global symbols are printed in
+ <citetitle>Xlib − C Language X Interface</citetitle> uses the
+ following conventions:
+
+ <itemizedlist>
+ <listitem>
+ <para>
+Global symbols are printed in
<function>this</function>
<function>special</function>
<function>font</function>.
@@ -774,11 +795,11 @@ When declared and defined, function arguments are printed in <emphasis remap='I'>italics</emphasis>.
In the explanatory text that follows,
they usually are printed in regular type.
- </para>
- </listitem>
- <listitem>
- <para>
-Each function is introduced by a general discussion that
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+Each function is introduced by a general discussion that
distinguishes it from other functions.
The function declaration itself follows,
and each argument is specifically explained.
@@ -787,36 +808,36 @@ Xlib header files normally declare functions using function prototypes in ANSI C environments.
General discussion of the function, if any is required,
follows the arguments.
-Where applicable,
-the last paragraph of the explanation lists the possible
+Where applicable,
+the last paragraph of the explanation lists the possible
Xlib error codes that the function can generate.
For a complete discussion of the Xlib error codes,
see section 11.8.2. <!-- xref -->
- </para>
- </listitem>
- <listitem>
- <para>
-To eliminate any ambiguity between those arguments that you pass and those that
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+To eliminate any ambiguity between those arguments that you pass and those that
a function returns to you,
the explanations for all arguments that you pass start with the word
-<emphasis remap='I'>specifies</emphasis> or, in the case of multiple arguments, the word <emphasis remap='I'>specify\^</emphasis>.
+<emphasis remap='I'>specifies</emphasis> or, in the case of multiple arguments, the word <emphasis remap='I'>specify</emphasis>.
The explanations for all arguments that are returned to you start with the
-word <emphasis remap='I'>returns</emphasis> or, in the case of multiple arguments, the word <emphasis remap='I'>return\^</emphasis>.
+word <emphasis remap='I'>returns</emphasis> or, in the case of multiple arguments, the word <emphasis remap='I'>return</emphasis>.
The explanations for all arguments that you can pass and are returned start
-with the words <emphasis remap='I'>specifies and returns\^</emphasis>.
- </para>
- </listitem>
- <listitem>
- <para>
-Any pointer to a structure that is used to return a value is designated as
+with the words <emphasis remap='I'>specifies and returns</emphasis>.
+ </para>
+ </listitem>
+ <listitem>
+ <para>
+Any pointer to a structure that is used to return a value is designated as
such by the <emphasis remap='I'>_return</emphasis> suffix as part of its name.
All other pointers passed to these functions are
used for reading only.
A few arguments use pointers to structures that are used for
both input and output and are indicated by using the <emphasis remap='I'>_in_out</emphasis> suffix.
-<!-- .bp -->
+ </para>
+ </listitem>
+ </itemizedlist>
</para>
- </listitem>
-</itemizedlist>
-</sect1>
+ </sect1>
</chapter>
diff --git a/libX11/specs/libX11/CH02.xml b/libX11/specs/libX11/CH02.xml index b6623cbcc..a00b7c283 100644 --- a/libX11/specs/libX11/CH02.xml +++ b/libX11/specs/libX11/CH02.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="display_functions">
<title>Display Functions</title>
<para>
@@ -219,7 +222,10 @@ returns a pointer to a <type>Display</type>
structure,
which is defined in
-<<filename class="headerfile">X11/Xlib.h</filename>>.
+<filename class="headerfile"><X11/Xlib.h></filename>.
+<indexterm type="file"><primary><filename class="headerfile">X11/Xlib.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xlib.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xlib.h></filename></secondary></indexterm>
If
<function>XOpenDisplay</function>
does not succeed, it returns NULL.
diff --git a/libX11/specs/libX11/CH03.xml b/libX11/specs/libX11/CH03.xml index 8b6fb3478..c6f1c86a1 100644 --- a/libX11/specs/libX11/CH03.xml +++ b/libX11/specs/libX11/CH03.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="window_functions"><title>Window Functions</title>
<sect1 id="Visual_Types">
<title>Visual Types</title>
@@ -176,7 +179,7 @@ use <funcsynopsis>
<funcprototype>
<funcdef>VisualID <function>XVisualIDFromVisual</function></funcdef>
- <paramdef>Visual<parameter> *\^visual</parameter></paramdef>
+ <paramdef>Visual *<parameter>visual</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<!-- .FN -->
@@ -750,7 +753,7 @@ change of width and height, the (x, y) pairs are defined: <para>
<!-- .LP -->
<informaltable>
- <tgroup cols='3' align='center'>
+ <tgroup cols='2' align='center'>
<colspec colname='c1'/>
<colspec colname='c2'/>
<thead>
@@ -819,9 +822,9 @@ A bit-gravity of indicates that the contents or origin should not move relative to the
origin of the root window.
If the change in size of the window is coupled with a change in position (x, y),
-then for bit-gravity the change in position of each pixel is (\-x, \-y), and for
+then for bit-gravity the change in position of each pixel is (−x, −y), and for
win-gravity the change in position of a child when its parent is so resized is
-(\-x, \-y).
+(−x, −y).
Note that
<symbol>StaticGravity</symbol>
still only takes effect when the width or height of the window is changed,
@@ -3386,7 +3389,6 @@ To restack a set of windows from top to bottom, use <funcsynopsis>
<funcprototype>
<funcdef><function>XRestackWindows</function></funcdef>
- <paramdef>XRestackWindows\^(\^display,windows,<parameter> \^nwindows)</parameter></paramdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> windows[]</parameter></paramdef>
<paramdef>int<parameter> nwindows</parameter></paramdef>
diff --git a/libX11/specs/libX11/CH04.xml b/libX11/specs/libX11/CH04.xml index dc611aef5..119e86a2e 100644 --- a/libX11/specs/libX11/CH04.xml +++ b/libX11/specs/libX11/CH04.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="window_information_functions">
<title>Window Information Functions</title>
@@ -253,73 +256,38 @@ or <!-- .LP -->
The bit_gravity member is set to the window's bit gravity
and can be one of the following:
+ <simplelist type="vert" columns="2">
+ <member><symbol>ForgetGravity</symbol></member>
+ <member><symbol>NorthWestGravity</symbol></member>
+ <member><symbol>NorthGravity</symbol></member>
+ <member><symbol>NorthEastGravity</symbol></member>
+ <member><symbol>WestGravity</symbol></member>
+
+ <member><symbol>EastGravity</symbol></member>
+ <member><symbol>SouthWestGravity</symbol></member>
+ <member><symbol>SouthGravity</symbol></member>
+ <member><symbol>SouthEastGravity</symbol></member>
+ <member><symbol>StaticGravity</symbol></member>
+ </simplelist>
</para>
-<informaltable>
- <tgroup cols='2' align='center'>
- <colspec colname='c1'/>
- <colspec colname='c2'/>
- <tbody>
- <row>
- <entry><symbol>ForgetGravity</symbol></entry>
- <entry><symbol>EastGravity</symbol></entry>
- </row>
- <row>
- <entry><symbol>NorthWestGravity</symbol></entry>
- <entry><symbol>SouthWestGravity</symbol></entry>
- </row>
- <row>
- <entry><symbol>NorthGravity</symbol></entry>
- <entry><symbol>SouthGravity</symbol></entry>
- </row>
- <row>
- <entry><symbol>NorthEastGravity</symbol></entry>
- <entry><symbol>SouthEastGravity</symbol></entry>
- </row>
- <row>
- <entry><symbol>WestGravity</symbol></entry>
- <entry><symbol>StaticGravity</symbol></entry>
- </row>
- </tbody>
- </tgroup>
-</informaltable>
<para>
-<!-- .LP -->
The win_gravity member is set to the window's window gravity
and can be one of the following:
-</para>
+ <simplelist type="vert" columns="2">
+ <member><symbol>UnmapGravity</symbol></member>
+ <member><symbol>NorthWestGravity</symbol></member>
+ <member><symbol>NorthGravity</symbol></member>
+ <member><symbol>NorthEastGravity</symbol></member>
+ <member><symbol>WestGravity</symbol></member>
-<informaltable>
- <tgroup cols='2' align='center'>
- <colspec colname='c1'/>
- <colspec colname='c2'/>
- <tbody>
- <row>
- <entry><symbol>UnmapGravity</symbol></entry>
- <entry><symbol>EastGravity</symbol></entry>
- </row>
- <row>
- <entry><symbol>NorthWestGravity</symbol></entry>
- <entry><symbol>SouthWestGravity</symbol></entry>
- </row>
- <row>
- <entry><symbol>NorthGravity</symbol></entry>
- <entry><symbol>SouthGravity</symbol></entry>
- </row>
- <row>
- <entry><symbol>NorthEastGravity</symbol></entry>
- <entry><symbol>SouthEastGravity</symbol></entry>
- </row>
- <row>
- <entry><symbol>WestGravity</symbol></entry>
- <entry><symbol>StaticGravity</symbol></entry>
- </row>
- <row>
- <entry><symbol>CenterGravity</symbol></entry>
- <entry></entry>
- </row>
- </tbody>
- </tgroup>
-</informaltable>
+ <member><symbol>EastGravity</symbol></member>
+ <member><symbol>SouthWestGravity</symbol></member>
+ <member><symbol>SouthGravity</symbol></member>
+ <member><symbol>SouthEastGravity</symbol></member>
+ <member><symbol>StaticGravity</symbol></member>
+ <member><symbol>CenterGravity</symbol></member>
+ </simplelist>
+</para>
<para>
<!-- .LP -->
For additional information on gravity,
@@ -910,7 +878,10 @@ arbitrary extension in this type scheme. Certain property names are
predefined in the server for commonly used functions.
The atoms for these properties are defined in
-<<filename class="headerfile">X11/Xatom.h</filename>>.
+<filename class="headerfile"><X11/Xatom.h></filename>.
+<indexterm type="file"><primary><filename class="headerfile">X11/Xatom.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xatom.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xatom.h></filename></secondary></indexterm>
To avoid name clashes with user symbols, the
<code>#define</code>
name for each atom has the XA_ prefix.
@@ -973,206 +944,98 @@ event (none are built into the X server) <para>
<!-- .LP -->
The built-in selection property names are:
-</para>
-<para>
-<!-- .LP -->
-<literallayout class="monospaced">
-<!-- .TA .5i 1.5i 3i -->
-<!-- .ta .5i 1.5i 3i -->
-<!-- .R -->
-PRIMARY
-SECONDARY
-</literallayout>
+<simplelist type="vert" columns="2">
+ <member><property>PRIMARY</property></member>
+ <member><property>SECONDARY</property></member>
+</simplelist>
</para>
<para>
<!-- .LP -->
The built-in property names are:
-<informaltable>
- <tgroup cols='2' align='center'>
- <colspec colname='c1'/>
- <colspec colname='c2'/>
- <tbody>
- <row>
- <entry>lw(2i) lw(2i).</entry>
- </row>
- <row>
- <entry>CUT_BUFFER0</entry>
- <entry>RESOURCE_MANAGER</entry>
- </row>
- <row>
- <entry>CUT_BUFFER1</entry>
- <entry>WM_CLASS</entry>
- </row>
- <row>
- <entry>CUT_BUFFER2</entry>
- <entry>WM_CLIENT_MACHINE</entry>
- </row>
- <row>
- <entry>CUT_BUFFER3</entry>
- <entry>WM_COLORMAP_WINDOWS</entry>
- </row>
- <row>
- <entry>CUT_BUFFER4</entry>
- <entry>WM_COMMAND</entry>
- </row>
- <row>
- <entry>CUT_BUFFER5</entry>
- <entry>WM_HINTS</entry>
- </row>
- <row>
- <entry>CUT_BUFFER6</entry>
- <entry>WM_ICON_NAME</entry>
- </row>
- <row>
- <entry>CUT_BUFFER7</entry>
- <entry>WM_ICON_SIZE</entry>
- </row>
- <row>
- <entry>RGB_BEST_MAP</entry>
- <entry>WM_NAME</entry>
- </row>
- <row>
- <entry>RGB_BLUE_MAP</entry>
- <entry>WM_NORMAL_HINTS</entry>
- </row>
- <row>
- <entry>RGB_DEFAULT_MAP</entry>
- <entry>WM_PROTOCOLS</entry>
- </row>
- <row>
- <entry>RGB_GRAY_MAP</entry>
- <entry>WM_STATE</entry>
- </row>
- <row>
- <entry>RGB_GREEN_MAP</entry>
- <entry>WM_TRANSIENT_FOR</entry>
- </row>
- <row>
- <entry>RGB_RED_MAP</entry>
- <entry>WM_ZOOM_HINTS</entry>
- </row>
- </tbody>
- </tgroup>
-</informaltable>
+ <simplelist type="vert" columns="2">
+ <member><property>CUT_BUFFER0</property></member>
+ <member><property>CUT_BUFFER1</property></member>
+ <member><property>CUT_BUFFER2</property></member>
+ <member><property>CUT_BUFFER3</property></member>
+ <member><property>CUT_BUFFER4</property></member>
+ <member><property>CUT_BUFFER5</property></member>
+ <member><property>CUT_BUFFER6</property></member>
+ <member><property>CUT_BUFFER7</property></member>
+ <member><property>RGB_BEST_MAP</property></member>
+ <member><property>RGB_BLUE_MAP</property></member>
+ <member><property>RGB_DEFAULT_MAP</property></member>
+ <member><property>RGB_GRAY_MAP</property></member>
+ <member><property>RGB_GREEN_MAP</property></member>
+ <member><property>RGB_RED_MAP</property></member>
+
+ <member><property>RESOURCE_MANAGER</property></member>
+ <member><property>WM_CLASS</property></member>
+ <member><property>WM_CLIENT_MACHINE</property></member>
+ <member><property>WM_COLORMAP_WINDOWS</property></member>
+ <member><property>WM_COMMAND</property></member>
+ <member><property>WM_HINTS</property></member>
+ <member><property>WM_ICON_NAME</property></member>
+ <member><property>WM_ICON_SIZE</property></member>
+ <member><property>WM_NAME</property></member>
+ <member><property>WM_NORMAL_HINTS</property></member>
+ <member><property>WM_PROTOCOLS</property></member>
+ <member><property>WM_STATE</property></member>
+ <member><property>WM_TRANSIENT_FOR</property></member>
+ <member><property>WM_ZOOM_HINTS</property></member>
+ </simplelist>
</para>
<para>
-<!-- .LP -->
The built-in property types are:
+ <simplelist type="vert" columns="2">
+ <member><property>ARC</property></member>
+ <member><property>ATOM</property></member>
+ <member><property>BITMAP</property></member>
+ <member><property>CARDINAL</property></member>
+ <member><property>COLORMAP</property></member>
+ <member><property>CURSOR</property></member>
+ <member><property>DRAWABLE</property></member>
+ <member><property>FONT</property></member>
+ <member><property>INTEGER</property></member>
+ <member><property>PIXMAP</property></member>
+ <member><property>POINT</property></member>
+ <member><property>RGB_COLOR_MAP</property></member>
+ <member><property>RECTANGLE</property></member>
+ <member><property>STRING</property></member>
+ <member><property>VISUALID</property></member>
+ <member><property>WINDOW</property></member>
+ <member><property>WM_HINTS</property></member>
+ <member><property>WM_SIZE_HINTS</property></member>
+ </simplelist>
</para>
<para>
-<!-- .LP -->
-<informaltable>
- <tgroup cols='2' align='center'>
- <colspec colname='c1'/>
- <colspec colname='c2'/>
- <tbody>
- <row>
- <entry>lw(2i) lw(2i).</entry>
- </row>
- <row>
- <entry>ARC</entry>
- <entry>POINT</entry>
- </row>
- <row>
- <entry>ATOM</entry>
- <entry>RGB_COLOR_MAP</entry>
- </row>
- <row>
- <entry>BITMAP</entry>
- <entry>RECTANGLE</entry>
- </row>
- <row>
- <entry>CARDINAL</entry>
- <entry>STRING</entry>
- </row>
- <row>
- <entry>COLORMAP</entry>
- <entry>VISUALID</entry>
- </row>
- <row>
- <entry>CURSOR</entry>
- <entry>WINDOW</entry>
- </row>
- <row>
- <entry>DRAWABLE</entry>
- <entry>WM_HINTS</entry>
- </row>
- <row>
- <entry>FONT</entry>
- <entry>WM_SIZE_HINTS</entry>
- </row>
- <row>
- <entry>INTEGER</entry>
- </row>
- <row>
- <entry>PIXMAP</entry>
- </row>
- </tbody>
- </tgroup>
-</informaltable>
-</para>
-<para>
-<!-- .LP -->
The built-in font property names are:
-<informaltable>
- <tgroup cols='2' align='center'>
- <colspec colname='c1'/>
- <colspec colname='c2'/>
- <tbody>
- <row>
- <entry>lw(2i) lw(2i).</entry>
- </row>
- <row>
- <entry>MIN_SPACE</entry>
- <entry>STRIKEOUT_DESCENT</entry>
- </row>
- <row>
- <entry>NORM_SPACE</entry>
- <entry>STRIKEOUT_ASCENT</entry>
- </row>
- <row>
- <entry>MAX_SPACE</entry>
- <entry>ITALIC_ANGLE</entry>
- </row>
- <row>
- <entry>END_SPACE</entry>
- <entry>X_HEIGHT</entry>
- </row>
- <row>
- <entry>SUPERSCRIPT_X</entry>
- <entry>QUAD_WIDTH</entry>
- </row>
- <row>
- <entry>SUPERSCRIPT_Y</entry>
- <entry>WEIGHT</entry>
- </row>
- <row>
- <entry>SUBSCRIPT_X</entry>
- <entry>POINT_SIZE</entry>
- </row>
- <row>
- <entry>SUBSCRIPT_Y</entry>
- <entry>RESOLUTION</entry>
- </row>
- <row>
- <entry>UNDERLINE_POSITION</entry>
- <entry>COPYRIGHT</entry>
- </row>
- <row>
- <entry>UNDERLINE_THICKNESS</entry>
- <entry>NOTICE</entry>
- </row>
- <row>
- <entry>FONT_NAME</entry>
- <entry>FAMILY_NAME</entry>
- </row>
- <row>
- <entry>FULL_NAME</entry>
- <entry>CAP_HEIGHT</entry>
- </row>
- </tbody>
- </tgroup>
-</informaltable>
+ <simplelist type="vert" columns="2">
+ <member><property>MIN_SPACE</property></member>
+ <member><property>NORM_SPACE</property></member>
+ <member><property>MAX_SPACE</property></member>
+ <member><property>END_SPACE</property></member>
+ <member><property>SUPERSCRIPT_X</property></member>
+ <member><property>SUPERSCRIPT_Y</property></member>
+ <member><property>SUBSCRIPT_X</property></member>
+ <member><property>SUBSCRIPT_Y</property></member>
+ <member><property>UNDERLINE_POSITION</property></member>
+ <member><property>UNDERLINE_THICKNESS</property></member>
+ <member><property>FONT_NAME</property></member>
+ <member><property>FULL_NAME</property></member>
+
+ <member><property>STRIKEOUT_DESCENT</property></member>
+ <member><property>STRIKEOUT_ASCENT</property></member>
+ <member><property>ITALIC_ANGLE</property></member>
+ <member><property>X_HEIGHT</property></member>
+ <member><property>QUAD_WIDTH</property></member>
+ <member><property>WEIGHT</property></member>
+ <member><property>POINT_SIZE</property></member>
+ <member><property>RESOLUTION</property></member>
+ <member><property>COPYRIGHT</property></member>
+ <member><property>NOTICE</property></member>
+ <member><property>FAMILY_NAME</property></member>
+ <member><property>CAP_HEIGHT</property></member>
+ </simplelist>
</para>
<para>
<!-- .LP -->
@@ -1549,7 +1412,7 @@ To obtain the type, format, and value of a property of a given window, use <funcsynopsis>
<funcprototype>
<funcdef>int <function>XGetWindowProperty</function></funcdef>
- <paramdef><parameter> \^display</parameter></paramdef>
+ <paramdef><parameter> display</parameter></paramdef>
<paramdef><parameter> w</parameter></paramdef>
<paramdef><parameter> property</parameter></paramdef>
<paramdef><parameter> long_offset</parameter></paramdef>
@@ -2105,7 +1968,7 @@ To rotate a window's property list, use <funcdef><function>XRotateWindowProperties</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>Window<parameter> w</parameter></paramdef>
- <paramdef>Atom<parameter> properties[]\^</parameter></paramdef>
+ <paramdef>Atom<parameter> properties[]</parameter></paramdef>
<paramdef>int<parameter> num_prop</parameter></paramdef>
<paramdef>int<parameter> npositions</parameter></paramdef>
</funcprototype>
@@ -2176,7 +2039,7 @@ events. If the property names in the properties array are viewed as being numbered
starting from zero and if there are num_prop property names in the list,
then the value associated with property name I becomes the value associated
-with property name (I + npositions) mod N for all I from zero to N \- 1.
+with property name (I + npositions) mod N for all I from zero to N − 1.
The effect is to rotate the states by npositions places around the virtual ring
of property names (right for positive npositions,
left for negative npositions).
diff --git a/libX11/specs/libX11/CH05.xml b/libX11/specs/libX11/CH05.xml index d4a3ff1a0..08d78d666 100644 --- a/libX11/specs/libX11/CH05.xml +++ b/libX11/specs/libX11/CH05.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="pixmap_and_cursor_functions">
<title>Pixmap and Cursor Functions</title>
<sect1 id="Creating_and_Freeing_Pixmaps">
diff --git a/libX11/specs/libX11/CH06.xml b/libX11/specs/libX11/CH06.xml index 070898dd3..f60053b93 100644 --- a/libX11/specs/libX11/CH06.xml +++ b/libX11/specs/libX11/CH06.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="color_management_functions">
<title>Color Management Functions</title>
<!-- .sp 2 -->
@@ -77,9 +80,15 @@ Add new color spaces <!-- .LP -->
All functions, types, and symbols in this chapter with the prefix ``Xcms''
are defined in
-<<filename class="headerfile">X11/Xcms.h</filename>>.
+<filename class="headerfile"><X11/Xcms.h></filename>.
+<indexterm type="file"><primary><filename class="headerfile">X11/Xcms.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xcms.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xcms.h></filename></secondary></indexterm>
The remaining functions and types are defined in
-<<filename class="headerfile">X11/Xlib.h</filename>>.
+<filename class="headerfile"><X11/Xlib.h></filename>.
+<indexterm type="file"><primary><filename class="headerfile">X11/Xlib.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xlib.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xlib.h></filename></secondary></indexterm>
</para>
<para>
<!-- .LP -->
@@ -1994,9 +2003,6 @@ pixels_return array. <para>
<!-- .LP -->
<!-- .eM -->
-<!-- .EQ -->
-delim %%
-<!-- .EN -->
The
<function>XAllocColorCells</function>
function allocates read/write color cells.
@@ -2010,7 +2016,8 @@ and nplane plane masks are returned. No mask will have any bits set to 1 in common with
any other mask or with any of the pixels.
By ORing together each pixel with zero or more masks,
-ncolors * %2 sup nplanes% distinct pixels can be produced.
+ncolors × 2<superscript><emphasis>nplanes</emphasis></superscript>
+distinct pixels can be produced.
All of these are
allocated writable by the request.
For
@@ -2197,9 +2204,6 @@ Return bit masks for the red, green, and blue planes. <para>
<!-- .LP -->
<!-- .eM -->
-<!-- .EQ -->
-delim %%
-<!-- .EN -->
The specified ncolors must be positive;
and nreds, ngreens, and nblues must be nonnegative,
or a
@@ -2220,12 +2224,17 @@ each mask will lie within the corresponding pixel subfield.
By ORing together
subsets of masks with each pixel value,
-ncolors * %2 sup (nreds+ngreens+nblues)% distinct pixel values can be produced.
+ncolors × 2<superscript><emphasis>(nreds+ngreens+nblues)</emphasis></superscript>
+distinct pixel values can be produced.
All of these are allocated by the request.
However, in the
-colormap, there are only ncolors * %2 sup nreds% independent red entries,
-ncolors * %2 sup ngreens% independent green entries,
-and ncolors * %2 sup nblues% independent blue entries.
+colormap, there are only
+ncolors × 2<superscript><emphasis>nreds</emphasis></superscript>
+independent red entries,
+ncolors × 2<superscript><emphasis>ngreens</emphasis></superscript>
+independent green entries, and
+ncolors × 2<superscript><emphasis>nblues</emphasis></superscript>
+independent blue entries.
This is true even for
<symbol>PseudoColor</symbol>.
When the colormap entry of a pixel
diff --git a/libX11/specs/libX11/CH07.xml b/libX11/specs/libX11/CH07.xml index ae977b365..14d4bd4ed 100644 --- a/libX11/specs/libX11/CH07.xml +++ b/libX11/specs/libX11/CH07.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="graphics_context_functions">
<title>Graphics Context Functions</title>
@@ -269,7 +272,10 @@ is typically the most useful because it will work on a color display, but special applications may use other functions,
particularly in concert with particular planes of a color display.
The 16 GC functions, defined in
-<<filename class="headerfile">X11/X.h</filename>>,
+<filename class="headerfile"><X11/X.h></filename>,
+<indexterm type="file"><primary><filename class="headerfile">X11/X.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/X.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/X.h></filename></secondary></indexterm>
are:
</para>
<!-- .\" are listed in Table 5-1 along with the -->
@@ -962,10 +968,10 @@ depth of drawable, use <funcsynopsis>
<funcprototype>
<funcdef>GC <function>XCreateGC</function></funcdef>
- <paramdef>Display<parameter> *display</parameter></paramdef>
+ <paramdef>Display <parameter> *display</parameter></paramdef>
<paramdef>Drawable<parameter> d</parameter></paramdef>
<paramdef>unsignedlong<parameter> valuemask</parameter></paramdef>
- <paramdef>XGCValues<parameter> *\^values</parameter></paramdef>
+ <paramdef>XGCValues *<parameter>values</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<!-- .FN -->
@@ -1139,7 +1145,7 @@ To change the components in a given GC, use <paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>unsignedlong<parameter> valuemask</parameter></paramdef>
- <paramdef>XGCValues<parameter> *\^values</parameter></paramdef>
+ <paramdef>XGCValues<parameter> *values</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<!-- .FN -->
@@ -1976,7 +1982,7 @@ To set the dash-offset and dash-list for dashed line styles of a given GC, use <paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>int<parameter> dash_offset</parameter></paramdef>
- <paramdef>char<parameter> dash_list[]\^</parameter></paramdef>
+ <paramdef>char<parameter> dash_list[]</parameter></paramdef>
<paramdef>int<parameter> n</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2074,7 +2080,7 @@ are only required to match this ideal for horizontal and vertical lines. Failing the ideal semantics, it is suggested that the length be measured along the
major axis of the line.
The major axis is defined as the x axis for lines drawn at an angle of between
-\-45 and +45 degrees or between 135 and 225 degrees from the x axis.
+−45 and +45 degrees or between 135 and 225 degrees from the x axis.
For all other lines, the major axis is the y axis.
</para>
<para>
@@ -3037,7 +3043,7 @@ To set the clip-mask of a given GC to the specified list of rectangles, use <paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>GC<parameter> gc</parameter></paramdef>
<paramdef>intclip_x_origin,<parameter> clip_y_origin</parameter></paramdef>
- <paramdef>XRectangle<parameter> rectangles[]\^</parameter></paramdef>
+ <paramdef>XRectangle<parameter> rectangles[]</parameter></paramdef>
<paramdef>int<parameter> n</parameter></paramdef>
<paramdef>int<parameter> ordering</parameter></paramdef>
</funcprototype>
diff --git a/libX11/specs/libX11/CH08.xml b/libX11/specs/libX11/CH08.xml index d1e0b36d5..de768f448 100644 --- a/libX11/specs/libX11/CH08.xml +++ b/libX11/specs/libX11/CH08.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="graphics_functions">
<title>Graphics Functions</title>
<para>
@@ -3341,7 +3344,10 @@ if the property was not defined or if it was defined.
A set of predefined atoms exists for font properties,
which can be found in
-<<filename class="headerfile">X11/Xatom.h</filename>>.
+<filename class="headerfile"><X11/Xatom.h></filename>.
+<indexterm type="file"><primary><filename class="headerfile">X11/Xatom.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xatom.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xatom.h></filename></secondary></indexterm>
This set contains the standard properties associated with
a font.
Although it is not guaranteed,
diff --git a/libX11/specs/libX11/CH09.xml b/libX11/specs/libX11/CH09.xml index 60bf08e68..bcb7366fd 100644 --- a/libX11/specs/libX11/CH09.xml +++ b/libX11/specs/libX11/CH09.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="window_and_session_manager_functions">
<title>Window and Session Manager Functions</title>
@@ -1102,7 +1105,7 @@ or Timeout and interval are specified in seconds.
A timeout of 0 disables the screen saver
(but an activated screen saver is not deactivated),
-and a timeout of \-1 restores the default.
+and a timeout of −1 restores the default.
Other negative values generate a
<errorname>BadValue</errorname>
error.
diff --git a/libX11/specs/libX11/CH10.xml b/libX11/specs/libX11/CH10.xml index e00b517e7..d94ff212b 100644 --- a/libX11/specs/libX11/CH10.xml +++ b/libX11/specs/libX11/CH10.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="events">
<title>Events</title>
@@ -58,7 +61,10 @@ events are always sent to all clients. An event type describes a specific event generated by the X server.
For each event type,
a corresponding constant name is defined in
-<<filename class="headerfile">X11/X.h</filename>>,
+<filename class="headerfile"><X11/X.h></filename>,
+<indexterm type="file"><primary><filename class="headerfile">X11/X.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/X.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/X.h></filename></secondary></indexterm>
which is used when referring to an event type.
<indexterm><primary>Event</primary><secondary>categories</secondary></indexterm>
The following table lists the event category
@@ -171,7 +177,10 @@ The processing associated with these events is discussed in section 10.5. <!-- .LP -->
For each event type,
a corresponding structure is declared in
-<<filename class="headerfile">X11/Xlib.h</filename>>.
+<filename class="headerfile"><X11/Xlib.h></filename>.
+<indexterm type="file"><primary><filename class="headerfile">X11/Xlib.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xlib.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xlib.h></filename></secondary></indexterm>
All the event structures have the following common members:
</para>
<para>
@@ -313,7 +322,10 @@ Clients select event reporting of most events relative to a window. To do this, pass an event mask to an Xlib event-handling
function that takes an event_mask argument.
The bits of the event mask are defined in
-<<filename class="headerfile">X11/X.h</filename>>.
+<filename class="headerfile"><X11/X.h></filename>.
+<indexterm type="file"><primary><filename class="headerfile">X11/X.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/X.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/X.h></filename></secondary></indexterm>
Each bit in the event mask maps to an event mask name,
which describes the event or events you want the X server to
return to a client application.
@@ -1052,8 +1064,7 @@ masks bits in the event-mask attribute of the window. <itemizedlist>
<listitem>
<para>
-<function>Button1MotionMask \ \-</function>
-<symbol>Button5MotionMask</symbol>
+<symbol>Button1MotionMask</symbol> - <symbol>Button5MotionMask</symbol>
</para>
</listitem>
<listitem>
@@ -2932,7 +2943,10 @@ a call to <function>XCopyPlane</function>
initiated the request.
These constants are defined in
-<<filename class="headerfile">X11/Xproto.h</filename>>.
+<filename class="headerfile"><X11/Xproto.h></filename>.
+<indexterm type="file"><primary><filename class="headerfile">X11/Xproto.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xproto.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xproto.h></filename></secondary></indexterm>
The minor_code member,
like the major_code member,
indicates which graphics request was initiated by
diff --git a/libX11/specs/libX11/CH11.xml b/libX11/specs/libX11/CH11.xml index 2cfae3aad..c8031649a 100644 --- a/libX11/specs/libX11/CH11.xml +++ b/libX11/specs/libX11/CH11.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="event_handling_functions">
<title>Event Handling Functions</title>
@@ -2436,7 +2439,7 @@ the major request protocol number is used for the message argument. For an extension request,
the extension name (as given by
<function>InitExtension</function>)
-followed by a period (\.) and the minor request protocol number
+followed by a period (.) and the minor request protocol number
is used for the message argument.
If no string is found in the error database,
the default_string is returned to the buffer argument.
diff --git a/libX11/specs/libX11/CH12.xml b/libX11/specs/libX11/CH12.xml index dabf2b04b..bfde8d927 100644 --- a/libX11/specs/libX11/CH12.xml +++ b/libX11/specs/libX11/CH12.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="input_device_functions">
<title>Input Device Functions</title>
@@ -3035,14 +3038,20 @@ standards. In areas where no standards exist,
some of these sets are derived from Digital Equipment Corporation standards.
The list of defined symbols can be found in
-<<filename class="headerfile">X11/keysymdef.h</filename>>.
+<filename class="headerfile"><X11/keysymdef.h></filename>.
+<indexterm type="file"><primary><filename class="headerfile">X11/keysymdef.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/keysymdef.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/keysymdef.h></filename></secondary></indexterm>
Unfortunately, some C preprocessors have
limits on the number of defined symbols.
If you must use KeySyms not
in the Latin 1-4, Greek, and miscellaneous classes,
you may have to define a symbol for those sets.
Most applications usually only include
-<<filename class="headerfile">X11/keysym.h</filename>>,
+<filename class="headerfile"><X11/keysym.h></filename>,
+<indexterm type="file"><primary><filename class="headerfile">X11/keysym.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/keysym.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/keysym.h></filename></secondary></indexterm>
which defines symbols for ISO Latin 1-4, Greek, and miscellaneous.
</para>
<para>
diff --git a/libX11/specs/libX11/CH13.xml b/libX11/specs/libX11/CH13.xml index f7809f665..be0918adb 100644 --- a/libX11/specs/libX11/CH13.xml +++ b/libX11/specs/libX11/CH13.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="locales_and_internationalized_text_functions">
<title>Locales and Internationalized Text Functions</title>
diff --git a/libX11/specs/libX11/CH14.xml b/libX11/specs/libX11/CH14.xml index 4221e9b01..9bfbc4f1b 100644 --- a/libX11/specs/libX11/CH14.xml +++ b/libX11/specs/libX11/CH14.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="inter_client_communication_functions">
<title>Inter-Client Communication Functions</title>
<para>
@@ -40,7 +43,7 @@ managers are: </thead>
<tbody>
<row>
- <entry>WM_CLASS</entry>
+ <entry><property>WM_CLASS</property></entry>
<entry>STRING</entry>
<entry>8</entry>
<entry>Set by application programs to allow
@@ -50,7 +53,7 @@ managers are: </entry>
</row>
<row>
- <entry>WM_CLIENT_MACHINE</entry>
+ <entry><property>WM_CLIENT_MACHINE</property></entry>
<entry>TEXT</entry>
<entry></entry>
<entry>The string name of the machine on
@@ -59,7 +62,7 @@ managers are: </entry>
</row>
<row>
- <entry>WM_COLORMAP_WINDOWS</entry>
+ <entry><property>WM_COLORMAP_WINDOWS</property></entry>
<entry>WINDOWS</entry>
<entry>32</entry>
<entry>The list of window IDs that may
@@ -68,7 +71,7 @@ managers are: </entry>
</row>
<row>
- <entry>WM_COMMAND</entry>
+ <entry><property>WM_COMMAND</property></entry>
<entry>TEXT</entry>
<entry></entry>
<entry>The command and arguments, null-
@@ -76,8 +79,8 @@ managers are: </entry>
</row>
<row>
- <entry>WM_HINTS</entry>
- <entry>WM_HINTS</entry>
+ <entry><property>WM_HINTS</property></entry>
+ <entry><property>WM_HINTS</property></entry>
<entry>32</entry>
<entry>Additional hints set by the client for
use by the window manager. The C
@@ -85,14 +88,14 @@ managers are: </entry>
</row>
<row>
- <entry>WM_ICON_NAME</entry>
+ <entry><property>WM_ICON_NAME</property></entry>
<entry>TEXT</entry>
<entry></entry>
<entry>The name to be used in an icon.</entry>
</row>
<row>
- <entry>WM_ICON_SIZE</entry>
- <entry>WM_ICON_SIZE</entry>
+ <entry><property>WM_ICON_SIZE</property></entry>
+ <entry><property>WM_ICON_SIZE</property></entry>
<entry>32</entry>
<entry>The window manager may set this
property on the root window to
@@ -102,14 +105,14 @@ managers are: </entry>
</row>
<row>
- <entry>WM_NAME</entry>
+ <entry><property>WM_NAME</property></entry>
<entry>TEXT</entry>
<entry></entry>
<entry>The name of the application.</entry>
</row>
<row>
- <entry>WM_NORMAL_HINTS</entry>
- <entry>WM_NORMAL_HINTS</entry>
+ <entry><property>WM_NORMAL_HINTS</property></entry>
+ <entry><property>WM_NORMAL_HINTS</property></entry>
<entry>32</entry>
<entry>Size hints for a window in its
normal state. The C type of this
@@ -117,7 +120,7 @@ managers are: </entry>
</row>
<row>
- <entry>WM_PROTOCOLS</entry>
+ <entry><property>WM_PROTOCOLS</property></entry>
<entry>ATOM</entry>
<entry>32</entry>
<entry>List of atoms that identify the
@@ -127,8 +130,8 @@ managers are: </entry>
</row>
<row>
- <entry>WM_STATE</entry>
- <entry>WM_STATE</entry>
+ <entry><property>WM_STATE</property></entry>
+ <entry><property>WM_STATE</property></entry>
<entry>32</entry>
<entry>Intended for communication
between window and session man-
@@ -136,7 +139,7 @@ managers are: </entry>
</row>
<row>
- <entry>WM_TRANSIENT_FOR</entry>
+ <entry><property>WM_TRANSIENT_FOR</property></entry>
<entry>WINDOW</entry>
<entry>32</entry>
<entry>Set by application programs to
@@ -186,47 +189,47 @@ Set and read text properties </listitem>
<listitem>
<para>
-Set and read the WM_NAME property
+Set and read the <property>WM_NAME</property> property
</para>
</listitem>
<listitem>
<para>
-Set and read the WM_ICON_NAME property
+Set and read the <property>WM_ICON_NAME</property> property
</para>
</listitem>
<listitem>
<para>
-Set and read the WM_HINTS property
+Set and read the <property>WM_HINTS</property> property
</para>
</listitem>
<listitem>
<para>
-Set and read the WM_NORMAL_HINTS property
+Set and read the <property>WM_NORMAL_HINTS</property> property
</para>
</listitem>
<listitem>
<para>
-Set and read the WM_CLASS property
+Set and read the <property>WM_CLASS</property> property
</para>
</listitem>
<listitem>
<para>
-Set and read the WM_TRANSIENT_FOR property
+Set and read the <property>WM_TRANSIENT_FOR</property> property
</para>
</listitem>
<listitem>
<para>
-Set and read the WM_PROTOCOLS property
+Set and read the <property>WM_PROTOCOLS</property> property
</para>
</listitem>
<listitem>
<para>
-Set and read the WM_COLORMAP_WINDOWS property
+Set and read the <property>WM_COLORMAP_WINDOWS</property> property
</para>
</listitem>
<listitem>
<para>
-Set and read the WM_ICON_SIZE property
+Set and read the <property>WM_ICON_SIZE</property> property
</para>
</listitem>
<listitem>
@@ -303,7 +306,7 @@ Specifies the appropriate screen number on the host server. <!-- .eM -->
The
<function>XIconifyWindow</function>
-function sends a WM_CHANGE_STATE
+function sends a <property>WM_CHANGE_STATE</property>
<symbol>ClientMessage</symbol>
event with a format of 32 and a first data element of
<symbol>IconicState</symbol>
@@ -317,7 +320,7 @@ with an event mask set to Window managers may elect to receive this message and
if the window is in its normal state,
may treat it as a request to change the window's state from normal to iconic.
-If the WM_CHANGE_STATE property cannot be interned,
+If the <property>WM_CHANGE_STATE</property> property cannot be interned,
<function>XIconifyWindow</function>
does not send a message and returns a zero status.
It returns a nonzero status if the client message is sent successfully;
@@ -1173,7 +1176,7 @@ and the missing charset list allocated by Xlib provides two functions that you can use to set and read
the text properties for a given window.
You can use these functions to set and read those properties of type TEXT
-(WM_NAME, WM_ICON_NAME, WM_COMMAND, and WM_CLIENT_MACHINE).
+(<property>WM_NAME</property>, <property>WM_ICON_NAME</property>, <property>WM_COMMAND</property>, and <property>WM_CLIENT_MACHINE</property>).
In addition,
Xlib provides separate convenience functions that you can use to set each
of these properties.
@@ -1382,12 +1385,12 @@ errors. <para>
<!-- .LP -->
Xlib provides convenience functions that you can use to set and read
-the WM_NAME property for a given window.
+the <property>WM_NAME</property> property for a given window.
<!-- .sp -->
</para>
<para>
<!-- .LP -->
-To set a window's WM_NAME property with the supplied convenience function, use
+To set a window's <property>WM_NAME</property> property with the supplied convenience function, use
<function>XSetWMName</function>.
<indexterm significance="preferred"><primary>XSetWMName</primary></indexterm>
<!-- .sM -->
@@ -1442,12 +1445,12 @@ The <function>XSetWMName</function>
convenience function calls
<function>XSetTextProperty</function>
-to set the WM_NAME property.
+to set the <property>WM_NAME</property> property.
<!-- .sp -->
</para>
<para>
<!-- .LP -->
-To read a window's WM_NAME property with the supplied convenience function, use
+To read a window's <property>WM_NAME</property> property with the supplied convenience function, use
<function>XGetWMName</function>.
<indexterm significance="preferred"><primary>XGetWMName</primary></indexterm>
<!-- .sM -->
@@ -1502,7 +1505,7 @@ The <function>XGetWMName</function>
convenience function calls
<function>XGetTextProperty</function>
-to obtain the WM_NAME property.
+to obtain the <property>WM_NAME</property> property.
It returns a nonzero status on success;
otherwise, it returns a zero status.
</para>
@@ -1649,7 +1652,7 @@ If it succeeds, it returns a nonzero status;
otherwise, no name has been set for the window,
and it returns zero.
-If the WM_NAME property has not been set for this window,
+If the <property>WM_NAME</property> property has not been set for this window,
<function>XFetchName</function>
sets window_name_return to NULL.
If the data returned by the server is in the Latin Portable Character Encoding,
@@ -1675,12 +1678,12 @@ error. <para>
<!-- .LP -->
Xlib provides convenience functions that you can use to set and read
-the WM_ICON_NAME property for a given window.
+the <property>WM_ICON_NAME</property> property for a given window.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
-To set a window's WM_ICON_NAME property,
+To set a window's <property>WM_ICON_NAME</property> property,
use
<function>XSetWMIconName</function>.
<indexterm significance="preferred"><primary>XSetWMIconName</primary></indexterm>
@@ -1736,12 +1739,12 @@ The <function>XSetWMIconName</function>
convenience function calls
<function>XSetTextProperty</function>
-to set the WM_ICON_NAME property.
+to set the <property>WM_ICON_NAME</property> property.
<!-- .sp -->
</para>
<para>
<!-- .LP -->
-To read a window's WM_ICON_NAME property,
+To read a window's <property>WM_ICON_NAME</property> property,
use
<function>XGetWMIconName</function>.
<indexterm significance="preferred"><primary>XGetWMIconName</primary></indexterm>
@@ -1797,7 +1800,7 @@ The <function>XGetWMIconName</function>
convenience function calls
<function>XGetTextProperty</function>
-to obtain the WM_ICON_NAME property.
+to obtain the <property>WM_ICON_NAME</property> property.
It returns a nonzero status on success;
otherwise, it returns a zero status.
</para>
@@ -1960,11 +1963,14 @@ error. <para>
<!-- .LP -->
Xlib provides functions that you can use to set and read
-the WM_HINTS property for a given window.
+the <property>WM_HINTS</property> property for a given window.
These functions use the flags and the
<structname>XWMHints</structname>
structure, as defined in the
-<<filename class="headerfile">X11/Xutil.h</filename>>
+<filename class="headerfile"><X11/Xutil.h></filename>
+<indexterm type="file"><primary><filename class="headerfile">X11/Xutil.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
header file.
<!-- .sp -->
</para>
@@ -2113,7 +2119,7 @@ or the window to be withdrawn. <para>
<!-- .LP -->
<!-- .sp -->
-To set a window's WM_HINTS property, use
+To set a window's <property>WM_HINTS</property> property, use
<function>XSetWMHints</function>.
<indexterm significance="preferred"><primary>XSetWMHints</primary></indexterm>
<!-- .sM -->
@@ -2182,7 +2188,7 @@ errors. <para>
<!-- .LP -->
<!-- .sp -->
-To read a window's WM_HINTS property, use
+To read a window's <property>WM_HINTS</property> property, use
<function>XGetWMHints</function>.
<indexterm significance="preferred"><primary>XGetWMHints</primary></indexterm>
<!-- .sM -->
@@ -2223,7 +2229,7 @@ Specifies the window. The
<function>XGetWMHints</function>
function reads the window manager hints and
-returns NULL if no WM_HINTS property was set on the window
+returns NULL if no <property>WM_HINTS</property> property was set on the window
or returns a pointer to an
<structname>XWMHints</structname>
structure if it succeeds.
@@ -2247,11 +2253,14 @@ error. <para>
<!-- .LP -->
Xlib provides functions that you can use to set or read
-the WM_NORMAL_HINTS property for a given window.
+the <property>WM_NORMAL_HINTS</property> property for a given window.
The functions use the flags and the
<structname>XSizeHints</structname>
structure, as defined in the
-<<filename class="headerfile">X11/Xutil.h</filename>>
+<filename class="headerfile"><X11/Xutil.h></filename>
+<indexterm type="file"><primary><filename class="headerfile">X11/Xutil.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
header file.
</para>
<para>
@@ -2376,7 +2385,7 @@ macro is highly discouraged. </para>
<para>
<!-- .LP -->
-To set a window's WM_NORMAL_HINTS property, use
+To set a window's <property>WM_NORMAL_HINTS</property> property, use
<function>XSetWMNormalHints</function>.
<indexterm significance="preferred"><primary>XSetWMNormalHints</primary></indexterm>
<!-- .sM -->
@@ -2427,12 +2436,12 @@ Specifies the size hints for the window in its normal state. <!-- .eM -->
The
<function>XSetWMNormalHints</function>
-function replaces the size hints for the WM_NORMAL_HINTS property
+function replaces the size hints for the <property>WM_NORMAL_HINTS</property> property
on the specified window.
If the property does not already exist,
<function>XSetWMNormalHints</function>
-sets the size hints for the WM_NORMAL_HINTS property on the specified window.
-The property is stored with a type of WM_SIZE_HINTS and a format of 32.
+sets the size hints for the <property>WM_NORMAL_HINTS</property> property on the specified window.
+The property is stored with a type of <property>WM_SIZE_HINTS</property> and a format of 32.
</para>
<para>
<!-- .LP -->
@@ -2446,7 +2455,7 @@ errors. </para>
<para>
<!-- .LP -->
-To read a window's WM_NORMAL_HINTS property, use
+To read a window's <property>WM_NORMAL_HINTS</property> property, use
<function>XGetWMNormalHints</function>.
<indexterm significance="preferred"><primary>XGetWMNormalHints</primary></indexterm>
<!-- .sM -->
@@ -2508,9 +2517,9 @@ Returns the hints that were supplied by the user. <!-- .eM -->
The
<function>XGetWMNormalHints</function>
-function returns the size hints stored in the WM_NORMAL_HINTS property
+function returns the size hints stored in the <property>WM_NORMAL_HINTS</property> property
on the specified window.
-If the property is of type WM_SIZE_HINTS, is of format 32,
+If the property is of type <property>WM_SIZE_HINTS</property>, is of format 32,
and is long enough to contain either an old (pre-<acronym>ICCCM</acronym>)
or new size hints structure,
<function>XGetWMNormalHints</function>
@@ -2557,7 +2566,7 @@ error. </para>
<para>
<!-- .LP -->
-To set a window's WM_SIZE_HINTS property, use
+To set a window's <property>WM_SIZE_HINTS</property> property, use
<function>XSetWMSizeHints</function>.
<indexterm significance="preferred"><primary>XSetWMSizeHints</primary></indexterm>
<!-- .sM -->
@@ -2627,7 +2636,7 @@ If the specified property does not already exist, <function>XSetWMSizeHints</function>
sets the size hints for the specified property
on the named window.
-The property is stored with a type of WM_SIZE_HINTS and a format of 32.
+The property is stored with a type of <property>WM_SIZE_HINTS</property> and a format of 32.
To set a window's normal size hints,
you can use the
<function>XSetWMNormalHints</function>
@@ -2646,7 +2655,7 @@ errors. </para>
<para>
<!-- .LP -->
-To read a window's WM_SIZE_HINTS property, use
+To read a window's <property>WM_SIZE_HINTS</property> property, use
<function>XGetWMSizeHints</function>.
<indexterm significance="preferred"><primary>XGetWMSizeHints</primary></indexterm>
<!-- .sM -->
@@ -2723,7 +2732,7 @@ The <function>XGetWMSizeHints</function>
function returns the size hints stored in the specified property
on the named window.
-If the property is of type WM_SIZE_HINTS, is of format 32,
+If the property is of type <property>WM_SIZE_HINTS</property>, is of format 32,
and is long enough to contain either an old (pre-<acronym>ICCCM</acronym>)
or new size hints structure,
<function>XGetWMSizeHints</function>
@@ -2783,11 +2792,14 @@ errors. <para>
<!-- .LP -->
Xlib provides functions that you can use to set and get
-the WM_CLASS property for a given window.
+the <property>WM_CLASS</property> property for a given window.
These functions use the
<structname>XClassHint</structname>
structure, which is defined in the
-<<filename class="headerfile">X11/Xutil.h</filename>>
+<filename class="headerfile"><X11/Xutil.h></filename>
+<indexterm type="file"><primary><filename class="headerfile">X11/Xutil.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
header file.
<!-- .sp -->
</para>
@@ -2847,19 +2859,19 @@ typedef struct { <!-- .eM -->
The res_name member contains the application name,
and the res_class member contains the application class.
-Note that the name set in this property may differ from the name set as WM_NAME.
-That is, WM_NAME specifies what should be displayed in the title bar and,
+Note that the name set in this property may differ from the name set as <property>WM_NAME</property>.
+That is, <property>WM_NAME</property> specifies what should be displayed in the title bar and,
therefore, can contain temporal information (for example, the name of
a file currently in an editor's buffer).
On the other hand,
-the name specified as part of WM_CLASS is the formal name of the application
+the name specified as part of <property>WM_CLASS</property> is the formal name of the application
that should be used when retrieving the application's resources from the
resource database.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
-To set a window's WM_CLASS property, use
+To set a window's <property>WM_CLASS</property> property, use
<function>XSetClassHint</function>.
<indexterm significance="preferred"><primary>XSetClassHint</primary></indexterm>
<!-- .sM -->
@@ -2928,7 +2940,7 @@ errors. <para>
<!-- .LP -->
<!-- .sp -->
-To read a window's WM_CLASS property, use
+To read a window's <property>WM_CLASS</property> property, use
<function>XGetClassHint</function>.
<indexterm significance="preferred"><primary>XGetClassHint</primary></indexterm>
<!-- .sM -->
@@ -3009,12 +3021,12 @@ error. <para>
<!-- .LP -->
Xlib provides functions that you can use to set and read
-the WM_TRANSIENT_FOR property for a given window.
+the <property>WM_TRANSIENT_FOR</property> property for a given window.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
-To set a window's WM_TRANSIENT_FOR property, use
+To set a window's <property>WM_TRANSIENT_FOR</property> property, use
<function>XSetTransientForHint</function>.
<indexterm significance="preferred"><primary>XSetTransientForHint</primary></indexterm>
<!-- .sM -->
@@ -3054,7 +3066,7 @@ Specifies the window. </term>
<listitem>
<para>
-Specifies the window that the WM_TRANSIENT_FOR property is to be set to.
+Specifies the window that the <property>WM_TRANSIENT_FOR</property> property is to be set to.
</para>
</listitem>
</varlistentry>
@@ -3065,7 +3077,7 @@ Specifies the window that the WM_TRANSIENT_FOR property is to be set to. <!-- .eM -->
The
<function>XSetTransientForHint</function>
-function sets the WM_TRANSIENT_FOR property of the specified window to the
+function sets the <property>WM_TRANSIENT_FOR</property> property of the specified window to the
specified prop_window.
</para>
<para>
@@ -3080,7 +3092,7 @@ errors. <para>
<!-- .LP -->
<!-- .sp -->
-To read a window's WM_TRANSIENT_FOR property, use
+To read a window's <property>WM_TRANSIENT_FOR</property> property, use
<function>XGetTransientForHint</function>.
<indexterm significance="preferred"><primary>XGetTransientForHint</primary></indexterm>
<!-- .sM -->
@@ -3120,7 +3132,7 @@ Specifies the window. </term>
<listitem>
<para>
-Returns the WM_TRANSIENT_FOR property of the specified window.
+Returns the <property>WM_TRANSIENT_FOR</property> property of the specified window.
</para>
</listitem>
</varlistentry>
@@ -3131,7 +3143,7 @@ Returns the WM_TRANSIENT_FOR property of the specified window. <!-- .eM -->
The
<function>XGetTransientForHint</function>
-function returns the WM_TRANSIENT_FOR property for the specified window.
+function returns the <property>WM_TRANSIENT_FOR</property> property for the specified window.
It returns a nonzero status on success;
otherwise, it returns a zero status.
</para>
@@ -3151,12 +3163,12 @@ error. <para>
<!-- .LP -->
Xlib provides functions that you can use to set and read
-the WM_PROTOCOLS property for a given window.
+the <property>WM_PROTOCOLS</property> property for a given window.
</para>
<para>
<!-- .LP -->
<!-- .sp -->
-To set a window's WM_PROTOCOLS property, use
+To set a window's <property>WM_PROTOCOLS</property> property, use
<function>XSetWMProtocols</function>.
<indexterm significance="preferred"><primary>XSetWMProtocols</primary></indexterm>
<!-- .sM -->
@@ -3219,14 +3231,14 @@ Specifies the number of (Cn. <!-- .eM -->
The
<function>XSetWMProtocols</function>
-function replaces the WM_PROTOCOLS property on the specified window
+function replaces the <property>WM_PROTOCOLS</property> property on the specified window
with the list of atoms specified by the protocols argument.
If the property does not already exist,
<function>XSetWMProtocols</function>
-sets the WM_PROTOCOLS property on the specified window
+sets the <property>WM_PROTOCOLS</property> property on the specified window
to the list of atoms specified by the protocols argument.
The property is stored with a type of ATOM and a format of 32.
-If it cannot intern the WM_PROTOCOLS atom,
+If it cannot intern the <property>WM_PROTOCOLS</property> atom,
<function>XSetWMProtocols</function>
returns a zero status.
Otherwise, it returns a nonzero status.
@@ -3243,7 +3255,7 @@ errors. </para>
<para>
<!-- .LP -->
-To read a window's WM_PROTOCOLS property, use
+To read a window's <property>WM_PROTOCOLS</property> property, use
<function>XGetWMProtocols</function>.
<indexterm significance="preferred"><primary>XGetWMProtocols</primary></indexterm>
<!-- .sM -->
@@ -3306,12 +3318,12 @@ Returns the number of (Cn. <!-- .eM -->
The
<function>XGetWMProtocols</function>
-function returns the list of atoms stored in the WM_PROTOCOLS property
+function returns the list of atoms stored in the <property>WM_PROTOCOLS</property> property
on the specified window.
These atoms describe window manager protocols in which the owner
of this window is willing to participate.
If the property exists, is of type ATOM, is of format 32,
-and the atom WM_PROTOCOLS can be interned,
+and the atom <property>WM_PROTOCOLS</property> can be interned,
<function>XGetWMProtocols</function>
sets the protocols_return argument to a list of atoms,
sets the count_return argument to the number of elements in the list,
@@ -3337,12 +3349,12 @@ error. <para>
<!-- .LP -->
Xlib provides functions that you can use to set and read
-the WM_COLORMAP_WINDOWS property for a given window.
+the <property>WM_COLORMAP_WINDOWS</property> property for a given window.
<!-- .sp -->
</para>
<para>
<!-- .LP -->
-To set a window's WM_COLORMAP_WINDOWS property, use
+To set a window's <property>WM_COLORMAP_WINDOWS</property> property, use
<function>XSetWMColormapWindows</function>.
<indexterm significance="preferred"><primary>XSetWMColormapWindows</primary></indexterm>
<!-- .sM -->
@@ -3405,14 +3417,14 @@ Specifies the number of (Cn. <!-- .eM -->
The
<function>XSetWMColormapWindows</function>
-function replaces the WM_COLORMAP_WINDOWS property on the specified
+function replaces the <property>WM_COLORMAP_WINDOWS</property> property on the specified
window with the list of windows specified by the colormap_windows argument.
If the property does not already exist,
<function>XSetWMColormapWindows</function>
-sets the WM_COLORMAP_WINDOWS property on the specified
+sets the <property>WM_COLORMAP_WINDOWS</property> property on the specified
window to the list of windows specified by the colormap_windows argument.
The property is stored with a type of WINDOW and a format of 32.
-If it cannot intern the WM_COLORMAP_WINDOWS atom,
+If it cannot intern the <property>WM_COLORMAP_WINDOWS</property> atom,
<function>XSetWMColormapWindows</function>
returns a zero status.
Otherwise, it returns a nonzero status.
@@ -3429,7 +3441,7 @@ errors. </para>
<para>
<!-- .LP -->
-To read a window's WM_COLORMAP_WINDOWS property, use
+To read a window's <property>WM_COLORMAP_WINDOWS</property> property, use
<function>XGetWMColormapWindows</function>.
<indexterm significance="preferred"><primary>XGetWMColormapWindows</primary></indexterm>
<!-- .sM -->
@@ -3493,11 +3505,11 @@ Returns the number of (Cn. The
<function>XGetWMColormapWindows</function>
function returns the list of window identifiers stored
-in the WM_COLORMAP_WINDOWS property on the specified window.
+in the <property>WM_COLORMAP_WINDOWS</property> property on the specified window.
These identifiers indicate the colormaps that the window manager
may need to install for this window.
If the property exists, is of type WINDOW, is of format 32,
-and the atom WM_COLORMAP_WINDOWS can be interned,
+and the atom <property>WM_COLORMAP_WINDOWS</property> can be interned,
<function>XGetWMColormapWindows</function>
sets the windows_return argument to a list of window identifiers,
sets the count_return argument to the number of elements in the list,
@@ -3523,12 +3535,15 @@ error. <para>
<!-- .LP -->
Xlib provides functions that you can use to set and read
-the WM_ICON_SIZE property for a given window.
+the <property>WM_ICON_SIZE</property> property for a given window.
These functions use the
<structname>XIconSize</structname>
<indexterm><primary>XIconSize</primary></indexterm>
structure, which is defined in the
-<<filename class="headerfile">X11/Xutil.h</filename>>
+<filename class="headerfile"><X11/Xutil.h></filename>
+<indexterm type="file"><primary><filename class="headerfile">X11/Xutil.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
header file.
<!-- .sp -->
</para>
@@ -3591,7 +3606,7 @@ sizes (minimum to maximum) that represent the supported icon sizes. <para>
<!-- .LP -->
<!-- .sp -->
-To set a window's WM_ICON_SIZE property, use
+To set a window's <property>WM_ICON_SIZE</property> property, use
<function>XSetIconSizes</function>.
<indexterm significance="preferred"><primary>XSetIconSizes</primary></indexterm>
<!-- .sM -->
@@ -3667,7 +3682,7 @@ errors. <para>
<!-- .LP -->
<!-- .sp -->
-To read a window's WM_ICON_SIZE property, use
+To read a window's <property>WM_ICON_SIZE</property> property, use
<function>XGetIconSizes</function>.
<indexterm significance="preferred"><primary>XGetIconSizes</primary></indexterm>
<!-- .sM -->
@@ -3764,8 +3779,8 @@ function stores the standard set of window manager properties, with text properties in standard encodings
for internationalized text communication.
The standard window manager properties for a given window are
-WM_NAME, WM_ICON_NAME, WM_HINTS, WM_NORMAL_HINTS, WM_CLASS,
-WM_COMMAND, WM_CLIENT_MACHINE, and WM_LOCALE_NAME.
+<property>WM_NAME</property>, <property>WM_ICON_NAME</property>, <property>WM_HINTS</property>, <property>WM_NORMAL_HINTS</property>, <property>WM_CLASS</property>,
+<property>WM_COMMAND</property>, <property>WM_CLIENT_MACHINE</property>, and <property>WM_LOCALE_NAME</property>.
<indexterm significance="preferred"><primary>XmbSetWMProperties</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@@ -3896,10 +3911,10 @@ for communicating with other clients <!-- .LP -->
If the window_name argument is non-NULL,
<function>XmbSetWMProperties</function>
-sets the WM_NAME property.
+sets the <property>WM_NAME</property> property.
If the icon_name argument is non-NULL,
<function>XmbSetWMProperties</function>
-sets the WM_ICON_NAME property.
+sets the <property>WM_ICON_NAME</property> property.
The window_name and icon_name arguments are null-terminated strings
in the encoding of the current locale.
If the arguments can be fully converted to the STRING encoding,
@@ -3913,18 +3928,18 @@ If the normal_hints argument is non-NULL, <function>XmbSetWMProperties</function>
calls
<function>XSetWMNormalHints</function>,
-which sets the WM_NORMAL_HINTS property (see section 14.1.7).
+which sets the <property>WM_NORMAL_HINTS</property> property (see section 14.1.7).
If the wm_hints argument is non-NULL,
<function>XmbSetWMProperties</function>
calls
<function>XSetWMHints</function>,
-which sets the WM_HINTS property (see section 14.1.6).
+which sets the <property>WM_HINTS</property> property (see section 14.1.6).
</para>
<para>
<!-- .LP -->
If the argv argument is non-NULL,
<function>XmbSetWMProperties</function>
-sets the WM_COMMAND property from argv and argc.
+sets the <property>WM_COMMAND</property> property from argv and argc.
An argc of zero indicates a zero-length command.
</para>
<para>
@@ -3937,7 +3952,7 @@ The hostname of the machine is stored using <!-- .LP -->
If the class_hints argument is non-NULL,
<function>XmbSetWMProperties</function>
-sets the WM_CLASS property.
+sets the <property>WM_CLASS</property> property.
If the res_name member in the
<structname>XClassHint</structname>
structure is set to the NULL pointer and the RESOURCE_NAME
@@ -3954,7 +3969,7 @@ It is assumed that the supplied class_hints.res_name and argv, the RESOURCE_NAME environment variable, and the hostname of the machine
are in the encoding of the locale announced for the LC_CTYPE category
(on <acronym>POSIX</acronym>-compliant systems, the LC_CTYPE, else LANG environment variable).
-The corresponding WM_CLASS, WM_COMMAND, and WM_CLIENT_MACHINE properties
+The corresponding <property>WM_CLASS</property>, <property>WM_COMMAND</property>, and <property>WM_CLIENT_MACHINE</property> properties
are typed according to the local host locale announcer.
No encoding conversion is performed prior to storage in the properties.
</para>
@@ -3962,7 +3977,7 @@ No encoding conversion is performed prior to storage in the properties. <!-- .LP -->
For clients that need to process the property text in a locale,
<function>XmbSetWMProperties</function>
-sets the WM_LOCALE_NAME property to be the name of the current locale.
+sets the <property>WM_LOCALE_NAME</property> property to be the name of the current locale.
The name is assumed to be in the Host Portable Character Encoding
and is converted to STRING for storage in the property.
</para>
@@ -3982,8 +3997,8 @@ To set a window's standard window manager properties with strings in client-specified encodings, use
<function>XSetWMProperties</function>.
The standard window manager properties for a given window are
-WM_NAME, WM_ICON_NAME, WM_HINTS, WM_NORMAL_HINTS, WM_CLASS,
-WM_COMMAND, and WM_CLIENT_MACHINE.
+<property>WM_NAME</property>, <property>WM_ICON_NAME</property>, <property>WM_HINTS</property>, <property>WM_NORMAL_HINTS</property>, <property>WM_CLASS</property>,
+<property>WM_COMMAND</property>, and <property>WM_CLIENT_MACHINE</property>.
<indexterm significance="preferred"><primary>XSetWMProperties</primary></indexterm>
<!-- .sM -->
<funcsynopsis>
@@ -4116,17 +4131,17 @@ If the window_name argument is non-NULL, <function>XSetWMProperties</function>
calls
<function>XSetWMName</function>,
-which, in turn, sets the WM_NAME property (see section 14.1.4).
+which, in turn, sets the <property>WM_NAME</property> property (see section 14.1.4).
If the icon_name argument is non-NULL,
<function>XSetWMProperties</function>
calls
<function>XSetWMIconName</function>,
-which sets the WM_ICON_NAME property (see section 14.1.5).
+which sets the <property>WM_ICON_NAME</property> property (see section 14.1.5).
If the argv argument is non-NULL,
<function>XSetWMProperties</function>
calls
<function>XSetCommand</function>,
-which sets the WM_COMMAND property (see section 14.2.1).
+which sets the <property>WM_COMMAND</property> property (see section 14.2.1).
Note that an argc of zero is allowed to indicate a zero-length command.
Note also that the hostname of this machine is stored using
<function>XSetWMClientMachine</function>
@@ -4138,12 +4153,12 @@ If the normal_hints argument is non-NULL, <function>XSetWMProperties</function>
calls
<function>XSetWMNormalHints</function>,
-which sets the WM_NORMAL_HINTS property (see section 14.1.7).
+which sets the <property>WM_NORMAL_HINTS</property> property (see section 14.1.7).
If the wm_hints argument is non-NULL,
<function>XSetWMProperties</function>
calls
<function>XSetWMHints</function>,
-which sets the WM_HINTS property (see section 14.1.6).
+which sets the <property>WM_HINTS</property> property (see section 14.1.6).
</para>
<para>
<!-- .LP -->
@@ -4151,7 +4166,7 @@ If the class_hints argument is non-NULL, <function>XSetWMProperties</function>
calls
<function>XSetClassHint</function>,
-which sets the WM_CLASS property (see section 14.1.8).
+which sets the <property>WM_CLASS</property> property (see section 14.1.8).
If the res_name member in the
<structname>XClassHint</structname>
structure is set to the NULL pointer and the RESOURCE_NAME environment
@@ -4186,12 +4201,12 @@ This section discusses how to: <itemizedlist>
<listitem>
<para>
-Set and read the WM_COMMAND property
+Set and read the <property>WM_COMMAND</property> property
</para>
</listitem>
<listitem>
<para>
-Set and read the WM_CLIENT_MACHINE property
+Set and read the <property>WM_CLIENT_MACHINE</property> property
</para>
</listitem>
</itemizedlist>
@@ -4203,12 +4218,12 @@ Set and read the WM_CLIENT_MACHINE property <para>
<!-- .LP -->
Xlib provides functions that you can use to set and read
-the WM_COMMAND property for a given window.
+the <property>WM_COMMAND</property> property for a given window.
<!-- .sp -->
</para>
<para>
<!-- .LP -->
-To set a window's WM_COMMAND property, use
+To set a window's <property>WM_COMMAND</property> property, use
<function>XSetCommand</function>.
<indexterm significance="preferred"><primary>XSetCommand</primary></indexterm>
<!-- .sM -->
@@ -4288,7 +4303,7 @@ errors. </para>
<para>
<!-- .LP -->
-To read a window's WM_COMMAND property, use
+To read a window's <property>WM_COMMAND</property> property, use
<function>XGetCommand</function>.
<indexterm significance="preferred"><primary>XGetCommand</primary></indexterm>
<!-- .sM -->
@@ -4350,9 +4365,9 @@ Returns the number of arguments returned. <!-- .eM -->
The
<function>XGetCommand</function>
-function reads the WM_COMMAND property from the specified window
+function reads the <property>WM_COMMAND</property> property from the specified window
and returns a string list.
-If the WM_COMMAND property exists,
+If the <property>WM_COMMAND</property> property exists,
it is of type STRING and format 8.
If sufficient memory can be allocated to contain the string list,
<function>XGetCommand</function>
@@ -4374,12 +4389,12 @@ To free the memory allocated to the string list, use <para>
<!-- .LP -->
Xlib provides functions that you can use to set and read
-the WM_CLIENT_MACHINE property for a given window.
+the <property>WM_CLIENT_MACHINE</property> property for a given window.
<!-- .sp -->
</para>
<para>
<!-- .LP -->
-To set a window's WM_CLIENT_MACHINE property, use
+To set a window's <property>WM_CLIENT_MACHINE</property> property, use
<function>XSetWMClientMachine</function>.
<indexterm significance="preferred"><primary>XSetWMClientMachine</primary></indexterm>
<!-- .sM -->
@@ -4434,12 +4449,12 @@ The <function>XSetWMClientMachine</function>
convenience function calls
<function>XSetTextProperty</function>
-to set the WM_CLIENT_MACHINE property.
+to set the <property>WM_CLIENT_MACHINE</property> property.
<!-- .sp -->
</para>
<para>
<!-- .LP -->
-To read a window's WM_CLIENT_MACHINE property, use
+To read a window's <property>WM_CLIENT_MACHINE</property> property, use
<function>XGetWMClientMachine</function>.
<indexterm significance="preferred"><primary>XGetWMClientMachine</primary></indexterm>
<!-- .sM -->
@@ -4494,7 +4509,7 @@ The <function>XGetWMClientMachine</function>
convenience function performs an
<function>XGetTextProperty</function>
-on the WM_CLIENT_MACHINE property.
+on the <property>WM_CLIENT_MACHINE</property> property.
It returns a nonzero status on success;
otherwise, it returns a zero status.
</para>
@@ -4772,7 +4787,10 @@ and each such property is identified by an atom. The following list names the atoms and describes the colormap
associated with each one.
The
-<<filename class="headerfile">X11/Xatom.h</filename>>
+<filename class="headerfile"><X11/Xatom.h></filename>
+<indexterm type="file"><primary><filename class="headerfile">X11/Xatom.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xatom.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xatom.h></filename></secondary></indexterm>
header file contains the definitions for each of the following atoms,
which are prefixed with XA_.
</para>
diff --git a/libX11/specs/libX11/CH15.xml b/libX11/specs/libX11/CH15.xml index 844f1d204..753dff177 100644 --- a/libX11/specs/libX11/CH15.xml +++ b/libX11/specs/libX11/CH15.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="resource_manager_functions">
<title>Resource Manager Functions</title>
<!-- .sp 2 -->
@@ -123,7 +126,10 @@ value for that entry. <para>
<!-- .LP -->
The definitions for the resource manager are contained in
-<<filename class="headerfile">X11/Xresource.h</filename>>.
+<filename class="headerfile"><X11/Xresource.h></filename>.
+<indexterm type="file"><primary><filename class="headerfile">X11/Xresource.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xresource.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xresource.h></filename></secondary></indexterm>
</para>
<sect1 id="Resource_File_Syntax">
<title>Resource File Syntax</title>
@@ -1484,9 +1490,6 @@ otherwise, they return <para>
<!-- .LP -->
<!-- .sp -->
-<!-- .EQ -->
-<!-- delim %% -->
-<!-- .EN -->
Most applications and toolkits do not make random probes
into a resource database to fetch resources.
The X toolkit access pattern for a resource database is quite stylized.
@@ -1494,7 +1497,8 @@ A series of from 1 to 20 probes is made with only the last name/class differing in each probe.
The
<function>XrmGetResource</function>
-function is at worst a %2 sup n% algorithm, <!-- FIXME: log(n) ? -->
+function is at worst a
+2<superscript><emphasis remap='I'>n</emphasis></superscript> algorithm,
where <emphasis remap='I'>n</emphasis> is the length of the name/class list.
This can be improved upon by the application programmer by prefetching a list
of database levels that might match the first part of a name/class list.
@@ -1595,8 +1599,10 @@ otherwise, it returns The size of the search list that the caller must allocate is
dependent upon the number of levels and wildcards in the resource specifiers
that are stored in the database.
-The worst case length is %3 sup n%,
-where <emphasis remap='I'>n</emphasis> is the number of name or class components in names or classes.
+The worst case length is
+3<superscript><emphasis remap='I'>n</emphasis></superscript>,
+where <emphasis remap='I'>n</emphasis> is the number of name or class
+components in names or classes.
</para>
<para>
<!-- .LP -->
diff --git a/libX11/specs/libX11/CH16.xml b/libX11/specs/libX11/CH16.xml index c3751cc09..9c7bf8c01 100644 --- a/libX11/specs/libX11/CH16.xml +++ b/libX11/specs/libX11/CH16.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="application_utility_functions">
<title>Application Utility Functions</title>
<!-- .sp 2 -->
@@ -394,7 +397,10 @@ Specifies the name of the KeySym that is to be converted. <!-- .LP -->
<!-- .eM -->
Standard KeySym names are obtained from
-<<filename class="headerfile">X11/keysymdef.h</filename>>
+<filename class="headerfile"><X11/keysymdef.h></filename>
+<indexterm type="file"><primary><filename class="headerfile">X11/keysymdef.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/keysymdef.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/keysymdef.h></filename></secondary></indexterm>
by removing the XK_ prefix from each name.
KeySyms that are not part of the Xlib standard also may be obtained
with this function.
@@ -792,7 +798,7 @@ use <funcdef><function>XRebindKeysym</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>KeySym<parameter> keysym</parameter></paramdef>
- <paramdef>KeySym<parameter> list[\^]\^</parameter></paramdef>
+ <paramdef>KeySym<parameter> list[ ]</parameter></paramdef>
<paramdef>int<parameter> mod_count</parameter></paramdef>
<paramdef>unsignedchar<parameter> *string</parameter></paramdef>
<paramdef>int<parameter> num_bytes</parameter></paramdef>
@@ -1011,8 +1017,8 @@ Specifically, this function lets you parse strings of the form: <para>
<!-- .LP -->
The fields map into the arguments associated with this function.
-(Items enclosed in <\^> are integers, items in [\^] are optional, and
-items enclosed in {\^} indicate ``choose one of.''
+(Items enclosed in < > are integers, items in [ ] are optional, and
+items enclosed in { } indicate ``choose one of.''
Note that the brackets should not appear in the actual string.)
If the string is not in the Host Portable Character Encoding,
the result is implementation-dependent.
@@ -1024,7 +1030,7 @@ The function returns a bitmask that indicates which of the four values (width,
height, xoffset, and yoffset) were actually found in the string
and whether the x and y values are negative.
-By convention, \-0 is not equal to +0, because the user needs to
+By convention, −0 is not equal to +0, because the user needs to
be able to say ``position the window relative to the right or bottom edge.''
For each value found, the corresponding argument is updated.
For each value not found, the argument is left unchanged.
@@ -1037,7 +1043,10 @@ The bits are represented by or
<symbol>YNegative</symbol>
and are defined in
-<<filename class="headerfile">X11/Xutil.h</filename>>.
+<filename class="headerfile"><X11/Xutil.h></filename>.
+<indexterm type="file"><primary><filename class="headerfile">X11/Xutil.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
They will be set whenever one of the values is defined
or one of the signs is set.
</para>
@@ -1196,7 +1205,7 @@ The function combines any geometry information (given in the format used by
<function>XParseGeometry</function>)
specified by the user and by the calling program with size hints
-(usually the ones to be stored in WM_NORMAL_HINTS) and returns the position,
+(usually the ones to be stored in <property>WM_NORMAL_HINTS</property>) and returns the position,
size, and gravity
(<symbol>NorthWestGravity</symbol>,
<symbol>NorthEastGravity</symbol>,
@@ -1239,7 +1248,10 @@ Xlib provides functions for manipulating regions. The opaque type
<structname>Region</structname>
is defined in
-<<filename class="headerfile">X11/Xutil.h</filename>>.
+<filename class="headerfile"><X11/Xutil.h></filename>.
+<indexterm type="file"><primary><filename class="headerfile">X11/Xutil.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
Xlib provides functions that you can use to manipulate regions.
This section discusses how to:
</para>
@@ -2144,7 +2156,7 @@ To store data in cut buffer 0, use <funcdef><function>XStoreBytes</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> *bytes</parameter></paramdef>
- <paramdef>int<parameter> \^nbytes</parameter></paramdef>
+ <paramdef>int<parameter> nbytes</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<!-- .FN -->
@@ -2209,7 +2221,7 @@ To store data in a specified cut buffer, use <funcdef><function>XStoreBuffer</function></funcdef>
<paramdef>Display<parameter> *display</parameter></paramdef>
<paramdef>char<parameter> *bytes</parameter></paramdef>
- <paramdef>int<parameter> \^nbytes</parameter></paramdef>
+ <paramdef>int<parameter> nbytes</parameter></paramdef>
<paramdef>int<parameter> buffer</parameter></paramdef>
</funcprototype>
</funcsynopsis>
@@ -2456,7 +2468,10 @@ The functions in this section use the visual information masks and the <structname>XVisualInfo</structname>
structure,
which is defined in
-<<filename class="headerfile">X11/Xutil.h</filename>>
+<filename class="headerfile"><X11/Xutil.h></filename>
+<indexterm type="file"><primary><filename class="headerfile">X11/Xutil.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
and contains:
<!-- .sM -->
</para>
@@ -2675,7 +2690,10 @@ All operations on images are defined using an <structname>XImage</structname>
structure,
as defined in
-<<filename class="headerfile">X11/Xlib.h</filename>>.
+<filename class="headerfile"><X11/Xlib.h></filename>.
+<indexterm type="file"><primary><filename class="headerfile">X11/Xlib.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xlib.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xlib.h></filename></secondary></indexterm>
Because the number of different types of image formats can be very large,
this hides details of image storage properly from applications.
</para>
@@ -2900,7 +2918,10 @@ The basic functions used to get a pixel, set a pixel, create a subimage, and add a constant value to an image are defined in the image object.
The functions in this section are really macro invocations of the functions
in the image object and are defined in
-<<filename class="headerfile">X11/Xutil.h</filename>>.
+<filename class="headerfile"><X11/Xutil.h></filename>.
+<indexterm type="file"><primary><filename class="headerfile">X11/Xutil.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
</para>
<para>
<!-- .LP -->
@@ -3180,7 +3201,7 @@ use <funcsynopsis>
<funcprototype>
<funcdef><function>XDestroyImage</function></funcdef>
- <paramdef>XImage<parameter> *\^ximage</parameter></paramdef>
+ <paramdef>XImage *<parameter>ximage</parameter></paramdef>
</funcprototype>
</funcsynopsis>
<!-- .FN -->
@@ -3400,7 +3421,7 @@ when finished. If <emphasis remap='I'>name</emphasis>_x_hot and <emphasis remap='I'>name</emphasis>_y_hot exist,
<function>XReadBitmapFile</function>
returns them to x_hot_return and y_hot_return;
-otherwise, it returns \-1,\-1.
+otherwise, it returns −1,−1.
</para>
<para>
<!-- .LP -->
@@ -3597,7 +3618,7 @@ Specify the width and height. </term>
<listitem>
<para>
-Specify where to place the hotspot coordinates (or \-1,\-1 if none are present)
+Specify where to place the hotspot coordinates (or −1,−1 if none are present)
in the file.
</para>
</listitem>
@@ -3623,7 +3644,7 @@ returns otherwise, on no error,
it returns
<returnvalue>BitmapSuccess</returnvalue>.
-If x_hot and y_hot are not \-1, \-1,
+If x_hot and y_hot are not −1, −1,
<function>XWriteBitmapFile</function>
writes them out as the hotspot coordinates for the bitmap.
</para>
@@ -3909,7 +3930,10 @@ Xlib provides context management functions with which you can save data values, get data values, delete entries, and create a unique
context type.
The symbols used are in
-<<filename class="headerfile">X11/Xutil.h</filename>>.
+<filename class="headerfile"><X11/Xutil.h></filename>.
+<indexterm type="file"><primary><filename class="headerfile">X11/Xutil.h</filename></primary></indexterm>
+<indexterm><primary>Files</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
+<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><X11/Xutil.h></filename></secondary></indexterm>
</para>
<para>
<!-- .LP -->
diff --git a/libX11/specs/libX11/credits.xml b/libX11/specs/libX11/credits.xml index 17713d3cb..13c8c055e 100644 --- a/libX11/specs/libX11/credits.xml +++ b/libX11/specs/libX11/credits.xml @@ -1,3 +1,6 @@ +<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE preface PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<preface id="acknowledgments">
<title>Acknowledgments</title>
<para>
diff --git a/libX11/specs/libX11/glossary.xml b/libX11/specs/libX11/glossary.xml index 4202e9a9d..6f909b2b0 100644 --- a/libX11/specs/libX11/glossary.xml +++ b/libX11/specs/libX11/glossary.xml @@ -1,3 +1,6 @@ +<?xml version="1.0" encoding="UTF-8" ?>
+<!DOCTYPE glossary PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
+ "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
<glossary id='glossary'>
<title>Glossary</title>
<glossentry id="glossary:Access_control_list">
@@ -1065,12 +1068,10 @@ displayed. <glossterm>Pixmap</glossterm>
<glossdef>
<indexterm significance="preferred"><primary>Pixmap</primary></indexterm>
-<!-- .EQ -->
-<!-- .EN -->
<para>
A pixmap is a three-dimensional array of bits.
A pixmap is normally thought of as a two-dimensional array of pixels,
-where each pixel can be a value from 0 to %2 sup N %\-1,
+where each pixel can be a value from 0 to 2<superscript>N</superscript>-1,
and where N is the depth (z axis) of the pixmap.
A pixmap can also be thought of as a stack of N bitmaps.
A pixmap can only be used on the screen that it was created in.
@@ -1667,19 +1668,11 @@ Manipulation of windows on the screen and much of the user interface <para>
A basic set of 97 characters which are assumed to exist in all
locales supported by Xlib. This set contains the following characters:
- </para>
- <para>
-<!-- .Ds 0 -->
-<!-- .EQ -->
-<!-- .EN -->
- </para>
- <para>
+ <literallayout>
a..z A..Z 0..9
!"#$%&'()*+,-./:;<=>?@[\\]^_`{|}~
<space>, <tab>, and <newline>
-<!-- .EQ -->
-<!-- .EN -->
-<!-- .De -->
+ </literallayout>
</para>
<para>
This is the left/lower half (also called the G0 set)
diff --git a/libX11/specs/libX11/libX11.xml b/libX11/specs/libX11/libX11.xml index 40a1d95ec..50da9e620 100644 --- a/libX11/specs/libX11/libX11.xml +++ b/libX11/specs/libX11/libX11.xml @@ -2,7 +2,7 @@ <!DOCTYPE book PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN"
"http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd">
-<book id="libX11">
+<book id="libX11" lang="en">
<bookinfo>
<title>Xlib - C Language X Interface</title>
|