http://ftp.x.org/contrib/applications/xscreensaver-3.20.tar.gz
[xscreensaver] / hacks / halo.man
1 .TH XScreenSaver 1 "12-Jun-97" "X Version 11"
2 .SH NAME
3 halo - draw circular patterns
4 .SH SYNOPSIS
5 .B halo
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-count \fIint\fP] [\-delay \fIusecs\fP] [\-mode seuss | ramp | random ] [\-animate] [\-colors \fIinteger\fP] [\-cycle] [\-no\-cycle] [\-cycle\-delay \fIusecs\fP] 
7 .SH DESCRIPTION
8 The \fIhalo\fP program draws cool patterns based on circles.
9 .SH OPTIONS
10 .I halo
11 accepts the following options:
12 .TP 8
13 .B \-window
14 Draw on a newly-created window.  This is the default.
15 .TP 8
16 .B \-root
17 Draw on the root window.
18 .TP 8
19 .B \-mono 
20 If on a color display, pretend we're on a monochrome display.
21 .TP 8
22 .B \-install
23 Install a private colormap for the window.
24 .TP 8
25 .B \-visual \fIvisual\fP
26 Specify which visual to use.  Legal values are the name of a visual class,
27 or the id number (decimal or hex) of a specific visual.
28 .TP 8
29 .B \-count \fIinteger\fP
30 How many circles to draw.  Default 0, meaning random.
31 .TP 8
32 .B \-mode "seuss | ramp | random"
33 In \fIseuss\fP mode, alternating striped curves will be drawn.
34
35 In \fIramp\fP mode, a color ramp will be drawn.
36
37 \fIrandom\fP means pick the mode randomly.
38 .TP 8
39 .B \-delay \fImicroseconds\fP
40 How much of a delay should be introduced between steps of the animation.
41 Default 100000, or about 0.1 second.
42 .TP 8
43 .B \-colors \fIinteger\fP
44 How many colors to use.  Default 100.
45 .TP 8
46 .B \-animate
47 If specified, then the centerpoints of the circles will bounce around.
48 Otherwise, the circles will be drawn once, erased, and a new set of
49 circles will be drawn.
50 .TP 8
51 .B \-cycle
52 .TP 8
53 .B \-no\-cycle
54 Whether to do colormap cycling.  Default is to cycle.
55 .TP 8
56 .B \-cycle\-delay
57 Number of microseconds between shifts of the colormap; default 100000,
58 or 1/10th second.
59 .SH ENVIRONMENT
60 .PP
61 .TP 8
62 .B DISPLAY
63 to get the default host and display number.
64 .TP 8
65 .B XENVIRONMENT
66 to get the name of a resource file that overrides the global resources
67 stored in the RESOURCE_MANAGER property.
68 .SH SEE ALSO
69 .BR X (1),
70 .BR xscreensaver (1)
71 .SH COPYRIGHT
72 Copyright \(co 1993 by Jamie Zawinski.  Permission to use, copy, modify, 
73 distribute, and sell this software and its documentation for any purpose is 
74 hereby granted without fee, provided that the above copyright notice appear 
75 in all copies and that both that copyright notice and this permission notice
76 appear in supporting documentation.  No representations are made about the 
77 suitability of this software for any purpose.  It is provided "as is" without
78 express or implied warranty.
79 .SH AUTHOR
80 Jamie Zawinski <jwz@jwz.org>, 6-jul-93.