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 .SH DESCRIPTION
  26 \fITwang\fP divides the screen into equal-sized tiles, and then plucks
  27 them in various ways. Tiles are affected by their neighbors, so waves
  28 of motion flow through the grid. This manpage
  29 describes v1.3 of the program.
  30 .SH OPTIONS
  31 .I twang
  32 accepts the following options:
  33 .TP 8
  34 .B \-window
  35 Draw on a newly-created window.  This is the default.
  36 .TP 8
  37 .B \-root
  38 Draw on the root window.
  39 .TP 8
  40 .B \-mono
  41 If on a color display, pretend we're on a monochrome display.
  42 .TP 8
  43 .B \-install
  44 Install a private colormap for the window.
  45 .TP 8
  46 .B \-visual \fIvisual\fP
  47 Which visual to use.  Legal values are the name of a visual class,
  48 or the id number (decimal or hex) of a specific visual.
  49 .TP 8
  50 .B \-shm
  51 .TP 8
  52 .B \-no-shm
  53 Use the shared memory extension (or not, respectively), if available.
  54 This may speed things
  55 up a bit, but probably won't make that much difference. If available,
  56 defaults to true, resource \fIuseSHM\fP.
  57 .TP 8
  58 .B \-delay \fImicroseconds\fP
  59 The interframe delay, in microseconds. Defaults to 10000, resource
  60 \fIdelay\fP.
  61 .TP 8
  62 .B \-duration \fIseconds\fP
  63 How long to run before loading a new image.  Default 120 seconds.
  64 .TP 8
  65 .B \-border-color \fIcolor\fP
  66 Color of the border surrounding each tile. Defaults to blue, resource
  67 \fIborderColor\fP.
  68 .TP 8
  69 .B \-border-width \fIinteger\fP
  70 Width of the border surrounding each tile. Defaults to 3, resource
  71 \fIborderWidth\fP.
  72 .TP 8
  73 .B \-event-chance \fIfraction\fP
  74 The chance, per iteration, for an event to occur (such as tweaking
  75 the orientation of a tile), in the range 0..1. Defaults to 0.01,
  76 resource \fIeventChance\fP.
  77 .TP 8
  78 .B \-friction \fIfraction\fP
  79 How much friction there is in the system, in the range 0..1.
  80 This is the amount by which velocities are damped per iteration.
  81 Defaults to 0.05, resource \fIfriction\fP.
  82 .TP 8
  83 .B \-springiness \fIfraction\fP
  84 How springy the tiles are, in the range 0..1.
  85 This is the fraction of an orientation that gets turned into a velocity
  86 towards the center (resting point). Defaults to 0.1, resource
  87 \fIspringiness\fP.
  88 .TP 8
  89 .B \-tile-size \fIinteger\fP
  90 Size (width and height) of each tile, not including the outer edge
  91 of the border. Defaults to 120, resource \fItileSize\fP.
  92 .TP 8
  93 .B \-transference \fIfraction\fP
  94 How much a tile's neighbors affect it, in the range 0..1.
  95 This is the fraction of an orientation of a neighbor that gets turned
  96 into a velocity in the same direction Defaults to 0.025, resource
  97 \fItransference\fP.
  98 .SH ENVIRONMENT
  99 .PP
 100 .TP 8
 101 .B DISPLAY
 102 to get the default host and display number.
 103 .TP 8
 104 .B XENVIRONMENT
 105 to get the name of a resource file that overrides the global resources
 106 stored in the RESOURCE_MANAGER property.
 107 .SH X RESOURCES
 108 There are resource equivalents for each option, noted above.
 109 .SH BUGS
 110 .I twang
 111 should have more interesting events.
 112 .TP 8
 113 Ways of speeding it up need to be investigated. It's kinda sluggish,
 114 especially on hugeass displays.
 115 .SH SEE ALSO
 116 .BR xscreensaver (1)
 117 .SH COPYRIGHT
 118 Copyright \(co 2002 by Dan Bornstein. All rights reserved.
 119
 120 Permission to use, copy, modify, distribute, and sell this software and its
 121 documentation for any purpose is hereby granted without fee, provided that
 122 the above copyright notice appear in all copies and that both that
 123 copyright notice and this permission notice appear in supporting
 124 documentation. No representations are made about the suitability of this
 125 software for any purpose. It is provided "as is" without express or
 126 implied warranty.
 127 .SH AUTHOR
 128 Dan Bornstein <danfuzz@milk.com>.