ftp://ftp.ntnu.no/old/pub/X11/R5contrib/xscreensaver-1.17.tar.gz
[xscreensaver] / hacks / qix.man
1 .TH XScreenSaver 1 "9-dec-92" "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] [\-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]
7 .SH DESCRIPTION
8 The \fIqix\fP program bounces a series of line segments around its window.
9 This is truly the swiss army chainsaw of qix programs.  If you know of one
10 with more display modes, I want to know about it.
11 .SH OPTIONS
12 .I qix
13 accepts the following options:
14 .TP 8
15 .B \-window
16 Draw on a newly-created window.  This is the default.
17 .TP 8
18 .B \-root
19 Draw on the root window.
20 .TP 8
21 .B \-mono 
22 If on a color display, pretend we're on a monochrome display.
23 .TP 8
24 .B \-segments integer
25 How many line segments should be drawn.  Default 50.
26 .TP 8
27 .B \-spread integer
28 How far apart the endpoints of one segment should be from the next.
29 Default 8.
30 .TP 8
31 .B \-size integer
32 The maximum distance one endpoint of a segment is allowed to be from
33 the opposite end of that segment.  Default 0, meaning unlimited.
34 .TP 8
35 .B \-count integer
36 How many qixes to draw.  Default 1.
37 .TP 8
38 .B \-color\-shift degrees
39 If on a color display, the color of the line segments will cycle through
40 the spectrum.  This specifies how far the hue of each segment should be
41 from the next, in degrees on the HSV wheel.  Default 3.
42 .TP 8
43 .B \-delay microseconds
44 How much of a delay should be introduced between steps of the animation.
45 Default 25000, or about 0.025 seconds.
46 .TP 8
47 .B \-random
48 The \fIqix\fP will wander around the screen semi-randomly.  This is the
49 default.
50 .TP 8
51 .B \-linear
52 The opposite of \fI\-random\fP: the \fIqix\fP will travel in straight lines
53 until it reaches a wall, and then it will bounce.
54 .TP 8
55 .B \-solid
56 If this is specified, then the area between the line segments will be filled
57 in with the appropriate color, instead of the \fIqix\fP simply being composed
58 of one-pixel-wide line segments.  This option looks really good in color.
59 .TP 8
60 .B \-hollow
61 The opposite of \fI\-solid\fP; this is the default.
62 .TP 8
63 .B \-xor
64 If this is specified, then qix segments will be drawn and erased with xor,
65 instead of being drawn in some color and erased in the background color.
66 This implies \fI\-mono\fP, in that only two colors can be used.
67 .TP 8
68 .B \-transparent
69 If this is specified, and \fI\-count\fP is greater than 1, then each qix
70 will be drawn in one color, and when they overlap, the colors will be mixed.
71 This only works on \fBPseudoColor\fP displays.  This looks best in
72 conjuction with \fI\-solid\fP.
73 .TP 8
74 .B \-non\-transparent
75 Turns off \fI\-transparent\fP.
76 .TP 8
77 .B \-additive
78 If \fI\-transparent\fP is specified, then this option means that the colors
79 will be mixed using an additive color model, as if the qixes were projected
80 light.  This is the default.
81 .TP 8
82 .B \-subtractive
83 If \fI\-transparent\fP is specified, then this option means that the
84 colors will be mixed using a subtractive color model, as if the qixes were
85 translucent filters.
86 .SH ENVIRONMENT
87 .PP
88 .TP 8
89 .B DISPLAY
90 to get the default host and display number.
91 .TP 8
92 .B XENVIRONMENT
93 to get the name of a resource file that overrides the global resources
94 stored in the RESOURCE_MANAGER property.
95 .SH SEE ALSO
96 .BR X (1),
97 .BR xscreensaver (1)
98 .SH COPYRIGHT
99 Copyright \(co 1992 by Jamie Zawinski.  Permission to use, copy, modify, 
100 distribute, and sell this software and its documentation for any purpose is 
101 hereby granted without fee, provided that the above copyright notice appear 
102 in all copies and that both that copyright notice and this permission notice
103 appear in supporting documentation.  No representations are made about the 
104 suitability of this software for any purpose.  It is provided "as is" without
105 express or implied warranty.
106 .SH AUTHOR
107 Jamie Zawinski <jwz@lucid.com>, 13-aug-92.