From 558ec1d7194307d7ce73aeae2f4f61df9d44bba0 Mon Sep 17 00:00:00 2001 From: Matt Dew Date: Tue, 4 Oct 2011 21:50:03 -0600 Subject: Cleanup IDs and links in doc 1 - fix the capitalization of the ID attributes to match either the or <funcdef> string it goes with. 2 - fix any <linkend>'s that were affected by 1. 3 - any <function> in the docs that has an actual funcdef, will become an olink. Signed-off-by: Matt Dew <marcoz@osource.org> --- specs/recordlib.xml | 208 +++++++++++++++++++++++++--------------------------- specs/xtestlib.xml | 50 ++++++------- 2 files changed, 126 insertions(+), 132 deletions(-) (limited to 'specs') diff --git a/specs/recordlib.xml b/specs/recordlib.xml index 85cdaf4..08d3eb2 100644 --- a/specs/recordlib.xml +++ b/specs/recordlib.xml @@ -67,7 +67,7 @@ X Consortium. </legalnotice> </bookinfo> -<chapter id="record_extension_overview"> +<chapter id='Record_Extension_Overview'> <title>Record Extension Overview The purpose of this extension is to support the recording and reporting of @@ -76,7 +76,7 @@ gives an overview of the Record extension. The following sections describe how to use the Record extension library. - + Synchronous Playback Environment information is generally provided to an X-based playback @@ -113,7 +113,7 @@ synchronization methodology. - + Design Approach The design approach of the extension is to record core X protocol and @@ -125,7 +125,7 @@ events, including input device events that do not go to any clients. - + Record Clients The recommended communication model for a Record application is to open two @@ -144,14 +144,13 @@ recording operations. A client that wishes to record X protocol does so through the library functions defined in - - + A typical sequence of requests that a client would make is as follows: -XRecordQueryVersion + query the extension protocol version. @@ -159,7 +158,7 @@ query the extension protocol version. -XRecordCreateContext + request that the server create a record context for access by this client, @@ -170,7 +169,7 @@ used by most other extension requests to identify the specified context. -XRecordEnableContext + begin the recording and reporting of protocol data. @@ -178,7 +177,7 @@ begin the recording and reporting of protocol data. -XRecordDisableContext + end the recording and reporting of protocol data. @@ -186,7 +185,7 @@ end the recording and reporting of protocol data. -XRecordFreeContext + free the record context. @@ -205,11 +204,11 @@ The Xtst library contains the - + Common Arguments -The Record extension functions XRecordCreateContext - and XRecordRegisterClients allow applications to +The Record extension functions + and allow applications to specify the following: @@ -231,21 +230,20 @@ recording client although it may not be sent to a recorded client. The device_events type differs from delivered_events, which also can be specified by a recording client; delivered_events are actually delivered to one or more clients. These event types are discussed in - - + -The Record extension functions XRecordCreateContext - and XRecordRegisterClients have the common arguments +The Record extension functions + and have the common arguments datum_flags, clients, and ranges, which specify whether server time and/or client sequence number should precede protocol elements, the clients or client set to record, and the protocol ranges to record, respectively. These are discussed in the following sections. - + Datum Flags The datum_flags argument is a set of flags OR’ed together to specify options @@ -274,7 +272,7 @@ The XRecordFromClientSequence flag specifies that - + Selecting Clients @@ -299,8 +297,7 @@ If the element in the array identifies a particular client, protocol specified by the ranges argument will be recorded by the server. The recorded protocol data will not be returned to the recording client until the record context has been enabled. This is described in - - + If the element is XRecordCurrentClients, the protocol @@ -320,12 +317,12 @@ silently exclude the recording data connection. It is an error to explicitly register the data connection. - + Protocol Ranges -The functions XRecordCreateContext and -XRecordRegisterClients have another common argument, +The functions and + have another common argument, ranges, which is an array of pointers to XRecordRange structures. Each structure contains ranges of numeric values for each of the protocol types that can be specified and recorded individually by the @@ -507,7 +504,7 @@ notification when a client disconnects is not specified by this - + Library Extension Requests @@ -522,17 +519,17 @@ or errors. - + Query Extension Version An application uses the -XRecordQueryVersion + function to determine the version of the Record extension protocol supported by an X server. - + Status XRecordQueryVersion Display *display @@ -558,27 +555,27 @@ the version of the Record extension protocol supported by an X server. The -XRecordQueryVersion + function returns the major and minor protocol version numbers supported by the server. -XRecordQueryVersion + returns nonzero (success) only if the returned version numbers are common to both the library and the server; otherwise, it returns zero. - + Create and Modify Context An application uses the -XRecordCreateContext + function to create a record context. At the time the record context is created by the recording client, the clients to be recorded and the protocol to record for each client may be specified. - + XRecordContext XRecordCreateContext Display *display @@ -619,15 +616,14 @@ protocol to record for each client may be specified. The -XRecordCreateContext + function creates a record context and returns an XRecordContext which is then used in the other Record library calls. This request is typically executed by the recording client over its control connection to the X server. The datum_flags specifies whether server time and/or client sequence number should precede protocol elements recorded by context ( - - + ). When a clients element identifies a particular client, the client is added to the context and the protocol to record for that client is set to the union of all ranges. When a clients element is @@ -636,15 +632,14 @@ union of all ranges. When a clients element is or XRecordAllClients the actions described in - - + are performed. -XRecordCreateContext + returns zero if the request failed. -XRecordCreateContext + can generate BadIDChoice BadMatch @@ -675,21 +670,21 @@ structure. The structure is initialized to specify no protocol. The function returns NULL if the structure allocation fails. The application can free the structure by calling -XFree +XFree - + Additions An application uses the -XRecordRegisterClients + function to modify a previously created record context, by adding clients or modifying the recorded protocol, typically over its control connection to the X server. - + Status XRecordRegisterClients Display *display @@ -736,8 +731,7 @@ typically over its control connection to the X server. The datum_flags specifies whether server time and/or client sequence number should precede protocol elements for all clients recorded by context (See - - + ). When a clients element identifies a particular client and the client is not yet targeted for recording in the given context, the client is added to the set of clients to record, and the protocol to record for that client @@ -749,19 +743,18 @@ is set to the union of all ranges. When the element is or XRecordAllClients the actions described in - - + are performed. -XRecordRegisterClients + returns zero if the request failed; otherwise, it returns nonzero. -XRecordRegisterClients + can generate XRecordBadContext BadMatch @@ -771,7 +764,7 @@ errors. - + Deletions @@ -781,7 +774,7 @@ function to delete clients from a previously created record context, typically over its control connection to the X server. - + Status XRecordUnRegisterClients Display *display @@ -857,17 +850,17 @@ errors. - + Query Context State An application uses the -XRecordGetContext + function to query the current state of a record context, typically over its control connection to the X server. - + Status XRecordGetContext Display *display @@ -897,7 +890,7 @@ the function stores a pointer to the current state of the record context. The XRecordState typedef returned by -XRecordGetContext + is a structure with the following members: @@ -945,7 +938,7 @@ structures, which specify the protocol ranges to record. -XRecordGetContext + returns zero if the request failed; otherwise, it returns nonzero. The context argument must specify a valid XRecordContext @@ -956,12 +949,12 @@ error results. Recording clients should use the -XRecordFreeState + function to free the state data returned by -XRecordGetContext + - + void XRecordFreeState XRecordState *state @@ -976,37 +969,37 @@ function to free the state data returned by -XRecordFreeState + frees the data pointed to by state. If the argument does not match an XRecordState pointer returned from a successful call to -XRecordGetContext + or if -XRecordFreeState + has already been called with it, the behavior is undefined. - + Data Transfer An application uses the -XRecordEnableContext + and -XRecordDisableContext + functions to change the state of data transfer between the X server and the recording client. These functions allow the application to start recording and reporting of protocol data and to stop recording and reporting of protocol data, respectively. - + Enable Context To direct the X server to record and report protocol, a program uses -XRecordEnableContext + typically over its data connection to the X server. The reporting of recorded protocol back to the recording client is handled by the following data structures and procedure definitions. @@ -1150,7 +1143,7 @@ in the same reply packet. When a reply is received, a procedure of type is called for each protocol element in the reply. - + typedef void (*XRecordInterceptProc) XPointer closure @@ -1176,13 +1169,13 @@ connection other than the data connection). Recording clients should use the -XRecordFreeData + function to free the XRecordInterceptData structure. - + Status XRecordEnableContext Display *display @@ -1213,7 +1206,7 @@ structure. -XRecordEnableContext + enables data transfer between the recording client and the X server. All core and extension protocol received from or sent to targeted clients that the recording client has expressed @@ -1221,7 +1214,7 @@ interest in will be recorded and reported to the recording client. -XRecordEnableContext + returns zero if the request failed; otherwise, it returns nonzero. The context argument must specify a valid XRecordContext @@ -1233,16 +1226,16 @@ results when data transfer is already enabled on the given context. - + Enable Context Asynchronously Because -XRecordEnableContext + does not return until -XRecordDisableContext + is executed on the control connection, a nonblocking interface in addition to -XRecordEnableContext + is provided. This interface also enables data transfer; however, it does not block. @@ -1251,7 +1244,7 @@ enables data transfer; however, it does not block. This interface is defined as follows: - + Status XRecordEnableContextAsync Display *display @@ -1281,22 +1274,22 @@ This interface is defined as follows: -XRecordEnableContextAsync + enables data transfer between the recording client and the X server just as -XRecordEnableContext + does. Unlike -XRecordEnableContext + it does not wait for the context to be disabled before returning; -XRecordEnableContextAsync + returns as soon as the XRecordStartOfData reply has been received and processed. -XRecordEnableContextAsync + returns zero if it could not allocate the necessary memory and nonzero if it sent the request successfully to the server. The context argument must specify a valid @@ -1313,11 +1306,11 @@ Each time it reads data from the server connection, Xlib will check for incoming replies and call callback as necessary. The application may direct Xlib explicitly to check for Record data with the -XRecordProcessReplies + function. - + void XRecordProcessReplies Display *display @@ -1332,11 +1325,11 @@ function. -XRecordProcessReplies + will check for any replies that have not yet been processed by the application. The asynchronous callback will be called as appropriate. -XRecordProcessReplies + returns when all immediately available replies have been processed. It does not block. @@ -1344,9 +1337,9 @@ available replies have been processed. It does not block. To free the data passed to the XRecordInterceptProc callback, use -XRecordFreeData + - + void XRecordFreeData XRecordInterceptData *data @@ -1362,28 +1355,28 @@ callback, use -XRecordFreeData + frees the data pointed to by data. If the argument does not match an XRecordInterceptData pointer earlier passed to an XRecordInterceptProc callback or if -XRecordFreeData + has already been called with it, the behavior is undefined. - + Disable Context To direct the X server to halt the reporting of recorded protocol, the program executes -XRecordDisableContext + typically over its control connection to the X server. - + Status XRecordDisableContext Display *display @@ -1405,7 +1398,7 @@ typically over its control connection to the X server. The -XRecordDisableContext + function disables context, stopping all recording over its data connection. Any complete protocol elements for context that were buffered in the server will be sent to the recording client rather than being discarded. @@ -1415,7 +1408,7 @@ that has not been enabled, no action will take place. -XRecordDisableContext + returns zero if the request failed; otherwise, it returns nonzero. The context argument must specify a valid XRecordContext @@ -1426,13 +1419,14 @@ error results. -ID Base Mask + +ID Base Mask To determine the mask the server uses for the client ID base, use -XRecordIdBaseMask + - + XID XRecordIdBaseMask Display *display @@ -1448,25 +1442,25 @@ To determine the mask the server uses for the client ID base, use The -XRecordIdBaseMask + function returns the resource ID mask passed to the client by the server at connection setup. - + Free Context Before terminating, the program should request that the server free the record context. This is done with the -XRecordFreeContext + function, typically over the record client's control connection to the X server. - + Status XRecordFreeContext Display *display @@ -1487,21 +1481,21 @@ to the X server. The -XRecordFreeContext + function frees the given context for the requesting client. Freeing a record context releases the clients targeted for recording and their respective protocol ranges to record. If protocol data is being reported to the recording client, generally over the data connection to the X server, the reporting ceases as if -XRecordDisableContext + had been called on the given context. When a program terminates without freeing its record context, the X server will automatically free that context on behalf of the client. -XRecordFreeContext + returns zero if the request failed; otherwise,it returns nonzero. The context argument must specify a valid XRecordContext diff --git a/specs/xtestlib.xml b/specs/xtestlib.xml index ff4877c..463149a 100644 --- a/specs/xtestlib.xml +++ b/specs/xtestlib.xml @@ -66,7 +66,7 @@ in this Software without prior written authorization from the X Consortium. - + Overview @@ -114,7 +114,7 @@ Minimize performance penalties on normal server operation. - + Description The functions provided by this extension fall into two groups: @@ -164,7 +164,7 @@ or pressed a key or button. - + C Language Binding @@ -188,7 +188,7 @@ The include file for this extension is <X11/extensions/XTest.h>. - + Bool XTestQueryExtension Display *display @@ -200,7 +200,7 @@ The include file for this extension is -XTestQueryExtension + returns True if the specified display supports the XTEST extension, else @@ -215,7 +215,7 @@ numbers of the extension supported by the display. Otherwise, none of the arguments are set. - + Bool XTestCompareCursorWithWindow Display *display @@ -225,7 +225,7 @@ the arguments are set. If the extension is supported, -XTestCompareCursorWithWindow + performs a comparison of the cursor whose ID is specified by cursor (which may be None @@ -237,7 +237,7 @@ otherwise. If the extension is not supported, then the request is ignored and zero is returned. - + BoolXTestCompareCurrentCursorWithWindow Display *display @@ -246,7 +246,7 @@ zero is returned. If the extension is supported, -XTestCompareCurrentCursorWithWindow + performs a comparison of the current cursor with the cursor of the specified window returning True @@ -256,7 +256,7 @@ otherwise. If the extension is not supported, then the request is ignored and zero is returned. - + XTestFakeKeyEvent Display *display @@ -267,7 +267,7 @@ zero is returned. If the extension is supported, -XTestFakeKeyEvent + requests the server to simulate either a KeyPress (if is_press is @@ -288,7 +288,7 @@ this client will be processed until this delay, if any, has expired and subsequent processing of the simulated event has been completed. - + XTestFakeButtonEvent Display *display @@ -299,7 +299,7 @@ and subsequent processing of the simulated event has been completed. If the extension is supported, -XTestFakeButtonEvent + requests the server to simulate either a ButtonPress (if is_press is @@ -321,7 +321,7 @@ this client will be processed until this delay, if any, has expired and subsequent processing of the simulated event has been completed. - + XTestFakeMotionEvent Display *display @@ -333,7 +333,7 @@ and subsequent processing of the simulated event has been completed. If the extension is supported, -XTestFakeMotionEvent + requests the server to simulate a movement of the pointer to the specified position (x, y) on the root window of screen_number; otherwise, the request is ignored. If screen_number is -1, the current screen (that the pointer @@ -349,7 +349,7 @@ this client will be processed until this delay, if any, has expired and subsequent processing of the simulated event has been completed. - + XTestFakeRelativeMotionEvent Display *display @@ -362,7 +362,7 @@ and subsequent processing of the simulated event has been completed. If the extension is supported, -XTestFakeRelativeMotionEvent + requests the server to simulate a movement of the pointer by the specified offsets (x, y) relative to the current pointer position on screen_number; otherwise, the request is ignored. If screen_number is -1, the @@ -378,7 +378,7 @@ this client will be processed until this delay, if any, has expired and subsequent processing of the simulated event has been completed. - + XTestGrabControl Display *display @@ -394,7 +394,7 @@ then the executing client returns to the normal state of being susceptible to server grabs. - + Bool XTestSetGContextOfGC GC gc @@ -403,12 +403,12 @@ to server grabs. -XTestSetGContextOfGC + sets the GContext within the opaque datatype referenced by gc to be that specified by gid. - + XTestSetVisualIDOfVisual Visual *visual @@ -417,12 +417,12 @@ be that specified by gid. -XTestSetVisualIDOfVisual + sets the VisualID within the opaque datatype referenced by visual to be that specified by visualid. - + Bool XTestDiscard Display *display @@ -430,7 +430,7 @@ be that specified by visualid. -XTestDiscard + discards any requests within the output buffer for the specified display. It returns True @@ -439,7 +439,7 @@ if any requests were discarded; otherwise, it returns - + References -- cgit v1.2.1