From 618cea608d726c0aeb48960da7bedc2dd8b36bba Mon Sep 17 00:00:00 2001 From: Matt Dew Date: Fri, 30 Sep 2011 22:28:10 -0600 Subject: #1 - fix the capitalization of the ID attriutes 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/appgrp.xml | 42 ++++++++++++++--------------- specs/dbe.xml | 40 ++++++++++++++-------------- specs/dpms.xml | 32 +++++++++++------------ specs/evi.xml | 6 ++--- specs/multibuf.xml | 38 +++++++++++++-------------- specs/security.xml | 77 +++++++++++++++++++++++++++--------------------------- specs/shm.xml | 14 +++++----- specs/sync.xml | 23 ++++++++-------- specs/tog-cup.xml | 8 +++--- specs/xtest.xml | 10 +++---- 10 files changed, 144 insertions(+), 146 deletions(-) diff --git a/specs/appgrp.xml b/specs/appgrp.xml index dfeee9e..cf2c2d0 100644 --- a/specs/appgrp.xml +++ b/specs/appgrp.xml @@ -60,7 +60,7 @@ example, OpenDoc does, such as shared menu bars, etc. </abstract> </articleinfo> -<sect1 id='purpose_and_goals'> +<sect1 id='Purpose_and_Goals'> <title>Purpose and Goals @@ -83,7 +83,7 @@ Computer, Inc. WinCenter is a trademark of Network Computing Devices, Inc. - + Overview of the protocol. @@ -99,7 +99,7 @@ As a member of an Application Group, when an application creates and maps a wind - + Requests @@ -343,10 +343,10 @@ This request destroys the association created with AppGroupCreateAssociation. Th - + Changes to Existing Requests - + MapWindow @@ -354,7 +354,7 @@ If the override-redirect attribute of the window is False and if the window is a - + ConfigureWindow @@ -362,7 +362,7 @@ If the override-redirect attribute of the window is False and if the window is a - + CreateWindow @@ -375,7 +375,7 @@ When a program in an Application Group creates a window that is a child of a roo - + ChangeWindowAttributes @@ -386,7 +386,7 @@ When a program in an Application Group changes the attributes of a window that i - + Changes to Existing Events @@ -398,7 +398,7 @@ The Application Group Leader must not select SubstructuRedirect events on a root - + MapRequest @@ -406,7 +406,7 @@ When a MapWindow request is received for a window whose override-redirect attrib - + ConfigureRequest @@ -416,10 +416,10 @@ When a ConfigureWindow request is received for a window whose override-redirect - + Errors - + AppGroupQueryVersion @@ -428,7 +428,7 @@ There are no errors for AppGroupQueryVersion. - + AppGroupCreate @@ -453,7 +453,7 @@ A Match error is returned if root_visual does not exist for the screen of the de - + AppGroupDestroy @@ -466,7 +466,7 @@ An Access error is returned if an untrusted application attempts to destroy an A - + AppGroupGetAttr @@ -479,7 +479,7 @@ An Access error is returned if an untrusted application attempts to get the attr - + AppGroupQuery @@ -488,7 +488,7 @@ An Access error is returned if an untrusted application attempts to query the Ap - + AppGroupCreateAssociation @@ -505,7 +505,7 @@ A Window error may be returned for system-specific errors related to system_wind - + AppGroupDestroyAssociation @@ -515,7 +515,7 @@ A Window error is returned if window was not specified in a previous AppGroupCre - + Encoding @@ -643,7 +643,7 @@ VALUEs - + Library API diff --git a/specs/dbe.xml b/specs/dbe.xml index 8c87548..d0319d3 100644 --- a/specs/dbe.xml +++ b/specs/dbe.xml @@ -48,7 +48,7 @@ without express or implied warranty. - + Introduction The Double Buffer Extension (DBE) provides a standard way to utilize double-buffering within the framework of the X Window System. Double-buffering @@ -64,7 +64,7 @@ The result is a flicker-free animation. - + Goals This extension should enable clients to: @@ -125,7 +125,7 @@ access (DGHA) architectures. - + Concepts @@ -281,7 +281,7 @@ frame rate) should investigate the Synchronization Extension, an X Consortium standard. - + Window Management Operations @@ -333,7 +333,7 @@ It is tiled with the window background in both buffers, and - + Complex Swap Actions DBE has no explicit knowledge of ancillary buffers (for example, depth @@ -435,11 +435,11 @@ ensure best possible performance across a wide variety of implementations. - + Requests The DBE defines the following requests. - + DBEGetVersion This request returns the major and minor version numbers of this extension. @@ -498,7 +498,7 @@ otherwise, the client will get undefined behavior (DBE may or may not work). - + DBEGetVisualInfo This request returns information about which visuals support double buffering. @@ -577,7 +577,7 @@ returned, starting with screen zero. - + DBEAllocateBackBufferName @@ -645,7 +645,7 @@ back-buffer-name is freed. - + DBEDeallocateBackBufferName This request frees a drawable ID that was obtained by @@ -683,7 +683,7 @@ a Buffer error results). - + DBESwapBuffers This request swaps the buffers for all windows listed, applying the @@ -782,7 +782,7 @@ type of idiom, it must immediately follow the - + DBEBeginIdiom This request informs the server that a complex swap will immediately follow @@ -800,7 +800,7 @@ free to implement this request as a no-op. - + DBEEndIdiom @@ -818,7 +818,7 @@ request as a no-op. - + DBEGetBackBufferAttributes This request returns information about a back buffer. @@ -860,7 +860,7 @@ the window field of the attributes in the reply will be None. - + Encoding Please refer to the X11 Protocol Encoding document as this section uses @@ -869,7 +869,7 @@ syntactic conventions and data types established there. The name of this extension is "DOUBLE-BUFFER". - + Type The following new types are used by the extension. @@ -906,7 +906,7 @@ BUFFER_ATTRIBUTES - + Error Buffer @@ -920,7 +920,7 @@ BUFFER_ATTRIBUTES - + Request @@ -1018,7 +1018,7 @@ DBEGetVersion - + Acknowledgements We wish to thank the following individuals who have contributed their time @@ -1042,7 +1042,7 @@ draft of the specification. David served as architect. - + References Jeffrey Friedberg, Larry Seiler, and Jeff Vroom, "Multi-buffering Extension diff --git a/specs/dpms.xml b/specs/dpms.xml index fe97da9..617744c 100644 --- a/specs/dpms.xml +++ b/specs/dpms.xml @@ -123,7 +123,7 @@ it may be decided to make DPMS less aggressive, or disable it completely. Requests -DPMSGetVersion +DPMSGetVersion @@ -178,7 +178,7 @@ of one (1). -DPMSCapable +DPMSCapable @@ -206,7 +206,7 @@ case of heterogeneous multi-head servers is implementation defined. -DPMSGetTimeouts +DPMSGetTimeouts @@ -275,7 +275,7 @@ value of zero indicates that this mode is disabled. -DPMSSetTimeouts +DPMSSetTimeouts @@ -339,7 +339,7 @@ to the value of the previous (non-zero) level. A BadValue error is generated if an illegal combination is detected. -DPMSEnable +DPMSEnable => @@ -352,7 +352,7 @@ effected. -DPMSDisable +DPMSDisable => @@ -366,7 +366,7 @@ may be disabled without damaging the server's stored timeout values. -DPMSForceLevel +DPMSForceLevel @@ -395,7 +395,7 @@ DPMSModeSuspend or DPMSModeOff. -DPMSInfo +DPMSInfo @@ -450,7 +450,7 @@ The name of this extension is "DPMS". -DPMSGetVersion +DPMSGetVersion 1 CARD8 opcode 1 0 DPMS opcode 2 2 request length @@ -467,7 +467,7 @@ The name of this extension is "DPMS". -DPMSCapable +DPMSCapable 1 CARD8 opcode 1 1 DPMS opcode 2 1 request length @@ -481,7 +481,7 @@ The name of this extension is "DPMS". -DPMSGetTimeouts +DPMSGetTimeouts 1 CARD8 opcode 1 2 DPMS opcode 2 1 request length @@ -497,7 +497,7 @@ The name of this extension is "DPMS". -DPMSSetTimeouts +DPMSSetTimeouts 1 CARD8 opcode 1 3 DPMS opcode 2 3 request length @@ -509,7 +509,7 @@ The name of this extension is "DPMS". -DPMSEnable +DPMSEnable 1 CARD8 opcode 1 4 DPMS opcode 2 1 request length @@ -517,7 +517,7 @@ The name of this extension is "DPMS". -DPMSDisable +DPMSDisable 1 CARD8 opcode 1 5 DPMS opcode 2 1 request length @@ -525,7 +525,7 @@ The name of this extension is "DPMS". -DPMSForceLevel +DPMSForceLevel 1 CARD8 opcode 1 6 DPMS opcode 2 2 request length @@ -539,7 +539,7 @@ The name of this extension is "DPMS". -DPMSInfo +DPMSInfo 1 CARD8 opcode 1 7 DPMS opcode 2 1 request length diff --git a/specs/evi.xml b/specs/evi.xml index 8489b37..e5cfac4 100644 --- a/specs/evi.xml +++ b/specs/evi.xml @@ -292,7 +292,7 @@ No new events or errors are defined by this extension. - + Changes to existing protocol. None. @@ -375,7 +375,7 @@ The include file for this extension is: < X11/extensions/XEVI.h>. - + Bool XeviQueryVersion Display *display @@ -434,7 +434,7 @@ To get the extended information for any subset of visuals use XeviGetVisualInfo. - + int XeviGetVisualInfo Display *display diff --git a/specs/multibuf.xml b/specs/multibuf.xml index 39a5dbf..9e2b065 100644 --- a/specs/multibuf.xml +++ b/specs/multibuf.xml @@ -80,7 +80,7 @@ Extension (DBE). DBE is an X Consortium Standard as of Release 6.1. - + Introduction @@ -123,7 +123,7 @@ multi-buffering, and stereo in a way that is acceptable to all concerned. - + Goals @@ -179,7 +179,7 @@ existing hardware features. - + Image Buffers @@ -319,7 +319,7 @@ maintained for an image buffer, then no exposure events are generated. - + New Requests @@ -674,7 +674,7 @@ the request is ignored. - + Attributes @@ -863,7 +863,7 @@ major version will be 1, and the minor version will be 1. - + Events @@ -961,7 +961,7 @@ request), an UpdateNotify event is generated. - + Errors @@ -969,14 +969,14 @@ The following error type has been added to support this extension: - + Buffer A value for a BUFFER argument does not name a defined BUFFER. - + Double-Buffering Normal Windows @@ -1026,7 +1026,7 @@ DestroyImageBuffers( W ) - + Multi-Buffering Normal Windows @@ -1073,7 +1073,7 @@ while animating - + Stereo Windows How stereo windows are supported on a server @@ -1178,7 +1178,7 @@ right eyes for normal windows should be the same - + Single-Buffered Stereo Windows @@ -1198,7 +1198,7 @@ MapWindow( W ) - + Double-Buffering Stereo Windows @@ -1270,7 +1270,7 @@ while animating - + Multi-Buffering Stereo Windows @@ -1313,7 +1313,7 @@ while animating - + Protocol Encoding @@ -1360,7 +1360,7 @@ encoding for this extension. - + TYPES @@ -1382,7 +1382,7 @@ SETofBUFFER_EVENT - + EVENTS @@ -1408,7 +1408,7 @@ SETofBUFFER_EVENT - + ERRORS @@ -1424,7 +1424,7 @@ SETofBUFFER_EVENT - + REQUESTS diff --git a/specs/security.xml b/specs/security.xml index 228d350..b920618 100644 --- a/specs/security.xml +++ b/specs/security.xml @@ -56,7 +56,7 @@ in this Software without prior written authorization from the X Consortium. - + Introduction @@ -67,10 +67,10 @@ clients (defined below). - + Requests - + SecurityQueryVersion This request returns the major and minor version numbers of this extension. @@ -150,7 +150,7 @@ protocol version; otherwise, the client will get undefined behavior - + SecurityGenerateAuthorization @@ -460,7 +460,7 @@ authorization-data-return this way. - + SecurityRevokeAuthorization @@ -506,14 +506,14 @@ with this authorization will fail. - + Changes to Core Requests A server supporting this extension modifies the handling of some core requests in the following ways. - + Resource ID Usage @@ -603,7 +603,7 @@ ISSUE: are root window exceptions needed for these? WarpPointer, ReparentWindow - + Extension Security @@ -638,7 +638,7 @@ opcode will fail with a Request error. - + Keyboard Security @@ -705,7 +705,7 @@ expected. This is in line with the root window exceptions above. - + Image Security @@ -745,8 +745,7 @@ to be an unusual configuration. - - + Property Security @@ -840,7 +839,7 @@ field in the reply is zero). - + Miscellaneous Security @@ -859,7 +858,7 @@ a SelectionNotify event to the requestor with property None. - + New Authorization Method @@ -998,7 +997,7 @@ policy-type Permit. - + Encoding @@ -1010,14 +1009,14 @@ uses syntactic conventions and data types established there. The name of this extension is "SECURITY". - + Types AUTHID: CARD32 - + Request Encoding @@ -1097,7 +1096,7 @@ r unused, r=pad(q) - + Event Encoding SecurityAuthorizationRevoked @@ -1113,7 +1112,7 @@ r unused, r=pad(q) - + Authorization Method Encoding @@ -1151,7 +1150,7 @@ termination between STRs. - + C Language Binding @@ -1164,7 +1163,7 @@ All functions that have return type Status will return nonzero for success and zero for failure. - + Status XSecurityQueryExtension Display *dpy @@ -1174,7 +1173,7 @@ success and zero for failure. -XSecurityQueryExtension sets major_version_return and + sets major_version_return and minor_version_return to the major and minor Security protocol version supported by the server. If the Security library is compatible with the version returned by the server, it returns nonzero. If dpy does not support @@ -1185,7 +1184,7 @@ function. If a client violates this rule, the effects of all subsequent XSecurity calls that it makes are undefined. - + Xauth *XSecurityAllocXauth void @@ -1198,9 +1197,9 @@ allocate and deallocate them. -XSecurityAllocXauth must be used to allocate the + must be used to allocate the Xauth structure that is passed to -XSecurityGenerateAuthorization. +. @@ -1289,7 +1288,7 @@ The Xauth structure returned by this function is initialized as follows: name_length and data_length are zero, and name and data are NULL. - + void XSecurityFreeXauth Xauth *auth @@ -1297,20 +1296,20 @@ name_length and data_length are zero, and name and data are NULL. -XSecurityFreeXauth must be used to free Xauth + must be used to free Xauth structures allocated by -XSecurityAllocXauth or returned by -XSecurityGenerateAuthorization. It is the + or returned by +. It is the caller's responsibility to fill in the name and data fields of Xauth structures -allocated with XSecurityAllocXauth, so this function +allocated with , so this function will not attempt to free them. In contrast, all storage associated with Xauth structures returned from -XSecurityGenerateAuthorization will be freed by this + will be freed by this function, including the name and data fields. - + Bool XSecurityRevokeAuthorization Display *dpy @@ -1319,15 +1318,15 @@ function, including the name and data fields. -XSecurityRevokeAuthorization deletes the authorization + deletes the authorization specified by auth_id, which must be a value returned in the auth_id_return -parameter of XSecurityGenerateAuthorization. All +parameter of . All clients that connected with that authorization are be killed. Subsequently, clients that attempt to connect using that authorization will be refused. - + Xauth *XSecurityGenerateAuthorization Display *dpy @@ -1339,16 +1338,16 @@ clients that attempt to connect using that authorization will be refused. -XSecurityGenerateAuthorization creates a new + creates a new authorization with the specified attributes. The auth_in argument must be -allocated by XSecurityAllocXauth. The +allocated by . The name and name_length fields of auth_in should be initialized to the authorization protocol name and its length in characters respectively. If there is authorization data, the data and data_length fields of auth_in should be initialized to the data and its length in characters respectivley. The library does not assume that name and data are null-terminated strings. The auth_in argument must be freed with -XSecurityFreeXauth. +. @@ -1453,7 +1452,7 @@ the authorization data returned by the server. The caller should not assume that name and data are null-terminated strings. If no authorization data was returned by the server, the data and data_length fields will be set to NULL and zero repectively. The returned Xauth structure must be freed with -XSecurityFreeXauth; the caller should not use any other +; the caller should not use any other means free the structure or any of its components. The auth_id_return argument will be filled in with the non-zero authorization id of the created authorization. diff --git a/specs/shm.xml b/specs/shm.xml index 027aa54..f6ad347 100644 --- a/specs/shm.xml +++ b/specs/shm.xml @@ -138,7 +138,7 @@ the net, or in some other environment where the extension will not work. To perform this check, call either - + Status XShmQueryExtension Display *display @@ -149,7 +149,7 @@ To perform this check, call either or - + Status XShmQueryVersion Display *display @@ -203,7 +203,7 @@ Use the shared memory XImage, much like a normal one. To create a shared memory XImage, use: - + XImage *XShmCreateImage Display *display @@ -318,7 +318,7 @@ ready for use. To write a shared memory XImage into an X drawable, use XShmPutImage: - + Status XShmPutImage Display *display @@ -381,7 +381,7 @@ completion event, the results you see on the screen may be inconsistent. To read image data into a shared memory XImage, use the following: - + Status XShmGetImage Display *display @@ -424,7 +424,7 @@ format is) and independent of the screen. Use XShmPixmapFormat to get the format for the server: - + int XShmPixmapFormat Display *display @@ -444,7 +444,7 @@ bytes_per_line value to use. Once you have your shminfo structure filled in, simply call: - + Pixmap XShmCreatePixmap Display *display diff --git a/specs/sync.xml b/specs/sync.xml index 895c7d4..6df45a6 100644 --- a/specs/sync.xml +++ b/specs/sync.xml @@ -98,7 +98,7 @@ Consortium. - + Synchronization Protocol The core X protocol makes no guarantees about the relative order of execution @@ -131,7 +131,7 @@ animation applications to be implemented without any round-trip requests and makes best use of buffering within the client, network, and server. - + Description The mechanism used by this extension for synchronization within the X @@ -200,7 +200,7 @@ merely establishes an upper bound for the scope of fence operations. - + Types Please refer to the X11 Protocol specification as this document uses @@ -325,7 +325,7 @@ state. Otherwise, the fence is in the not triggered state. - + Errors @@ -359,8 +359,7 @@ does not name a defined FENCE. - - + Requests @@ -904,7 +903,7 @@ is generated if any member of fence-list does not name a valid fence. - + Events @@ -962,7 +961,7 @@ is destroyed, or the counter for the alarm is destroyed. - + Encoding Please refer to the X11 Protocol Encoding document as this section uses @@ -970,7 +969,7 @@ syntactic conventions established there and references types defined there. The name of this extension is "SYNC". - + Encoding New Types The following new types are used by the extension. @@ -1015,7 +1014,7 @@ groups, the byte ordering determined during connection setup is used. - + Encoding Errors Counter @@ -1046,7 +1045,7 @@ groups, the byte ordering determined during connection setup is used. - + Encoding Requests @@ -1246,7 +1245,7 @@ AwaitFence - + Encoding Events diff --git a/specs/tog-cup.xml b/specs/tog-cup.xml index a06d7cc..c8597a6 100644 --- a/specs/tog-cup.xml +++ b/specs/tog-cup.xml @@ -254,7 +254,7 @@ No new events or errors are defined by this extension. - + Changes to existing protocol. None. @@ -355,7 +355,7 @@ The include file for this extension is <X11/extensions/Xcup.h>. - + Status XCupQueryVersion Display* display @@ -415,7 +415,7 @@ To get the list of reserved colormap entries, use XCupGetReservedColormapEntries. - + Status XCupGetReservedColormapEntries Display* display @@ -469,7 +469,7 @@ To allocate one or more read-only color cells with RGB values, use XCupStoreColors. - + Status XCupStoreColors Display* display diff --git a/specs/xtest.xml b/specs/xtest.xml index e20f06a..121a8d5 100644 --- a/specs/xtest.xml +++ b/specs/xtest.xml @@ -241,7 +241,7 @@ not required, respectively. -XTestSetGContextOfGC +XTestSetGContextOfGC @@ -268,7 +268,7 @@ the value specified by gid. -XTestSetVisualIDOfVisual +XTestSetVisualIDOfVisual @@ -295,7 +295,7 @@ the value specified by visualid. -XTestDiscard +XTestDiscard @@ -581,7 +581,7 @@ error occurs. -XTestGrabControl +XTestGrabControl @@ -694,7 +694,7 @@ the corresponding core protocol event types. -XTestGrabControl +XTestGrabControl 1 CARD8 opcode 1 3 xtest opcode 2 2 request length -- cgit v1.2.3