git.hungrycats.org Git - xscreensaver/blob - hacks/nerverot.man

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