Commit 4eb167f5 authored by Walter Harms's avatar Walter Harms

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's avatarWalter Harms <wharms@bfs.de>
parent 08e6b362
......@@ -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__),
......
......@@ -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__),
......
......@@ -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"
......
......@@ -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:
......
......@@ -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__),
......
......@@ -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"
......
......@@ -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