diff options
| author | Walter Harms <wharms@bfs.de> | 2019-07-03 18:18:09 +0200 |
|---|---|---|
| committer | Walter Harms <wharms@bfs.de> | 2019-07-03 18:18:09 +0200 |
| commit | 4eb167f5aca4cca05a230c728ffdb4fd382a4e1e (patch) | |
| tree | 43d92fdddfc3921c4362106156caa566d725b9f0 | |
| parent | 08e6b36292ebf01ba2dcc4a48ec371c6f5d13458 (diff) | |
replace home grown .ZN with std, .B and .BR
Replace the home grown macro .ZN with std. macros
from man macro paket. So we can get rid of the
definition an get a clean header.
Signed-off-by: Walter Harms <wharms@bfs.de>
182 files changed, 3834 insertions, 3834 deletions
diff --git a/man/AllPlanes.man b/man/AllPlanes.man index 99c70015..859c3316 100644 --- a/man/AllPlanes.man +++ b/man/AllPlanes.man @@ -148,82 +148,82 @@ Specifies the appropriate screen number on the host server. Returns the number of depths. .SH DESCRIPTION The -.ZN AllPlanes +.B AllPlanes macro returns a value with all bits set to 1 suitable for use in a plane argument to a procedure. .LP The -.ZN BlackPixel +.B BlackPixel macro returns the black pixel value for the specified screen. .LP The -.ZN WhitePixel +.B WhitePixel macro returns the white pixel value for the specified screen. .LP The -.ZN ConnectionNumber +.B ConnectionNumber macro returns a connection number for the specified display. .LP The -.ZN DefaultColormap +.B DefaultColormap macro returns the default colormap ID for allocation on the specified screen. .LP The -.ZN DefaultDepth +.B DefaultDepth macro returns the depth (number of planes) of the default root window for the specified screen. .LP The -.ZN XListDepths +.B XListDepths function returns the array of depths that are available on the specified screen. If the specified screen_number is valid and sufficient memory for the array can be allocated, -.ZN XListDepths +.B XListDepths sets count_return to the number of available depths. Otherwise, it does not set count_return and returns NULL. To release the memory allocated for the array of depths, use -.ZN XFree . +.BR XFree . .LP The -.ZN DefaultGC +.B DefaultGC macro returns the default GC for the root window of the specified screen. .LP The -.ZN DefaultRootWindow +.B DefaultRootWindow macro returns the root window for the default screen. .LP The -.ZN DefaultScreenOfDisplay +.B DefaultScreenOfDisplay macro returns the default screen of the specified display. .LP The -.ZN DefaultScreen +.B DefaultScreen macro returns the default screen number referenced in the -.ZN XOpenDisplay +.B XOpenDisplay routine. .LP The -.ZN DefaultVisual +.B DefaultVisual macro returns the default visual type for the specified screen. .LP The -.ZN DisplayCells +.B DisplayCells macro returns the number of entries in the default colormap. .LP The -.ZN DisplayPlanes +.B DisplayPlanes macro returns the depth of the root window of the specified screen. .LP The -.ZN DisplayString +.B DisplayString macro returns the string that was passed to -.ZN XOpenDisplay +.B XOpenDisplay when the current display was opened. .LP The -.ZN XMaxRequestSize +.B XMaxRequestSize function returns the maximum request size (in 4-byte units) supported by the server without using an extended-length protocol encoding. Single protocol requests to the server can be no larger than this size @@ -232,81 +232,81 @@ The protocol guarantees the size to be no smaller than 4096 units (16384 bytes). Xlib automatically breaks data up into multiple protocol requests as necessary for the following functions: -.ZN XDrawPoints , -.ZN XDrawRectangles , -.ZN XDrawSegments , -.ZN XFillArcs , -.ZN XFillRectangles , +.BR XDrawPoints , +.BR XDrawRectangles , +.BR XDrawSegments , +.BR XFillArcs , +.BR XFillRectangles , and -.ZN XPutImage . +.BR XPutImage . .LP The -.ZN XExtendedMaxRequestSize +.B XExtendedMaxRequestSize function returns zero if the specified display does not support an extended-length protocol encoding; otherwise, it returns the maximum request size (in 4-byte units) supported by the server using the extended-length encoding. The Xlib functions -.ZN XDrawLines , -.ZN XDrawArcs , -.ZN XFillPolygon , -.ZN XChangeProperty , -.ZN XSetClipRectangles , +.BR XDrawLines , +.BR XDrawArcs , +.BR XFillPolygon , +.BR XChangeProperty , +.BR XSetClipRectangles , and -.ZN XSetRegion +.B XSetRegion will use the extended-length encoding as necessary, if supported by the server. Use of the extended-length encoding in other Xlib functions (for example, -.ZN XDrawPoints , -.ZN XDrawRectangles , -.ZN XDrawSegments , -.ZN XFillArcs , -.ZN XFillRectangles , -.ZN XPutImage ) +.BR XDrawPoints , +.BR XDrawRectangles , +.BR XDrawSegments , +.BR XFillArcs , +.BR XFillRectangles , +.BR XPutImage ) is permitted but not required; an Xlib implementation may choose to split the data across multiple smaller requests instead. .LP The -.ZN LastKnownRequestProcessed +.B LastKnownRequestProcessed macro extracts the full serial number of the last request known by Xlib to have been processed by the X server. .LP The -.ZN NextRequest +.B NextRequest macro extracts the full serial number that is to be used for the next request. .LP The -.ZN ProtocolVersion +.B ProtocolVersion macro returns the major version number (11) of the X protocol associated with the connected display. .LP The -.ZN ProtocolRevision +.B ProtocolRevision macro returns the minor protocol revision number of the X server. .LP The -.ZN QLength +.B QLength macro returns the length of the event queue for the connected display. .LP The -.ZN RootWindow +.B RootWindow macro returns the root window. .LP The -.ZN ScreenCount +.B ScreenCount macro returns the number of available screens. .LP The -.ZN ScreenOfDisplay +.B ScreenOfDisplay macro returns a pointer to the screen of the specified display. .LP The -.ZN ServerVendor +.B ServerVendor macro returns a pointer to a null-terminated string that provides some identification of the owner of the X server implementation. .LP The -.ZN VendorRelease +.B VendorRelease macro returns a number related to a vendor's release of the X server. .SH "SEE ALSO" BlackPixelOfScreen(__libmansuffix__), diff --git a/man/BlackPixelOfScreen.man b/man/BlackPixelOfScreen.man index 535b4ad4..66d0cdb2 100644 --- a/man/BlackPixelOfScreen.man +++ b/man/BlackPixelOfScreen.man @@ -151,98 +151,98 @@ int WidthMMOfScreen\^(\^Screen *\fIscreen\fP\^); .SH ARGUMENTS .IP \fIscreen\fP 1i Specifies the appropriate -.ZN Screen +.B Screen structure. .SH DESCRIPTION The -.ZN BlackPixelOfScreen +.B BlackPixelOfScreen macro returns the black pixel value of the specified screen. .LP The -.ZN WhitePixelOfScreen +.B WhitePixelOfScreen macro returns the white pixel value of the specified screen. .LP The -.ZN CellsOfScreen +.B CellsOfScreen macro returns the number of colormap cells in the default colormap of the specified screen. .LP The -.ZN DefaultColormapOfScreen +.B DefaultColormapOfScreen macro returns the default colormap of the specified screen. .LP The -.ZN DefaultDepthOfScreen +.B DefaultDepthOfScreen macro returns the default depth of the root window of the specified screen. .LP The -.ZN DefaultGCOfScreen +.B DefaultGCOfScreen macro returns the default GC of the specified screen, which has the same depth as the root window of the screen. .LP The -.ZN DefaultVisualOfScreen +.B DefaultVisualOfScreen macro returns the default visual of the specified screen. .LP The -.ZN DoesBackingStore +.B DoesBackingStore macro returns -.ZN WhenMapped , -.ZN NotUseful , +.BR WhenMapped , +.BR NotUseful , or -.ZN Always , +.BR Always , which indicate whether the screen supports backing stores. .LP The -.ZN DoesSaveUnders +.B DoesSaveUnders macro returns a Boolean value indicating whether the screen supports save unders. .LP The -.ZN DisplayOfScreen +.B DisplayOfScreen macro returns the display of the specified screen. .LP The -.ZN XScreenNumberOfScreen +.B XScreenNumberOfScreen function returns the screen index number of the specified screen. .LP The -.ZN EventMaskOfScreen +.B EventMaskOfScreen macro returns the root event mask of the root window for the specified screen at connection setup. .LP The -.ZN HeightOfScreen +.B HeightOfScreen macro returns the height of the specified screen. .LP The -.ZN HeightMMOfScreen +.B HeightMMOfScreen macro returns the height of the specified screen in millimeters. .LP The -.ZN MaxCmapsOfScreen +.B MaxCmapsOfScreen macro returns the maximum number of installed colormaps supported by the specified screen. .LP The -.ZN MinCmapsOfScreen +.B MinCmapsOfScreen macro returns the minimum number of installed colormaps supported by the specified screen. .LP The -.ZN PlanesOfScreen +.B PlanesOfScreen macro returns the number of planes in the root window of the specified screen. .LP The -.ZN RootWindowOfScreen +.B RootWindowOfScreen macro returns the root window of the specified screen. .LP The -.ZN WidthOfScreen +.B WidthOfScreen macro returns the width of the specified screen. .LP The -.ZN WidthMMOfScreen +.B WidthMMOfScreen macro returns the width of the specified screen in millimeters. .SH "SEE ALSO" AllPlanes(__libmansuffix__), diff --git a/man/DisplayOfCCC.man b/man/DisplayOfCCC.man index 85bd6720..6ad2b705 100644 --- a/man/DisplayOfCCC.man +++ b/man/DisplayOfCCC.man @@ -123,24 +123,24 @@ XcmsColor *ClientWhitePointOfCCC\^(\^XcmsCCC \fIccc\fP\^); Specifies the CCC. .SH DESCRIPTION The -.ZN DisplayOfCCC +.B DisplayOfCCC macro returns the display associated with the specified CCC. .LP The -.ZN VisualOfCCC +.B VisualOfCCC macro returns the visual associated with the specified CCC. .LP The -.ZN ScreenNumberOfCCC +.B ScreenNumberOfCCC macro returns the number of the screen associated with the specified CCC. .LP The -.ZN ScreenWhitePointOfCCC +.B ScreenWhitePointOfCCC macro returns the screen white point of the screen associated with the specified CCC. .LP The -.ZN ClientWhitePointOfCCC +.B ClientWhitePointOfCCC macro returns the client white point of the screen associated with the specified CCC. .SH "SEE ALSO" diff --git a/man/ImageByteOrder.man b/man/ImageByteOrder.man index af3677c2..1a28c89d 100644 --- a/man/ImageByteOrder.man +++ b/man/ImageByteOrder.man @@ -109,59 +109,59 @@ Returns the number of pixmap formats that are supported by the display. Specifies the appropriate screen number on the host server. .SH DESCRIPTION The -.ZN XListPixmapFormats +.B XListPixmapFormats function returns an array of -.ZN XPixmapFormatValues +.B XPixmapFormatValues structures that describe the types of Z format images supported by the specified display. If insufficient memory is available, -.ZN XListPixmapFormats +.B XListPixmapFormats returns NULL. To free the allocated storage for the -.ZN XPixmapFormatValues +.B XPixmapFormatValues structures, use -.ZN XFree . +.BR XFree . .LP The -.ZN ImageByteOrder +.B ImageByteOrder macro specifies the required byte order for images for each scanline unit in XY format (bitmap) or for each pixel value in Z format. .LP The -.ZN BitmapBitOrder +.B BitmapBitOrder macro returns -.ZN LSBFirst +.B LSBFirst or -.ZN MSBFirst +.B MSBFirst to indicate whether the leftmost bit in the bitmap as displayed on the screen is the least or most significant bit in the unit. .LP The -.ZN BitmapPad +.B BitmapPad macro returns the number of bits that each scanline must be padded. .LP The -.ZN BitmapUnit +.B BitmapUnit macro returns the size of a bitmap's scanline unit in bits. .LP The -.ZN DisplayHeight +.B DisplayHeight macro returns the height of the specified screen in pixels. .LP The -.ZN DisplayHeightMM +.B DisplayHeightMM macro returns the height of the specified screen in millimeters. .LP The -.ZN DisplayWidth +.B DisplayWidth macro returns the width of the screen in pixels. .LP The -.ZN DisplayWidthMM +.B DisplayWidthMM macro returns the width of the specified screen in millimeters. .SH STRUCTURES The -.ZN XPixmapFormatValues +.B XPixmapFormatValues structure provides an interface to the pixmap format information that is returned at the time of a connection setup. It contains: diff --git a/man/IsCursorKey.man b/man/IsCursorKey.man index ed4f52b3..422e6773 100644 --- a/man/IsCursorKey.man +++ b/man/IsCursorKey.man @@ -100,45 +100,45 @@ int IsPrivateKeypadKey\^(\^KeySym \fIkeysym\fP\^); Specifies the KeySym that is to be tested. .SH DESCRIPTION The -.ZN IsCursorKey +.B IsCursorKey macro returns -.ZN True +.B True if the specified KeySym is a cursor key. .LP The -.ZN IsFunctionKey +.B IsFunctionKey macro returns -.ZN True +.B True if the KeySym is a function key. .LP The -.ZN IsKeypadKey +.B IsKeypadKey macro returns -.ZN True +.B True if the specified KeySym is a keypad key. .LP The -.ZN IsMiscFunctionKey +.B IsMiscFunctionKey macro returns -.ZN True +.B True if the specified KeySym is a miscellaneous function key. .LP The -.ZN IsModifierKey +.B IsModifierKey macro returns -.ZN True +.B True if the specified KeySym is a modifier key. .LP The -.ZN IsPFKey +.B IsPFKey macro returns -.ZN True +.B True if the specified KeySym is a PF key. .LP The -.ZN IsPrivateKeypadKey +.B IsPrivateKeypadKey macro returns -.ZN True +.B True if the specified KeySym is a vendor-private keypad key. .SH "SEE ALSO" XkbKeyTypesForCoreSymbols(__libmansuffix__), diff --git a/man/XAddConnectionWatch.man b/man/XAddConnectionWatch.man index 48b79bea..8013c301 100644 --- a/man/XAddConnectionWatch.man +++ b/man/XAddConnectionWatch.man @@ -112,25 +112,25 @@ Returns the file descriptors. Specifies the procedure to be called. .SH DESCRIPTION The -.ZN XAddConnectionWatch +.B XAddConnectionWatch function registers a procedure to be called each time Xlib opens or closes an internal connection for the specified display. The procedure is passed the display, the specified client_data, the file descriptor for the connection, a Boolean indicating whether the connection is being opened or closed, and a pointer to a location for private watch data. If opening is -.ZN True , +.BR True , the procedure can store a pointer to private data in the location pointed to by watch_data; when the procedure is later called for this same connection and opening is -.ZN False , +.BR False , the location pointed to by watch_data will hold this same private data pointer. .LP This function can be called at any time after a display is opened. If internal connections already exist, the registered procedure will immediately be called for each of them, before -.ZN XAddConnectionWatch +.B XAddConnectionWatch returns. -.ZN XAddConnectionWatch +.B XAddConnectionWatch returns a nonzero status if the procedure is successfully registered; otherwise, it returns zero. .LP @@ -141,33 +141,33 @@ If Xlib has been initialized for threads, the procedure is called with the display locked and the result of a call by the procedure to any Xlib function that locks the display is not defined unless the executing thread has externally locked the display using -.ZN XLockDisplay . +.BR XLockDisplay . .LP The -.ZN XRemoveConnectionWatch +.B XRemoveConnectionWatch function removes a previously registered connection watch procedure. The client_data must match the client_data used when the procedure was initially registered. .LP The -.ZN XProcessInternalConnection +.B XProcessInternalConnection function processes input available on an internal connection. This function should be called for an internal connection only after an operating system facility (for example, -.ZN select +.B select or -.ZN poll ) +.BR poll ) has indicated that input is available; otherwise, the effect is not defined. .LP The -.ZN XInternalConnectionNumbers +.B XInternalConnectionNumbers function returns a list of the file descriptors for all internal connections currently open for the specified display. When the allocated list is no longer needed, free it by using -.ZN XFree . +.BR XFree . This functions returns a nonzero status if the list is successfully allocated; otherwise, it returns zero. .SH "SEE ALSO" diff --git a/man/XAddHost.man b/man/XAddHost.man index a54b06f6..23e5eaef 100644 --- a/man/XAddHost.man +++ b/man/XAddHost.man @@ -136,9 +136,9 @@ Specifies each host that is to be added or removed. .IP \fImode\fP 1i Specifies the mode. You can pass -.ZN EnableAccess +.B EnableAccess or -.ZN DisableAccess . +.BR DisableAccess . .IP \fInhosts_return\fP 1i Returns the number of hosts currently in the access control list. .IP \fInum_hosts\fP 1i @@ -147,113 +147,113 @@ Specifies the number of hosts. Returns the state of the access control. .SH DESCRIPTION The -.ZN XAddHost +.B XAddHost function adds the specified host to the access control list for that display. The server must be on the same host as the client issuing the command, or a -.ZN BadAccess +.B BadAccess error results. .LP -.ZN XAddHost +.B XAddHost can generate -.ZN BadAccess +.B BadAccess and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XAddHosts +.B XAddHosts function adds each specified host to the access control list for that display. The server must be on the same host as the client issuing the command, or a -.ZN BadAccess +.B BadAccess error results. .LP -.ZN XAddHosts +.B XAddHosts can generate -.ZN BadAccess +.B BadAccess and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XListHosts +.B XListHosts function returns the current access control list as well as whether the use of the list at connection setup was enabled or disabled. -.ZN XListHosts +.B XListHosts allows a program to find out what machines can make connections. It also returns a pointer to a list of host structures that were allocated by the function. When no longer needed, this memory should be freed by calling -.ZN XFree . +.BR XFree . .LP The -.ZN XRemoveHost +.B XRemoveHost function removes the specified host from the access control list for that display. The server must be on the same host as the client process, or a -.ZN BadAccess +.B BadAccess error results. If you remove your machine from the access list, you can no longer connect to that server, and this operation cannot be reversed unless you reset the server. .LP -.ZN XRemoveHost +.B XRemoveHost can generate -.ZN BadAccess +.B BadAccess and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XRemoveHosts +.B XRemoveHosts function removes each specified host from the access control list for that display. The X server must be on the same host as the client process, or a -.ZN BadAccess +.B BadAccess error results. If you remove your machine from the access list, you can no longer connect to that server, and this operation cannot be reversed unless you reset the server. .LP -.ZN XRemoveHosts +.B XRemoveHosts can generate -.ZN BadAccess +.B BadAccess and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XSetAccessControl +.B XSetAccessControl function either enables or disables the use of the access control list at each connection setup. .LP -.ZN XSetAccessControl +.B XSetAccessControl can generate -.ZN BadAccess +.B BadAccess and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XEnableAccessControl +.B XEnableAccessControl function enables the use of the access control list at each connection setup. .LP -.ZN XEnableAccessControl +.B XEnableAccessControl can generate a -.ZN BadAccess +.B BadAccess error. .LP The -.ZN XDisableAccessControl +.B XDisableAccessControl function disables the use of the access control list at each connection setup. .LP -.ZN XDisableAccessControl +.B XDisableAccessControl can generate a -.ZN BadAccess +.B BadAccess error. .SH STRUCTURES The -.ZN XHostAddress +.B XHostAddress structure contains: .LP .Ds 0 @@ -266,18 +266,18 @@ typedef struct { .LP The family member specifies which protocol address family to use (for example, TCP/IP or DECnet) and can be -.ZN FamilyInternet , -.ZN FamilyInternet6 , -.ZN FamilyServerInterpreted , -.ZN FamilyDECnet , +.BR FamilyInternet , +.BR FamilyInternet6 , +.BR FamilyServerInterpreted , +.BR FamilyDECnet , or -.ZN FamilyChaos . +.BR FamilyChaos . The length member specifies the length of the address in bytes. The address member specifies a pointer to the address. .LP For the ServerInterpreted family, the length is ignored and the address member is a pointer to a -.ZN XServerInterpretedAddress +.B XServerInterpretedAddress structure which contains: .LP .Ds 0 @@ -295,12 +295,12 @@ should be used when accessing them. The typelength and valuelength members specify the length in byte of the type and value strings. .SH DIAGNOSTICS .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to modify the access control list from other than the local (or otherwise authorized) host. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XAllocClassHint.man b/man/XAllocClassHint.man index 34d0ce77..a712b7f7 100644 --- a/man/XAllocClassHint.man +++ b/man/XAllocClassHint.man @@ -93,45 +93,45 @@ Status XGetClassHint\^(\^Display *\fIdisplay\fP, Window \fIw\fP, XClassHint *\fI Specifies the connection to the X server. .IP \fIclass_hints\fP 1i Specifies the -.ZN XClassHint +.B XClassHint structure that is to be used. .IP \fIclass_hints_return\fP 1i Returns the -.ZN XClassHint +.B XClassHint structure. .IP \fIw\fP 1i Specifies the window. .SH DESCRIPTION The -.ZN XAllocClassHint +.B XAllocClassHint function allocates and returns a pointer to a -.ZN XClassHint +.B XClassHint structure. Note that the pointer fields in the -.ZN XClassHint +.B XClassHint structure are initially set to NULL. If insufficient memory is available, -.ZN XAllocClassHint +.B XAllocClassHint returns NULL. To free the memory allocated to this structure, use -.ZN XFree . +.BR XFree . .LP The -.ZN XSetClassHint +.B XSetClassHint function sets the class hint for the specified window. If the strings are not in the Host Portable Character Encoding, the result is implementation-dependent. .LP -.ZN XSetClassHint +.B XSetClassHint can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetClassHint +.B XGetClassHint function returns the class hint of the specified window to the members of the supplied structure. If the data returned by the server is in the Latin Portable Character Encoding, @@ -141,12 +141,12 @@ It returns a nonzero status on success; otherwise, it returns a zero status. To free res_name and res_class when finished with the strings, use -.ZN XFree +.B XFree on each individually. .LP -.ZN XGetClassHint +.B XGetClassHint can generate a -.ZN BadWindow +.B BadWindow error. .SH PROPERTIES .TP 1i @@ -155,7 +155,7 @@ Set by application programs to allow window and session managers to obtain the application's resources from the resource database. .SH STRUCTURES The -.ZN XClassHint +.B XClassHint structure contains: .LP .IN "XClassHint" "" "@DEF@" @@ -177,10 +177,10 @@ that should be used when retrieving the application's resources from the resource database. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocIconSize(__libmansuffix__), diff --git a/man/XAllocColor.man b/man/XAllocColor.man index 7b21b563..f9ac2abe 100644 --- a/man/XAllocColor.man +++ b/man/XAllocColor.man @@ -158,16 +158,16 @@ Returns the closest RGB values provided by the hardware. Specifies and returns the values actually used in the colormap. .SH DESCRIPTION The -.ZN XAllocColor +.B XAllocColor function allocates a read-only colormap entry corresponding to the closest RGB value supported by the hardware. -.ZN XAllocColor +.B XAllocColor returns the pixel value of the color closest to the specified RGB elements supported by the hardware and returns the RGB value actually used. The corresponding colormap cell is read-only. In addition, -.ZN XAllocColor +.B XAllocColor returns nonzero if it succeeded or zero if it failed. .IN "Color map" .IN "Color" "allocation" @@ -176,18 +176,18 @@ returns nonzero if it succeeded or zero if it failed. Multiple clients that request the same effective RGB value can be assigned the same read-only entry, thus allowing entries to be shared. When the last client deallocates a shared cell, it is deallocated. -.ZN XAllocColor +.B XAllocColor does not use or affect the flags in the -.ZN XColor +.B XColor structure. .LP -.ZN XAllocColor +.B XAllocColor can generate a -.ZN BadColor +.B BadColor error. .LP The -.ZN XAllocNamedColor +.B XAllocNamedColor function looks up the named color with respect to the screen that is associated with the specified colormap. It returns both the exact database definition and @@ -200,24 +200,24 @@ Use of uppercase or lowercase does not matter. If screen_def_return and exact_def_return point to the same structure, the pixel field will be set correctly, but the color values are undefined. -.ZN XAllocNamedColor +.B XAllocNamedColor returns nonzero if a cell is allocated; otherwise, it returns zero. .LP -.ZN XAllocNamedColor +.B XAllocNamedColor can generate a -.ZN BadColor +.B BadColor error. .LP .EQ delim %% .EN The -.ZN XAllocColorCells +.B XAllocColorCells function allocates read/write color cells. The number of colors must be positive and the number of planes nonnegative, or a -.ZN BadValue +.B BadValue error results. If ncolors and nplanes are requested, then ncolors pixels @@ -229,33 +229,33 @@ ncolors * %2 sup nplanes% distinct pixels can be produced. All of these are allocated writable by the request. For -.ZN GrayScale +.B GrayScale or -.ZN PseudoColor , +.BR PseudoColor , each mask has exactly one bit set to 1. For -.ZN DirectColor , +.BR DirectColor , each has exactly three bits set to 1. If contig is -.ZN True +.B True and if all masks are ORed together, a single contiguous set of bits set to 1 will be formed for -.ZN GrayScale +.B GrayScale or -.ZN PseudoColor +.B PseudoColor and three contiguous sets of bits set to 1 (one within each pixel subfield) for -.ZN DirectColor . +.BR DirectColor . The RGB values of the allocated entries are undefined. -.ZN XAllocColorCells +.B XAllocColorCells returns nonzero if it succeeded or zero if it failed. .LP -.ZN XAllocColorCells +.B XAllocColorCells can generate -.ZN BadColor +.B BadColor and -.ZN BadValue +.B BadValue errors. .LP .EQ @@ -264,19 +264,19 @@ delim %% The specified ncolors must be positive; and nreds, ngreens, and nblues must be nonnegative, or a -.ZN BadValue +.B BadValue error results. If ncolors colors, nreds reds, ngreens greens, and nblues blues are requested, ncolors pixels are returned; and the masks have nreds, ngreens, and nblues bits set to 1, respectively. If contig is -.ZN True , +.BR True , each mask will have a contiguous set of bits set to 1. No mask will have any bits set to 1 in common with any other mask or with any of the pixels. For -.ZN DirectColor , +.BR DirectColor , each mask will lie within the corresponding pixel subfield. By ORing together @@ -288,27 +288,27 @@ colormap, there are only ncolors * %2 sup nreds% independent red entries, ncolors * %2 sup ngreens% independent green entries, and ncolors * %2 sup nblues% independent blue entries. This is true even for -.ZN PseudoColor . +.BR PseudoColor . When the colormap entry of a pixel value is changed (using -.ZN XStoreColors , -.ZN XStoreColor , +.BR XStoreColors , +.BR XStoreColor , or -.ZN XStoreNamedColor ), +.BR XStoreNamedColor ), the pixel is decomposed according to the masks, and the corresponding independent entries are updated. -.ZN XAllocColorPlanes +.B XAllocColorPlanes returns nonzero if it succeeded or zero if it failed. .LP -.ZN XAllocColorPlanes +.B XAllocColorPlanes can generate -.ZN BadColor +.B BadColor and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XFreeColors +.B XFreeColors function frees the cells represented by pixels whose values are in the pixels array. The planes argument should not have any bits set to 1 in common with any of the @@ -321,14 +321,14 @@ were allocated by the client (using .IN XAllocNamedColor .IN XAllocColorCells .IN XAllocColorPlanes -.ZN XAllocColor , -.ZN XAllocNamedColor , -.ZN XAllocColorCells , +.BR XAllocColor , +.BR XAllocNamedColor , +.BR XAllocColorCells , and -.ZN XAllocColorPlanes ). +.BR XAllocColorPlanes ). Note that freeing an individual pixel obtained from -.ZN XAllocColorPlanes +.B XAllocColorPlanes may not actually allow it to be reused until all of its related pixels are also freed. Similarly, @@ -339,41 +339,41 @@ it must free the entry that many times before the entry is actually freed. All specified pixels that are allocated by the client in the colormap are freed, even if one or more pixels produce an error. If a specified pixel is not a valid index into the colormap, a -.ZN BadValue +.B BadValue error results. If a specified pixel is not allocated by the client (that is, is unallocated or is only allocated by another client) or if the colormap was created with all entries writable (by passing -.ZN AllocAll +.B AllocAll to -.ZN XCreateColormap ), +.BR XCreateColormap ), a -.ZN BadAccess +.B BadAccess error results. If more than one pixel is in error, the one that gets reported is arbitrary. .LP -.ZN XFreeColors +.B XFreeColors can generate -.ZN BadAccess , -.ZN BadColor , +.BR BadAccess , +.BR BadColor , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to free a color map entry that it did not already allocate. .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to store into a read-only color map entry. .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XAllocIconSize.man b/man/XAllocIconSize.man index c8b9087f..f9df926d 100644 --- a/man/XAllocIconSize.man +++ b/man/XAllocIconSize.man @@ -104,50 +104,50 @@ Returns the size list. Specifies the window. .SH DESCRIPTION The -.ZN XAllocIconSize +.B XAllocIconSize function allocates and returns a pointer to a -.ZN XIconSize +.B XIconSize structure. Note that all fields in the -.ZN XIconSize +.B XIconSize structure are initially set to zero. If insufficient memory is available, -.ZN XAllocIconSize +.B XAllocIconSize returns NULL. To free the memory allocated to this structure, use -.ZN XFree . +.BR XFree . .LP The -.ZN XSetIconSizes +.B XSetIconSizes function is used only by window managers to set the supported icon sizes. .LP -.ZN XSetIconSizes +.B XSetIconSizes can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetIconSizes +.B XGetIconSizes function returns zero if a window manager has not set icon sizes; otherwise, it return nonzero. -.ZN XGetIconSizes +.B XGetIconSizes should be called by an application that wants to find out what icon sizes would be most appreciated by the window manager under which the application is running. The application should then use -.ZN XSetWMHints +.B XSetWMHints to supply the window manager with an icon pixmap or window in one of the supported sizes. To free the data allocated in size_list_return, use -.ZN XFree . +.BR XFree . .LP -.ZN XGetIconSizes +.B XGetIconSizes can generate a -.ZN BadWindow +.B BadWindow error. .SH PROPERTIES .TP 1i @@ -155,10 +155,10 @@ error. The window manager may set this property on the root window to specify the icon sizes it supports. The C type of this property is -.ZN XIconSize . +.BR XIconSize . .SH STRUCTURES The -.ZN XIconSize +.B XIconSize structure contains: .LP .IN "XIconSize" "" "@DEF@" @@ -174,10 +174,10 @@ The width_inc and height_inc members define an arithmetic progression of sizes (minimum to maximum) that represent the supported icon sizes. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/man/XAllocSizeHints.man b/man/XAllocSizeHints.man index 9c01736f..e38e7a07 100644 --- a/man/XAllocSizeHints.man +++ b/man/XAllocSizeHints.man @@ -104,7 +104,7 @@ Specifies the connection to the X server. Specifies the size hints for the window in its normal state. .IP \fIhints\fP 1i Specifies the -.ZN XSizeHints +.B XSizeHints structure to be used. .IP \fIhints_return\fP 1i Returns the size hints for the window in its normal state. @@ -116,53 +116,53 @@ Returns the hints that were supplied by the user. Specifies the window. .SH DESCRIPTION The -.ZN XAllocSizeHints +.B XAllocSizeHints function allocates and returns a pointer to a -.ZN XSizeHints +.B XSizeHints structure. Note that all fields in the -.ZN XSizeHints +.B XSizeHints structure are initially set to zero. If insufficient memory is available, -.ZN XAllocSizeHints +.B XAllocSizeHints returns NULL. To free the memory allocated to this structure, use -.ZN XFree . +.BR XFree . .LP The -.ZN XSetWMNormalHints +.B XSetWMNormalHints function replaces the size hints for the WM_NORMAL_HINTS property on the specified window. If the property does not already exist, -.ZN XSetWMNormalHints +.B XSetWMNormalHints sets the size hints for the WM_NORMAL_HINTS property on the specified window. The property is stored with a type of WM_SIZE_HINTS and a format of 32. .LP -.ZN XSetWMNormalHints +.B XSetWMNormalHints can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetWMNormalHints +.B XGetWMNormalHints function returns the size hints stored in the WM_NORMAL_HINTS property on the specified window. If the property is of type WM_SIZE_HINTS, is of format 32, and is long enough to contain either an old (pre-ICCCM) or new size hints structure, -.ZN XGetWMNormalHints +.B XGetWMNormalHints sets the various fields of the -.ZN XSizeHints +.B XSizeHints structure, sets the supplied_return argument to the list of fields that were supplied by the user (whether or not they contained defined values), and returns a nonzero status. Otherwise, it returns a zero status. .LP If -.ZN XGetWMNormalHints +.B XGetWMNormalHints returns successfully and a pre-ICCCM size hints property is read, the supplied_return argument will contain the following bits: .LP @@ -179,43 +179,43 @@ the supplied_return argument will also contain the following bits: PBaseSize|PWinGravity .De .LP -.ZN XGetWMNormalHints +.B XGetWMNormalHints can generate a PN BadWindow error. .LP The -.ZN XSetWMSizeHints +.B XSetWMSizeHints function replaces the size hints for the specified property on the named window. If the specified property does not already exist, -.ZN XSetWMSizeHints +.B XSetWMSizeHints sets the size hints for the specified property on the named window. The property is stored with a type of WM_SIZE_HINTS and a format of 32. To set a window's normal size hints, you can use the -.ZN XSetWMNormalHints +.B XSetWMNormalHints function. .LP -.ZN XSetWMSizeHints +.B XSetWMSizeHints can generate -.ZN BadAlloc , -.ZN BadAtom , +.BR BadAlloc , +.BR BadAtom , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetWMSizeHints +.B XGetWMSizeHints function returns the size hints stored in the specified property on the named window. If the property is of type WM_SIZE_HINTS, is of format 32, and is long enough to contain either an old (pre-ICCCM) or new size hints structure, -.ZN XGetWMSizeHints +.B XGetWMSizeHints sets the various fields of the -.ZN XSizeHints +.B XSizeHints structure, sets the supplied_return argument to the list of fields that were supplied by the user (whether or not they contained defined values), @@ -223,11 +223,11 @@ and returns a nonzero status. Otherwise, it returns a zero status. To get a window's normal size hints, you can use the -.ZN XGetWMNormalHints +.B XGetWMNormalHints function. .LP If -.ZN XGetWMSizeHints +.B XGetWMSizeHints returns successfully and a pre-ICCCM size hints property is read, the supplied_return argument will contain the following bits: .LP @@ -244,21 +244,21 @@ the supplied_return argument will also contain the following bits: PBaseSize|PWinGravity .De .LP -.ZN XGetWMSizeHints +.B XGetWMSizeHints can generate -.ZN BadAtom +.B BadAtom and -.ZN BadWindow +.B BadWindow errors. .SH PROPERTIES .TP 1i \s-1WM_NORMAL_HINTS\s+1 Size hints for a window in its normal state. The C type of this property is -.ZN XSizeHints . +.BR XSizeHints . .SH STRUCTURES The -.ZN XSizeHints +.B XSizeHints structure contains: .LP /\&* Size hints mask bits */ @@ -267,7 +267,7 @@ lw(.5i) lw(1.1i) lw(1.5i) lw(3.1i). T{ \&#define T} T{ -.ZN USPosition +.B USPosition T} T{ (1L << 0) T} T{ @@ -276,7 +276,7 @@ T} T{ \&#define T} T{ -.ZN USSize +.B USSize T} T{ (1L << 1) T} T{ @@ -285,7 +285,7 @@ T} T{ \&#define T} T{ -.ZN PPosition +.B PPosition T} T{ (1L << 2) T} T{ @@ -294,7 +294,7 @@ T} T{ \&#define T} T{ -.ZN PSize +.B PSize T} T{ (1L << 3) T} T{ @@ -303,7 +303,7 @@ T} T{ \&#define T} T{ -.ZN PMinSize +.B PMinSize T} T{ (1L << 4) T} T{ @@ -312,7 +312,7 @@ T} T{ \&#define T} T{ -.ZN PMaxSize +.B PMaxSize T} T{ (1L << 5) T} T{ @@ -321,7 +321,7 @@ T} T{ \&#define T} T{ -.ZN PResizeInc +.B PResizeInc T} T{ (1L << 6) T} T{ @@ -330,7 +330,7 @@ T} T{ \&#define T} T{ -.ZN PAspect +.B PAspect T} T{ (1L << 7) T} T{ @@ -339,21 +339,21 @@ T} T{ \&#define T} T{ -.ZN PBaseSize +.B PBaseSize T} T{ (1L << 8) T} T{ \&#define T} T{ -.ZN PWinGravity +.B PWinGravity T} T{ (1L << 9) T} T{ \&#define T} T{ -.ZN PAllHints +.B PAllHints T} T{ (PPosition|PSize| .br @@ -408,17 +408,17 @@ will be placed where the client window would have been placed in the absence of a window manager. .LP Note that use of the -.ZN PAllHints +.B PAllHints macro is highly discouraged. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadAtom +.B BadAtom A value for an Atom argument does not name a defined Atom. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/man/XAllocStandardColormap.man b/man/XAllocStandardColormap.man index 49a524f1..fc5ea49c 100644 --- a/man/XAllocStandardColormap.man +++ b/man/XAllocStandardColormap.man @@ -105,34 +105,34 @@ Returns the number of colormaps. Specifies the property name. .IP \fIstd_colormap\fP 1i Specifies the -.ZN XStandardColormap +.B XStandardColormap structure to be used. .IP \fIstd_colormap_return\fP 1i Returns the -.ZN XStandardColormap +.B XStandardColormap structure. .SH DESCRIPTION The -.ZN XAllocStandardColormap +.B XAllocStandardColormap function allocates and returns a pointer to a -.ZN XStandardColormap +.B XStandardColormap structure. Note that all fields in the -.ZN XStandardColormap +.B XStandardColormap structure are initially set to zero. If insufficient memory is available, -.ZN XAllocStandardColormap +.B XAllocStandardColormap returns NULL. To free the memory allocated to this structure, use -.ZN XFree . +.BR XFree . .LP The -.ZN XSetRGBColormaps +.B XSetRGBColormaps function replaces the RGB colormap definition in the specified property on the named window. If the property does not already exist, -.ZN XSetRGBColormaps +.B XSetRGBColormaps sets the RGB colormap definition in the specified property on the named window. The property is stored with a type of RGB_COLOR_MAP and a format of 32. @@ -140,7 +140,7 @@ Note that it is the caller's responsibility to honor the ICCCM restriction that only RGB_DEFAULT_MAP contain more than one definition. .LP The -.ZN XSetRGBColormaps +.B XSetRGBColormaps function usually is only used by window or session managers. To create a standard colormap, follow this procedure: @@ -159,64 +159,64 @@ Create a colormap (unless you are using the default colormap of the screen). Determine the color characteristics of the visual. .IP \(bu 5 Allocate cells in the colormap (or create it with -.ZN AllocAll ). +.BR AllocAll ). .IP \(bu 5 Call -.ZN XStoreColors +.B XStoreColors to store appropriate color values in the colormap. .IP \(bu 5 Fill in the descriptive members in the -.ZN XStandardColormap +.B XStandardColormap structure. .IP \(bu 5 Attach the property to the root window. .IP \(bu 5 Use -.ZN XSetCloseDownMode +.B XSetCloseDownMode to make the resource permanent. .RE .IP 5. 5 Ungrab the server. .LP -.ZN XSetRGBColormaps +.B XSetRGBColormaps can generate -.ZN BadAlloc , -.ZN BadAtom , +.BR BadAlloc , +.BR BadAtom , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetRGBColormaps +.B XGetRGBColormaps function returns the RGB colormap definitions stored in the specified property on the named window. If the property exists, is of type RGB_COLOR_MAP, is of format 32, and is long enough to contain a colormap definition, -.ZN XGetRGBColormaps +.B XGetRGBColormaps allocates and fills in space for the returned colormaps and returns a nonzero status. If the visualid is not present, -.ZN XGetRGBColormaps +.B XGetRGBColormaps assumes the default visual for the screen on which the window is located; if the killid is not present, -.ZN None +.B None is assumed, which indicates that the resources cannot be released. Otherwise, none of the fields are set, and -.ZN XGetRGBColormaps +.B XGetRGBColormaps returns a zero status. Note that it is the caller's responsibility to honor the ICCCM restriction that only RGB_DEFAULT_MAP contain more than one definition. .LP -.ZN XGetRGBColormaps +.B XGetRGBColormaps can generate -.ZN BadAtom +.B BadAtom and -.ZN BadWindow +.B BadWindow errors. .SH STRUCTURES The -.ZN XStandardColormap +.B XStandardColormap structure contains: .LP /\&* Hints */ @@ -225,7 +225,7 @@ lw(.5i) lw(2i) lw(1i). T{ \&#define T} T{ -.ZN ReleaseByFreeingColormap +.B ReleaseByFreeingColormap T} T{ ( (XID) 1L) T} @@ -248,7 +248,7 @@ typedef struct { .De .LP The colormap member is the colormap created by the -.ZN XCreateColormap +.B XCreateColormap function. The red_max, green_max, and blue_max members give the maximum red, green, and blue values, respectively. @@ -272,7 +272,7 @@ green_mult might be 6, and blue_mult might be 1. The base_pixel member gives the base pixel value used to compose a full pixel value. Usually, the base_pixel is obtained from a call to the -.ZN XAllocColorPlanes +.B XAllocColorPlanes function. Given integer red, green, and blue coefficients in their appropriate ranges, one then can compute a corresponding pixel value by @@ -283,13 +283,13 @@ using the following expression: .De .LP For -.ZN GrayScale +.B GrayScale colormaps, only the colormap, red_max, red_mult, and base_pixel members are defined. The other members are ignored. To compute a -.ZN GrayScale +.B GrayScale pixel value, use the following expression: .LP .Ds @@ -309,23 +309,23 @@ colormap was created. The killid member gives a resource ID that indicates whether the cells held by this standard colormap are to be released by freeing the colormap ID or by calling the -.ZN XKillClient +.B XKillClient function on the indicated resource. (Note that this method is necessary for allocating out of an existing colormap.) .LP The properties containing the -.ZN XStandardColormap +.B XStandardColormap information have the type RGB_COLOR_MAP. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadAtom +.B BadAtom A value for an Atom argument does not name a defined Atom. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocColor(__libmansuffix__), diff --git a/man/XAllocWMHints.man b/man/XAllocWMHints.man index f871c36e..71671a4c 100644 --- a/man/XAllocWMHints.man +++ b/man/XAllocWMHints.man @@ -97,61 +97,61 @@ Specifies the connection to the X server. Specifies the window. .IP \fIwmhints\fP 1i Specifies the -.ZN XWMHints +.B XWMHints structure to be used. .SH DESCRIPTION The -.ZN XAllocWMHints +.B XAllocWMHints function allocates and returns a pointer to a -.ZN XWMHints +.B XWMHints structure. Note that all fields in the -.ZN XWMHints +.B XWMHints structure are initially set to zero. If insufficient memory is available, -.ZN XAllocWMHints +.B XAllocWMHints returns NULL. To free the memory allocated to this structure, use -.ZN XFree . +.BR XFree . .LP The -.ZN XSetWMHints +.B XSetWMHints function sets the window manager hints that include icon information and location, the initial state of the window, and whether the application relies on the window manager to get keyboard input. .LP -.ZN XSetWMHints +.B XSetWMHints can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetWMHints +.B XGetWMHints function reads the window manager hints and returns NULL if no WM_HINTS property was set on the window or returns a pointer to a -.ZN XWMHints +.B XWMHints structure if it succeeds. When finished with the data, free the space used for it by calling -.ZN XFree . +.BR XFree . .LP -.ZN XGetWMHints +.B XGetWMHints can generate a -.ZN BadWindow +.B BadWindow error. .SH PROPERTIES .TP 1i \s-1WM_HINTS\s+1 Additional hints set by the client for use by the window manager. The C type of this property is -.ZN XWMHints . +.BR XWMHints . .SH STRUCTURES The -.ZN XWMHints +.B XWMHints structure contains: .LP /\&* Window manager hints mask bits */ @@ -160,63 +160,63 @@ lw(.5i) lw(2.5i) lw(2.5i). T{ \&#define T} T{ -.ZN InputHint +.B InputHint T} T{ (1L << 0) T} T{ \&#define T} T{ -.ZN StateHint +.B StateHint T} T{ (1L << 1) T} T{ \&#define T} T{ -.ZN IconPixmapHint +.B IconPixmapHint T} T{ (1L << 2) T} T{ \&#define T} T{ -.ZN IconWindowHint +.B IconWindowHint T} T{ (1L << 3) T} T{ \&#define T} T{ -.ZN IconPositionHint +.B IconPositionHint T} T{ (1L << 4) T} T{ \&#define T} T{ -.ZN IconMaskHint +.B IconMaskHint T} T{ (1L << 5) T} T{ \&#define T} T{ -.ZN WindowGroupHint +.B WindowGroupHint T} T{ (1L << 6) T} T{ \&#define T} T{ -.ZN XUrgencyHint +.B XUrgencyHint T} T{ (1L << 8) T} T{ \&#define T} T{ -.ZN AllHints +.B AllHints T} T{ (InputHint|StateHint|IconPixmapHint| .br @@ -249,30 +249,30 @@ Applications that expect input but never explicitly set focus to any of their subwindows (that is, use the push model of focus management), such as X Version 10 style applications that use real-estate driven focus, should set this member to -.ZN True . +.BR True . Similarly, applications that set input focus to their subwindows only when it is given to their top-level window by a window manager should also set this member to -.ZN True . +.BR True . Applications that manage their own input focus by explicitly setting focus to one of their subwindows whenever they want keyboard input (that is, use the pull model of focus management) should set this member to -.ZN False . +.BR False . Applications that never expect any keyboard input also should set this member to -.ZN False . +.BR False . .LP Pull model window managers should make it possible for push model applications to get input by setting input focus to the top-level windows of applications whose input member is -.ZN True . +.BR True . Push model window managers should make sure that pull model applications do not break them by resetting input focus to -.ZN PointerRoot +.B PointerRoot when it is appropriate (for example, whenever an application whose input member is -.ZN False +.B False sets input focus to one of its subwindows). .LP The definitions for the initial_state flag are: @@ -281,7 +281,7 @@ lw(.5i) lw(2i) lw(.2i) lw(2.8i). T{ \&#define T} T{ -.ZN WithdrawnState +.B WithdrawnState T} T{ 0 T} T{ @@ -289,7 +289,7 @@ T} T{ \&#define T} T{ -.ZN NormalState +.B NormalState T} T{ 1 T} T{ @@ -298,7 +298,7 @@ T} T{ \&#define T} T{ -.ZN IconicState +.B IconicState T} T{ 3 T} T{ @@ -319,7 +319,7 @@ information that a window manager can iconify all of the windows rather than just the one window. .LP The -.ZN UrgencyHint +.B UrgencyHint flag, if set in the flags field, indicates that the client deems the window contents to be urgent, requiring the timely response of the user. The window manager will make some effort to draw the user's attention to this @@ -329,10 +329,10 @@ the condition that made the window urgent or merely shutting off the alarm) or the window to be withdrawn. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/man/XAllowEvents.man b/man/XAllowEvents.man index cecb0066..15c4d6a2 100644 --- a/man/XAllowEvents.man +++ b/man/XAllowEvents.man @@ -91,35 +91,35 @@ Specifies the connection to the X server. .IP \fIevent_mode\fP 1i Specifies the event mode. You can pass -.ZN AsyncPointer , -.ZN SyncPointer , -.ZN AsyncKeyboard , -.ZN SyncKeyboard , -.ZN ReplayPointer , -.ZN ReplayKeyboard , -.ZN AsyncBoth , +.BR AsyncPointer , +.BR SyncPointer , +.BR AsyncKeyboard , +.BR SyncKeyboard , +.BR ReplayPointer , +.BR ReplayKeyboard , +.BR AsyncBoth , or -.ZN SyncBoth . +.BR SyncBoth . .IP \fItime\fP 1i Specifies the time. You can pass either a timestamp or -.ZN CurrentTime . +.BR CurrentTime . .SH DESCRIPTION The -.ZN XAllowEvents +.B XAllowEvents function releases some queued events if the client has caused a device to freeze. It has no effect if the specified time is earlier than the last-grab time of the most recent active grab for the client or if the specified time is later than the current X server time. .LP -.ZN XAllowEvents +.B XAllowEvents can generate a -.ZN BadValue +.B BadValue error. .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XAnyEvent.man b/man/XAnyEvent.man index 651be426..c3225c6b 100644 --- a/man/XAnyEvent.man +++ b/man/XAnyEvent.man @@ -98,16 +98,16 @@ typedef struct { The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -115,7 +115,7 @@ The window member is set to the window that is most useful to toolkit dispatchers. .LP The -.ZN XEvent +.B XEvent structure is a union of the individual structures declared for each event type: .Ds 0 typedef union _XEvent { @@ -156,14 +156,14 @@ typedef union _XEvent { .De .LP An -.ZN XEvent +.B XEvent structure's first entry always is the type member, which is set to the event type. The second member always is the serial number of the protocol request that generated the event. The third member always is send_event, which is a -.ZN Bool +.B Bool that indicates if the event was sent by a different client. The fourth member always is a display, which is the display that the event was read from. diff --git a/man/XButtonEvent.man b/man/XButtonEvent.man index 14a8bc6a..5300e7a7 100644 --- a/man/XButtonEvent.man +++ b/man/XButtonEvent.man @@ -83,12 +83,12 @@ XButtonEvent, XKeyEvent, XMotionEvent \- KeyPress, KeyRelease, ButtonPress, ButtonRelease, and MotionNotify event structures .SH STRUCTURES The structures for -.ZN KeyPress , -.ZN KeyRelease , -.ZN ButtonPress , -.ZN ButtonRelease , +.BR KeyPress , +.BR KeyRelease , +.BR ButtonPress , +.BR ButtonRelease , and -.ZN MotionNotify +.B MotionNotify events contain: .LP .Ds 0 @@ -156,16 +156,16 @@ their structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -185,14 +185,14 @@ relative to the root window's origin at the time of the event. The same_screen member is set to indicate whether the event window is on the same screen as the root window and can be either -.ZN True +.B True or -.ZN False . +.BR False . If -.ZN True , +.BR True , the event and root windows are on the same screen. If -.ZN False , +.BR False , the event and root windows are not on the same screen. .LP If the source window is an inferior of the event window, @@ -200,7 +200,7 @@ the subwindow member of the structure is set to the child of the event window that is the source window or the child of the event window that is an ancestor of the source window. Otherwise, the X server sets the subwindow member to -.ZN None . +.BR None . The time member is set to the time when the event was generated and is expressed in milliseconds. .LP @@ -213,51 +213,51 @@ The state member is set to indicate the logical state of the pointer buttons and modifier keys just prior to the event, which is the bitwise inclusive OR of one or more of the button or modifier key masks: -.ZN Button1Mask , -.ZN Button2Mask , -.ZN Button3Mask , -.ZN Button4Mask , -.ZN Button5Mask , -.ZN ShiftMask , -.ZN LockMask , -.ZN ControlMask , -.ZN Mod1Mask , -.ZN Mod2Mask , -.ZN Mod3Mask , -.ZN Mod4Mask , +.BR Button1Mask , +.BR Button2Mask , +.BR Button3Mask , +.BR Button4Mask , +.BR Button5Mask , +.BR ShiftMask , +.BR LockMask , +.BR ControlMask , +.BR Mod1Mask , +.BR Mod2Mask , +.BR Mod3Mask , +.BR Mod4Mask , and -.ZN Mod5Mask . +.BR Mod5Mask . .LP Each of these structures also has a member that indicates the detail. For the -.ZN XKeyPressedEvent +.B XKeyPressedEvent and -.ZN XKeyReleasedEvent +.B XKeyReleasedEvent structures, this member is called a keycode. It is set to a number that represents a physical key on the keyboard. The keycode is an arbitrary representation for any key on the keyboard (see sections 12.7 and 16.1). .LP For the -.ZN XButtonPressedEvent +.B XButtonPressedEvent and -.ZN XButtonReleasedEvent +.B XButtonReleasedEvent structures, this member is called button. It represents the pointer button that changed state and can be the -.ZN Button1 , -.ZN Button2 , -.ZN Button3 , -.ZN Button4 , +.BR Button1 , +.BR Button2 , +.BR Button3 , +.BR Button4 , or -.ZN Button5 +.B Button5 value. For the -.ZN XPointerMovedEvent +.B XPointerMovedEvent structure, this member is called is_hint. It can be set to -.ZN NotifyNormal +.B NotifyNormal or -.ZN NotifyHint . +.BR NotifyHint . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XCreateWindowEvent(__libmansuffix__), diff --git a/man/XChangeKeyboardControl.man b/man/XChangeKeyboardControl.man index efaf0ee4..5d5645fa 100644 --- a/man/XChangeKeyboardControl.man +++ b/man/XChangeKeyboardControl.man @@ -114,44 +114,44 @@ This mask is the bitwise inclusive OR of the valid control mask bits. Specifies one value for each bit set to 1 in the mask. .IP \fIvalues_return\fP 1i Returns the current keyboard controls in the specified -.ZN XKeyboardState +.B XKeyboardState structure. .SH DESCRIPTION The -.ZN XChangeKeyboardControl +.B XChangeKeyboardControl function controls the keyboard characteristics defined by the -.ZN XKeyboardControl +.B XKeyboardControl structure. The value_mask argument specifies which values are to be changed. .LP -.ZN XChangeKeyboardControl +.B XChangeKeyboardControl can generate -.ZN BadMatch +.B BadMatch and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XGetKeyboardControl +.B XGetKeyboardControl function returns the current control values for the keyboard to the -.ZN XKeyboardState +.B XKeyboardState structure. .LP The -.ZN XAutoRepeatOn +.B XAutoRepeatOn function turns on auto-repeat for the keyboard on the specified display. .LP The -.ZN XAutoRepeatOff +.B XAutoRepeatOff function turns off auto-repeat for the keyboard on the specified display. .LP The -.ZN XBell +.B XBell function rings the bell on the keyboard on the specified display, if possible. The specified volume is relative to the base volume for the keyboard. If the value for the percent argument is not in the range \-100 to 100 inclusive, a -.ZN BadValue +.B BadValue error results. The volume at which the bell rings when the percent argument is nonnegative is: @@ -164,15 +164,15 @@ when the percent argument is negative is: base + [(base * percent) / 100] .LP To change the base volume of the bell, use -.ZN XChangeKeyboardControl . +.BR XChangeKeyboardControl . .LP -.ZN XBell +.B XBell can generate a -.ZN BadValue +.B BadValue error. .LP The -.ZN XQueryKeymap +.B XQueryKeymap function returns a bit vector for the logical state of the keyboard, where each bit set to 1 indicates that the corresponding key is currently pressed down. @@ -184,7 +184,7 @@ Note that the logical state of a device (as seen by client applications) may lag the physical state if device event processing is frozen. .SH STRUCTURES The -.ZN XKeyboardControl +.B XKeyboardControl structure contains: .LP .LP @@ -194,56 +194,56 @@ lw(.5i) lw(2.5i) lw(.8i). T{ \&#define T} T{ -.ZN KBKeyClickPercent +.B KBKeyClickPercent T} T{ (1L<<0) T} T{ \&#define T} T{ -.ZN KBBellPercent +.B KBBellPercent T} T{ (1L<<1) T} T{ \&#define T} T{ -.ZN KBBellPitch +.B KBBellPitch T} T{ (1L<<2) T} T{ \&#define T} T{ -.ZN KBBellDuration +.B KBBellDuration T} T{ (1L<<3) T} T{ \&#define T} T{ -.ZN KBLed +.B KBLed T} T{ (1L<<4) T} T{ \&#define T} T{ -.ZN KBLedMode +.B KBLedMode T} T{ (1L<<5) T} T{ \&#define T} T{ -.ZN KBKey +.B KBKey T} T{ (1L<<6) T} T{ \&#define T} T{ -.ZN KBAutoRepeatMode +.B KBAutoRepeatMode T} T{ (1L<<7) T} @@ -269,53 +269,53 @@ The key_click_percent member sets the volume for key clicks between 0 (off) and 100 (loud) inclusive, if possible. A setting of \-1 restores the default. Other negative values generate a -.ZN BadValue +.B BadValue error. .LP The bell_percent sets the base volume for the bell between 0 (off) and 100 (loud) inclusive, if possible. A setting of \-1 restores the default. Other negative values generate a -.ZN BadValue +.B BadValue error. The bell_pitch member sets the pitch (specified in Hz) of the bell, if possible. A setting of \-1 restores the default. Other negative values generate a -.ZN BadValue +.B BadValue error. The bell_duration member sets the duration of the bell specified in milliseconds, if possible. A setting of \-1 restores the default. Other negative values generate a -.ZN BadValue +.B BadValue error. .LP If both the led_mode and led members are specified, the state of that LED is changed, if possible. The led_mode member can be set to -.ZN LedModeOn +.B LedModeOn or -.ZN LedModeOff . +.BR LedModeOff . If only led_mode is specified, the state of all LEDs are changed, if possible. At most 32 LEDs numbered from one are supported. No standard interpretation of LEDs is defined. If led is specified without led_mode, a -.ZN BadMatch +.B BadMatch error results. .LP If both the auto_repeat_mode and key members are specified, the auto_repeat_mode of that key is changed (according to -.ZN AutoRepeatModeOn , -.ZN AutoRepeatModeOff , +.BR AutoRepeatModeOn , +.BR AutoRepeatModeOff , or -.ZN AutoRepeatModeDefault ), +.BR AutoRepeatModeDefault ), if possible. If only auto_repeat_mode is specified, the global auto_repeat_mode for the entire keyboard is changed, if possible, and does not affect the per-key settings. If a key is specified without an auto_repeat_mode, a -.ZN BadMatch +.B BadMatch error results. Each key has an individual mode of whether or not it should auto-repeat and a default setting for the mode. @@ -323,22 +323,22 @@ In addition, there is a global mode of whether auto-repeat should be enabled or not and a default setting for that mode. When global mode is -.ZN AutoRepeatModeOn , +.BR AutoRepeatModeOn , keys should obey their individual auto-repeat modes. When global mode is -.ZN AutoRepeatModeOff , +.BR AutoRepeatModeOff , no keys should auto-repeat. An auto-repeating key generates alternating -.ZN KeyPress +.B KeyPress and -.ZN KeyRelease +.B KeyRelease events. When a key is used as a modifier, it is desirable for the key not to auto-repeat, regardless of its auto-repeat setting. .LP The -.ZN XKeyboardState +.B XKeyboardState structure contains: .LP .Ds 0 @@ -356,9 +356,9 @@ For the LEDs, the least significant bit of led_mask corresponds to LED one, and each bit set to 1 in led_mask indicates an LED that is lit. The global_auto_repeat member can be set to -.ZN AutoRepeatModeOn +.B AutoRepeatModeOn or -.ZN AutoRepeatModeOff . +.BR AutoRepeatModeOff . The auto_repeats member is a bit vector. Each bit set to 1 indicates that auto-repeat is enabled for the corresponding key. @@ -367,11 +367,11 @@ Byte N (from 0) contains the bits for keys 8N to 8N + 7 with the least significant bit in the byte representing key 8N. .SH DIAGNOSTICS .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XChangeKeyboardMapping.man b/man/XChangeKeyboardMapping.man index 33d07619..53dbb103 100644 --- a/man/XChangeKeyboardMapping.man +++ b/man/XChangeKeyboardMapping.man @@ -133,13 +133,13 @@ Returns the minimum number of KeyCodes. Specifies the modifier. .IP \fImodmap\fP 1i Specifies the -.ZN XModifierKeymap +.B XModifierKeymap structure. .IP \fInum_codes\fP 1i Specifies the number of KeyCodes that are to be changed. .SH DESCRIPTION The -.ZN XChangeKeyboardMapping +.B XChangeKeyboardMapping function defines the symbols for the specified number of KeyCodes starting with first_keycode. The symbols for KeyCodes outside this range remain unchanged. @@ -151,15 +151,15 @@ num_codes * keysyms_per_keycode .LP The specified first_keycode must be greater than or equal to min_keycode returned by -.ZN XDisplayKeycodes , +.BR XDisplayKeycodes , or a -.ZN BadValue +.B BadValue error results. In addition, the following expression must be less than or equal to max_keycode as returned by -.ZN XDisplayKeycodes , +.BR XDisplayKeycodes , or a -.ZN BadValue +.B BadValue error results: .LP .Ds @@ -176,48 +176,48 @@ in keysyms, counting from zero: The specified keysyms_per_keycode can be chosen arbitrarily by the client to be large enough to hold all desired symbols. A special KeySym value of -.ZN NoSymbol +.B NoSymbol should be used to fill in unused elements for individual KeyCodes. It is legal for -.ZN NoSymbol +.B NoSymbol to appear in nontrailing positions of the effective list for a KeyCode. -.ZN XChangeKeyboardMapping +.B XChangeKeyboardMapping generates a -.ZN MappingNotify +.B MappingNotify event. .LP There is no requirement that the X server interpret this mapping. It is merely stored for reading and writing by clients. .LP -.ZN XChangeKeyboardMapping +.B XChangeKeyboardMapping can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XGetKeyboardMapping +.B XGetKeyboardMapping function returns the symbols for the specified number of KeyCodes starting with first_keycode. The value specified in first_keycode must be greater than or equal to min_keycode as returned by -.ZN XDisplayKeycodes , +.BR XDisplayKeycodes , or a -.ZN BadValue +.B BadValue error results. In addition, the following expression must be less than or equal to max_keycode as returned by -.ZN XDisplayKeycodes : +.BR XDisplayKeycodes : .LP .Ds first_keycode + keycode_count \- 1 .De .LP If this is not the case, a -.ZN BadValue +.B BadValue error results. The number of elements in the KeySyms list is: .LP @@ -234,21 +234,21 @@ in the list, counting from zero: The X server arbitrarily chooses the keysyms_per_keycode_return value to be large enough to report all requested symbols. A special KeySym value of -.ZN NoSymbol +.B NoSymbol is used to fill in unused elements for individual KeyCodes. To free the storage returned by -.ZN XGetKeyboardMapping , +.BR XGetKeyboardMapping , use -.ZN XFree . +.BR XFree . .LP -.ZN XGetKeyboardMapping +.B XGetKeyboardMapping can generate a -.ZN BadValue +.B BadValue error. .LP The -.ZN XDisplayKeycodes +.B XDisplayKeycodes function returns the min-keycodes and max-keycodes supported by the specified display. The minimum number of KeyCodes returned is never less than 8, @@ -256,44 +256,44 @@ and the maximum number of KeyCodes returned is never greater than 255. Not all KeyCodes in this range are required to have corresponding keys. .LP The -.ZN XSetModifierMapping +.B XSetModifierMapping function specifies the KeyCodes of the keys (if any) that are to be used as modifiers. If it succeeds, the X server generates a -.ZN MappingNotify +.B MappingNotify event, and -.ZN XSetModifierMapping +.B XSetModifierMapping returns -.ZN MappingSuccess . +.BR MappingSuccess . X permits at most 8 modifier keys. If more than 8 are specified in the -.ZN XModifierKeymap +.B XModifierKeymap structure, a -.ZN BadLength +.B BadLength error results. .LP The modifiermap member of the -.ZN XModifierKeymap +.B XModifierKeymap structure contains 8 sets of max_keypermod KeyCodes, one for each modifier in the order -.ZN Shift , -.ZN Lock , -.ZN Control , -.ZN Mod1 , -.ZN Mod2 , -.ZN Mod3 , -.ZN Mod4 , +.BR Shift , +.BR Lock , +.BR Control , +.BR Mod1 , +.BR Mod2 , +.BR Mod3 , +.BR Mod4 , and -.ZN Mod5 . +.BR Mod5 . Only nonzero KeyCodes have meaning in each set, and zero KeyCodes are ignored. In addition, all of the nonzero KeyCodes must be in the range specified by min_keycode and max_keycode in the -.ZN Display +.B Display structure, or a -.ZN BadValue +.B BadValue error results. .LP An X server can impose restrictions on how modifiers can be changed, @@ -303,61 +303,61 @@ if auto-repeat cannot be disabled on certain keys, or if multiple modifier keys are not supported. If some such restriction is violated, the status reply is -.ZN MappingFailed , +.BR MappingFailed , and none of the modifiers are changed. If the new KeyCodes specified for a modifier differ from those currently defined and any (current or new) keys for that modifier are in the logically down state, -.ZN XSetModifierMapping +.B XSetModifierMapping returns -.ZN MappingBusy , +.BR MappingBusy , and none of the modifiers is changed. .LP -.ZN XSetModifierMapping +.B XSetModifierMapping can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XGetModifierMapping +.B XGetModifierMapping function returns a pointer to a newly created -.ZN XModifierKeymap +.B XModifierKeymap structure that contains the keys being used as modifiers. The structure should be freed after use by calling -.ZN XFreeModifiermap . +.BR XFreeModifiermap . If only zero values appear in the set for any modifier, that modifier is disabled. .LP The -.ZN XNewModifiermap +.B XNewModifiermap function returns a pointer to -.ZN XModifierKeymap +.B XModifierKeymap structure for later use. .LP The -.ZN XInsertModifiermapEntry +.B XInsertModifiermapEntry function adds the specified KeyCode to the set that controls the specified modifier and returns the resulting -.ZN XModifierKeymap +.B XModifierKeymap structure (expanded as needed). .LP The -.ZN XDeleteModifiermapEntry +.B XDeleteModifiermapEntry function deletes the specified KeyCode from the set that controls the specified modifier and returns a pointer to the resulting -.ZN XModifierKeymap +.B XModifierKeymap structure. .LP The -.ZN XFreeModifiermap +.B XFreeModifiermap function frees the specified -.ZN XModifierKeymap +.B XModifierKeymap structure. .SH STRUCTURES The -.ZN XModifierKeymap +.B XModifierKeymap structure contains: .LP .Ds 0 @@ -368,10 +368,10 @@ typedef struct { .De .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XChangePointerControl.man b/man/XChangePointerControl.man index 57d46a32..44dccbc0 100644 --- a/man/XChangePointerControl.man +++ b/man/XChangePointerControl.man @@ -113,7 +113,7 @@ Specifies the acceleration threshold. Returns the acceleration threshold. .SH DESCRIPTION The -.ZN XChangePointerControl +.B XChangePointerControl function defines how the pointing device moves. The acceleration, expressed as a fraction, is a multiplier for movement. @@ -125,26 +125,26 @@ only takes effect if the pointer moves more than threshold pixels at once and only applies to the amount beyond the value in the threshold argument. Setting a value to \-1 restores the default. The values of the do_accel and do_threshold arguments must be -.ZN True +.B True for the pointer values to be set, or the parameters are unchanged. Negative values (other than \-1) generate a -.ZN BadValue +.B BadValue error, as does a zero value for the accel_denominator argument. .LP -.ZN XChangePointerControl +.B XChangePointerControl can generate a -.ZN BadValue +.B BadValue error. .LP The -.ZN XGetPointerControl +.B XGetPointerControl function returns the pointer's current acceleration multiplier and acceleration threshold. .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XChangeSaveSet.man b/man/XChangeSaveSet.man index 5de9f37e..0cbee57d 100644 --- a/man/XChangeSaveSet.man +++ b/man/XChangeSaveSet.man @@ -92,72 +92,72 @@ int XRemoveFromSaveSet\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); .IP \fIchange_mode\fP 1i Specifies the mode. You can pass -.ZN SetModeInsert +.B SetModeInsert or -.ZN SetModeDelete . +.BR SetModeDelete . .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIw\fP 1i Specifies the window that you want to add or delete from the client's save-set. .SH DESCRIPTION Depending on the specified mode, -.ZN XChangeSaveSet +.B XChangeSaveSet either inserts or deletes the specified window from the client's save-set. The specified window must have been created by some other client, or a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XChangeSaveSet +.B XChangeSaveSet can generate -.ZN BadMatch , -.ZN BadValue , +.BR BadMatch , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XAddToSaveSet +.B XAddToSaveSet function adds the specified window to the client's save-set. The specified window must have been created by some other client, or a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XAddToSaveSet +.B XAddToSaveSet can generate -.ZN BadMatch +.B BadMatch and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XRemoveFromSaveSet +.B XRemoveFromSaveSet function removes the specified window from the client's save-set. The specified window must have been created by some other client, or a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XRemoveFromSaveSet +.B XRemoveFromSaveSet can generate -.ZN BadMatch +.B BadMatch and -.ZN BadWindow +.B BadWindow errors. .SH DIAGNOSTICS .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XReparentWindow(__libmansuffix__) diff --git a/man/XChangeWindowAttributes.man b/man/XChangeWindowAttributes.man index 9075d557..88da231e 100644 --- a/man/XChangeWindowAttributes.man +++ b/man/XChangeWindowAttributes.man @@ -105,14 +105,14 @@ set to indicate which attributes have been set in the structure. Specifies the pixel that is to be used for the background. .IP \fIbackground_pixmap\fP 1i Specifies the background pixmap, -.ZN ParentRelative , +.BR ParentRelative , or -.ZN None . +.BR None . .IP \fIborder_pixel\fP 1i Specifies the entry in the colormap. .IP \fIborder_pixmap\fP 1i Specifies the border pixmap or -.ZN CopyFromParent . +.BR CopyFromParent . .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIvaluemask\fP 1i @@ -128,42 +128,42 @@ Specifies the colormap. .SH DESCRIPTION Depending on the valuemask, the -.ZN XChangeWindowAttributes +.B XChangeWindowAttributes function uses the window attributes in the -.ZN XSetWindowAttributes +.B XSetWindowAttributes structure to change the specified window attributes. Changing the background does not cause the window contents to be changed. To repaint the window and its background, use -.ZN XClearWindow . +.BR XClearWindow . Setting the border or changing the background such that the border tile origin changes causes the border to be repainted. Changing the background of a root window to -.ZN None +.B None or -.ZN ParentRelative +.B ParentRelative restores the default background pixmap. Changing the border of a root window to -.ZN CopyFromParent +.B CopyFromParent restores the default border pixmap. Changing the win-gravity does not affect the current position of the window. Changing the backing-store of an obscured window to -.ZN WhenMapped +.B WhenMapped or -.ZN Always , +.BR Always , or changing the backing-planes, backing-pixel, or save-under of a mapped window may have no immediate effect. Changing the colormap of a window (that is, defining a new map, not changing the contents of the existing map) generates a -.ZN ColormapNotify +.B ColormapNotify event. Changing the colormap of a visible window may have no immediate effect on the screen because the map may not be installed (see -.ZN XInstallColormap ). +.BR XInstallColormap ). Changing the cursor of a root window to -.ZN None +.B None restores the default cursor. Whenever possible, you are encouraged to share colormaps. @@ -173,164 +173,164 @@ Their event masks are maintained separately. When an event is generated, it is reported to all interested clients. However, only one client at a time can select for -.ZN SubstructureRedirectMask , -.ZN ResizeRedirectMask , +.BR SubstructureRedirectMask , +.BR ResizeRedirectMask , and -.ZN ButtonPressMask . +.BR ButtonPressMask . If a client attempts to select any of these event masks and some other client has already selected one, a -.ZN BadAccess +.B BadAccess error results. There is only one do-not-propagate-mask for a window, not one per client. .LP -.ZN XChangeWindowAttributes +.B XChangeWindowAttributes can generate -.ZN BadAccess , -.ZN BadColor , -.ZN BadCursor , -.ZN BadMatch , -.ZN BadPixmap , -.ZN BadValue , +.BR BadAccess , +.BR BadColor , +.BR BadCursor , +.BR BadMatch , +.BR BadPixmap , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XSetWindowBackground +.B XSetWindowBackground function sets the background of the window to the specified pixel value. Changing the background does not cause the window contents to be changed. -.ZN XSetWindowBackground +.B XSetWindowBackground uses a pixmap of undefined size filled with the pixel value you passed. If you try to change the background of an -.ZN InputOnly +.B InputOnly window, a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XSetWindowBackground +.B XSetWindowBackground can generate -.ZN BadMatch +.B BadMatch and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XSetWindowBackgroundPixmap +.B XSetWindowBackgroundPixmap function sets the background pixmap of the window to the specified pixmap. The background pixmap can immediately be freed if no further explicit references to it are to be made. If -.ZN ParentRelative +.B ParentRelative is specified, the background pixmap of the window's parent is used, or on the root window, the default background is restored. If you try to change the background of an -.ZN InputOnly +.B InputOnly window, a -.ZN BadMatch +.B BadMatch error results. If the background is set to -.ZN None , +.BR None , the window has no defined background. .LP -.ZN XSetWindowBackgroundPixmap +.B XSetWindowBackgroundPixmap can generate -.ZN BadMatch , -.ZN BadPixmap , +.BR BadMatch , +.BR BadPixmap , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XSetWindowBorder +.B XSetWindowBorder function sets the border of the window to the pixel value you specify. If you attempt to perform this on an -.ZN InputOnly +.B InputOnly window, a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XSetWindowBorder +.B XSetWindowBorder can generate -.ZN BadMatch +.B BadMatch and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XSetWindowBorderPixmap +.B XSetWindowBorderPixmap function sets the border pixmap of the window to the pixmap you specify. The border pixmap can be freed immediately if no further explicit references to it are to be made. If you specify -.ZN CopyFromParent , +.BR CopyFromParent , a copy of the parent window's border pixmap is used. If you attempt to perform this on an -.ZN InputOnly +.B InputOnly window, a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XSetWindowBorderPixmap +.B XSetWindowBorderPixmap can generate -.ZN BadMatch , -.ZN BadPixmap , +.BR BadMatch , +.BR BadPixmap , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XSetWindowColormap +.B XSetWindowColormap function sets the specified colormap of the specified window. The colormap must have the same visual type as the window, or a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XSetWindowColormap +.B XSetWindowColormap can generate -.ZN BadColor , -.ZN BadMatch , +.BR BadColor , +.BR BadMatch , and -.ZN BadWindow +.B BadWindow errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to free a color map entry that it did not already allocate. .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to store into a read-only color map entry. .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadCursor +.B BadCursor A value for a Cursor argument does not name a defined Cursor. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window locks this attribute. .TP 1i -.ZN BadPixmap +.B BadPixmap A value for a Pixmap argument does not name a defined Pixmap. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XConfigureWindow(__libmansuffix__), diff --git a/man/XCirculateEvent.man b/man/XCirculateEvent.man index e5f41cfe..ae130d7b 100644 --- a/man/XCirculateEvent.man +++ b/man/XCirculateEvent.man @@ -83,7 +83,7 @@ XCirculateEvent \- CirculateNotify event structure .SH STRUCTURES The structure for -.ZN CirculateNotify +.B CirculateNotify events contains: .LP .Ds 0 @@ -104,16 +104,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -122,21 +122,21 @@ dispatchers. .LP The event member is set either to the restacked window or to its parent, depending on whether -.ZN StructureNotify +.B StructureNotify or -.ZN SubstructureNotify +.B SubstructureNotify was selected. The window member is set to the window that was restacked. The place member is set to the window's position after the restack occurs and is either -.ZN PlaceOnTop +.B PlaceOnTop or -.ZN PlaceOnBottom . +.BR PlaceOnBottom . If it is -.ZN PlaceOnTop , +.BR PlaceOnTop , the window is now on top of all siblings. If it is -.ZN PlaceOnBottom , +.BR PlaceOnBottom , the window is now below all siblings. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/man/XCirculateRequestEvent.man b/man/XCirculateRequestEvent.man index 146a71ee..f8f2c3f5 100644 --- a/man/XCirculateRequestEvent.man +++ b/man/XCirculateRequestEvent.man @@ -83,7 +83,7 @@ XCirculateRequestEvent \- CirculateRequest event structure .SH STRUCTURES The structure for -.ZN CirculateRequest +.B CirculateRequest events contains: .LP .Ds 0 @@ -104,16 +104,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -124,14 +124,14 @@ The parent member is set to the parent window. The window member is set to the subwindow to be restacked. The place member is set to what the new position in the stacking order should be and is either -.ZN PlaceOnTop +.B PlaceOnTop or -.ZN PlaceOnBottom . +.BR PlaceOnBottom . If it is -.ZN PlaceOnTop , +.BR PlaceOnTop , the subwindow should be on top of all siblings. If it is -.ZN PlaceOnBottom , +.BR PlaceOnBottom , the subwindow should be below all siblings. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/man/XClearArea.man b/man/XClearArea.man index 26fa8557..34655942 100644 --- a/man/XClearArea.man +++ b/man/XClearArea.man @@ -93,7 +93,7 @@ int XClearWindow\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); Specifies the connection to the X server. .IP \fIexposures\fP 1i Specifies a Boolean value that indicates if -.ZN Expose +.B Expose events are to be generated. .IP \fIw\fP 1i Specifies the window. @@ -111,11 +111,11 @@ Specify the x and y coordinates, which are relative to the origin of the window and specify the upper-left corner of the rectangle. .SH DESCRIPTION The -.ZN XClearArea +.B XClearArea function paints a rectangular area in the specified window according to the specified dimensions with the window's background pixel or pixmap. The subwindow-mode effectively is -.ZN ClipByChildren . +.BR ClipByChildren . If width is zero, it is replaced with the current width of the window minus x. If height is @@ -124,70 +124,70 @@ If the window has a defined background tile, the rectangle clipped by any children is filled with this tile. If the window has background -.ZN None , +.BR None , the contents of the window are not changed. In either case, if exposures is -.ZN True , +.BR True , one or more -.ZN Expose +.B Expose events are generated for regions of the rectangle that are either visible or are being retained in a backing store. If you specify a window whose class is -.ZN InputOnly , +.BR InputOnly , a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XClearArea +.B XClearArea can generate -.ZN BadMatch , -.ZN BadValue , +.BR BadMatch , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XClearWindow +.B XClearWindow function clears the entire area in the specified window and is equivalent to -.ZN XClearArea +.B XClearArea (display, w, 0, 0, 0, 0, -.ZN False ). +.BR False ). If the window has a defined background tile, the rectangle is tiled with a plane-mask of all ones and -.ZN GXcopy +.B GXcopy function. If the window has background -.ZN None , +.BR None , the contents of the window are not changed. If you specify a window whose class is -.ZN InputOnly , +.BR InputOnly , a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XClearWindow +.B XClearWindow can generate -.ZN BadMatch +.B BadMatch and -.ZN BadWindow +.B BadWindow errors. .SH DIAGNOSTICS .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XCopyArea(__libmansuffix__) diff --git a/man/XClientMessageEvent.man b/man/XClientMessageEvent.man index fc421149..b6d51070 100644 --- a/man/XClientMessageEvent.man +++ b/man/XClientMessageEvent.man @@ -83,7 +83,7 @@ XClientMessageEvent \- ClientMessage event structure .SH STRUCTURES The structure for -.ZN ClientMessage +.B ClientMessage events contains: .LP .Ds 0 @@ -109,16 +109,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. diff --git a/man/XColormapEvent.man b/man/XColormapEvent.man index f793ac75..847a407e 100644 --- a/man/XColormapEvent.man +++ b/man/XColormapEvent.man @@ -83,7 +83,7 @@ XColormapEvent \- ColormapNotify event structure .SH STRUCTURES The structure for -.ZN ColormapNotify +.B ColormapNotify events contains: .LP .Ds 0 @@ -105,16 +105,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -126,26 +126,26 @@ colormap is changed, installed, or uninstalled. For a colormap that is changed, installed, or uninstalled, the colormap member is set to the colormap associated with the window. For a colormap that is changed by a call to -.ZN XFreeColormap , +.BR XFreeColormap , the colormap member is set to -.ZN None . +.BR None . The new member is set to indicate whether the colormap for the specified window was changed or installed or uninstalled and can be -.ZN True +.B True or -.ZN False . +.BR False . If it is -.ZN True , +.BR True , the colormap was changed. If it is -.ZN False , +.BR False , the colormap was installed or uninstalled. The state member is always set to indicate whether the colormap is installed or uninstalled and can be -.ZN ColormapInstalled +.B ColormapInstalled or -.ZN ColormapUninstalled . +.BR ColormapUninstalled . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/man/XConfigureEvent.man b/man/XConfigureEvent.man index 103e3da9..31bb4cc6 100644 --- a/man/XConfigureEvent.man +++ b/man/XConfigureEvent.man @@ -83,7 +83,7 @@ XConfigureEvent \- ConfigureNotify event structure .SH STRUCTURES The structure for -.ZN ConfigureNotify +.B ConfigureNotify events contains: .LP .Ds 0 @@ -108,16 +108,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -126,9 +126,9 @@ dispatchers. .LP The event member is set either to the reconfigured window or to its parent, depending on whether -.ZN StructureNotify +.B StructureNotify or -.ZN SubstructureNotify +.B SubstructureNotify was selected. The window member is set to the window whose size, position, border, and/or stacking @@ -144,7 +144,7 @@ The border_width member is set to the width of the window's border, in pixels. The above member is set to the sibling window and is used for stacking operations. If the X server sets this member to -.ZN None , +.BR None , the window whose state was changed is on the bottom of the stack with respect to sibling windows. However, if this member is set to a sibling window, @@ -155,7 +155,7 @@ window. Window manager clients normally should ignore this window if the override_redirect member is -.ZN True . +.BR True . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/man/XConfigureRequestEvent.man b/man/XConfigureRequestEvent.man index 520e3f83..a4174473 100644 --- a/man/XConfigureRequestEvent.man +++ b/man/XConfigureRequestEvent.man @@ -83,7 +83,7 @@ XConfigureRequestEvent \- ConfigureRequest event structure .SH STRUCTURES The structure for -.ZN ConfigureRequest +.B ConfigureRequest events contains: .LP .Ds 0 @@ -109,16 +109,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -129,15 +129,15 @@ The parent member is set to the parent window. The window member is set to the window whose size, position, border width, and/or stacking order is to be reconfigured. The value_mask member indicates which components were specified in the -.ZN ConfigureWindow +.B ConfigureWindow protocol request. The corresponding values are reported as given in the request. The remaining values are filled in from the current geometry of the window, except in the case of above (sibling) and detail (stack-mode), which are reported as -.ZN None +.B None and -.ZN Above , +.BR Above , respectively, if they are not given in the request. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/man/XConfigureWindow.man b/man/XConfigureWindow.man index 69f22328..c5d71667 100644 --- a/man/XConfigureWindow.man +++ b/man/XConfigureWindow.man @@ -106,7 +106,7 @@ the values structure. This mask is the bitwise inclusive OR of the valid configure window values bits. .IP \fIvalues\fP 1i Specifies the -.ZN XWindowChanges +.B XWindowChanges structure. .IP \fIw\fP 1i Specifies the window to be reconfigured, moved, or resized.. @@ -126,41 +126,41 @@ of the window's border or the window itself if it has no border or define the new position of the window relative to its parent. .SH DESCRIPTION The -.ZN XConfigureWindow +.B XConfigureWindow function uses the values specified in the -.ZN XWindowChanges +.B XWindowChanges structure to reconfigure a window's size, position, border, and stacking order. Values not specified are taken from the existing geometry of the window. .LP If a sibling is specified without a stack_mode or if the window is not actually a sibling, a -.ZN BadMatch +.B BadMatch error results. Note that the computations for -.ZN BottomIf , -.ZN TopIf , +.BR BottomIf , +.BR TopIf , and -.ZN Opposite +.B Opposite are performed with respect to the window's final geometry (as controlled by the other arguments passed to -.ZN XConfigureWindow ), +.BR XConfigureWindow ), not its initial geometry. Any backing store contents of the window, its inferiors, and other newly visible windows are either discarded or changed to reflect the current screen contents (depending on the implementation). .LP -.ZN XConfigureWindow +.B XConfigureWindow can generate -.ZN BadMatch , -.ZN BadValue , +.BR BadMatch , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XMoveWindow +.B XMoveWindow function moves the specified window to the specified x and y coordinates, but it does not change the window's size, raise the window, or change the mapping state of the window. @@ -169,102 +169,102 @@ depending on if the window is obscured by nonchildren and if no backing store exists. If the contents of the window are lost, the X server generates -.ZN Expose +.B Expose events. Moving a mapped window generates -.ZN Expose +.B Expose events on any formerly obscured windows. .LP If the override-redirect flag of the window is -.ZN False +.B False and some other client has selected -.ZN SubstructureRedirectMask +.B SubstructureRedirectMask on the parent, the X server generates a -.ZN ConfigureRequest +.B ConfigureRequest event, and no further processing is performed. Otherwise, the window is moved. .LP -.ZN XMoveWindow +.B XMoveWindow can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XResizeWindow +.B XResizeWindow function changes the inside dimensions of the specified window, not including its borders. This function does not change the window's upper-left coordinate or the origin and does not restack the window. Changing the size of a mapped window may lose its contents and generate -.ZN Expose +.B Expose events. If a mapped window is made smaller, changing its size generates -.ZN Expose +.B Expose events on windows that the mapped window formerly obscured. .LP If the override-redirect flag of the window is -.ZN False +.B False and some other client has selected -.ZN SubstructureRedirectMask +.B SubstructureRedirectMask on the parent, the X server generates a -.ZN ConfigureRequest +.B ConfigureRequest event, and no further processing is performed. If either width or height is zero, a -.ZN BadValue +.B BadValue error results. .LP -.ZN XResizeWindow +.B XResizeWindow can generate -.ZN BadValue +.B BadValue and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XMoveResizeWindow +.B XMoveResizeWindow function changes the size and location of the specified window without raising it. Moving and resizing a mapped window may generate an -.ZN Expose +.B Expose event on the window. Depending on the new size and location parameters, moving and resizing a window may generate -.ZN Expose +.B Expose events on windows that the window formerly obscured. .LP If the override-redirect flag of the window is -.ZN False +.B False and some other client has selected -.ZN SubstructureRedirectMask +.B SubstructureRedirectMask on the parent, the X server generates a -.ZN ConfigureRequest +.B ConfigureRequest event, and no further processing is performed. Otherwise, the window size and location are changed. .LP -.ZN XMoveResizeWindow +.B XMoveResizeWindow can generate -.ZN BadValue +.B BadValue and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XSetWindowBorderWidth +.B XSetWindowBorderWidth function sets the specified window's border width to the specified width. .LP -.ZN XSetWindowBorderWidth +.B XSetWindowBorderWidth can generate a -.ZN BadWindow +.B BadWindow error. .SH STRUCTURES The -.ZN XWindowChanges +.B XWindowChanges structure contains: .LP .LP @@ -274,49 +274,49 @@ lw(.5i) lw(2.5i) lw(.8i). T{ \&#define T} T{ -.ZN CWX +.B CWX T} T{ (1<<0) T} T{ \&#define T} T{ -.ZN CWY +.B CWY T} T{ (1<<1) T} T{ \&#define T} T{ -.ZN CWWidth +.B CWWidth T} T{ (1<<2) T} T{ \&#define T} T{ -.ZN CWHeight +.B CWHeight T} T{ (1<<3) T} T{ \&#define T} T{ -.ZN CWBorderWidth +.B CWBorderWidth T} T{ (1<<4) T} T{ \&#define T} T{ -.ZN CWSibling +.B CWSibling T} T{ (1<<5) T} T{ \&#define T} T{ -.ZN CWStackMode +.B CWStackMode T} T{ (1<<6) T} @@ -339,7 +339,7 @@ which are relative to the parent's origin and indicate the position of the upper-left outer corner of the window. The width and height members are used to set the inside size of the window, not including the border, and must be nonzero, or a -.ZN BadValue +.B BadValue error results. Attempts to configure a root window have no effect. .LP @@ -347,38 +347,38 @@ The border_width member is used to set the width of the border in pixels. Note that setting just the border width leaves the outer-left corner of the window in a fixed position but moves the absolute position of the window's origin. If you attempt to set the border-width attribute of an -.ZN InputOnly +.B InputOnly window nonzero, a -.ZN BadMatch +.B BadMatch error results. .LP The sibling member is used to set the sibling window for stacking operations. The stack_mode member is used to set how the window is to be restacked and can be set to -.ZN Above , -.ZN Below , -.ZN TopIf , -.ZN BottomIf , +.BR Above , +.BR Below , +.BR TopIf , +.BR BottomIf , or -.ZN Opposite . +.BR Opposite . .SH DIAGNOSTICS .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XChangeWindowAttributes(__libmansuffix__), diff --git a/man/XCopyArea.man b/man/XCopyArea.man index 7bfe99aa..f9bd1fa6 100644 --- a/man/XCopyArea.man +++ b/man/XCopyArea.man @@ -125,12 +125,12 @@ Specify the width and height, which are the dimensions of both the source and destination rectangles. .SH DESCRIPTION The -.ZN XCopyArea +.B XCopyArea function combines the specified rectangle of src with the specified rectangle of dest. The drawables must have the same root and depth, or a -.ZN BadMatch +.B BadMatch error results. .LP If regions of the source rectangle are obscured and have not been @@ -141,99 +141,99 @@ Instead, the following occurs on all corresponding destination regions that are either visible or are retained in backing store. If the destination is a window with a background other than -.ZN None , +.BR None , corresponding regions of the destination are tiled with that background (with plane-mask of all ones and -.ZN GXcopy +.B GXcopy function). Regardless of tiling or whether the destination is a window or a pixmap, if graphics-exposures is -.ZN True , +.BR True , then -.ZN GraphicsExpose +.B GraphicsExpose events for all corresponding destination regions are generated. If graphics-exposures is -.ZN True +.B True but no -.ZN GraphicsExpose +.B GraphicsExpose events are generated, a -.ZN NoExpose +.B NoExpose event is generated. Note that by default graphics-exposures is -.ZN True +.B True in new GCs. .LP This function uses these GC components: function, plane-mask, subwindow-mode, graphics-exposures, clip-x-origin, clip-y-origin, and clip-mask. .LP -.ZN XCopyArea +.B XCopyArea can generate -.ZN BadDrawable , -.ZN BadGC , +.BR BadDrawable , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. .LP The -.ZN XCopyPlane +.B XCopyPlane function uses a single bit plane of the specified source rectangle combined with the specified GC to modify the specified rectangle of dest. The drawables must have the same root but need not have the same depth. If the drawables do not have the same root, a -.ZN BadMatch +.B BadMatch error results. If plane does not have exactly one bit set to 1 and the value of plane is not less than %2 sup n%, where \fIn\fP is the depth of src, a -.ZN BadValue +.B BadValue error results. .LP Effectively, -.ZN XCopyPlane +.B XCopyPlane forms a pixmap of the same depth as the rectangle of dest and with a size specified by the source region. It uses the foreground/background pixels in the GC (foreground everywhere the bit plane in src contains a bit set to 1, background everywhere the bit plane in src contains a bit set to 0) and the equivalent of a -.ZN CopyArea +.B CopyArea protocol request is performed with all the same exposure semantics. This can also be thought of as using the specified region of the source bit plane as a stipple with a fill-style of -.ZN FillOpaqueStippled +.B FillOpaqueStippled for filling a rectangular area of the destination. .LP This function uses these GC components: function, plane-mask, foreground, background, subwindow-mode, graphics-exposures, clip-x-origin, clip-y-origin, and clip-mask. .LP -.ZN XCopyPlane +.B XCopyPlane can generate -.ZN BadDrawable , -.ZN BadGC , -.ZN BadMatch , +.BR BadDrawable , +.BR BadGC , +.BR BadMatch , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XCreateColormap.man b/man/XCreateColormap.man index 5dd06b6e..8c63874d 100644 --- a/man/XCreateColormap.man +++ b/man/XCreateColormap.man @@ -94,9 +94,9 @@ int XFreeColormap\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^); .IP \fIalloc\fP 1i Specifies the colormap entries to be allocated. You can pass -.ZN AllocNone +.B AllocNone or -.ZN AllocAll . +.BR AllocAll . .IP \fIcolormap\fP 1i Specifies the colormap that you want to create, copy, set, or destroy. .IP \fIdisplay\fP 1i @@ -105,13 +105,13 @@ Specifies the connection to the X server. Specifies a visual type supported on the screen. If the visual type is not one supported by the screen, a -.ZN BadMatch +.B BadMatch error results. .IP \fIw\fP 1i Specifies the window on whose screen you want to create a colormap. .SH DESCRIPTION The -.ZN XCreateColormap +.B XCreateColormap function creates a colormap of the specified visual type for the screen on which the specified window resides and returns the colormap ID associated with it. @@ -119,69 +119,69 @@ Note that the specified window is only used to determine the screen. .LP The initial values of the colormap entries are undefined for the visual classes -.ZN GrayScale , -.ZN PseudoColor , +.BR GrayScale , +.BR PseudoColor , and -.ZN DirectColor . +.BR DirectColor . For -.ZN StaticGray , -.ZN StaticColor , +.BR StaticGray , +.BR StaticColor , and -.ZN TrueColor , +.BR TrueColor , the entries have defined values, but those values are specific to the visual and are not defined by X. For -.ZN StaticGray , -.ZN StaticColor , +.BR StaticGray , +.BR StaticColor , and -.ZN TrueColor , +.BR TrueColor , alloc must be -.ZN AllocNone , +.BR AllocNone , or a -.ZN BadMatch +.B BadMatch error results. For the other visual classes, if alloc is -.ZN AllocNone , +.BR AllocNone , the colormap initially has no allocated entries, and clients can allocate them. For information about the visual types, see section 3.1. .LP If alloc is -.ZN AllocAll , +.BR AllocAll , the entire colormap is allocated writable. The initial values of all allocated entries are undefined. For -.ZN GrayScale +.B GrayScale and -.ZN PseudoColor , +.BR PseudoColor , the effect is as if an -.ZN XAllocColorCells +.B XAllocColorCells call returned all pixel values from zero to N \- 1, where N is the colormap entries value in the specified visual. For -.ZN DirectColor , +.BR DirectColor , the effect is as if an -.ZN XAllocColorPlanes +.B XAllocColorPlanes call returned a pixel value of zero and red_mask, green_mask, and blue_mask values containing the same bits as the corresponding masks in the specified visual. However, in all cases, none of these entries can be freed by using -.ZN XFreeColors . +.BR XFreeColors . .LP -.ZN XCreateColormap +.B XCreateColormap can generate -.ZN BadAlloc , -.ZN BadMatch , -.ZN BadValue , +.BR BadAlloc , +.BR BadMatch , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XCopyColormapAndFree +.B XCopyColormapAndFree function creates a colormap of the same visual type and for the same screen as the specified colormap and returns the new colormap ID. It also moves all of the client's existing allocation from the specified @@ -190,58 +190,58 @@ and their read-only or writable characteristics intact and frees those entries in the specified colormap. Color values in other entries in the new colormap are undefined. If the specified colormap was created by the client with alloc set to -.ZN AllocAll , +.BR AllocAll , the new colormap is also created with -.ZN AllocAll , +.BR AllocAll , all color values for all entries are copied from the specified colormap, and then all entries in the specified colormap are freed. If the specified colormap was not created by the client with -.ZN AllocAll , +.BR AllocAll , the allocations to be moved are all those pixels and planes that have been allocated by the client using -.ZN XAllocColor , -.ZN XAllocNamedColor , -.ZN XAllocColorCells , +.BR XAllocColor , +.BR XAllocNamedColor , +.BR XAllocColorCells , or -.ZN XAllocColorPlanes +.B XAllocColorPlanes and that have not been freed since they were allocated. .LP -.ZN XCopyColormapAndFree +.B XCopyColormapAndFree can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadColor +.B BadColor errors. .LP The -.ZN XFreeColormap +.B XFreeColormap function deletes the association between the colormap resource ID and the colormap and frees the colormap storage. However, this function has no effect on the default colormap for a screen. If the specified colormap is an installed map for a screen, it is uninstalled (see -.ZN XUninstallColormap ). +.BR XUninstallColormap ). If the specified colormap is defined as the colormap for a window (by -.ZN XCreateWindow , -.ZN XSetWindowColormap , +.BR XCreateWindow , +.BR XSetWindowColormap , or -.ZN XChangeWindowAttributes ), -.ZN XFreeColormap +.BR XChangeWindowAttributes ), +.B XFreeColormap changes the colormap associated with the window to -.ZN None +.B None and generates a -.ZN ColormapNotify +.B ColormapNotify event. X does not define the colors displayed for a window with a colormap of -.ZN None . +.BR None . .LP -.ZN XFreeColormap +.B XFreeColormap can generate a -.ZN BadColor +.B BadColor error. .SH STRUCTURES The -.ZN XColor +.B XColor structure contains: .LP .Ds 0 @@ -263,34 +263,34 @@ and white is represented by (65535,65535,65535). In some functions, the flags member controls which of the red, green, and blue members is used and can be the inclusive OR of zero or more of -.ZN DoRed , -.ZN DoGreen , +.BR DoRed , +.BR DoGreen , and -.ZN DoBlue . +.BR DoBlue . .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocColor(__libmansuffix__), diff --git a/man/XCreateFontCursor.man b/man/XCreateFontCursor.man index bc23464f..1cc21427 100644 --- a/man/XCreateFontCursor.man +++ b/man/XCreateFontCursor.man @@ -104,12 +104,12 @@ Specifies the connection to the X server. Specifies the RGB values for the foreground of the source. .IP \fImask\fP 1i Specifies the cursor's source bits to be displayed or -.ZN None . +.BR None . .IP \fImask_char\fP 1i Specifies the glyph character for the mask. .IP \fImask_font\fP 1i Specifies the font for the mask glyph or -.ZN None . +.BR None . .IP \fIshape\fP 1i Specifies the shape of the cursor. .IP \fIsource\fP 1i @@ -136,29 +136,29 @@ to use. The hotspot comes from the information stored in the cursor font. The initial colors of a cursor are a black foreground and a white background (see -.ZN XRecolorCursor ). +.BR XRecolorCursor ). .LP -.ZN XCreateFontCursor +.B XCreateFontCursor can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XCreatePixmapCursor +.B XCreatePixmapCursor function creates a cursor and returns the cursor ID associated with it. The foreground and background RGB values must be specified using foreground_color and background_color, even if the X server only has a -.ZN StaticGray +.B StaticGray or -.ZN GrayScale +.B GrayScale screen. The foreground color is used for the pixels set to 1 in the source, and the background color is used for the pixels set to 0. Both source and mask, if specified, must have depth one (or a -.ZN BadMatch +.B BadMatch error results) but can have any root. The mask argument defines the shape of the cursor. The pixels set to 1 in the mask define which source pixels are displayed, @@ -167,11 +167,11 @@ If no mask is given, all pixels of the source are displayed. The mask, if present, must be the same size as the pixmap defined by the source argument, or a -.ZN BadMatch +.B BadMatch error results. The hotspot must be a point within the source, or a -.ZN BadMatch +.B BadMatch error results. .LP The components of the cursor can be transformed arbitrarily to meet @@ -182,27 +182,27 @@ Subsequent drawing in the source or mask pixmap has an undefined effect on the cursor. The X server might or might not make a copy of the pixmap. .LP -.ZN XCreatePixmapCursor +.B XCreatePixmapCursor can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadPixmap +.B BadPixmap errors. .LP The -.ZN XCreateGlyphCursor +.B XCreateGlyphCursor function is similar to -.ZN XCreatePixmapCursor +.B XCreatePixmapCursor except that the source and mask bitmaps are obtained from the specified font glyphs. The source_char must be a defined glyph in source_font, or a -.ZN BadValue +.B BadValue error results. If mask_font is given, mask_char must be a defined glyph in mask_font, or a -.ZN BadValue +.B BadValue error results. The mask_font and character are optional. The origins of the source_char and mask_char (if defined) glyphs are @@ -212,7 +212,7 @@ and there is no restriction on the placement of the hotspot relative to the boun boxes. If no mask_char is given, all pixels of the source are displayed. You can free the fonts immediately by calling -.ZN XFreeFont +.B XFreeFont if no further explicit references to them are to be made. .LP For 2-byte matrix fonts, @@ -220,29 +220,29 @@ the 16-bit value should be formed with the byte1 member in the most significant byte and the byte2 member in the least significant byte. .LP -.ZN XCreateGlyphCursor +.B XCreateGlyphCursor can generate -.ZN BadAlloc , -.ZN BadFont , +.BR BadAlloc , +.BR BadFont , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadFont +.B BadFont A value for a Font or GContext argument does not name a defined Font. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadPixmap +.B BadPixmap A value for a Pixmap argument does not name a defined Pixmap. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XCreateFontSet.man b/man/XCreateFontSet.man index 38cb9f3d..0d061667 100644 --- a/man/XCreateFontSet.man +++ b/man/XCreateFontSet.man @@ -103,10 +103,10 @@ Returns the number of missing charsets. Returns the missing charsets. .SH DESCRIPTION The -.ZN XCreateFontSet +.B XCreateFontSet function creates a font set for the specified display. The font set is bound to the current locale when -.ZN XCreateFontSet +.B XCreateFontSet is called. The font set may be used in subsequent calls to obtain font and character information and to image text in the locale of the font set. @@ -132,12 +132,12 @@ If a base font name is not an XLFD name, Xlib will attempt to obtain an XLFD name from the font properties for the font. If this action is successful in obtaining an XLFD name, the -.ZN XBaseFontNameListOfFontSet +.B XBaseFontNameListOfFontSet function will return this XLFD name instead of the client-supplied name. .LP Xlib uses the following algorithm to select the fonts that will be used to display text with the -.ZN XFontSet . +.BR XFontSet . .LP For each font charset required by the locale, the base font name list is searched for the first appearance of one @@ -145,9 +145,9 @@ of the following cases that names a set of fonts that exist at the server: .IP \(bu 5 The first XLFD-conforming base font name that specifies the required charset or a superset of the required charset in its -.ZN CharSetRegistry +.B CharSetRegistry and -.ZN CharSetEncoding +.B CharSetEncoding fields. The implementation may use a base font name whose specified charset is a superset of the required charset, for example, @@ -167,9 +167,9 @@ if a JIS Roman font is not available. The first XLFD-conforming font name or the first non-XLFD font name for which an XLFD font name can be obtained, combined with the required charset (replacing the -.ZN CharSetRegistry +.B CharSetRegistry and -.ZN CharSetEncoding +.B CharSetEncoding fields in the XLFD font name). As in case 1, the implementation may use a charset that is a superset @@ -220,23 +220,23 @@ For example: .De .LP If -.ZN XCreateFontSet +.B XCreateFontSet is unable to create the font set, either because there is insufficient memory or because the current locale is not supported, -.ZN XCreateFontSet +.B XCreateFontSet returns NULL, missing_charset_list_return is set to NULL, and missing_charset_count_return is set to zero. If fonts exist for all of the charsets required by the current locale, -.ZN XCreateFontSet +.B XCreateFontSet returns a valid -.ZN XFontSet , +.BR XFontSet , missing_charset_list_return is set to NULL, and missing_charset_count_return is set to zero. .LP If no font exists for one or more of the required charsets, -.ZN XCreateFontSet +.B XCreateFontSet sets missing_charset_list_return to a list of one or more null-terminated charset names for which no font exists and sets missing_charset_count_return to the number of missing fonts. @@ -247,23 +247,23 @@ may be able to remap a required charset. If no font exists for any of the required charsets or if the locale definition in Xlib requires that a font exist for a particular charset and a font is not found for that charset, -.ZN XCreateFontSet +.B XCreateFontSet returns NULL. Otherwise, -.ZN XCreateFontSet +.B XCreateFontSet returns a valid -.ZN XFontSet +.B XFontSet to font_set. .LP When an Xmb/wc drawing or measuring function is called with an -.ZN XFontSet +.B XFontSet that has missing charsets, some characters in the locale will not be drawable. If def_string_return is non-NULL, -.ZN XCreateFontSet +.B XCreateFontSet returns a pointer to a string that represents the glyphs that are drawn with this -.ZN XFontSet +.B XFontSet when the charsets of the available fonts do not include all font glyphs required to draw a codepoint. The string does not necessarily consist of valid characters @@ -271,16 +271,16 @@ in the current locale and is not necessarily drawn with the fonts loaded for the font set, but the client can draw and measure the default glyphs by including this string in a string being drawn or measured with the -.ZN XFontSet . +.BR XFontSet . .LP If the string returned to def_string_return is the empty string ("\^"), no glyphs are drawn, and the escapement is zero. The returned string is null-terminated. It is owned by Xlib and should not be modified or freed by the client. It will be freed by a call to -.ZN XFreeFontSet +.B XFreeFontSet with the associated -.ZN XFontSet . +.BR XFontSet . Until freed, its contents will not be modified by Xlib. .LP The client is responsible for constructing an error message from the @@ -288,23 +288,23 @@ missing charset and default string information and may choose to continue operation in the case that some fonts did not exist. .LP The returned -.ZN XFontSet +.B XFontSet and missing charset list should be freed with -.ZN XFreeFontSet +.B XFreeFontSet and -.ZN XFreeStringList , +.BR XFreeStringList , respectively. The client-supplied base_font_name_list may be freed by the client after calling -.ZN XCreateFontSet . +.BR XCreateFontSet . .LP The -.ZN XFreeFontSet +.B XFreeFontSet function frees the specified font set. The associated base font name list, font name list, -.ZN XFontStruct +.B XFontStruct list, and -.ZN XFontSetExtents , +.BR XFontSetExtents , if any, are freed. .SH "SEE ALSO" XExtentsofFontSet(__libmansuffix__), diff --git a/man/XCreateGC.man b/man/XCreateGC.man index a45368aa..c484e232 100644 --- a/man/XCreateGC.man +++ b/man/XCreateGC.man @@ -119,248 +119,248 @@ GC component mask bits. Specifies any values as specified by the valuemask. .IP \fIvalues_return\fP 1i Returns the GC values in the specified -.ZN XGCValues +.B XGCValues structure. .SH DESCRIPTION The -.ZN XCreateGC +.B XCreateGC function creates a graphics context and returns a GC. The GC can be used with any destination drawable having the same root and depth as the specified drawable. Use with other drawables results in a -.ZN BadMatch +.B BadMatch error. .LP -.ZN XCreateGC +.B XCreateGC can generate -.ZN BadAlloc , -.ZN BadDrawable , -.ZN BadFont , -.ZN BadMatch , -.ZN BadPixmap , +.BR BadAlloc , +.BR BadDrawable , +.BR BadFont , +.BR BadMatch , +.BR BadPixmap , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XCopyGC +.B XCopyGC function copies the specified components from the source GC to the destination GC. The source and destination GCs must have the same root and depth, or a -.ZN BadMatch +.B BadMatch error results. The valuemask specifies which component to copy, as for -.ZN XCreateGC . +.BR XCreateGC . .LP -.ZN XCopyGC +.B XCopyGC can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. .LP The -.ZN XChangeGC +.B XChangeGC function changes the components specified by valuemask for the specified GC. The values argument contains the values to be set. The values and restrictions are the same as for -.ZN XCreateGC . +.BR XCreateGC . Changing the clip-mask overrides any previous -.ZN XSetClipRectangles +.B XSetClipRectangles request on the context. Changing the dash-offset or dash-list overrides any previous -.ZN XSetDashes +.B XSetDashes request on the context. The order in which components are verified and altered is server dependent. If an error is generated, a subset of the components may have been altered. .LP -.ZN XChangeGC +.B XChangeGC can generate -.ZN BadAlloc , -.ZN BadFont , -.ZN BadGC , -.ZN BadMatch , -.ZN BadPixmap , +.BR BadAlloc , +.BR BadFont , +.BR BadGC , +.BR BadMatch , +.BR BadPixmap , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XGetGCValues +.B XGetGCValues function returns the components specified by valuemask for the specified GC. If the valuemask contains a valid set of GC mask bits .Pn ( GCFunction , -.ZN GCPlaneMask , -.ZN GCForeground , -.ZN GCBackground , -.ZN GCLineWidth , -.ZN GCLineStyle , -.ZN GCCapStyle , -.ZN GCJoinStyle , -.ZN GCFillStyle , -.ZN GCFillRule , -.ZN GCTile , -.ZN GCStipple , -.ZN GCTileStipXOrigin , -.ZN GCTileStipYOrigin , -.ZN GCFont , -.ZN GCSubwindowMode , -.ZN GCGraphicsExposures , -.ZN GCClipXOrigin , -.ZN GCCLipYOrigin , -.ZN GCDashOffset , +.BR GCPlaneMask , +.BR GCForeground , +.BR GCBackground , +.BR GCLineWidth , +.BR GCLineStyle , +.BR GCCapStyle , +.BR GCJoinStyle , +.BR GCFillStyle , +.BR GCFillRule , +.BR GCTile , +.BR GCStipple , +.BR GCTileStipXOrigin , +.BR GCTileStipYOrigin , +.BR GCFont , +.BR GCSubwindowMode , +.BR GCGraphicsExposures , +.BR GCClipXOrigin , +.BR GCCLipYOrigin , +.BR GCDashOffset , or -.ZN GCArcMode ) +.BR GCArcMode ) and no error occurs, -.ZN XGetGCValues +.B XGetGCValues sets the requested components in values_return and returns a nonzero status. Otherwise, it returns a zero status. Note that the clip-mask and dash-list (represented by the -.ZN GCClipMask +.B GCClipMask and -.ZN GCDashList +.B GCDashList bits, respectively, in the valuemask) cannot be requested. Also note that an invalid resource ID (with one or more of the three most significant bits set to 1) will be returned for -.ZN GCFont , -.ZN GCTile , +.BR GCFont , +.BR GCTile , and -.ZN GCStipple +.B GCStipple if the component has never been explicitly set by the client. .LP The -.ZN XFreeGC +.B XFreeGC function destroys the specified GC as well as all the associated storage. .LP -.ZN XFreeGC +.B XFreeGC can generate a -.ZN BadGC +.B BadGC error. .SH STRUCTURES The -.ZN XGCValues +.B XGCValues structure contains: .LP /\&* GC attribute value mask bits */ .TS lw(.5i) lw(2.5i) lw(.75i). \&#define T{ -.ZN GCFunction +.B GCFunction T} T{ (1L<<0) T} \&#define T{ -.ZN GCPlaneMask +.B GCPlaneMask T} T{ (1L<<1) T} \&#define T{ -.ZN GCForeground +.B GCForeground T} T{ (1L<<2) T} \&#define T{ -.ZN GCBackground +.B GCBackground T} T{ (1L<<3) T} \&#define T{ -.ZN GCLineWidth +.B GCLineWidth T} T{ (1L<<4) T} \&#define T{ -.ZN GCLineStyle +.B GCLineStyle T} T{ (1L<<5) T} \&#define T{ -.ZN GCCapStyle +.B GCCapStyle T} T{ (1L<<6) T} \&#define T{ -.ZN GCJoinStyle +.B GCJoinStyle T} T{ (1L<<7) T} \&#define T{ -.ZN GCFillStyle +.B GCFillStyle T} T{ (1L<<8) T} \&#define T{ -.ZN GCFillRule +.B GCFillRule T} T{ (1L<<9) T} \&#define T{ -.ZN GCTile +.B GCTile T} T{ (1L<<10) T} \&#define T{ -.ZN GCStipple +.B GCStipple T} T{ (1L<<11) T} \&#define T{ -.ZN GCTileStipXOrigin +.B GCTileStipXOrigin T} T{ (1L<<12) T} \&#define T{ -.ZN GCTileStipYOrigin +.B GCTileStipYOrigin T} T{ (1L<<13) T} \&#define T{ -.ZN GCFont +.B GCFont T} T{ (1L<<14) T} \&#define T{ -.ZN GCSubwindowMode +.B GCSubwindowMode T} T{ (1L<<15) T} \&#define T{ -.ZN GCGraphicsExposures +.B GCGraphicsExposures T} T{ (1L<<16) T} \&#define T{ -.ZN GCClipXOrigin +.B GCClipXOrigin T} T{ (1L<<17) T} \&#define T{ -.ZN GCClipYOrigin +.B GCClipYOrigin T} T{ (1L<<18) T} \&#define T{ -.ZN GCClipMask +.B GCClipMask T} T{ (1L<<19) T} \&#define T{ -.ZN GCDashOffset +.B GCDashOffset T} T{ (1L<<20) T} \&#define T{ -.ZN GCDashList +.B GCDashList T} T{ (1L<<21) T} \&#define T{ -.ZN GCArcMode +.B GCArcMode T} T{ (1L<<22) T} @@ -401,7 +401,7 @@ The function attributes of a GC are used when you update a section of a drawable (the destination) with bits from somewhere else (the source). The function in a GC defines how the new destination bits are to be computed from the source bits and the old destination bits. -.ZN GXcopy +.B GXcopy 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. @@ -423,112 +423,112 @@ Function Name Value Operation _ .sp 6p T{ -.ZN GXclear +.B GXclear T} T{ 0x0 T} T{ 0 T} T{ -.ZN GXand +.B GXand T} T{ 0x1 T} T{ src AND dst T} T{ -.ZN GXandReverse +.B GXandReverse T} T{ 0x2 T} T{ src AND NOT dst T} T{ -.ZN GXcopy +.B GXcopy T} T{ 0x3 T} T{ src T} T{ -.ZN GXandInverted +.B GXandInverted T} T{ 0x4 T} T{ (NOT src) AND dst T} T{ -.ZN GXnoop +.B GXnoop T} T{ 0x5 T} T{ dst T} T{ -.ZN GXxor +.B GXxor T} T{ 0x6 T} T{ src XOR dst T} T{ -.ZN GXor +.B GXor T} T{ 0x7 T} T{ src OR dst T} T{ -.ZN GXnor +.B GXnor T} T{ 0x8 T} T{ (NOT src) AND (NOT dst) T} T{ -.ZN GXequiv +.B GXequiv T} T{ 0x9 T} T{ (NOT src) XOR dst T} T{ -.ZN GXinvert +.B GXinvert T} T{ 0xa T} T{ NOT dst T} T{ -.ZN GXorReverse +.B GXorReverse T} T{ 0xb T} T{ src OR (NOT dst) T} T{ -.ZN GXcopyInverted +.B GXcopyInverted T} T{ 0xc T} T{ NOT src T} T{ -.ZN GXorInverted +.B GXorInverted T} T{ 0xd T} T{ (NOT src) OR dst T} T{ -.ZN GXnand +.B GXnand T} T{ 0xe T} T{ (NOT src) OR (NOT dst) T} T{ -.ZN GXset +.B GXset T} T{ 0xf T} T{ @@ -553,7 +553,7 @@ the result is computed bitwise on corresponding bits of the pixels. That is, a Boolean operation is performed in each bit plane. The plane_mask restricts the operation to a subset of planes. A macro constant -.ZN AllPlanes +.B AllPlanes can be used to refer to all planes of the screen simultaneously. The result is computed by the following: .LP @@ -627,31 +627,31 @@ The line-style defines which sections of a line are drawn: .TS lw(1.3i) lw(4.5i). T{ -.ZN LineSolid +.B LineSolid T} T{ The full path of the line is drawn. T} .sp 6p T{ -.ZN LineDoubleDash +.B LineDoubleDash T} T{ The full path of the line is drawn, but the even dashes are filled differently from the odd dashes (see fill-style) with -.ZN CapButt +.B CapButt style used where even and odd dashes meet. T} .sp 6p T{ -.ZN LineOnOffDash +.B LineOnOffDash T} T{ Only the even dashes are drawn, and cap-style applies to all internal ends of the individual dashes, except -.ZN CapNotLast +.B CapNotLast is treated as -.ZN CapButt . +.BR CapButt . T} .TE .LP @@ -660,37 +660,37 @@ The cap-style defines how the endpoints of a path are drawn: .TS lw(1.3i) lw(4.5i). T{ -.ZN CapNotLast +.B CapNotLast T} T{ This is equivalent to -.ZN CapButt +.B CapButt except that for a line-width of zero the final endpoint is not drawn. T} .sp 6p T{ -.ZN CapButt +.B CapButt T} T{ The line is square at the endpoint (perpendicular to the slope of the line) with no projection beyond. T} .sp 6p T{ -.ZN CapRound +.B CapRound T} T{ The line has a circular arc with the diameter equal to the line-width, centered on the endpoint. (This is equivalent to -.ZN CapButt +.B CapButt for line-width of zero). T} .sp 6p T{ -.ZN CapProjecting +.B CapProjecting T} T{ The line is square at the end, but the path continues beyond the endpoint for a distance equal to half the line-width. (This is equivalent to -.ZN CapButt +.B CapButt for line-width of zero). T} .TE @@ -699,27 +699,27 @@ The join-style defines how corners are drawn for wide lines: .TS lw(1.3i) lw(4.5i). T{ -.ZN JoinMiter +.B JoinMiter T} T{ The outer edges of two lines extend to meet at an angle. However, if the angle is less than 11 degrees, then a -.ZN JoinBevel +.B JoinBevel join-style is used instead. T} .sp 6p T{ -.ZN JoinRound +.B JoinRound T} T{ The corner is a circular arc with the diameter equal to the line-width, centered on the joinpoint. T} .sp 6p T{ -.ZN JoinBevel +.B JoinBevel T} T{ The corner has -.ZN CapButt +.B CapButt endpoint styles with the triangular notch filled. T} .TE @@ -730,7 +730,7 @@ the semantics depends on the line-width and the cap-style: .TS lw(1.3i) lw(.5i) lw(4i). T{ -.ZN CapNotLast +.B CapNotLast T} T{ thin T} T{ @@ -739,7 +739,7 @@ but the desired effect is that nothing is drawn. T} .sp 6p T{ -.ZN CapButt +.B CapButt T} T{ thin T} T{ @@ -748,25 +748,25 @@ but the desired effect is that a single pixel is drawn. T} .sp 6p T{ -.ZN CapRound +.B CapRound T} T{ thin T} T{ The results are the same as for -.ZN CapButt /thin. +.BR CapButt /thin. T} .sp 6p T{ -.ZN CapProjecting +.B CapProjecting T} T{ thin T} T{ The results are the same as for -.ZN CapButt /thin. +.BR CapButt /thin. T} .sp 6p T{ -.ZN CapButt +.B CapButt T} T{ wide T} T{ @@ -774,7 +774,7 @@ Nothing is drawn. T} .sp 6p T{ -.ZN CapRound +.B CapRound T} T{ wide T} T{ @@ -783,7 +783,7 @@ with the diameter equal to the line-width. T} .sp 6p T{ -.ZN CapProjecting +.B CapProjecting T} T{ wide T} T{ @@ -810,16 +810,16 @@ origin of whatever destination drawable is specified in a graphics request. The tile pixmap must have the same root and depth as the GC, or a -.ZN BadMatch +.B BadMatch error results. The stipple pixmap must have depth one and must have the same root as the GC, or a -.ZN BadMatch +.B BadMatch error results. For stipple operations where the fill-style is -.ZN FillStippled +.B FillStippled but not -.ZN FillOpaqueStippled , +.BR FillOpaqueStippled , the stipple pattern is tiled in a single plane and acts as an additional clip mask to be ANDed with the clip-mask. Although some sizes may be faster to use than others, @@ -828,41 +828,41 @@ any size pixmap can be used for tiling or stippling. The fill-style defines the contents of the source for line, text, and fill requests. For all text and fill requests (for example, -.ZN XDrawText , -.ZN XDrawText16 , -.ZN XFillRectangle , -.ZN XFillPolygon , +.BR XDrawText , +.BR XDrawText16 , +.BR XFillRectangle , +.BR XFillPolygon , and -.ZN XFillArc ); +.BR XFillArc ); for line requests with line-style -.ZN LineSolid +.B LineSolid (for example, -.ZN XDrawLine , -.ZN XDrawSegments , -.ZN XDrawRectangle , -.ZN XDrawArc ); +.BR XDrawLine , +.BR XDrawSegments , +.BR XDrawRectangle , +.BR XDrawArc ); and for the even dashes for line requests with line-style -.ZN LineOnOffDash +.B LineOnOffDash or -.ZN LineDoubleDash , +.BR LineDoubleDash , the following apply: .TS lw(1.8i) lw(4i). T{ -.ZN FillSolid +.B FillSolid T} T{ Foreground T} .sp 6p T{ -.ZN FillTiled +.B FillTiled T} T{ Tile T} .sp 6p T{ -.ZN FillOpaqueStippled +.B FillOpaqueStippled T} T{ A tile with the same width and height as stipple, but with background everywhere stipple has a zero @@ -870,37 +870,37 @@ and with foreground everywhere stipple has a one T} .sp 6p T{ -.ZN FillStippled +.B FillStippled T} T{ Foreground masked by stipple T} .TE .LP When drawing lines with line-style -.ZN LineDoubleDash , +.BR LineDoubleDash , the odd dashes are controlled by the fill-style in the following manner: .TS lw(1.8i) lw(4i). T{ -.ZN FillSolid +.B FillSolid T} T{ Background T} .sp 6p T{ -.ZN FillTiled +.B FillTiled T} T{ Same as for even dashes T} .sp 6p T{ -.ZN FillOpaqueStippled +.B FillOpaqueStippled T} T{ Same as for even dashes T} .sp 6p T{ -.ZN FillStippled +.B FillStippled T} T{ Background masked by stipple T} @@ -925,28 +925,28 @@ of GCs. .LP The dashes value is actually a simplified form of the more general patterns that can be set with -.ZN XSetDashes . +.BR XSetDashes . Specifying a value of N is equivalent to specifying the two-element list [N, N] in -.ZN XSetDashes . +.BR XSetDashes . The value must be nonzero, or a -.ZN BadValue +.B BadValue error results. .LP The clip-mask restricts writes to the destination drawable. If the clip-mask is set to a pixmap, it must have depth one and have the same root as the GC, or a -.ZN BadMatch +.B BadMatch error results. If clip-mask is set to -.ZN None , +.BR None , the pixels are always drawn regardless of the clip origin. The clip-mask also can be set by calling the -.ZN XSetClipRectangles +.B XSetClipRectangles or -.ZN XSetRegion +.B XSetRegion functions. Only pixels where the clip-mask has a bit set to 1 are drawn. Pixels are not drawn outside the area covered by the clip-mask @@ -957,40 +957,40 @@ The clip-mask origin is interpreted relative to the origin of whatever destination drawable is specified in a graphics request. .LP You can set the subwindow-mode to -.ZN ClipByChildren +.B ClipByChildren or -.ZN IncludeInferiors . +.BR IncludeInferiors . For -.ZN ClipByChildren , +.BR ClipByChildren , both source and destination windows are additionally clipped by all viewable -.ZN InputOutput +.B InputOutput children. For -.ZN IncludeInferiors , +.BR IncludeInferiors , neither source nor destination window is clipped by inferiors. This will result in including subwindow contents in the source and drawing through subwindow boundaries of the destination. The use of -.ZN IncludeInferiors +.B IncludeInferiors on a window of one depth with mapped inferiors of differing depth is not illegal, but the semantics are undefined by the core protocol. .LP The fill-rule defines what pixels are inside (drawn) for paths given in -.ZN XFillPolygon +.B XFillPolygon requests and can be set to -.ZN EvenOddRule +.B EvenOddRule or -.ZN WindingRule . +.BR WindingRule . For -.ZN EvenOddRule , +.BR EvenOddRule , a point is inside if an infinite ray with the point as origin crosses the path an odd number of times. For -.ZN WindingRule , +.BR WindingRule , a point is inside if an infinite ray with the point as origin crosses an unequal number of clockwise and counterclockwise directed path segments. @@ -1003,9 +1003,9 @@ uninteresting because you can simply choose a different ray that is not coincident with a segment. .LP For both -.ZN EvenOddRule +.B EvenOddRule and -.ZN WindingRule , +.BR WindingRule , a point is infinitely small, and the path is an infinitely thin line. A pixel is inside if the center point of the pixel is inside @@ -1018,53 +1018,53 @@ and are inside if and only if the polygon interior is immediately below (y increasing direction). .LP The arc-mode controls filling in the -.ZN XFillArcs +.B XFillArcs function and can be set to -.ZN ArcPieSlice +.B ArcPieSlice or -.ZN ArcChord . +.BR ArcChord . For -.ZN ArcPieSlice , +.BR ArcPieSlice , the arcs are pie-slice filled. For -.ZN ArcChord , +.BR ArcChord , the arcs are chord filled. .LP The graphics-exposure flag controls -.ZN GraphicsExpose +.B GraphicsExpose event generation for -.ZN XCopyArea +.B XCopyArea and -.ZN XCopyPlane +.B XCopyPlane requests (and any similar requests defined by extensions). .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadFont +.B BadFont A value for a Font or GContext argument does not name a defined Font. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadPixmap +.B BadPixmap A value for a Pixmap argument does not name a defined Pixmap. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XCreateIC.man b/man/XCreateIC.man index 5b7c4228..e64e00ee 100644 --- a/man/XCreateIC.man +++ b/man/XCreateIC.man @@ -97,7 +97,7 @@ Specifies the input method. Specifies the variable length argument list to set XIC values. .SH DESCRIPTION The -.ZN XCreateIC +.B XCreateIC function creates a context within the specified input method. .LP Some of the arguments are mandatory at creation time, and @@ -106,47 +106,47 @@ The mandatory arguments are the input style and the set of text callbacks (if the input style selected requires callbacks). All other input context values can be set later. .LP -.ZN XCreateIC +.B XCreateIC returns a NULL value if no input context could be created. A NULL value could be returned for any of the following reasons: .IP \(bu 5 A required argument was not set. .IP \(bu 5 A read-only argument was set (for example, -.ZN XNFilterEvents ). +.BR XNFilterEvents ). .IP \(bu 5 The argument name is not recognized. .IP \(bu 5 The input method encountered an input method implementation-dependent error. .LP The -.ZN XCreateIC +.B XCreateIC can generate -.ZN BadAtom , -.ZN BadColor , -.ZN BadPixmap , +.BR BadAtom , +.BR BadColor , +.BR BadPixmap , and -.ZN BadWindow +.B BadWindow errors. .LP -.ZN XDestroyIC +.B XDestroyIC destroys the specified input context. .LP The -.ZN XIMOfIC +.B XIMOfIC function returns the input method associated with the specified input context. .SH DIAGNOSTICS .TP 1i -.ZN BadAtom +.B BadAtom A value for an Atom argument does not name a defined Atom. .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadPixmap +.B BadPixmap A value for a Pixmap argument does not name a defined Pixmap. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XOpenIM(__libmansuffix__), diff --git a/man/XCreateOC.man b/man/XCreateOC.man index 99b173b0..e37cce0f 100644 --- a/man/XCreateOC.man +++ b/man/XCreateOC.man @@ -101,14 +101,14 @@ Specifies the output method. Specifies the variable length argument list to set or get XOC values. .SH DESCRIPTION The -.ZN XCreateOC +.B XCreateOC function creates an output context within the specified output method. .LP The base font names argument is mandatory at creation time, and the output context will not be created unless it is provided. All other output context values can be set later. .LP -.ZN XCreateOC +.B XCreateOC returns NULL if no output context could be created. NULL can be returned for any of the following reasons: .IP \(bu 5 @@ -121,11 +121,11 @@ An argument name is not recognized. The output method encountered an output method implementation-dependent error. .LP The -.ZN XDestroyOC +.B XDestroyOC function destroys the specified output context. .LP The -.ZN XSetOCValues +.B XSetOCValues function returns NULL if no error occurred; otherwise, it returns the name of the first argument that could not be set. @@ -141,7 +141,7 @@ Each value to be set must be an appropriate datum, matching the data type imposed by the semantics of the argument. .LP The -.ZN XGetOCValues +.B XGetOCValues function returns NULL if no error occurred; otherwise, it returns the name of the first argument that could not be obtained. An argument might not be obtained for any of the following reasons: @@ -154,7 +154,7 @@ Each argument value following a name must point to a location where the value is to be stored. .LP The -.ZN XOMOfOC +.B XOMOfOC function returns the output method associated with the specified output context. .SH "SEE ALSO" diff --git a/man/XCreatePixmap.man b/man/XCreatePixmap.man index bebcb0fd..ad733570 100644 --- a/man/XCreatePixmap.man +++ b/man/XCreatePixmap.man @@ -104,60 +104,60 @@ Specifies the pixmap. Specify the width and height, which define the dimensions of the pixmap. .SH DESCRIPTION The -.ZN XCreatePixmap +.B XCreatePixmap function creates a pixmap of the width, height, and depth you specified and returns a pixmap ID that identifies it. It is valid to pass an -.ZN InputOnly +.B InputOnly window to the drawable argument. The width and height arguments must be nonzero, or a -.ZN BadValue +.B BadValue error results. The depth argument must be one of the depths supported by the screen of the specified drawable, or a -.ZN BadValue +.B BadValue error results. .LP The server uses the specified drawable to determine on which screen to create the pixmap. The pixmap can be used only on this screen and only with other drawables of the same depth (see -.ZN XCopyPlane +.B XCopyPlane for an exception to this rule). The initial contents of the pixmap are undefined. .LP -.ZN XCreatePixmap +.B XCreatePixmap can generate -.ZN BadAlloc , -.ZN BadDrawable , +.BR BadAlloc , +.BR BadDrawable , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XFreePixmap +.B XFreePixmap function first deletes the association between the pixmap ID and the pixmap. Then, the X server frees the pixmap storage when there are no references to it. The pixmap should never be referenced again. .LP -.ZN XFreePixmap +.B XFreePixmap can generate a -.ZN BadPixmap +.B BadPixmap error. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadPixmap +.B BadPixmap A value for a Pixmap argument does not name a defined Pixmap. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XCreateRegion.man b/man/XCreateRegion.man index 7759035b..42eae316 100644 --- a/man/XCreateRegion.man +++ b/man/XCreateRegion.man @@ -97,11 +97,11 @@ Specifies the GC. Specifies the region. .SH DESCRIPTION The -.ZN XCreateRegion +.B XCreateRegion function creates a new empty region. .LP The -.ZN XSetRegion +.B XSetRegion function sets the clip-mask in the GC to the specified region. The region is specified relative to the drawable's origin. The resulting GC clip origin is implementation-dependent. @@ -109,7 +109,7 @@ Once it is set in the GC, the region can be destroyed. .LP The -.ZN XDestroyRegion +.B XDestroyRegion function deallocates the storage associated with a specified region. .SH "SEE ALSO" XEmptyRegion(__libmansuffix__), diff --git a/man/XCreateWindow.man b/man/XCreateWindow.man index edf3d5fe..f2b05ed3 100644 --- a/man/XCreateWindow.man +++ b/man/XCreateWindow.man @@ -104,18 +104,18 @@ Specifies the width of the created window's border in pixels. .IP \fIclass\fP 1i Specifies the created window's class. You can pass -.ZN InputOutput , -.ZN InputOnly , +.BR InputOutput , +.BR InputOnly , or -.ZN CopyFromParent . +.BR CopyFromParent . A class of -.ZN CopyFromParent +.B CopyFromParent means the class is taken from the parent. .IP \fIdepth\fP 1i Specifies the window's depth. A depth of -.ZN CopyFromParent +.B CopyFromParent means the depth is taken from the parent. .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -130,7 +130,7 @@ the attributes are ignored and are not referenced. .IP \fIvisual\fP 1i Specifies the visual type. A visual of -.ZN CopyFromParent +.B CopyFromParent means the visual type is taken from the parent. .IP \fIwidth\fP 1i @@ -148,11 +148,11 @@ corner of the window's borders and are relative to the inside of the parent window's borders. .SH DESCRIPTION The -.ZN XCreateWindow +.B XCreateWindow function creates an unmapped subwindow for a specified parent window, returns the window ID of the created window, and causes the X server to generate a -.ZN CreateNotify +.B CreateNotify event. The created window is placed on top in the stacking order with respect to siblings. @@ -167,91 +167,91 @@ For a window, the origin is inside the border at the inside, upper-left corner. .LP The border_width for an -.ZN InputOnly +.B InputOnly window must be zero, or a -.ZN BadMatch +.B BadMatch error results. For class -.ZN InputOutput , +.BR InputOutput , the visual type and depth must be a combination supported for the screen, or a -.ZN BadMatch +.B BadMatch error results. The depth need not be the same as the parent, but the parent must not be a window of class -.ZN InputOnly , +.BR InputOnly , or a -.ZN BadMatch +.B BadMatch error results. For an -.ZN InputOnly +.B InputOnly window, the depth must be zero, and the visual must be one supported by the screen. If either condition is not met, a -.ZN BadMatch +.B BadMatch error results. The parent window, however, may have any depth and class. If you specify any invalid window attribute for a window, a -.ZN BadMatch +.B BadMatch error results. .LP The created window is not yet displayed (mapped) on the user's display. To display the window, call -.ZN XMapWindow . +.BR XMapWindow . The new window initially uses the same cursor as its parent. A new cursor can be defined for the new window by calling -.ZN XDefineCursor . +.BR XDefineCursor . .IN "Cursor" "Initial State" .IN "XDefineCursor" The window will not be visible on the screen unless it and all of its ancestors are mapped and it is not obscured by any of its ancestors. .LP -.ZN XCreateWindow +.B XCreateWindow can generate -.ZN BadAlloc -.ZN BadColor , -.ZN BadCursor , -.ZN BadMatch , -.ZN BadPixmap , -.ZN BadValue , +.B BadAlloc +.BR BadColor , +.BR BadCursor , +.BR BadMatch , +.BR BadPixmap , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XCreateSimpleWindow +.B XCreateSimpleWindow function creates an unmapped -.ZN InputOutput +.B InputOutput subwindow for a specified parent window, returns the window ID of the created window, and causes the X server to generate a -.ZN CreateNotify +.B CreateNotify event. The created window is placed on top in the stacking order with respect to siblings. Any part of the window that extends outside its parent window is clipped. The border_width for an -.ZN InputOnly +.B InputOnly window must be zero, or a -.ZN BadMatch +.B BadMatch error results. -.ZN XCreateSimpleWindow +.B XCreateSimpleWindow inherits its depth, class, and visual from its parent. All other window attributes, except background and border, have their default values. .LP -.ZN XCreateSimpleWindow +.B XCreateSimpleWindow can generate -.ZN BadAlloc , -.ZN BadMatch , -.ZN BadValue , +.BR BadAlloc , +.BR BadMatch , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .SH STRUCTURES The -.ZN XSetWindow Attributes +.BR XSetWindow Attributes structure contains: .LP .LP @@ -261,105 +261,105 @@ lw(.5i) lw(2.5i) lw(.8i). T{ \&#define T} T{ -.ZN CWBackPixmap +.B CWBackPixmap T} T{ (1L<<0) T} T{ \&#define T} T{ -.ZN CWBackPixel +.B CWBackPixel T} T{ (1L<<1) T} T{ \&#define T} T{ -.ZN CWBorderPixmap +.B CWBorderPixmap T} T{ (1L<<2) T} T{ \&#define T} T{ -.ZN CWBorderPixel +.B CWBorderPixel T} T{ (1L<<3) T} T{ \&#define T} T{ -.ZN CWBitGravity +.B CWBitGravity T} T{ (1L<<4) T} T{ \&#define T} T{ -.ZN CWWinGravity +.B CWWinGravity T} T{ (1L<<5) T} T{ \&#define T} T{ -.ZN CWBackingStore +.B CWBackingStore T} T{ (1L<<6) T} T{ \&#define T} T{ -.ZN CWBackingPlanes +.B CWBackingPlanes T} T{ (1L<<7) T} T{ \&#define T} T{ -.ZN CWBackingPixel +.B CWBackingPixel T} T{ (1L<<8) T} T{ \&#define T} T{ -.ZN CWOverrideRedirect +.B CWOverrideRedirect T} T{ (1L<<9) T} T{ \&#define T} T{ -.ZN CWSaveUnder +.B CWSaveUnder T} T{ (1L<<10) T} T{ \&#define T} T{ -.ZN CWEventMask +.B CWEventMask T} T{ (1L<<11) T} T{ \&#define T} T{ -.ZN CWDontPropagate +.B CWDontPropagate T} T{ (1L<<12) T} T{ \&#define T} T{ -.ZN CWColormap +.B CWColormap T} T{ (1L<<13) T} T{ \&#define T} T{ -.ZN CWCursor +.B CWCursor T} T{ (1L<<14) T} @@ -391,34 +391,34 @@ For a detailed explanation of the members of this structure, see \fI\*(xL\fP\^. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadCursor +.B BadCursor A value for a Cursor argument does not name a defined Cursor. .TP 1i -.ZN BadMatch +.B BadMatch The values do not exist for an -.ZN InputOnly +.B InputOnly window. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadPixmap +.B BadPixmap A value for a Pixmap argument does not name a defined Pixmap. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XChangeWindowAttributes(__libmansuffix__), diff --git a/man/XCreateWindowEvent.man b/man/XCreateWindowEvent.man index 9322bb57..d1eb2070 100644 --- a/man/XCreateWindowEvent.man +++ b/man/XCreateWindowEvent.man @@ -83,7 +83,7 @@ XCreateWindowEvent \- CreateNotify event structure .SH STRUCTURES The structure for -.ZN CreateNotify +.B CreateNotify events contains: .LP .Ds 0 @@ -107,16 +107,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -135,7 +135,7 @@ The override_redirect member is set to the override-redirect attribute of the window. Window manager clients normally should ignore this window if the override_redirect member is -.ZN True . +.BR True . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/man/XCrossingEvent.man b/man/XCrossingEvent.man index 98eaf554..8d377135 100644 --- a/man/XCrossingEvent.man +++ b/man/XCrossingEvent.man @@ -83,9 +83,9 @@ XCrossingEvent \- EnterNotify and LeaveNotify event structure .SH STRUCTURES The structure for -.ZN EnterNotify +.B EnterNotify and -.ZN LeaveNotify +.B LeaveNotify events contains: .LP .Ds 0 @@ -120,16 +120,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -137,9 +137,9 @@ The window member is set to the window that is most useful to toolkit dispatchers. .LP The window member is set to the window on which the -.ZN EnterNotify +.B EnterNotify or -.ZN LeaveNotify +.B LeaveNotify event was generated and is referred to as the event window. This is the window used by the X server to report the event, and is relative to the root @@ -148,17 +148,17 @@ The root member is set to the root window of the screen on which the event occurred. .LP For a -.ZN LeaveNotify +.B LeaveNotify event, if a child of the event window contains the initial position of the pointer, the subwindow component is set to that child. Otherwise, the X server sets the subwindow member to -.ZN None . +.BR None . For an -.ZN EnterNotify +.B EnterNotify event, if a child of the event window contains the final pointer position, the subwindow component is set to that child or -.ZN None . +.BR None . .LP The time member is set to the time when the event was generated and is expressed in milliseconds. @@ -175,27 +175,27 @@ root window's origin at the time of the event. .LP The same_screen member is set to indicate whether the event window is on the same screen as the root window and can be either -.ZN True +.B True or -.ZN False . +.BR False . If -.ZN True , +.BR True , the event and root windows are on the same screen. If -.ZN False , +.BR False , the event and root windows are not on the same screen. .LP The focus member is set to indicate whether the event window is the focus window or an inferior of the focus window. The X server can set this member to either -.ZN True +.B True or -.ZN False . +.BR False . If -.ZN True , +.BR True , the event window is the focus window or an inferior of the focus window. If -.ZN False , +.BR False , the event window is not the focus window or an inferior of the focus window. .LP The state member is set to indicate the state of the pointer buttons and @@ -203,36 +203,36 @@ modifier keys just prior to the event. The X server can set this member to the bitwise inclusive OR of one or more of the button or modifier key masks: -.ZN Button1Mask , -.ZN Button2Mask , -.ZN Button3Mask , -.ZN Button4Mask , -.ZN Button5Mask , -.ZN ShiftMask , -.ZN LockMask , -.ZN ControlMask , -.ZN Mod1Mask , -.ZN Mod2Mask , -.ZN Mod3Mask , -.ZN Mod4Mask , -.ZN Mod5Mask . +.BR Button1Mask , +.BR Button2Mask , +.BR Button3Mask , +.BR Button4Mask , +.BR Button5Mask , +.BR ShiftMask , +.BR LockMask , +.BR ControlMask , +.BR Mod1Mask , +.BR Mod2Mask , +.BR Mod3Mask , +.BR Mod4Mask , +.BR Mod5Mask . .LP The mode member is set to indicate whether the events are normal events, pseudo-motion events when a grab activates, or pseudo-motion events when a grab deactivates. The X server can set this member to -.ZN NotifyNormal , -.ZN NotifyGrab , +.BR NotifyNormal , +.BR NotifyGrab , or -.ZN NotifyUngrab . +.BR NotifyUngrab . .LP The detail member is set to indicate the notify detail and can be -.ZN NotifyAncestor , -.ZN NotifyVirtual , -.ZN NotifyInferior , -.ZN NotifyNonlinear , +.BR NotifyAncestor , +.BR NotifyVirtual , +.BR NotifyInferior , +.BR NotifyNonlinear , or -.ZN NotifyNonlinearVirtual . +.BR NotifyNonlinearVirtual . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/man/XDefineCursor.man b/man/XDefineCursor.man index 4f003cc1..478a3949 100644 --- a/man/XDefineCursor.man +++ b/man/XDefineCursor.man @@ -90,7 +90,7 @@ int XUndefineCursor\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^); .SH ARGUMENTS .IP \fIcursor\fP 1i Specifies the cursor that is to be displayed or -.ZN None . +.BR None . .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIw\fP 1i @@ -98,40 +98,40 @@ Specifies the window. .SH DESCRIPTION If a cursor is set, it will be used when the pointer is in the window. If the cursor is -.ZN None , +.BR None , it is equivalent to -.ZN XUndefineCursor . +.BR XUndefineCursor . .LP -.ZN XDefineCursor +.B XDefineCursor can generate -.ZN BadCursor +.B BadCursor and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XUndefineCursor +.B XUndefineCursor function undoes the effect of a previous -.ZN XDefineCursor +.B XDefineCursor for this window. When the pointer is in the window, the parent's cursor will now be used. On the root window, the default cursor is restored. .LP -.ZN XUndefineCursor +.B XUndefineCursor can generate a -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadCursor +.B BadCursor A value for a Cursor argument does not name a defined Cursor. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XCreateFontCursor(__libmansuffix__), diff --git a/man/XDestroyWindow.man b/man/XDestroyWindow.man index c2bffb3b..44657dd2 100644 --- a/man/XDestroyWindow.man +++ b/man/XDestroyWindow.man @@ -93,57 +93,57 @@ Specifies the connection to the X server. Specifies the window. .SH DESCRIPTION The -.ZN XDestroyWindow +.B XDestroyWindow function destroys the specified window as well as all of its subwindows and causes the X server to generate a -.ZN DestroyNotify +.B DestroyNotify event for each window. The window should never be referenced again. If the window specified by the w argument is mapped, it is unmapped automatically. The ordering of the -.ZN DestroyNotify +.B DestroyNotify events is such that for any given window being destroyed, -.ZN DestroyNotify +.B DestroyNotify is generated on any inferiors of the window before being generated on the window itself. The ordering among siblings and across subhierarchies is not otherwise constrained. If the window you specified is a root window, no windows are destroyed. Destroying a mapped window will generate -.ZN Expose +.B Expose events on other windows that were obscured by the window being destroyed. .LP -.ZN XDestroyWindow +.B XDestroyWindow can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XDestroySubwindows +.B XDestroySubwindows function destroys all inferior windows of the specified window, in bottom-to-top stacking order. It causes the X server to generate a -.ZN DestroyNotify +.B DestroyNotify event for each window. If any mapped subwindows were actually destroyed, -.ZN XDestroySubwindows +.B XDestroySubwindows causes the X server to generate -.ZN Expose +.B Expose events on the specified window. This is much more efficient than deleting many windows one at a time because much of the work need be performed only once for all of the windows, rather than for each window. The subwindows should never be referenced again. .LP -.ZN XDestroySubwindows +.B XDestroySubwindows can generate a -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XChangeWindowAttributes(__libmansuffix__), diff --git a/man/XDestroyWindowEvent.man b/man/XDestroyWindowEvent.man index 7d6753be..2fb7f09d 100644 --- a/man/XDestroyWindowEvent.man +++ b/man/XDestroyWindowEvent.man @@ -83,7 +83,7 @@ XDestroyWindowEvent \- DestroyNotify event structure .SH STRUCTURES The structure for -.ZN DestroyNotify +.B DestroyNotify events contains: .LP .Ds 0 @@ -103,16 +103,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -121,9 +121,9 @@ dispatchers. .LP The event member is set either to the destroyed window or to its parent, depending on whether -.ZN StructureNotify +.B StructureNotify or -.ZN SubstructureNotify +.B SubstructureNotify was selected. The window member is set to the window that is destroyed. .SH "SEE ALSO" diff --git a/man/XDrawArc.man b/man/XDrawArc.man index e889d312..fd813365 100644 --- a/man/XDrawArc.man +++ b/man/XDrawArc.man @@ -134,9 +134,9 @@ and specify the upper-left corner of the bounding rectangle. .EQ delim %% .EN -.ZN XDrawArc +.B XDrawArc draws a single circular or elliptical arc, and -.ZN XDrawArcs +.B XDrawArcs draws multiple circular or elliptical arcs. Each arc is specified by a rectangle and two angles. The center of the circle or ellipse is the center of the @@ -144,9 +144,9 @@ rectangle, and the major and minor axes are specified by the width and height. Positive angles indicate counterclockwise motion, and negative angles indicate clockwise motion. If the magnitude of angle2 is greater than 360 degrees, -.ZN XDrawArc +.B XDrawArc or -.ZN XDrawArcs +.B XDrawArcs truncates it to 360 degrees. .LP For an arc specified as %[ ~x, ~y, ~width , ~height, ~angle1, ~angle2 ]%, @@ -194,15 +194,15 @@ l l. .TE .LP For any given arc, -.ZN XDrawArc +.B XDrawArc and -.ZN XDrawArcs +.B XDrawArcs do not draw a pixel more than once. If two arcs join correctly and if the line-width is greater than zero and the arcs intersect, -.ZN XDrawArc +.B XDrawArc and -.ZN XDrawArcs +.B XDrawArcs do not draw a pixel more than once. Otherwise, the intersecting pixels of intersecting arcs are drawn multiple times. @@ -226,18 +226,18 @@ They also use these GC mode-dependent components: foreground, background, tile, stipple, tile-stipple-x-origin, tile-stipple-y-origin, dash-offset, and dash-list. .LP -.ZN XDrawArc +.B XDrawArc and -.ZN XDrawArcs +.B XDrawArcs can generate -.ZN BadDrawable , -.ZN BadGC , +.BR BadDrawable , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. .SH STRUCTURES The -.ZN XArc +.B XArc structure contains: .LP .EX @@ -255,18 +255,18 @@ out of the 16-bit ranges, because the protocol only has 16-bit fields for these values. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .SH "SEE ALSO" diff --git a/man/XDrawImageString.man b/man/XDrawImageString.man index f99b03aa..b2fcf794 100644 --- a/man/XDrawImageString.man +++ b/man/XDrawImageString.man @@ -110,9 +110,9 @@ origin of the specified drawable and define the origin of the first character. .SH DESCRIPTION The -.ZN XDrawImageString16 +.B XDrawImageString16 function is similar to -.ZN XDrawImageString +.B XDrawImageString except that it uses 2-byte or 16-bit characters. Both functions also use both the foreground and background pixels of the GC in the destination. @@ -140,46 +140,46 @@ font-ascent + font-descent .LP The overall-width, font-ascent, and font-descent are as would be returned by -.ZN XQueryTextExtents +.B XQueryTextExtents using gc and string. The function and fill-style defined in the GC are ignored for these functions. The effective function is -.ZN GXcopy , +.BR GXcopy , and the effective fill-style is -.ZN FillSolid . +.BR FillSolid . .LP For fonts defined with 2-byte matrix indexing and used with -.ZN XDrawImageString , +.BR XDrawImageString , each byte is used as a byte2 with a byte1 of zero. .LP Both functions use these GC components: plane-mask, foreground, background, font, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. .LP -.ZN XDrawImageString +.B XDrawImageString and -.ZN XDrawImageString16 +.B XDrawImageString16 can generate -.ZN BadDrawable , -.ZN BadGC , +.BR BadDrawable , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .SH "SEE ALSO" diff --git a/man/XDrawLine.man b/man/XDrawLine.man index 03433aac..09f32f39 100644 --- a/man/XDrawLine.man +++ b/man/XDrawLine.man @@ -101,9 +101,9 @@ Specifies the GC. .IP \fImode\fP 1i Specifies the coordinate mode. You can pass -.ZN CoordModeOrigin +.B CoordModeOrigin or -.ZN CoordModePrevious . +.BR CoordModePrevious . .IP \fInpoints\fP 1i Specifies the number of points in the array. .IP \fInsegments\fP 1i @@ -125,52 +125,52 @@ Specifies an array of segments. Specify the points (x1, y1) and (x2, y2) to be connected. .SH DESCRIPTION The -.ZN XDrawLine +.B XDrawLine function uses the components of the specified GC to draw a line between the specified set of points (x1, y1) and (x2, y2). It does not perform joining at coincident endpoints. For any given line, -.ZN XDrawLine +.B XDrawLine does not draw a pixel more than once. If lines intersect, the intersecting pixels are drawn multiple times. .LP The -.ZN XDrawLines +.B XDrawLines function uses the components of the specified GC to draw npoints\-1 lines between each pair of points (point[i], point[i+1]) in the array of -.ZN XPoint +.B XPoint structures. It draws the lines in the order listed in the array. The lines join correctly at all intermediate points, and if the first and last points coincide, the first and last lines also join correctly. For any given line, -.ZN XDrawLines +.B XDrawLines does not draw a pixel more than once. If thin (zero line-width) lines intersect, the intersecting pixels are drawn multiple times. If wide lines intersect, the intersecting pixels are drawn only once, as though the entire -.ZN PolyLine +.B PolyLine protocol request were a single, filled shape. -.ZN CoordModeOrigin +.B CoordModeOrigin treats all coordinates as relative to the origin, and -.ZN CoordModePrevious +.B CoordModePrevious treats all coordinates after the first as relative to the previous point. .LP The -.ZN XDrawSegments +.B XDrawSegments function draws multiple, unconnected lines. For each segment, -.ZN XDrawSegments +.B XDrawSegments draws a line between (x1, y1) and (x2, y2). It draws the lines in the order listed in the array of -.ZN XSegment +.B XSegment structures and does not perform joining at coincident endpoints. For any given line, -.ZN XDrawSegments +.B XDrawSegments does not draw a pixel more than once. If lines intersect, the intersecting pixels are drawn multiple times. .LP @@ -179,29 +179,29 @@ function, plane-mask, line-width, line-style, cap-style, fill-style, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. The -.ZN XDrawLines +.B XDrawLines function also uses the join-style GC component. All three functions also use these GC mode-dependent components: foreground, background, tile, stipple, tile-stipple-x-origin, tile-stipple-y-origin, dash-offset, and dash-list. .LP -.ZN XDrawLine , -.ZN XDrawLines , +.BR XDrawLine , +.BR XDrawLines , and -.ZN XDrawSegments +.B XDrawSegments can generate -.ZN BadDrawable , -.ZN BadGC , +.BR BadDrawable , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. -.ZN XDrawLines +.B XDrawLines can also generate a -.ZN BadValue +.B BadValue error. .SH STRUCTURES The -.ZN XSegment +.B XSegment structure contains: .LP .Ds 0 @@ -217,22 +217,22 @@ out of the 16-bit ranges, because the protocol only has 16-bit fields for these values. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XDrawPoint.man b/man/XDrawPoint.man index 05721ca8..14deae78 100644 --- a/man/XDrawPoint.man +++ b/man/XDrawPoint.man @@ -98,9 +98,9 @@ Specifies the GC. .IP \fImode\fP 1i Specifies the coordinate mode. You can pass -.ZN CoordModeOrigin +.B CoordModeOrigin or -.ZN CoordModePrevious . +.BR CoordModePrevious . .IP \fInpoints\fP 1i Specifies the number of points in the array. .IP \fIpoints\fP 1i @@ -112,40 +112,40 @@ Specifies an array of points. Specify the x and y coordinates where you want the point drawn. .SH DESCRIPTION The -.ZN XDrawPoint +.B XDrawPoint function uses the foreground pixel and function components of the GC to draw a single point into the specified drawable; -.ZN XDrawPoints +.B XDrawPoints draws multiple points this way. -.ZN CoordModeOrigin +.B CoordModeOrigin treats all coordinates as relative to the origin, and -.ZN CoordModePrevious +.B CoordModePrevious treats all coordinates after the first as relative to the previous point. -.ZN XDrawPoints +.B XDrawPoints draws the points in the order listed in the array. .LP Both functions use these GC components: function, plane-mask, foreground, subwindow-mode, clip-x-origin, clip-y-origin, and clip-mask. .LP -.ZN XDrawPoint +.B XDrawPoint can generate -.ZN BadDrawable , -.ZN BadGC , +.BR BadDrawable , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. -.ZN XDrawPoints +.B XDrawPoints can generate -.ZN BadDrawable , -.ZN BadGC , -.ZN BadMatch , +.BR BadDrawable , +.BR BadGC , +.BR BadMatch , and -.ZN BadValue +.B BadValue errors. .SH STRUCTURES The -.ZN XPoint +.B XPoint structure contains: .LP .Ds 0 @@ -161,22 +161,22 @@ out of the 16-bit ranges, because the protocol only has 16-bit fields for these values. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XDrawRectangle.man b/man/XDrawRectangle.man index 05792941..cac687bd 100644 --- a/man/XDrawRectangle.man +++ b/man/XDrawRectangle.man @@ -112,19 +112,19 @@ Specify the width and height, which specify the dimensions of the rectangle. Specify the x and y coordinates, which specify the upper-left corner of the rectangle. .SH DESCRIPTION The -.ZN XDrawRectangle +.B XDrawRectangle and -.ZN XDrawRectangles +.B XDrawRectangles functions draw the outlines of the specified rectangle or rectangles as if a five-point -.ZN PolyLine +.B PolyLine protocol request were specified for each rectangle: .IP [x,y] [x+width,y] [x+width,y+height] [x,y+height] [x,y] .LP For the specified rectangle or rectangles, these functions do not draw a pixel more than once. -.ZN XDrawRectangles +.B XDrawRectangles draws the rectangles in the order listed in the array. If rectangles intersect, the intersecting pixels are drawn multiple times. @@ -137,18 +137,18 @@ They also use these GC mode-dependent components: foreground, background, tile, stipple, tile-stipple-x-origin, tile-stipple-y-origin, dash-offset, and dash-list. .LP -.ZN XDrawRectangle +.B XDrawRectangle and -.ZN XDrawRectangles +.B XDrawRectangles can generate -.ZN BadDrawable , -.ZN BadGC , +.BR BadDrawable , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. .SH STRUCTURES The -.ZN XRectangle +.B XRectangle structure contains: .LP .Ds 0 @@ -165,18 +165,18 @@ out of the 16-bit ranges, because the protocol only has 16-bit fields for these values. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .SH "SEE ALSO" diff --git a/man/XDrawString.man b/man/XDrawString.man index 85aa4a5b..940f6b7e 100644 --- a/man/XDrawString.man +++ b/man/XDrawString.man @@ -114,7 +114,7 @@ additional mask for a fill operation on the drawable. The drawable is modified only where the font character has a bit set to 1. For fonts defined with 2-byte matrix indexing and used with -.ZN XDrawString16 , +.BR XDrawString16 , each byte is used as a byte2 with a byte1 of zero. .LP Both functions use these GC components: @@ -124,29 +124,29 @@ They also use these GC mode-dependent components: foreground, background, tile, stipple, tile-stipple-x-origin, and tile-stipple-y-origin. .LP -.ZN XDrawString +.B XDrawString and -.ZN XDrawString16 +.B XDrawString16 can generate -.ZN BadDrawable , -.ZN BadGC , +.BR BadDrawable , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .SH "SEE ALSO" diff --git a/man/XDrawText.man b/man/XDrawText.man index 5666cea5..66fad216 100644 --- a/man/XDrawText.man +++ b/man/XDrawText.man @@ -109,15 +109,15 @@ of the specified drawable and define the origin of the first character. .SH DESCRIPTION The -.ZN XDrawText16 +.B XDrawText16 function is similar to -.ZN XDrawText +.B XDrawText except that it uses 2-byte or 16-bit characters. Both functions allow complex spacing and font shifts between counted strings. .LP Each text item is processed in turn. A font member other than -.ZN None +.B None in an item causes the font to be stored in the GC and used for subsequent text. A text element delta specifies an additional change @@ -128,12 +128,12 @@ Each character image, as defined by the font in the GC, is treated as an additional mask for a fill operation on the drawable. The drawable is modified only where the font character has a bit set to 1. If a text item generates a -.ZN BadFont +.B BadFont error, the previous text items may have been drawn. .LP For fonts defined with linear indexing rather than 2-byte matrix indexing, each -.ZN XChar2b +.B XChar2b structure is interpreted as a 16-bit number with byte1 as the most significant byte. .LP @@ -144,21 +144,21 @@ They also use these GC mode-dependent components: foreground, background, tile, stipple, tile-stipple-x-origin, and tile-stipple-y-origin. .LP -.ZN XDrawText +.B XDrawText and -.ZN XDrawText16 +.B XDrawText16 can generate -.ZN BadDrawable , -.ZN BadFont , -.ZN BadGC , +.BR BadDrawable , +.BR BadFont , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. .SH STRUCTURES The -.ZN XTextItem +.B XTextItem and -.ZN XTextItem16 +.B XTextItem16 structures contain: .LP .Ds 0 @@ -180,7 +180,7 @@ typedef struct { .De .LP If the font member is not -.ZN None , +.BR None , the font is changed before printing and also is stored in the GC. If an error was generated during text drawing, the previous items may have been drawn. @@ -188,33 +188,33 @@ The baseline of the characters are drawn starting at the x and y coordinates that you pass in the text drawing functions. .LP For example, consider the background rectangle drawn by -.ZN XDrawImageString . +.BR XDrawImageString . If you want the upper-left corner of the background rectangle to be at pixel coordinate (x,y), pass the (x,y + ascent) as the baseline origin coordinates to the text functions. The ascent is the font ascent, as given in the -.ZN XFontStruct +.B XFontStruct structure. If you want the lower-left corner of the background rectangle to be at pixel coordinate (x,y), pass the (x,y \- descent + 1) as the baseline origin coordinates to the text functions. The descent is the font descent, as given in the -.ZN XFontStruct +.B XFontStruct structure. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadFont +.B BadFont A value for a Font or GContext argument does not name a defined Font. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .SH "SEE ALSO" XDrawImageString(__libmansuffix__), diff --git a/man/XEmptyRegion.man b/man/XEmptyRegion.man index e57b3b70..a0803a25 100644 --- a/man/XEmptyRegion.man +++ b/man/XEmptyRegion.man @@ -114,32 +114,32 @@ Specify the x and y coordinates, which define the point or the coordinates of the upper-left corner of the rectangle. .SH DESCRIPTION The -.ZN XEmptyRegion +.B XEmptyRegion function returns -.ZN True +.B True if the region is empty. .LP The -.ZN XEqualRegion +.B XEqualRegion function returns -.ZN True +.B True if the two regions have the same offset, size, and shape. .LP The -.ZN XPointInRegion +.B XPointInRegion function returns -.ZN True +.B True if the point (x, y) is contained in the region r. .LP The -.ZN XRectInRegion +.B XRectInRegion function returns -.ZN RectangleIn +.B RectangleIn if the rectangle is entirely in the specified region, -.ZN RectangleOut +.B RectangleOut if the rectangle is entirely out of the specified region, and -.ZN RectanglePart +.B RectanglePart if the rectangle is partially in the specified region. .SH "SEE ALSO" XCreateRegion(__libmansuffix__), diff --git a/man/XErrorEvent.man b/man/XErrorEvent.man index 136de6ec..6a021084 100644 --- a/man/XErrorEvent.man +++ b/man/XErrorEvent.man @@ -83,7 +83,7 @@ XErrorEvent \- X error event structure .SH STRUCTURES The -.ZN XErrorEvent +.B XErrorEvent structure contains: .LP .Ds 0 @@ -104,7 +104,7 @@ the structure members are set as follows. The serial member is the number of requests, starting from one, sent over the network connection since it was opened. It is the number that was the value of -.ZN NextRequest +.B NextRequest immediately before the failing call was made. The request_code member is a protocol request of the procedure that failed, as defined in diff --git a/man/XExposeEvent.man b/man/XExposeEvent.man index 7bf90cde..7ca1945b 100644 --- a/man/XExposeEvent.man +++ b/man/XExposeEvent.man @@ -83,7 +83,7 @@ XExposeEvent \- Expose event structure .SH STRUCTURES The structure for -.ZN Expose +.B Expose events contains: .LP .Ds 0 @@ -105,16 +105,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -126,17 +126,17 @@ The x and y members are set to the coordinates relative to the window's origin and indicate the upper-left corner of the rectangle. The width and height members are set to the size (extent) of the rectangle. The count member is set to the number of -.ZN Expose +.B Expose events that are to follow. If count is zero, no more -.ZN Expose +.B Expose events follow for this window. However, if count is nonzero, at least that number of -.ZN Expose +.B Expose events (and possibly more) follow for this window. Simple applications that do not want to optimize redisplay by distinguishing between subareas of its window can just ignore all -.ZN Expose +.B Expose events with nonzero counts and perform full redisplays on events with zero counts. .SH "SEE ALSO" diff --git a/man/XExtentsOfFontSet.man b/man/XExtentsOfFontSet.man index 6200f604..e0ffb1b9 100644 --- a/man/XExtentsOfFontSet.man +++ b/man/XExtentsOfFontSet.man @@ -89,20 +89,20 @@ XFontSetExtents *XExtentsOfFontSet\^(\^XFontSet \fIfont_set\fP\^); Specifies the font set. .SH DESCRIPTION The -.ZN XExtentsOfFontSet +.B XExtentsOfFontSet function returns an -.ZN XFontSetExtents +.B XFontSetExtents structure for the fonts used by the Xmb and Xwc layers for the given font set. .LP The -.ZN XFontSetExtents +.B XFontSetExtents structure is owned by Xlib and should not be modified or freed by the client. It will be freed by a call to -.ZN XFreeFontSet +.B XFreeFontSet with the associated -.ZN XFontSet . +.BR XFontSet . Until freed, its contents will not be modified by Xlib. .SH "SEE ALSO" XCreateFontSet(__libmansuffix__), diff --git a/man/XFillRectangle.man b/man/XFillRectangle.man index 8931607d..d4da6a05 100644 --- a/man/XFillRectangle.man +++ b/man/XFillRectangle.man @@ -118,9 +118,9 @@ Specifies the GC. .IP \fImode\fP 1i Specifies the coordinate mode. You can pass -.ZN CoordModeOrigin +.B CoordModeOrigin or -.ZN CoordModePrevious . +.BR CoordModePrevious . .IP \fInarcs\fP 1i Specifies the number of arcs in the array. .IP \fInpoints\fP 1i @@ -134,10 +134,10 @@ Specifies an array of rectangles. .IP \fIshape\fP 1i Specifies a shape that helps the server to improve performance. You can pass -.ZN Complex , -.ZN Convex , +.BR Complex , +.BR Convex , or -.ZN Nonconvex . +.BR Nonconvex . .ds Wh .IP \fIwidth\fP 1i .br @@ -153,12 +153,12 @@ Specify the x and y coordinates, which are relative to the origin of the drawabl and specify the upper-left corner of the rectangle. .SH DESCRIPTION The -.ZN XFillRectangle +.B XFillRectangle and -.ZN XFillRectangles +.B XFillRectangles functions fill the specified rectangle or rectangles as if a four-point -.ZN FillPolygon +.B FillPolygon protocol request were specified for each rectangle: .LP .Ds @@ -168,12 +168,12 @@ protocol request were specified for each rectangle: Each function uses the x and y coordinates, width and height dimensions, and GC you specify. .LP -.ZN XFillRectangles +.B XFillRectangles fills the rectangles in the order listed in the array. For any given rectangle, -.ZN XFillRectangle +.B XFillRectangle and -.ZN XFillRectangles +.B XFillRectangles do not draw a pixel more than once. If rectangles intersect, the intersecting pixels are drawn multiple times. @@ -185,62 +185,62 @@ They also use these GC mode-dependent components: foreground, background, tile, stipple, tile-stipple-x-origin, and tile-stipple-y-origin. .LP -.ZN XFillRectangle +.B XFillRectangle and -.ZN XFillRectangles +.B XFillRectangles can generate -.ZN BadDrawable , -.ZN BadGC , +.BR BadDrawable , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. .LP -.ZN XFillPolygon +.B XFillPolygon fills the region closed by the specified path. The path is closed automatically if the last point in the list does not coincide with the first point. -.ZN XFillPolygon +.B XFillPolygon does not draw a pixel of the region more than once. -.ZN CoordModeOrigin +.B CoordModeOrigin treats all coordinates as relative to the origin, and -.ZN CoordModePrevious +.B CoordModePrevious treats all coordinates after the first as relative to the previous point. .LP Depending on the specified shape, the following occurs: .IP \(bu 5 If shape is -.ZN Complex , +.BR Complex , the path may self-intersect. Note that contiguous coincident points in the path are not treated as self-intersection. .IP \(bu 5 If shape is -.ZN Convex , +.BR Convex , for every pair of points inside the polygon, the line segment connecting them does not intersect the path. If known by the client, specifying -.ZN Convex +.B Convex can improve performance. If you specify -.ZN Convex +.B Convex for a path that is not convex, the graphics results are undefined. .IP \(bu 5 If shape is -.ZN Nonconvex , +.BR Nonconvex , the path does not self-intersect, but the shape is not wholly convex. If known by the client, specifying -.ZN Nonconvex +.B Nonconvex instead of -.ZN Complex +.B Complex may improve performance. If you specify -.ZN Nonconvex +.B Nonconvex for a self-intersecting path, the graphics results are undefined. .LP The fill-rule of the GC controls the filling behavior of @@ -253,35 +253,35 @@ It also uses these GC mode-dependent components: foreground, background, tile, stipple, tile-stipple-x-origin, and tile-stipple-y-origin. .LP -.ZN XFillPolygon +.B XFillPolygon can generate -.ZN BadDrawable , -.ZN BadGC , -.ZN BadMatch , +.BR BadDrawable , +.BR BadGC , +.BR BadMatch , and -.ZN BadValue +.B BadValue errors. .LP For each arc, -.ZN XFillArc +.B XFillArc or -.ZN XFillArcs +.B XFillArcs fills the region closed by the infinitely thin path described by the specified arc and, depending on the arc-mode specified in the GC, one or two line segments. For -.ZN ArcChord , +.BR ArcChord , the single line segment joining the endpoints of the arc is used. For -.ZN ArcPieSlice , +.BR ArcPieSlice , the two line segments joining the endpoints of the arc with the center point are used. -.ZN XFillArcs +.B XFillArcs fills the arcs in the order listed in the array. For any given arc, -.ZN XFillArc +.B XFillArc and -.ZN XFillArcs +.B XFillArcs do not draw a pixel more than once. If regions intersect, the intersecting pixels are drawn multiple times. @@ -293,33 +293,33 @@ They also use these GC mode-dependent components: foreground, background, tile, stipple, tile-stipple-x-origin, and tile-stipple-y-origin. .LP -.ZN XFillArc +.B XFillArc and -.ZN XFillArcs +.B XFillArcs can generate -.ZN BadDrawable , -.ZN BadGC , +.BR BadDrawable , +.BR BadGC , and -.ZN BadMatch +.B BadMatch errors. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XFilterEvent.man b/man/XFilterEvent.man index 825f8bfb..bcbc131f 100644 --- a/man/XFilterEvent.man +++ b/man/XFilterEvent.man @@ -91,31 +91,31 @@ Specifies the event to filter. Specifies the window for which the filter is to be applied. .SH DESCRIPTION If the window argument is -.ZN None , -.ZN XFilterEvent +.BR None , +.B XFilterEvent applies the filter to the window specified in the -.ZN XEvent +.B XEvent structure. The window argument is provided so that layers above Xlib that do event redirection can indicate to which window an event has been redirected. .LP If -.ZN XFilterEvent +.B XFilterEvent returns -.ZN True , +.BR True , then some input method has filtered the event, and the client should discard the event. If -.ZN XFilterEvent +.B XFilterEvent returns -.ZN False , +.BR False , then the client should continue processing the event. .LP If a grab has occurred in the client and -.ZN XFilterEvent +.B XFilterEvent returns -.ZN True , +.BR True , the client should ungrab the keyboard. .SH "SEE ALSO" XNextEvent(__libmansuffix__) diff --git a/man/XFlush.man b/man/XFlush.man index 9e1f21e5..2af3731a 100644 --- a/man/XFlush.man +++ b/man/XFlush.man @@ -93,106 +93,106 @@ int XPending\^(\^Display *\fIdisplay\fP\^); .SH ARGUMENTS .IP \fIdiscard\fP 1i Specifies a Boolean value that indicates whether -.ZN XSync +.B XSync discards all events on the event queue. .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fImode\fP 1i Specifies the mode. You can pass -.ZN QueuedAlready , -.ZN QueuedAfterFlush , +.BR QueuedAlready , +.BR QueuedAfterFlush , or -.ZN QueuedAfterReading . +.BR QueuedAfterReading . .SH DESCRIPTION The -.ZN XFlush +.B XFlush function flushes the output buffer. Most client applications need not use this function because the output buffer is automatically flushed as needed by calls to -.ZN XPending , -.ZN XNextEvent , +.BR XPending , +.BR XNextEvent , and -.ZN XWindowEvent . +.BR XWindowEvent . .IN "XPending" .IN "XNextEvent" .IN "XWindowEvent" Events generated by the server may be enqueued into the library's event queue. .LP The -.ZN XSync +.B XSync function flushes the output buffer and then waits until all requests have been received and processed by the X server. Any errors generated must be handled by the error handler. For each protocol error received by Xlib, -.ZN XSync +.B XSync calls the client application's error handling routine (see section 11.8.2). Any events generated by the server are enqueued into the library's event queue. .LP Finally, if you passed -.ZN False , -.ZN XSync +.BR False , +.B XSync does not discard the events in the queue. If you passed -.ZN True , -.ZN XSync +.BR True , +.B XSync discards all events in the queue, including those events that were on the queue before -.ZN XSync +.B XSync was called. Client applications seldom need to call -.ZN XSync . +.BR XSync . .LP If mode is -.ZN QueuedAlready , -.ZN XEventsQueued +.BR QueuedAlready , +.B XEventsQueued returns the number of events already in the event queue (and never performs a system call). If mode is -.ZN QueuedAfterFlush , -.ZN XEventsQueued +.BR QueuedAfterFlush , +.B XEventsQueued returns the number of events already in the queue if the number is nonzero. If there are no events in the queue, -.ZN XEventsQueued +.B XEventsQueued flushes the output buffer, attempts to read more events out of the application's connection, and returns the number read. If mode is -.ZN QueuedAfterReading , -.ZN XEventsQueued +.BR QueuedAfterReading , +.B XEventsQueued returns the number of events already in the queue if the number is nonzero. If there are no events in the queue, -.ZN XEventsQueued +.B XEventsQueued attempts to read more events out of the application's connection without flushing the output buffer and returns the number read. .LP -.ZN XEventsQueued +.B XEventsQueued always returns immediately without I/O if there are events already in the queue. -.ZN XEventsQueued +.B XEventsQueued with mode -.ZN QueuedAfterFlush +.B QueuedAfterFlush is identical in behavior to -.ZN XPending . -.ZN XEventsQueued +.BR XPending . +.B XEventsQueued with mode -.ZN QueuedAlready +.B QueuedAlready is identical to the -.ZN XQLength +.B XQLength function. .LP The -.ZN XPending +.B XPending function returns the number of events that have been received from the X server but have not been removed from the event queue. -.ZN XPending +.B XPending is identical to -.ZN XEventsQueued +.B XEventsQueued with the mode -.ZN QueuedAfterFlush +.B QueuedAfterFlush specified. .SH "SEE ALSO" AllPlanes(__libmansuffix__), diff --git a/man/XFocusChangeEvent.man b/man/XFocusChangeEvent.man index 0dfaee5e..7ccaad31 100644 --- a/man/XFocusChangeEvent.man +++ b/man/XFocusChangeEvent.man @@ -83,9 +83,9 @@ XFocusChangeEvent \- FocusIn and FocusOut event structure .SH STRUCTURES The structure for -.ZN FocusIn +.B FocusIn and -.ZN FocusOut +.B FocusOut events contains: .LP .Ds 0 @@ -113,16 +113,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -130,9 +130,9 @@ The window member is set to the window that is most useful to toolkit dispatchers. .LP The window member is set to the window on which the -.ZN FocusIn +.B FocusIn or -.ZN FocusOut +.B FocusOut event was generated. This is the window used by the X server to report the event. The mode member is set to indicate whether the focus events @@ -141,38 +141,38 @@ focus events while grabbed, focus events when a grab activates, or focus events when a grab deactivates. The X server can set the mode member to -.ZN NotifyNormal , -.ZN NotifyWhileGrabbed , -.ZN NotifyGrab , +.BR NotifyNormal , +.BR NotifyWhileGrabbed , +.BR NotifyGrab , or -.ZN NotifyUngrab . +.BR NotifyUngrab . .LP All -.ZN FocusOut +.B FocusOut events caused by a window unmap are generated after any -.ZN UnmapNotify +.B UnmapNotify event; however, the X protocol does not constrain the ordering of -.ZN FocusOut +.B FocusOut events with respect to generated -.ZN EnterNotify , -.ZN LeaveNotify , -.ZN VisibilityNotify , +.BR EnterNotify , +.BR LeaveNotify , +.BR VisibilityNotify , and -.ZN Expose +.B Expose events. .LP Depending on the event mode, the detail member is set to indicate the notify detail and can be -.ZN NotifyAncestor , -.ZN NotifyVirtual , -.ZN NotifyInferior , -.ZN NotifyNonlinear , -.ZN NotifyNonlinearVirtual , -.ZN NotifyPointer , -.ZN NotifyPointerRoot , +.BR NotifyAncestor , +.BR NotifyVirtual , +.BR NotifyInferior , +.BR NotifyNonlinear , +.BR NotifyNonlinearVirtual , +.BR NotifyPointer , +.BR NotifyPointerRoot , or -.ZN NotifyDetailNone . +.BR NotifyDetailNone . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/man/XFontSetExtents.man b/man/XFontSetExtents.man index d78db7dc..ba180d19 100644 --- a/man/XFontSetExtents.man +++ b/man/XFontSetExtents.man @@ -83,7 +83,7 @@ XFontSetExtents \- XFontSetExtents structure .SH STRUCTURES The -.ZN XFontSetExtents +.B XFontSetExtents structure contains: .LP .Ds 0 @@ -94,7 +94,7 @@ typedef struct { .De .LP The -.ZN XRectangle +.B XRectangle structures used to return font set metrics are the usual Xlib screen-oriented rectangles with x, y giving the upper left corner, and width and height always positive. @@ -103,9 +103,9 @@ The max_ink_extent member gives the maximum extent, over all drawable characters the rectangles that bound the character glyph image drawn in the foreground color, relative to a constant origin. See -.ZN XmbTextExtents +.B XmbTextExtents and -.ZN XwcTextExtents +.B XwcTextExtents for detailed semantics. .LP The max_logical_extent member gives the maximum extent, diff --git a/man/XFontsOfFontSet.man b/man/XFontsOfFontSet.man index 845599dc..29bfc9c7 100644 --- a/man/XFontsOfFontSet.man +++ b/man/XFontsOfFontSet.man @@ -104,19 +104,19 @@ Returns the list of font names. Returns the list of font structs. .SH DESCRIPTION The -.ZN XFontsOfFontSet +.B XFontsOfFontSet function returns a list of one or more -.ZN XFontStructs +.B XFontStructs and font names for the fonts used by the Xmb and Xwc layers for the given font set. A list of pointers to the -.ZN XFontStruct +.B XFontStruct structures is returned to font_struct_list_return. A list of pointers to null-terminated, fully specified font name strings in the locale of the font set is returned to font_name_list_return. The font_name_list order corresponds to the font_struct_list order. The number of -.ZN XFontStruct +.B XFontStruct structures and font names is returned as the value of the function. .LP Because it is not guaranteed that a given character will be imaged using a @@ -125,38 +125,38 @@ there is no provision for mapping a character or default string to the font properties, font ID, or direction hint for the font for the character. The client may access the -.ZN XFontStruct +.B XFontStruct list to obtain these values for all the fonts currently in use. .LP Xlib does not guarantee that fonts are loaded from the server at the creation of an -.ZN XFontSet . +.BR XFontSet . Xlib may choose to cache font data, loading it only as needed to draw text or compute text dimensions. Therefore, existence of the per_char metrics in the -.ZN XFontStruct +.B XFontStruct structures in the -.ZN XFontStructSet +.B XFontStructSet is undefined. Also, note that all properties in the -.ZN XFontStruct +.B XFontStruct structures are in the STRING encoding. .LP The -.ZN XFontStruct +.B XFontStruct and font name lists are owned by Xlib and should not be modified or freed by the client. They will be freed by a call to -.ZN XFreeFontSet +.B XFreeFontSet with the associated -.ZN XFontSet . +.BR XFontSet . Until freed, their contents will not be modified by Xlib. .LP The -.ZN XBaseFontNameListOfFontSet +.B XBaseFontNameListOfFontSet function returns the original base font name list supplied by the client when the -.ZN XFontSet +.B XFontSet was created. A null-terminated string containing a list of comma-separated font names is returned @@ -164,59 +164,59 @@ as the value of the function. White space may appear immediately on either side of separating commas. .LP If -.ZN XCreateFontSet +.B XCreateFontSet obtained an XLFD name from the font properties for the font specified by a non-XLFD base name, the -.ZN XBaseFontNameListOfFontSet +.B XBaseFontNameListOfFontSet function will return the XLFD name instead of the non-XLFD base name. .LP The base font name list is owned by Xlib and should not be modified or freed by the client. It will be freed by a call to -.ZN XFreeFontSet +.B XFreeFontSet with the associated -.ZN XFontSet . +.BR XFontSet . Until freed, its contents will not be modified by Xlib. .LP The -.ZN XLocaleOfFontSet +.B XLocaleOfFontSet function returns the name of the locale bound to the specified -.ZN XFontSet , +.BR XFontSet , as a null-terminated string. .LP The returned locale name string is owned by Xlib and should not be modified or freed by the client. It may be freed by a call to -.ZN XFreeFontSet +.B XFreeFontSet with the associated -.ZN XFontSet . +.BR XFontSet . Until freed, it will not be modified by Xlib. .LP The -.ZN XContextDependentDrawing +.B XContextDependentDrawing function returns -.ZN True +.B True if the drawing functions implement implicit text directionality or if text drawn with the font_set might include context-dependent drawing; otherwise, it returns -.ZN False . +.BR False . .LP The -.ZN XContextualDrawing +.B XContextualDrawing function returns -.ZN True +.B True if text drawn with the font set might include context-dependent drawing; otherwise, it returns -.ZN False . +.BR False . .LP The -.ZN XDirectionalDependentDrawing +.B XDirectionalDependentDrawing function returns -.ZN True +.B True if the drawing functions implement implicit text directionality; otherwise, it returns -.ZN False . +.BR False . .SH "SEE ALSO" XCreateFontSet(__libmansuffix__), XCreateOM(__libmansuffix__), diff --git a/man/XFree.man b/man/XFree.man index 89b64088..f4e3efb4 100644 --- a/man/XFree.man +++ b/man/XFree.man @@ -88,7 +88,7 @@ int XFree\^(\^void *\fIdata\fP\^); Specifies the data that are to be freed. .SH DESCRIPTION The -.ZN XFree +.B XFree function is a general-purpose Xlib routine that frees the specified data. You must use it to free any objects that were allocated by Xlib, unless an alternate function is explicitly specified for the object. diff --git a/man/XGetEventData.man b/man/XGetEventData.man index 6d1f2dbb..79ca4679 100644 --- a/man/XGetEventData.man +++ b/man/XGetEventData.man @@ -87,41 +87,41 @@ typedef struct { .SH DESCRIPTION Some extension -.ZN XGenericEvents +.B XGenericEvents require additional memory to store information. For these events, the library returns a -.ZN XGenericEventCookie +.B XGenericEventCookie with a token ('cookie') unique to this event. The -.ZN XGenericEventCookie 's +.BR XGenericEventCookie 's data pointer is undefined until -.ZN XGetEventData +.B XGetEventData is called. The -.ZN XGetEventData +.B XGetEventData function retrieves this extra data for the given cookie. No round-trip to the server is required. If the cookie is invalid or the event is not an event handled by cookie handlers, -.ZN False +.B False is returned. If -.ZN XGetEventData +.B XGetEventData returns -.ZN True , +.BR True , the cookie's data pointer points to the memory containing the event information. A client must call -.ZN XFreeEventData +.B XFreeEventData to free this memory. -.ZN XGetEventData +.B XGetEventData returns -.ZN False +.B False for multiple calls for the same event cookie. The -.ZN XFreeEventData +.B XFreeEventData function frees the data associated with a cookie. A client must call -.ZN XFreeEventData +.B XFreeEventData for each cookie claimed with -.ZN XGetEventData . +.BR XGetEventData . .SH EXAMPLE CODE .Ds 0 @@ -140,16 +140,16 @@ XFreeEventData(display, cookie); .SH NOTES A cookie is defined as unclaimed if it has been returned to the client through -.ZN XNextEvent +.B XNextEvent but its data has not been retrieved via -.ZN XGetEventData . +.BR XGetEventData . Subsequent calls to -.ZN XNextEvent +.B XNextEvent may free memory associated with unclaimed cookies. Multi-threaded X clients must ensure that -.ZN XGetEventData +.B XGetEventData is called before the next call to -.ZN XNextEvent . +.BR XNextEvent . .SH "SEE ALSO" XNextEvent(__libmansuffix__), diff --git a/man/XGetVisualInfo.man b/man/XGetVisualInfo.man index 5c5d226c..e23533a4 100644 --- a/man/XGetVisualInfo.man +++ b/man/XGetVisualInfo.man @@ -115,34 +115,34 @@ Specifies the visual attributes that are to be used in matching the visual structures. .SH DESCRIPTION The -.ZN XGetVisualInfo +.B XGetVisualInfo function returns a list of visual structures that have attributes equal to the attributes specified by vinfo_template. If no visual structures match the template using the specified vinfo_mask, -.ZN XGetVisualInfo +.B XGetVisualInfo returns a NULL. To free the data returned by this function, use -.ZN XFree . +.BR XFree . .LP The -.ZN XMatchVisualInfo +.B XMatchVisualInfo function returns the visual information for a visual that matches the specified depth and class for a screen. Because multiple visuals that match the specified depth and class can exist, the exact visual chosen is undefined. If a visual is found, -.ZN XMatchVisualInfo +.B XMatchVisualInfo returns nonzero and the information on the visual to vinfo_return. Otherwise, when a visual is not found, -.ZN XMatchVisualInfo +.B XMatchVisualInfo returns zero. .LP The -.ZN XVisualIDFromVisual +.B XVisualIDFromVisual function returns the visual ID for the specified visual type. .SH STRUCTURES The -.ZN XVisualInfo +.B XVisualInfo structure contains: .LP .LP @@ -152,77 +152,77 @@ lw(.5i) lw(2.5i) lw(.8i). T{ \&#define T} T{ -.ZN VisualNoMask +.B VisualNoMask T} T{ 0x0 T} T{ \&#define T} T{ -.ZN VisualIDMask +.B VisualIDMask T} T{ 0x1 T} T{ \&#define T} T{ -.ZN VisualScreenMask +.B VisualScreenMask T} T{ 0x2 T} T{ \&#define T} T{ -.ZN VisualDepthMask +.B VisualDepthMask T} T{ 0x4 T} T{ \&#define T} T{ -.ZN VisualClassMask +.B VisualClassMask T} T{ 0x8 T} T{ \&#define T} T{ -.ZN VisualRedMaskMask +.B VisualRedMaskMask T} T{ 0x10 T} T{ \&#define T} T{ -.ZN VisualGreenMaskMask +.B VisualGreenMaskMask T} T{ 0x20 T} T{ \&#define T} T{ -.ZN VisualBlueMaskMask +.B VisualBlueMaskMask T} T{ 0x40 T} T{ \&#define T} T{ -.ZN VisualColormapSizeMask +.B VisualColormapSizeMask T} T{ 0x80 T} T{ \&#define T} T{ -.ZN VisualBitsPerRGBMask +.B VisualBitsPerRGBMask T} T{ 0x100 T} T{ \&#define T} T{ -.ZN VisualAllMask +.B VisualAllMask T} T{ 0x1FF T} diff --git a/man/XGetWindowAttributes.man b/man/XGetWindowAttributes.man index b60ef426..d0673a36 100644 --- a/man/XGetWindowAttributes.man +++ b/man/XGetWindowAttributes.man @@ -113,7 +113,7 @@ Specifies the window whose current attributes you want to obtain. Return the drawable's dimensions (width and height). .IP \fIwindow_attributes_return\fP 1i Returns the specified window's attributes in the -.ZN XWindowAttributes +.B XWindowAttributes structure. .IP \fIx_return\fP 1i .br @@ -126,32 +126,32 @@ its parent's origin. For pixmaps, these coordinates are always zero. .SH DESCRIPTION The -.ZN XGetWindowAttributes +.B XGetWindowAttributes function returns the current attributes for the specified window to an -.ZN XWindowAttributes +.B XWindowAttributes structure. It returns a nonzero status on success; otherwise, it returns a zero status. .LP -.ZN XGetWindowAttributes +.B XGetWindowAttributes can generate -.ZN BadDrawable +.B BadDrawable and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetGeometry +.B XGetGeometry function returns the root window and the current geometry of the drawable. The geometry of the drawable includes the x and y coordinates, width and height, border width, and depth. These are described in the argument list. It is legal to pass to this function a window whose class is -.ZN InputOnly . +.BR InputOnly . It returns a nonzero status on success; otherwise, it returns a zero status. .SH STRUCTURES The -.ZN XWindowAttributes +.B XWindowAttributes structure contains: .LP .Ds 0 @@ -188,13 +188,13 @@ The border_width member is set to the window's border width in pixels. The depth member is set to the depth of the window (that is, bits per pixel for the object). The visual member is a pointer to the screen's associated -.ZN Visual +.B Visual structure. The root member is set to the root window of the screen containing the window. The class member is set to the window's class and can be either -.ZN InputOutput +.B InputOutput or -.ZN InputOnly . +.BR InputOnly . .LP The bit_gravity member is set to the window's bit gravity and can be one of the following: @@ -202,31 +202,31 @@ and can be one of the following: .TS lw(1.5i) lw(1.5i). T{ -.ZN ForgetGravity +.B ForgetGravity T} T{ -.ZN EastGravity +.B EastGravity T} T{ -.ZN NorthWestGravity +.B NorthWestGravity T} T{ -.ZN SouthWestGravity +.B SouthWestGravity T} T{ -.ZN NorthGravity +.B NorthGravity T} T{ -.ZN SouthGravity +.B SouthGravity T} T{ -.ZN NorthEastGravity +.B NorthEastGravity T} T{ -.ZN SouthEastGravity +.B SouthEastGravity T} T{ -.ZN WestGravity +.B WestGravity T} T{ -.ZN StaticGravity +.B StaticGravity T} -.ZN CenterGravity +.B CenterGravity .TE .LP The win_gravity member is set to the window's window gravity @@ -235,31 +235,31 @@ and can be one of the following: .TS lw(1.5i) lw(1.5i). T{ -.ZN UnmapGravity +.B UnmapGravity T} T{ -.ZN EastGravity +.B EastGravity T} T{ -.ZN NorthWestGravity +.B NorthWestGravity T} T{ -.ZN SouthWestGravity +.B SouthWestGravity T} T{ -.ZN NorthGravity +.B NorthGravity T} T{ -.ZN SouthGravity +.B SouthGravity T} T{ -.ZN NorthEastGravity +.B NorthEastGravity T} T{ -.ZN SouthEastGravity +.B SouthEastGravity T} T{ -.ZN WestGravity +.B WestGravity T} T{ -.ZN StaticGravity +.B StaticGravity T} -.ZN CenterGravity +.B CenterGravity .TE .LP For additional information on gravity, @@ -268,10 +268,10 @@ see section 3.3. The backing_store member is set to indicate how the X server should maintain the contents of a window and can be -.ZN WhenMapped , -.ZN Always , +.BR WhenMapped , +.BR Always , or -.ZN NotUseful . +.BR NotUseful . The backing_planes member is set to indicate (with bits set to 1) which bit planes of the window hold dynamic data that must be preserved in backing_stores and during save_unders. @@ -279,23 +279,23 @@ The backing_pixel member is set to indicate what values to use for planes not set in backing_planes. .LP The save_under member is set to -.ZN True +.B True or -.ZN False . +.BR False . The colormap member is set to the colormap for the specified window and can be a colormap ID or -.ZN None . +.BR None . The map_installed member is set to indicate whether the colormap is currently installed and can be -.ZN True +.B True or -.ZN False . +.BR False . The map_state member is set to indicate the state of the window and can be -.ZN IsUnmapped , -.ZN IsUnviewable , +.BR IsUnmapped , +.BR IsUnviewable , or -.ZN IsViewable . -.ZN IsUnviewable +.BR IsViewable . +.B IsUnviewable is used if the window is mapped but some ancestor is unmapped. .LP The all_event_masks member is set to the bitwise inclusive OR of all event @@ -307,11 +307,11 @@ set of events that should not propagate. .LP The override_redirect member is set to indicate whether this window overrides structure control facilities and can be -.ZN True +.B True or -.ZN False . +.BR False . Window manager clients should ignore the window if this member is -.ZN True . +.BR True . .LP The screen member is set to a screen pointer that gives you a back pointer to the correct screen. @@ -319,10 +319,10 @@ This makes it easier to obtain the screen information without having to loop over the root window fields to see which field matches. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XQueryPointer(__libmansuffix__), diff --git a/man/XGetWindowProperty.man b/man/XGetWindowProperty.man index 0a7d70d0..e59123b8 100644 --- a/man/XGetWindowProperty.man +++ b/man/XGetWindowProperty.man @@ -124,7 +124,7 @@ byte-swap operations as necessary. If the format is 16-bit or 32-bit, you must explicitly cast your data pointer to an (unsigned char *) in the call to -.ZN XChangeProperty . +.BR XChangeProperty . .IP \fIlong_length\fP 1i Specifies the length in 32-bit multiples of the data to be retrieved. .IP \fIlong_offset\fP 1i @@ -134,10 +134,10 @@ where the data is to be retrieved. .IP \fImode\fP 1i Specifies the mode of the operation. You can pass -.ZN PropModeReplace , -.ZN PropModePrepend , +.BR PropModeReplace , +.BR PropModePrepend , or -.ZN PropModeAppend . +.BR PropModeAppend . .IP \fInelements\fP 1i Specifies the number of elements of the specified data format. .IP \fInitems_return\fP 1i @@ -163,27 +163,27 @@ Specifies the property name. Specifies the array of properties that are to be rotated. .IP \fIreq_type\fP 1i Specifies the atom identifier associated with the property type or -.ZN AnyPropertyType . +.BR AnyPropertyType . .IP \fItype\fP 1i Specifies the type of the property. The X server does not interpret the type but simply passes it back to an application that later calls -.ZN XGetWindowProperty . +.BR XGetWindowProperty . .IP \fIw\fP 1i Specifies the window whose property you want to obtain, change, rotate or delete. .SH DESCRIPTION The -.ZN XGetWindowProperty +.B XGetWindowProperty function returns the actual type of the property; the actual format of the property; the number of 8-bit, 16-bit, or 32-bit items transferred; the number of bytes remaining to be read in the property; and a pointer to the data actually returned. -.ZN XGetWindowProperty +.B XGetWindowProperty sets the return arguments as follows: .IP \(bu 5 If the specified property does not exist for the specified window, -.ZN XGetWindowProperty +.B XGetWindowProperty returns -.ZN None +.B None to actual_type_return and the value zero to actual_format_return and bytes_after_return. The nitems_return argument is empty. @@ -191,7 +191,7 @@ In this case, the delete argument is ignored. .IP \(bu 5 If the specified property exists but its type does not match the specified type, -.ZN XGetWindowProperty +.B XGetWindowProperty returns the actual property type to actual_type_return, the actual property format (never zero) to actual_format_return, and the property length in bytes @@ -201,9 +201,9 @@ It also ignores the delete argument. The nitems_return argument is empty. .IP \(bu 5 If the specified property exists and either you assign -.ZN AnyPropertyType +.B AnyPropertyType to the req_type argument or the specified type matches the actual property type, -.ZN XGetWindowProperty +.B XGetWindowProperty returns the actual property type to actual_type_return and the actual property format (never zero) to actual_format_return. It also returns a value to bytes_after_return and nitems_return, by @@ -223,100 +223,100 @@ The returned value starts at byte index I in the property (indexing from zero), and its length in bytes is L. If the value for long_offset causes L to be negative, a -.ZN BadValue +.B BadValue error results. The value of bytes_after_return is A, giving the number of trailing unread bytes in the stored property. .LP If the returned format is 8, the returned data is represented as a -.ZN char +.B char array. If the returned format is 16, the returned data is represented as a -.ZN short +.B short array and should be cast to that type to obtain the elements. If the returned format is 32, the returned data is represented as a -.ZN long +.B long array and should be cast to that type to obtain the elements. .LP -.ZN XGetWindowProperty +.B XGetWindowProperty always allocates one extra byte in prop_return (even if the property is zero length) and sets it to zero so that simple properties consisting of characters do not have to be copied into yet another string before use. .LP If delete is -.ZN True +.B True and bytes_after_return is zero, -.ZN XGetWindowProperty +.B XGetWindowProperty deletes the property from the window and generates a -.ZN PropertyNotify +.B PropertyNotify event on the window. .LP The function returns -.ZN Success +.B Success if it executes successfully. To free the resulting data, use -.ZN XFree . +.BR XFree . .LP -.ZN XGetWindowProperty +.B XGetWindowProperty can generate -.ZN BadAtom , -.ZN BadValue , +.BR BadAtom , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XListProperties +.B XListProperties function returns a pointer to an array of atom properties that are defined for the specified window or returns NULL if no properties were found. To free the memory allocated by this function, use -.ZN XFree . +.BR XFree . .LP -.ZN XListProperties +.B XListProperties can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XChangeProperty +.B XChangeProperty function alters the property for the specified window and causes the X server to generate a -.ZN PropertyNotify +.B PropertyNotify event on that window. -.ZN XChangeProperty +.B XChangeProperty performs the following: .IP \(bu 5 If mode is -.ZN PropModeReplace , -.ZN XChangeProperty +.BR PropModeReplace , +.B XChangeProperty discards the previous property value and stores the new data. .IP \(bu 5 If mode is -.ZN PropModePrepend +.B PropModePrepend or -.ZN PropModeAppend , -.ZN XChangeProperty +.BR PropModeAppend , +.B XChangeProperty inserts the specified data before the beginning of the existing data or onto the end of the existing data, respectively. The type and format must match the existing property value, or a -.ZN BadMatch +.B BadMatch error results. If the property is undefined, it is treated as defined with the correct type and format with zero-length data. .LP If the specified format is 8, the property data must be a -.ZN char +.B char array. If the specified format is 16, the property data must be a -.ZN short +.B short array. If the specified format is 32, the property data must be a -.ZN long +.B long array. .LP The lifetime of a property is not tied to the storing client. @@ -327,24 +327,24 @@ see section 2.6. The maximum size of a property is server dependent and can vary dynamically depending on the amount of memory the server has available. (If there is insufficient space, a -.ZN BadAlloc +.B BadAlloc error results.) .LP -.ZN XChangeProperty +.B XChangeProperty can generate -.ZN BadAlloc , -.ZN BadAtom , -.ZN BadMatch , -.ZN BadValue , +.BR BadAlloc , +.BR BadAtom , +.BR BadMatch , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XRotateWindowProperties +.B XRotateWindowProperties function allows you to rotate properties on a window and causes the X server to generate -.ZN PropertyNotify +.B PropertyNotify events. If the property names in the properties array are viewed as being numbered starting from zero and if there are num_prop property names in the list, @@ -355,57 +355,57 @@ of property names (right for positive npositions, left for negative npositions). If npositions mod N is nonzero, the X server generates a -.ZN PropertyNotify +.B PropertyNotify event for each property in the order that they are listed in the array. If an atom occurs more than once in the list or no property with that name is defined for the window, a -.ZN BadMatch +.B BadMatch error results. If a -.ZN BadAtom +.B BadAtom or -.ZN BadMatch +.B BadMatch error results, no properties are changed. .LP -.ZN XRotateWindowProperties +.B XRotateWindowProperties can generate -.ZN BadAtom , -.ZN BadMatch , +.BR BadAtom , +.BR BadMatch , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XDeleteProperty +.B XDeleteProperty function deletes the specified property only if the property was defined on the specified window and causes the X server to generate a -.ZN PropertyNotify +.B PropertyNotify event on the window unless the property does not exist. .LP -.ZN XDeleteProperty +.B XDeleteProperty can generate -.ZN BadAtom +.B BadAtom and -.ZN BadWindow +.B BadWindow errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadAtom +.B BadAtom A value for an Atom argument does not name a defined Atom. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XFree(__libmansuffix__), diff --git a/man/XGrabButton.man b/man/XGrabButton.man index ffdb15e1..a7ef0645 100644 --- a/man/XGrabButton.man +++ b/man/XGrabButton.man @@ -94,13 +94,13 @@ unsigned int \fImodifiers\fP\^, Window \fIgrab_window\fP\^); .SH ARGUMENTS .IP \fIbutton\fP 1i Specifies the pointer button that is to be grabbed or released or -.ZN AnyButton . +.BR AnyButton . .IP \fIconfine_to\fP 1i Specifies the window to confine the pointer in or -.ZN None . +.BR None . .IP \fIcursor\fP 1i Specifies the cursor that is to be displayed or -.ZN None . +.BR None . .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIevent_mask\fP 1i @@ -111,12 +111,12 @@ Specifies the grab window. .IP \fIkeyboard_mode\fP 1i Specifies further processing of keyboard events. You can pass -.ZN GrabModeSync +.B GrabModeSync or -.ZN GrabModeAsync . +.BR GrabModeAsync . .IP \fImodifiers\fP 1i Specifies the set of keymasks or -.ZN AnyModifier . +.BR AnyModifier . The mask is the bitwise inclusive OR of the valid keymask bits. .IP \fIowner_events\fP 1i Specifies a Boolean value that indicates whether the pointer @@ -125,21 +125,21 @@ if selected by the event mask. .IP \fIpointer_mode\fP 1i Specifies further processing of pointer events. You can pass -.ZN GrabModeSync +.B GrabModeSync or -.ZN GrabModeAsync . +.BR GrabModeAsync . .SH DESCRIPTION The -.ZN XGrabButton +.B XGrabButton function establishes a passive grab. In the future, the pointer is actively grabbed (as for -.ZN XGrabPointer ), +.BR XGrabPointer ), the last-pointer-grab time is set to the time at which the button was pressed (as transmitted in the -.ZN ButtonPress +.B ButtonPress event), and the -.ZN ButtonPress +.B ButtonPress event is reported if all of the following conditions are true: .IP \(bu 5 The pointer is not grabbed, and the specified button is logically pressed @@ -154,12 +154,12 @@ A passive grab on the same button/key combination does not exist on any ancestor of grab_window. .LP The interpretation of the remaining arguments is as for -.ZN XGrabPointer . +.BR XGrabPointer . The active grab is terminated automatically when the logical state of the pointer has all buttons released (independent of the state of the logical modifier keys), at which point a -.ZN ButtonRelease +.B ButtonRelease event is reported to the grabbing window. .LP Note that the logical state of a device (as seen by client applications) @@ -168,78 +168,78 @@ may lag the physical state if device event processing is frozen. This request overrides all previous grabs by the same client on the same button/key combinations on the same window. A modifiers of -.ZN AnyModifier +.B AnyModifier is equivalent to issuing the grab request for all possible modifier combinations (including the combination of no modifiers). It is not required that all modifiers specified have currently assigned KeyCodes. A button of -.ZN AnyButton +.B AnyButton is equivalent to issuing the request for all possible buttons. Otherwise, it is not required that the specified button currently be assigned to a physical button. .LP If some other client has already issued a -.ZN XGrabButton +.B XGrabButton with the same button/key combination on the same window, a -.ZN BadAccess +.B BadAccess error results. When using -.ZN AnyModifier +.B AnyModifier or -.ZN AnyButton , +.BR AnyButton , the request fails completely, and a -.ZN BadAccess +.B BadAccess error results (no grabs are established) if there is a conflicting grab for any combination. -.ZN XGrabButton +.B XGrabButton has no effect on an active grab. .LP -.ZN XGrabButton +.B XGrabButton can generate -.ZN BadCursor , -.ZN BadValue , +.BR BadCursor , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XUngrabButton +.B XUngrabButton function releases the passive button/key combination on the specified window if it was grabbed by this client. A modifiers of -.ZN AnyModifier +.B AnyModifier is equivalent to issuing the ungrab request for all possible modifier combinations, including the combination of no modifiers. A button of -.ZN AnyButton +.B AnyButton is equivalent to issuing the request for all possible buttons. -.ZN XUngrabButton +.B XUngrabButton has no effect on an active grab. .LP -.ZN XUngrabButton +.B XUngrabButton can generate -.ZN BadValue +.B BadValue and -.ZN BadWindow +.B BadWindow errors. .SH DIAGNOSTICS .TP 1i -.ZN BadCursor +.B BadCursor A value for a Cursor argument does not name a defined Cursor. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllowEvents(__libmansuffix__), diff --git a/man/XGrabKey.man b/man/XGrabKey.man index 0ffc6661..478ff2c2 100644 --- a/man/XGrabKey.man +++ b/man/XGrabKey.man @@ -97,15 +97,15 @@ Specifies the grab window. .IP \fIkeyboard_mode\fP 1i Specifies further processing of keyboard events. You can pass -.ZN GrabModeSync +.B GrabModeSync or -.ZN GrabModeAsync . +.BR GrabModeAsync . .IP \fIkeycode\fP 1i Specifies the KeyCode or -.ZN AnyKey . +.BR AnyKey . .IP \fImodifiers\fP 1i Specifies the set of keymasks or -.ZN AnyModifier . +.BR AnyModifier . The mask is the bitwise inclusive OR of the valid keymask bits. .IP \fIowner_events\fP 1i Specifies a Boolean value that indicates whether the keyboard events @@ -113,21 +113,21 @@ are to be reported as usual. .IP \fIpointer_mode\fP 1i Specifies further processing of pointer events. You can pass -.ZN GrabModeSync +.B GrabModeSync or -.ZN GrabModeAsync . +.BR GrabModeAsync . .SH DESCRIPTION The -.ZN XGrabKey +.B XGrabKey function establishes a passive grab on the keyboard. In the future, the keyboard is actively grabbed (as for -.ZN XGrabKeyboard ), +.BR XGrabKeyboard ), the last-keyboard-grab time is set to the time at which the key was pressed (as transmitted in the -.ZN KeyPress +.B KeyPress event), and the -.ZN KeyPress +.B KeyPress event is reported if all of the following conditions are true: .IP \(bu 5 The keyboard is not grabbed and the specified key @@ -142,91 +142,91 @@ A passive grab on the same key combination does not exist on any ancestor of grab_window. .LP The interpretation of the remaining arguments is as for -.ZN XGrabKeyboard . +.BR XGrabKeyboard . The active grab is terminated automatically when the logical state of the keyboard has the specified key released (independent of the logical state of the modifier keys), at which point a -.ZN KeyRelease +.B KeyRelease event is reported to the grabbing window. .LP Note that the logical state of a device (as seen by client applications) may lag the physical state if device event processing is frozen. .LP A modifiers argument of -.ZN AnyModifier +.B AnyModifier is equivalent to issuing the request for all possible modifier combinations (including the combination of no modifiers). It is not required that all modifiers specified have currently assigned KeyCodes. A keycode argument of -.ZN AnyKey +.B AnyKey is equivalent to issuing the request for all possible KeyCodes. Otherwise, the specified keycode must be in the range specified by min_keycode and max_keycode in the connection setup, or a -.ZN BadValue +.B BadValue error results. .LP If some other client has issued a -.ZN XGrabKey +.B XGrabKey with the same key combination on the same window, a -.ZN BadAccess +.B BadAccess error results. When using -.ZN AnyModifier +.B AnyModifier or -.ZN AnyKey , +.BR AnyKey , the request fails completely, and a -.ZN BadAccess +.B BadAccess error results (no grabs are established) if there is a conflicting grab for any combination. .LP -.ZN XGrabKey +.B XGrabKey can generate -.ZN BadAccess , -.ZN BadValue , +.BR BadAccess , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XUngrabKey +.B XUngrabKey function releases the key combination on the specified window if it was grabbed by this client. It has no effect on an active grab. A modifiers of -.ZN AnyModifier +.B AnyModifier is equivalent to issuing the request for all possible modifier combinations (including the combination of no modifiers). A keycode argument of -.ZN AnyKey +.B AnyKey is equivalent to issuing the request for all possible key codes. .LP -.ZN XUngrabKey +.B XUngrabKey can generate -.ZN BadValue +.B BadValue and -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to grab a key/button combination already grabbed by another client. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllowEvents(__libmansuffix__), diff --git a/man/XGrabKeyboard.man b/man/XGrabKeyboard.man index 875fe3e5..ecfbd28d 100644 --- a/man/XGrabKeyboard.man +++ b/man/XGrabKeyboard.man @@ -96,136 +96,136 @@ Specifies the grab window. .IP \fIkeyboard_mode\fP 1i Specifies further processing of keyboard events. You can pass -.ZN GrabModeSync +.B GrabModeSync or -.ZN GrabModeAsync . +.BR GrabModeAsync . .IP \fIowner_events\fP 1i Specifies a Boolean value that indicates whether the keyboard events are to be reported as usual. .IP \fIpointer_mode\fP 1i Specifies further processing of pointer events. You can pass -.ZN GrabModeSync +.B GrabModeSync or -.ZN GrabModeAsync . +.BR GrabModeAsync . .IP \fItime\fP 1i Specifies the time. You can pass either a timestamp or -.ZN CurrentTime . +.BR CurrentTime . .SH DESCRIPTION The -.ZN XGrabKeyboard +.B XGrabKeyboard function actively grabs control of the keyboard and generates -.ZN FocusIn +.B FocusIn and -.ZN FocusOut +.B FocusOut events. Further key events are reported only to the grabbing client. -.ZN XGrabKeyboard +.B XGrabKeyboard overrides any active keyboard grab by this client. If owner_events is -.ZN False , +.BR False , all generated key events are reported with respect to grab_window. If owner_events is -.ZN True +.B True and if a generated key event would normally be reported to this client, it is reported normally; otherwise, the event is reported with respect to the grab_window. Both -.ZN KeyPress +.B KeyPress and -.ZN KeyRelease +.B KeyRelease events are always reported, independent of any event selection made by the client. .LP If the keyboard_mode argument is -.ZN GrabModeAsync , +.BR GrabModeAsync , keyboard event processing continues as usual. If the keyboard is currently frozen by this client, then processing of keyboard events is resumed. If the keyboard_mode argument is -.ZN GrabModeSync , +.BR GrabModeSync , the state of the keyboard (as seen by client applications) appears to freeze, and the X server generates no further keyboard events until the grabbing client issues a releasing -.ZN XAllowEvents +.B XAllowEvents call or until the keyboard grab is released. Actual keyboard changes are not lost while the keyboard is frozen; they are simply queued in the server for later processing. .LP If pointer_mode is -.ZN GrabModeAsync , +.BR GrabModeAsync , pointer event processing is unaffected by activation of the grab. If pointer_mode is -.ZN GrabModeSync , +.BR GrabModeSync , the state of the pointer (as seen by client applications) appears to freeze, and the X server generates no further pointer events until the grabbing client issues a releasing -.ZN XAllowEvents +.B XAllowEvents call or until the keyboard grab is released. Actual pointer changes are not lost while the pointer is frozen; they are simply queued in the server for later processing. .LP If the keyboard is actively grabbed by some other client, -.ZN XGrabKeyboard +.B XGrabKeyboard fails and returns -.ZN AlreadyGrabbed . +.BR AlreadyGrabbed . If grab_window is not viewable, it fails and returns -.ZN GrabNotViewable . +.BR GrabNotViewable . If the keyboard is frozen by an active grab of another client, it fails and returns -.ZN GrabFrozen . +.BR GrabFrozen . If the specified time is earlier than the last-keyboard-grab time or later than the current X server time, it fails and returns -.ZN GrabInvalidTime . +.BR GrabInvalidTime . Otherwise, the last-keyboard-grab time is set to the specified time .Pn ( CurrentTime is replaced by the current X server time). .LP -.ZN XGrabKeyboard +.B XGrabKeyboard can generate -.ZN BadValue +.B BadValue and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XUngrabKeyboard +.B XUngrabKeyboard function releases the keyboard and any queued events if this client has it actively grabbed from either -.ZN XGrabKeyboard +.B XGrabKeyboard or -.ZN XGrabKey . -.ZN XUngrabKeyboard +.BR XGrabKey . +.B XUngrabKeyboard does not release the keyboard and any queued events if the specified time is earlier than the last-keyboard-grab time or is later than the current X server time. It also generates -.ZN FocusIn +.B FocusIn and -.ZN FocusOut +.B FocusOut events. The X server automatically performs an -.ZN UngrabKeyboard +.B UngrabKeyboard request if the event window for an active keyboard grab becomes not viewable. .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllowEvents(__libmansuffix__), diff --git a/man/XGrabPointer.man b/man/XGrabPointer.man index b29d0c9d..20ca6870 100644 --- a/man/XGrabPointer.man +++ b/man/XGrabPointer.man @@ -95,10 +95,10 @@ int XChangeActivePointerGrab\^(\^Display *\fIdisplay\fP\^, unsigned int .SH ARGUMENTS .IP \fIconfine_to\fP 1i Specifies the window to confine the pointer in or -.ZN None . +.BR None . .IP \fIcursor\fP 1i Specifies the cursor that is to be displayed during the grab or -.ZN None . +.BR None . .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIevent_mask\fP 1i @@ -109,9 +109,9 @@ Specifies the grab window. .IP \fIkeyboard_mode\fP 1i Specifies further processing of keyboard events. You can pass -.ZN GrabModeSync +.B GrabModeSync or -.ZN GrabModeAsync . +.BR GrabModeAsync . .IP \fIowner_events\fP 1i Specifies a Boolean value that indicates whether the pointer events are to be reported as usual or reported with respect to the grab window @@ -119,29 +119,29 @@ if selected by the event mask. .IP \fIpointer_mode\fP 1i Specifies further processing of pointer events. You can pass -.ZN GrabModeSync +.B GrabModeSync or -.ZN GrabModeAsync . +.BR GrabModeAsync . .IP \fItime\fP 1i Specifies the time. You can pass either a timestamp or -.ZN CurrentTime . +.BR CurrentTime . .SH DESCRIPTION The -.ZN XGrabPointer +.B XGrabPointer function actively grabs control of the pointer and returns -.ZN GrabSuccess +.B GrabSuccess if the grab was successful. Further pointer events are reported only to the grabbing client. -.ZN XGrabPointer +.B XGrabPointer overrides any active pointer grab by this client. If owner_events is -.ZN False , +.BR False , all generated pointer events are reported with respect to grab_window and are reported only if selected by event_mask. If owner_events is -.ZN True +.B True and if a generated pointer event would normally be reported to this client, it is reported as usual. @@ -150,31 +150,31 @@ grab_window and is reported only if selected by event_mask. For either value of owner_events, unreported events are discarded. .LP If the pointer_mode is -.ZN GrabModeAsync , +.BR GrabModeAsync , pointer event processing continues as usual. If the pointer is currently frozen by this client, the processing of events for the pointer is resumed. If the pointer_mode is -.ZN GrabModeSync , +.BR GrabModeSync , the state of the pointer, as seen by client applications, appears to freeze, and the X server generates no further pointer events until the grabbing client calls -.ZN XAllowEvents +.B XAllowEvents or until the pointer grab is released. Actual pointer changes are not lost while the pointer is frozen; they are simply queued in the server for later processing. .LP If the keyboard_mode is -.ZN GrabModeAsync , +.BR GrabModeAsync , keyboard event processing is unaffected by activation of the grab. If the keyboard_mode is -.ZN GrabModeSync , +.BR GrabModeSync , the state of the keyboard, as seen by client applications, appears to freeze, and the X server generates no further keyboard events until the grabbing client calls -.ZN XAllowEvents +.B XAllowEvents or until the pointer grab is released. Actual keyboard changes are not lost while the pointer is frozen; they are simply queued in the server for later processing. @@ -182,7 +182,7 @@ they are simply queued in the server for later processing. If a cursor is specified, it is displayed regardless of what window the pointer is in. If -.ZN None +.B None is specified, the normal cursor for that window is displayed when the pointer is in grab_window or one of its subwindows; @@ -209,91 +209,91 @@ before the first application. The first application then will get an indication that the other application grabbed the pointer before its request was processed. .LP -.ZN XGrabPointer +.B XGrabPointer generates -.ZN EnterNotify +.B EnterNotify and -.ZN LeaveNotify +.B LeaveNotify events. .LP Either if grab_window or confine_to window is not viewable or if the confine_to window lies completely outside the boundaries of the root window, -.ZN XGrabPointer +.B XGrabPointer fails and returns -.ZN GrabNotViewable . +.BR GrabNotViewable . If the pointer is actively grabbed by some other client, it fails and returns -.ZN AlreadyGrabbed . +.BR AlreadyGrabbed . If the pointer is frozen by an active grab of another client, it fails and returns -.ZN GrabFrozen . +.BR GrabFrozen . If the specified time is earlier than the last-pointer-grab time or later than the current X server time, it fails and returns -.ZN GrabInvalidTime . +.BR GrabInvalidTime . Otherwise, the last-pointer-grab time is set to the specified time .Pn ( CurrentTime is replaced by the current X server time). .LP -.ZN XGrabPointer +.B XGrabPointer can generate -.ZN BadCursor , -.ZN BadValue , +.BR BadCursor , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XUngrabPointer +.B XUngrabPointer function releases the pointer and any queued events if this client has actively grabbed the pointer from -.ZN XGrabPointer , -.ZN XGrabButton , +.BR XGrabPointer , +.BR XGrabButton , or from a normal button press. -.ZN XUngrabPointer +.B XUngrabPointer does not release the pointer if the specified time is earlier than the last-pointer-grab time or is later than the current X server time. It also generates -.ZN EnterNotify +.B EnterNotify and -.ZN LeaveNotify +.B LeaveNotify events. The X server performs an -.ZN UngrabPointer +.B UngrabPointer request automatically if the event window or confine_to window for an active pointer grab becomes not viewable or if window reconfiguration causes the confine_to window to lie completely outside the boundaries of the root window. .LP The -.ZN XChangeActivePointerGrab +.B XChangeActivePointerGrab function changes the specified dynamic parameters if the pointer is actively grabbed by the client and if the specified time is no earlier than the last-pointer-grab time and no later than the current X server time. This function has no effect on the passive parameters of a -.ZN XGrabButton . +.BR XGrabButton . The interpretation of event_mask and cursor is the same as described in -.ZN XGrabPointer . +.BR XGrabPointer . .LP -.ZN XChangeActivePointerGrab +.B XChangeActivePointerGrab can generate a -.ZN BadCursor +.B BadCursor and -.ZN BadValue +.B BadValue error. .SH DIAGNOSTICS .TP 1i -.ZN BadCursor +.B BadCursor A value for a Cursor argument does not name a defined Cursor. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllowEvents(__libmansuffix__), diff --git a/man/XGrabServer.man b/man/XGrabServer.man index c0502313..9a23e629 100644 --- a/man/XGrabServer.man +++ b/man/XGrabServer.man @@ -91,13 +91,13 @@ int XUngrabServer\^(\^Display *\fIdisplay\fP\^); Specifies the connection to the X server. .SH DESCRIPTION The -.ZN XGrabServer +.B XGrabServer function disables processing of requests and close downs on all other connections than the one this request arrived on. You should not grab the X server any more than is absolutely necessary. .LP The -.ZN XUngrabServer +.B XUngrabServer function restarts processing of requests and close downs on other connections. You should avoid grabbing the X server as much as possible. .SH "SEE ALSO" diff --git a/man/XGraphicsExposeEvent.man b/man/XGraphicsExposeEvent.man index 9961f8c3..1bb20860 100644 --- a/man/XGraphicsExposeEvent.man +++ b/man/XGraphicsExposeEvent.man @@ -83,9 +83,9 @@ XGraphicsExposeEvent, XNoExposeEvent \- GraphicsExpose and NoExpose event structures .SH STRUCTURES The structures for -.ZN GraphicsExpose +.B GraphicsExpose and -.ZN NoExpose +.B NoExpose events contain: .LP .Ds 0 @@ -121,16 +121,16 @@ their structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -142,18 +142,18 @@ The drawable member is set to the drawable of the destination region on which the graphics request was to be performed. The major_code member is set to the graphics request initiated by the client and can be either -.ZN X_CopyArea +.B X_CopyArea or -.ZN X_CopyPlane . +.BR X_CopyPlane . If it is -.ZN X_CopyArea , +.BR X_CopyArea , a call to -.ZN XCopyArea +.B XCopyArea initiated the request. If it is -.ZN X_CopyPlane , +.BR X_CopyPlane , a call to -.ZN XCopyPlane +.B XCopyPlane initiated the request. These constants are defined in .hN X11/Xproto.h . @@ -166,19 +166,19 @@ X protocol and will be zero in these cases, although it may be used by an extension. .LP The -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure has these additional members: x, y, width, height, and count. The x and y members are set to the coordinates relative to the drawable's origin and indicate the upper-left corner of the rectangle. The width and height members are set to the size (extent) of the rectangle. The count member is set to the number of -.ZN GraphicsExpose +.B GraphicsExpose events to follow. If count is zero, no more -.ZN GraphicsExpose +.B GraphicsExpose events follow for this window. However, if count is nonzero, at least that number of -.ZN GraphicsExpose +.B GraphicsExpose events (and possibly more) are to follow for this window. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/man/XGravityEvent.man b/man/XGravityEvent.man index afdacc74..829d657a 100644 --- a/man/XGravityEvent.man +++ b/man/XGravityEvent.man @@ -83,7 +83,7 @@ XGravityEvent \- GravityNotify event structure .SH STRUCTURES The structure for -.ZN GravityNotify +.B GravityNotify events contains: .LP .Ds 0 @@ -104,16 +104,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -122,9 +122,9 @@ dispatchers. .LP The event member is set either to the window that was moved or to its parent, depending on whether -.ZN StructureNotify +.B StructureNotify or -.ZN SubstructureNotify +.B SubstructureNotify was selected. The window member is set to the child window that was moved. The x and y members are set to the coordinates relative to the diff --git a/man/XIconifyWindow.man b/man/XIconifyWindow.man index b11776e0..6b4b7446 100644 --- a/man/XIconifyWindow.man +++ b/man/XIconifyWindow.man @@ -103,63 +103,63 @@ the values structure. This mask is the bitwise inclusive OR of the valid configure window values bits. .IP \fIvalues\fP 1i Specifies the -.ZN XWindowChanges +.B XWindowChanges structure. .IP \fIw\fP 1i Specifies the window. .SH DESCRIPTION The -.ZN XIconifyWindow +.B XIconifyWindow function sends a WM_CHANGE_STATE -.ZN ClientMessage +.B ClientMessage event with a format of 32 and a first data element of -.ZN IconicState +.B IconicState (as described in section 4.1.4 of the \fIInter-Client Communication Conventions Manual\fP) and a window of w to the root window of the specified screen with an event mask set to -.ZN SubstructureNotifyMask | -.ZN SubstructureRedirectMask . +.BR SubstructureNotifyMask | +.BR SubstructureRedirectMask . Window managers may elect to receive this message and if the window is in its normal state, may treat it as a request to change the window's state from normal to iconic. If the WM_CHANGE_STATE property cannot be interned, -.ZN XIconifyWindow +.B XIconifyWindow does not send a message and returns a zero status. It returns a nonzero status if the client message is sent successfully; otherwise, it returns a zero status. .LP The -.ZN XWithdrawWindow +.B XWithdrawWindow function unmaps the specified window and sends a synthetic -.ZN UnmapNotify +.B UnmapNotify event to the root window of the specified screen. Window managers may elect to receive this message and may treat it as a request to change the window's state to withdrawn. When a window is in the withdrawn state, neither its normal nor its iconic representations is visible. It returns a nonzero status if the -.ZN UnmapNotify +.B UnmapNotify event is successfully sent; otherwise, it returns a zero status. .LP -.ZN XWithdrawWindow +.B XWithdrawWindow can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XReconfigureWMWindow +.B XReconfigureWMWindow function issues a -.ZN ConfigureWindow +.B ConfigureWindow request on the specified top-level window. If the stacking mode is changed and the request fails with a -.ZN BadMatch +.B BadMatch error, the error is trapped by Xlib and a synthetic -.ZN ConfigureRequestEvent +.B ConfigureRequestEvent containing the same configuration parameters is sent to the root of the specified window. Window managers may elect to receive this event @@ -167,21 +167,21 @@ and treat it as a request to reconfigure the indicated window. It returns a nonzero status if the request or event is successfully sent; otherwise, it returns a zero status. .LP -.ZN XReconfigureWMWindow +.B XReconfigureWMWindow can generate -.ZN BadValue +.B BadValue and -.ZN BadWindow +.B BadWindow errors. .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XChangeWindowAttributes(__libmansuffix__), diff --git a/man/XIfEvent.man b/man/XIfEvent.man index eab1030c..d7348b65 100644 --- a/man/XIfEvent.man +++ b/man/XIfEvent.man @@ -103,46 +103,46 @@ Specifies the procedure that is to be called to determine if the next event in the queue matches what you want. .SH DESCRIPTION The -.ZN XIfEvent +.B XIfEvent function completes only when the specified predicate procedure returns -.ZN True +.B True for an event, which indicates an event in the queue matches. -.ZN XIfEvent +.B XIfEvent flushes the output buffer if it blocks waiting for additional events. -.ZN XIfEvent +.B XIfEvent removes the matching event from the queue and copies the structure into the client-supplied -.ZN XEvent +.B XEvent structure. .LP When the predicate procedure finds a match, -.ZN XCheckIfEvent +.B XCheckIfEvent copies the matched event into the client-supplied -.ZN XEvent +.B XEvent structure and returns -.ZN True . +.BR True . (This event is removed from the queue.) If the predicate procedure finds no match, -.ZN XCheckIfEvent +.B XCheckIfEvent returns -.ZN False , +.BR False , and the output buffer will have been flushed. All earlier events stored in the queue are not discarded. .LP The -.ZN XPeekIfEvent +.B XPeekIfEvent function returns only when the specified predicate procedure returns -.ZN True +.B True for an event. After the predicate procedure finds a match, -.ZN XPeekIfEvent +.B XPeekIfEvent copies the matched event into the client-supplied -.ZN XEvent +.B XEvent structure without removing the event from the queue. -.ZN XPeekIfEvent +.B XPeekIfEvent flushes the output buffer if it blocks waiting for additional events. .LP Each of these functions requires you to pass a predicate procedure that @@ -155,7 +155,7 @@ If Xlib has been initialized for threads, the predicate is called with the display locked and the result of a call by the predicate to any Xlib function that locks the display is not defined unless the caller has first called -.ZN XLockDisplay . +.BR XLockDisplay . .LP The predicate procedure and its associated arguments are: .HP @@ -164,22 +164,22 @@ Bool (\^*\fIpredicate\fP\^)\^(\^Display *\fIdisplay\fP, XEvent *\fIevent\fP, XPo Specifies the connection to the X server. .IP \fIevent\fP 1i Specifies the -.ZN XEvent +.B XEvent structure. .IP \fIarg\fP 1i Specifies the argument passed in from the -.ZN XIfEvent , -.ZN XCheckIfEvent , +.BR XIfEvent , +.BR XCheckIfEvent , or -.ZN XPeekIfEvent +.B XPeekIfEvent function. .LP The predicate procedure is called once for each event in the queue until it finds a match. After finding a match, the predicate procedure must return -.ZN True . +.BR True . If it did not find a match, it must return -.ZN False . +.BR False . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XNextEvent(__libmansuffix__), diff --git a/man/XInitImage.man b/man/XInitImage.man index efd9478f..7a9614f7 100644 --- a/man/XInitImage.man +++ b/man/XInitImage.man @@ -119,10 +119,10 @@ Specifies the connection to the X server. .IP \fIformat\fP 1i Specifies the format for the image. You can pass -.ZN XYBitmap , -.ZN XYPixmap , +.BR XYBitmap , +.BR XYPixmap , or -.ZN ZPixmap . +.BR ZPixmap . .IP \fIheight\fP 1i Specifies the height of the image, in pixels. .IP \fIoffset\fP 1i @@ -137,7 +137,7 @@ Specifies the width of the new subimage, in pixels. Specifies the constant value that is to be added. .IP \fIvisual\fP 1i Specifies the -.ZN Visual +.B Visual structure. .IP \fIwidth\fP 1i Specifies the width of the image, in pixels. @@ -150,12 +150,12 @@ Specifies the image. Specify the x and y coordinates. .SH DESCRIPTION The -.ZN XInitImage +.B XInitImage function initializes the internal image manipulation routines of an image structure, based on the values of the various structure members. All fields other than the manipulation routines must already be initialized. If the bytes_per_line member is zero, -.ZN XInitImage +.B XInitImage will assume the image data is contiguous in memory and set the bytes_per_line member to an appropriate value based on the other members; otherwise, the value of bytes_per_line is not changed. @@ -173,18 +173,18 @@ structure is successful. It returns zero if it detected some error or inconsistency in the structure, in which case the image is not changed. .LP The -.ZN XCreateImage +.B XCreateImage function allocates the memory needed for an -.ZN XImage +.B XImage structure for the specified display but does not allocate space for the image itself. Rather, it initializes the structure byte-order, bit-order, and bitmap-unit values from the display and returns a pointer to the -.ZN XImage +.B XImage structure. The red, green, and blue mask values are defined for Z format images only and are derived from the -.ZN Visual +.B Visual structure passed in. Other values also are passed in. The offset permits the rapid displaying of the image without requiring each @@ -194,12 +194,12 @@ Xlib assumes that the scanlines are contiguous in memory and calculates the value of bytes_per_line itself. .LP Note that when the image is created using -.ZN XCreateImage , -.ZN XGetImage , +.BR XCreateImage , +.BR XGetImage , or -.ZN XSubImage , +.BR XSubImage , the destroy procedure that the -.ZN XDestroyImage +.B XDestroyImage function calls frees both the image structure and the data pointed to by the image structure. .LP @@ -210,7 +210,7 @@ in the image object and are defined in .hN X11/Xutil.h . .LP The -.ZN XGetPixel +.B XGetPixel function returns the specified pixel from the named image. The pixel value is returned in normalized format (that is, the least significant byte of the long is the least significant byte @@ -218,7 +218,7 @@ of the pixel). The image must contain the x and y coordinates. .LP The -.ZN XPutPixel +.B XPutPixel function overwrites the pixel in the named image with the specified pixel value. The input pixel value must be in normalized format (that is, the least significant byte of the long is the least significant @@ -226,10 +226,10 @@ byte of the pixel). The image must contain the x and y coordinates. .LP The -.ZN XSubImage +.B XSubImage function creates a new image that is a subsection of an existing one. It allocates the memory necessary for the new -.ZN XImage +.B XImage structure and returns a pointer to the new image. The data is copied from the source image, @@ -237,15 +237,15 @@ and the image must contain the rectangle defined by x, y, subimage_width, and subimage_height. .LP The -.ZN XAddPixel +.B XAddPixel function adds a constant value to every pixel in an image. It is useful when you have a base pixel value from allocating color resources and need to manipulate the image to that form. .LP The -.ZN XDestroyImage +.B XDestroyImage function deallocates the memory associated with the -.ZN XImage +.B XImage structure. .SH "SEE ALSO" XPutImage(__libmansuffix__) diff --git a/man/XInitThreads.man b/man/XInitThreads.man index 2ca98029..408a3174 100644 --- a/man/XInitThreads.man +++ b/man/XInitThreads.man @@ -93,7 +93,7 @@ void XUnlockDisplay\^(\^Display *\fIdisplay\fP\^); Specifies the connection to the X server. .SH DESCRIPTION The -.ZN XInitThreads +.B XInitThreads function initializes Xlib support for concurrent threads. This function must be the first Xlib function a multi-threaded program calls, and it must complete @@ -111,32 +111,32 @@ It is recommended that single-threaded programs not call this function. .LP The -.ZN XLockDisplay +.B XLockDisplay function locks out all other threads from using the specified display. Other threads attempting to use the display will block until the display is unlocked by this thread. Nested calls to -.ZN XLockDisplay +.B XLockDisplay work correctly; the display will not actually be unlocked until -.ZN XUnlockDisplay +.B XUnlockDisplay has been called the same number of times as -.ZN XLockDisplay . +.BR XLockDisplay . This function has no effect unless Xlib was successfully initialized for threads using -.ZN XInitThreads . +.BR XInitThreads . .LP The -.ZN XUnlockDisplay +.B XUnlockDisplay function allows other threads to use the specified display again. Any threads that have blocked on the display are allowed to continue. Nested locking works correctly; if -.ZN XLockDisplay +.B XLockDisplay has been called multiple times by a thread, then -.ZN XUnlockDisplay +.B XUnlockDisplay must be called an equal number of times before the display is actually unlocked. This function has no effect unless Xlib was successfully initialized for threads using -.ZN XInitThreads . +.BR XInitThreads . .SH "SEE ALSO" \fI\*(xL\fP diff --git a/man/XInstallColormap.man b/man/XInstallColormap.man index 880c1729..aaa7b52d 100644 --- a/man/XInstallColormap.man +++ b/man/XInstallColormap.man @@ -101,35 +101,35 @@ Returns the number of currently installed colormaps. Specifies the window that determines the screen. .SH DESCRIPTION The -.ZN XInstallColormap +.B XInstallColormap function installs the specified colormap for its associated screen. All windows associated with this colormap immediately display with true colors. You associated the windows with this colormap when you created them by calling -.ZN XCreateWindow , -.ZN XCreateSimpleWindow , -.ZN XChangeWindowAttributes , +.BR XCreateWindow , +.BR XCreateSimpleWindow , +.BR XChangeWindowAttributes , or -.ZN XSetWindowColormap . +.BR XSetWindowColormap . .LP If the specified colormap is not already an installed colormap, the X server generates a -.ZN ColormapNotify +.B ColormapNotify event on each window that has that colormap. In addition, for every other colormap that is installed as a result of a call to -.ZN XInstallColormap , +.BR XInstallColormap , the X server generates a -.ZN ColormapNotify +.B ColormapNotify event on each window that has that colormap. .LP -.ZN XInstallColormap +.B XInstallColormap can generate a -.ZN BadColor +.B BadColor error. .LP The -.ZN XUninstallColormap +.B XUninstallColormap function removes the specified colormap from the required list for its screen. As a result, @@ -140,40 +140,40 @@ except that the required list must remain installed. .LP If the specified colormap becomes uninstalled, the X server generates a -.ZN ColormapNotify +.B ColormapNotify event on each window that has that colormap. In addition, for every other colormap that is installed or uninstalled as a result of a call to -.ZN XUninstallColormap , +.BR XUninstallColormap , the X server generates a -.ZN ColormapNotify +.B ColormapNotify event on each window that has that colormap. .LP -.ZN XUninstallColormap +.B XUninstallColormap can generate a -.ZN BadColor +.B BadColor error. .LP The -.ZN XListInstalledColormaps +.B XListInstalledColormaps function returns a list of the currently installed colormaps for the screen of the specified window. The order of the colormaps in the list is not significant and is no explicit indication of the required list. When the allocated list is no longer needed, free it by using -.ZN XFree . +.BR XFree . .LP -.ZN XListInstalledColormaps +.B XListInstalledColormaps can generate a -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XChangeWindowAttributes(__libmansuffix__), diff --git a/man/XInternAtom.man b/man/XInternAtom.man index db74834a..2e3b5efc 100644 --- a/man/XInternAtom.man +++ b/man/XInternAtom.man @@ -114,16 +114,16 @@ Returns the atom names. Specifies a Boolean value that indicates whether the atom must be created. .SH DESCRIPTION The -.ZN XInternAtom +.B XInternAtom function returns the atom identifier associated with the specified atom_name string. If only_if_exists is -.ZN False , +.BR False , the atom is created if it does not exist. Therefore, -.ZN XInternAtom +.B XInternAtom can return -.ZN None . +.BR None . If the atom name is not in the Host Portable Character Encoding, the result is implementation-dependent. Uppercase and lowercase matter; @@ -133,19 +133,19 @@ The atom will remain defined even after the client's connection closes. It will become undefined only when the last connection to the X server closes. .LP -.ZN XInternAtom +.B XInternAtom can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XInternAtoms +.B XInternAtoms function returns the atom identifiers associated with the specified names. The atoms are stored in the atoms_return array supplied by the caller. Calling this function is equivalent to calling -.ZN XInternAtom +.B XInternAtom for each of the names in turn with the specified value of only_if_exists, but this function minimizes the number of round-trip protocol exchanges between the client and the X server. @@ -154,34 +154,34 @@ This function returns a nonzero status if atoms are returned for all of the names; otherwise, it returns zero. .LP -.ZN XInternAtoms +.B XInternAtoms can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XGetAtomName +.B XGetAtomName function returns the name associated with the specified atom. If the data returned by the server is in the Latin Portable Character Encoding, then the returned string is in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. To free the resulting string, call -.ZN XFree . +.BR XFree . .LP -.ZN XGetAtomName +.B XGetAtomName can generate a -.ZN BadAtom +.B BadAtom error. .LP The -.ZN XGetAtomNames +.B XGetAtomNames function returns the names associated with the specified atoms. The names are stored in the names_return array supplied by the caller. Calling this function is equivalent to calling -.ZN XGetAtomName +.B XGetAtomName for each of the atoms in turn, but this function minimizes the number of round-trip protocol exchanges between the client and the X server. @@ -190,19 +190,19 @@ This function returns a nonzero status if names are returned for all of the atoms; otherwise, it returns zero. .LP -.ZN XGetAtomNames +.B XGetAtomNames can generate a -.ZN BadAtom +.B BadAtom error. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadAtom +.B BadAtom A value for an Atom argument does not name a defined Atom. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XIntersectRegion.man b/man/XIntersectRegion.man index 9e30eef2..a654869f 100644 --- a/man/XIntersectRegion.man +++ b/man/XIntersectRegion.man @@ -125,33 +125,33 @@ Specify the two regions with which you want to perform the computation. Specifies the source region to be used. .SH DESCRIPTION The -.ZN XIntersectRegion +.B XIntersectRegion function computes the intersection of two regions. .LP The -.ZN XUnionRegion +.B XUnionRegion function computes the union of two regions. .LP The -.ZN XUnionRectWithRegion +.B XUnionRectWithRegion function updates the destination region from a union of the specified rectangle and the specified source region. .LP The -.ZN XSubtractRegion +.B XSubtractRegion function subtracts srb from sra and stores the results in dr_return. .LP The -.ZN XXorRegion +.B XXorRegion function calculates the difference between the union and intersection of two regions. .LP The -.ZN XOffsetRegion +.B XOffsetRegion function moves the specified region by a specified amount. .LP The -.ZN XShrinkRegion +.B XShrinkRegion function reduces the specified region by a specified amount. Positive values shrink the size of the region, and negative values expand the region. diff --git a/man/XKeymapEvent.man b/man/XKeymapEvent.man index 1fdb5165..ada18701 100644 --- a/man/XKeymapEvent.man +++ b/man/XKeymapEvent.man @@ -83,7 +83,7 @@ XKeymapEvent \- KeymapNotify event structure .SH STRUCTURES The structure for -.ZN KeymapNotify +.B KeymapNotify events contains: .LP .Ds 0 @@ -104,16 +104,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. diff --git a/man/XListFonts.man b/man/XListFonts.man index b386ae8a..3bd5bb31 100644 --- a/man/XListFonts.man +++ b/man/XListFonts.man @@ -121,10 +121,10 @@ Specifies the null-terminated pattern string that can contain wildcard characters. .SH DESCRIPTION The -.ZN XListFonts +.B XListFonts function returns an array of available font names (as controlled by the font search path; see -.ZN XSetFontPath ) +.BR XSetFontPath ) that match the string you passed to the pattern argument. The pattern string can contain any characters, but each asterisk (*) is a wildcard for any number of characters, @@ -137,26 +137,26 @@ If the data returned by the server is in the Latin Portable Character Encoding, then the returned strings are in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. If there are no matching font names, -.ZN XListFonts +.B XListFonts returns NULL. The client should call -.ZN XFreeFontNames +.B XFreeFontNames when finished with the result to free the memory. .LP The -.ZN XFreeFontNames +.B XFreeFontNames function frees the array and strings returned by -.ZN XListFonts +.B XListFonts or -.ZN XListFontsWithInfo . +.BR XListFontsWithInfo . .LP The -.ZN XListFontsWithInfo +.B XListFontsWithInfo function returns a list of font names that match the specified pattern and their associated font information. The list of names is limited to size specified by maxnames. The information returned for each font is identical to what -.ZN XLoadQueryFont +.B XLoadQueryFont would return except that the per-character metrics are not returned. The pattern string can contain any characters, but each asterisk (*) is a wildcard for any number of characters, @@ -169,33 +169,33 @@ If the data returned by the server is in the Latin Portable Character Encoding, then the returned strings are in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. If there are no matching font names, -.ZN XListFontsWithInfo +.B XListFontsWithInfo returns NULL. .LP To free only the allocated name array, the client should call -.ZN XFreeFontNames . +.BR XFreeFontNames . To free both the name array and the font information array or to free just the font information array, the client should call -.ZN XFreeFontInfo . +.BR XFreeFontInfo . .LP The -.ZN XFreeFontInfo +.B XFreeFontInfo function frees a font structure or an array of font structures and optionally an array of font names. If NULL is passed for names, no font names are freed. If a font structure for an open font (returned by -.ZN XLoadQueryFont ) +.BR XLoadQueryFont ) is passed, the structure is freed, but the font is not closed; use -.ZN XUnloadFont +.B XUnloadFont to close the font. .LP Note that -.ZN XListFontsWithInfo +.B XListFontsWithInfo is not thread-safe. If other threads make X requests on the same -.ZN Display , +.BR Display , then this function's behavior is undefined. .SH "SEE ALSO" XLoadFont(__libmansuffix__), diff --git a/man/XLoadFont.man b/man/XLoadFont.man index 2d2d1422..6b024ba5 100644 --- a/man/XLoadFont.man +++ b/man/XLoadFont.man @@ -115,7 +115,7 @@ Specifies the connection to the X server. Specifies the font. .IP \fIfont_ID\fP 1i Specifies the font ID or the -.ZN GContext +.B GContext ID. .IP \fIfont_struct\fP 1i Specifies the storage associated with the font. @@ -128,7 +128,7 @@ which is a null-terminated string. Returns the value of the font property. .SH DESCRIPTION The -.ZN XLoadFont +.B XLoadFont function loads the specified font and returns its associated font ID. If the font name is not in the Host Portable Character Encoding, the result is implementation-dependent. @@ -141,85 +141,85 @@ and the ``*'' character will match any number of characters. A structured format for font names is specified in the X Consortium standard \fIX Logical Font Description Conventions\fP. If -.ZN XLoadFont +.B XLoadFont was unsuccessful at loading the specified font, a -.ZN BadName +.B BadName error results. Fonts are not associated with a particular screen and can be stored as a component of any GC. When the font is no longer needed, call -.ZN XUnloadFont . +.BR XUnloadFont . .LP -.ZN XLoadFont +.B XLoadFont can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadName +.B BadName errors. .LP The -.ZN XQueryFont +.B XQueryFont function returns a pointer to the -.ZN XFontStruct +.B XFontStruct structure, which contains information associated with the font. You can query a font or the font stored in a GC. The font ID stored in the -.ZN XFontStruct +.B XFontStruct structure will be the -.ZN GContext +.B GContext ID, and you need to be careful when using this ID in other functions (see -.ZN XGContextFromGC ). +.BR XGContextFromGC ). If the font does not exist, -.ZN XQueryFont +.B XQueryFont returns NULL. To free this data, use -.ZN XFreeFontInfo . +.BR XFreeFontInfo . .LP -.ZN XLoadQueryFont +.B XLoadQueryFont can generate a -.ZN BadAlloc +.B BadAlloc error. .LP The -.ZN XLoadQueryFont +.B XLoadQueryFont function provides the most common way for accessing a font. -.ZN XLoadQueryFont +.B XLoadQueryFont both opens (loads) the specified font and returns a pointer to the appropriate -.ZN XFontStruct +.B XFontStruct structure. If the font name is not in the Host Portable Character Encoding, the result is implementation-dependent. If the font does not exist, -.ZN XLoadQueryFont +.B XLoadQueryFont returns NULL. .LP The -.ZN XFreeFont +.B XFreeFont function deletes the association between the font resource ID and the specified font and frees the -.ZN XFontStruct +.B XFontStruct structure. The font itself will be freed when no other resource references it. The data and the font should not be referenced again. .LP -.ZN XFreeFont +.B XFreeFont can generate a -.ZN BadFont +.B BadFont error. .LP Given the atom for that property, the -.ZN XGetFontProperty +.B XGetFontProperty function returns the value of the specified font property. -.ZN XGetFontProperty +.B XGetFontProperty also returns -.ZN False +.B False if the property was not defined or -.ZN True +.B True if it was defined. A set of predefined atoms exists for font properties, which can be found in @@ -230,29 +230,29 @@ Although it is not guaranteed, it is likely that the predefined font properties will be present. .LP The -.ZN XUnloadFont +.B XUnloadFont function deletes the association between the font resource ID and the specified font. The font itself will be freed when no other resource references it. The font should not be referenced again. .LP -.ZN XUnloadFont +.B XUnloadFont can generate a -.ZN BadFont +.B BadFont error. .SH STRUCTURES The -.ZN XFontStruct +.B XFontStruct structure contains all of the information for the font and consists of the font-specific information as well as a pointer to an array of -.ZN XCharStruct +.B XCharStruct structures for the characters contained in the font. The -.ZN XFontStruct , -.ZN XFontProp , +.BR XFontStruct , +.BR XFontProp , and -.ZN XCharStruct +.B XCharStruct structures contain: .LP .IN "XCharStruct" "" "@DEF@" @@ -317,25 +317,25 @@ Single byte/character fonts have one row defined, and the byte2 range specified in the structure defines a range of characters. .LP The bounding box of a character is defined by the -.ZN XCharStruct +.B XCharStruct of that character. When characters are absent from a font, the default_char is used. When fonts have all characters of the same size, only the information in the -.ZN XFontStruct +.B XFontStruct min and max bounds are used. .LP The members of the -.ZN XFontStruct +.B XFontStruct have the following semantics: .IP \(bu 5 The direction member can be either -.ZN FontLeftToRight +.B FontLeftToRight or -.ZN FontRightToLeft . +.BR FontRightToLeft . It is just a hint as to whether most -.ZN XCharStruct +.B XCharStruct elements have a positive .Pn ( FontLeftToRight ) @@ -372,7 +372,7 @@ inclusive have the same information, as given by both min_bounds and max_bounds. .IP \(bu 5 If all_chars_exist is -.ZN True , +.BR True , all characters in the per_char array have nonzero bounding boxes. .IP \(bu 5 The default_char member specifies the character that will be used when an @@ -386,7 +386,7 @@ no printing is performed for an undefined or nonexistent character. .IP \(bu 5 The min_bounds and max_bounds members contain the most extreme values of each individual -.ZN XCharStruct +.B XCharStruct component over all elements of this array (and ignore nonexistent characters). The bounding box of the font (the smallest @@ -426,7 +426,7 @@ For a character origin at [x,y], the bounding box of a character (that is, the smallest rectangle that encloses the character's shape) described in terms of -.ZN XCharStruct +.B XCharStruct components is a rectangle with its upper-left corner at: .LP .Ds @@ -462,13 +462,13 @@ from the origin. The width member defines the logical width of the character. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadFont +.B BadFont A value for a Font or GContext argument does not name a defined Font. .TP 1i -.ZN BadName +.B BadName A font or color of the specified name does not exist. .SH "SEE ALSO" XCreateGC(__libmansuffix__), diff --git a/man/XLookupKeysym.man b/man/XLookupKeysym.man index 9397f03e..a271f193 100644 --- a/man/XLookupKeysym.man +++ b/man/XLookupKeysym.man @@ -109,16 +109,16 @@ Specifies the mapping event that is to be used. .IP \fIevent_struct\fP 1i Specifies the key event structure to be used. You can pass -.ZN XKeyPressedEvent +.B XKeyPressedEvent or -.ZN XKeyReleasedEvent . +.BR XKeyReleasedEvent . .IP \fIindex\fP 1i Specifies the index into the KeySyms list for the event's KeyCode. .IP \fIkey_event\fP 1i Specifies the -.ZN KeyPress +.B KeyPress or -.ZN KeyRelease +.B KeyRelease event. .IP \fIkeysym\fP 1i Specifies the KeySym that is to be returned. @@ -130,72 +130,72 @@ Specifies the KeySyms to be used as modifiers. Specifies the number of modifiers in the modifier list. .IP \fIstatus_in_out\fP 1i Specifies or returns the -.ZN XComposeStatus +.B XComposeStatus structure or NULL. .IP \fIstring\fP 1i Specifies the string that is copied and will be returned by -.ZN XLookupString . +.BR XLookupString . .SH DESCRIPTION The -.ZN XLookupKeysym +.B XLookupKeysym function uses a given keyboard event and the index you specified to return the KeySym from the list that corresponds to the KeyCode member in the -.ZN XKeyPressedEvent +.B XKeyPressedEvent or -.ZN XKeyReleasedEvent +.B XKeyReleasedEvent structure. If no KeySym is defined for the KeyCode of the event, -.ZN XLookupKeysym +.B XLookupKeysym returns -.ZN NoSymbol . +.BR NoSymbol . .LP The -.ZN XRefreshKeyboardMapping +.B XRefreshKeyboardMapping function refreshes the stored modifier and keymap information. You usually call this function when a -.ZN MappingNotify +.B MappingNotify event with a request member of -.ZN MappingKeyboard +.B MappingKeyboard or -.ZN MappingModifier +.B MappingModifier occurs. The result is to update Xlib's knowledge of the keyboard. .LP The -.ZN XLookupString +.B XLookupString function translates a key event to a KeySym and a string. The KeySym is obtained by using the standard interpretation of the -.ZN Shift , -.ZN Lock , +.BR Shift , +.BR Lock , group, and numlock modifiers as defined in the X Protocol specification. If the KeySym has been rebound (see -.ZN XRebindKeysym ), +.BR XRebindKeysym ), the bound string will be stored in the buffer. Otherwise, the KeySym is mapped, if possible, to an ISO Latin-1 character or (if the Control modifier is on) to an ASCII control character, and that character is stored in the buffer. -.ZN XLookupString +.B XLookupString returns the number of characters that are stored in the buffer. .LP If present (non-NULL), the -.ZN XComposeStatus +.B XComposeStatus structure records the state, which is private to Xlib, that needs preservation across calls to -.ZN XLookupString +.B XLookupString to implement compose processing. The creation of -.ZN XComposeStatus +.B XComposeStatus structures is implementation-dependent; a portable program must pass NULL for this argument. .LP The -.ZN XRebindKeysym +.B XRebindKeysym function can be used to rebind the meaning of a KeySym for the client. It does not redefine any key in the X server but merely provides an easy way for long strings to be attached to keys. -.ZN XLookupString +.B XLookupString returns this string when the appropriate set of modifier keys are pressed and when the KeySym would have been used for the translation. diff --git a/man/XMapEvent.man b/man/XMapEvent.man index 1251c24d..8c64e1be 100644 --- a/man/XMapEvent.man +++ b/man/XMapEvent.man @@ -83,7 +83,7 @@ XMapEvent, XMappingEvent \- MapNotify and MappingNotify event structures .SH STRUCTURES The structure for -.ZN MapNotify +.B MapNotify events contains: .LP .Ds 0 @@ -104,16 +104,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -122,21 +122,21 @@ dispatchers. .LP The event member is set either to the window that was mapped or to its parent, depending on whether -.ZN StructureNotify +.B StructureNotify or -.ZN SubstructureNotify +.B SubstructureNotify was selected. The window member is set to the window that was mapped. The override_redirect member is set to the override-redirect attribute of the window. Window manager clients normally should ignore this window if the override-redirect attribute is -.ZN True , +.BR True , because these events usually are generated from pop-ups, which override structure control. .LP The structure for -.ZN MappingNotify +.B MappingNotify events is: .LP .Ds 0 @@ -159,16 +159,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -177,21 +177,21 @@ dispatchers. .LP The request member is set to indicate the kind of mapping change that occurred and can be -.ZN MappingModifier , -.ZN MappingKeyboard , -.ZN MappingPointer . +.BR MappingModifier , +.BR MappingKeyboard , +.BR MappingPointer . If it is -.ZN MappingModifier , +.BR MappingModifier , the modifier mapping was changed. If it is -.ZN MappingKeyboard , +.BR MappingKeyboard , the keyboard mapping was changed. If it is -.ZN MappingPointer , +.BR MappingPointer , the pointer button mapping was changed. The first_keycode and count members are set only if the request member was set to -.ZN MappingKeyboard . +.BR MappingKeyboard . The number in first_keycode represents the first number in the range of the altered mapping, and count represents the number of keycodes altered. diff --git a/man/XMapRequestEvent.man b/man/XMapRequestEvent.man index 30fc860a..b6ea5bd3 100644 --- a/man/XMapRequestEvent.man +++ b/man/XMapRequestEvent.man @@ -83,7 +83,7 @@ XMapRequestEvent \- MapRequest event structure .SH STRUCTURES The structure for -.ZN MapRequest +.B MapRequest events contains: .LP .Ds 0 @@ -103,16 +103,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. diff --git a/man/XMapWindow.man b/man/XMapWindow.man index 94d28f18..ad56d975 100644 --- a/man/XMapWindow.man +++ b/man/XMapWindow.man @@ -95,7 +95,7 @@ Specifies the connection to the X server. Specifies the window. .SH DESCRIPTION The -.ZN XMapWindow +.B XMapWindow function maps the window and all of its subwindows that have had map requests. @@ -109,16 +109,16 @@ and will be visible on the screen if it is not obscured by another window. This function has no effect if the window is already mapped. .LP If the override-redirect of the window is -.ZN False +.B False and if some other client has selected -.ZN SubstructureRedirectMask +.B SubstructureRedirectMask on the parent window, then the X server generates a -.ZN MapRequest +.B MapRequest event, and the -.ZN XMapWindow +.B XMapWindow function does not map the window. Otherwise, the window is mapped, and the X server generates a -.ZN MapNotify +.B MapNotify event. .LP If the window becomes viewable and no earlier contents for it are remembered, @@ -126,10 +126,10 @@ the X server tiles the window with its background. If the window's background is undefined, the existing screen contents are not altered, and the X server generates zero or more -.ZN Expose +.B Expose events. If backing-store was maintained while the window was unmapped, no -.ZN Expose +.B Expose events are generated. If backing-store will now be maintained, @@ -139,71 +139,71 @@ Similar tiling and exposure take place for any newly viewable inferiors. .LP .IN "XMapWindow" If the window is an -.ZN InputOutput +.B InputOutput window, -.ZN XMapWindow +.B XMapWindow generates -.ZN Expose +.B Expose events on each -.ZN InputOutput +.B InputOutput window that it causes to be displayed. If the client maps and paints the window and if the client begins processing events, the window is painted twice. To avoid this, first ask for -.ZN Expose +.B Expose events and then map the window, so the client processes input events as usual. The event list will include -.ZN Expose +.B Expose for each window that has appeared on the screen. The client's normal response to an -.ZN Expose +.B Expose event should be to repaint the window. This method usually leads to simpler programs and to proper interaction with window managers. .LP -.ZN XMapWindow +.B XMapWindow can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XMapRaised +.B XMapRaised function essentially is similar to -.ZN XMapWindow +.B XMapWindow in that it maps the window and all of its subwindows that have had map requests. However, it also raises the specified window to the top of the stack. .LP -.ZN XMapRaised +.B XMapRaised can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XMapSubwindows +.B XMapSubwindows .IN "XMapSubwindows" function maps all subwindows for a specified window in top-to-bottom stacking order. The X server generates -.ZN Expose +.B Expose events on each newly displayed window. This may be much more efficient than mapping many windows one at a time because the server needs to perform much of the work only once, for all of the windows, rather than for each window. .LP -.ZN XMapSubwindows +.B XMapSubwindows can generate a -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XChangeWindowAttributes(__libmansuffix__), diff --git a/man/XNextEvent.man b/man/XNextEvent.man index fb435b0d..b2ef6833 100644 --- a/man/XNextEvent.man +++ b/man/XNextEvent.man @@ -121,121 +121,121 @@ Specifies the event type to be compared. Specifies the window whose event you are interested in. .SH DESCRIPTION The -.ZN XNextEvent +.B XNextEvent function copies the first event from the event queue into the specified -.ZN XEvent +.B XEvent structure and then removes it from the queue. If the event queue is empty, -.ZN XNextEvent +.B XNextEvent flushes the output buffer and blocks until an event is received. .LP The -.ZN XPeekEvent +.B XPeekEvent function returns the first event from the event queue, but it does not remove the event from the queue. If the queue is empty, -.ZN XPeekEvent +.B XPeekEvent flushes the output buffer and blocks until an event is received. It then copies the event into the client-supplied -.ZN XEvent +.B XEvent structure without removing it from the event queue. .LP The -.ZN XWindowEvent +.B XWindowEvent function searches the event queue for an event that matches both the specified window and event mask. When it finds a match, -.ZN XWindowEvent +.B XWindowEvent removes that event from the queue and copies it into the specified -.ZN XEvent +.B XEvent structure. The other events stored in the queue are not discarded. If a matching event is not in the queue, -.ZN XWindowEvent +.B XWindowEvent flushes the output buffer and blocks until one is received. .LP The -.ZN XCheckWindowEvent +.B XCheckWindowEvent function searches the event queue and then the events available on the server connection for the first event that matches the specified window and event mask. If it finds a match, -.ZN XCheckWindowEvent +.B XCheckWindowEvent removes that event, copies it into the specified -.ZN XEvent +.B XEvent structure, and returns -.ZN True . +.BR True . The other events stored in the queue are not discarded. If the event you requested is not available, -.ZN XCheckWindowEvent +.B XCheckWindowEvent returns -.ZN False , +.BR False , and the output buffer will have been flushed. .LP The -.ZN XMaskEvent +.B XMaskEvent function searches the event queue for the events associated with the specified mask. When it finds a match, -.ZN XMaskEvent +.B XMaskEvent removes that event and copies it into the specified -.ZN XEvent +.B XEvent structure. The other events stored in the queue are not discarded. If the event you requested is not in the queue, -.ZN XMaskEvent +.B XMaskEvent flushes the output buffer and blocks until one is received. .LP The -.ZN XCheckMaskEvent +.B XCheckMaskEvent function searches the event queue and then any events available on the server connection for the first event that matches the specified mask. If it finds a match, -.ZN XCheckMaskEvent +.B XCheckMaskEvent removes that event, copies it into the specified -.ZN XEvent +.B XEvent structure, and returns -.ZN True . +.BR True . The other events stored in the queue are not discarded. If the event you requested is not available, -.ZN XCheckMaskEvent +.B XCheckMaskEvent returns -.ZN False , +.BR False , and the output buffer will have been flushed. .LP The -.ZN XCheckTypedEvent +.B XCheckTypedEvent function searches the event queue and then any events available on the server connection for the first event that matches the specified type. If it finds a match, -.ZN XCheckTypedEvent +.B XCheckTypedEvent removes that event, copies it into the specified -.ZN XEvent +.B XEvent structure, and returns -.ZN True . +.BR True . The other events in the queue are not discarded. If the event is not available, -.ZN XCheckTypedEvent +.B XCheckTypedEvent returns -.ZN False , +.BR False , and the output buffer will have been flushed. .LP The -.ZN XCheckTypedWindowEvent +.B XCheckTypedWindowEvent function searches the event queue and then any events available on the server connection for the first event that matches the specified type and window. If it finds a match, -.ZN XCheckTypedWindowEvent +.B XCheckTypedWindowEvent removes the event from the queue, copies it into the specified -.ZN XEvent +.B XEvent structure, and returns -.ZN True . +.BR True . The other events in the queue are not discarded. If the event is not available, -.ZN XCheckTypedWindowEvent +.B XCheckTypedWindowEvent returns -.ZN False , +.BR False , and the output buffer will have been flushed. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/man/XNoOp.man b/man/XNoOp.man index 6851ff3e..d768343e 100644 --- a/man/XNoOp.man +++ b/man/XNoOp.man @@ -88,9 +88,9 @@ int XNoOp\^(\^Display *\fIdisplay\fP\^); Specifies the connection to the X server. .SH DESCRIPTION The -.ZN XNoOp +.B XNoOp function sends a -.ZN NoOperation +.B NoOperation protocol request to the X server, thereby exercising the connection. .SH "SEE ALSO" diff --git a/man/XOpenDisplay.man b/man/XOpenDisplay.man index 30859b21..247d27c1 100644 --- a/man/XOpenDisplay.man +++ b/man/XOpenDisplay.man @@ -97,13 +97,13 @@ it defaults to the value of the DISPLAY environment variable. .IN "Environment" "DISPLAY" .SH DESCRIPTION The -.ZN XOpenDisplay +.B XOpenDisplay function returns a -.ZN Display +.B Display structure that serves as the connection to the X server and that contains all the information about that X server. -.ZN XOpenDisplay +.B XOpenDisplay connects your application to the X server through TCP or DECnet communications protocols, or through some local inter-process communication protocol. @@ -111,13 +111,13 @@ or through some local inter-process communication protocol. .IN "Protocol" "DECnet" If the hostname is a host machine name and a single colon (:) separates the hostname and display number, -.ZN XOpenDisplay +.B XOpenDisplay connects using TCP streams. If the hostname is not specified, Xlib uses whatever it believes is the fastest transport. If the hostname is a host machine name and a double colon (::) separates the hostname and display number, -.ZN XOpenDisplay +.B XOpenDisplay connects using DECnet. A single X server can support any or all of these transport mechanisms simultaneously. @@ -126,66 +126,66 @@ mechanisms. .LP .IN "Display" If successful, -.ZN XOpenDisplay +.B XOpenDisplay returns a pointer to a -.ZN Display +.B Display structure, which is defined in .hN X11/Xlib.h . If -.ZN XOpenDisplay +.B XOpenDisplay does not succeed, it returns NULL. After a successful call to -.ZN XOpenDisplay , +.BR XOpenDisplay , all of the screens in the display can be used by the client. The screen number specified in the display_name argument is returned by the -.ZN DefaultScreen +.B DefaultScreen macro (or the -.ZN XDefaultScreen +.B XDefaultScreen function). You can access elements of the -.ZN Display +.B Display and -.ZN Screen +.B Screen structures only by using the information macros or functions. For information about using macros and functions to obtain information from the -.ZN Display +.B Display structure, see section 2.2.1. .LP The -.ZN XCloseDisplay +.B XCloseDisplay function closes the connection to the X server for the display specified in the -.ZN Display +.B Display structure and destroys all windows, resource IDs .Pn ( Window , -.ZN Font , -.ZN Pixmap , -.ZN Colormap , -.ZN Cursor , +.BR Font , +.BR Pixmap , +.BR Colormap , +.BR Cursor , and -.ZN GContext ), +.BR GContext ), or other resources that the client has created on this display, unless the close-down mode of the resource has been changed (see -.ZN XSetCloseDownMode ). +.BR XSetCloseDownMode ). Therefore, these windows, resource IDs, and other resources should never be referenced again or an error will be generated. Before exiting, you should call -.ZN XCloseDisplay +.B XCloseDisplay explicitly so that any pending errors are reported as -.ZN XCloseDisplay +.B XCloseDisplay performs a final -.ZN XSync +.B XSync operation. .IN "Resource IDs" .IN "XCloseDisplay" .LP -.ZN XCloseDisplay +.B XCloseDisplay can generate a -.ZN BadGC +.B BadGC error. .SH "SEE ALSO" AllPlanes(__libmansuffix__), diff --git a/man/XOpenIM.man b/man/XOpenIM.man index 3176f0fc..e4506ac1 100644 --- a/man/XOpenIM.man +++ b/man/XOpenIM.man @@ -123,25 +123,25 @@ Specifies the full resource name of the application. Specifies the variable length argument list to set or get XIM values. .SH DESCRIPTION The -.ZN XOpenIM +.B XOpenIM function opens an input method, matching the current locale and modifiers specification. Current locale and modifiers are bound to the input method at opening time. The locale associated with an input method cannot be changed dynamically. This implies that the strings returned by -.ZN XmbLookupString +.B XmbLookupString or -.ZN XwcLookupString , +.BR XwcLookupString , for any input context affiliated with a given input method will be encoded in the locale current at the time the input method is opened. .LP The specific input method to which this call will be routed is identified on the basis of the current locale. -.ZN XOpenIM +.B XOpenIM will identify a default input method corresponding to the current locale. That default can be modified using -.ZN XSetLocaleModifiers +.B XSetLocaleModifiers for the input method modifier. .LP The db argument is the resource database to be used by the input method @@ -163,19 +163,19 @@ if res_name or res_class is NULL. .LP The res_name and res_class arguments are not assumed to exist beyond the call to -.ZN XOpenIM . +.BR XOpenIM . The specified resource database is assumed to exist for the lifetime of the input method. .LP -.ZN XOpenIM +.B XOpenIM returns NULL if no input method could be opened. .LP The -.ZN XCloseIM +.B XCloseIM function closes the specified input method. .LP The -.ZN XSetIMValues +.B XSetIMValues function presents a variable argument list programming interface for setting attributes of the specified input method. It returns NULL if it succeeds; @@ -187,7 +187,7 @@ all arguments in the list preceding the failed argument have been set correctly. .LP The -.ZN XGetIMValues +.B XGetIMValues function presents a variable argument list programming interface for querying properties or features of the specified input method. This function returns NULL if it succeeds; @@ -200,39 +200,39 @@ That is, if the XIM value is of type T, the argument must be of type T*. If T itself is a pointer type, then -.ZN XGetIMValues +.B XGetIMValues allocates memory to store the actual data, and the client is responsible for freeing this data by calling -.ZN XFree +.B XFree with the returned pointer. .LP The -.ZN XDisplayOfIM +.B XDisplayOfIM function returns the display associated with the specified input method. .LP The -.ZN XLocaleOfIM +.B XLocaleOfIM function returns the locale associated with the specified input method. .LP The -.ZN XRegisterIMInstantiateCallback +.B XRegisterIMInstantiateCallback function registers a callback to be invoked whenever a new input method becomes available for the specified display that matches the current locale and modifiers. .LP The function returns -.ZN True +.B True if it succeeds; otherwise, it returns -.ZN False . +.BR False . .LP The -.ZN XUnregisterIMInstantiateCallback +.B XUnregisterIMInstantiateCallback function removes an input method instantiation callback previously registered. The function returns -.ZN True +.B True if it succeeds; otherwise, it returns -.ZN False . +.BR False . .SH "SEE ALSO" XCreateIC(__libmansuffix__), XSetICFocus(__libmansuffix__), diff --git a/man/XOpenOM.man b/man/XOpenOM.man index a8cc7eba..bed66318 100644 --- a/man/XOpenOM.man +++ b/man/XOpenOM.man @@ -111,22 +111,22 @@ Specifies the output method. Specifies the variable length argument list to set or get XOM values. .SH DESCRIPTION The -.ZN XOpenOM +.B XOpenOM function opens an output method matching the current locale and modifiers specification. The current locale and modifiers are bound to the output method when -.ZN XOpenOM +.B XOpenOM is called. The locale associated with an output method cannot be changed. .LP The specific output method to which this call will be routed is identified on the basis of the current locale and modifiers. -.ZN XOpenOM +.B XOpenOM will identify a default output method corresponding to the current locale. That default can be modified using -.ZN XSetLocaleModifiers +.B XSetLocaleModifiers to set the output method modifier. .LP The db argument is the resource database to be used by the output method @@ -148,19 +148,19 @@ if res_name or res_class is NULL. .LP The res_name and res_class arguments are not assumed to exist beyond the call to -.ZN XOpenOM . +.BR XOpenOM . The specified resource database is assumed to exist for the lifetime of the output method. .LP -.ZN XOpenOM +.B XOpenOM returns NULL if no output method could be opened. .LP The -.ZN XCloseOM +.B XCloseOM function closes the specified output method. .LP The -.ZN XSetOMValues +.B XSetOMValues function presents a variable argument list programming interface for setting properties or features of the specified output method. This function returns NULL if it succeeds; @@ -174,7 +174,7 @@ correctly. No standard arguments are currently defined by Xlib. .LP The -.ZN XGetOMValues +.B XGetOMValues function presents a variable argument list programming interface for querying properties or features of the specified output method. This function returns NULL if it succeeds; @@ -182,11 +182,11 @@ otherwise, it returns the name of the first argument that could not be obtained. .LP The -.ZN XDisplayOfOM +.B XDisplayOfOM function returns the display associated with the specified output method. .LP The -.ZN XLocaleOfOM +.B XLocaleOfOM returns the locale associated with the specified output method. .SH "SEE ALSO" XCreateOC(__libmansuffix__), diff --git a/man/XParseGeometry.man b/man/XParseGeometry.man index 50a95aba..99a595d3 100644 --- a/man/XParseGeometry.man +++ b/man/XParseGeometry.man @@ -137,7 +137,7 @@ Specifies the user-specified geometry or NULL. .SH DESCRIPTION By convention, X applications use a standard string to indicate window size and placement. -.ZN XParseGeometry +.B XParseGeometry makes it easier to conform to this standard because it allows you to parse the standard window geometry. Specifically, this function lets you parse strings of the form: @@ -156,7 +156,7 @@ If the string is not in the Host Portable Character Encoding, the result is implementation-dependent. .LP The -.ZN XParseGeometry +.B XParseGeometry function returns a bitmask that indicates which of the four values (width, height, xoffset, and yoffset) were actually found in the string and whether the x and y values are negative. @@ -165,47 +165,47 @@ be able to say ``position the window relative to the right or bottom edge.'' For each value found, the corresponding argument is updated. For each value not found, the argument is left unchanged. The bits are represented by -.ZN XValue , -.ZN YValue , -.ZN WidthValue , -.ZN HeightValue , -.ZN XNegative , +.BR XValue , +.BR YValue , +.BR WidthValue , +.BR HeightValue , +.BR XNegative , or -.ZN YNegative +.B YNegative and are defined in .hN X11/Xutil.h . They will be set whenever one of the values is defined or one of the signs is set. .LP If the function returns either the -.ZN XValue +.B XValue or -.ZN YValue +.B YValue flag, you should place the window at the requested position. .LP The -.ZN XWMGeometry +.B XWMGeometry function combines any geometry information (given in the format used by -.ZN XParseGeometry ) +.BR XParseGeometry ) specified by the user and by the calling program with size hints (usually the ones to be stored in WM_NORMAL_HINTS) and returns the position, size, and gravity .Pn ( NorthWestGravity , -.ZN NorthEastGravity , -.ZN SouthEastGravity , +.BR NorthEastGravity , +.BR SouthEastGravity , or -.ZN SouthWestGravity ) +.BR SouthWestGravity ) that describe the window. If the base size is not set in the -.ZN XSizeHints +.B XSizeHints structure, the minimum size is used if set. Otherwise, a base size of zero is assumed. If no minimum size is set in the hints structure, the base size is used. A mask (in the form returned by -.ZN XParseGeometry ) +.BR XParseGeometry ) that describes which values came from the user specification and whether or not the position coordinates are relative to the right and bottom edges is returned. diff --git a/man/XPolygonRegion.man b/man/XPolygonRegion.man index 81bb1439..80a209ad 100644 --- a/man/XPolygonRegion.man +++ b/man/XPolygonRegion.man @@ -91,9 +91,9 @@ int XClipBox\^(\^Region \fIr\fP\^, XRectangle *\fIrect_return\fP\^); .IP \fIfill_rule\fP 1i Specifies the fill-rule you want to set for the specified GC. You can pass -.ZN EvenOddRule +.B EvenOddRule or -.ZN WindingRule . +.BR WindingRule . .IP \fIn\fP 1i Specifies the number of points in the polygon. .IP \fIpoints\fP 1i @@ -104,14 +104,14 @@ Specifies the region. Returns the smallest enclosing rectangle. .SH DESCRIPTION The -.ZN XPolygonRegion +.B XPolygonRegion function returns a region for the polygon defined by the points array. For an explanation of fill_rule, see -.ZN XCreateGC . +.BR XCreateGC . .LP The -.ZN XClipBox +.B XClipBox function returns the smallest rectangle enclosing the specified region. .SH "SEE ALSO" XCreateGC(__libmansuffix__), diff --git a/man/XPropertyEvent.man b/man/XPropertyEvent.man index e9a40c25..7c00db6a 100644 --- a/man/XPropertyEvent.man +++ b/man/XPropertyEvent.man @@ -83,7 +83,7 @@ XPropertyEvent \- PropertyNotify event structure .SH STRUCTURES The structure for -.ZN PropertyNotify +.B PropertyNotify events contains: .LP .Ds 0 @@ -105,16 +105,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -128,28 +128,28 @@ property was changed or desired. The time member is set to the server time when the property was changed. The state member is set to indicate whether the property was changed to a new value or deleted and can be -.ZN PropertyNewValue +.B PropertyNewValue or -.ZN PropertyDelete . +.BR PropertyDelete . The state member is set to -.ZN PropertyNewValue +.B PropertyNewValue when a property of the window is changed using -.ZN XChangeProperty +.B XChangeProperty or -.ZN XRotateWindowProperties +.B XRotateWindowProperties (even when adding zero-length data using -.ZN XChangeProperty ) +.BR XChangeProperty ) and when replacing all or part of a property with identical data using -.ZN XChangeProperty +.B XChangeProperty or -.ZN XRotateWindowProperties . +.BR XRotateWindowProperties . The state member is set to -.ZN PropertyDelete +.B PropertyDelete when a property of the window is deleted using -.ZN XDeleteProperty +.B XDeleteProperty or, if the delete argument is -.ZN True , -.ZN XGetWindowProperty . +.BR True , +.BR XGetWindowProperty . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/man/XPutBackEvent.man b/man/XPutBackEvent.man index 9360ebe1..f130cc8f 100644 --- a/man/XPutBackEvent.man +++ b/man/XPutBackEvent.man @@ -91,13 +91,13 @@ Specifies the connection to the X server. Specifies the event. .SH DESCRIPTION The -.ZN XPutBackEvent +.B XPutBackEvent function pushes an event back onto the head of the display's event queue by copying the event into the queue. This can be useful if you read an event and then decide that you would rather deal with it later. There is no limit to the number of times in succession that you can call -.ZN XPutBackEvent . +.BR XPutBackEvent . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XIfEvent(__libmansuffix__), diff --git a/man/XPutImage.man b/man/XPutImage.man index 81fc7281..db0397df 100644 --- a/man/XPutImage.man +++ b/man/XPutImage.man @@ -116,9 +116,9 @@ Specifies the connection to the X server. .IP \fIformat\fP 1i Specifies the format for the image. You can pass -.ZN XYPixmap +.B XYPixmap or -.ZN ZPixmap . +.BR ZPixmap . .IP \fIgc\fP 1i Specifies the GC. .IP \fIimage\fP 1i @@ -129,12 +129,12 @@ Specifies the plane mask. .IP \fIsrc_x\fP 1i Specifies the offset in X from the left edge of the image defined by the -.ZN XImage +.B XImage structure. .IP \fIsrc_y\fP 1i Specifies the offset in Y from the top edge of the image defined by the -.ZN XImage +.B XImage structure. .IP \fIwidth\fP 1i .br @@ -150,31 +150,31 @@ Specify the x and y coordinates, which are relative to the origin of the drawabl and define the upper-left corner of the rectangle. .SH DESCRIPTION The -.ZN XPutImage +.B XPutImage function combines an image with a rectangle of the specified drawable. The section of the image defined by the src_x, src_y, width, and height arguments is drawn on the specified part of the drawable. If -.ZN XYBitmap +.B XYBitmap format is used, the depth of the image must be one, or a -.ZN BadMatch +.B BadMatch error results. The foreground pixel in the GC defines the source for the one bits in the image, and the background pixel defines the source for the zero bits. For -.ZN XYPixmap +.B XYPixmap and -.ZN ZPixmap , +.BR ZPixmap , the depth of the image must match the depth of the drawable, or a -.ZN BadMatch +.B BadMatch error results. .LP If the characteristics of the image (for example, byte_order and bitmap_unit) differ from what the server requires, -.ZN XPutImage +.B XPutImage automatically makes the appropriate conversions. .LP @@ -184,49 +184,49 @@ and clip-mask. It also uses these GC mode-dependent components: foreground and background. .LP -.ZN XPutImage +.B XPutImage can generate -.ZN BadDrawable , -.ZN BadGC , -.ZN BadMatch , +.BR BadDrawable , +.BR BadGC , +.BR BadMatch , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XGetImage +.B XGetImage function returns a pointer to an -.ZN XImage +.B XImage structure. This structure provides you with the contents of the specified rectangle of the drawable in the format you specify. If the format argument is -.ZN XYPixmap , +.BR XYPixmap , the image contains only the bit planes you passed to the plane_mask argument. If the plane_mask argument only requests a subset of the planes of the display, the depth of the returned image will be the number of planes requested. If the format argument is -.ZN ZPixmap , -.ZN XGetImage +.BR ZPixmap , +.B XGetImage returns as zero the bits in all planes not specified in the plane_mask argument. The function performs no range checking on the values in plane_mask and ignores extraneous bits. .LP -.ZN XGetImage +.B XGetImage returns the depth of the image to the depth member of the -.ZN XImage +.B XImage structure. The depth of the image is as specified when the drawable was created, except when getting a subset of the planes in -.ZN XYPixmap +.B XYPixmap format, when the depth is given by the number of bits set to 1 in plane_mask. .LP If the drawable is a pixmap, the given rectangle must be wholly contained within the pixmap, or a -.ZN BadMatch +.B BadMatch error results. If the drawable is a window, the window must be viewable, @@ -234,7 +234,7 @@ and it must be the case that if there were no inferiors or overlapping windows, the specified rectangle of the window would be fully visible on the screen and wholly contained within the outside edges of the window, or a -.ZN BadMatch +.B BadMatch error results. Note that the borders of the window can be included and read with this request. @@ -247,46 +247,46 @@ The returned contents of visible regions of inferiors of a different depth than the specified window's depth are also undefined. The pointer cursor image is not included in the returned contents. If a problem occurs, -.ZN XGetImage +.B XGetImage returns NULL. .LP -.ZN XGetImage +.B XGetImage can generate -.ZN BadDrawable , -.ZN BadMatch , +.BR BadDrawable , +.BR BadMatch , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XGetSubImage +.B XGetSubImage function updates dest_image with the specified subimage in the same manner as -.ZN XGetImage . +.BR XGetImage . If the format argument is -.ZN XYPixmap , +.BR XYPixmap , the image contains only the bit planes you passed to the plane_mask argument. If the format argument is -.ZN ZPixmap , -.ZN XGetSubImage +.BR ZPixmap , +.B XGetSubImage returns as zero the bits in all planes not specified in the plane_mask argument. The function performs no range checking on the values in plane_mask and ignores extraneous bits. As a convenience, -.ZN XGetSubImage +.B XGetSubImage returns a pointer to the same -.ZN XImage +.B XImage structure specified by dest_image. .LP The depth of the destination -.ZN XImage +.B XImage structure must be the same as that of the drawable. If the specified subimage does not fit at the specified location on the destination image, the right and bottom edges are clipped. If the drawable is a pixmap, the given rectangle must be wholly contained within the pixmap, or a -.ZN BadMatch +.B BadMatch error results. If the drawable is a window, the window must be viewable, @@ -294,7 +294,7 @@ and it must be the case that if there were no inferiors or overlapping windows, the specified rectangle of the window would be fully visible on the screen and wholly contained within the outside edges of the window, or a -.ZN BadMatch +.B BadMatch error results. If the window has backing-store, then the backing-store contents are returned for regions of the window @@ -304,35 +304,35 @@ the returned contents of such obscured regions are undefined. The returned contents of visible regions of inferiors of a different depth than the specified window's depth are also undefined. If a problem occurs, -.ZN XGetSubImage +.B XGetSubImage returns NULL. .LP -.ZN XGetSubImage +.B XGetSubImage can generate -.ZN BadDrawable , -.ZN BadGC , -.ZN BadMatch , +.BR BadDrawable , +.BR BadGC , +.BR BadMatch , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XQueryBestSize.man b/man/XQueryBestSize.man index d6c45046..2ab5079a 100644 --- a/man/XQueryBestSize.man +++ b/man/XQueryBestSize.man @@ -99,10 +99,10 @@ unsigned int *\fIwidth_return\fP, unsigned int *\fIheight_return\fP\^); .IP \fIclass\fP 1i Specifies the class that you are interested in. You can pass -.ZN TileShape , -.ZN CursorShape , +.BR TileShape , +.BR CursorShape , or -.ZN StippleShape . +.BR StippleShape . .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIwidth\fP 1i @@ -120,95 +120,95 @@ Return the width and height of the object best supported by the display hardware. .SH DESCRIPTION The -.ZN XQueryBestSize +.B XQueryBestSize function returns the best or closest size to the specified size. For -.ZN CursorShape , +.BR CursorShape , this is the largest size that can be fully displayed on the screen specified by which_screen. For -.ZN TileShape , +.BR TileShape , this is the size that can be tiled fastest. For -.ZN StippleShape , +.BR StippleShape , this is the size that can be stippled fastest. For -.ZN CursorShape , +.BR CursorShape , the drawable indicates the desired screen. For -.ZN TileShape +.B TileShape and -.ZN StippleShape , +.BR StippleShape , the drawable indicates the screen and possibly the window class and depth. An -.ZN InputOnly +.B InputOnly window cannot be used as the drawable for -.ZN TileShape +.B TileShape or -.ZN StippleShape , +.BR StippleShape , or a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XQueryBestSize +.B XQueryBestSize can generate -.ZN BadDrawable , -.ZN BadMatch , +.BR BadDrawable , +.BR BadMatch , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XQueryBestTile +.B XQueryBestTile function returns the best or closest size, that is, the size that can be tiled fastest on the screen specified by which_screen. The drawable indicates the screen and possibly the window class and depth. If an -.ZN InputOnly +.B InputOnly window is used as the drawable, a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XQueryBestTile +.B XQueryBestTile can generate -.ZN BadDrawable +.B BadDrawable and -.ZN BadMatch +.B BadMatch errors. .LP The -.ZN XQueryBestStipple +.B XQueryBestStipple function returns the best or closest size, that is, the size that can be stippled fastest on the screen specified by which_screen. The drawable indicates the screen and possibly the window class and depth. If an -.ZN InputOnly +.B InputOnly window is used as the drawable, a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XQueryBestStipple +.B XQueryBestStipple can generate -.ZN BadDrawable +.B BadDrawable and -.ZN BadMatch +.B BadMatch errors. .SH DIAGNOSTICS .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadMatch +.B BadMatch The values do not exist for an -.ZN InputOnly +.B InputOnly window. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XQueryColor.man b/man/XQueryColor.man index f1fa461f..0b86c281 100644 --- a/man/XQueryColor.man +++ b/man/XQueryColor.man @@ -114,7 +114,7 @@ Returns the exact RGB values. .IP \fIncolors\fP 1i .\"Specifies the number of color definition structures. Specifies the number of -.ZN XColor +.B XColor structures in the color definition array. .IP \fIscreen_def_return\fP 1i Returns the closest RGB values provided by the hardware. @@ -123,45 +123,45 @@ Specifies the color name string; case is ignored. .IP \fIexact_def_return\fP 1i Returns the exact color value for later use and sets the -.ZN DoRed , -.ZN DoGreen , +.BR DoRed , +.BR DoGreen , and -.ZN DoBlue +.B DoBlue flags. .SH DESCRIPTION The -.ZN XQueryColor +.B XQueryColor function returns the current RGB value for the pixel in the -.ZN XColor +.B XColor structure and sets the -.ZN DoRed , -.ZN DoGreen , +.BR DoRed , +.BR DoGreen , and -.ZN DoBlue +.B DoBlue flags. The -.ZN XQueryColors +.B XQueryColors function returns the RGB value for each pixel in each -.ZN XColor +.B XColor structure and sets the -.ZN DoRed , -.ZN DoGreen , +.BR DoRed , +.BR DoGreen , and -.ZN DoBlue +.B DoBlue flags in each structure. .LP -.ZN XQueryColor +.B XQueryColor and -.ZN XQueryColors +.B XQueryColors can generate -.ZN BadColor +.B BadColor and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XLookupColor +.B XLookupColor function looks up the string name of a color with respect to the screen associated with the specified colormap. It returns both the exact color values and @@ -170,27 +170,27 @@ with respect to the visual type of the specified colormap. If the color name is not in the Host Portable Character Encoding, the result is implementation-dependent. Use of uppercase or lowercase does not matter. -.ZN XLookupColor +.B XLookupColor returns nonzero if the name is resolved; otherwise, it returns zero. .LP The -.ZN XParseColor +.B XParseColor function looks up the string name of a color with respect to the screen associated with the specified colormap. It returns the exact color value. If the color name is not in the Host Portable Character Encoding, the result is implementation-dependent. Use of uppercase or lowercase does not matter. -.ZN XParseColor +.B XParseColor returns nonzero if the name is resolved; otherwise, it returns zero. .LP -.ZN XLookupColor +.B XLookupColor and -.ZN XParseColor +.B XParseColor can generate -.ZN BadColor +.B BadColor error. .SH "COLOR NAMES" An RGB Device specification is identified by @@ -267,10 +267,10 @@ and an optional exponent field consisting of an ``E'' or ``e'' followed by an optional plus or minus followed by a string of digits. .SH DIAGNOSTICS .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XQueryPointer.man b/man/XQueryPointer.man index ec14587e..d5771ddc 100644 --- a/man/XQueryPointer.man +++ b/man/XQueryPointer.man @@ -110,45 +110,45 @@ Specifies the window. Return the pointer coordinates relative to the specified window. .SH DESCRIPTION The -.ZN XQueryPointer +.B XQueryPointer function returns the root window the pointer is logically on and the pointer coordinates relative to the root window's origin. If -.ZN XQueryPointer +.B XQueryPointer returns -.ZN False , +.BR False , the pointer is not on the same screen as the specified window, and -.ZN XQueryPointer +.B XQueryPointer returns -.ZN None +.B None to child_return and zero to win_x_return and win_y_return. If -.ZN XQueryPointer +.B XQueryPointer returns -.ZN True , +.BR True , the pointer coordinates returned to win_x_return and win_y_return are relative to the origin of the specified window. In this case, -.ZN XQueryPointer +.B XQueryPointer returns the child that contains the pointer, if any, or else -.ZN None +.B None to child_return. .LP -.ZN XQueryPointer +.B XQueryPointer returns the current logical state of the keyboard buttons and the modifier keys in mask_return. It sets mask_return to the bitwise inclusive OR of one or more of the button or modifier key bitmasks to match the current state of the mouse buttons and the modifier keys. .LP -.ZN XQueryPointer +.B XQueryPointer can generate a -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XGetWindowAttributes(__libmansuffix__), diff --git a/man/XQueryTree.man b/man/XQueryTree.man index 0a2471fc..224168ca 100644 --- a/man/XQueryTree.man +++ b/man/XQueryTree.man @@ -102,27 +102,27 @@ Specifies the window whose list of children, root, parent, and number of childre you want to obtain. .SH DESCRIPTION The -.ZN XQueryTree +.B XQueryTree function returns the root ID, the parent window ID, a pointer to the list of children windows (NULL when there are no children), and the number of children in the list for the specified window. The children are listed in current stacking order, from bottom-most (first) to top-most (last). -.ZN XQueryTree +.B XQueryTree returns zero if it fails and nonzero if it succeeds. To free a non-NULL children list when it is no longer needed, use -.ZN XFree . +.BR XFree . .LP -.ZN XQueryTree +.B XQueryTree can generate a -.ZN BadWindow +.B BadWindow error. .SH BUGS This really should return a screen *, not a root window ID. .SH DIAGNOSTICS .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XFree(__libmansuffix__), diff --git a/man/XRaiseWindow.man b/man/XRaiseWindow.man index 4dcd6a75..57af3af8 100644 --- a/man/XRaiseWindow.man +++ b/man/XRaiseWindow.man @@ -101,9 +101,9 @@ int XRestackWindows\^(\^Display *\fIdisplay\fP\^, Window \fIwindows\fP\^[], int Specifies the direction (up or down) that you want to circulate the window. You can pass -.ZN RaiseLowest +.B RaiseLowest or -.ZN LowerHighest . +.BR LowerHighest . .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fInwindows\fP 1i @@ -114,7 +114,7 @@ Specifies the window. Specifies an array containing the windows to be restacked. .SH DESCRIPTION The -.ZN XRaiseWindow +.B XRaiseWindow function raises the specified window to the top of the stack so that no sibling window obscures it. @@ -123,26 +123,26 @@ on a desk, then raising a window is analogous to moving the sheet to the top of the stack but leaving its x and y location on the desk constant. Raising a mapped window may generate -.ZN Expose +.B Expose events for the window and any mapped subwindows that were formerly obscured. .LP If the override-redirect attribute of the window is -.ZN False +.B False and some other client has selected -.ZN SubstructureRedirectMask +.B SubstructureRedirectMask on the parent, the X server generates a -.ZN ConfigureRequest +.B ConfigureRequest event, and no processing is performed. Otherwise, the window is raised. .LP -.ZN XRaiseWindow +.B XRaiseWindow can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XLowerWindow +.B XLowerWindow function lowers the specified window to the bottom of the stack so that it does not obscure any sibling windows. @@ -151,93 +151,93 @@ stacked on a desk, then lowering a window is analogous to moving the sheet to the bottom of the stack but leaving its x and y location on the desk constant. Lowering a mapped window will generate -.ZN Expose +.B Expose events on any windows it formerly obscured. .LP If the override-redirect attribute of the window is -.ZN False +.B False and some other client has selected -.ZN SubstructureRedirectMask +.B SubstructureRedirectMask on the parent, the X server generates a -.ZN ConfigureRequest +.B ConfigureRequest event, and no processing is performed. Otherwise, the window is lowered to the bottom of the stack. .LP -.ZN XLowerWindow +.B XLowerWindow can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XCirculateSubwindows +.B XCirculateSubwindows function circulates children of the specified window in the specified direction. If you specify -.ZN RaiseLowest , -.ZN XCirculateSubwindows +.BR RaiseLowest , +.B XCirculateSubwindows raises the lowest mapped child (if any) that is occluded by another child to the top of the stack. If you specify -.ZN LowerHighest , -.ZN XCirculateSubwindows +.BR LowerHighest , +.B XCirculateSubwindows lowers the highest mapped child (if any) that occludes another child to the bottom of the stack. Exposure processing is then performed on formerly obscured windows. If some other client has selected -.ZN SubstructureRedirectMask +.B SubstructureRedirectMask on the window, the X server generates a -.ZN CirculateRequest +.B CirculateRequest event, and no further processing is performed. If a child is actually restacked, the X server generates a -.ZN CirculateNotify +.B CirculateNotify event. .LP -.ZN XCirculateSubwindows +.B XCirculateSubwindows can generate -.ZN BadValue +.B BadValue and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XCirculateSubwindowsUp +.B XCirculateSubwindowsUp function raises the lowest mapped child of the specified window that is partially or completely occluded by another child. Completely unobscured children are not affected. This is a convenience function equivalent to -.ZN XCirculateSubwindows +.B XCirculateSubwindows with -.ZN RaiseLowest +.B RaiseLowest specified. .LP -.ZN XCirculateSubwindowsUp +.B XCirculateSubwindowsUp can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XCirculateSubwindowsDown +.B XCirculateSubwindowsDown function lowers the highest mapped child of the specified window that partially or completely occludes another child. Completely unobscured children are not affected. This is a convenience function equivalent to -.ZN XCirculateSubwindows +.B XCirculateSubwindows with -.ZN LowerHighest +.B LowerHighest specified. .LP -.ZN XCirculateSubwindowsDown +.B XCirculateSubwindowsDown can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XRestackWindows +.B XRestackWindows function restacks the windows in the order specified, from top to bottom. The stacking order of the first window in the windows array is unaffected, @@ -246,33 +246,33 @@ in the order of the array. The stacking order of the other windows is not affected. For each window in the window array that is not a sibling of the first window, a -.ZN BadMatch +.B BadMatch error results. .LP If the override-redirect attribute of a window is -.ZN False +.B False and some other client has selected -.ZN SubstructureRedirectMask +.B SubstructureRedirectMask on the parent, the X server generates -.ZN ConfigureRequest +.B ConfigureRequest events for each window whose override-redirect flag is not set, and no further processing is performed. Otherwise, the windows will be restacked in top-to-bottom order. .LP -.ZN XRestackWindows +.B XRestackWindows can generate -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XChangeWindowAttributes(__libmansuffix__), diff --git a/man/XReadBitmapFile.man b/man/XReadBitmapFile.man index 151cbd3f..5f8d4cf3 100644 --- a/man/XReadBitmapFile.man +++ b/man/XReadBitmapFile.man @@ -151,107 +151,107 @@ in the file. Return the hotspot coordinates. .SH DESCRIPTION The -.ZN XReadBitmapFile +.B XReadBitmapFile function reads in a file containing a bitmap. The file is parsed in the encoding of the current locale. The ability to read other than the standard format is implementation-dependent. If the file cannot be opened, -.ZN XReadBitmapFile +.B XReadBitmapFile returns -.ZN BitmapOpenFailed . +.BR BitmapOpenFailed . If the file can be opened but does not contain valid bitmap data, it returns -.ZN BitmapFileInvalid . +.BR BitmapFileInvalid . If insufficient working storage is allocated, it returns -.ZN BitmapNoMemory . +.BR BitmapNoMemory . If the file is readable and valid, it returns -.ZN BitmapSuccess . +.BR BitmapSuccess . .LP -.ZN XReadBitmapFile +.B XReadBitmapFile returns the bitmap's height and width, as read from the file, to width_return and height_return. It then creates a pixmap of the appropriate size, reads the bitmap data from the file into the pixmap, and assigns the pixmap to the caller's variable bitmap. The caller must free the bitmap using -.ZN XFreePixmap +.B XFreePixmap when finished. If \fIname\fP_x_hot and \fIname\fP_y_hot exist, -.ZN XReadBitmapFile +.B XReadBitmapFile returns them to x_hot_return and y_hot_return; otherwise, it returns \-1,\-1. .LP -.ZN XReadBitmapFile +.B XReadBitmapFile can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadDrawable +.B BadDrawable errors. .LP The -.ZN XReadBitmapFileData +.B XReadBitmapFileData function reads in a file containing a bitmap, in the same manner as -.ZN XReadBitmapFile , +.BR XReadBitmapFile , but returns the data directly rather than creating a pixmap in the server. The bitmap data is returned in data_return; the client must free this storage when finished with it by calling -.ZN XFree . +.BR XFree . The status and other return values are the same as for -.ZN XReadBitmapFile . +.BR XReadBitmapFile . .LP The -.ZN XWriteBitmapFile +.B XWriteBitmapFile function writes a bitmap out to a file in the X Version 11 format. The name used in the output file is derived from the file name by deleting the directory prefix. The file is written in the encoding of the current locale. If the file cannot be opened for writing, it returns -.ZN BitmapOpenFailed . +.BR BitmapOpenFailed . If insufficient memory is allocated, -.ZN XWriteBitmapFile +.B XWriteBitmapFile returns -.ZN BitmapNoMemory ; +.BR BitmapNoMemory ; otherwise, on no error, it returns -.ZN BitmapSuccess . +.BR BitmapSuccess . If x_hot and y_hot are not \-1, \-1, -.ZN XWriteBitmapFile +.B XWriteBitmapFile writes them out as the hotspot coordinates for the bitmap. .LP -.ZN XWriteBitmapFile +.B XWriteBitmapFile can generate -.ZN BadDrawable +.B BadDrawable and -.ZN BadMatch +.B BadMatch errors. .LP The -.ZN XCreatePixmapFromBitmapData +.B XCreatePixmapFromBitmapData function creates a pixmap of the given depth and then does a bitmap-format -.ZN XPutImage +.B XPutImage of the data into it. The depth must be supported by the screen of the specified drawable, or a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XCreatePixmapFromBitmapData +.B XCreatePixmapFromBitmapData can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadMatch +.B BadMatch errors. .LP The -.ZN XCreateBitmapFromData +.B XCreateBitmapFromData function allows you to include in your C program (using -.ZN #include ) +.BR #include ) a bitmap file that was written out by -.ZN XWriteBitmapFile +.B XWriteBitmapFile (X version 11 format only) without reading in the bitmap file. The following example creates a gray bitmap: .LP @@ -263,29 +263,29 @@ bitmap = XCreateBitmapFromData(display, window, gray_bits, gray_width, gray_heig .De .LP If insufficient working storage was allocated, -.ZN XCreateBitmapFromData +.B XCreateBitmapFromData returns -.ZN None . +.BR None . It is your responsibility to free the bitmap using -.ZN XFreePixmap +.B XFreePixmap when finished. .LP -.ZN XCreateBitmapFromData +.B XCreateBitmapFromData can generate a -.ZN BadAlloc +.B BadAlloc error. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .TP 1i -.ZN BadMatch +.B BadMatch An -.ZN InputOnly +.B InputOnly window is used as a Drawable. .SH "SEE ALSO" XCreatePixmap(__libmansuffix__), diff --git a/man/XRecolorCursor.man b/man/XRecolorCursor.man index 4f867cc9..556449e6 100644 --- a/man/XRecolorCursor.man +++ b/man/XRecolorCursor.man @@ -115,34 +115,34 @@ Return the best width and height that is closest to the specified width and height. .SH DESCRIPTION The -.ZN XRecolorCursor +.B XRecolorCursor function changes the color of the specified cursor, and if the cursor is being displayed on a screen, the change is visible immediately. The pixel members of the -.ZN XColor +.B XColor structures are ignored; only the RGB values are used. .LP -.ZN XRecolorCursor +.B XRecolorCursor can generate a -.ZN BadCursor +.B BadCursor error. .LP The -.ZN XFreeCursor +.B XFreeCursor function deletes the association between the cursor resource ID and the specified cursor. The cursor storage is freed when no other resource references it. The specified cursor ID should not be referred to again. .LP -.ZN XFreeCursor +.B XFreeCursor can generate a -.ZN BadCursor +.B BadCursor error. .LP Some displays allow larger cursors than other displays. The -.ZN XQueryBestCursor +.B XQueryBestCursor function provides a way to find out what size cursors are actually possible on the display. .IN "Cursor" "limitations" @@ -150,16 +150,16 @@ It returns the largest size that can be displayed. Applications should be prepared to use smaller cursors on displays that cannot support large ones. .LP -.ZN XQueryBestCursor +.B XQueryBestCursor can generate a -.ZN BadDrawable +.B BadDrawable error. .SH DIAGNOSTICS .TP 1i -.ZN BadCursor +.B BadCursor A value for a Cursor argument does not name a defined Cursor. .TP 1i -.ZN BadDrawable +.B BadDrawable A value for a Drawable argument does not name a defined Window or Pixmap. .SH "SEE ALSO" XCreateColormap(__libmansuffix__), diff --git a/man/XReparentEvent.man b/man/XReparentEvent.man index 459391c7..999ff106 100644 --- a/man/XReparentEvent.man +++ b/man/XReparentEvent.man @@ -83,7 +83,7 @@ XReparentEvent \- ReparentNotify event structure .SH STRUCTURES The structure for -.ZN ReparentNotify +.B ReparentNotify events contains: .LP .Ds 0 @@ -106,16 +106,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -124,9 +124,9 @@ dispatchers. .LP The event member is set either to the reparented window or to the old or the new parent, depending on whether -.ZN StructureNotify +.B StructureNotify or -.ZN SubstructureNotify +.B SubstructureNotify was selected. The window member is set to the window that was reparented. The parent member is set to the new parent window. @@ -137,7 +137,7 @@ The override_redirect member is set to the override-redirect attribute of the window specified by the window member. Window manager clients normally should ignore this window if the override_redirect member is -.ZN True . +.BR True . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/man/XReparentWindow.man b/man/XReparentWindow.man index 05f27989..af7fc36a 100644 --- a/man/XReparentWindow.man +++ b/man/XReparentWindow.man @@ -99,40 +99,40 @@ Specifies the window. Specify the x and y coordinates of the position in the new parent window. .SH DESCRIPTION If the specified window is mapped, -.ZN XReparentWindow +.B XReparentWindow automatically performs an -.ZN UnmapWindow +.B UnmapWindow request on it, removes it from its current position in the hierarchy, and inserts it as the child of the specified parent. The window is placed in the stacking order on top with respect to sibling windows. .LP After reparenting the specified window, -.ZN XReparentWindow +.B XReparentWindow causes the X server to generate a -.ZN ReparentNotify +.B ReparentNotify event. The override_redirect member returned in this event is set to the window's corresponding attribute. Window manager clients usually should ignore this window if this member is set to -.ZN True . +.BR True . Finally, if the specified window was originally mapped, the X server automatically performs a -.ZN MapWindow +.B MapWindow request on it. .LP The X server performs normal exposure processing on formerly obscured windows. The X server might not generate -.ZN Expose +.B Expose events for regions from the initial -.ZN UnmapWindow +.B UnmapWindow request that are immediately obscured by the final -.ZN MapWindow +.B MapWindow request. A -.ZN BadMatch +.B BadMatch error results if: .IP \(bu 5 The new parent window is not on the same screen as @@ -142,23 +142,23 @@ The new parent window is the specified window or an inferior of the specified window. .IP \(bu 5 The new parent is -.ZN InputOnly , +.BR InputOnly , and the window is not. .IP \(bu 5 The specified window has a -.ZN ParentRelative +.B ParentRelative background, and the new parent window is not the same depth as the specified window. .LP -.ZN XReparentWindow +.B XReparentWindow can generate -.ZN BadMatch +.B BadMatch and -.ZN BadWindow +.B BadWindow errors. .SH DIAGNOSTICS .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XChangeSaveSet(__libmansuffix__) diff --git a/man/XResizeRequestEvent.man b/man/XResizeRequestEvent.man index 36ea8cfd..282ed17b 100644 --- a/man/XResizeRequestEvent.man +++ b/man/XResizeRequestEvent.man @@ -83,7 +83,7 @@ XResizeRequestEvent \- ResizeRequest event structure .SH STRUCTURES The structure for -.ZN ResizeRequest +.B ResizeRequest events contains: .LP .Ds 0 @@ -103,16 +103,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. diff --git a/man/XResourceManagerString.man b/man/XResourceManagerString.man index 7d4884b5..0cfb6916 100644 --- a/man/XResourceManagerString.man +++ b/man/XResourceManagerString.man @@ -93,31 +93,31 @@ Specifies the connection to the X server. Specifies the screen. .SH DESCRIPTION The -.ZN XResourceManagerString +.B XResourceManagerString function returns the RESOURCE_MANAGER property from the server's root window of screen zero, which was returned when the connection was opened using -.ZN XOpenDisplay . +.BR XOpenDisplay . The property is converted from type STRING to the current locale. The conversion is identical to that produced by -.ZN XmbTextPropertyToTextList +.B XmbTextPropertyToTextList for a single element STRING property. The returned string is owned by Xlib and should not be freed by the client. The property value must be in a format that is acceptable to -.ZN XrmGetStringDatabase . +.BR XrmGetStringDatabase . If no property exists, NULL is returned. .LP The -.ZN XScreenResourceString +.B XScreenResourceString function returns the SCREEN_RESOURCES property from the root window of the specified screen. The property is converted from type STRING to the current locale. The conversion is identical to that produced by -.ZN XmbTextPropertyToTextList +.B XmbTextPropertyToTextList for a single element STRING property. The property value must be in a format that is acceptable to -.ZN XrmGetStringDatabase . +.BR XrmGetStringDatabase . If no property exists, NULL is returned. The caller is responsible for freeing the returned string by using -.ZN XFree . +.BR XFree . .SH "SEE ALSO" \fI\*(xL\fP diff --git a/man/XSaveContext.man b/man/XSaveContext.man index de7482b2..e85f41ee 100644 --- a/man/XSaveContext.man +++ b/man/XSaveContext.man @@ -106,39 +106,39 @@ Specifies the connection to the X server. Specifies the resource ID with which the data is associated. .SH DESCRIPTION If an entry with the specified resource ID and type already exists, -.ZN XSaveContext +.B XSaveContext overrides it with the specified context. The -.ZN XSaveContext +.B XSaveContext function returns a nonzero error code if an error has occurred and zero otherwise. Possible errors are -.ZN XCNOMEM +.B XCNOMEM (out of memory). .LP Because it is a return value, the data is a pointer. The -.ZN XFindContext +.B XFindContext function returns a nonzero error code if an error has occurred and zero otherwise. Possible errors are -.ZN XCNOENT +.B XCNOENT (context-not-found). .LP The -.ZN XDeleteContext +.B XDeleteContext function deletes the entry for the given resource ID and type from the data structure. This function returns the same error codes that -.ZN XFindContext +.B XFindContext returns if called with the same arguments. -.ZN XDeleteContext +.B XDeleteContext does not free the data whose address was saved. .LP The -.ZN XUniqueContext +.B XUniqueContext function creates a unique context type that may be used in subsequent calls to -.ZN XSaveContext . +.BR XSaveContext . .SH "SEE ALSO" \fI\*(xL\fP diff --git a/man/XSelectInput.man b/man/XSelectInput.man index ccdc034e..670cc775 100644 --- a/man/XSelectInput.man +++ b/man/XSelectInput.man @@ -94,7 +94,7 @@ Specifies the event mask. Specifies the window whose events you are interested in. .SH DESCRIPTION The -.ZN XSelectInput +.B XSelectInput function requests that the X server report the events associated with the specified event mask. Initially, X will not report any of these events. @@ -115,36 +115,36 @@ When the X server generates an event, it reports it to all interested clients. .IP \(bu 5 Only one client at a time can select -.ZN CirculateRequest , -.ZN ConfigureRequest , +.BR CirculateRequest , +.BR ConfigureRequest , or -.ZN MapRequest +.B MapRequest events, which are associated with the event mask -.ZN SubstructureRedirectMask . +.BR SubstructureRedirectMask . .IP \(bu 5 Only one client at a time can select a -.ZN ResizeRequest +.B ResizeRequest event, which is associated with the event mask -.ZN ResizeRedirectMask . +.BR ResizeRedirectMask . .IP \(bu 5 Only one client at a time can select a -.ZN ButtonPress +.B ButtonPress event, which is associated with the event mask -.ZN ButtonPressMask . +.BR ButtonPressMask . .LP The server reports the event to all interested clients. .LP -.ZN XSelectInput +.B XSelectInput can generate a -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" \fI\*(xL\fP diff --git a/man/XSelectionClearEvent.man b/man/XSelectionClearEvent.man index d8db1fc1..e8ce7b3b 100644 --- a/man/XSelectionClearEvent.man +++ b/man/XSelectionClearEvent.man @@ -83,7 +83,7 @@ XSelectionClearEvent \- SelectionClear event structure .SH STRUCTURES The structure for -.ZN SelectionClear +.B SelectionClear events contains: .LP .Ds 0 @@ -104,16 +104,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -125,7 +125,7 @@ The time member is set to the last change time recorded for the selection. The window member is the window that was specified by the current owner (the owner losing the selection) in its -.ZN XSetSelectionOwner +.B XSetSelectionOwner call. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/man/XSelectionEvent.man b/man/XSelectionEvent.man index feb5dfcd..468eb650 100644 --- a/man/XSelectionEvent.man +++ b/man/XSelectionEvent.man @@ -83,7 +83,7 @@ XSelectionEvent \- SelectionNotify event structure .SH STRUCTURES The structure for -.ZN SelectionNotify +.B SelectionNotify events contains: .LP .Ds 0 @@ -106,16 +106,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -132,10 +132,10 @@ The property member is set to the atom that indicates which property the result was stored on. If the conversion failed, the property member is set to -.ZN None . +.BR None . The time member is set to the time the conversion took place and can be a timestamp or -.ZN CurrentTime . +.BR CurrentTime . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/man/XSelectionRequestEvent.man b/man/XSelectionRequestEvent.man index 35454c3d..154bc111 100644 --- a/man/XSelectionRequestEvent.man +++ b/man/XSelectionRequestEvent.man @@ -83,7 +83,7 @@ XSelectionRequestEvent \- SelectionRequest event structure .SH STRUCTURES The structure for -.ZN SelectionRequest +.B SelectionRequest events contains: .LP .Ds 0 @@ -107,16 +107,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -125,7 +125,7 @@ dispatchers. .LP The owner member is set to the window that was specified by the current owner in its -.ZN XSetSelectionOwner +.B XSetSelectionOwner call. The requestor member is set to the window requesting the selection. The selection member is set to the atom that names the selection. @@ -133,11 +133,11 @@ For example, PRIMARY is used to indicate the primary selection. The target member is set to the atom that indicates the type the selection is desired in. The property member can be a property name or -.ZN None . +.BR None . The time member is set to the timestamp or -.ZN CurrentTime +.B CurrentTime value from the -.ZN ConvertSelection +.B ConvertSelection request. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/man/XSendEvent.man b/man/XSendEvent.man index 98f9b636..78a30c86 100644 --- a/man/XSendEvent.man +++ b/man/XSendEvent.man @@ -108,15 +108,15 @@ Specifies a Boolean value. Specify the time interval in which the events are returned from the motion history buffer. You can pass a timestamp or -.ZN CurrentTime . -.ZN PointerWindow , +.BR CurrentTime . +.BR PointerWindow , or -.ZN InputFocus . +.BR InputFocus . .IP \fIw\fP 1i Specifies the window the window the event is to be sent to. .SH DESCRIPTION The -.ZN XSendEvent +.B XSendEvent function identifies the destination window, determines which clients should receive the specified events, and ignores any active grabs. @@ -126,17 +126,17 @@ see section 10.3. This function uses the w argument to identify the destination window as follows: .IP \(bu 5 If w is -.ZN PointerWindow , +.BR PointerWindow , the destination window is the window that contains the pointer. .IP \(bu 5 If w is -.ZN InputFocus +.B InputFocus and if the focus window contains the pointer, the destination window is the window that contains the pointer; otherwise, the destination window is the focus window. .LP To determine which clients should receive the specified events, -.ZN XSendEvent +.B XSendEvent uses the propagate argument as follows: .IP \(bu 5 If event_mask is the empty set, @@ -145,12 +145,12 @@ If that client no longer exists, no event is sent. .IP \(bu 5 If propagate is -.ZN False , +.BR False , the event is sent to every client selecting on destination any of the event types in the event_mask argument. .IP \(bu 5 If propagate is -.ZN True +.B True and no clients have selected on destination any of the event types in event-mask, the destination is replaced with the closest ancestor of destination for which some client has selected a @@ -158,47 +158,47 @@ type in event-mask and for which no intervening window has that type in its do-not-propagate-mask. If no such window exists or if the window is an ancestor of the focus window and -.ZN InputFocus +.B InputFocus was originally specified as the destination, the event is not sent to any clients. Otherwise, the event is reported to every client selecting on the final destination any of the types specified in event_mask. .LP The event in the -.ZN XEvent +.B XEvent structure must be one of the core events or one of the events defined by an extension (or a -.ZN BadValue +.B BadValue error results) so that the X server can correctly byte-swap the contents as necessary. The contents of the event are otherwise unaltered and unchecked by the X server except to force send_event to -.ZN True +.B True in the forwarded event and to set the serial number in the event correctly; therefore these fields and the display field are ignored by -.ZN XSendEvent . +.BR XSendEvent . .LP -.ZN XSendEvent +.B XSendEvent returns zero if the conversion to wire protocol format failed and returns nonzero otherwise. -.ZN XSendEvent +.B XSendEvent can generate -.ZN BadValue +.B BadValue and -.ZN BadWindow +.B BadWindow errors. .LP The server may retain the recent history of the pointer motion and do so to a finer granularity than is reported by -.ZN MotionNotify +.B MotionNotify events. The -.ZN XGetMotionEvents +.B XGetMotionEvents function makes this history available. .LP The -.ZN XGetMotionEvents +.B XGetMotionEvents function returns all events in the motion history buffer that fall between the specified start and stop times, inclusive, and that have coordinates that lie within the specified window (including its borders) at its present @@ -207,17 +207,17 @@ If the server does not support motion history, if the start time is later than the stop time, or if the start time is in the future, no events are returned; -.ZN XGetMotionEvents +.B XGetMotionEvents returns NULL. If the stop time is in the future, it is equivalent to specifying -.ZN CurrentTime . -.ZN XGetMotionEvents +.BR CurrentTime . +.B XGetMotionEvents can generate a -.ZN BadWindow +.B BadWindow error. .SH STRUCTURES The -.ZN XTimeCoord +.B XTimeCoord structure contains: .LP .Ds 0 @@ -233,13 +233,13 @@ are reported relative to the origin of the specified window. .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAnyEvent(__libmansuffix__), diff --git a/man/XSetArcMode.man b/man/XSetArcMode.man index 18326f0d..251094e1 100644 --- a/man/XSetArcMode.man +++ b/man/XSetArcMode.man @@ -95,74 +95,74 @@ int XSetGraphicsExposures\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, Bool .IP \fIarc_mode\fP 1i Specifies the arc mode. You can pass -.ZN ArcChord +.B ArcChord or -.ZN ArcPieSlice . +.BR ArcPieSlice . .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIgc\fP 1i Specifies the GC. .IP \fIgraphics_exposures\fP 1i Specifies a Boolean value that indicates whether you want -.ZN GraphicsExpose +.B GraphicsExpose and -.ZN NoExpose +.B NoExpose events to be reported when calling -.ZN XCopyArea +.B XCopyArea and -.ZN XCopyPlane +.B XCopyPlane with this GC. .IP \fIsubwindow_mode\fP 1i Specifies the subwindow mode. You can pass -.ZN ClipByChildren +.B ClipByChildren or -.ZN IncludeInferiors . +.BR IncludeInferiors . .SH DESCRIPTION The -.ZN XSetArcMode +.B XSetArcMode function sets the arc mode in the specified GC. .LP -.ZN XSetArcMode +.B XSetArcMode can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XSetSubwindowMode +.B XSetSubwindowMode function sets the subwindow mode in the specified GC. .LP -.ZN XSetSubwindowMode +.B XSetSubwindowMode can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XSetGraphicsExposures +.B XSetGraphicsExposures function sets the graphics-exposures flag in the specified GC. .LP -.ZN XSetGraphicsExposures +.B XSetGraphicsExposures can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XSetClipOrigin.man b/man/XSetClipOrigin.man index a227ebc6..2494ff7a 100644 --- a/man/XSetClipOrigin.man +++ b/man/XSetClipOrigin.man @@ -107,48 +107,48 @@ Specifies the number of rectangles. .IP \fIordering\fP 1i Specifies the ordering relations on the rectangles. You can pass -.ZN Unsorted , -.ZN YSorted , -.ZN YXSorted , +.BR Unsorted , +.BR YSorted , +.BR YXSorted , or -.ZN YXBanded . +.BR YXBanded . .IP \fIpixmap\fP 1i Specifies the pixmap or -.ZN None . +.BR None . .IP \fIrectangles\fP 1i Specifies an array of rectangles that define the clip-mask. .SH DESCRIPTION The -.ZN XSetClipOrigin +.B XSetClipOrigin function sets the clip origin in the specified GC. The clip-mask origin is interpreted relative to the origin of whatever destination drawable is specified in the graphics request. .LP -.ZN XSetClipOrigin +.B XSetClipOrigin can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadGC +.B BadGC errors. .LP The -.ZN XSetClipMask +.B XSetClipMask function sets the clip-mask in the specified GC to the specified pixmap. If the clip-mask is set to -.ZN None , +.BR None , the pixels are are always drawn (regardless of the clip-origin). .LP -.ZN XSetClipMask +.B XSetClipMask can generate -.ZN BadAlloc , -.ZN BadGC , -.ZN BadMatch , +.BR BadAlloc , +.BR BadGC , +.BR BadMatch , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XSetClipRectangles +.B XSetClipRectangles function changes the clip-mask in the specified GC to the specified list of rectangles and sets the clip origin. The output is clipped to remain contained within the @@ -161,60 +161,60 @@ undefined. Note that the list of rectangles can be empty, which effectively disables output. This is the opposite of passing -.ZN None +.B None as the clip-mask in -.ZN XCreateGC , -.ZN XChangeGC , +.BR XCreateGC , +.BR XChangeGC , and -.ZN XSetClipMask . +.BR XSetClipMask . .LP If known by the client, ordering relations on the rectangles can be specified with the ordering argument. This may provide faster operation by the server. If an incorrect ordering is specified, the X server may generate a -.ZN BadMatch +.B BadMatch error, but it is not required to do so. If no error is generated, the graphics results are undefined. -.ZN Unsorted +.B Unsorted means the rectangles are in arbitrary order. -.ZN YSorted +.B YSorted means that the rectangles are nondecreasing in their Y origin. -.ZN YXSorted +.B YXSorted additionally constrains -.ZN YSorted +.B YSorted order in that all rectangles with an equal Y origin are nondecreasing in their X origin. -.ZN YXBanded +.B YXBanded additionally constrains -.ZN YXSorted +.B YXSorted by requiring that, for every possible Y scanline, all rectangles that include that scanline have an identical Y origins and Y extents. .LP -.ZN XSetClipRectangles +.B XSetClipRectangles can generate -.ZN BadAlloc , -.ZN BadGC , -.ZN BadMatch , +.BR BadAlloc , +.BR BadGC , +.BR BadMatch , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XSetCloseDownMode.man b/man/XSetCloseDownMode.man index 6ae6fd86..a1ae54f1 100644 --- a/man/XSetCloseDownMode.man +++ b/man/XSetCloseDownMode.man @@ -90,67 +90,67 @@ int XKillClient\^(\^Display *\fIdisplay\fP\^, XID \fIresource\fP\^); .IP \fIclose_mode\fP 1i Specifies the client close-down mode. You can pass -.ZN DestroyAll , -.ZN RetainPermanent , +.BR DestroyAll , +.BR RetainPermanent , or -.ZN RetainTemporary . +.BR RetainTemporary . .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIresource\fP 1i Specifies any resource associated with the client that you want to destroy or -.ZN AllTemporary . +.BR AllTemporary . .SH DESCRIPTION The -.ZN XSetCloseDownMode +.B XSetCloseDownMode defines what will happen to the client's resources at connection close. A connection starts in -.ZN DestroyAll +.B DestroyAll mode. For information on what happens to the client's resources when the close_mode argument is -.ZN RetainPermanent +.B RetainPermanent or -.ZN RetainTemporary , +.BR RetainTemporary , see section 2.6. .LP -.ZN XSetCloseDownMode +.B XSetCloseDownMode can generate a -.ZN BadValue +.B BadValue error. .LP The -.ZN XKillClient +.B XKillClient function forces a close down of the client that created the resource if a valid resource is specified. If the client has already terminated in either -.ZN RetainPermanent +.B RetainPermanent or -.ZN RetainTemporary +.B RetainTemporary mode, all of the client's resources are destroyed. If -.ZN AllTemporary +.B AllTemporary is specified, the resources of all clients that have terminated in -.ZN RetainTemporary +.B RetainTemporary are destroyed (see section 2.5). This permits implementation of window manager facilities that aid debugging. A client can set its close-down mode to -.ZN RetainTemporary . +.BR RetainTemporary . If the client then crashes, its windows would not be destroyed. The programmer can then inspect the application's window tree and use the window manager to destroy the zombie windows. .LP -.ZN XKillClient +.B XKillClient can generate a -.ZN BadValue +.B BadValue error. .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XSetCommand.man b/man/XSetCommand.man index 3b89c664..19d0b680 100644 --- a/man/XSetCommand.man +++ b/man/XSetCommand.man @@ -103,28 +103,28 @@ Specifies the connection to the X server. Specifies the window. .SH DESCRIPTION The -.ZN XSetCommand +.B XSetCommand function sets the command and arguments used to invoke the application. (Typically, argv is the argv array of your main program.) If the strings are not in the Host Portable Character Encoding, the result is implementation-dependent. .LP -.ZN XSetCommand +.B XSetCommand can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetCommand +.B XGetCommand function reads the WM_COMMAND property from the specified window and returns a string list. If the WM_COMMAND property exists, it is of type STRING and format 8. If sufficient memory can be allocated to contain the string list, -.ZN XGetCommand +.B XGetCommand fills in the argv_return and argc_return arguments and returns a nonzero status. Otherwise, or if any other error is encountered, it returns a zero status. @@ -132,7 +132,7 @@ If the data returned by the server is in the Latin Portable Character Encoding, then the returned strings are in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. To free the memory allocated to the string list, use -.ZN XFreeStringList . +.BR XFreeStringList . .SH PROPERTIES .TP 1i \s-1WM_COMMAND\s+1 @@ -140,10 +140,10 @@ The command and arguments, null-separated, used to invoke the application. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/man/XSetErrorHandler.man b/man/XSetErrorHandler.man index 0e3121bf..1551e8b2 100644 --- a/man/XSetErrorHandler.man +++ b/man/XSetErrorHandler.man @@ -120,16 +120,16 @@ Specifies the character string. Xlib generally calls the program's supplied error handler whenever an error is received. It is not called on -.ZN BadName +.B BadName errors from -.ZN OpenFont , -.ZN LookupColor , +.BR OpenFont , +.BR LookupColor , or -.ZN AllocNamedColor +.B AllocNamedColor protocol requests or on -.ZN BadFont +.B BadFont errors from a -.ZN QueryFont +.B QueryFont protocol request. These errors generally are reflected back to the program through the procedural interface. @@ -142,7 +142,7 @@ that will generate protocol requests or that will look for input events. The previous error handler is returned. .LP The -.ZN XGetErrorText +.B XGetErrorText function copies a null-terminated string describing the specified error code into the specified buffer. The returned text is in the encoding of the current locale. @@ -151,20 +151,20 @@ because extensions to Xlib may define their own error codes and error strings. .LP The -.ZN XDisplayName +.B XDisplayName function returns the name of the display that -.ZN XOpenDisplay +.B XOpenDisplay would attempt to use. If a NULL string is specified, -.ZN XDisplayName +.B XDisplayName looks in the environment for the display and returns the display name that -.ZN XOpenDisplay +.B XOpenDisplay would attempt to use. This makes it easier to report to the user precisely which display the program attempted to open when the initial connection attempt failed. .LP The -.ZN XSetIOErrorHandler +.B XSetIOErrorHandler sets the fatal I/O error handler. Xlib calls the program's supplied error handler if any sort of system call error occurs (for example, the connection to the server was lost). @@ -176,7 +176,7 @@ the client process exits. Note that the previous error handler is returned. .LP The -.ZN XGetErrorDatabaseText +.B XGetErrorDatabaseText function returns a null-terminated message (or the default message) from the error message database. @@ -202,7 +202,7 @@ For a core protocol request, the major request protocol number is used for the message argument. For an extension request, the extension name (as given by -.ZN InitExtension ) +.BR InitExtension ) followed by a period (\.) and the minor request protocol number is used for the message argument. If no string is found in the error database, diff --git a/man/XSetFillStyle.man b/man/XSetFillStyle.man index a4af0172..814e4445 100644 --- a/man/XSetFillStyle.man +++ b/man/XSetFillStyle.man @@ -94,52 +94,52 @@ Specifies the connection to the X server. .IP \fIfill_rule\fP 1i Specifies the fill-rule you want to set for the specified GC. You can pass -.ZN EvenOddRule +.B EvenOddRule or -.ZN WindingRule . +.BR WindingRule . .IP \fIfill_style\fP 1i Specifies the fill-style you want to set for the specified GC. You can pass -.ZN FillSolid , -.ZN FillTiled , -.ZN FillStippled , +.BR FillSolid , +.BR FillTiled , +.BR FillStippled , or -.ZN FillOpaqueStippled . +.BR FillOpaqueStippled . .IP \fIgc\fP 1i Specifies the GC. .SH DESCRIPTION The -.ZN XSetFillStyle +.B XSetFillStyle function sets the fill-style in the specified GC. .LP -.ZN XSetFillStyle +.B XSetFillStyle can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XSetFillRule +.B XSetFillRule function sets the fill-rule in the specified GC. .LP -.ZN XSetFillRule +.B XSetFillRule can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XSetFont.man b/man/XSetFont.man index 8c303d63..32c127ac 100644 --- a/man/XSetFont.man +++ b/man/XSetFont.man @@ -93,25 +93,25 @@ Specifies the font. Specifies the GC. .SH DESCRIPTION The -.ZN XSetFont +.B XSetFont function sets the current font in the specified GC. .LP -.ZN XSetFont +.B XSetFont can generate -.ZN BadAlloc , -.ZN BadFont , +.BR BadAlloc , +.BR BadFont , and -.ZN BadGC +.B BadGC errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadFont +.B BadFont A value for a Font or GContext argument does not name a defined Font. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .SH "SEE ALSO" XCreateGC(__libmansuffix__), diff --git a/man/XSetFontPath.man b/man/XSetFontPath.man index 382537fa..adce2bb4 100644 --- a/man/XSetFontPath.man +++ b/man/XSetFontPath.man @@ -103,7 +103,7 @@ Specifies the number of directories in the path. Returns the number of strings in the font path array. .SH DESCRIPTION The -.ZN XSetFontPath +.B XSetFontPath function defines the directory search path for font lookup. There is only one search path per X server, not one per client. The encoding and interpretation of the strings are implementation-dependent, @@ -119,28 +119,28 @@ the X server is guaranteed to flush all cached information about fonts for which there currently are no explicit resource IDs allocated. The meaning of an error from this request is implementation-dependent. .LP -.ZN XSetFontPath +.B XSetFontPath can generate a -.ZN BadValue +.B BadValue error. .LP The -.ZN XGetFontPath +.B XGetFontPath function allocates and returns an array of strings containing the search path. The contents of these strings are implementation-dependent and are not intended to be interpreted by client applications. When it is no longer needed, the data in the font path should be freed by using -.ZN XFreeFontPath . +.BR XFreeFontPath . .LP The -.ZN XFreeFontPath +.B XFreeFontPath function frees the data allocated by -.ZN XGetFontPath . +.BR XGetFontPath . .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XSetICFocus.man b/man/XSetICFocus.man index 39278880..943baeb4 100644 --- a/man/XSetICFocus.man +++ b/man/XSetICFocus.man @@ -91,18 +91,18 @@ void XUnsetICFocus\^(\^XIC \fIic\fP\^); Specifies the input context. .SH DESCRIPTION The -.ZN XSetICFocus +.B XSetICFocus function allows a client to notify an input method that the focus window attached to the specified input context has received keyboard focus. The input method should take action to provide appropriate feedback. Complete feedback specification is a matter of user interface policy. .LP Calling -.ZN XSetICFocus +.B XSetICFocus does not affect the focus window value. .LP The -.ZN XUnsetICFocus +.B XUnsetICFocus function allows a client to notify an input method that the specified input context has lost the keyboard focus and that no more input is expected on the focus window attached to that input context. @@ -110,7 +110,7 @@ The input method should take action to provide appropriate feedback. Complete feedback specification is a matter of user interface policy. .LP Calling -.ZN XUnsetICFocus +.B XUnsetICFocus does not affect the focus window value; the client may still receive events from the input method that are directed to the focus window. diff --git a/man/XSetICValues.man b/man/XSetICValues.man index 64831eed..db03f86b 100644 --- a/man/XSetICValues.man +++ b/man/XSetICValues.man @@ -93,14 +93,14 @@ Specifies the input context. Specifies the variable length argument list to set or get XIC values. .SH DESCRIPTION The -.ZN XSetICValues +.B XSetICValues function returns NULL if no error occurred; otherwise, it returns the name of the first argument that could not be set. An argument might not be set for any of the following reasons: .IP \(bu 5 The argument is read-only (for example, -.ZN XNFilterEvents ). +.BR XNFilterEvents ). .IP \(bu 5 The argument name is not recognized. .IP \(bu 5 @@ -110,18 +110,18 @@ Each value to be set must be an appropriate datum, matching the data type imposed by the semantics of the argument. .LP The -.ZN XSetICValues +.B XSetICValues can generate -.ZN BadAtom , -.ZN BadColor , -.ZN BadCursor , -.ZN BadPixmap , +.BR BadAtom , +.BR BadColor , +.BR BadCursor , +.BR BadPixmap , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetICValues +.B XGetICValues function returns NULL if no error occurred; otherwise, it returns the name of the first argument that could not be obtained. An argument could not be obtained for any of the following reasons: @@ -136,33 +136,33 @@ That is, if the IC value is of type T, the argument must be of type T*. If T itself is a pointer type, then -.ZN XGetICValues +.B XGetICValues allocates memory to store the actual data, and the client is responsible for freeing this data by calling -.ZN XFree +.B XFree with the returned pointer. The exception to this rule is for an IC value of type -.ZN XNVaNestedList +.B XNVaNestedList (for preedit and status attributes). In this case, the argument must also be of type -.ZN XVaNestedList . +.BR XVaNestedList . Then, the rule of changing type T to T* and freeing the allocated data applies to each element of the nested list. .SH DIAGNOSTICS .TP 1i -.ZN BadAtom +.B BadAtom A value for an Atom argument does not name a defined Atom. .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadCursor +.B BadCursor A value for a Cursor argument does not name a defined Cursor. .TP 1i -.ZN BadPixmap +.B BadPixmap A value for a Pixmap argument does not name a defined Pixmap. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XCreateIC(__libmansuffix__), diff --git a/man/XSetInputFocus.man b/man/XSetInputFocus.man index 25dedddc..df6e061d 100644 --- a/man/XSetInputFocus.man +++ b/man/XSetInputFocus.man @@ -93,53 +93,53 @@ int *\fIrevert_to_return\fP\^); Specifies the connection to the X server. .IP \fIfocus\fP 1i Specifies the window, -.ZN PointerRoot , +.BR PointerRoot , or -.ZN None . +.BR None . .IP \fIfocus_return\fP 1i Returns the focus window, -.ZN PointerRoot , +.BR PointerRoot , or -.ZN None . +.BR None . .IP \fIrevert_to\fP 1i Specifies where the input focus reverts to if the window becomes not viewable. You can pass -.ZN RevertToParent , -.ZN RevertToPointerRoot , +.BR RevertToParent , +.BR RevertToPointerRoot , or -.ZN RevertToNone . +.BR RevertToNone . .IP \fIrevert_to_return\fP 1i Returns the current focus state .Pn ( RevertToParent , -.ZN RevertToPointerRoot , +.BR RevertToPointerRoot , or -.ZN RevertToNone ). +.BR RevertToNone ). .IP \fItime\fP 1i Specifies the time. You can pass either a timestamp or -.ZN CurrentTime . +.BR CurrentTime . .SH DESCRIPTION The -.ZN XSetInputFocus +.B XSetInputFocus function changes the input focus and the last-focus-change time. It has no effect if the specified time is earlier than the current last-focus-change time or is later than the current X server time. Otherwise, the last-focus-change time is set to the specified time .Pn ( CurrentTime is replaced by the current X server time). -.ZN XSetInputFocus +.B XSetInputFocus causes the X server to generate -.ZN FocusIn +.B FocusIn and -.ZN FocusOut +.B FocusOut events. .LP Depending on the focus argument, the following occurs: .IP \(bu 5 If focus is -.ZN None , +.BR None , all keyboard events are discarded until a new focus window is set, and the revert_to argument is ignored. .IP \(bu 5 @@ -150,63 +150,63 @@ or one of its inferiors, the event is reported as usual. Otherwise, the event is reported relative to the focus window. .IP \(bu 5 If focus is -.ZN PointerRoot , +.BR PointerRoot , the focus window is dynamically taken to be the root window of whatever screen the pointer is on at each keyboard event. In this case, the revert_to argument is ignored. .LP The specified focus window must be viewable at the time -.ZN XSetInputFocus +.B XSetInputFocus is called, or a -.ZN BadMatch +.B BadMatch error results. If the focus window later becomes not viewable, the X server evaluates the revert_to argument to determine the new focus window as follows: .IP \(bu 5 If revert_to is -.ZN RevertToParent , +.BR RevertToParent , the focus reverts to the parent (or the closest viewable ancestor), and the new revert_to value is taken to be -.ZN RevertToNone . +.BR RevertToNone . .IP \(bu 5 If revert_to is -.ZN RevertToPointerRoot +.B RevertToPointerRoot or -.ZN RevertToNone , +.BR RevertToNone , the focus reverts to -.ZN PointerRoot +.B PointerRoot or -.ZN None , +.BR None , respectively. When the focus reverts, the X server generates -.ZN FocusIn +.B FocusIn and -.ZN FocusOut +.B FocusOut events, but the last-focus-change time is not affected. .LP -.ZN XSetInputFocus +.B XSetInputFocus can generate -.ZN BadMatch , -.ZN BadValue , +.BR BadMatch , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetInputFocus +.B XGetInputFocus function returns the focus window and the current focus state. .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XWarpPointer(__libmansuffix__) diff --git a/man/XSetLineAttributes.man b/man/XSetLineAttributes.man index f54c7749..e39286a6 100644 --- a/man/XSetLineAttributes.man +++ b/man/XSetLineAttributes.man @@ -93,11 +93,11 @@ int XSetDashes\^(\^Display *\fIdisplay\fP\^, GC \fIgc\fP\^, int .IP \fIcap_style\fP 1i Specifies the line-style and cap-style you want to set for the specified GC. You can pass -.ZN CapNotLast , -.ZN CapButt , -.ZN CapRound , +.BR CapNotLast , +.BR CapButt , +.BR CapRound , or -.ZN CapProjecting . +.BR CapProjecting . .IP \fIdash_list\fP 1i Specifies the dash-list for the dashed line-style you want to set for the specified GC. @@ -111,41 +111,41 @@ Specifies the GC. .IP \fIjoin_style\fP 1i Specifies the line join-style you want to set for the specified GC. You can pass -.ZN JoinMiter , -.ZN JoinRound , +.BR JoinMiter , +.BR JoinRound , or -.ZN JoinBevel . +.BR JoinBevel . .IP \fIline_style\fP 1i Specifies the line-style you want to set for the specified GC. You can pass -.ZN LineSolid , -.ZN LineOnOffDash , +.BR LineSolid , +.BR LineOnOffDash , or -.ZN LineDoubleDash . +.BR LineDoubleDash . .IP \fIline_width\fP 1i Specifies the line-width you want to set for the specified GC. .IP \fIn\fP 1i Specifies the number of elements in dash_list. .SH DESCRIPTION The -.ZN XSetLineAttributes +.B XSetLineAttributes function sets the line drawing components in the specified GC. .LP -.ZN XSetLineAttributes +.B XSetLineAttributes can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XSetDashes +.B XSetDashes function sets the dash-offset and dash-list attributes for dashed line styles in the specified GC. There must be at least one element in the specified dash_list, or a -.ZN BadValue +.B BadValue error results. The initial and alternating elements (second, fourth, and so on) of the dash_list are the even dashes, and @@ -153,7 +153,7 @@ the others are the odd dashes. Each element specifies a dash length in pixels. All of the elements must be nonzero, or a -.ZN BadValue +.B BadValue error results. Specifying an odd-length list is equivalent to specifying the same list concatenated with itself to produce an even-length list. @@ -173,22 +173,22 @@ The major axis is defined as the x axis for lines drawn at an angle of between \-45 and +45 degrees or between 135 and 225 degrees from the x axis. For all other lines, the major axis is the y axis. .LP -.ZN XSetDashes +.B XSetDashes can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XSetPointerMapping.man b/man/XSetPointerMapping.man index 054757d2..cd195b2b 100644 --- a/man/XSetPointerMapping.man +++ b/man/XSetPointerMapping.man @@ -99,44 +99,44 @@ Returns the mapping list. Specifies the number of items in the mapping list. .SH DESCRIPTION The -.ZN XSetPointerMapping +.B XSetPointerMapping function sets the mapping of the pointer. If it succeeds, the X server generates a -.ZN MappingNotify +.B MappingNotify event, and -.ZN XSetPointerMapping +.B XSetPointerMapping returns -.ZN MappingSuccess . +.BR MappingSuccess . Element map[i] defines the logical button number for the physical button i+1. The length of the list must be the same as -.ZN XGetPointerMapping +.B XGetPointerMapping would return, or a -.ZN BadValue +.B BadValue error results. A zero element disables a button, and elements are not restricted in value by the number of physical buttons. However, no two elements can have the same nonzero value, or a -.ZN BadValue +.B BadValue error results. If any of the buttons to be altered are logically in the down state, -.ZN XSetPointerMapping +.B XSetPointerMapping returns -.ZN MappingBusy , +.BR MappingBusy , and the mapping is not changed. .LP -.ZN XSetPointerMapping +.B XSetPointerMapping can generate a -.ZN BadValue +.B BadValue error. .LP The -.ZN XGetPointerMapping +.B XGetPointerMapping function returns the current mapping of the pointer. Pointer buttons are numbered starting from one. -.ZN XGetPointerMapping +.B XGetPointerMapping returns the number of physical buttons actually on the pointer. The nominal mapping for a pointer is map[i]=i+1. The nmap argument specifies the length of the array where the pointer @@ -144,7 +144,7 @@ mapping is returned, and only the first nmap elements are returned in map_return. .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XSetScreenSaver.man b/man/XSetScreenSaver.man index 8684769b..fcab3e3d 100644 --- a/man/XSetScreenSaver.man +++ b/man/XSetScreenSaver.man @@ -100,16 +100,16 @@ int *\fIinterval_return\fP\^, int *\fIprefer_blanking_return\fP\^, int .IP \fIallow_exposures\fP 1i Specifies the screen save control values. You can pass -.ZN DontAllowExposures , -.ZN AllowExposures , +.BR DontAllowExposures , +.BR AllowExposures , or -.ZN DefaultExposures . +.BR DefaultExposures . .IP \fIallow_exposures_return\fP 1i Returns the current screen save control value .Pn ( DontAllowExposures , -.ZN AllowExposures , +.BR AllowExposures , or -.ZN DefaultExposures ). +.BR DefaultExposures ). .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIinterval\fP 1i @@ -119,22 +119,22 @@ Returns the interval between screen saver invocations. .IP \fImode\fP 1i Specifies the mode that is to be applied. You can pass -.ZN ScreenSaverActive +.B ScreenSaverActive or -.ZN ScreenSaverReset . +.BR ScreenSaverReset . .IP \fIprefer_blanking\fP 1i Specifies how to enable screen blanking. You can pass -.ZN DontPreferBlanking , -.ZN PreferBlanking , +.BR DontPreferBlanking , +.BR PreferBlanking , or -.ZN DefaultBlanking . +.BR DefaultBlanking . .IP \fIprefer_blanking_return\fP 1i Returns the current screen blanking preference .Pn ( DontPreferBlanking , -.ZN PreferBlanking , +.BR PreferBlanking , or -.ZN DefaultBlanking ). +.BR DefaultBlanking ). .IP \fItimeout\fP 1i Specifies the timeout, in seconds, until the screen saver turns on. .IP \fItimeout_return\fP 1i @@ -145,10 +145,10 @@ A timeout of 0 disables the screen saver (but an activated screen saver is not deactivated), and a timeout of \-1 restores the default. Other negative values generate a -.ZN BadValue +.B BadValue error. If the timeout value is nonzero, -.ZN XSetScreenSaver +.B XSetScreenSaver enables the screen saver. An interval of 0 disables the random-pattern motion. Both values are limited to a 16-bit signed integer range by the wire protocol, @@ -162,7 +162,7 @@ if blanking is preferred and the hardware supports video blanking, the screen simply goes blank. Otherwise, if either exposures are allowed or the screen can be regenerated without sending -.ZN Expose +.B Expose events to clients, the screen is tiled with the root window background tile randomly re-origined each interval seconds. @@ -171,9 +171,9 @@ and the screen saver is not activated. The screen saver is deactivated, and all screen states are restored at the next keyboard or pointer input or at the next call to -.ZN XForceScreenSaver +.B XForceScreenSaver with mode -.ZN ScreenSaverReset . +.BR ScreenSaverReset . .LP If the server-dependent screen saver method supports periodic change, the interval argument serves as a hint about how long the change period @@ -183,44 +183,44 @@ periodically, moving an icon image around the screen periodically, or tiling the screen with the root window background tile, randomly re-origined periodically. .LP -.ZN XSetScreenSaver +.B XSetScreenSaver can generate a -.ZN BadValue +.B BadValue error. .LP If the specified mode is -.ZN ScreenSaverActive +.B ScreenSaverActive and the screen saver currently is deactivated, -.ZN XForceScreenSaver +.B XForceScreenSaver activates the screen saver even if the screen saver had been disabled with a timeout of zero. If the specified mode is -.ZN ScreenSaverReset +.B ScreenSaverReset and the screen saver currently is enabled, -.ZN XForceScreenSaver +.B XForceScreenSaver deactivates the screen saver if it was activated, and the activation timer is reset to its initial state (as if device input had been received). .LP -.ZN XForceScreenSaver +.B XForceScreenSaver can generate a -.ZN BadValue +.B BadValue error. .LP The -.ZN XActivateScreenSaver +.B XActivateScreenSaver function activates the screen saver. .LP The -.ZN XResetScreenSaver +.B XResetScreenSaver function resets the screen saver. .LP The -.ZN XGetScreenSaver +.B XGetScreenSaver function gets the current screen saver values. .SH DIAGNOSTICS .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XSetSelectionOwner.man b/man/XSetSelectionOwner.man index 3a3707c7..0a3e3800 100644 --- a/man/XSetSelectionOwner.man +++ b/man/XSetSelectionOwner.man @@ -98,11 +98,11 @@ Specifies the connection to the X server. .IP \fIowner\fP 1i Specifies the owner of the specified selection atom. You can pass a window or -.ZN None . +.BR None . .IP \fIproperty\fP 1i Specifies the property name. You also can pass -.ZN None . +.BR None . .IP \fIrequestor\fP 1i Specifies the requestor. .IP \fIselection\fP 1i @@ -112,34 +112,34 @@ Specifies the target atom. .IP \fItime\fP 1i Specifies the time. You can pass either a timestamp or -.ZN CurrentTime . +.BR CurrentTime . .SH DESCRIPTION The -.ZN XSetSelectionOwner +.B XSetSelectionOwner function changes the owner and last-change time for the specified selection and has no effect if the specified time is earlier than the current last-change time of the specified selection or is later than the current X server time. Otherwise, the last-change time is set to the specified time, with -.ZN CurrentTime +.B CurrentTime replaced by the current server time. If the owner window is specified as -.ZN None , +.BR None , then the owner of the selection becomes -.ZN None +.B None (that is, no owner). Otherwise, the owner of the selection becomes the client executing the request. .LP If the new owner (whether a client or -.ZN None ) +.BR None ) is not the same as the current owner of the selection and the current owner is not -.ZN None , +.BR None , the current owner is sent a -.ZN SelectionClear +.B SelectionClear event. If the client that is the owner of a selection is later terminated (that is, its connection is closed) @@ -147,71 +147,71 @@ or if the owner window it has specified in the request is later destroyed, the owner of the selection automatically reverts to -.ZN None , +.BR None , but the last-change time is not affected. The selection atom is uninterpreted by the X server. -.ZN XGetSelectionOwner +.B XGetSelectionOwner returns the owner window, which is reported in -.ZN SelectionRequest +.B SelectionRequest and -.ZN SelectionClear +.B SelectionClear events. Selections are global to the X server. .LP -.ZN XSetSelectionOwner +.B XSetSelectionOwner can generate -.ZN BadAtom +.B BadAtom and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetSelectionOwner +.B XGetSelectionOwner function returns the window ID associated with the window that currently owns the specified selection. If no selection was specified, the function returns the constant -.ZN None . +.BR None . If -.ZN None +.B None is returned, there is no owner for the selection. .LP -.ZN XGetSelectionOwner +.B XGetSelectionOwner can generate a -.ZN BadAtom +.B BadAtom error. .LP -.ZN XConvertSelection +.B XConvertSelection requests that the specified selection be converted to the specified target type: .IP \(bu 5 If the specified selection has an owner, the X server sends a -.ZN SelectionRequest +.B SelectionRequest event to that owner. .IP \(bu 5 If no owner for the specified selection exists, the X server generates a -.ZN SelectionNotify +.B SelectionNotify event to the requestor with property -.ZN None . +.BR None . .LP The arguments are passed on unchanged in either of the events. There are two predefined selection atoms: PRIMARY and SECONDARY. .LP -.ZN XConvertSelection +.B XConvertSelection can generate -.ZN BadAtom +.B BadAtom and -.ZN BadWindow +.B BadWindow errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAtom +.B BadAtom A value for an Atom argument does not name a defined Atom. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" \fI\*(xL\fP diff --git a/man/XSetState.man b/man/XSetState.man index 6fb7d724..c48fa215 100644 --- a/man/XSetState.man +++ b/man/XSetState.man @@ -114,70 +114,70 @@ Specifies the plane mask. .\" *** JIM: NEED MORE INFO FOR THIS. *** .SH DESCRIPTION The -.ZN XSetState +.B XSetState function sets the foreground, background, plane mask, and function components for the specified GC. .LP -.ZN XSetState +.B XSetState can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadValue +.B BadValue errors. .LP -.ZN XSetFunction +.B XSetFunction sets a specified value in the specified GC. .LP -.ZN XSetFunction +.B XSetFunction can generate -.ZN BadAlloc , -.ZN BadGC , +.BR BadAlloc , +.BR BadGC , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XSetPlaneMask +.B XSetPlaneMask function sets the plane mask in the specified GC. .LP -.ZN XSetPlaneMask +.B XSetPlaneMask can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadGC +.B BadGC errors. .LP The -.ZN XSetForeground +.B XSetForeground function sets the foreground in the specified GC. .LP -.ZN XSetForeground +.B XSetForeground can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadGC +.B BadGC errors. .LP The -.ZN XSetBackground +.B XSetBackground function sets the background in the specified GC. .LP -.ZN XSetBackground +.B XSetBackground can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadGC +.B BadGC errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XSetTextProperty.man b/man/XSetTextProperty.man index 1438a420..90593704 100644 --- a/man/XSetTextProperty.man +++ b/man/XSetTextProperty.man @@ -95,39 +95,39 @@ Specifies the connection to the X server. Specifies the property name. .IP \fItext_prop\fP 1i Specifies the -.ZN XTextProperty +.B XTextProperty structure to be used. .IP \fItext_prop_return\fP 1i Returns the -.ZN XTextProperty +.B XTextProperty structure. .SH DESCRIPTION The -.ZN XSetTextProperty +.B XSetTextProperty function replaces the existing specified property for the named window with the data, type, format, and number of items determined by the value field, the encoding field, the format field, and the nitems field, respectively, of the specified -.ZN XTextProperty +.B XTextProperty structure. If the property does not already exist, -.ZN XSetTextProperty +.B XSetTextProperty sets it for the specified window. .LP -.ZN XSetTextProperty +.B XSetTextProperty can generate -.ZN BadAlloc , -.ZN BadAtom , -.ZN BadValue , +.BR BadAlloc , +.BR BadAtom , +.BR BadValue , and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetTextProperty +.B XGetTextProperty function reads the specified property from the window and stores the data in the returned -.ZN XTextProperty +.B XTextProperty structure. It stores the data in the value field, the type of the data in the encoding field, @@ -138,25 +138,25 @@ is stored at the end of the value field of text_prop_return. The particular interpretation of the property's encoding and data as text is left to the calling application. If the specified property does not exist on the window, -.ZN XGetTextProperty +.B XGetTextProperty sets the value field to NULL, the encoding field to -.ZN None , +.BR None , the format field to zero, and the nitems field to zero. .LP If it was able to read and store the data in the -.ZN XTextProperty +.B XTextProperty structure, -.ZN XGetTextProperty +.B XGetTextProperty returns a nonzero status; otherwise, it returns a zero status. .LP -.ZN XGetTextProperty +.B XGetTextProperty can generate -.ZN BadAtom +.B BadAtom and -.ZN BadWindow +.B BadWindow errors. .SH PROPERTIES .TP 1i @@ -174,19 +174,19 @@ The name to be used in an icon. The name of the application. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadAtom +.B BadAtom A value for an Atom argument does not name a defined Atom. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of alternatives can generate this error. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/man/XSetTile.man b/man/XSetTile.man index d35c5a2a..f595cbca 100644 --- a/man/XSetTile.man +++ b/man/XSetTile.man @@ -107,65 +107,65 @@ Specifies the fill tile you want to set for the specified GC. Specify the x and y coordinates of the tile and stipple origin. .SH DESCRIPTION The -.ZN XSetTile +.B XSetTile function sets the fill tile in the specified GC. The tile and GC must have the same depth, or a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XSetTile +.B XSetTile can generate -.ZN BadAlloc , -.ZN BadGC , -.ZN BadMatch , +.BR BadAlloc , +.BR BadGC , +.BR BadMatch , and -.ZN BadPixmap +.B BadPixmap errors. .LP The -.ZN XSetStipple +.B XSetStipple function sets the stipple in the specified GC. The stipple must have a depth of one, or a -.ZN BadMatch +.B BadMatch error results. .LP -.ZN XSetStipple +.B XSetStipple can generate -.ZN BadAlloc , -.ZN BadGC , -.ZN BadMatch , +.BR BadAlloc , +.BR BadGC , +.BR BadMatch , and -.ZN BadPixmap +.B BadPixmap errors. .LP The -.ZN XSetTSOrigin +.B XSetTSOrigin function sets the tile/stipple origin in the specified GC. When graphics requests call for tiling or stippling, the parent's origin will be interpreted relative to whatever destination drawable is specified in the graphics request. .LP -.ZN XSetTSOrigin +.B XSetTSOrigin can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadGC +.B BadGC errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadPixmap +.B BadPixmap A value for a Pixmap argument does not name a defined Pixmap. .SH "SEE ALSO" XCreateGC(__libmansuffix__), diff --git a/man/XSetTransientForHint.man b/man/XSetTransientForHint.man index 3255137e..fae8b6ce 100644 --- a/man/XSetTransientForHint.man +++ b/man/XSetTransientForHint.man @@ -99,26 +99,26 @@ Specifies the window that the WM_TRANSIENT_FOR property is to be set to. Returns the WM_TRANSIENT_FOR property of the specified window. .SH DESCRIPTION The -.ZN XSetTransientForHint +.B XSetTransientForHint function sets the WM_TRANSIENT_FOR property of the specified window to the specified prop_window. .LP -.ZN XSetTransientForHint +.B XSetTransientForHint can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetTransientForHint +.B XGetTransientForHint function returns the WM_TRANSIENT_FOR property for the specified window. It returns a nonzero status on success; otherwise, it returns a zero status. .LP -.ZN XGetTransientForHint +.B XGetTransientForHint can generate a -.ZN BadWindow +.B BadWindow error. .SH PROPERTIES .TP 1i @@ -127,10 +127,10 @@ Set by application programs to indicate to the window manager that a transient top-level window, such as a dialog box. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/man/XSetWMClientMachine.man b/man/XSetWMClientMachine.man index 1fe1fa39..b3b1a4e7 100644 --- a/man/XSetWMClientMachine.man +++ b/man/XSetWMClientMachine.man @@ -93,25 +93,25 @@ XTextProperty *\fItext_prop_return\fP\^); Specifies the connection to the X server. .IP \fItext_prop\fP 1i Specifies the -.ZN XTextProperty +.B XTextProperty structure to be used. .IP \fItext_prop_return\fP 1i Returns the -.ZN XTextProperty +.B XTextProperty structure. .IP \fIw\fP 1i Specifies the window. .SH DESCRIPTION The -.ZN XSetWMClientMachine +.B XSetWMClientMachine convenience function calls -.ZN XSetTextProperty +.B XSetTextProperty to set the WM_CLIENT_MACHINE property. .LP The -.ZN XGetWMClientMachine +.B XGetWMClientMachine convenience function performs an -.ZN XGetTextProperty +.B XGetTextProperty on the WM_CLIENT_MACHINE property. It returns a nonzero status on success; otherwise, it returns a zero status. diff --git a/man/XSetWMColormapWindows.man b/man/XSetWMColormapWindows.man index 83fe5746..306299d7 100644 --- a/man/XSetWMColormapWindows.man +++ b/man/XSetWMColormapWindows.man @@ -103,46 +103,46 @@ Returns the number of windows in the list. Specifies the window. .SH DESCRIPTION The -.ZN XSetWMColormapWindows +.B XSetWMColormapWindows function replaces the WM_COLORMAP_WINDOWS property on the specified window with the list of windows specified by the colormap_windows argument. It the property does not already exist, -.ZN XSetWMColormapWindows +.B XSetWMColormapWindows sets the WM_COLORMAP_WINDOWS property on the specified window to the list of windows specified by the colormap_windows argument. The property is stored with a type of WINDOW and a format of 32. If it cannot intern the WM_COLORMAP_WINDOWS atom, -.ZN XSetWMColormapWindows +.B XSetWMColormapWindows returns a zero status. Otherwise, it returns a nonzero status. .LP -.ZN XSetWMColormapWindows +.B XSetWMColormapWindows can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetWMColormapWindows +.B XGetWMColormapWindows function returns the list of window identifiers stored in the WM_COLORMAP_WINDOWS property on the specified window. These identifiers indicate the colormaps that the window manager may need to install for this window. If the property exists, is of type WINDOW, is of format 32, and the atom WM_COLORMAP_WINDOWS can be interned, -.ZN XGetWMColormapWindows +.B XGetWMColormapWindows sets the windows_return argument to a list of window identifiers, sets the count_return argument to the number of elements in the list, and returns a nonzero status. Otherwise, it sets neither of the return arguments and returns a zero status. To release the list of window identifiers, use -.ZN XFree . +.BR XFree . .LP -.ZN XGetWMColormapWindows +.B XGetWMColormapWindows can generate a -.ZN BadWindow +.B BadWindow error. .SH PROPERTIES .TP 1i @@ -151,10 +151,10 @@ The list of window IDs that may need a different colormap from that of their top-level window. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/man/XSetWMIconName.man b/man/XSetWMIconName.man index 98190a40..dbe3cf5f 100644 --- a/man/XSetWMIconName.man +++ b/man/XSetWMIconName.man @@ -105,59 +105,59 @@ Returns the window's icon name, which is a null-terminated string. .IP \fItext_prop\fP 1i Specifies the -.ZN XTextProperty +.B XTextProperty structure to be used. .IP \fItext_prop_return\fP 1i Returns the -.ZN XTextProperty +.B XTextProperty structure. .IP \fIw\fP 1i Specifies the window. .SH DESCRIPTION The -.ZN XSetWMIconName +.B XSetWMIconName convenience function calls -.ZN XSetTextProperty +.B XSetTextProperty to set the WM_ICON_NAME property. .LP The -.ZN XGetWMIconName +.B XGetWMIconName convenience function calls -.ZN XGetTextProperty +.B XGetTextProperty to obtain the WM_ICON_NAME property. It returns a nonzero status on success; otherwise, it returns a zero status. .LP The -.ZN XSetIconName +.B XSetIconName function sets the name to be displayed in a window's icon. .LP -.ZN XSetIconName +.B XSetIconName can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetIconName +.B XGetIconName function returns the name to be displayed in the specified window's icon. If it succeeds, it returns a nonzero status; otherwise, if no icon name has been set for the window, it returns zero. If you never assigned a name to the window, -.ZN XGetIconName +.B XGetIconName sets icon_name_return to NULL. If the data returned by the server is in the Latin Portable Character Encoding, then the returned string is in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. When finished with it, a client must free the icon name string using -.ZN XFree . +.BR XFree . .LP -.ZN XGetIconName +.B XGetIconName can generate a -.ZN BadWindow +.B BadWindow error. .SH PROPERTIES .TP 1i @@ -165,10 +165,10 @@ error. The name to be used in an icon. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/man/XSetWMName.man b/man/XSetWMName.man index 8f598d1b..7bdb2ee2 100644 --- a/man/XSetWMName.man +++ b/man/XSetWMName.man @@ -99,11 +99,11 @@ Status XFetchName\^(\^Display *\fIdisplay\fP\^, Window \fIw\fP\^, char Specifies the connection to the X server. .IP \fItext_prop\fP 1i Specifies the -.ZN XTextProperty +.B XTextProperty structure to be used. .IP \fItext_prop_return\fP 1i Returns the -.ZN XTextProperty +.B XTextProperty structure. .IP \fIw\fP 1i Specifies the window. @@ -114,21 +114,21 @@ which should be a null-terminated string. Returns the window name, which is a null-terminated string. .SH DESCRIPTION The -.ZN XSetWMName +.B XSetWMName convenience function calls -.ZN XSetTextProperty +.B XSetTextProperty to set the WM_NAME property. .LP The -.ZN XGetWMName +.B XGetWMName convenience function calls -.ZN XGetTextProperty +.B XGetTextProperty to obtain the WM_NAME property. It returns a nonzero status on success; otherwise, it returns a zero status. .LP The -.ZN XStoreName +.B XStoreName function assigns the name passed to window_name to the specified window. A window manager can display the window name in some prominent place, such as the title bar, to allow users to identify windows easily. @@ -138,33 +138,33 @@ if one is provided by the application. If the string is not in the Host Portable Character Encoding, the result is implementation-dependent. .LP -.ZN XStoreName +.B XStoreName can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XFetchName +.B XFetchName function returns the name of the specified window. If it succeeds, it returns a nonzero status; otherwise, no name has been set for the window, and it returns zero. If the WM_NAME property has not been set for this window, -.ZN XFetchName +.B XFetchName sets window_name_return to NULL. If the data returned by the server is in the Latin Portable Character Encoding, then the returned string is in the Host Portable Character Encoding. Otherwise, the result is implementation-dependent. When finished with it, a client must free the window name string using -.ZN XFree . +.BR XFree . .LP -.ZN XFetchName +.B XFetchName can generate a -.ZN BadWindow +.B BadWindow error. .SH PROPERTIES .TP 1i @@ -172,10 +172,10 @@ error. The name of the application. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/man/XSetWMProperties.man b/man/XSetWMProperties.man index 9d670c5c..6878b20c 100644 --- a/man/XSetWMProperties.man +++ b/man/XSetWMProperties.man @@ -105,7 +105,7 @@ Specifies the number of arguments. Specifies the application's argument list. .IP \fIclass_hints\fP 1i Specifies the -.ZN XClassHint +.B XClassHint structure to be used. .IP \fIdisplay\fP 1i Specifies the connection to the X server. @@ -121,54 +121,54 @@ Specifies the window name, which should be a null-terminated string. .IP \fIwm_hints\fP 1i Specifies the -.ZN XWMHints +.B XWMHints structure to be used. .SH DESCRIPTION The -.ZN XSetWMProperties +.B XSetWMProperties convenience function provides a single programming interface for setting those essential window properties that are used for communicating with other clients (particularly window and session managers). .LP If the window_name argument is non-NULL, -.ZN XSetWMProperties +.B XSetWMProperties calls -.ZN XSetWMName , +.BR XSetWMName , which in turn, sets the WM_NAME property (see section 14.1.4). If the icon_name argument is non-NULL, -.ZN XSetWMProperties +.B XSetWMProperties calls -.ZN XSetWMIconName , +.BR XSetWMIconName , which sets the WM_ICON_NAME property (see section 14.1.5). If the argv argument is non-NULL, -.ZN XSetWMProperties +.B XSetWMProperties calls -.ZN XSetCommand , +.BR XSetCommand , which sets the WM_COMMAND property (see section 14.2.1). Note that an argc of zero is allowed to indicate a zero-length command. Note also that the hostname of this machine is stored using -.ZN XSetWMClientMachine +.B XSetWMClientMachine (see section 14.2.2). .LP If the normal_hints argument is non-NULL, -.ZN XSetWMProperties +.B XSetWMProperties calls -.ZN XSetWMNormalHints , +.BR XSetWMNormalHints , which sets the WM_NORMAL_HINTS property (see section 14.1.7). If the wm_hints argument is non-NULL, -.ZN XSetWMProperties +.B XSetWMProperties calls -.ZN XSetWMHints , +.BR XSetWMHints , which sets the WM_HINTS property (see section 14.1.6). .LP If the class_hints argument is non-NULL, -.ZN XSetWMProperties +.B XSetWMProperties calls -.ZN XSetClassHint , +.BR XSetClassHint , which sets the WM_CLASS property (see section 14.1.8). If the res_name member in the -.ZN XClassHint +.B XClassHint structure is set to the NULL pointer and the RESOURCE_NAME environment variable is set, then the value of the environment variable is substituted for res_name. @@ -179,9 +179,9 @@ then the value of argv[0], stripped of any directory prefixes, is substituted for res_name. .LP The -.ZN XmbSetWMProperties +.B XmbSetWMProperties and -.ZN Xutf8SetWMProperties +.B Xutf8SetWMProperties convenience functions provide a simple programming interface for setting those essential window properties that are used for communicating with other clients @@ -192,9 +192,9 @@ they set the WM_NAME property. If the icon_name argument is non-NULL, they set the WM_ICON_NAME property. The window_name and icon_name arguments are null-terminated strings, for -.ZN XmbSetWMProperties +.B XmbSetWMProperties in the encoding of the current locale, for -.ZN Xutf8SetWMProperties +.B Xutf8SetWMProperties in UTF-8 encoding. If the arguments can be fully converted to the STRING encoding, the properties are created with type ``STRING''; @@ -202,38 +202,38 @@ otherwise, the arguments are converted to Compound Text, and the properties are created with type ``COMPOUND_TEXT''. .LP If the normal_hints argument is non-NULL, -.ZN XmbSetWMProperties +.B XmbSetWMProperties and -.ZN Xutf8SetWMProperties +.B Xutf8SetWMProperties call -.ZN XSetWMNormalHints , +.BR XSetWMNormalHints , which sets the WM_NORMAL_HINTS property (see section 14.1.7). If the wm_hints argument is non-NULL, -.ZN XmbSetWMProperties +.B XmbSetWMProperties and -.ZN Xutf8SetWMProperties +.B Xutf8SetWMProperties call -.ZN XSetWMHints , +.BR XSetWMHints , which sets the WM_HINTS property (see section 14.1.6). .LP If the argv argument is non-NULL, -.ZN XmbSetWMProperties +.B XmbSetWMProperties and -.ZN Xutf8SetWMProperties +.B Xutf8SetWMProperties set the WM_COMMAND property from argv and argc. An argc of zero indicates a zero-length command. .LP The hostname of the machine is stored using -.ZN XSetWMClientMachine +.B XSetWMClientMachine (see section 14.2.2). .LP If the class_hints argument is non-NULL, -.ZN XmbSetWMProperties +.B XmbSetWMProperties and -.ZN Xutf8SetWMProperties +.B Xutf8SetWMProperties set the WM_CLASS property. If the res_name member in the -.ZN XClassHint +.B XClassHint structure is set to the NULL pointer and the RESOURCE_NAME environment variable is set, the value of the environment variable is substituted for res_name. @@ -251,29 +251,29 @@ No encoding conversion is performed for these strings prior to storage in the properties. .LP For clients that need to process the property text in a locale, -.ZN XmbSetWMProperties +.B XmbSetWMProperties and -.ZN Xutf8SetWMProperties +.B Xutf8SetWMProperties set the WM_LOCALE_NAME property to be the name of the current locale. The name is assumed to be in the Host Portable Character Encoding and is converted to STRING for storage in the property. .LP -.ZN XSetWMProperties , -.ZN XmbSetWMProperties +.BR XSetWMProperties , +.B XmbSetWMProperties and -.ZN Xutf8SetWMProperties +.B Xutf8SetWMProperties can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP The function -.ZN Xutf8SetWMProperties +.B Xutf8SetWMProperties is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 release. Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH PROPERTIES .TP 1i \s-1WM_CLASS\s+1 @@ -290,7 +290,7 @@ application. \s-1WM_HINTS\s+1 Additional hints set by the client for use by the window manager. The C type of this property is -.ZN XWMHints . +.BR XWMHints . .TP 1i \s-1WM_ICON_NAME\s+1 The name to be used in an icon. @@ -301,13 +301,13 @@ The name of the application. \s-1WM_NORMAL_HINTS\s+1 Size hints for a window in its normal state. The C type of this property is -.ZN XSizeHints . +.BR XSizeHints . .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/man/XSetWMProtocols.man b/man/XSetWMProtocols.man index 6d83a78c..2f01c931 100644 --- a/man/XSetWMProtocols.man +++ b/man/XSetWMProtocols.man @@ -101,46 +101,46 @@ Specifies the list of protocols. Returns the list of protocols. .SH DESCRIPTION The -.ZN XSetWMProtocols +.B XSetWMProtocols function replaces the WM_PROTOCOLS property on the specified window with the list of atoms specified by the protocols argument. If the property does not already exist, -.ZN XSetWMProtocols +.B XSetWMProtocols sets the WM_PROTOCOLS property on the specified window to the list of atoms specified by the protocols argument. The property is stored with a type of ATOM and a format of 32. If it cannot intern the WM_PROTOCOLS atom, -.ZN XSetWMProtocols +.B XSetWMProtocols returns a zero status. Otherwise, it returns a nonzero status. .LP -.ZN XSetWMProtocols +.B XSetWMProtocols can generate -.ZN BadAlloc +.B BadAlloc and -.ZN BadWindow +.B BadWindow errors. .LP The -.ZN XGetWMProtocols +.B XGetWMProtocols function returns the list of atoms stored in the WM_PROTOCOLS property on the specified window. These atoms describe window manager protocols in which the owner of this window is willing to participate. If the property exists, is of type ATOM, is of format 32, and the atom WM_PROTOCOLS can be interned, -.ZN XGetWMProtocols +.B XGetWMProtocols sets the protocols_return argument to a list of atoms, sets the count_return argument to the number of elements in the list, and returns a nonzero status. Otherwise, it sets neither of the return arguments and returns a zero status. To release the list of atoms, use -.ZN XFree . +.BR XFree . .LP -.ZN XGetWMProtocols +.B XGetWMProtocols can generate a -.ZN BadWindow +.B BadWindow error. .SH PROPERTIES .TP 1i @@ -149,10 +149,10 @@ List of atoms that identify the communications protocols between the client and window manager in which the client is willing to participate. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XAllocClassHint(__libmansuffix__), diff --git a/man/XStoreBytes.man b/man/XStoreBytes.man index 891919ec..e377e0a9 100644 --- a/man/XStoreBytes.man +++ b/man/XStoreBytes.man @@ -114,24 +114,24 @@ The data can have embedded null characters and need not be null-terminated. The cut buffer's contents can be retrieved later by any client calling -.ZN XFetchBytes . +.BR XFetchBytes . .LP -.ZN XStoreBytes +.B XStoreBytes can generate a -.ZN BadAlloc +.B BadAlloc error. .LP If an invalid buffer is specified, the call has no effect. The data can have embedded null characters and need not be null-terminated. .LP -.ZN XStoreBuffer +.B XStoreBuffer can generate a -.ZN BadAlloc +.B BadAlloc error. .LP The -.ZN XFetchBytes +.B XFetchBytes function returns the number of bytes in the nbytes_return argument, if the buffer contains data. @@ -139,48 +139,48 @@ Otherwise, the function returns NULL and sets nbytes to 0. The appropriate amount of storage is allocated and the pointer returned. The client must free this storage when finished with it by calling -.ZN XFree . +.BR XFree . .LP The -.ZN XFetchBuffer +.B XFetchBuffer function returns zero to the nbytes_return argument if there is no data in the buffer or if an invalid buffer is specified. .LP -.ZN XFetchBuffer +.B XFetchBuffer can generate a -.ZN BadValue +.B BadValue error. .LP The -.ZN XRotateBuffers +.B XRotateBuffers function rotates the cut buffers, such that buffer 0 becomes buffer n, buffer 1 becomes n + 1 mod 8, and so on. This cut buffer numbering is global to the display. Note that -.ZN XRotateBuffers +.B XRotateBuffers generates -.ZN BadMatch +.B BadMatch errors if any of the eight buffers have not been created. .LP -.ZN XRotateBuffers +.B XRotateBuffers can generate a -.ZN BadMatch +.B BadMatch error. .SH DIAGNOSTICS .TP 1i -.ZN BadAlloc +.B BadAlloc The server failed to allocate the requested resource or server memory. .TP 1i -.ZN BadAtom +.B BadAtom A value for an Atom argument does not name a defined Atom. .TP 1i -.ZN BadMatch +.B BadMatch Some argument or pair of arguments has the correct type and range but fails to match in some other way required by the request. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XStoreColors.man b/man/XStoreColors.man index defaa5c3..f080005a 100644 --- a/man/XStoreColors.man +++ b/man/XStoreColors.man @@ -105,85 +105,85 @@ Specifies which red, green, and blue components are set. .IP \fIncolors\fP 1i .\"Specifies the number of color definition structures. Specifies the number of -.ZN XColor +.B XColor structures in the color definition array. .IP \fIpixel\fP 1i Specifies the entry in the colormap. .SH DESCRIPTION The -.ZN XStoreColors +.B XStoreColors function changes the colormap entries of the pixel values specified in the pixel members of the -.ZN XColor +.B XColor structures. You specify which color components are to be changed by setting -.ZN DoRed , -.ZN DoGreen , +.BR DoRed , +.BR DoGreen , and/or -.ZN DoBlue +.B DoBlue in the flags member of the -.ZN XColor +.B XColor structures. If the colormap is an installed map for its screen, the changes are visible immediately. -.ZN XStoreColors +.B XStoreColors changes the specified pixels if they are allocated writable in the colormap by any client, even if one or more pixels generates an error. If a specified pixel is not a valid index into the colormap, a -.ZN BadValue +.B BadValue error results. If a specified pixel either is unallocated or is allocated read-only, a -.ZN BadAccess +.B BadAccess error results. If more than one pixel is in error, the one that gets reported is arbitrary. .LP -.ZN XStoreColors +.B XStoreColors can generate -.ZN BadAccess , -.ZN BadColor , +.BR BadAccess , +.BR BadColor , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XStoreColor +.B XStoreColor function changes the colormap entry of the pixel value specified in the pixel member of the -.ZN XColor +.B XColor structure. You specified this value in the pixel member of the -.ZN XColor +.B XColor structure. This pixel value must be a read/write cell and a valid index into the colormap. If a specified pixel is not a valid index into the colormap, a -.ZN BadValue +.B BadValue error results. -.ZN XStoreColor +.B XStoreColor also changes the red, green, and/or blue color components. You specify which color components are to be changed by setting -.ZN DoRed , -.ZN DoGreen , +.BR DoRed , +.BR DoGreen , and/or -.ZN DoBlue +.B DoBlue in the flags member of the -.ZN XColor +.B XColor structure. If the colormap is an installed map for its screen, the changes are visible immediately. .LP -.ZN XStoreColor +.B XStoreColor can generate -.ZN BadAccess , -.ZN BadColor , +.BR BadAccess , +.BR BadColor , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XStoreNamedColor +.B XStoreNamedColor function looks up the named color with respect to the screen associated with the colormap and stores the result in the specified colormap. The pixel argument determines the entry in the colormap. @@ -191,45 +191,45 @@ The flags argument determines which of the red, green, and blue components are set. You can set this member to the bitwise inclusive OR of the bits -.ZN DoRed , -.ZN DoGreen , +.BR DoRed , +.BR DoGreen , and -.ZN DoBlue . +.BR DoBlue . If the color name is not in the Host Portable Character Encoding, the result is implementation-dependent. Use of uppercase or lowercase does not matter. If the specified pixel is not a valid index into the colormap, a -.ZN BadValue +.B BadValue error results. If the specified pixel either is unallocated or is allocated read-only, a -.ZN BadAccess +.B BadAccess error results. .LP -.ZN XStoreNamedColor +.B XStoreNamedColor can generate -.ZN BadAccess , -.ZN BadColor , -.ZN BadName , +.BR BadAccess , +.BR BadColor , +.BR BadName , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to free a color map entry that it did not already allocate. .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to store into a read-only color map entry. .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadName +.B BadName A font or color of the specified name does not exist. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XStringListToTextProperty.man b/man/XStringListToTextProperty.man index 4dec97e9..92d73a95 100644 --- a/man/XStringListToTextProperty.man +++ b/man/XStringListToTextProperty.man @@ -104,36 +104,36 @@ Specifies a list of null-terminated character strings. Returns a list of null-terminated character strings. .IP \fItext_prop\fP 1i Specifies the -.ZN XTextProperty +.B XTextProperty structure to be used. .IP \fItext_prop_return\fP 1i Returns the -.ZN XTextProperty +.B XTextProperty structure. .SH DESCRIPTION The -.ZN XStringListToTextProperty +.B XStringListToTextProperty function sets the specified -.ZN XTextProperty +.B XTextProperty to be of type STRING (format 8) with a value representing the concatenation of the specified list of null-separated character strings. An extra null byte (which is not included in the nitems member) is stored at the end of the value field of text_prop_return. The strings are assumed (without verification) to be in the STRING encoding. If insufficient memory is available for the new value string, -.ZN XStringListToTextProperty +.B XStringListToTextProperty does not set any fields in the -.ZN XTextProperty +.B XTextProperty structure and returns a zero status. Otherwise, it returns a nonzero status. To free the storage for the value field, use -.ZN XFree . +.BR XFree . .LP The -.ZN XTextPropertyToStringList +.B XTextPropertyToStringList function returns a list of strings representing the null-separated elements of the specified -.ZN XTextProperty +.B XTextProperty structure. The data in text_prop must be of type STRING and format 8. Multiple elements of the property @@ -141,24 +141,24 @@ Multiple elements of the property are separated by NULL (encoding 0). The contents of the property are not null-terminated. If insufficient memory is available for the list and its elements, -.ZN XTextPropertyToStringList +.B XTextPropertyToStringList sets no return values and returns a zero status. Otherwise, it returns a nonzero status. To free the storage for the list and its contents, use -.ZN XFreeStringList . +.BR XFreeStringList . .LP The -.ZN XFreeStringList +.B XFreeStringList function releases memory allocated by -.ZN XmbTextPropertyToTextList , -.ZN Xutf8TextPropertyToTextList +.BR XmbTextPropertyToTextList , +.B Xutf8TextPropertyToTextList and -.ZN XTextPropertyToStringList +.B XTextPropertyToStringList and the missing charset list allocated by -.ZN XCreateFontSet . +.BR XCreateFontSet . .SH STRUCTURES The -.ZN XTextProperty +.B XTextProperty structure contains: .LP .Ds 0 diff --git a/man/XStringToKeysym.man b/man/XStringToKeysym.man index 046de1e9..fca97911 100644 --- a/man/XStringToKeysym.man +++ b/man/XStringToKeysym.man @@ -121,36 +121,36 @@ and the mechanisms by which Xlib obtains them is implementation-dependent. If the KeySym name is not in the Host Portable Character Encoding, the result is implementation-dependent. If the specified string does not match a valid KeySym, -.ZN XStringToKeysym +.B XStringToKeysym returns -.ZN NoSymbol . +.BR NoSymbol . .LP The returned string is in a static area and must not be modified. The returned string is in the Host Portable Character Encoding. If the specified KeySym is not defined, -.ZN XKeysymToString +.B XKeysymToString returns a NULL. .LP The -.ZN XKeycodeToKeysym +.B XKeycodeToKeysym function uses internal Xlib tables and returns the KeySym defined for the specified KeyCode and the element of the KeyCode vector. If no symbol is defined, -.ZN XKeycodeToKeysym +.B XKeycodeToKeysym returns -.ZN NoSymbol . -.ZN XKeycodeToKeysym +.BR NoSymbol . +.B XKeycodeToKeysym predates the XKB extension. If you want to lookup a KeySym while using XKB you have to use -.ZN XkbKeycodeToKeysym . +.BR XkbKeycodeToKeysym . .LP If the specified KeySym is not defined for any KeyCode, -.ZN XKeysymToKeycode +.B XKeysymToKeycode returns zero. .LP The -.ZN XConvertCase +.B XConvertCase function returns the uppercase and lowercase forms of the specified Keysym, if the KeySym is subject to case conversion; otherwise, the specified KeySym is returned to both lower_return and diff --git a/man/XSupportsLocale.man b/man/XSupportsLocale.man index f0e4853e..a50cd762 100644 --- a/man/XSupportsLocale.man +++ b/man/XSupportsLocale.man @@ -92,20 +92,20 @@ char *XSetLocaleModifiers\^(\^char *\fImodifier_list\fP\^); Specifies the modifiers. .SH DESCRIPTION The -.ZN XSupportsLocale +.B XSupportsLocale function returns -.ZN True +.B True if Xlib functions are capable of operating under the current locale. If it returns -.ZN False , +.BR False , Xlib locale-dependent functions for which the -.ZN XLocaleNotSupported +.B XLocaleNotSupported return status is defined will return -.ZN XLocaleNotSupported . +.BR XLocaleNotSupported . Other Xlib locale-dependent routines will operate in the ``C'' locale. .LP The -.ZN XSetLocaleModifiers +.B XSetLocaleModifiers function sets the X modifiers for the current locale setting. The modifier_list argument is a null-terminated string of the form ``{@\^\fIcategory\fP\^=\^\fIvalue\fP\^}'', that is, @@ -130,7 +130,7 @@ If the function is successful, it returns a pointer to a string. The contents of the string are such that a subsequent call with that string (in the same locale) will restore the modifiers to the same settings. If modifier_list is a NULL pointer, -.ZN XSetLocaleModifiers +.B XSetLocaleModifiers also returns a pointer to such a string, and the current locale modifiers are not changed. .LP @@ -144,7 +144,7 @@ the first successful call to set them. Whenever the locale is changed, the modifiers that are in effect become unspecified until the next successful call to set them. Clients should always call -.ZN XSetLocaleModifiers +.B XSetLocaleModifiers with a non-NULL modifier_list after setting the locale before they call any locale-dependent Xlib routine. .LP diff --git a/man/XSynchronize.man b/man/XSynchronize.man index f99facc5..f19f2396 100644 --- a/man/XSynchronize.man +++ b/man/XSynchronize.man @@ -97,20 +97,20 @@ Specifies a Boolean value that indicates whether to enable or disable synchronization. .SH DESCRIPTION The -.ZN XSynchronize +.B XSynchronize function returns the previous after function. If onoff is -.ZN True , -.ZN XSynchronize +.BR True , +.B XSynchronize turns on synchronous behavior. If onoff is -.ZN False , -.ZN XSynchronize +.BR False , +.B XSynchronize turns off synchronous behavior. .LP The specified procedure is called with only a display pointer. -.ZN XSetAfterFunction +.B XSetAfterFunction returns the previous after function. .SH "SEE ALSO" XSetErrorHandler(__libmansuffix__) diff --git a/man/XTextExtents.man b/man/XTextExtents.man index cd8f37a9..dd64bab4 100644 --- a/man/XTextExtents.man +++ b/man/XTextExtents.man @@ -107,12 +107,12 @@ int *\fIfont_ascent_return\fP, int *\fIfont_descent_return\fP\^, XCharStruct Returns the value of the direction hint .Pn ( FontLeftToRight or -.ZN FontRightToLeft ). +.BR FontRightToLeft ). .IP \fIdisplay\fP 1i Specifies the connection to the X server. .IP \fIfont_ID\fP 1i Specifies either the font ID or the -.ZN GContext +.B GContext ID that contains the font. .IP \fIfont_ascent_return\fP 1i Returns the font ascent. @@ -120,7 +120,7 @@ Returns the font ascent. Returns the font descent. .IP \fIfont_struct\fP 1i Specifies the -.ZN XFontStruct +.B XFontStruct structure. .IP \fInchars\fP 1i Specifies the number of characters in the character string. @@ -128,21 +128,21 @@ Specifies the number of characters in the character string. Specifies the character string. .IP \fIoverall_return\fP 1i Returns the overall size in the specified -.ZN XCharStruct +.B XCharStruct structure. .SH DESCRIPTION The -.ZN XTextExtents +.B XTextExtents and -.ZN XTextExtents16 +.B XTextExtents16 functions perform the size computation locally and, thereby, avoid the round-trip overhead of -.ZN XQueryTextExtents +.B XQueryTextExtents and -.ZN XQueryTextExtents16 . +.BR XQueryTextExtents16 . Both functions return an -.ZN XCharStruct +.B XCharStruct structure, whose members are set to the values as follows. .LP The ascent member is set to the maximum of the ascent metrics of all @@ -160,26 +160,26 @@ The rbearing member is set to the maximum R. .LP For fonts defined with linear indexing rather than 2-byte matrix indexing, each -.ZN XChar2b +.B XChar2b structure is interpreted as a 16-bit number with byte1 as the most significant byte. If the font has no defined default character, undefined characters in the string are taken to have all zero metrics. .LP The -.ZN XQueryTextExtents +.B XQueryTextExtents and -.ZN XQueryTextExtents16 +.B XQueryTextExtents16 functions return the bounding box of the specified 8-bit and 16-bit character string in the specified font or the font contained in the specified GC. These functions query the X server and, therefore, suffer the round-trip overhead that is avoided by -.ZN XTextExtents +.B XTextExtents and -.ZN XTextExtents16 . +.BR XTextExtents16 . Both functions return a -.ZN XCharStruct +.B XCharStruct structure, whose members are set to the values as follows. .LP The ascent member is set to the maximum of the ascent metrics @@ -197,7 +197,7 @@ The rbearing member is set to the maximum R. .LP For fonts defined with linear indexing rather than 2-byte matrix indexing, each -.ZN XChar2b +.B XChar2b structure is interpreted as a 16-bit number with byte1 as the most significant byte. If the font has no defined default character, @@ -207,20 +207,20 @@ Characters with all zero metrics are ignored. If the font has no defined default_char, the undefined characters in the string are also ignored. .LP -.ZN XQueryTextExtents +.B XQueryTextExtents and -.ZN XQueryTextExtents16 +.B XQueryTextExtents16 can generate -.ZN BadFont +.B BadFont and -.ZN BadGC +.B BadGC errors. .SH DIAGNOSTICS .TP 1i -.ZN BadFont +.B BadFont A value for a Font or GContext argument does not name a defined Font. .TP 1i -.ZN BadGC +.B BadGC A value for a GContext argument does not name a defined GContext. .SH "SEE ALSO" XLoadFont(__libmansuffix__), diff --git a/man/XTextWidth.man b/man/XTextWidth.man index b236de9c..b6ac2de7 100644 --- a/man/XTextWidth.man +++ b/man/XTextWidth.man @@ -97,9 +97,9 @@ Specifies the font used for the width computation. Specifies the character string. .SH DESCRIPTION The -.ZN XTextWidth +.B XTextWidth and -.ZN XTextWidth16 +.B XTextWidth16 functions return the width of the specified 8-bit or 2-byte character strings. .SH "SEE ALSO" XLoadFont(__libmansuffix__), diff --git a/man/XTranslateCoordinates.man b/man/XTranslateCoordinates.man index cddd1804..9fbc377c 100644 --- a/man/XTranslateCoordinates.man +++ b/man/XTranslateCoordinates.man @@ -109,31 +109,31 @@ Specifies the source window. Specify the x and y coordinates within the source window. .SH DESCRIPTION If -.ZN XTranslateCoordinates +.B XTranslateCoordinates returns -.ZN True , +.BR True , it takes the src_x and src_y coordinates relative to the source window's origin and returns these coordinates to dest_x_return and dest_y_return relative to the destination window's origin. If -.ZN XTranslateCoordinates +.B XTranslateCoordinates returns -.ZN False , +.BR False , src_w and dest_w are on different screens, and dest_x_return and dest_y_return are zero. If the coordinates are contained in a mapped child of dest_w, that child is returned to child_return. Otherwise, child_return is set to -.ZN None . +.BR None . .LP -.ZN XTranslateCoordinates +.B XTranslateCoordinates can generate a -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" \fI\*(xL\fP diff --git a/man/XUnmapEvent.man b/man/XUnmapEvent.man index c47bc131..73fe97e2 100644 --- a/man/XUnmapEvent.man +++ b/man/XUnmapEvent.man @@ -83,7 +83,7 @@ XUnmapEvent \- UnmapNotify event structure .SH STRUCTURES The structure for -.ZN UnmapNotify +.B UnmapNotify events contains: .LP .Ds 0 @@ -104,16 +104,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -122,17 +122,17 @@ dispatchers. .LP The event member is set either to the unmapped window or to its parent, depending on whether -.ZN StructureNotify +.B StructureNotify or -.ZN SubstructureNotify +.B SubstructureNotify was selected. This is the window used by the X server to report the event. The window member is set to the window that was unmapped. The from_configure member is set to -.ZN True +.B True if the event was generated as a result of a resizing of the window's parent when the window itself had a win_gravity of -.ZN UnmapGravity . +.BR UnmapGravity . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/man/XUnmapWindow.man b/man/XUnmapWindow.man index 87fca888..f5e53ed3 100644 --- a/man/XUnmapWindow.man +++ b/man/XUnmapWindow.man @@ -93,14 +93,14 @@ Specifies the connection to the X server. Specifies the window. .SH DESCRIPTION The -.ZN XUnmapWindow +.B XUnmapWindow function unmaps the specified window and causes the X server to generate an -.ZN UnmapNotify +.B UnmapNotify .IN "UnmapNotify Event" .IN "XUnmapWindow" event. If the specified window is already unmapped, -.ZN XUnmapWindow +.B XUnmapWindow has no effect. Normal exposure processing on formerly obscured windows is performed. Any child window will no longer be visible until another map call is @@ -108,35 +108,35 @@ made on the parent. In other words, the subwindows are still mapped but are not visible until the parent is mapped. Unmapping a window will generate -.ZN Expose +.B Expose events on windows that were formerly obscured by it. .LP -.ZN XUnmapWindow +.B XUnmapWindow can generate a -.ZN BadWindow +.B BadWindow error. .LP The -.ZN XUnmapSubwindows +.B XUnmapSubwindows function unmaps all subwindows for the specified window in bottom-to-top stacking order. It causes the X server to generate an -.ZN UnmapNotify +.B UnmapNotify event on each subwindow and -.ZN Expose +.B Expose events on formerly obscured windows. .IN "UnmapNotify Event" Using this function is much more efficient than unmapping multiple windows one at a time because the server needs to perform much of the work only once, for all of the windows, rather than for each window. .LP -.ZN XUnmapSubwindows +.B XUnmapSubwindows can generate a -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XChangeWindowAttributes(__libmansuffix__), diff --git a/man/XVaCreateNestedList.man b/man/XVaCreateNestedList.man index 6220f9d1..640e2aac 100644 --- a/man/XVaCreateNestedList.man +++ b/man/XVaCreateNestedList.man @@ -92,7 +92,7 @@ Specifies an unused argument (required by ANSI C). Specifies the variable length argument list. .SH DESCRIPTION The -.ZN XVaCreateNestedList +.B XVaCreateNestedList function allocates memory and copies its arguments into a single list pointer, which may be used as a value for arguments requiring a list value. @@ -101,7 +101,7 @@ Data passed by reference is not copied; the caller must ensure data remains valid for the lifetime of the nested list. The list should be freed using -.ZN XFree +.B XFree when it is no longer needed. .SH "SEE ALSO" \fI\*(xL\fP diff --git a/man/XVisibilityEvent.man b/man/XVisibilityEvent.man index b406cde9..6e704625 100644 --- a/man/XVisibilityEvent.man +++ b/man/XVisibilityEvent.man @@ -83,7 +83,7 @@ XVisibilityEvent \- VisibilityNotify event structure .SH STRUCTURES The structure for -.ZN VisibilityNotify +.B VisibilityNotify events contains: .LP .Ds 0 @@ -103,16 +103,16 @@ the structure members are set as follows. The type member is set to the event type constant name that uniquely identifies it. For example, when the X server reports a -.ZN GraphicsExpose +.B GraphicsExpose event to a client application, it sends an -.ZN XGraphicsExposeEvent +.B XGraphicsExposeEvent structure with the type member set to -.ZN GraphicsExpose . +.BR GraphicsExpose . The display member is set to a pointer to the display the event was read on. The send_event member is set to -.ZN True +.B True if the event came from a -.ZN SendEvent +.B SendEvent protocol request. The serial member is set from the serial number reported in the protocol but expanded from the 16-bit least-significant bits to a full 32-bit value. @@ -121,36 +121,36 @@ dispatchers. .LP The window member is set to the window whose visibility state changes. The state member is set to the state of the window's visibility and can be -.ZN VisibilityUnobscured , -.ZN VisibilityPartiallyObscured , +.BR VisibilityUnobscured , +.BR VisibilityPartiallyObscured , or -.ZN VisibilityFullyObscured . +.BR VisibilityFullyObscured . The X server ignores all of a window's subwindows when determining the visibility state of the window and processes -.ZN VisibilityNotify +.B VisibilityNotify events according to the following: .IP \(bu 5 When the window changes state from partially obscured, fully obscured, or not viewable to viewable and completely unobscured, the X server generates the event with the state member of the -.ZN XVisibilityEvent +.B XVisibilityEvent structure set to -.ZN VisibilityUnobscured . +.BR VisibilityUnobscured . .IP \(bu 5 When the window changes state from viewable and completely unobscured or not viewable to viewable and partially obscured, the X server generates the event with the state member of the -.ZN XVisibilityEvent +.B XVisibilityEvent structure set to -.ZN VisibilityPartiallyObscured . +.BR VisibilityPartiallyObscured . .IP \(bu 5 When the window changes state from viewable and completely unobscured, viewable and partially obscured, or not viewable to viewable and fully obscured, the X server generates the event with the state member of the -.ZN XVisibilityEvent +.B XVisibilityEvent structure set to -.ZN VisibilityFullyObscured . +.BR VisibilityFullyObscured . .SH "SEE ALSO" XAnyEvent(__libmansuffix__), XButtonEvent(__libmansuffix__), diff --git a/man/XWarpPointer.man b/man/XWarpPointer.man index 7b10ef2c..87835b20 100644 --- a/man/XWarpPointer.man +++ b/man/XWarpPointer.man @@ -90,7 +90,7 @@ int XWarpPointer\^(\^Display *\fIdisplay\fP\^, Window \fIsrc_w\fP\^, Window .SH ARGUMENTS .IP \fIdest_w\fP 1i Specifies the destination window or -.ZN None . +.BR None . .IP \fIdest_x\fP 1i .br .ns @@ -111,15 +111,15 @@ Specifies the connection to the X server. Specify a rectangle in the source window. .IP \fIsrc_w\fP 1i Specifies the source window or -.ZN None . +.BR None . .SH DESCRIPTION If dest_w is -.ZN None , -.ZN XWarpPointer +.BR None , +.B XWarpPointer moves the pointer by the offsets (dest_x, dest_y) relative to the current position of the pointer. If dest_w is a window, -.ZN XWarpPointer +.B XWarpPointer moves the pointer to the offsets (dest_x, dest_y) relative to the origin of dest_w. However, if src_w is a window, @@ -137,18 +137,18 @@ The pointer should normally be left to the user. If you do use this function, however, it generates events just as if the user had instantaneously moved the pointer from one position to another. Note that you cannot use -.ZN XWarpPointer +.B XWarpPointer to move the pointer outside the confine_to window of an active pointer grab. An attempt to do so will only move the pointer as far as the closest edge of the confine_to window. .LP -.ZN XWarpPointer +.B XWarpPointer can generate a -.ZN BadWindow +.B BadWindow error. .SH DIAGNOSTICS .TP 1i -.ZN BadWindow +.B BadWindow A value for a Window argument does not name a defined Window. .SH "SEE ALSO" XSetInputFocus(__libmansuffix__) diff --git a/man/XcmsAllocColor.man b/man/XcmsAllocColor.man index a3936da1..2fa6af66 100644 --- a/man/XcmsAllocColor.man +++ b/man/XcmsAllocColor.man @@ -110,56 +110,56 @@ Specifies the color string whose color definition structure is to be returned. Specifies the color format for the returned color specification. .SH DESCRIPTION The -.ZN XcmsAllocColor +.B XcmsAllocColor function is similar to -.ZN XAllocColor +.B XAllocColor except the color can be specified in any format. The -.ZN XcmsAllocColor +.B XcmsAllocColor function ultimately calls -.ZN XAllocColor +.B XAllocColor to allocate a read-only color cell (colormap entry) with the specified color. -.ZN XcmsAllocColor +.B XcmsAllocColor first converts the color specified to an RGB value and then passes this to -.ZN XAllocColor . -.ZN XcmsAllocColor +.BR XAllocColor . +.B XcmsAllocColor returns the pixel value of the color cell and the color specification actually allocated. This returned color specification is the result of converting the RGB value returned by -.ZN XAllocColor +.B XAllocColor into the format specified with the result_format argument. If there is no interest in a returned color specification, unnecessary computation can be bypassed if result_format is set to -.ZN XcmsRGBFormat . +.BR XcmsRGBFormat . The corresponding colormap cell is read-only. If this routine returns -.ZN XcmsFailure , +.BR XcmsFailure , the color_in_out color specification is left unchanged. .LP -.ZN XcmsAllocColor +.B XcmsAllocColor can generate a -.ZN BadColor +.B BadColor errors. .LP The -.ZN XcmsAllocNamedColor +.B XcmsAllocNamedColor function is similar to -.ZN XAllocNamedColor +.B XAllocNamedColor except that the color returned can be in any format specified. This function ultimately calls -.ZN XAllocColor +.B XAllocColor to allocate a read-only color cell with the color specified by a color string. The color string is parsed into an -.ZN XcmsColor +.B XcmsColor structure (see -.ZN XcmsLookupColor ), +.BR XcmsLookupColor ), converted to an RGB value, and finally passed to -.ZN XAllocColor . +.BR XAllocColor . If the color name is not in the Host Portable Character Encoding, the result is implementation-dependent. Use of uppercase or lowercase does not matter. @@ -169,23 +169,23 @@ of parsing (exact specification) and the actual color specification stored (screen specification). This screen specification is the result of converting the RGB value returned by -.ZN XAllocColor +.B XAllocColor into the format specified in result_format. If there is no interest in a returned color specification, unnecessary computation can be bypassed if result_format is set to -.ZN XcmsRGBFormat . +.BR XcmsRGBFormat . If color_screen_return and color_exact_return point to the same structure, the pixel field will be set correctly, but the color values are undefined. .LP .LP -.ZN XcmsAllocNamedColor +.B XcmsAllocNamedColor can generate a -.ZN BadColor +.B BadColor errors. .SH DIAGNOSTICS .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .SH "SEE ALSO" XcmsQueryColor(__libmansuffix__), diff --git a/man/XcmsCCCOfColormap.man b/man/XcmsCCCOfColormap.man index 9f0dfc10..bdbba6d3 100644 --- a/man/XcmsCCCOfColormap.man +++ b/man/XcmsCCCOfColormap.man @@ -97,22 +97,22 @@ Specifies the CCC. Specifies the colormap. .SH DESCRIPTION The -.ZN XcmsCCCOfColormap +.B XcmsCCCOfColormap function returns the CCC associated with the specified colormap. Once obtained, the CCC attributes can be queried or modified. Unless the CCC associated with the specified colormap is changed with -.ZN XcmsSetCCCOfColormap , +.BR XcmsSetCCCOfColormap , this CCC is used when the specified colormap is used as an argument to color functions. .LP The -.ZN XcmsSetCCCOfColormap +.B XcmsSetCCCOfColormap function changes the CCC associated with the specified colormap. It returns the CCC previously associated with the colormap. If they are not used again in the application, CCCs should be freed by calling -.ZN XcmsFreeCCC . +.BR XcmsFreeCCC . Several colormaps may share the same CCC without restriction; this includes the CCCs generated by Xlib with each colormap. Xlib, however, creates a new CCC with each new colormap. diff --git a/man/XcmsCIELabQueryMaxC.man b/man/XcmsCIELabQueryMaxC.man index c5d5db4f..dce608e9 100644 --- a/man/XcmsCIELabQueryMaxC.man +++ b/man/XcmsCIELabQueryMaxC.man @@ -116,35 +116,35 @@ or minimum lightness (MinL). Specifies the lightness (L*) at which to find maximum chroma (MaxC). .SH DESCRIPTION The -.ZN XcmsCIELabQueryMaxC +.B XcmsCIELabQueryMaxC function, given a hue angle and lightness, finds the point of maximum chroma displayable by the screen. It returns this point in CIE L*a*b* coordinates. .LP The -.ZN XcmsCIELabQueryMaxL +.B XcmsCIELabQueryMaxL function, given a hue angle and chroma, finds the point in CIE L*a*b* color space of maximum lightness (L*) displayable by the screen. It returns this point in CIE L*a*b* coordinates. An -.ZN XcmsFailure +.B XcmsFailure return value usually indicates that the given chroma is beyond maximum for the given hue angle. .LP The -.ZN XcmsCIELabQueryMaxLC +.B XcmsCIELabQueryMaxLC function, given a hue angle, finds the point of maximum chroma displayable by the screen. It returns this point in CIE L*a*b* coordinates. .LP The -.ZN XcmsCIELabQueryMinL +.B XcmsCIELabQueryMinL function, given a hue angle and chroma, finds the point of minimum lightness (L*) displayable by the screen. It returns this point in CIE L*a*b* coordinates. An -.ZN XcmsFailure +.B XcmsFailure return value usually indicates that the given chroma is beyond maximum for the given hue angle. .SH "SEE ALSO" diff --git a/man/XcmsCIELuvQueryMaxC.man b/man/XcmsCIELuvQueryMaxC.man index 14a2a226..db4fb712 100644 --- a/man/XcmsCIELuvQueryMaxC.man +++ b/man/XcmsCIELuvQueryMaxC.man @@ -121,35 +121,35 @@ Specifies the hue angle (in degrees) at which to find \*(Ha. Specifies the lightness (L*) at which to find \*(Ls. .SH DESCRIPTION The -.ZN XcmsCIELuvQueryMaxC +.B XcmsCIELuvQueryMaxC function, given a hue angle and lightness, finds the point of maximum chroma displayable by the screen. It returns this point in CIE L*u*v* coordinates. .LP The -.ZN XcmsCIELuvQueryMaxL +.B XcmsCIELuvQueryMaxL function, given a hue angle and chroma, finds the point in CIE L*u*v* color space of maximum lightness (L*) displayable by the screen. It returns this point in CIE L*u*v* coordinates. An -.ZN XcmsFailure +.B XcmsFailure return value usually indicates that the given chroma is beyond maximum for the given hue angle. .LP The -.ZN XcmsCIELuvQueryMaxLC +.B XcmsCIELuvQueryMaxLC function, given a hue angle, finds the point of maximum chroma displayable by the screen. It returns this point in CIE L*u*v* coordinates. .LP The -.ZN XcmsCIELuvQueryMinL +.B XcmsCIELuvQueryMinL function, given a hue angle and chroma, finds the point of minimum lightness (L*) displayable by the screen. It returns this point in CIE L*u*v* coordinates. An -.ZN XcmsFailure +.B XcmsFailure return value usually indicates that the given chroma is beyond maximum for the given hue angle. .SH "SEE ALSO" diff --git a/man/XcmsColor.man b/man/XcmsColor.man index 376913d9..785f5274 100644 --- a/man/XcmsColor.man +++ b/man/XcmsColor.man @@ -92,7 +92,7 @@ XcmsColor, XcmsRGB, XcmsRGBi, XcmsCIEXYZ, XcmsCIEuvY, XcmsCIExyY, XcmsCIELab, XcmsCIELuv, XcmsTekHVC, XcmsPad \- Xcms color structure .SH STRUCTURES The structure for -.ZN XcmsColor +.B XcmsColor contains: .LP .EX @@ -191,7 +191,7 @@ typedef struct { .EE .SH DESCRIPTION The -.ZN XcmsColor +.B XcmsColor structure contains a union of substructures, each supporting color specification encoding for a particular color space. .SH "SEE ALSO" diff --git a/man/XcmsConvertColors.man b/man/XcmsConvertColors.man index 941873bb..986e5af2 100644 --- a/man/XcmsConvertColors.man +++ b/man/XcmsConvertColors.man @@ -99,26 +99,26 @@ Pixel members are ignored and remain unchanged upon return. Returns an array of Boolean values indicating compression status. If a non-NULL pointer is supplied, each element of the array is set to -.ZN True +.B True if the corresponding color was compressed and -.ZN False +.B False otherwise. Pass NULL if the compression status is not useful. .IP \fIncolors\fP 1i Specifies the number of -.ZN XcmsColor +.B XcmsColor structures in the color-specification array. .IP \fItarget_format\fP 1i Specifies the target color specification format. .SH DESCRIPTION The -.ZN XcmsConvertColors +.B XcmsConvertColors function converts the color specifications in the specified array of -.ZN XcmsColor +.B XcmsColor structures from their current format to a single target format, using the specified CCC. When the return value is -.ZN XcmsFailure , +.BR XcmsFailure , the contents of the color specification array are left unchanged. .LP The array may contain a mixture of color specification formats @@ -126,8 +126,8 @@ The array may contain a mixture of color specification formats When the array contains both device-independent and device-dependent color specifications and the target_format argument specifies a device-dependent format (for example, -.ZN XcmsRGBiFormat , -.ZN XcmsRGBFormat ), +.BR XcmsRGBiFormat , +.BR XcmsRGBFormat ), all specifications are converted to CIE XYZ format and then to the target device-dependent format. .SH "SEE ALSO" diff --git a/man/XcmsCreateCCC.man b/man/XcmsCreateCCC.man index 1c260170..64d89f91 100644 --- a/man/XcmsCreateCCC.man +++ b/man/XcmsCreateCCC.man @@ -110,7 +110,7 @@ If NULL is specified and a function using this CCC must convert a color specification to a device-dependent format and encounters a color that lies outside the screen's color gamut, that function will return -.ZN XcmsFailure . +.BR XcmsFailure . .IP \fIscreen_number\fP 1i Specifies the appropriate screen number on the host server. .IP \fIvisual\fP 1i @@ -123,11 +123,11 @@ when the Client White Point differs from the Screen White Point. NULL indicates that no white point adjustment is desired. .SH DESCRIPTION The -.ZN XcmsCreateCCC +.B XcmsCreateCCC function creates a CCC for the specified display, screen, and visual. .LP The -.ZN XcmsFreeCCC +.B XcmsFreeCCC function frees the memory used for the specified CCC. Note that default CCCs and those currently associated with colormaps are ignored. diff --git a/man/XcmsDefaultCCC.man b/man/XcmsDefaultCCC.man index 21bf6cfc..3df5120c 100644 --- a/man/XcmsDefaultCCC.man +++ b/man/XcmsDefaultCCC.man @@ -92,7 +92,7 @@ Specifies the connection to the X server. Specifies the appropriate screen number on the host server. .SH DESCRIPTION The -.ZN XcmsDefaultCCC +.B XcmsDefaultCCC function returns the default CCC for the specified screen. Its visual is the default visual of the screen. Its initial gamut compression and white point diff --git a/man/XcmsQueryBlack.man b/man/XcmsQueryBlack.man index 06f33b8f..264d5d2d 100644 --- a/man/XcmsQueryBlack.man +++ b/man/XcmsQueryBlack.man @@ -111,27 +111,27 @@ The value returned in the pixel member is undefined. Specifies the target color specification format. .SH DESCRIPTION The -.ZN XcmsQueryBlack +.B XcmsQueryBlack function returns the color specification in the specified target format for zero-intensity red, green, and blue. .LP The -.ZN XcmsQueryBlue +.B XcmsQueryBlue function returns the color specification in the specified target format for full-intensity blue while red and green are zero. .LP The -.ZN XcmsQueryGreen +.B XcmsQueryGreen function returns the color specification in the specified target format for full-intensity green while red and blue are zero. .LP The -.ZN XcmsQueryRed +.B XcmsQueryRed function returns the color specification in the specified target format for full-intensity red while green and blue are zero. .LP The -.ZN XcmsQueryWhite +.B XcmsQueryWhite function returns the color specification in the specified target format for full-intensity red, green, and blue. .SH "SEE ALSO" diff --git a/man/XcmsQueryColor.man b/man/XcmsQueryColor.man index 583e403f..4ed6aa32 100644 --- a/man/XcmsQueryColor.man +++ b/man/XcmsQueryColor.man @@ -105,7 +105,7 @@ or parsed from the corresponding string found in a color-name database. .IP \fIcolor_in_out\fP 1i Specifies the pixel member that indicates the color cell to query. The color specification stored for the color cell is returned in this -.ZN XcmsColor +.B XcmsColor structure. .IP \fIcolor_screen_return\fP 1i Returns the color that can be reproduced on the screen. @@ -115,57 +115,57 @@ Specifies the color string. Specifies the color format for the returned color specifications (color_screen_return and color_exact_return arguments). If the format is -.ZN XcmsUndefinedFormat +.B XcmsUndefinedFormat and the color string contains a numerical color specification, the specification is returned in the format used in that numerical color specification. If the format is -.ZN XcmsUndefinedFormat +.B XcmsUndefinedFormat and the color string contains a color name, the specification is returned in the format used to store the color in the database. .IP \fIncolors\fP 1i Specifies the number of -.ZN XcmsColor +.B XcmsColor structures in the color-specification array. .SH DESCRIPTION The -.ZN XcmsQueryColor +.B XcmsQueryColor function obtains the RGB value for the pixel value in the pixel member of the specified -.ZN XcmsColor +.B XcmsColor structure and then converts the value to the target format as specified by the result_format argument. If the pixel is not a valid index in the specified colormap, a -.ZN BadValue +.B BadValue error results. The -.ZN XcmsQueryColors +.B XcmsQueryColors function obtains the RGB values for pixel values in the pixel members of -.ZN XcmsColor +.B XcmsColor structures and then converts the values to the target format as specified by the result_format argument. If a pixel is not a valid index into the specified colormap, a -.ZN BadValue +.B BadValue error results. If more than one pixel is in error, the one that gets reported is arbitrary. .LP -.ZN XcmsQueryColor +.B XcmsQueryColor and -.ZN XcmsQueryColors +.B XcmsQueryColors can generate -.ZN BadColor +.B BadColor and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XcmsLookupColor +.B XcmsLookupColor function looks up the string name of a color with respect to the screen associated with the specified colormap. It returns both the exact color values and @@ -175,23 +175,23 @@ The values are returned in the format specified by result_format. If the color name is not in the Host Portable Character Encoding, the result is implementation-dependent. Use of uppercase or lowercase does not matter. -.ZN XcmsLookupColor +.B XcmsLookupColor returns -.ZN XcmsSuccess +.B XcmsSuccess or -.ZN XcmsSuccessWithCompression +.B XcmsSuccessWithCompression if the name is resolved; otherwise, it returns -.ZN XcmsFailure . +.BR XcmsFailure . If -.ZN XcmsSuccessWithCompression +.B XcmsSuccessWithCompression is returned, the color specification returned in color_screen_return is the result of gamut compression. .SH DIAGNOSTICS .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XcmsSetWhitePoint.man b/man/XcmsSetWhitePoint.man index 742fe2c6..142a854c 100644 --- a/man/XcmsSetWhitePoint.man +++ b/man/XcmsSetWhitePoint.man @@ -98,19 +98,19 @@ Specifies the new Client White Point. Specifies the white point adjustment procedure. .SH DESCRIPTION The -.ZN XcmsSetWhitePoint +.B XcmsSetWhitePoint function changes the Client White Point in the specified CCC. Note that the pixel member is ignored and that the color specification is left unchanged upon return. The format for the new white point must be -.ZN XcmsCIEXYZFormat , -.ZN XcmsCIEuvYFormat , -.ZN XcmsCIExyYFormat , +.BR XcmsCIEXYZFormat , +.BR XcmsCIEuvYFormat , +.BR XcmsCIExyYFormat , or -.ZN XcmsUndefinedFormat . +.BR XcmsUndefinedFormat . If the color argument is NULL, this function sets the format component of the Client White Point specification to -.ZN XcmsUndefinedFormat , +.BR XcmsUndefinedFormat , indicating that the Client White Point is assumed to be the same as the Screen White Point. .LP @@ -120,7 +120,7 @@ otherwise, it returns zero. .LP The -.ZN XcmsSetWhiteAdjustProc +.B XcmsSetWhiteAdjustProc function first sets the white point adjustment procedure and client data in the specified CCC with the newly specified procedure and client data and then returns the old procedure. diff --git a/man/XcmsStoreColor.man b/man/XcmsStoreColor.man index 58282886..78ad85b5 100644 --- a/man/XcmsStoreColor.man +++ b/man/XcmsStoreColor.man @@ -95,11 +95,11 @@ Specifies the connection to the X server. .IP \fIcolor\fP 1i Specifies the color cell and the color to store. Values specified in this -.ZN XcmsColor +.B XcmsColor structure remain unchanged on return. .IP \fIcolors\fP 1i Specifies the color specification array of -.ZN XcmsColor +.B XcmsColor structures, each specifying a color cell and the color to store in that cell. Values specified in the array remain unchanged upon return. @@ -109,89 +109,89 @@ Specifies the colormap. Returns an array of Boolean values indicating compression status. If a non-NULL pointer is supplied, each element of the array is set to -.ZN True +.B True if the corresponding color was compressed and -.ZN False +.B False otherwise. Pass NULL if the compression status is not useful. .IP \fIncolors\fP 1i Specifies the number of -.ZN XcmsColor +.B XcmsColor structures in the color-specification array. .SH DESCRIPTION The -.ZN XcmsStoreColor +.B XcmsStoreColor function converts the color specified in the -.ZN XcmsColor +.B XcmsColor structure into RGB values. It then uses this RGB specification in an -.ZN XColor +.B XColor structure, whose three flags .Pn ( DoRed , -.ZN DoGreen , +.BR DoGreen , and -.ZN DoBlue ) +.BR DoBlue ) are set, in a call to -.ZN XStoreColor +.B XStoreColor to change the color cell specified by the pixel member of the -.ZN XcmsColor +.B XcmsColor structure. This pixel value must be a valid index for the specified colormap, and the color cell specified by the pixel value must be a read/write cell. If the pixel value is not a valid index, a -.ZN BadValue +.B BadValue error results. If the color cell is unallocated or is allocated read-only, a -.ZN BadAccess +.B BadAccess error results. If the colormap is an installed map for its screen, the changes are visible immediately. .LP Note that -.ZN XStoreColor +.B XStoreColor has no return value; therefore, an -.ZN XcmsSuccess +.B XcmsSuccess return value from this function indicates that the conversion to RGB succeeded and the call to -.ZN XStoreColor +.B XStoreColor was made. To obtain the actual color stored, use -.ZN XcmsQueryColor . +.BR XcmsQueryColor . Because of the screen's hardware limitations or gamut compression, the color stored in the colormap may not be identical to the color specified. .LP -.ZN XcmsStoreColor +.B XcmsStoreColor can generate -.ZN BadAccess , -.ZN BadColor , +.BR BadAccess , +.BR BadColor , and -.ZN BadValue +.B BadValue errors. .LP The -.ZN XcmsStoreColors +.B XcmsStoreColors function converts the colors specified in the array of -.ZN XcmsColor +.B XcmsColor structures into RGB values and then uses these RGB specifications in -.ZN XColor +.B XColor structures, whose three flags .Pn ( DoRed , -.ZN DoGreen , +.BR DoGreen , and -.ZN DoBlue ) +.BR DoBlue ) are set, in a call to -.ZN XStoreColors +.B XStoreColors to change the color cells specified by the pixel member of the corresponding -.ZN XcmsColor +.B XcmsColor structure. Each pixel value must be a valid index for the specified colormap, and the color cell specified by each pixel value must be a read/write cell. If a pixel value is not a valid index, a -.ZN BadValue +.B BadValue error results. If a color cell is unallocated or is allocated read-only, a -.ZN BadAccess +.B BadAccess error results. If more than one pixel is in error, the one that gets reported is arbitrary. @@ -199,41 +199,41 @@ If the colormap is an installed map for its screen, the changes are visible immediately. .LP Note that -.ZN XStoreColors +.B XStoreColors has no return value; therefore, an -.ZN XcmsSuccess +.B XcmsSuccess return value from this function indicates that conversions to RGB succeeded and the call to -.ZN XStoreColors +.B XStoreColors was made. To obtain the actual colors stored, use -.ZN XcmsQueryColors . +.BR XcmsQueryColors . Because of the screen's hardware limitations or gamut compression, the colors stored in the colormap may not be identical to the colors specified. .LP .LP -.ZN XcmsStoreColors +.B XcmsStoreColors can generate -.ZN BadAccess , -.ZN BadColor , +.BR BadAccess , +.BR BadColor , and -.ZN BadValue +.B BadValue errors. .SH DIAGNOSTICS .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to free a color map entry that it did not already allocate. .TP 1i -.ZN BadAccess +.B BadAccess A client attempted to store into a read-only color map entry. .TP 1i -.ZN BadColor +.B BadColor A value for a Colormap argument does not name a defined Colormap. .TP 1i -.ZN BadValue +.B BadValue Some numeric value falls outside the range of values accepted by the request. Unless a specific range is specified for an argument, the full range defined by the argument's type is accepted. Any argument defined as a set of diff --git a/man/XcmsTekHVCQueryMaxC.man b/man/XcmsTekHVCQueryMaxC.man index 9bd9e21f..1f103bd4 100644 --- a/man/XcmsTekHVCQueryMaxC.man +++ b/man/XcmsTekHVCQueryMaxC.man @@ -134,7 +134,7 @@ Specifies the number of samples. Specifies the Value in which to find the maximum Chroma (MaxC) or minimum Value (MinL). .SH DESCRIPTION The -.ZN XcmsTekHVCQueryMaxC +.B XcmsTekHVCQueryMaxC function, given a Hue and Value, determines the maximum Chroma in TekHVC color space displayable by the screen. @@ -142,7 +142,7 @@ It returns the maximum Chroma along with the actual Hue and Value at which the maximum Chroma was found. .LP The -.ZN XcmsTekHVCQueryMaxV +.B XcmsTekHVCQueryMaxV function, given a Hue and Chroma, determines the maximum Value in TekHVC color space displayable by the screen. @@ -150,7 +150,7 @@ It returns the maximum Value and the actual Hue and Chroma at which the maximum Value was found. .LP The -.ZN XcmsTekHVCQueryMaxVC +.B XcmsTekHVCQueryMaxVC function, given a Hue, determines the maximum Chroma in TekHVC color space displayable by the screen and the Value at which that maximum Chroma is reached. @@ -159,7 +159,7 @@ the Value at which that maximum Chroma is reached, and the actual Hue for which the maximum Chroma was found. .LP The -.ZN XcmsTekHVCQueryMaxVSamples +.B XcmsTekHVCQueryMaxVSamples returns nsamples of maximum Value, the Chroma at which that maximum Value is reached, and the actual Hue for which the maximum Chroma was found. These sample points may then be used to plot the maximum Value/Chroma @@ -167,7 +167,7 @@ boundary of the screen's color gamut for the specified Hue in TekHVC color space. .LP The -.ZN XcmsTekHVCQueryMinV +.B XcmsTekHVCQueryMinV function, given a Hue and Chroma, determines the minimum Value in TekHVC color space displayable by the screen. It returns the minimum Value and the actual Hue and Chroma at which diff --git a/man/XmbDrawImageString.man b/man/XmbDrawImageString.man index efeb0837..0e61bc88 100644 --- a/man/XmbDrawImageString.man +++ b/man/XmbDrawImageString.man @@ -117,33 +117,33 @@ Specifies the character string. Specify the x and y coordinates. .SH DESCRIPTION The -.ZN XmbDrawImageString , -.ZN XwcDrawImageString +.BR XmbDrawImageString , +.B XwcDrawImageString and -.ZN Xutf8DrawImageString +.B Xutf8DrawImageString functions fill a destination rectangle with the background pixel defined in the GC and then paint the text with the foreground pixel. The filled rectangle is the rectangle returned to overall_logical_return by -.ZN XmbTextExtents , -.ZN XwcTextExtents +.BR XmbTextExtents , +.B XwcTextExtents or -.ZN Xutf8TextExtents +.B Xutf8TextExtents for the same text and -.ZN XFontSet . +.BR XFontSet . .LP When the -.ZN XFontSet +.B XFontSet has missing charsets, each unavailable character is drawn with the default string returned by -.ZN XCreateFontSet . +.BR XCreateFontSet . The behavior for an invalid codepoint is undefined. .LP The function -.ZN Xutf8TextExtents +.B Xutf8TextExtents is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 release. Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH "SEE ALSO" XDrawImageString(__libmansuffix__), XDrawString(__libmansuffix__), diff --git a/man/XmbDrawString.man b/man/XmbDrawString.man index 6b2fb9f5..e4091409 100644 --- a/man/XmbDrawString.man +++ b/man/XmbDrawString.man @@ -117,24 +117,24 @@ Specifies the character string. Specify the x and y coordinates. .SH DESCRIPTION The -.ZN XmbDrawString , -.ZN XwcDrawString +.BR XmbDrawString , +.B XwcDrawString and -.ZN Xutf8DrawString +.B Xutf8DrawString functions draw the specified text with the foreground pixel. When the -.ZN XFontSet +.B XFontSet has missing charsets, each unavailable character is drawn with the default string returned by -.ZN XCreateFontSet . +.BR XCreateFontSet . The behavior for an invalid codepoint is undefined. .LP The function -.ZN Xutf8DrawString +.B Xutf8DrawString is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 release. Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH "SEE ALSO" XDrawImageString(__libmansuffix__), XDrawString(__libmansuffix__), diff --git a/man/XmbDrawText.man b/man/XmbDrawText.man index 3823c42d..d0b21be5 100644 --- a/man/XmbDrawText.man +++ b/man/XmbDrawText.man @@ -112,10 +112,10 @@ Specifies the number of text items in the array. Specify the x and y coordinates. .SH DESCRIPTION The -.ZN XmbDrawText , -.ZN XwcDrawText +.BR XmbDrawText , +.B XwcDrawText and -.ZN Xutf8DrawText +.B Xutf8DrawText functions allow complex spacing and font set shifts between text strings. Each text item is processed in turn, with the origin of a text element advanced in the primary draw direction by the escapement of the @@ -123,42 +123,42 @@ previous text item. A text item delta specifies an additional escapement of the text item drawing origin in the primary draw direction. A font_set member other than -.ZN None +.B None in an item causes the font set to be used for this and subsequent text items in the text_items list. Leading text items with a font_set member set to -.ZN None +.B None will not be drawn. .LP -.ZN XmbDrawText , -.ZN XwcDrawText +.BR XmbDrawText , +.B XwcDrawText and -.ZN Xutf8DrawText +.B Xutf8DrawText do not perform any context-dependent rendering between text segments. Clients may compute the drawing metrics by passing each text segment to -.ZN XmbTextExtents , -.ZN XwcTextExtents , -.ZN Xutf8TextExtents +.BR XmbTextExtents , +.BR XwcTextExtents , +.B Xutf8TextExtents or -.ZN XmbTextPerCharExtents , -.ZN XwcTextPerCharExtents . -.ZN Xutf8TextPerCharExtents . +.BR XmbTextPerCharExtents , +.BR XwcTextPerCharExtents . +.BR Xutf8TextPerCharExtents . When the -.ZN XFontSet +.B XFontSet has missing charsets, each unavailable character is drawn with the default string returned by -.ZN XCreateFontSet . +.BR XCreateFontSet . The behavior for an invalid codepoint is undefined. .LP The function -.ZN Xutf8DrawText +.B Xutf8DrawText is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 release. Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH STRUCTURES The -.ZN XmbTextItem +.B XmbTextItem structure contains: .Ds 0 typedef struct { @@ -169,7 +169,7 @@ typedef struct { } XmbTextItem; .De The -.ZN XwcTextItem +.B XwcTextItem structure contains: .Ds 0 typedef struct { diff --git a/man/XmbLookupString.man b/man/XmbLookupString.man index 0c20495c..8effbf76 100644 --- a/man/XmbLookupString.man +++ b/man/XmbLookupString.man @@ -116,10 +116,10 @@ Returns the KeySym computed from the event if this argument is not NULL. Returns a value indicating what kind of data is returned. .SH DESCRIPTION The -.ZN XmbLookupString , -.ZN XwcLookupString +.BR XmbLookupString , +.B XwcLookupString and -.ZN Xutf8LookupString +.B Xutf8LookupString functions return the string from the input method specified in the buffer_return argument. If no string is returned, @@ -131,38 +131,38 @@ argument indicates that a KeySym was returned. If both a string and a KeySym are returned, the KeySym value does not necessarily correspond to the string returned. .LP -.ZN XmbLookupString +.B XmbLookupString and -.ZN Xutf8LookupString +.B Xutf8LookupString return the length of the string in bytes, and -.ZN XwcLookupString +.B XwcLookupString returns the length of the string in characters. Both -.ZN XmbLookupString +.B XmbLookupString and -.ZN XwcLookupString +.B XwcLookupString return text in the encoding of the locale bound to the input method of the specified input context, and -.ZN Xutf8LookupString +.B Xutf8LookupString returns text in UTF-8 encoding. .LP Each string returned by -.ZN XmbLookupString +.B XmbLookupString and -.ZN XwcLookupString +.B XwcLookupString begins in the initial state of the encoding of the locale (if the encoding of the locale is state-dependent). .LP Note: To ensure proper input processing, it is essential that the client pass only -.ZN KeyPress +.B KeyPress events to -.ZN XmbLookupString , -.ZN XwcLookupString +.BR XmbLookupString , +.B XwcLookupString and -.ZN Xutf8LookupString . +.BR Xutf8LookupString . Their behavior when a client passes a -.ZN KeyRelease +.B KeyRelease event is undefined. .LP Clients should check the status_return argument before @@ -173,28 +173,28 @@ The possible values returned are: .TS lw(1.5i) lw(4.3i). T{ -.ZN XBufferOverflow +.B XBufferOverflow T} T{ The input string to be returned is too large for the supplied buffer_return. The required size (for -.ZN XmbLookupString , -.ZN Xutf8LookupString +.BR XmbLookupString , +.B Xutf8LookupString in bytes; for -.ZN XwcLookupString +.B XwcLookupString in characters) is returned as the value of the function, and the contents of buffer_return and keysym_return are not modified. The client should recall the function with the same event and a buffer of adequate size to obtain the string. T} T{ -.ZN XLookupNone +.B XLookupNone T} T{ No consistent input has been composed so far. The contents of buffer_return and keysym_return are not modified, and the function returns zero. T} T{ -.ZN XLookupChars +.B XLookupChars T} T{ Some input characters have been composed. They are placed in the buffer_return argument, using the encoding @@ -203,7 +203,7 @@ and the string length is returned as the value of the function. The content of the keysym_return argument is not modified. T} T{ -.ZN XLookupKeySym +.B XLookupKeySym T} T{ A KeySym has been returned instead of a string and is returned in keysym_return. @@ -211,36 +211,36 @@ The content of the buffer_return argument is not modified, and the function returns zero. T} T{ -.ZN XLookupBoth +.B XLookupBoth T} T{ Both a KeySym and a string are returned; -.ZN XLookupChars +.B XLookupChars and -.ZN XLookupKeySym +.B XLookupKeySym occur simultaneously. T} .TE .LP It does not make any difference if the input context passed as an argument to -.ZN XmbLookupString , -.ZN XwcLookupString +.BR XmbLookupString , +.B XwcLookupString and -.ZN Xutf8LookupString +.B Xutf8LookupString is the one currently in possession of the focus or not. Input may have been composed within an input context before it lost the focus, and that input may be returned on subsequent calls to -.ZN XmbLookupString , -.ZN XwcLookupString +.BR XmbLookupString , +.B XwcLookupString or -.ZN Xutf8LookupString +.B Xutf8LookupString even though it does not have any more keyboard focus. .LP The function -.ZN Xutf8LookupString +.B Xutf8LookupString is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 release. Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH "SEE ALSO" XLookupKeysym(__libmansuffix__), Compose(__filemansuffix__) diff --git a/man/XmbResetIC.man b/man/XmbResetIC.man index f265ee2f..7d15eb12 100644 --- a/man/XmbResetIC.man +++ b/man/XmbResetIC.man @@ -94,37 +94,37 @@ char *Xutf8ResetIC\^(\^XIC \fIic\fP\^); Specifies the input context. .SH DESCRIPTION When -.ZN XNResetState +.B XNResetState is set to -.ZN XIMInitialState , -.ZN XmbResetIC , -.ZN XwcResetIC +.BR XIMInitialState , +.BR XmbResetIC , +.B XwcResetIC and -.ZN Xutf8ResetIC +.B Xutf8ResetIC reset an input context to its initial state; when -.ZN XNResetState +.B XNResetState is set to -.ZN XIMPreserveState , +.BR XIMPreserveState , the current input context state is preserved. In both cases, any input pending on that context is deleted. The input method is required to clear the preedit area, if any, and update the status accordingly. Calling -.ZN XmbResetIC , -.ZN XwcResetIC +.BR XmbResetIC , +.B XwcResetIC or -.ZN Xutf8ResetIC +.B Xutf8ResetIC does not change the focus. .LP The return value of -.ZN XmbResetIC +.B XmbResetIC is its current preedit string as a multibyte string. The return value of -.ZN XwcResetIC +.B XwcResetIC is its current preedit string as a wide character string. The return value of -.ZN Xutf8ResetIC +.B Xutf8ResetIC is its current preedit string as an UTF-8 string. If there is any preedit text drawn or visible to the user, then these procedures must return a non-NULL string. @@ -133,14 +133,14 @@ then it is input method implementation-dependent whether these procedures return a non-NULL string or NULL. .LP The client should free the returned string by calling -.ZN XFree . +.BR XFree . .LP The function -.ZN Xutf8ResetIC +.B Xutf8ResetIC is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 release. Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH "SEE ALSO" XCreateIC(__libmansuffix__), XOpenIM(__libmansuffix__), diff --git a/man/XmbTextEscapement.man b/man/XmbTextEscapement.man index 35da94c1..773a218b 100644 --- a/man/XmbTextEscapement.man +++ b/man/XmbTextEscapement.man @@ -103,10 +103,10 @@ Specifies the number of characters in the string argument. Specifies the character string. .SH DESCRIPTION The -.ZN XmbTextEscapement , -.ZN XwcTextEscapement +.BR XmbTextEscapement , +.B XwcTextEscapement and -.ZN Xutf8TextEscapement +.B Xutf8TextEscapement functions return the escapement in pixels of the specified string as a value, using the fonts loaded for the specified font set. The escapement is the distance in pixels in the primary draw @@ -118,11 +118,11 @@ Regardless of the character rendering order, the escapement is always positive. .LP The function -.ZN Xutf8TextEscapement +.B Xutf8TextEscapement is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 release. Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH "SEE ALSO" XmbTextExtents(__libmansuffix__), XmbTextPerCharExtents(__libmansuffix__) diff --git a/man/XmbTextExtents.man b/man/XmbTextExtents.man index 247412fb..53cd676e 100644 --- a/man/XmbTextExtents.man +++ b/man/XmbTextExtents.man @@ -110,19 +110,19 @@ Returns the overall logical dimensions. Specifies the character string. .SH DESCRIPTION The -.ZN XmbTextExtents , -.ZN XwcTextExtents +.BR XmbTextExtents , +.B XwcTextExtents and -.ZN Xutf8TextExtents +.B Xutf8TextExtents functions set the components of the specified overall_ink_return and overall_logical_return arguments to the overall bounding box of the string's image and a logical bounding box for spacing purposes, respectively. They return the value returned by -.ZN XmbTextEscapement , -.ZN XwcTextEscapement +.BR XmbTextEscapement , +.B XwcTextEscapement or -.ZN Xutf8TextEscapement . +.BR Xutf8TextEscapement . These metrics are relative to the drawing origin of the string, using the fonts loaded for the specified font set. .LP @@ -144,20 +144,20 @@ Other graphical features, for example, a border surrounding the text, should not intersect this rectangle. .LP When the -.ZN XFontSet +.B XFontSet has missing charsets, metrics for each unavailable character are taken from the default string returned by -.ZN XCreateFontSet +.B XCreateFontSet so that the metrics represent the text as it will actually be drawn. The behavior for an invalid codepoint is undefined. .LP The function -.ZN Xutf8TextExtents +.B Xutf8TextExtents is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 release. Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH "SEE ALSO" XmbTextEscapement(__libmansuffix__), XmbTextPerCharExtents(__libmansuffix__) diff --git a/man/XmbTextListToTextProperty.man b/man/XmbTextListToTextProperty.man index cd473463..89adc865 100644 --- a/man/XmbTextListToTextProperty.man +++ b/man/XmbTextListToTextProperty.man @@ -122,11 +122,11 @@ Specifies the number of strings specified. Specifies the manner in which the property is encoded. .IP \fItext_prop_return\fP 1i Returns the -.ZN XTextProperty +.B XTextProperty structure. .IP \fItext_prop\fP 1i Specifies the -.ZN XTextProperty +.B XTextProperty structure to be used. .IP \fIlist_return\fP 1i Returns a list of null-terminated character strings. @@ -136,46 +136,46 @@ Returns the number of strings. Specifies the list of strings to be freed. .SH DESCRIPTION The -.ZN XmbTextListToTextProperty , -.ZN XwcTextListToTextProperty +.BR XmbTextListToTextProperty , +.B XwcTextListToTextProperty and -.ZN Xutf8TextListToTextProperty +.B Xutf8TextListToTextProperty functions set the specified -.ZN XTextProperty +.B XTextProperty value to a set of null-separated elements representing the concatenation of the specified list of null-terminated text strings. The input text strings must be given in the current locale encoding (for -.ZN XmbTextListToTextProperty +.B XmbTextListToTextProperty and -.ZN XwcTextListToTextProperty ), +.BR XwcTextListToTextProperty ), or in UTF-8 encoding (for -.ZN Xutf8TextListToTextProperty ). +.BR Xutf8TextListToTextProperty ). .LP The functions set the encoding field of text_prop_return to an -.ZN Atom +.B Atom for the specified display naming the encoding determined by the specified style and convert the specified text list to this encoding for storage in the text_prop_return value field. If the style -.ZN XStringStyle +.B XStringStyle or -.ZN XCompoundTextStyle +.B XCompoundTextStyle is specified, this encoding is ``STRING'' or ``COMPOUND_TEXT'', respectively. If the style -.ZN XUTF8StringStyle +.B XUTF8StringStyle is specified, this encoding is ``UTF8_STRING''. (This is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 release. Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING .) +.BR X_HAVE_UTF8_STRING .) If the style -.ZN XTextStyle +.B XTextStyle is specified, this encoding is the encoding of the current locale. If the style -.ZN XStdICCTextStyle +.B XStdICCTextStyle is specified, this encoding is ``STRING'' if the text is fully convertible to STRING, else ``COMPOUND_TEXT''. @@ -184,46 +184,46 @@ of text_prop_return but is not included in the nitems member. .LP If insufficient memory is available for the new value string, the functions return -.ZN XNoMemory . +.BR XNoMemory . If the current locale is not supported, the functions return -.ZN XLocaleNotSupported . +.BR XLocaleNotSupported . In both of these error cases, the functions do not set text_prop_return. .LP To determine if the functions are guaranteed not to return -.ZN XLocaleNotSupported , +.BR XLocaleNotSupported , use -.ZN XSupportsLocale . +.BR XSupportsLocale . .LP If the supplied text is not fully convertible to the specified encoding, the functions return the number of unconvertible characters. Each unconvertible character is converted to an implementation-defined and encoding-specific default string. Otherwise, the functions return -.ZN Success . +.BR Success . Note that full convertibility to all styles except -.ZN XStringStyle +.B XStringStyle is guaranteed. .LP To free the storage for the value field, use -.ZN XFree . +.BR XFree . .LP The -.ZN XmbTextPropertyToTextList , -.ZN XwcTextPropertyToTextList +.BR XmbTextPropertyToTextList , +.B XwcTextPropertyToTextList and -.ZN Xutf8TextPropertyToTextList +.B Xutf8TextPropertyToTextList functions return a list of text strings representing the null-separated elements of the specified -.ZN XTextProperty +.B XTextProperty structure. The returned strings are encoded using the current locale encoding (for -.ZN XmbTextPropertyToTextList +.B XmbTextPropertyToTextList and -.ZN XwcTextPropertyToTextList ) +.BR XwcTextPropertyToTextList ) or in UTF-8 (for -.ZN Xutf8TextPropertyToTextList ). +.BR Xutf8TextPropertyToTextList ). The data in text_prop must be format 8. .LP Multiple elements of the property (for example, the strings in a disjoint @@ -232,25 +232,25 @@ The contents of the property are not required to be null-terminated; any terminating null should not be included in text_prop.nitems. .LP If insufficient memory is available for the list and its elements, -.ZN XmbTextPropertyToTextList , -.ZN XwcTextPropertyToTextList +.BR XmbTextPropertyToTextList , +.B XwcTextPropertyToTextList and -.ZN Xutf8TextPropertyToTextList +.B Xutf8TextPropertyToTextList return -.ZN XNoMemory . +.BR XNoMemory . If the current locale is not supported, the functions return -.ZN XLocaleNotSupported . +.BR XLocaleNotSupported . Otherwise, if the encoding field of text_prop is not convertible to the encoding of the current locale, the functions return -.ZN XConverterNotFound . +.BR XConverterNotFound . For supported locales, existence of a converter from COMPOUND_TEXT, STRING, UTF8_STRING or the encoding of the current locale is guaranteed if -.ZN XSupportsLocale +.B XSupportsLocale returns -.ZN True +.B True for the current locale (but the actual text may contain unconvertible characters). Conversion of other encodings is implementation-dependent. @@ -258,10 +258,10 @@ In all of these error cases, the functions do not set any return values. .LP Otherwise, -.ZN XmbTextPropertyToTextList , -.ZN XwcTextPropertyToTextList +.BR XmbTextPropertyToTextList , +.B XwcTextPropertyToTextList and -.ZN Xutf8TextPropertyToTextList +.B Xutf8TextPropertyToTextList return the list of null-terminated text strings to list_return and the number of text strings to count_return. .LP @@ -272,52 +272,52 @@ Each unconvertible character is converted to a string in the current locale that is specific to the current locale. To obtain the value of this string, use -.ZN XDefaultString . +.BR XDefaultString . Otherwise, -.ZN XmbTextPropertyToTextList , -.ZN XwcTextPropertyToTextList +.BR XmbTextPropertyToTextList , +.B XwcTextPropertyToTextList and -.ZN Xutf8TextPropertyToTextList +.B Xutf8TextPropertyToTextList return -.ZN Success . +.BR Success . .LP To free the storage for the list and its contents returned by -.ZN XmbTextPropertyToTextList +.B XmbTextPropertyToTextList or -.ZN Xutf8TextPropertyToTextList , +.BR Xutf8TextPropertyToTextList , use -.ZN XFreeStringList . +.BR XFreeStringList . To free the storage for the list and its contents returned by -.ZN XwcTextPropertyToTextList , +.BR XwcTextPropertyToTextList , use -.ZN XwcFreeStringList . +.BR XwcFreeStringList . .LP The -.ZN XwcFreeStringList +.B XwcFreeStringList function frees memory allocated by -.ZN XwcTextPropertyToTextList . +.BR XwcTextPropertyToTextList . .LP The -.ZN XDefaultString +.B XDefaultString function returns the default string used by Xlib for text conversion (for example, in -.ZN XmbTextPropertyToTextList ). +.BR XmbTextPropertyToTextList ). The default string is the string in the current locale that is output when an unconvertible character is found during text conversion. If the string returned by -.ZN XDefaultString +.B XDefaultString is the empty string ("\^"), no character is output in the converted text. -.ZN XDefaultString +.B XDefaultString does not return NULL. .LP The string returned by -.ZN XDefaultString +.B XDefaultString is independent of the default string for text drawing; see -.ZN XCreateFontSet +.B XCreateFontSet to obtain the default string for an -.ZN XFontSet . +.BR XFontSet . .LP The behavior when an invalid codepoint is supplied to any Xlib function is undefined. @@ -328,16 +328,16 @@ It may be freed after the current locale is changed. Until freed, it will not be modified by Xlib. .LP The functions -.ZN Xutf8TextListToTextProperty +.B Xutf8TextListToTextProperty and -.ZN Xutf8TextPropertyToTextList +.B Xutf8TextPropertyToTextList are extensions introduced by The XFree86 Project, Inc. in their 4.0.2 release. Their presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH STRUCTURES The -.ZN XTextProperty +.B XTextProperty structure contains: .LP .Ds 0 @@ -350,7 +350,7 @@ typedef struct { .De .LP The -.ZN XICCEncodingStyle +.B XICCEncodingStyle structure contains: .LP .TS @@ -358,21 +358,21 @@ lw(.5i) lw(2i) lw(2.5i). T{ \&#define T} T{ -.ZN XNoMemory +.B XNoMemory T} T{ \-1 T} T{ \&#define T} T{ -.ZN XLocaleNotSupported +.B XLocaleNotSupported T} T{ \-2 T} T{ \&#define T} T{ -.ZN XConverterNotFound +.B XConverterNotFound T} T{ \-3 T} diff --git a/man/XmbTextPerCharExtents.man b/man/XmbTextPerCharExtents.man index 201508c5..fa0ceaf8 100644 --- a/man/XmbTextPerCharExtents.man +++ b/man/XmbTextPerCharExtents.man @@ -125,10 +125,10 @@ Returns the overall logical extents of the entire string. Specifies the character string. .SH DESCRIPTION The -.ZN XmbTextPerCharExtents , -.ZN XwcTextPerCharExtents +.BR XmbTextPerCharExtents , +.B XwcTextPerCharExtents and -.ZN Xutf8TextPerCharExtents +.B Xutf8TextPerCharExtents functions return the text dimensions of each character of the specified text, using the fonts loaded for the specified font set. Each successive element of ink_array_return and logical_array_return @@ -148,20 +148,20 @@ Other graphical features should not intersect any of the logical_array_return rectangles. .LP Note that an -.ZN XRectangle +.B XRectangle represents the effective drawing dimensions of the character, regardless of the number of font glyphs that are used to draw the character or the direction in which the character is drawn. If multiple characters map to a single character glyph, the dimensions of all the -.ZN XRectangles +.B XRectangles of those characters are the same. .LP When the -.ZN XFontSet +.B XFontSet has missing charsets, metrics for each unavailable character are taken from the default string returned by -.ZN XCreateFontSet +.B XCreateFontSet so that the metrics represent the text as it will actually be drawn. The behavior for an invalid codepoint is undefined. .LP @@ -171,23 +171,23 @@ and num_chars_return is set to the number of rectangles required. Otherwise, the functions return a nonzero value. .LP If the overall_ink_return or overall_logical_return argument is non-NULL, -.ZN XmbTextPerCharExtents , -.ZN XwcTextPerCharExtents +.BR XmbTextPerCharExtents , +.B XwcTextPerCharExtents and -.ZN Xutf8TextPerCharExtents +.B Xutf8TextPerCharExtents return the maximum extent of the string's metrics to overall_ink_return or overall_logical_return, as returned by -.ZN XmbTextExtents , -.ZN XwcTextExtents +.BR XmbTextExtents , +.B XwcTextExtents or -.ZN Xutf8TextExtents . +.BR Xutf8TextExtents . .LP The function -.ZN Xutf8TextPerCharExtents +.B Xutf8TextPerCharExtents is an extension introduced by The XFree86 Project, Inc. in their 4.0.2 release. Its presence is indicated by the macro -.ZN X_HAVE_UTF8_STRING . +.BR X_HAVE_UTF8_STRING . .SH "SEE ALSO" XmbTextEscapement(__libmansuffix__), XmbTextExtents(__libmansuffix__) diff --git a/man/XrmEnumerateDatabase.man b/man/XrmEnumerateDatabase.man index 03c0f30e..5df3b50e 100644 --- a/man/XrmEnumerateDatabase.man +++ b/man/XrmEnumerateDatabase.man @@ -91,14 +91,14 @@ lw(.5i) lw(2i) lw(2.5i). T{ \&#define T} T{ -.ZN XrmEnumAllLevels +.B XrmEnumAllLevels T} T{ 0 T} T{ \&#define T} T{ -.ZN XrmEnumOneLevel +.B XrmEnumOneLevel T} T{ 1 T} @@ -122,25 +122,25 @@ Specifies the procedure that is to be called for each matching entry. Specifies the user-supplied argument that will be passed to the procedure. .SH DESCRIPTION The -.ZN XrmEnumerateDatabase +.B XrmEnumerateDatabase function calls the specified procedure for each resource in the database that would match some completion of the given name/class resource prefix. The order in which resources are found is implementation-dependent. If mode is -.ZN XrmEnumOneLevel , +.BR XrmEnumOneLevel , a resource must match the given name/class prefix with just a single name and class appended. If mode is -.ZN XrmEnumAllLevels , +.BR XrmEnumAllLevels , the resource must match the given name/class prefix with one or more names and classes appended. If the procedure returns -.ZN True , +.BR True , the enumeration terminates and the function returns -.ZN True . +.BR True . If the procedure always returns -.ZN False , +.BR False , all matching resources are enumerated and the function returns -.ZN False . +.BR False . .LP The procedure is called with the following arguments: .LP @@ -157,7 +157,7 @@ The procedure is called with the following arguments: .\" End marker code here .LP The bindings and quarks lists are terminated by -.ZN NULLQUARK . +.BR NULLQUARK . Note that pointers to the database and type are passed, but these values should not be modified. .LP diff --git a/man/XrmGetFileDatabase.man b/man/XrmGetFileDatabase.man index a0c10197..63b9534a 100644 --- a/man/XrmGetFileDatabase.man +++ b/man/XrmGetFileDatabase.man @@ -125,7 +125,7 @@ Specifies the resource database. Specifies the connection to the X server. .SH DESCRIPTION The -.ZN XrmGetFileDatabase +.B XrmGetFileDatabase function opens the specified file, creates a new resource database, and loads it with the specifications read in from the specified file. @@ -135,11 +135,11 @@ with incorrect syntax is implementation-dependent. The file is parsed in the current locale, and the database is created in the current locale. If it cannot open the specified file, -.ZN XrmGetFileDatabase +.B XrmGetFileDatabase returns NULL. .LP The -.ZN XrmPutFileDatabase +.B XrmPutFileDatabase function stores a copy of the specified database in the specified file. Text is written to the file as a sequence of entries in valid ResourceLine format (see section 15.1). @@ -151,12 +151,12 @@ The order in which entries are written is implementation-dependent. Entries with representation types other than ``String'' are ignored. .LP The -.ZN XrmGetStringDatabase +.B XrmGetStringDatabase function creates a new database and stores the resources specified in the specified null-terminated string. -.ZN XrmGetStringDatabase +.B XrmGetStringDatabase is similar to -.ZN XrmGetFileDatabase +.B XrmGetFileDatabase except that it reads the information out of a string instead of out of a file. The string should contain a sequence of entries in valid ResourceLine format (see section 15.1) terminated by a null character; @@ -166,11 +166,11 @@ The string is parsed in the current locale, and the database is created in the current locale. .LP If database is NULL, -.ZN XrmDestroyDatabase +.B XrmDestroyDatabase returns immediately. .LP The -.ZN XrmLocaleOfDatabase +.B XrmLocaleOfDatabase function returns the name of the locale bound to the specified database, as a null-terminated string. The returned locale name string is owned by Xlib and should not be @@ -180,12 +180,12 @@ Until the string is freed, it will not be modified by Xlib. .LP The -.ZN XrmGetDatabase +.B XrmGetDatabase function returns the database associated with the specified display. It returns NULL if a database has not yet been set. .LP The -.ZN XrmSetDatabase +.B XrmSetDatabase function associates the specified resource database (or NULL) with the specified display. The database previously associated with the display (if any) is not destroyed. diff --git a/man/XrmGetResource.man b/man/XrmGetResource.man index ef2cf9ad..f8fec49a 100644 --- a/man/XrmGetResource.man +++ b/man/XrmGetResource.man @@ -113,7 +113,7 @@ Specifies a list of resource classes. Specifies the database that is to be used. .IP \fIlist\fP 1i Specifies the search list returned by -.ZN XrmQGetSearchList . +.BR XrmQGetSearchList . .IP \fIlist_length\fP 1i Specifies the number of entries (not the byte size) allocated for list_return. .IP \fIlist_return\fP 1i @@ -140,9 +140,9 @@ Returns data representation type. Returns the value in the database. .SH DESCRIPTION The -.ZN XrmGetResource +.B XrmGetResource and -.ZN XrmQGetResource +.B XrmQGetResource functions retrieve a resource from the specified database. Both take a fully qualified name/class pair, a destination resource representation, and the address of a value @@ -151,36 +151,36 @@ The value and returned type point into database memory; therefore, you must not modify the data. .LP The database only frees or overwrites entries on -.ZN XrmPutResource , -.ZN XrmQPutResource , +.BR XrmPutResource , +.BR XrmQPutResource , or -.ZN XrmMergeDatabases . +.BR XrmMergeDatabases . A client that is not storing new values into the database or is not merging the database should be safe using the address passed back at any time until it exits. If a resource was found, both -.ZN XrmGetResource +.B XrmGetResource and -.ZN XrmQGetResource +.B XrmQGetResource return -.ZN True ; +.BR True ; otherwise, they return -.ZN False . +.BR False . .LP The -.ZN XrmQGetSearchList +.B XrmQGetSearchList function takes a list of names and classes and returns a list of database levels where a match might occur. The returned list is in best-to-worst order and uses the same algorithm as -.ZN XrmGetResource +.B XrmGetResource for determining precedence. If list_return was large enough for the search list, -.ZN XrmQGetSearchList +.B XrmQGetSearchList returns -.ZN True ; +.BR True ; otherwise, it returns -.ZN False . +.BR False . .LP The size of the search list that the caller must allocate is dependent upon the number of levels and wildcards in the resource specifiers @@ -189,32 +189,32 @@ The worst case length is %3 sup n%, where \fIn\fP is the number of name or class components in names or classes. .LP When using -.ZN XrmQGetSearchList +.B XrmQGetSearchList followed by multiple probes for resources with a common name and class prefix, only the common prefix should be specified in the name and class list to -.ZN XrmQGetSearchList . +.BR XrmQGetSearchList . .LP The -.ZN XrmQGetSearchResource +.B XrmQGetSearchResource function searches the specified database levels for the resource that is fully identified by the specified name and class. The search stops with the first match. -.ZN XrmQGetSearchResource +.B XrmQGetSearchResource returns -.ZN True +.B True if the resource was found; otherwise, it returns -.ZN False . +.BR False . .LP A call to -.ZN XrmQGetSearchList +.B XrmQGetSearchList with a name and class list containing all but the last component of a resource name followed by a call to -.ZN XrmQGetSearchResource +.B XrmQGetSearchResource with the last component name and class returns the same database entry as -.ZN XrmGetResource +.B XrmGetResource and -.ZN XrmQGetResource +.B XrmQGetResource with the fully qualified name and class. .SH "MATCHING RULES" The algorithm for determining which resource database entry diff --git a/man/XrmInitialize.man b/man/XrmInitialize.man index 3b3ddd78..7aa5a5f9 100644 --- a/man/XrmInitialize.man +++ b/man/XrmInitialize.man @@ -106,17 +106,17 @@ Specifies the table of command line arguments to be parsed. Specifies the number of entries in the table. .SH DESCRIPTION The -.ZN XrmInitialize +.B XrmInitialize function initialize the resource manager. It must be called before any other Xrm functions are used. .LP The -.ZN XrmParseCommand +.B XrmParseCommand function parses an (argc, argv) pair according to the specified option table, loads recognized options into the specified database with type ``String,'' and modifies the (argc, argv) pair to remove all recognized options. If database contains NULL, -.ZN XrmParseCommand +.B XrmParseCommand creates a new database and returns a pointer to it. Otherwise, entries are added to the database specified. If a database is created, it is created in the current locale. @@ -128,7 +128,7 @@ in the order they occur in argv. The table entries contain information on the option string, the option name, the style of option, and a value to provide if the option kind is -.ZN XrmoptionNoArg . +.BR XrmoptionNoArg . The option names are compared byte-for-byte to arguments in argv, independent of any locale. The resource values given in the table are stored in the resource database @@ -153,10 +153,10 @@ Host Portable Character Encoding, the result is implementation-dependent. .SH STRUCTURES The -.ZN XrmValue , -.ZN XrmOptionKind , +.BR XrmValue , +.BR XrmOptionKind , and -.ZN XrmOptionDescRec +.B XrmOptionDescRec structures contain: .LP .Ds 0 diff --git a/man/XrmMergeDatabases.man b/man/XrmMergeDatabases.man index 41b27bb6..70f17e9a 100644 --- a/man/XrmMergeDatabases.man +++ b/man/XrmMergeDatabases.man @@ -105,22 +105,22 @@ Specifies the resource database file name. Specifies whether source entries override target ones. .SH DESCRIPTION Calling the -.ZN XrmMergeDatabases +.B XrmMergeDatabases function is equivalent to calling the -.ZN XrmCombineDatabase +.B XrmCombineDatabase function with an override argument of -.ZN True . +.BR True . .LP The -.ZN XrmCombineDatabase +.B XrmCombineDatabase function merges the contents of one database into another. If the same specifier is used for an entry in both databases, the entry in the source_db will replace the entry in the target_db if override is -.ZN True ; +.BR True ; otherwise, the entry in source_db is discarded. If target_db contains NULL, -.ZN XrmCombineDatabase +.B XrmCombineDatabase simply stores source_db in it. Otherwise, source_db is destroyed by the merge, but the database pointed to by target_db is not destroyed. @@ -129,20 +129,20 @@ regardless of the locales of the databases. The locale of the target database is not modified. .LP The -.ZN XrmCombineFileDatabase +.B XrmCombineFileDatabase function merges the contents of a resource file into a database. If the same specifier is used for an entry in both the file and the database, the entry in the file will replace the entry in the database if override is -.ZN True ; +.BR True ; otherwise, the entry in the file is discarded. The file is parsed in the current locale. If the file cannot be read, a zero status is returned; otherwise, a nonzero status is returned. If target_db contains NULL, -.ZN XrmCombineFileDatabase +.B XrmCombineFileDatabase creates and returns a new database to it. Otherwise, the database pointed to by target_db is not destroyed by the merge. The database entries are merged without changing values or types, diff --git a/man/XrmPutResource.man b/man/XrmPutResource.man index fd644630..09ad07cf 100644 --- a/man/XrmPutResource.man +++ b/man/XrmPutResource.man @@ -117,11 +117,11 @@ Specifies the type of the resource. Specifies the value of the resource, which is specified as a string. .SH DESCRIPTION If database contains NULL, -.ZN XrmPutResource +.B XrmPutResource creates a new database and returns a pointer to it. -.ZN XrmPutResource +.B XrmPutResource is a convenience function that calls -.ZN XrmStringToBindingQuarkList +.B XrmStringToBindingQuarkList followed by: .LP .Ds @@ -133,7 +133,7 @@ the result is implementation-dependent. The value is stored in the database without modification. .LP If database contains NULL, -.ZN XrmQPutResource +.B XrmQPutResource creates a new database and returns a pointer to it. If a resource entry with the identical bindings and quarks already exists in the database, the previous type and value are replaced by the new @@ -141,38 +141,38 @@ specified type and value. The value is stored in the database without modification. .LP If database contains NULL, -.ZN XrmPutStringResource +.B XrmPutStringResource creates a new database and returns a pointer to it. -.ZN XrmPutStringResource +.B XrmPutStringResource adds a resource with the specified value to the specified database. -.ZN XrmPutStringResource +.B XrmPutStringResource is a convenience function that first calls -.ZN XrmStringToBindingQuarkList +.B XrmStringToBindingQuarkList on the specifier and then calls -.ZN XrmQPutResource , +.BR XrmQPutResource , using a ``String'' representation type. If the specifier is not in the Host Portable Character Encoding, the result is implementation-dependent. The value is stored in the database without modification. .LP If database contains NULL, -.ZN XrmQPutStringResource +.B XrmQPutStringResource creates a new database and returns a pointer to it. -.ZN XrmQPutStringResource +.B XrmQPutStringResource is a convenience routine that constructs an -.ZN XrmValue +.B XrmValue for the value string (by calling -.ZN strlen +.B strlen to compute the size) and then calls -.ZN XrmQPutResource , +.BR XrmQPutResource , using a ``String'' representation type. The value is stored in the database without modification. .LP If database contains NULL, -.ZN XrmPutLineResource +.B XrmPutLineResource creates a new database and returns a pointer to it. -.ZN XrmPutLineResource +.B XrmPutLineResource adds a single resource entry to the specified database. The line should be in valid ResourceLine format (see section 15.1) terminated by a newline or null character; @@ -180,7 +180,7 @@ the database that results from using a string with incorrect syntax is implementation-dependent. The string is parsed in the locale of the database. If the -.ZN ResourceName +.B ResourceName is not in the Host Portable Character Encoding, the result is implementation-dependent. Note that comment lines are not stored. diff --git a/man/XrmUniqueQuark.man b/man/XrmUniqueQuark.man index d69454e9..107e4771 100644 --- a/man/XrmUniqueQuark.man +++ b/man/XrmUniqueQuark.man @@ -136,7 +136,7 @@ Returns the list of quarks. Specifies the string for which a quark or quark list is to be allocated. .SH DESCRIPTION The -.ZN XrmUniqueQuark +.B XrmUniqueQuark function allocates a quark that is guaranteed not to represent any string that is known to the resource manager. .LP @@ -144,18 +144,18 @@ These functions can be used to convert from string to quark representation. If the string is not in the Host Portable Character Encoding, the conversion is implementation-dependent. The string argument to -.ZN XrmStringToQuark +.B XrmStringToQuark need not be permanently allocated storage. -.ZN XrmPermStringToQuark +.B XrmPermStringToQuark is just like -.ZN XrmStringToQuark , +.BR XrmStringToQuark , except that Xlib is permitted to assume the string argument is permanently allocated, and, hence, that it can be used as the value to be returned by -.ZN XrmQuarkToString . +.BR XrmQuarkToString . .LP For any given quark, if -.ZN XrmStringToQuark +.B XrmStringToQuark returns a non-NULL value, all future calls will return the same value (identical address). .LP @@ -164,10 +164,10 @@ The string pointed to by the return value must not be modified or freed. The returned string is byte-for-byte equal to the original string passed to one of the string-to-quark routines. If no string exists for that quark, -.ZN XrmQuarkToString +.B XrmQuarkToString returns NULL. For any given quark, if -.ZN XrmQuarkToString +.B XrmQuarkToString returns a non-NULL value, all future calls will return the same value (identical address). .LP @@ -175,34 +175,34 @@ These functions can be used to convert from string to quark representation. If the string is not in the Host Portable Character Encoding, the conversion is implementation-dependent. The string argument to -.ZN XrmStringToQuark +.B XrmStringToQuark need not be permanently allocated storage. -.ZN XrmPermStringToQuark +.B XrmPermStringToQuark is just like -.ZN XrmStringToQuark , +.BR XrmStringToQuark , except that Xlib is permitted to assume the string argument is permanently allocated, and, hence, that it can be used as the value to be returned by -.ZN XrmQuarkToString . +.BR XrmQuarkToString . .LP For any given quark, if -.ZN XrmStringToQuark +.B XrmStringToQuark returns a non-NULL value, all future calls will return the same value (identical address). .LP The -.ZN XrmStringToQuarkList +.B XrmStringToQuarkList function converts the null-terminated string (generally a fully qualified name) to a list of quarks. The caller must allocate sufficient space for the quarks list before calling -.ZN XrmStringToQuarkList . +.BR XrmStringToQuarkList . Note that the string must be in the valid ResourceName format (see section 15.1). If the string is not in the Host Portable Character Encoding, the conversion is implementation-dependent. .LP A binding list is a list of type -.ZN XrmBindingList +.B XrmBindingList and indicates if components of name or class lists are bound tightly or loosely (that is, if wildcarding of intermediate components is specified). .LP @@ -210,17 +210,17 @@ and indicates if components of name or class lists are bound tightly or loosely typedef enum {XrmBindTightly, XrmBindLoosely} XrmBinding, *XrmBindingList; .EE .LP -.ZN XrmBindTightly +.B XrmBindTightly indicates that a period separates the components, and -.ZN XrmBindLoosely +.B XrmBindLoosely indicates that an asterisk separates the components. .LP The -.ZN XrmStringToBindingQuarkList +.B XrmStringToBindingQuarkList function converts the specified string to a binding list and a quark list. The caller must allocate sufficient space for the quarks list and the binding list before calling -.ZN XrmStringToBindingQuarkList . +.BR XrmStringToBindingQuarkList . If the string is not in the Host Portable Character Encoding the conversion is implementation-dependent. Component names in the list are separated by a period or |