de723fbf4c1114a978b741828a4618c04d5aed3e
[xscreensaver] / hacks / nerverot.man
1 .TH XScreenSaver 1 "11-Aug-2000" "X Version 11"
2 .SH NAME
3 nerverot - induces edginess in the viewer
4 .SH SYNOPSIS
5 .B nerverot
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-db] [\-no-db] [\-colors \fIinteger\fP] [\-delay \fImicroseconds\fP] [\-count \fIinteger\fP] [\-line-width \fIinteger\fP] [\-event-chance \fIfraction\fP] [\-iter-amt \fIfraction\fP] [\-nervousness \fIfraction\fP] [\-max-nerve-radius \fIfraction\fP] [\-min-radius \fIinteger\fP] [\-max-radius \fIinteger\fP] [\-min-scale \fIfraction\fP] [\-max-scale \fIfraction\fP]
7 .SH DESCRIPTION
8 The goal of \fInerverot\fP is to be interesting and compelling to
9 watch, yet induce a state of nervous edginess in the viewer. This manpage
10 describes v1.2 of the program.
11 .SH OPTIONS
12 .I nerverot
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 \-install
25 Install a private colormap for the window.
26 .TP 8
27 .B \-visual \fIvisual\fP
28 Which visual to use.  Legal values are the name of a visual class,
29 or the id number (decimal or hex) of a specific visual.
30 .TP 8
31 .B \-db
32 .B \-no-db
33 Use double-buffering (or not, respectively). Double-buffering may make 
34 things look better for larger line widths and/or larger numbers of
35 blots, but "better" may equate to yielding less of the desired edginess
36 effect. You'll be calmer after watching the double-buffered variant;
37 you're more likely to go into epileptic fits with it off. Hence, it
38 is off (false) by default, resource \fIdoubleBuffer\fP.
39 .TP 8
40 .B \-colors \fIinteger\fP
41 How many colors should be used (if possible). The colors
42 form a smooth ramp between two randomly-chosen colors. Defaults to 4,
43 resource \fIcolors\fP.
44 .TP 8
45 .B \-delay \fImicroseconds\fP
46 The interframe delay, in microseconds. Defaults to 10000, resource
47 \fIdelay\fP.
48 .TP 8
49 .B \-count \fIinteger\fP
50 How many "blots" to draw at a time. This number may be rounded down to
51 fit the particularly chosen model, and has a fixed minimum per-model.
52 Defaults to 250, resource \fIcount\fP.
53 .TP 8
54 .B \-line-width \fIinteger\fP
55 The width of the lines to draw. 0 means an optimized pixel-thick line.
56 Defaults to 0, resource \fIlineWidth\fP.
57 .TP 8
58 .B \-event-chance \fIfraction\fP
59 The chance, per iteration, for a life-altering event to occur (such as
60 picking a new rotation target), in the range 0..1. Defaults to 0.2,
61 resource \fIeventChance\fP.
62 .TP 8 
63 .B \-iter-amt \fIfraction\fP
64 The fraction of movement towards a target (such as rotation angle or scale)
65 that happens per iteration, in the range 0..1. Defaults to 0.01,
66 resource \fiterAmt\fP.
67 .TP 8
68 .B \-nervousness \fIfraction\fP
69 How nervous the drawing is, in the range 0..1. This is how jumpy the points
70 on each blot are. Defaults to 0.3, resource \fInervousness\fP.
71 .TP 8
72 .B \-max-nerve-radius \fIfraction\fP
73 The maximum radius of blot nervousness, as a fraction of the radius of the
74 blot, in the range 0..1. Defaults to 0.7, resource \fImaxNerveRadius\fP.
75 .TP 8
76 .B \-min-radius \fIinteger\fP
77 The minimum radius for a blot, in the range 1..100. Defaults to 3,
78 resource \fIminRadius\fP.
79 .TP 8
80 .B \-max-radius \fIinteger\fP
81 The maximum radius for a blot, in the range 1..100. Defaults to 25,
82 resource \fImaxRadius\fP.
83 .TP 8
84 .B \-min-scale \fIfraction\fP
85 The minimum overall scale of drawing, as a fraction of
86 \fImin(windowHeight,windowWidth)\fP, in the range 0..10. Defaults to 0.6,
87 resource \fIminScale\fP.
88 .TP 8
89 .B \-max-scale \fIfraction\fP
90 The maximum overall scale of drawing, as a fraction of
91 \fImin(windowHeight,windowWidth)\fP, in the range 0..10. Defaults to 1.75,
92 resource \fImaxScale\fP.
93 .SH ENVIRONMENT
94 .PP
95 .TP 8
96 .B DISPLAY
97 to get the default host and display number.
98 .TP 8
99 .B XENVIRONMENT
100 to get the name of a resource file that overrides the global resources
101 stored in the RESOURCE_MANAGER property.
102 .SH X RESOURCES
103 There are resource equivalents for each option, noted above.
104 .SH BUGS
105 .I nerverot
106 should have more models.
107 .SH SEE ALSO
108 .BR xscreensaver (1)
109 .SH COPYRIGHT
110 Copyright \(co 2000 by Dan Bornstein.
111
112 Permission to use, copy, modify, distribute, and sell this software and its
113 documentation for any purpose is hereby granted without fee, provided that
114 the above copyright notice appear in all copies and that both that
115 copyright notice and this permission notice appear in supporting
116 documentation.  No representations are made about the suitability of this
117 software for any purpose.  It is provided "as is" without express or 
118 implied warranty.
119 .SH AUTHOR
120 Dan Bornstein <danfuzz@milk.com>, 05-Jul-2000.