trim trailing whitespace from manpages

Signed-off-by: Thomas E. Dickey's avatarThomas E. Dickey <dickey@invisible-island.net>
parent 4abf482d
......@@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
......@@ -49,34 +49,34 @@
.SH NAME
AllPlanes, BlackPixel, WhitePixel, ConnectionNumber, DefaultColormap, DefaultDepth, XListDepths, DefaultGC, DefaultRootWindow, DefaultScreenOfDisplay, DefaultScreen, DefaultVisual, DisplayCells, DisplayPlanes, DisplayString, XMaxRequestSize, XExtendedMaxRequestSize, LastKnownRequestProcessed, NextRequest, ProtocolVersion, ProtocolRevision, QLength, RootWindow, ScreenCount, ScreenOfDisplay, ServerVendor, VendorRelease \- Display macros and functions
.SH SYNTAX
unsigned long AllPlanes;
unsigned long AllPlanes;
.HP
unsigned long BlackPixel\^(\^Display *\fIdisplay\fP\^, int \^\fIscreen_number\fP\^);
.HP
unsigned long WhitePixel\^(\^Display *\fIdisplay\fP\^, int \^\fIscreen_number\fP\^);
unsigned long WhitePixel\^(\^Display *\fIdisplay\fP\^, int \^\fIscreen_number\fP\^);
.HP
int ConnectionNumber\^(\^Display *\fIdisplay\fP\^);
int ConnectionNumber\^(\^Display *\fIdisplay\fP\^);
.HP
Colormap DefaultColormap\^(\^Display *\fIdisplay\fP\^,
\^int \fIscreen_number\fP\^);
\^int \fIscreen_number\fP\^);
.HP
int DefaultDepth\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
int DefaultDepth\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
.HP
int *XListDepths\^(\^Display *\fIdisplay\fP, int \fIscreen_number\fP, int
\fIcount_return\fP\^);
\fIcount_return\fP\^);
.HP
GC DefaultGC\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
GC DefaultGC\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
.HP
Window DefaultRootWindow\^(\^Display *\fIdisplay\fP\^);
Window DefaultRootWindow\^(\^Display *\fIdisplay\fP\^);
.HP
Screen *DefaultScreenOfDisplay\^(\^Display *\fIdisplay\fP\^);
Screen *DefaultScreenOfDisplay\^(\^Display *\fIdisplay\fP\^);
.HP
int DefaultScreen\^(\^Display *\fIdisplay\fP\^);
int DefaultScreen\^(\^Display *\fIdisplay\fP\^);
.HP
Visual *DefaultVisual\^(\^Display *\fIdisplay\fP\^, \^int
\fIscreen_number\fP\^);
\fIscreen_number\fP\^);
.HP
int DisplayCells\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
int DisplayCells\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
.HP
int DisplayPlanes\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
.HP
......@@ -86,22 +86,22 @@ long XMaxRequestSize(\^Display *\fIdisplay\fP\^)
.HP
long XExtendedMaxRequestSize(\^Display *\fIdisplay\fP\^)
.HP
unsigned long LastKnownRequestProcessed\^(\^Display *\fIdisplay\fP\^);
unsigned long LastKnownRequestProcessed\^(\^Display *\fIdisplay\fP\^);
.HP
unsigned long NextRequest\^(\^Display *\fIdisplay\fP\^);
unsigned long NextRequest\^(\^Display *\fIdisplay\fP\^);
.HP
int ProtocolVersion\^(\^Display *\fIdisplay\fP\^);
int ProtocolVersion\^(\^Display *\fIdisplay\fP\^);
.HP
int ProtocolRevision\^(\^Display *\fIdisplay\fP\^);
int ProtocolRevision\^(\^Display *\fIdisplay\fP\^);
.HP
int QLength\^(\^Display *\fIdisplay\fP\^);
int QLength\^(\^Display *\fIdisplay\fP\^);
.HP
Window RootWindow\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
Window RootWindow\^(\^Display *\fIdisplay\fP\^, \^int \fIscreen_number\fP\^);
.HP
int ScreenCount\^(\^Display *\fIdisplay\fP\^);
int ScreenCount\^(\^Display *\fIdisplay\fP\^);
.HP
Screen *ScreenOfDisplay\^(\^Display *\fIdisplay\fP, int
\fIscreen_number\fP\^);
\fIscreen_number\fP\^);
.HP
char *ServerVendor\^(\^Display *\fIdisplay\fP\^)
.HP
......@@ -116,7 +116,7 @@ Returns the number of depths.
.SH DESCRIPTION
The
.B AllPlanes
macro returns a value with all bits set to 1 suitable for use in a plane
macro returns a value with all bits set to 1 suitable for use in a plane
argument to a procedure.
.LP
The
......@@ -142,7 +142,7 @@ specified screen.
.LP
The
.B XListDepths
function returns the array of depths
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,
......@@ -204,7 +204,7 @@ as necessary for the following functions:
.BR XDrawSegments ,
.BR XFillArcs ,
.BR XFillRectangles ,
and
and
.BR XPutImage .
.LP
The
......@@ -222,7 +222,8 @@ The Xlib functions
and
.B XSetRegion
will use the extended-length encoding as necessary, if supported
by the server. Use of the extended-length encoding in other Xlib
by the server.
Use of the extended-length encoding in other Xlib
functions (for example,
.BR XDrawPoints ,
.BR XDrawRectangles ,
......
......@@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
......@@ -91,7 +91,7 @@ int WidthOfScreen\^(\^Screen *\fIscreen\fP\^);
int WidthMMOfScreen\^(\^Screen *\fIscreen\fP\^);
.SH ARGUMENTS
.IP \fIscreen\fP 1i
Specifies the appropriate
Specifies the appropriate
.B Screen
structure.
.SH DESCRIPTION
......@@ -127,7 +127,7 @@ macro returns the default visual of the specified screen.
.LP
The
.B DoesBackingStore
macro returns
macro returns
.BR WhenMapped ,
.BR NotUseful ,
or
......@@ -162,12 +162,12 @@ macro returns the height of the specified screen in millimeters.
.LP
The
.B MaxCmapsOfScreen
macro returns the maximum number of installed colormaps supported
macro returns the maximum number of installed colormaps supported
by the specified screen.
.LP
The
.B MinCmapsOfScreen
macro returns the minimum number of installed colormaps supported
macro returns the minimum number of installed colormaps supported
by the specified screen.
.LP
The
......
......@@ -46,8 +46,10 @@ file from the list in
.PP
Compose files can use an
.RB \*q include \*q
instruction. This allows local modifications to be made to existing compose
files without including all of the content directly. For example, the
instruction.
This allows local modifications to be made to existing compose
files without including all of the content directly.
For example, the
system's iso8859-1 compose file can be included with a line like this:
.RS 4
.BI "include \*q" %S/iso8859-1/Compose \*q
......@@ -74,12 +76,15 @@ by using:
.RS
.B "include \*q%L\*q"
.RE
and then rewrite only the few rules that you need to change. New
and then rewrite only the few rules that you need to change.
New
compose rules can be added, and previous ones replaced.
.SH FILE FORMAT
.\" Based on grammar description in modules/im/ximcp/imLcPrs.c
Compose files are plain text files, with a separate line for each compose
sequence. Comments begin with \fB#\fP characters. Each compose sequence
sequence.
Comments begin with \fB#\fP characters.
Each compose sequence
specifies one or more events and a resulting input sequence, with an optional
comment at the end of the line:
.RS
......@@ -97,7 +102,8 @@ it must match exactly.
MODIFIER may be one of Ctrl, Lock, Caps, Shift, Alt or Meta.
Each modifier may be preceded by a
.RB \*q "~" \*q
character to indicate that the modifier must not be present. If
character to indicate that the modifier must not be present.
If
.RB \*q "None" \*q
is specified, no modifier may be present.
.PP
......@@ -110,18 +116,21 @@ as input when the sequence of events is input:
Keysyms are specified without the \fBXK_\fP prefix.
.PP
Strings may be direct text encoded in the locale for which the compose file is
to be used, or an escaped octal or hexadecimal character code. Octal codes
to be used, or an escaped octal or hexadecimal character code.
Octal codes
are specified as \fB\*q\\123\*q\fP and hexadecimal codes as
\fB\*q\\x3a\*q\fP.
It is not necessary to specify in the right part of a rule a locale encoded
string in addition to the keysym name. If the string is omitted, Xlib
string in addition to the keysym name.
If the string is omitted, Xlib
figures it out from the keysym according to the current locale.
I.e., if a rule looks like:
.RS
\fB<dead_grave> <A> : \*q\\300\*q Agrave\fP
.RE
the result of the composition is always the letter with the "\\300"
code. But if the rule is:
code.
But if the rule is:
.RS
\fB<dead_grave> <A> : Agrave\fP
.RE
......
......@@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
......@@ -50,15 +50,15 @@
DisplayOfCCC, VisualOfCCC, ScreenNumberOfCCC, ScreenWhitePointOfCCC, ClientWhitePointOfCCC \- Color Conversion Context macros
.SH SYNTAX
.HP
Display *DisplayOfCCC\^(\^XcmsCCC \fIccc\fP\^);
Display *DisplayOfCCC\^(\^XcmsCCC \fIccc\fP\^);
.HP
Visual *VisualOfCCC\^(\^XcmsCCC \fIccc\fP\^);
Visual *VisualOfCCC\^(\^XcmsCCC \fIccc\fP\^);
.HP
int ScreenNumberOfCCC\^(\^XcmsCCC \fIccc\fP\^);
int ScreenNumberOfCCC\^(\^XcmsCCC \fIccc\fP\^);
.HP
XcmsColor *ScreenWhitePointOfCCC\^(\^XcmsCCC \fIccc\fP\^);
XcmsColor *ScreenWhitePointOfCCC\^(\^XcmsCCC \fIccc\fP\^);
.HP
XcmsColor *ClientWhitePointOfCCC\^(\^XcmsCCC \fIccc\fP\^);
XcmsColor *ClientWhitePointOfCCC\^(\^XcmsCCC \fIccc\fP\^);
.SH ARGUMENTS
.IP \fIccc\fP 1i
Specifies the CCC.
......
......@@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
......@@ -96,7 +96,7 @@ XY format (bitmap) or for each pixel value in Z format.
.LP
The
.B BitmapBitOrder
macro returns
macro returns
.B LSBFirst
or
.B MSBFirst
......
......@@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
......@@ -68,13 +68,13 @@ Specifies the KeySym that is to be tested.
.SH DESCRIPTION
The
.B IsCursorKey
macro returns
macro returns
.B True
if the specified KeySym is a cursor key.
.LP
The
.B IsFunctionKey
macro returns
macro returns
.B True
if the KeySym is a function key.
.LP
......
......@@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
......@@ -52,18 +52,18 @@ XAddConnectionWatch, XRemoveConnectionWatch, XProcessInternalConnection, XIntern
.HP
typedef void (*XConnectionWatchProc)\^(\^Display *\fIdisplay\fP\^, XPointer
\fIclient_data\fP\^, int \fIfd\fP\^, Bool \fIopening\fP\^, XPointer
*\fIwatch_data\fP\^);
*\fIwatch_data\fP\^);
.HP
Status XAddConnectionWatch\^(\^Display *\fIdisplay\fP\^, XWatchProc
\fIprocedure\fP\^, XPointer \fIclient_data\fP\^);
\fIprocedure\fP\^, XPointer \fIclient_data\fP\^);
.HP
Status XRemoveConnectionWatch\^(\^Display *\fIdisplay\fP\^, XWatchProc
\fIprocedure\fP\^, XPointer \fIclient_data\fP\^);
\fIprocedure\fP\^, XPointer \fIclient_data\fP\^);
.HP
void XProcessInternalConnection\^(\^Display *\fIdisplay\fP\^, int \fIfd\fP\^);
.HP
Status XInternalConnectionNumbers\^(\^Display *\fIdisplay\fP\^, int
**\fIfd_return\fP\^, int *\fIcount_return\fP\^);
**\fIfd_return\fP\^, int *\fIcount_return\fP\^);
.SH ARGUMENTS
.IP \fIclient_data\fP 1i
Specifies the additional client data.
......
.\" Copyright \(co 1985, 1986, 1987, 1988, 1989, 1990, 1991, 1994, 1996 X Consortium
.\"
.\" All rights reserved.
.\"
.\"
.\" Permission is hereby granted, free of charge, to any person obtaining a
.\" copy of this software and associated documentation files (the
.\" "Software"), to deal in the Software without restriction, including
......@@ -11,7 +11,7 @@
.\" copyright notice(s) and this permission notice appear in all copies of
.\" the Software and that both the above copyright notice(s) and this
.\" permission notice appear in supporting documentation.
.\"
.\"
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT
......@@ -21,12 +21,12 @@
.\" FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT,
.\" NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION
.\" WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
.\"
.\"
.\" Except as contained in this notice, the name of a copyright holder
.\" shall not be used in advertising or otherwise to promote the sale, use
.\" or other dealings in this Software without prior written authorization
.\" of the copyright holder.
.\"
.\"
.\" X Window System is a trademark of The Open Group.
.\"
.\" Copyright 2004 Oracle and/or its affiliates. All rights reserved.
......@@ -65,7 +65,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
......@@ -76,9 +76,9 @@
XAddHost, XAddHosts, XListHosts, XRemoveHost, XRemoveHosts, XSetAccessControl, XEnableAccessControl, XDisableAccessControl, XHostAddress, XServerInterpretedAddress \- control host access and host control structure
.SH SYNTAX
.HP
int XAddHost\^(\^Display *\fIdisplay\fP, XHostAddress *\fIhost\fP\^);
int XAddHost\^(\^Display *\fIdisplay\fP, XHostAddress *\fIhost\fP\^);
.HP
int XAddHosts\^(\^Display *\fIdisplay\fP, XHostAddress *\fIhosts\fP,
int XAddHosts\^(\^Display *\fIdisplay\fP, XHostAddress *\fIhosts\fP,
int \fInum_hosts\fP\^);
.HP
XHostAddress *XListHosts\^(\^Display *\fIdisplay\fP, int *\fInhosts_return\fP,
......@@ -143,19 +143,19 @@ errors.
.LP
The
.B XListHosts
function returns the current access control list as well as whether the use
function returns the current access control list as well as whether the use
of the list at connection setup was enabled or disabled.
.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.
were allocated by the function.
When no longer needed,
this memory should be freed by calling
.BR XFree .
.LP
The
.B XRemoveHost
function removes the specified host from the access control list
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
.B BadAccess
......@@ -173,12 +173,12 @@ errors.
.LP
The
.B XRemoveHosts
function removes each specified host from the access control list for that
display.
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
.B BadAccess
error results.
If you remove your machine from the access list,
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
......@@ -191,7 +191,7 @@ errors.
.LP
The
.B XSetAccessControl
function either enables or disables the use of the access control list
function either enables or disables the use of the access control list
at each connection setup.
.LP
.B XSetAccessControl
......@@ -231,7 +231,7 @@ typedef struct {
} XHostAddress;
.EE
.LP
The family member specifies which protocol address family to use
The family member specifies which protocol address family to use
(for example, TCP/IP or DECnet) and can be
.BR FamilyInternet ,
.BR FamilyInternet6 ,
......@@ -242,8 +242,8 @@ or
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
For the ServerInterpreted family, the length is ignored and the address
member is a pointer to a
.B XServerInterpretedAddress
structure which contains:
.LP
......
......@@ -39,7 +39,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
......@@ -63,7 +63,7 @@ Specifies the
.B XClassHint
structure that is to be used.
.IP \fIclass_hints_return\fP 1i
Returns the
Returns the
.B XClassHint
structure.
.IP \fIw\fP 1i
......@@ -77,7 +77,7 @@ structure.
Note that the pointer fields in the
.B XClassHint
structure are initially set to NULL.
If insufficient memory is available,
If insufficient memory is available,
.B XAllocClassHint
returns NULL.
To free the memory allocated to this structure,
......@@ -132,15 +132,15 @@ typedef struct {
char *res_class;
} XClassHint;
.LP
The res_name member contains the application name,
and the res_class member contains the application class.
The res_name member contains the application name,
and the res_class member contains the application class.
Note that the name set in this property may differ from the name set as WM_NAME.
That is, WM_NAME specifies what should be displayed in the title bar and,
therefore, can contain temporal information (for example, the name of
a file currently in an editor's buffer).
On the other hand,
On the other hand,
the name specified as part of WM_CLASS is the formal name of the application
that should be used when retrieving the application's resources from the
that should be used when retrieving the application's resources from the
resource database.
.SH DIAGNOSTICS
.TP 1i
......
......@@ -40,7 +40,7 @@
.\" Digital and Tektronix makes no representations about the suitability
.\" of this documentation for any purpose.
.\" It is provided "as is" without express or implied warranty.
.\"
.\"
.\"
.ds xT X Toolkit Intrinsics \- C Language Interface
.ds xW Athena X Widgets \- C Language X Toolkit Interface
......@@ -73,7 +73,7 @@ unsigned long *\fIgmask_return\fP\^, unsigned long *\fIbmask_return\fP\^);
int XFreeColors\^(\^Display *\fIdisplay\fP, Colormap \fIcolormap\fP\^, unsigned
long \fIpixels\fP\^[\^], int \fInpixels\fP\^, unsigned long \fIplanes\fP\^);
.IP \fIcolor_name\fP 1i
Specifies the color name string (for example, red) whose color
Specifies the color name string (for example, red) whose color
definition structure you want returned.
.IP \fIcolormap\fP 1i
Specifies the colormap.
......@@ -84,13 +84,13 @@ Specifies the connection to the X server.
.IP \fIexact_def_return\fP 1i
Returns the exact RGB values.
.IP \fIncolors\fP 1i
Specifies the number of pixel values that are to be returned in the
pixels_return array.
Specifies the number of pixel values that are to be returned in the
pixels_return array.
.IP \fInpixels\fP 1i
Specifies the number of pixels.
Specifies the number of pixels.
.IP \fInplanes\fP 1i
Specifies the number of plane masks that are to be returned in the plane masks
array.
Specifies the number of plane masks that are to be returned in the plane masks
array.
.IP \fInreds\fP 1i
.br
.ns
......@@ -101,11 +101,11 @@ array.
.br
.ns
Specify the number of red, green, and blue planes.
The value you pass must be nonnegative.
The value you pass must be nonnegative.
.IP \fIpixels\fP 1i
Specifies an array of pixel values.
Specifies an array of pixel values.
.IP \fIpixels_return\fP 1i
Returns an array of pixel values.
Returns an array of pixel values.
.IP \fIplane_mask_return\fP 1i
Returns an array of plane masks.
.\" *** JIM: NEED MORE INFO FOR THIS. ***
......@@ -161,7 +161,7 @@ It returns both the exact database definition and
the closest color supported by the screen.
The allocated color cell is read-only.
The pixel value is returned in screen_def_return.
If the color name is not in the Host Portable Character Encoding,
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 screen_def_return and exact_def_return
......@@ -186,7 +186,7 @@ The number of colors must be positive and the number of planes nonnegative,
or a
.B BadValue
error results.
If ncolors and nplanes are requested,
If ncolors and nplanes are requested,
then ncolors pixels
and nplane plane masks are returned.
No mask will have any bits set to 1 in common with
......@@ -195,23 +195,23 @@ By ORing together each pixel with zero or more masks,
ncolors * %2 sup nplanes% distinct pixels can be produced.
All of these are
allocated writable by the request.
For
For
.B GrayScale
or
or
.BR PseudoColor ,
each mask has exactly one bit set to 1.
For
each mask has exactly one bit set to 1.
For
.BR DirectColor ,
each has exactly three bits set to 1.
If contig is
If contig is
.B True
and if all masks are ORed
together, a single contiguous set of bits set to 1 will be formed for
together, a single contiguous set of bits set to 1 will be formed for
.B GrayScale
or
or
.B PseudoColor
and three contiguous sets of bits set to 1 (one within each
pixel subfield) for
pixel subfield) for
.BR DirectColor .
The RGB values of the allocated
entries are undefined.
......@@ -228,41 +228,41 @@ errors.
.EQ
delim %%
.EN
The specified ncolors must be positive;
The specified ncolors must be positive;
and nreds, ngreens, and nblues must be nonnegative,
or a
.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
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
If contig is
.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
For
.BR DirectColor ,
each mask
will lie within the corresponding pixel subfield.
By ORing together
subsets of masks with each pixel value,
ncolors * %2 sup (nreds+ngreens+nblues)% distinct pixel values can be produced.
subsets of masks with each pixel value,
ncolors * %2 sup (nreds+ngreens+nblues)% distinct pixel values can be produced.
All of these are allocated by the request.
However, in the
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
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
.BR PseudoColor .
When the colormap entry of a pixel
value is changed (using
value is changed (using
.BR XStoreColors ,
.BR XStoreColor ,
or
or
.BR XStoreNamedColor ),
the pixel is decomposed according to the masks,
the pixel is decomposed according to the masks,
and the corresponding independent entries are updated.
.B XAllocColorPlanes
returns nonzero if it succeeded or zero if it failed.
......@@ -279,11 +279,11 @@ The
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
pixels.
pixels.
The set of all pixels is produced by ORing together subsets of
the planes argument with the pixels.
The request frees all of these pixels that
were allocated by the client (using
were allocated by the client (using
.IN XAllocColor
.IN XAllocNamedColor
.IN XAllocColorCells
......@@ -291,10 +291,10 @@ were allocated by the client (using
.BR XAllocColor ,
.BR XAllocNamedColor ,
.BR XAllocColorCells ,
and
and
.BR XAllocColorPlanes ).
Note that freeing an
individual pixel obtained from
individual pixel obtained from
.B XAllocColorPlanes
may not actually allow
it to be reused until all of its related pixels are also freed.
......@@ -304,8 +304,8 @@ and if a client allocates the same read-only entry multiple times,
it must free the entry that many times before the entry is actually freed.
.LP
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
freed, even if one or more pixels produce an error.
If a specified pixel is not a valid index into the colormap, a
.B BadValue
error results.
If a specified pixel is not allocated by the
......@@ -316,8 +316,8 @@ to
.BR XCreateColormap ),
a
.B BadAccess
error results.
If more than one pixel is in error,
error results.
If more than one pixel is in error,
the one that gets reported is arbitrary.
.LP
.B XFreeColors
......@@ -346,8 +346,8 @@ 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.