~ubuntu-branches/ubuntu/dapper/xscreensaver/dapper-updates

« back to all changes in this revision

Viewing changes to hacks/twang.man

  • Committer: Bazaar Package Importer
  • Author(s): Ralf Hildebrandt
  • Date: 2005-04-09 00:06:43 UTC
  • mfrom: (1.1.1 upstream)
  • mto: This revision was merged to the branch mainline in revision 3.
  • Revision ID: james.westby@ubuntu.com-20050409000643-z0abtifbt9s20pcc
Tags: 4.21-3
Patch by Joachim Breitner to check more frequently if DPMS kicked in (closes: #303374, #286664).

Show diffs side-by-side

added added

removed removed

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