http://www.jwz.org/xscreensaver/xscreensaver-5.13.tar.gz
[xscreensaver] / hacks / qix.man
1 .TH XScreenSaver 1 "27-Apr-97" "X Version 11"
2 .SH NAME
3 qix - bounce colored lines around a window
4 .SH SYNOPSIS
5 .B qix
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-segments \fIint\fP] [\-spread \fIpixels\fP] [\-size \fIpixels\fP] [\-count \fIint\fP] [\-color-shift \fIdegrees\fP] [\-delay \fIusecs\fP] [\-random] [\-linear] [\-solid] [\-hollow] [\-xor] [\-no\-xor] [\-transparent] [\-non\-transparent] [\-additive] [\-subtractive] [\-poly \fIint\fP] [\-gravity] [\-no\-gravity]
7 [\-fps]
8 .SH DESCRIPTION
9 The \fIqix\fP program bounces a series of line segments around its window.
10 This is truly the swiss army chainsaw of qix programs.  If you know of one
11 with more display modes, I want to know about it.
12 .SH OPTIONS
13 .I qix
14 accepts the following options:
15 .TP 8
16 .B \-window
17 Draw on a newly-created window.  This is the default.
18 .TP 8
19 .B \-root
20 Draw on the root window.
21 .TP 8
22 .B \-mono 
23 If on a color display, pretend we're on a monochrome display.
24 .TP 8
25 .B \-install
26 Install a private colormap for the window.
27 .TP 8
28 .B \-visual \fIvisual\fP
29 Specify which visual to use.  Legal values are the name of a visual class,
30 or the id number (decimal or hex) of a specific visual.
31 .TP 8
32 .B \-segments \fIinteger\fP
33 How many line segments should be drawn.  Default 50.
34 .TP 8
35 .B \-spread \fIinteger\fP
36 How far apart the endpoints of one segment should be from the next.
37 Default 8.
38 .TP 8
39 .B \-size \fIinteger\fP
40 The maximum distance one endpoint of a segment is allowed to be from
41 the opposite end of that segment.  Default 0, meaning unlimited.
42 .TP 8
43 .B \-count \fIinteger\fP
44 How many qixes to draw.  Default 1.
45 .TP 8
46 .B \-color\-shift \fIdegrees\fP
47 If on a color display, the color of the line segments will cycle through
48 the spectrum.  This specifies how far the hue of each segment should be
49 from the next, in degrees on the HSV wheel.  Default 3.
50 .TP 8
51 .B \-delay \fImicroseconds\fP
52 How much of a delay should be introduced between steps of the animation.
53 Default 10000, or about 0.01 seconds.
54 .TP 8
55 .B \-random
56 The \fIqix\fP will wander around the screen semi-randomly.  This is the
57 default.
58 .TP 8
59 .B \-linear
60 The opposite of \fI\-random\fP: the \fIqix\fP will travel in straight lines
61 until it reaches a wall, and then it will bounce.
62 .TP 8
63 .B \-solid
64 If this is specified, then the area between the line segments will be filled
65 in with the appropriate color, instead of the \fIqix\fP simply being composed
66 of one-pixel-wide line segments.  This option looks really good in color.
67 .TP 8
68 .B \-hollow
69 The opposite of \fI\-solid\fP; this is the default.
70 .TP 8
71 .B \-xor
72 If this is specified, then qix segments will be drawn and erased with xor,
73 instead of being drawn in some color and erased in the background color.
74 This implies \fI\-mono\fP, in that only two colors can be used.
75 .TP 8
76 .B \-transparent
77 If this is specified, and \fI\-count\fP is greater than 1, then each qix
78 will be drawn in one color, and when they overlap, the colors will be mixed.
79 This looks best in conjunction with \fI\-solid\fP.
80 .TP 8
81 .B \-non\-transparent
82 Turns off \fI\-transparent\fP.
83 .TP 8
84 .B \-additive
85 If \fI\-transparent\fP is specified, then this option means that the colors
86 will be mixed using an additive color model, as if the qixes were projected
87 light.  This is the default.
88 .TP 8
89 .B \-subtractive
90 If \fI\-transparent\fP is specified, then this option means that the
91 colors will be mixed using a subtractive color model, as if the qixes were
92 translucent filters.
93 .TP 8
94 .B \-poly \fIint\fP
95 How many vertices each qix-line should have: the default is 2, meaning the
96 traditional qix line shape.  Three will yield triangles, and so on.
97 .TP 8
98 .B \-gravity
99 .TP 8
100 .B \-no\-gravity
101 Whether there should be downward attraction.  For example, the
102 options
103 .B \-gravity \-linear
104 will make everything move in nice smooth parabolas.
105 Gravity is off by default.
106 .TP 8
107 .B \-fps
108 Display the current frame rate and CPU load.
109 .SH ENVIRONMENT
110 .PP
111 .TP 8
112 .B DISPLAY
113 to get the default host and display number.
114 .TP 8
115 .B XENVIRONMENT
116 to get the name of a resource file that overrides the global resources
117 stored in the RESOURCE_MANAGER property.
118 .SH SEE ALSO
119 .BR X (1),
120 .BR xscreensaver (1)
121 .SH COPYRIGHT
122 Copyright \(co 1992 by Jamie Zawinski.  Permission to use, copy, modify, 
123 distribute, and sell this software and its documentation for any purpose is 
124 hereby granted without fee, provided that the above copyright notice appear 
125 in all copies and that both that copyright notice and this permission notice
126 appear in supporting documentation.  No representations are made about the 
127 suitability of this software for any purpose.  It is provided "as is" without
128 express or implied warranty.
129 .SH AUTHOR
130 Jamie Zawinski <jwz@jwz.org>, 13-aug-92.
131
132 Thanks to Ariel Scolnicov for the \-poly and \-gravity options.