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

   1 .TH XScreenSaver 1 "07-Feb-2002" "X Version 11"
   2 .SH NAME
   3 twang - pluck pieces of the screen
   4 .SH SYNOPSIS
   5 .B twang
   6 [\-display \fIhost:display.screen\fP]
   7 [\-foreground \fIcolor\fP]
   8 [\-background \fIcolor\fP]
   9 [\-window]
  10 [\-root]
  11 [\-mono]
  12 [\-install]
  13 [\-visual \fIvisual\fP]
  14 [\-shm]
  15 [\-no-shm]
  16 [\-delay \fIusecs\fP]
  17 [\-duration \fIsecs\fP]
  18 [\-border-color \fIcolor\fP]
  19 [\-border-width \fIinteger\fP]
  20 [\-event-chance \fIfraction\fP]
  21 [\-friction \fIfraction\fP]
  22 [\-springiness \fIfraction\fP]
  23 [\-tile-size \fIinteger\fP]
  24 [\-transference \fIfraction\fP]
  25 [\-fps]
  26 .SH DESCRIPTION
  27 \fITwang\fP divides the screen into equal-sized tiles, and then plucks
  28 them in various ways. Tiles are affected by their neighbors, so waves
  29 of motion flow through the grid. This manpage
  30 describes v1.3 of the program.
  31 .SH OPTIONS
  32 .I twang
  33 accepts the following options:
  34 .TP 8
  35 .B \-window
  36 Draw on a newly-created window.  This is the default.
  37 .TP 8
  38 .B \-root
  39 Draw on the root window.
  40 .TP 8
  41 .B \-mono
  42 If on a color display, pretend we're on a monochrome display.
  43 .TP 8
  44 .B \-install
  45 Install a private colormap for the window.
  46 .TP 8
  47 .B \-visual \fIvisual\fP
  48 Which visual to use.  Legal values are the name of a visual class,
  49 or the id number (decimal or hex) of a specific visual.
  50 .TP 8
  51 .B \-shm
  52 .TP 8
  53 .B \-no-shm
  54 Use the shared memory extension (or not, respectively), if available.
  55 This may speed things
  56 up a bit, but probably won't make that much difference. If available,
  57 defaults to true, resource \fIuseSHM\fP.
  58 .TP 8
  59 .B \-delay \fImicroseconds\fP
  60 The interframe delay, in microseconds. Defaults to 10000, resource
  61 \fIdelay\fP.
  62 .TP 8
  63 .B \-duration \fIseconds\fP
  64 How long to run before loading a new image.  Default 120 seconds.
  65 .TP 8
  66 .B \-border-color \fIcolor\fP
  67 Color of the border surrounding each tile. Defaults to blue, resource
  68 \fIborderColor\fP.
  69 .TP 8
  70 .B \-border-width \fIinteger\fP
  71 Width of the border surrounding each tile. Defaults to 3, resource
  72 \fIborderWidth\fP.
  73 .TP 8
  74 .B \-event-chance \fIfraction\fP
  75 The chance, per iteration, for an event to occur (such as tweaking
  76 the orientation of a tile), in the range 0..1. Defaults to 0.01,
  77 resource \fIeventChance\fP.
  78 .TP 8
  79 .B \-friction \fIfraction\fP
  80 How much friction there is in the system, in the range 0..1.
  81 This is the amount by which velocities are damped per iteration.
  82 Defaults to 0.05, resource \fIfriction\fP.
  83 .TP 8
  84 .B \-springiness \fIfraction\fP
  85 How springy the tiles are, in the range 0..1.
  86 This is the fraction of an orientation that gets turned into a velocity
  87 towards the center (resting point). Defaults to 0.1, resource
  88 \fIspringiness\fP.
  89 .TP 8
  90 .B \-tile-size \fIinteger\fP
  91 Size (width and height) of each tile, not including the outer edge
  92 of the border. Defaults to 120, resource \fItileSize\fP.
  93 .TP 8
  94 .B \-transference \fIfraction\fP
  95 How much a tile's neighbors affect it, in the range 0..1.
  96 This is the fraction of an orientation of a neighbor that gets turned
  97 into a velocity in the same direction Defaults to 0.025, resource
  98 \fItransference\fP.
  99 .TP 8
 100 .B \-fps
 101 Display the current frame rate and CPU load.
 102 .SH ENVIRONMENT
 103 .PP
 104 .TP 8
 105 .B DISPLAY
 106 to get the default host and display number.
 107 .TP 8
 108 .B XENVIRONMENT
 109 to get the name of a resource file that overrides the global resources
 110 stored in the RESOURCE_MANAGER property.
 111 .SH X RESOURCES
 112 There are resource equivalents for each option, noted above.
 113 .SH BUGS
 114 .I twang
 115 should have more interesting events.
 116 .TP 8
 117 Ways of speeding it up need to be investigated. It's kinda sluggish,
 118 especially on hugeass displays.
 119 .SH SEE ALSO
 120 .BR xscreensaver (1)
 121 .SH COPYRIGHT
 122 Copyright \(co 2002 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>.