diff options
author | Alan Coopersmith <alan.coopersmith@oracle.com> | 2010-07-18 12:47:27 -0700 |
---|---|---|
committer | Alan Coopersmith <alan.coopersmith@oracle.com> | 2010-07-18 13:47:16 -0700 |
commit | bb66e8f1ce330043278d3e8cbc7d5d3bc56ee030 (patch) | |
tree | 650709de835ee5c324adddb05063708d79d64e9e | |
parent | d0b0d215cb85da48b323b1392149ce181e7ef5ec (diff) |
specs/libX11: Add indexterms for headerfiles that .hN used to provide
Automatic substitution performed via:
perl -i -p -e 's{^<<filename class="headerfile">([^<]+)</filename>>(.*)$}{<filename class="headerfile"><$1></filename>$2\n<indexterm type="file"><primary><filename class="headerfile">$1</filename></primary></indexterm>\n<indexterm><primary>Files</primary><secondary><filename class="headerfile"><$1></filename></secondary></indexterm>\n<indexterm><primary>Headers</primary><secondary><filename class="headerfile"><$1></filename></secondary></indexterm>}' *.xml
Signed-off-by: Alan Coopersmith <alan.coopersmith@oracle.com>
-rw-r--r-- | specs/libX11/AppD.xml | 15 | ||||
-rw-r--r-- | specs/libX11/CH01.xml | 5 | ||||
-rw-r--r-- | specs/libX11/CH02.xml | 5 | ||||
-rw-r--r-- | specs/libX11/CH04.xml | 5 | ||||
-rw-r--r-- | specs/libX11/CH06.xml | 10 | ||||
-rw-r--r-- | specs/libX11/CH07.xml | 5 | ||||
-rw-r--r-- | specs/libX11/CH08.xml | 5 | ||||
-rw-r--r-- | specs/libX11/CH10.xml | 20 | ||||
-rw-r--r-- | specs/libX11/CH12.xml | 10 | ||||
-rw-r--r-- | specs/libX11/CH14.xml | 25 | ||||
-rw-r--r-- | specs/libX11/CH15.xml | 5 | ||||
-rw-r--r-- | specs/libX11/CH16.xml | 35 |
12 files changed, 116 insertions, 29 deletions
diff --git a/specs/libX11/AppD.xml b/specs/libX11/AppD.xml index 62fe628f..3331fd63 100644 --- a/specs/libX11/AppD.xml +++ b/specs/libX11/AppD.xml @@ -186,7 +186,10 @@ 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>> +<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> @@ -1323,7 +1326,10 @@ 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: <indexterm significance="preferred"><primary>Vertex</primary></indexterm> <synopsis> @@ -1343,7 +1349,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> diff --git a/specs/libX11/CH01.xml b/specs/libX11/CH01.xml index 379c6581..bf7b3a32 100644 --- a/specs/libX11/CH01.xml +++ b/specs/libX11/CH01.xml @@ -179,7 +179,10 @@ These can be of type 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 diff --git a/specs/libX11/CH02.xml b/specs/libX11/CH02.xml index fd3a6089..77f2ae80 100644 --- a/specs/libX11/CH02.xml +++ b/specs/libX11/CH02.xml @@ -219,7 +219,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/specs/libX11/CH04.xml b/specs/libX11/CH04.xml index b9b70b2f..2d549586 100644 --- a/specs/libX11/CH04.xml +++ b/specs/libX11/CH04.xml @@ -875,7 +875,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. diff --git a/specs/libX11/CH06.xml b/specs/libX11/CH06.xml index 3f5c843d..832a4101 100644 --- a/specs/libX11/CH06.xml +++ b/specs/libX11/CH06.xml @@ -80,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 --> diff --git a/specs/libX11/CH07.xml b/specs/libX11/CH07.xml index fe20f430..588217f8 100644 --- a/specs/libX11/CH07.xml +++ b/specs/libX11/CH07.xml @@ -269,7 +269,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 --> diff --git a/specs/libX11/CH08.xml b/specs/libX11/CH08.xml index 08de93d0..5a2a5de2 100644 --- a/specs/libX11/CH08.xml +++ b/specs/libX11/CH08.xml @@ -3341,7 +3341,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/specs/libX11/CH10.xml b/specs/libX11/CH10.xml index 812accd3..0804da55 100644 --- a/specs/libX11/CH10.xml +++ b/specs/libX11/CH10.xml @@ -58,7 +58,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 +174,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 +319,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. @@ -2932,7 +2941,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/specs/libX11/CH12.xml b/specs/libX11/CH12.xml index a94c57fb..5750aec8 100644 --- a/specs/libX11/CH12.xml +++ b/specs/libX11/CH12.xml @@ -3035,14 +3035,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/specs/libX11/CH14.xml b/specs/libX11/CH14.xml index e89cbba4..86d398a6 100644 --- a/specs/libX11/CH14.xml +++ b/specs/libX11/CH14.xml @@ -1964,7 +1964,10 @@ 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> @@ -2251,7 +2254,10 @@ 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> @@ -2787,7 +2793,10 @@ 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> @@ -3528,7 +3537,10 @@ 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> @@ -4772,7 +4784,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/specs/libX11/CH15.xml b/specs/libX11/CH15.xml index 98410194..2d7f2c45 100644 --- a/specs/libX11/CH15.xml +++ b/specs/libX11/CH15.xml @@ -123,7 +123,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> diff --git a/specs/libX11/CH16.xml b/specs/libX11/CH16.xml index 813e635e..3e6c0aaa 100644 --- a/specs/libX11/CH16.xml +++ b/specs/libX11/CH16.xml @@ -394,7 +394,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. @@ -1037,7 +1040,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> @@ -1239,7 +1245,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> @@ -2456,7 +2465,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 +2687,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 +2915,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 --> @@ -3909,7 +3927,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 --> |