http://ftp.x.org/contrib/applications/xscreensaver-3.25.tar.gz
[xscreensaver] / hacks / nerverot.man
1 .TH XScreenSaver 1 "05-Jul-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] [\-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.
10 .SH OPTIONS
11 .I nerverot
12 accepts the following options:
13 .TP 8
14 .B \-window
15 Draw on a newly-created window.  This is the default.
16 .TP 8
17 .B \-root
18 Draw on the root window.
19 .TP 8
20 .B \-mono 
21 If on a color display, pretend we're on a monochrome display.
22 .TP 8
23 .B \-install
24 Install a private colormap for the window.
25 .TP 8
26 .B \-visual \fIvisual\fP
27 Which visual to use.  Legal values are the name of a visual class,
28 or the id number (decimal or hex) of a specific visual.
29 .TP 8
30 .B \-colors \fIinteger\fP
31 How many colors should be used (if possible). The colors
32 form a smooth ramp between two randomly-chosen colors. Defaults to 4,
33 resource \fIcolors\fP.
34 .TP 8
35 .B \-delay \fImicroseconds\fP
36 The interframe delay, in microseconds. Defaults to 10000, resource
37 \fIdelay\fP.
38 .TP 8
39 .B \-count \fIinteger\fP
40 How many "blots" to draw at a time. This number may be rounded down to
41 fit the particularly chosen model, and has a fixed minimum per-model.
42 Defaults to 250, resource \fIcount\fP.
43 .TP 8
44 .B \-line-width \fIinteger\fP
45 The width of the lines to draw. 0 means an optimized pixel-thick line.
46 Defaults to 0, resource \fIlineWidth\fP.
47 .TP 8
48 .B \-event-chance \fIfraction\fP
49 The chance, per iteration, for a life-altering event to occur (such as
50 picking a new rotation target), in the range 0..1. Defaults to 0.2,
51 resource \fIeventChance\fP.
52 .TP 8 
53 .B \-iter-amt \fIfraction\fP
54 The fraction of movement towards a target (such as rotation angle or scale)
55 that happens per iteration, in the range 0..1. Defaults to 0.01,
56 resource \fiterAmt\fP.
57 .TP 8
58 .B \-nervousness \fIfraction\fP
59 How nervous the drawing is, in the range 0..1. This is how jumpy the points
60 on each blot are. Defaults to 0.3, resource \fInervousness\fP.
61 .TP 8
62 .B \-max-nerve-radius \fIfraction\fP
63 The maximum radius of blot nervousness, as a fraction of the radius of the
64 blot, in the range 0..1. Defaults to 0.7, resource \fImaxNerveRadius\fP.
65 .TP 8
66 .B \-min-radius \fIinteger\fP
67 The minimum radius for a blot, in the range 1..100. Defaults to 3,
68 resource \fIminRadius\fP.
69 .TP 8
70 .B \-max-radius \fIinteger\fP
71 The maximum radius for a blot, in the range 1..100. Defaults to 25,
72 resource \fImaxRadius\fP.
73 .TP 8
74 .B \-min-scale \fIfraction\fP
75 The minimum overall scale of drawing, as a fraction of
76 \fImin(windowHeight,windowWidth)\fP, in the range 0..10. Defaults to 0.6,
77 resource \fIminScale\fP.
78 .TP 8
79 .B \-max-scale \fIfraction\fP
80 The maximum overall scale of drawing, as a fraction of
81 \fImin(windowHeight,windowWidth)\fP, in the range 0..10. Defaults to 1.75,
82 resource \fImaxScale\fP.
83 .SH ENVIRONMENT
84 .PP
85 .TP 8
86 .B DISPLAY
87 to get the default host and display number.
88 .TP 8
89 .B XENVIRONMENT
90 to get the name of a resource file that overrides the global resources
91 stored in the RESOURCE_MANAGER property.
92 .SH X RESOURCES
93 There are resource equivalents for each option, noted above.
94 .SH BUGS
95 .I nerverot
96 should have more models.
97 .SH SEE ALSO
98 .BR xscreensaver (1)
99 .SH COPYRIGHT
100 Copyright \(co 2000 by Dan Bornstein.
101
102 Permission to use, copy, modify, distribute, and sell this software and its
103 documentation for any purpose is hereby granted without fee, provided that
104 the above copyright notice appear in all copies and that both that
105 copyright notice and this permission notice appear in supporting
106 documentation.  No representations are made about the suitability of this
107 software for any purpose.  It is provided "as is" without express or 
108 implied warranty.
109 .SH AUTHOR
110 Dan Bornstein <danfuzz@milk.com>, 05-Jul-2000.