http://www.jwz.org/xscreensaver/xscreensaver-5.13.tar.gz
[xscreensaver] / hacks / kaleidescope.man
1 .de EX          \"Begin example
2 .ne 5
3 .if n .sp 1
4 .if t .sp .5
5 .nf
6 .in +.5i
7 ..
8 .de EE
9 .fi
10 .in -.5i
11 .if n .sp 1
12 .if t .sp .5
13 ..
14 .TH Kaleidescpe 1 "14-Dec-95" "X Version 11"
15 .SH NAME
16 Kaleidescope - rotating line segments
17 .SH SYNOPSIS
18 .B kaleidescope
19 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root] [\-install] [\-visual \fIvisual\fP] [\-color_mode \fImono | nice | greedy\fP] [-nsegments \fIint\fP] [\-ntrails \fIint\fP] [\-local_rotation \fIint\fP] [\-global_rotation \fIint\fP] [\-delay \fIusecs\fP] [\-redmin \fIint\fP] [\-greenmin \fIint\fP] [\-bluemin \fIint\fP] [\-redrange \fIint\fP] [\-greenrange \fIint\fP] [\-bluerange \fIint\fP]
20 [\-fps]
21 .SH DESCRIPTION
22 The \fIkaleidescope\fP program draws line segments in a symmetric pattern
23 that evolves over time. 
24 .SH OPTIONS
25 .I kaleidescope
26 accepts the following options:
27 .TP 8
28 .B \-root
29 Draw on the root window.
30 .TP 8
31 .B \-color_mode "mono | nice | greedy"
32 Specify how kaleidescope uses colors. Mono uses
33 just the default foreground and background colors. Nice uses one
34 color for each segment (specified by nsegments). Greedy uses (ntrails * nsegments) + 1  colors.
35 .TP 8
36 .B \-install
37 Install a private colormap for the window.
38 .TP 8
39 .B \-visual \fIvisual\fP
40 Specify which visual to use.  Legal values are the name of a visual class,
41 or the id number (decimal or hex) of a specific visual.
42 .TP 8
43 .B \-nsegments integer
44 The number of segments to draw. Default is 7.
45 .TP 8
46 .B \-ntrails integer
47 The number of trails to draw. Default is 100.
48 .TP 8
49 .B \-local_rotation integer
50 The rate at which segments rotate around their center. Default is -59.
51 .TP 8
52 .B \-global_rotation integer 
53 The rate at which segments rotate around the center of the window.
54 Default is 1. 
55 .TP 8
56 .B \-redmin, \-greenmin, \-bluemin, \-redrange, \-greenrange, \-bluerange
57 All take an integer argument. When colors are randomly chosen, they 
58 are chosen from the interval min to min plus range. The minimums default
59 to 30000. The ranges default to 20000. 
60 .TP 8
61 .B \-delay microseconds
62 How much of a delay should be introduced between steps of the animation.
63 Default is 20000, or about 5 frames a second.
64 .TP 8
65 .B \-fps
66 Display the current frame rate and CPU load.
67 .SH ENVIRONMENT
68 .PP
69 .TP 8
70 .B DISPLAY
71 to get the default host and display number.
72 .TP 8
73 .B XENVIRONMENT
74 to get the name of a resource file that overrides the global resources
75 stored in the RESOURCE_MANAGER property.
76 .SH SEE ALSO
77 .BR X (1),
78 .BR kaleidescope (MANSUFFIX)
79 .SH COPYRIGHT
80 Copyright \(co 1997 by Ron Tapia.  Permission to use, copy, modify, 
81 distribute, and sell this software and its documentation for any purpose is 
82 hereby granted without fee, provided that the above copyright notice appear 
83 in all copies and that both that copyright notice and this permission notice
84 appear in supporting documentation.  No representations are made about the 
85 suitability of this software for any purpose.  It is provided "as is" without
86 express or implied warranty.
87 .SH AUTHOR
88 Ron Tapia <tapia@nmia.com>, 20-Mar-97.
89