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