http://www.jwz.org/xscreensaver/xscreensaver-5.10.tar.gz
[xscreensaver] / hacks / ripples.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 ripples - interference patterns.
4 .SH SYNOPSIS
5 .B ripples
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-delay \fInumber\fP]
11 [\-duration \fIsecs\fP]
12 [\-rate \fInumber\fP]
13 [\-fluidity \fInumber\fP]
14 [\-light \fInumber\fP]
15 [\-water]
16 [\-stir]
17 [\-oily]
18 [\-grayscale]
19 [\-colors \fInumber\fP]
20 [\-no-shm]
21 [\-fps]
22 .SH DESCRIPTION
23 This draws rippling interference patterns like splashing water. With the
24 -water option, it manipulates your desktop image to look like something is
25 dripping into it.
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: 50000 (0.05 seconds.).
40 .TP 8
41 .B \-duration \fIseconds\fP
42 How long to run before loading a new image.  Default 120 seconds.
43 .TP 8
44 .B \-rate \fInumber\fP
45 Drizzle.  1 - 100.  Default: 5.
46 .TP 8
47 .B \-fluidity \fInumber\fP
48 Small Drops.  0 - 16.  Default: 6.
49 .TP 8
50 .B \-light \fInumber\fP
51 Lighting Effect.  0 - 8.  Default: 0.
52 .TP 8
53 .B \-water | \-no-water
54 Grab Screen Image.  Boolean.
55 .TP 8
56 .B \-stir | \-no-stir
57 Moving Splashes.  Boolean.
58 .TP 8
59 .B \-oily | \-no-oily
60 Psychedelic Colors.  Boolean.
61 .TP 8
62 .B \-grayscale
63 Convert the screen image to grayscale.
64 Ignored if we don't grab the screen image or if our screen doesn't have
65 enough color depth.
66 .TP 8
67 .B \-colors \fInumber\fP
68 Colors Two.  Default: 200.
69 .TP 8
70 .B \-shm | \-no-shm
71 Use Shared Memory.  Boolean.
72 .TP 8
73 .B \-fps
74 Display the current frame rate and CPU load.
75 .SH ENVIRONMENT
76 .PP
77 .TP 8
78 .B DISPLAY
79 to get the default host and display number.
80 .TP 8
81 .B XENVIRONMENT
82 to get the name of a resource file that overrides the global resources
83 stored in the RESOURCE_MANAGER property.
84 .SH SEE ALSO
85 .BR X (1),
86 .BR xscreensaver (1)
87 .SH COPYRIGHT
88 Copyright \(co 2002 by Tom Hammersley.  Permission to use, copy, modify, 
89 distribute, and sell this software and its documentation for any purpose is 
90 hereby granted without fee, provided that the above copyright notice appear 
91 in all copies and that both that copyright notice and this permission notice
92 appear in supporting documentation.  No representations are made about the 
93 suitability of this software for any purpose.  It is provided "as is" without
94 express or implied warranty.
95 .SH AUTHOR
96 Tom Hammersley.