35f68147ad2b21e6d5b22a3d4a273e499346c40a
[xscreensaver] / hacks / bumps.man
1 .TH XScreenSaver 1 "05-Apr-1999" "X Version 11"
2 .SH NAME
3 bumps - move distorting spotlight around desktop
4 .SH SYNOPSIS
5 .B bumps
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP]
7 [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install]
8 [\-visual \fIvisual\fP] [\-delay \fIusecs\fP] [\-radius \fIpixels\fP]
9 .SH DESCRIPTION
10 The \fIbumps\fP program takes an image and exposes small, distorted
11 sections of it as if through an odd wandering spotlight beam.
12
13 The image that it manipulates will be grabbed from the portion of
14 the screen underlying the window, or from the system's video input,
15 or from a random file on disk, as indicated by
16 the \fIgrabDesktopImages\fP, \fIgrabVideoFrames\fP,
17 and \fIchooseRandomImages\fP options in the \fI~/.xscreensaver\fP
18 file; see
19 .BR xscreensaver-demo (1)
20 for more details.
21 .SH OPTIONS
22 .I bumps
23 accepts the following options:
24 .TP 8
25 .B \-window
26 Draw on a newly-created window.  This is the default.
27 .TP 8
28 .B \-root
29 Draw on the root window.
30 .TP 8
31 .B \-mono 
32 If on a color display, pretend we're on a monochrome display.
33 .TP 8
34 .B \-install
35 Install a private colormap for the window.
36 .TP 8
37 .B \-visual \fIvisual\fP
38 Specify which visual to use.  Legal values are the name of a visual class,
39 or the id number (decimal or hex) of a specific visual.
40 .TP 8
41 .B \-delay \fImicroseconds\fP
42 Slow it down.
43 .TP 8
44 .B \-radius \fIpixels\fP
45 Radius of the spotlight in pixels.
46 .SH ENVIRONMENT
47 .PP
48 .TP 8
49 .B DISPLAY
50 to get the default host and display number.
51 .TP 8
52 .B XENVIRONMENT
53 to get the name of a resource file that overrides the global resources
54 stored in the RESOURCE_MANAGER property.
55 .SH SEE ALSO
56 .BR X (1),
57 .BR xscreensaver (1),
58 .BR xscreensaver\-demo (1),
59 .BR xscreensaver\-getimage (1)
60 .SH COPYRIGHT
61 Copyright \(co 1999 by Shane Smit.  Permission to use, copy, modify, 
62 distribute, and sell this software and its documentation for any purpose is 
63 hereby granted without fee, provided that the above copyright notice appear 
64 in all copies and that both that copyright notice and this permission notice
65 appear in supporting documentation.  No representations are made about the 
66 suitability of this software for any purpose.  It is provided "as is" without
67 express or implied warranty.
68 .SH CREDITS
69 Shane Smit <blackend@inconnect.com>, 8-Oct-1999.