http://ftp.ksu.edu.tw/FTP/FreeBSD/distfiles/xscreensaver-4.23.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 [\-rate \fInumber\fP]
12 [\-fluidity \fInumber\fP]
13 [\-light \fInumber\fP]
14 [\-water]
15 [\-stir]
16 [\-oily]
17 [\-grayscale]
18 [\-colors \fInumber\fP]
19 [\-no-shm]
20 .SH DESCRIPTION
21 This draws rippling interference patterns like splashing water. With the
22 -water option, it manipulates your desktop image to look like something is
23 dripping into it.
24 .SH OPTIONS
25 .TP 8
26 .B \-visual \fIvisual\fP
27 Specify which visual to use.  Legal values are the name of a visual class,
28 or the id number (decimal or hex) of a specific visual.
29 .TP 8
30 .B \-window
31 Draw on a newly-created window.  This is the default.
32 .TP 8
33 .B \-root
34 Draw on the root window.
35 .TP 8
36 .B \-delay \fInumber\fP
37 Per-frame delay, in microseconds.  Default: 50000 (0.05 seconds.).
38 .TP 8
39 .B \-rate \fInumber\fP
40 Drizzle.  1 - 100.  Default: 5.
41 .TP 8
42 .B \-fluidity \fInumber\fP
43 Small Drops.  0 - 16.  Default: 6.
44 .TP 8
45 .B \-light \fInumber\fP
46 Lighting Effect.  0 - 8.  Default: 0.
47 .TP 8
48 .B \-water | \-no-water
49 Grab Screen Image.  Boolean.
50 .TP 8
51 .B \-stir | \-no-stir
52 Moving Splashes.  Boolean.
53 .TP 8
54 .B \-oily | \-no-oily
55 Psychedelic Colors.  Boolean.
56 .TP 8
57 .B \-grayscale
58 Convert the screen image to grayscale.
59 Ignored if we don't grab the screen image or if our screen doesn't have
60 enough color depth.
61 .TP 8
62 .B \-colors \fInumber\fP
63 Colors Two.  Default: 200.
64 .TP 8
65 .B \-shm | \-no-shm
66 Use Shared Memory.  Boolean.
67 .SH ENVIRONMENT
68 .PP
69 .TP 8
70 .B DISPLAY
71 to get the default host and display number.
72 .TP 8
73 .B XENVIRONMENT
74 to get the name of a resource file that overrides the global resources
75 stored in the RESOURCE_MANAGER property.
76 .SH SEE ALSO
77 .BR X (1),
78 .BR xscreensaver (1)
79 .SH COPYRIGHT
80 Copyright \(co 2002 by Tom Hammersley.  Permission to use, copy, modify, 
81 distribute, and sell this software and its documentation for any purpose is 
82 hereby granted without fee, provided that the above copyright notice appear 
83 in all copies and that both that copyright notice and this permission notice
84 appear in supporting documentation.  No representations are made about the 
85 suitability of this software for any purpose.  It is provided "as is" without
86 express or implied warranty.
87 .SH AUTHOR
88 Tom Hammersley.