From http://www.jwz.org/xscreensaver/xscreensaver-5.30.tar.gz
[xscreensaver] / hacks / distort.man
1 .TH XScreenSaver 1 "17-Oct-99" "X Version 11"
2 .SH NAME
3 distort \- distort the content of the screen in interesting ways
4 .SH SYNOPSIS
5 .B distort
6 [\-root] [\-window] [\-mono] [\-install] [\-noinstall] [\-visual \fIvisual\fP]
7 [\-window\-id \fIwindow\-id\fP]
8 [\-delay \fIusecs\fP]
9 [\-duration \fIsecs\fP]
10 [\-radius \fIpixels\fP]
11 [\-speed \fIint\fP]
12 [\-number \fIint\fP]
13 [\-swamp]
14 [\-bounce]
15 [\-reflect]
16 [\-vortex]
17 [\-magnify]
18 [\-blackhole]
19 [\-slow]
20 [\-shm] [\-no\-shm]
21 [\-fps]
22 .SH DESCRIPTION
23 The \fIdistort\fP program takes an image and lets circular zones of
24 distortion wander randomly around it, distorting what is under them.
25 The mode of distortion and the overall behaviour of the zones can be
26 influenced in various ways.
27
28 The image that it manipulates will be grabbed from the portion of
29 the screen underlying the window, or from the system's video input,
30 or from a random file on disk, as indicated by
31 the \fIgrabDesktopImages\fP, \fIgrabVideoFrames\fP,
32 and \fIchooseRandomImages\fP options in the \fI~/.xscreensaver\fP
33 file; see
34 .BR xscreensaver-demo (1)
35 for more details.
36 .SH OPTIONS
37 .I distort
38 accepts the following options:
39 .TP 8
40 .B \-root
41 Draw on the root window.
42 .TP 8
43 .B \-window
44 Draw on a newly-created window. This is the default.
45 .TP 8
46 .B \-mono
47 If on a color display, pretend we're on a monochrome display.
48 .TP 8
49 .B \-install
50 Install a private colormap for the window.
51 .TP 8
52 .B \-noinstall
53 Don't install a private colormap for the window.
54 .TP 8
55 .B \-visual \fIvisual\fP
56 Specify which visual to use. Legal values are the name of a visual
57 class or the id number (decimal or hex) of a specific visual.
58 .TP 8
59 .B \-window\-id \fIwindow\-id\fP
60 Specify which window id to use.
61 .TP 8
62 .B \-delay \fIusecs\fP
63 Specify the delay between subsequent animation frames in microseconds.
64 .TP 8
65 .B \-duration \fIseconds\fP
66 How long to run before loading a new image.  Default 120 seconds.
67 .TP 8
68 .B \-radius \fIpixels\fP
69 Specify the radius of the distortion zone in pixels.
70 .TP 8
71 .B \-speed \fIint\fP
72 Specify the speed at which the distortion zone moves, where 0 is slow,
73 higher numbers are faster (10 is pretty fast.)
74 .TP 8
75 .B \-number \fIint\fP
76 Specify the number of distortion zones.
77 .TP 8
78 .B \-swamp
79 Instead of letting zones wander around, let small zones pop up like
80 bubbles in a swamp and leave permanent distortion.  \fBWARNING:\fP
81 this option uses a \fIcolossal\fP amount of memory: keep the \fI\-radius\fP
82 small when using \fI\-swamp\fP.
83 .TP 8
84 .B \-bounce
85 Let zones wander around and bounce off the window border. This is the
86 default.
87 .TP 8
88 .B \-reflect
89 Mode of distortion that resembles reflection by a cylindrical mirror.
90 .TP 8
91 .B \-vortex
92 Whirlpool-shaped distortion. Way cool.
93 .TP 8
94 .B \-magnify
95 This mode of distortion looks like a magnifying glass.
96 .TP 8
97 .B \-blackhole
98 Suck your pixels beyond the event horizon. Favourite mode of Dr
99 Stephen Hawking.
100 .TP 8
101 .B \-slow
102 Make the zone wander slower.
103 .TP 8
104 .B \-shm
105 Use shared memory extension.
106 .TP 8
107 .B \-no\-shm
108 Don't use shared memory extension.
109 .TP 8
110 .B \-fps
111 Display the current frame rate and CPU load.
112 .SH ENVIRONMENT
113 .PP
114 .TP 8
115 .B DISPLAY
116 to get the default host and display number
117 .TP 8
118 .B XENVIRONMENT
119 to get the name of a resource file that overrides the global resources
120 stored in the RESOURCE_MANAGER property.
121 .SH SEE ALSO
122 .BR X (1),
123 .BR xscreensaver (1),
124 .BR xscreensaver\-demo (1),
125 .BR xscreensaver\-getimage (1)
126 .SH COPYRIGHT
127 Copyright \(co 1998 by Jonas Munsin and Jamie Zawinski.  Permission to use, 
128 copy, modify, distribute, and sell this software and its documentation for
129 any purpose is hereby granted without fee, provided that the above
130 copyright notice appear in all copies and that both that copyright
131 notice and this permission notice appear in supporting documentation.
132 No representations are made about the suitability of this software for
133 any purpose.  It is provided "as is" without express or implied
134 warranty.
135 .SH AUTHORS
136 Jonas Munsin <jmunsin@iki.fi> and Jamie Zawinski <jwz@jwz.org>.
137 This manual page by Matthias Warkus <mawa@iname.com>, 17-Oct-1999.