Add man pages for TOG-CUP extension functions. (Converted to man page

    format by Sun based on TOG-CUP specification docs.)

3 files changed, 247 insertions, 0 deletions

diff --git a/man/XcupGetReservedColormapEntries.man b/man/XcupGetReservedColormapEntries.man
new file mode 100644
index 0000000..4f624d3
--- /dev/null
+++ b/man/XcupGetReservedColormapEntries.man
@@ -0,0 +1,80 @@
+.\" $XdotOrg: $
+.\" 
+.\" Copyright \(co 1986-1997   The Open Group    All Rights Reserved
+.\" Copyright 1999, 2005 Sun Microsystems, Inc.  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 without limitation
+.\" the rights to use, copy, modify, merge, publish, distribute,
+.\" sublicense, and/or sell copies of the Software, and to permit persons
+.\" to whom the Software is furnished to do so, subject to the following
+.\" conditions:
+.\"
+.\" The above copyright notice and this permission notice shall be
+.\" included in all copies or substantial portions of the Software.
+.\"
+.\" 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.
+.\" IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
+.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+.\"
+.\" Except as contained in this notice, the names of the copyright holders
+.\" shall not be used in advertising or otherwise to promote the sale, use
+.\" or other dealings in this Software without prior written authorization
+.\" from said copyright holders.
+.\" 
+.\" X Window System is a trademark of The Open Group.
+.\" 
+.de ZN
+.ie t \fB\^\\$1\^\fR\\$2
+.el \fI\^\\$1\^\fP\\$2
+..
+.TH XCUP 3Xext __xorgversion__ "X FUNCTIONS"
+.SH NAME
+XcupGetReservedColormapEntries \- list colormap entries reserved by the system
+.SH SYNOPSIS
+.PP
+.nf
+\fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ]
+\&#include <X11/extensions/Xcup.h>
+.HP
+Status \fBXcupGetReservedColormapEntries\fP\^(\^Display *\fIdisplay\fP\^, 
+int \fIscreen\fP\^, XColor **\fIcolors_out\fP\^, int *\fIncolors\fP\^);
+.if n .ti +5n
+.if t .ti +.5i
+.SH ARGUMENTS
+.IP \fIdisplay\fP 1i
+Specifies the connection to the X server.
+.IP \fIscreen\fP 1i
+Screen number on the host server.
+.IP \fIcolors_out\fP 1i
+Returns the values reserved by the server.
+.IP \fIncolors\fP 1i
+Returns the number of items in \fIcolors_out\fP.
+.SH DESCRIPTION
+.LP
+The 
+.ZN XcupGetReservedColormapEntries 
+function returns a list of colormap entries (pixels) that are reserved
+by the system. This list will, at a minimum, contain entries for the 
+BlackPixel and WhitePixel of the specified screen. Use 
+.ZN XFree 
+to free 
+.I colors_out.
+.LP
+To minimize colormap flash, an application which installs its own private
+colormap should query the special colors by calling
+.ZN XCupGetReservedColormapEntries , 
+and can then store those entries (in the
+proper location) in its private colormap using 
+.ZN XCupStoreColors .
+.SH "SEE ALSO"
+.BR XcupQueryVersion (3Xext),
+.BR XcupStoreColors (3Xext),
+.BR XFree (3X11),
+.br
+\fIColormap Utilization Policy and Extension\fP
diff --git a/man/XcupQueryVersion.man b/man/XcupQueryVersion.man
new file mode 100644
index 0000000..3a20974
--- /dev/null
+++ b/man/XcupQueryVersion.man
@@ -0,0 +1,81 @@
+.\" $XdotOrg: $
+.\" 
+.\" Copyright \(co 1986-1997   The Open Group    All Rights Reserved
+.\" Copyright 1999, 2005 Sun Microsystems, Inc.  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 without limitation
+.\" the rights to use, copy, modify, merge, publish, distribute,
+.\" sublicense, and/or sell copies of the Software, and to permit persons
+.\" to whom the Software is furnished to do so, subject to the following
+.\" conditions:
+.\"
+.\" The above copyright notice and this permission notice shall be
+.\" included in all copies or substantial portions of the Software.
+.\"
+.\" 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.
+.\" IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
+.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+.\"
+.\" Except as contained in this notice, the names of the copyright holders
+.\" shall not be used in advertising or otherwise to promote the sale, use
+.\" or other dealings in this Software without prior written authorization
+.\" from said copyright holders.
+.\"
+.\" X Window System is a trademark of The Open Group.
+.\" 
+.de ZN
+.ie t \fB\^\\$1\^\fR\\$2
+.el \fI\^\\$1\^\fP\\$2
+..
+.TH XcupQueryVersion 3Xext __xorgversion__ "X FUNCTIONS"
+.SH NAME
+XcupQueryVersion \- Returns TOG-CUP protocol version supported by the X server
+.SH SYNOPSIS
+.PP
+.nf
+\fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ]
+\&#include <X11/extensions/Xcup.h>
+.HP
+Status \fBXcupQueryVersion\fP\^(\^Display *\fIdisplay\fP\^, 
+int *\fImajor_version_return\fP\^, int *\fIminor_version_return\fP\^);
+.if n .ti +5n
+.if t .ti +.5i
+.SH ARGUMENTS
+.IP \fIdisplay\fP 1i
+Specifies the connection to the X server
+.IP \fImajor_version_return\fP 1i
+Returns the major version supported by the server
+.IP \fIminor_version_return\fP 1i
+Returns the minor version supported by the server
+.SH DESCRIPTION
+.LP
+.ZN XcupQueryVersion 
+sets 
+.I major_version_return 
+and 
+.I minor_version_return 
+to the major and minor TOG-CUP protocol version supported by the
+server. If the TOG-CUP library is compatible with the version returned
+by the server, it returns nonzero. If the server does not support the TOG-CUP
+extension, or if there was an error during communications with the
+server, or if the server and library protocol versions are
+incompatible, it returns zero. No other Xcup functions may be called
+before this function. If a client violates this rule, the effects of
+all subsequent Xcup calls that it makes are undefined.
+.LP
+To get the list of reserved colormap entries, use 
+.ZN XcupGetReservedColormapEntries.
+.LP
+To allocate one or more read-only color cells with RGB values, use 
+.ZN XcupStoreColors.
+.SH "SEE ALSO"
+.BR XcupGetReservedColormapEntries (3Xext),
+.BR XcupStoreColors (3Xext),
+.br
+\fIColormap Utilization Policy and Extension\fP
diff --git a/man/XcupStoreColors.man b/man/XcupStoreColors.man
new file mode 100644
index 0000000..c9acd3e
--- /dev/null
+++ b/man/XcupStoreColors.man
@@ -0,0 +1,86 @@
+.\" $XdotOrg: $
+.\" 
+.\" Copyright \(co 1986-1997   The Open Group    All Rights Reserved
+.\" Copyright 1999, 2005 Sun Microsystems, Inc.  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 without limitation
+.\" the rights to use, copy, modify, merge, publish, distribute,
+.\" sublicense, and/or sell copies of the Software, and to permit persons
+.\" to whom the Software is furnished to do so, subject to the following
+.\" conditions:
+.\"
+.\" The above copyright notice and this permission notice shall be
+.\" included in all copies or substantial portions of the Software.
+.\"
+.\" 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.
+.\" IN NO EVENT SHALL THE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,
+.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR
+.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR
+.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+.\"
+.\" Except as contained in this notice, the names of the copyright holders
+.\" shall not be used in advertising or otherwise to promote the sale, use
+.\" or other dealings in this Software without prior written authorization
+.\" from said copyright holders.
+.\" 
+.\" X Window System is a trademark of The Open Group.
+.\" 
+.de ZN
+.ie t \fB\^\\$1\^\fR\\$2
+.el \fI\^\\$1\^\fP\\$2
+..
+.TH XcupStoreColors 3Xext __xorgversion__ "X FUNCTIONS"
+.SH NAME
+XcupStoreColors \- initialize shareable colormap entries at specific locations
+.SH SYNOPSIS
+.PP
+.nf
+\fBcc\fR [ \fIflag\fR \&.\&.\&. ] \fIfile\fR \&.\&.\&. -\fBlXext\fR [ \fIlibrary\fR \&.\&.\&. ]
+\&#include <X11/extensions/Xcup.h>
+.HP
+Status \fBXcupStoreColors\fP\^(\^Display *\fIdisplay\fP\^, Colormap \fIcolormap\fP\^,
+XColor *\fIcolors_in_out\fP\^, int \fIncolors\fP\^);
+.if n .ti +5n
+.if t .ti +.5i
+.SH ARGUMENTS
+.IP \fIdisplay\fP 1i
+Specifies the connection to the X server
+.IP \fIcolormap\fP 1i
+Specifies the colormap
+.IP \fIcolors_in_out\fP 1i
+Specifies and returns the values actually used in the colormap
+.IP \fIncolors\fP 1i
+Specifies the number of items in colors_in_out
+.SH DESCRIPTION
+.LP
+The 
+.ZN XcupStoreColors 
+function changes the colormap entries of the pixel values in the pixel
+members of the XColor structures. The colormap entries are allocated
+as if an AllocColor has been used instead, i.e. the colors are
+read-only (shareable).
+.ZN XcupStoreColors 
+returns the number of colors that were successfully allocated in the colormap.
+.LP
+A 
+.ZN Value 
+error is generated if a pixel is not a valid index into the colormap. A
+.ZN BadMatch 
+error is generated if the colormap does not belong to a GrayScale,
+PseudoColor, or DirectColor visual.
+.LP
+Applications which allocate many colors in a screen's default colormap, e.g.
+a color-cube or a gray-ramp, should allocate them with 
+.ZN XCupStoreColors .
+By using XCupStoreColors the colors will be allocated sharable (read-only) 
+and any other application which allocates the same color will share that 
+color cell.
+.SH "SEE ALSO"
+.BR XcupQueryVersion (3Xext),
+.BR XcupGetReservedColormapEntries (3Xext),
+.br
+\fIColormap Utilization Policy and Extension\fP