summaryrefslogtreecommitdiff
path: root/specs
diff options
context:
space:
mode:
authorAlan Coopersmith <alan.coopersmith@oracle.com>2010-12-16 23:54:45 -0800
committerAlan Coopersmith <alan.coopersmith@oracle.com>2010-12-16 23:54:45 -0800
commit9df8b77604b7ea7132d32f65f2280720b91249c1 (patch)
treecb60ea3563e7c6204cac75a19dfd7809862b4a02 /specs
parent6aa72ae8e629e065f09a6b6c05504363806d76a3 (diff)
specs: Fix section titles/nesting
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
Diffstat (limited to 'specs')
-rw-r--r--specs/dpms.xml17
-rw-r--r--specs/evi.xml29
-rw-r--r--specs/multibuf.xml77
-rw-r--r--specs/shape.xml34
-rw-r--r--specs/shm.xml21
-rw-r--r--specs/tog-cup.xml30
-rw-r--r--specs/xtest.xml37
7 files changed, 114 insertions, 131 deletions
diff --git a/specs/dpms.xml b/specs/dpms.xml
index d5323b1..98aaaa3 100644
--- a/specs/dpms.xml
+++ b/specs/dpms.xml
@@ -34,9 +34,7 @@ provided "as is" without express or implied warranty.
</legalnotice>
</bookinfo>
-<chapter>
-<title>TITLE</title>
-<sect1 id="Overview">
+<chapter id="Overview">
<title>Overview</title>
<para>
This extension provides X Protocol control over the VESA Display
@@ -119,9 +117,9 @@ importance of power savings should supersede the screen saver. If the
laptop user plugs the unit in and power is no longer a scarce commodity,
it may be decided to make DPMS less aggressive, or disable it completely.
</para>
-</sect1>
+</chapter>
-<sect1 id="Requests">
+<chapter id="Requests">
<title>Requests</title>
<para>
<function>DPMSGetVersion</function>
@@ -430,16 +428,16 @@ of DPMSModeOn, DPMSModeStandby, DPMSModeSuspend or DPMSModeOff, otherwise
it is undefined.
</para>
-</sect1>
+</chapter>
-<sect1 id="Events_and_Errors">
+<chapter id="Events_and_Errors">
<title>Events and Errors</title>
<para>
No new events or errors are defined by this extension.
</para>
-</sect1>
+</chapter>
-<sect1 id="Encoding">
+<chapter id="Encoding">
<title>Encoding</title>
<para>
Please refer to the X11 Protocol Encoding document as this document uses
@@ -558,6 +556,5 @@ The name of this extension is "DPMS".
21 unused
</literallayout>
-</sect1>
</chapter>
</book>
diff --git a/specs/evi.xml b/specs/evi.xml
index 1136278..a565f73 100644
--- a/specs/evi.xml
+++ b/specs/evi.xml
@@ -62,17 +62,15 @@ X Window System is a trademark of The Open Group.
</legalnotice>
</bookinfo>
-<chapter>
-<title>TITLE</title>
-<sect1 id="Introduction">
+<chapter id="Introduction">
<title>Introduction</title>
<para>
EVI (Extended Visual Information extension) allows a client to determine
information about core X visuals beyond what the core protocol provides.
</para>
-</sect1>
+</chapter>
-<sect1 id="Goals">
+<chapter id="Goals">
<title>Goals</title>
<para>
As the X Window System has evolved, it has become clear that the information
@@ -90,9 +88,9 @@ their own mechanisms for delivering that information. For example, the Double
Buffering Extension (DBE) provides its own mechanism for determining which
visuals support double-buffering.
</para>
-</sect1>
+</chapter>
-<sect1 id="Requests">
+<chapter id="Requests">
<title>Requests</title>
<para>
<function>GetVersion</function>
@@ -285,22 +283,22 @@ example, if a 12-bit colormap is overloaded to support 8-bit visuals, the
</listitem>
</itemizedlist>
-</sect1>
-<sect1 id="Events_and_Errors">
+</chapter>
+<chapter id="Events_and_Errors">
<title>Events and Errors</title>
<para>
No new events or errors are defined by this extension.
</para>
-</sect1>
+</chapter>
-<sect1 id="Changes_to_existing_protocol_">
+<chapter id="Changes_to_existing_protocol_">
<title>Changes to existing protocol.</title>
<para>
None.
</para>
-</sect1>
+</chapter>
-<sect1 id="Encoding">
+<chapter id="Encoding">
<title>Encoding</title>
<para>
The name of this extension is "Extended-Visual-Information".
@@ -358,9 +356,9 @@ VISUALINFO
1 CARD8 max_hw_colormaps
2 CARD16 num_colormap_conflicts
</literallayout>
-</sect1>
+</chapter>
-<sect1 id="C_Language_Binding">
+<chapter id="C_Language_Binding">
<title>C Language Binding</title>
<para>
<!-- .LP -->
@@ -513,6 +511,5 @@ of hardware support for multiple colormaps. XeviGetVisualInfo returns Success
if successful, or an X error otherwise.
</para>
-</sect1>
</chapter>
</book>
diff --git a/specs/multibuf.xml b/specs/multibuf.xml
index 263d580..eb01829 100644
--- a/specs/multibuf.xml
+++ b/specs/multibuf.xml
@@ -70,16 +70,16 @@ in this Software without prior written authorization from the X Consortium.
</legalnotice>
</bookinfo>
-<chapter>
-<title>TITLE</title>
+<preface><title>Warning</title>
<warning><para>
The <emphasis remap='I'>Multi-Buffering</emphasis> extension described here
was a draft standard of the X Consortium prior to Release 6.1. It has been
superseded by the Double Buffer
Extension (DBE). DBE is an X Consortium Standard as of Release 6.1.
</para></warning>
+</preface>
-<sect1 id="introduction">
+<chapter id="introduction">
<title>Introduction</title>
<para>
@@ -120,9 +120,9 @@ The authors of this proposal have tried to unify the above documents
to yield a proposal that incorporates support for double-buffering,
multi-buffering, and stereo in a way that is acceptable to all concerned.
</para>
-</sect1>
+</chapter>
-<sect1 id="goals">
+<chapter id="goals">
<title>Goals</title>
<para>
@@ -176,9 +176,9 @@ existing hardware features.
</listitem>
</itemizedlist>
-</sect1>
+</chapter>
-<sect1 id="image_buffers">
+<chapter id="image_buffers">
<title>Image Buffers</title>
<para>
@@ -316,9 +316,9 @@ the screen contents are not altered and the contents of any
undisplayed image buffers are undefined. If backing store was
maintained for an image buffer, then no exposure events are generated.
</para>
-</sect1>
+</chapter>
-<sect1 id="new_requests">
+<chapter id="new_requests">
<title>New Requests</title>
<para>
@@ -671,9 +671,9 @@ display are de-allocated. If the window is not multi-buffered,
the request is ignored.
</para>
-</sect1>
+</chapter>
-<sect1 id="attributes">
+<chapter id="attributes">
<title>Attributes</title>
<para>
@@ -860,9 +860,9 @@ increment for incompatible changes, and the minor version would
increment for small upward compatible changes. Barring changes, the
major version will be 1, and the minor version will be 1.
</para>
-</sect1>
+</chapter>
-<sect1 id="events">
+<chapter id="events">
<title>Events</title>
<para>
@@ -958,9 +958,9 @@ becomes <emphasis remap='I'>updated</emphasis>
<function>DisplayImageBuffers</function>
request), an <function>UpdateNotify</function> event is generated.
</para>
-</sect1>
+</chapter>
-<sect1 id="errors">
+<chapter id="errors">
<title>Errors</title>
<para>
@@ -968,14 +968,14 @@ The following error type has been added to support
this extension:
</para>
-<sect2 id="buffer_2">
+<sect1 id="buffer_2">
<title>Buffer</title>
<para>
A value for a BUFFER argument does not name a defined BUFFER.
</para>
-</sect2>
+</sect1>
-<sect2 id="double_buffering_normal_windows">
+<sect1 id="double_buffering_normal_windows">
<title>Double-Buffering Normal Windows</title>
<para>
@@ -1023,9 +1023,9 @@ while animating
DestroyImageBuffers( W )
</literallayout>
-</sect2>
+</sect1>
-<sect2 id="multi_buffering_normal_windows">
+<sect1 id="multi_buffering_normal_windows">
<title>Multi-Buffering Normal Windows</title>
<para>
@@ -1070,9 +1070,9 @@ while animating
}
</literallayout>
-</sect2>
+</sect1>
-<sect2 id="stereo_windows">
+<sect1 id="stereo_windows">
<title>Stereo Windows</title>
<para>
<emphasis remap='I'>How</emphasis> stereo windows are supported on a server
@@ -1175,9 +1175,9 @@ right eyes for normal windows should be the same
(ie: have no stereo offset).
</para>
-</sect2>
+</sect1>
-<sect2 id="single_buffered_stereo_windows">
+<sect1 id="single_buffered_stereo_windows">
<title>Single-Buffered Stereo Windows</title>
<para>
@@ -1195,9 +1195,9 @@ MapWindow( W )
&lt;draw picture using L,R&gt;
</literallayout>
-</sect2>
+</sect1>
-<sect2 id="double_buffering_stereo_windows">
+<sect1 id="double_buffering_stereo_windows">
<title>Double-Buffering Stereo Windows</title>
<para>
@@ -1267,9 +1267,9 @@ while animating
}
</literallayout>
-</sect2>
+</sect1>
-<sect2 id="multi_buffering_stereo_windows">
+<sect1 id="multi_buffering_stereo_windows">
<title>Multi-Buffering Stereo Windows</title>
<para>
@@ -1310,9 +1310,9 @@ while animating
DisplayImageBuffers( [L(i)], 100, 0 )
}
</literallayout>
-</sect2>
+</sect1>
-<sect2 id="protocol_encoding">
+<sect1 id="protocol_encoding">
<title>Protocol Encoding</title>
<para>
@@ -1356,10 +1356,10 @@ Specifies the code that will be returned when
The following sections describe the protocol
encoding for this extension.
</para>
-</sect2>
</sect1>
+</chapter>
-<sect1 id="type">
+<chapter id="type">
<title>TYPES</title>
<literallayout class="monospaced">
@@ -1379,9 +1379,9 @@ SETofBUFFER_EVENT
#x04000000 UpdateNotify
</literallayout>
-</sect1>
+</chapter>
-<sect1 id="events_2">
+<chapter id="events_2">
<title>EVENTS</title>
<literallayout class="monospaced">
@@ -1406,8 +1406,8 @@ SETofBUFFER_EVENT
24 unused
</literallayout>
-</sect1>
-<sect1 id="errors_2">
+</chapter>
+<chapter id="errors_2">
<title>ERRORS</title>
<literallayout class="monospaced">
@@ -1421,9 +1421,9 @@ SETofBUFFER_EVENT
21 unused
</literallayout>
-</sect1>
+</chapter>
-<sect1 id="requests">
+<chapter id="requests">
<title>REQUESTS</title>
<literallayout class="monospaced">
@@ -1623,6 +1623,5 @@ VALUEs
</literallayout>
-</sect1>
</chapter>
</book>
diff --git a/specs/shape.xml b/specs/shape.xml
index 7e5f2f7..3386443 100644
--- a/specs/shape.xml
+++ b/specs/shape.xml
@@ -60,8 +60,7 @@ copyright holders.
</legalnotice>
</bookinfo>
-<chapter><title>TITLE</title>
-<sect1 id="Overview">
+<chapter id="Overview">
<title>Overview</title>
<para>
<!-- .LP -->
@@ -94,9 +93,9 @@ the window's geometry in the core protocol. An expected convention would be
that client programs expand their shape to fill the area offered by the
window manager.
</para>
-</sect1>
+</chapter>
-<sect1 id="Description">
+<chapter id="Description">
<title>Description</title>
<para>
Each window (even with no shapes specified) is defined by three regions: the
@@ -264,9 +263,9 @@ the server is permitted to ignore requested changes to the bounding region
of a root window. If the server accepts bounding region changes, the contents
of the screen outside the bounding region are implementation dependent.
</para>
-</sect1>
+</chapter>
-<sect1 id="Types">
+<chapter id="Types">
<title>Types</title>
<para>
<!-- .LP -->
@@ -307,9 +306,9 @@ produce the new destination region.
indicates that the destination region is subtracted from the source region to
produce the new destination region.
</para>
-</sect1>
+</chapter>
-<sect1 id="Requests">
+<chapter id="Requests">
<title>Requests</title>
<para>
<function>ShapeQueryVersion</function>
@@ -802,9 +801,9 @@ values is the same as in the
<function>ShapeRectangles</function>
request.
</para>
-</sect1>
+</chapter>
-<sect1 id="Events">
+<chapter id="Events">
<title>Events</title>
<para>
<function>ShapeNotify</function>
@@ -870,9 +869,9 @@ current shape. When shaped is
these will indicate the extents of the default region. The timestamp
indicates the server time when the shape was changed.
</para>
-</sect1>
+</chapter>
-<sect1 id="Encoding">
+<chapter id="Encoding">
<title>Encoding</title>
<para>
Please refer to the X11 Protocol Encoding document as this document uses
@@ -883,7 +882,7 @@ conventions established there.
The name of this extension is "SHAPE".
</para>
-<sect2 id="New_Types">
+<sect1 id="New_Types">
<title>New Types</title>
<literallayout class="monospaced">
@@ -901,9 +900,9 @@ SHAPE_OP
3 Subtract
4 Invert
</literallayout>
-</sect2>
+</sect1>
-<sect2 id="Requests_2">
+<sect1 id="Requests_2">
<title>Requests</title>
<literallayout class="monospaced">
<function>ShapeQueryVersion</function>
@@ -1055,9 +1054,9 @@ SHAPE_OP
20 unused
8n LISTofRECTANGLE rectangles
</literallayout>
-</sect2>
+</sect1>
-<sect2 id="Events_2">
+<sect1 id="Events_2">
<title>Events</title>
<literallayout class="monospaced">
<function>ShapeNotify</function>
@@ -1073,7 +1072,6 @@ SHAPE_OP
1 BOOL shaped
11 unused
</literallayout>
-</sect2>
</sect1>
</chapter>
diff --git a/specs/shm.xml b/specs/shm.xml
index 24c989c..19d9309 100644
--- a/specs/shm.xml
+++ b/specs/shm.xml
@@ -67,9 +67,7 @@ in this Software without prior written authorization from the X Consortium.
</legalnotice>
</bookinfo>
-<chapter>
-<title>TITLE</title>
-<sect1 id="REQUIREMENTS">
+<chapter id="REQUIREMENTS">
<title>REQUIREMENTS</title>
<para>
The shared memory extension is provided only by some X servers. To find out
@@ -82,9 +80,9 @@ Additionally, the shared memeory maximum size will need to be increased on
both Sun and Digital systems; the defaults are far too small for any useful
work.
</para>
-</sect1>
+</chapter>
-<sect1 id="WHAT_IS_PROVIDED">
+<chapter id="WHAT_IS_PROVIDED">
<title>WHAT IS PROVIDED</title>
<para>
@@ -106,9 +104,9 @@ pixmap data; if the pixmaps are stored in some magic graphics hardware, your
application will not be able to share them with the server. Xdpyinfo(1)
doesn't print this particular nugget of information.
</para>
-</sect1>
+</chapter>
-<sect1 id="HOW_TO_USE_THE_SHARED_MEMORY_EXTENSION">
+<chapter id="HOW_TO_USE_THE_SHARED_MEMORY_EXTENSION">
<title>HOW TO USE THE SHARED MEMORY EXTENSION</title>
<para>
Code which uses the shared memory extension must include a number of header
@@ -165,9 +163,9 @@ conventional Xlib calls. When the extension is available,
version numbers of the extension implementation, and "pixmaps" which is
True iff shared memory pixmaps are supported.
</para>
-</sect1>
+</chapter>
-<sect1 id="USE_OF_SHARED_MEMORY_XIMAGES">
+<chapter id="USE_OF_SHARED_MEMORY_XIMAGES">
<title>USE OF SHARED MEMORY XIMAGES</title>
<para>
The basic sequence of operations for shared memory XImages is as follows:
@@ -408,9 +406,9 @@ shmdt (shminfo.shmaddr);
shmctl (shminfo.shmid, IPC_RMID, 0);
</literallayout>
-</sect1>
+</chapter>
-<sect1 id="USE_OF_SHARED_MEMORY_PIXMAPS">
+<chapter id="USE_OF_SHARED_MEMORY_PIXMAPS">
<title>USE OF SHARED MEMORY PIXMAPS</title>
<para>
Unlike X images, for which any image format is usable, the shared memory
@@ -469,6 +467,5 @@ contents directly through the shared memory segment. Shared memory pixmaps
are destroyed in the usual manner with XFreePixmap, though you should detach
and destroy the shared memory segment itself as shown above.
</para>
-</sect1>
</chapter>
</book>
diff --git a/specs/tog-cup.xml b/specs/tog-cup.xml
index 08bb19b..bb6fb25 100644
--- a/specs/tog-cup.xml
+++ b/specs/tog-cup.xml
@@ -64,9 +64,7 @@ X Window System is a trademark of The Open Group.
</legalnotice>
</bookinfo>
-<chapter>
-<title>TITLE</title>
-<sect1 id="Overview">
+<chapter id="Overview">
<title>Overview</title>
<para>
This extension has three purposes: a) to provide mechanism for a special
@@ -101,9 +99,9 @@ already been allocated, the color will be allocated in the private colormap
at the same locaton as in the default colormap (instead of in the first
available location.)
</para>
-</sect1>
+</chapter>
-<sect1 id="Requests">
+<chapter id="Requests">
<title>Requests</title>
<para>
<function>QueryVersion</function>
@@ -246,23 +244,23 @@ BadMatch error is generated if if cmap does not belong to a GrayScale,
PseudoColor, or DirectColor visual.
</para>
-</sect1>
+</chapter>
-<sect1 id="Events_and_Errors">
+<chapter id="Events_and_Errors">
<title>Events and Errors</title>
<para>
No new events or errors are defined by this extension.
</para>
-</sect1>
-<sect1 id="Changes_to_existing_protocol_">
+</chapter>
+<chapter id="Changes_to_existing_protocol_">
<title>Changes to existing protocol.</title>
<para>
None.
</para>
-</sect1>
+</chapter>
-<sect1 id="Encoding">
+<chapter id="Encoding">
<title>Encoding</title>
<para>
The name of this extension is "TOG-CUP".
@@ -338,9 +336,9 @@ additional alloc-ok member in the CUPStoreColors reply.)
#xF0 unused
1 unused
</literallayout>
-</sect1>
+</chapter>
-<sect1 id="C_Language_Binding">
+<chapter id="C_Language_Binding">
<title>C Language Binding</title>
<para>
@@ -531,9 +529,9 @@ colors are read-only (shareable). XCupStoreColors returns the number of
colors that were successfully allocated in the colormap.
</para>
-</sect1>
+</chapter>
-<sect1 id="Using_the_TOG_CUP_extension_and_Colormap_Utilization_Policy">
+<chapter id="Using_the_TOG_CUP_extension_and_Colormap_Utilization_Policy">
<title>Using the TOG-CUP extension and Colormap Utilization Policy</title>
<para>
The X server preallocates any hardware or desktop special colors in the
@@ -557,6 +555,6 @@ using XCupStoreColors the colors will be allocated sharable (read-only) and
any other application which allocates the same color will share that color
cell.
</para>
-</sect1>
</chapter>
+
</book>
diff --git a/specs/xtest.xml b/specs/xtest.xml
index 6da29f1..cdf5e63 100644
--- a/specs/xtest.xml
+++ b/specs/xtest.xml
@@ -59,10 +59,7 @@ in this Software without prior written authorization from the X Consortium.
</bookinfo>
-<chapter>
-<title>TITLE</title>
-
-<sect1 id="Overview">
+<chapter id="Overview">
<title>Overview</title>
<para>
This extension is a minimal set of client and server extensions
@@ -110,9 +107,9 @@ Minimize performance penalties on normal server operation.
</para>
</listitem>
</itemizedlist>
-</sect1>
+</chapter>
-<sect1 id="Description">
+<chapter id="Description">
<title>Description</title>
<para>
The functions provided by this extension fall into two groups:
@@ -167,9 +164,9 @@ or pressed a key or button.
</varlistentry>
</variablelist>
-</sect1>
+</chapter>
-<sect1 id="Types">
+<chapter id="Types">
<title>Types</title>
<para>
The following types are used in the request and event definitions in
@@ -223,9 +220,9 @@ CURSOR { <function>CurrentCursor</function>, <function> None</function> }
or a cursor as defined by the X11 Protocol.
</para>
-</sect1>
+</chapter>
-<sect1 id="Client_Operations">
+<chapter id="Client_Operations">
<title>Client Operations</title>
<para>
@@ -330,9 +327,9 @@ in the buffer and
<function>False</function>
otherwise.
</para>
-</sect1>
+</chapter>
-<sect1 id="Server_Requests">
+<chapter id="Server_Requests">
<title>Server Requests</title>
<para>
<function>XTestGetVersion</function>
@@ -607,9 +604,9 @@ If impervious is
then the executing client returns to the normal state of being
susceptible to server grabs.
</para>
-</sect1>
+</chapter>
-<sect1 id="Encoding">
+<chapter id="Encoding">
<title>Encoding</title>
<para>
Please refer to the X11 Protocol Encoding document as this document uses
@@ -620,7 +617,7 @@ conventions established there.
The name of this extension is "XTEST".
</para>
-<sect2 id="New_Types">
+<sect1 id="New_Types">
<title>New Types</title>
<literallayout class="monospaced">
FAKE_EVENT_TYPE
@@ -635,9 +632,9 @@ FAKE_EVENT_TYPE
NOTE that the above values are defined to be the same as those for
the corresponding core protocol event types.
</para>
-</sect2>
+</sect1>
-<sect2 id="Requests">
+<sect1 id="Requests">
<title>Requests</title>
<literallayout class="monospaced">
@@ -700,10 +697,10 @@ the corresponding core protocol event types.
1 BOOL impervious
3 unused
</literallayout>
-</sect2>
</sect1>
+</chapter>
-<sect1 id="References">
+<chapter id="References">
<title>References</title>
<para>
Annicchiarico, D., et al.,
@@ -717,6 +714,6 @@ Drake, K. J.,
Minimum X11 Testing Extension</emphasis>.
UniSoft Ltd., June 1991.
</para>
-</sect1>
</chapter>
+
</book>