summaryrefslogtreecommitdiff
path: root/xgc.man
diff options
context:
space:
mode:
authorAlan Coopersmith <alan.coopersmith@sun.com>2009-11-10 22:21:23 -0800
committerAlan Coopersmith <alan.coopersmith@sun.com>2009-11-10 22:21:28 -0800
commit90877de1d293d9f0ec47e588a518327b43536c6e (patch)
tree0c55b0465acb8fa284e193bbb04cc517fea69199 /xgc.man
parentd1abdda8c4e84b7df4927260753a8f47d027c6be (diff)
Include more detailed xgc man page description from Solaris
Signed-off-by: Alan Coopersmith <alan.coopersmith@sun.com>
Diffstat (limited to 'xgc.man')
-rw-r--r--xgc.man134
1 files changed, 130 insertions, 4 deletions
diff --git a/xgc.man b/xgc.man
index 7a188ba..7a3b4f3 100644
--- a/xgc.man
+++ b/xgc.man
@@ -1,6 +1,55 @@
-.\" $XConsortium: xgc.man,v 1.6 94/04/17 20:45:31 gildea Exp $
+.\" Copyright (c) 1991 X Consortium
.\"
-.\" $XFree86$
+.\" 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 X CONSORTIUM 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 name of the X Consortium shall
+.\" not be used in advertising or otherwise to promote the sale, use or
+.\" other dealings in this Software without prior written authorization
+.\" from the X Consortium.
+.\"
+.\" Copyright 2009 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, and/or sell copies of the Software, and to permit persons
+.\" to whom the Software is furnished to do so, provided that the above
+.\" 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
+.\" OF THIRD PARTY RIGHTS. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR
+.\" HOLDERS INCLUDED IN THIS NOTICE BE LIABLE FOR ANY CLAIM, OR ANY SPECIAL
+.\" INDIRECT OR CONSEQUENTIAL DAMAGES, OR ANY DAMAGES WHATSOEVER RESULTING
+.\" 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.
.\"
.TH XGC 1 __xorgversion__
.SH NAME
@@ -12,8 +61,85 @@ xgc - X graphics demo
The
.I xgc
program demonstrates various features of the X graphics primitives.
-Try the buttons, see what they do; we haven't the time to document
-them, perhaps you do?
+In X, most of the details about the graphics to be generated are
+stored in a resource called a graphics context (GC). The
+.B xgc
+program provides a user interface for setting various GC components.
+Pressing the "Run" button causes these results to be displayed in
+the large drawing window on the right. Timing information is
+displayed in the window immediately below.
+.PP
+The items in the upper left hand window work as follows:
+.PP
+.I Function
+\- specify the logical function with which primitives
+will drawn. The most usual setting is "set", i.e. simply to render
+pixels without regard to what has been drawn before.
+.PP
+.I LineStyle
+\- specify whether lines should be drawn solid in foreground,
+dashed in foreground or alternating foreground and background.
+.PP
+.I CapStyle
+\- specify the appearance of the ends of a line.
+.PP
+.I JoinStyle
+\- specify the appearance of joints between consecutive
+lines drawn within a single graphics primitive.
+.PP
+.I FillStyle
+\- specify whether lines, text and fill requests are
+solid, tiled with a pixmap or stippled.
+.PP
+.I FillRule
+\- specifies the rule used to fill polygons. The EvenOdd
+rule means that if areas overlap an odd number of times, they are not
+drawn. Winding rule means that overlapping areas are always filled,
+regardless of how many times they overlap.
+.PP
+.I ArcMode
+\- specifies the rule for filling of arcs. The boundary
+of the arc is either a Chord or two radii.
+.PP
+.I planemask
+\- specifies which planes of the drawing window are
+modified. By default, all planes are modified.
+.PP
+.I dashlist
+\- specifies a pattern to be used when drawing dashed lines.
+.PP
+.I Line Width
+\- specifies the width in pixels of lines to be drawn.
+Zero means to draw using the server's fastest algorithm with a line width of
+one pixel.
+.PP
+.I Font
+\- specifies the font to be used for text primitives.
+.PP
+.I Foreground
+and
+.I Background
+\- specify the pixel values to be
+applied when drawing primitives.
+The Foreground value is used as the
+pixel value for set bits in the source in all primitives.
+The Background value is used as the
+pixel value for unset bits in the source when using Copy Plane, drawing
+lines with LineStyle of DoubleDash and filling with FillStyle of
+OpaqueStippled.
+.PP
+.I Percentage of Test
+\- scrollbar permits specifying only
+a percentage of the test to be run. The number at the left indicates
+the current setting, which defaults to 100%.
+.sp
+The window labeled "Test" permits choice of one a number of graphics
+primitive tests, including Points, Segments, Lines, Arcs and Filled Arcs,
+8-bit Text and Image Text, Rectangles and Filled Rectangles, Image draws,
+as well as Copy Plane and Copy Area.
+.PP
+The window to the right of this has buttons which permit record/playback
+of the primitives rendered.
.SH OPTIONS
.I Xgc
accepts all of the standard X Toolkit command line options.