git.hungrycats.org Git - xscreensaver/blob - hacks/glx/jigglypuff.man

   1 .TH XScreenSaver 1 "" "X Version 11"
   2 .SH NAME
   3 jigglypuff - save your screen by tormenting your eyes.
   4 .SH SYNOPSIS
   5 .B jigglypuff
   6 [\-display \fIhost:display.screen\fP]
   7 [\-visual \fIvisual\fP]
   8 [\-window]
   9 [\-root]
  10 [-delay \fInumber\fP]
  11 [-cycles \fInumber\fP]
  12 [-wireframe]
  13 [-fps]
  14 [-color \fIcolorspec\fP]
  15 [-spooky]
  16 [-complexity \fIn\fP]
  17 [-speed \fIn\fP]
  18 [-spherism \fIn\fP]
  19 [-hold \fIn\fP]
  20 [-distance \fIn\fP]
  21 [-damping \fIn\fP]
  22 .SH DESCRIPTION
  23 This draws all manners of obscene, spastic, puffy, vaguely ball-shaped
  24 objects orbiting lazily about the screen, with a dizzying array of
  25 mostly pointless options.
  26 .SH OPTIONS
  27 .TP 8
  28 .B \-visual \fIvisual\fP
  29 Specify 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 \-window
  33 Draw on a newly-created window.  This is the default.
  34 .TP 8
  35 .B \-root
  36 Draw on the root window.
  37 .TP 8
  38 .B \-delay \fInumber\fP
  39 Per-frame delay, in microseconds.  Default: 20000 (0.02 seconds.).
  40 .TP 8
  41 .B \-wireframe
  42 Render in wireframe instead of solid. Default: render solid.
  43 .TP 8
  44 .B \-fps
  45 Display the current frame rate, CPU load, and polygon count.
  46 .TP 8
  47 .B -tetra | -no-tetra
  48 Whether to start the shape in the form of a tetrahedron. The default
  49 is to start as a sphere.
  50 .TP 8
  51 .B -color \fIcolorspec\fP
  52 Available options for colorspec are: cycle, flowerbox, clownpuke, chrome
  53 and #xxxxxx (i.e an (old-style) X color specification.) Default: cycle
  54 .TP 8
  55 .B -spooky \fIn\fP
  56 This option controls a kind of interesting effect obtained by
  57 using unnormalized normal vectors (how's that for an oxymoron?) in OpenGL.
  58 A value of zero disables the effect. Other values vary the lengths of
  59 the normals proportionally.
  60 Okay, so it's not very spooky. Sue me.
  61 Default: 0
  62 .TP 8
  63 .B -complexity \fIn\fP
  64 Valid options are 1, 2, and 3. Everything else is treated as though it
  65 were 2, which is the default. This controls the number of polygons in
  66 the 'thing'. A value of 1 yields 1024, and the values go up in powers
  67 of 4. (i.e. 4096, 16384.)
  68  note: There is an inherent lack of stability
  69 at lower complexity, which can cause the shape to devolve into a 'flying
  70 snotrag'.
  71 .TP 8
  72 .B -speed \fIn\fP
  73 Controls how fast the blob moves around the screen. Default: 500.
  74 .TP 8
  75 .B -spherism, -hold, -distance, -damping
  76 These options control the 'jigglyness'. The best way to explain these is
  77 to explain how jigglypuff works. Basically, the shape is a tetrahedron
  78 whose faces are subdivided into a number of triangles, forming a mesh.
  79 Each of the vertices of the mesh has two different forces applied to it:
  80 one proportional to its distance from the surface of a sphere, and one
  81 proportional to the difference of the distance to each of its neighbors
  82 in the mesh to a given ideal distance. In short, one tries to move the
  83 points into the configuration of a sphere, and the other tries to push
  84 them back into a tetrahedron. The catch is that the points have inertia,
  85 so they always overshoot their target, and hence they oscillate. The
  86 magnitudes of the two forces is controlled by the options 'spherism' and
  87 \'hold'; 'distance' specifies the distance the vertices seek to keep from
  88 their neighbors, with 500 corresponding to the size of the start tetrahedron.
  89 e.g. if you were to give the options '-tetra -spherism 0 -distance 500', you
  90 would end up with a stable tetrahedron. The 'damping' option can help to
  91 keep the blob from collapsing or flying apart. The option specifies the
  92 speed at which damping starts, hence lower values mean more damping.
  93 Defaults: spherism: 75; hold: 800; distance: 100; damping: 500.
  94 .TP 8
  95 .B -random
  96 Probably the only parameter you'l ever need. Overrides almost all of the
  97 parameters with random values. The values affected are: speed, spherism,
  98 hold, distance, damping, spooky, color, wireframe and tetra.
  99 Default: off
 100 .SH ENVIRONMENT
 101 .PP
 102 .TP 8
 103 .B DISPLAY
 104 to get the default host and display number.
 105 .TP 8
 106 .B XENVIRONMENT
 107 to get the name of a resource file that overrides the global resources
 108 stored in the RESOURCE_MANAGER property.
 109 .SH SEE ALSO
 110 .BR X (1),
 111 .BR xscreensaver (1)
 112 .SH COPYRIGHT
 113 Copyright \(co 2003 by Keith Macleod.  Permission to use, copy, modify,
 114 distribute, and sell this software and its documentation for any purpose is
 115 hereby granted without fee, provided that the above copyright notice appear
 116 in all copies and that both that copyright notice and this permission notice
 117 appear in supporting documentation.  No representations are made about the
 118 suitability of this software for any purpose.  It is provided "as is" without
 119 express or implied warranty.
 120 .SH AUTHOR
 121 By Keith Macleod