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