diff options
| author | Alan Coopersmith <alan.coopersmith@oracle.com> | 2010-07-18 13:12:20 -0700 |
|---|---|---|
| committer | Alan Coopersmith <alan.coopersmith@oracle.com> | 2010-07-18 13:47:35 -0700 |
| commit | c944a8521f5760b485192658b921145159cdb439 (patch) | |
| tree | 282aa1f0345f95b438bd4397ee79f8a448a6a7ba | |
| parent | bb66e8f1ce330043278d3e8cbc7d5d3bc56ee030 (diff) | |
specs/libX11: Fix up list of header files in Ch.1 & add index entries
Combination of manual editing and automatic substitution via:
perl -i -p -00 -e 's{<varlistentry>(\s+)<term><X11/([^&]+)></term>(\s+)<listitem>(\s+)<para>}{<varlistentry id="Standard_Header_Files:$2">$1<term><filename class="headerfile"><X11/$2></filename></term>$3<listitem>$4<indexterm type="file"><primary><filename class="headerfile">X11/$2</filename></primary></indexterm>$4<indexterm><primary>Files</primary><secondary><X11/$2></secondary></indexterm>$4<indexterm><primary>Headers</primary><secondary><X11/$2></secondary></indexterm>$4<para>}g' CH01.xml
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
| -rw-r--r-- | specs/libX11/CH01.xml | 114 |
1 files changed, 76 insertions, 38 deletions
diff --git a/specs/libX11/CH01.xml b/specs/libX11/CH01.xml index bf7b3a32..afe5f544 100644 --- a/specs/libX11/CH01.xml +++ b/specs/libX11/CH01.xml @@ -35,7 +35,6 @@ To provide an introduction to X programming, this chapter discusses: <listitem><para>Formatting conventions</para></listitem> </itemizedlist> - <sect1 id="Overview_of_the_X_Window_System"> <title>Overview of the X Window System</title> <!-- .XS --> @@ -284,12 +283,15 @@ the error is printed, and your program terminates. <para> <!-- .LP --> 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. @@ -301,63 +303,82 @@ 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 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, 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. @@ -365,9 +386,12 @@ 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_". @@ -381,57 +405,72 @@ XK_HEBREW, XK_THAI, and XK_KOREAN</function>. </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> +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. 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. @@ -439,10 +478,9 @@ X10 compatibility functions, which are described in appendix D. </listitem> </varlistentry> </variablelist> +</para> </sect1> - - <sect1 id="Generic_Values_and_Types"> <title>Generic Values and Types</title> <!-- .XS --> |