http://packetstormsecurity.org/UNIX/admin/xscreensaver-3.34.tar.gz
[xscreensaver] / hacks / decayscreen.man
1 .TH XScreenSaver 1 "05-Apr-1999" "X Version 11"
2 .SH NAME
3 decayscreen - make a screen meltdown.
4 .SH SYNOPSIS
5 .B decayscreen
6 [\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-mono] [\-install]
7 [\-visual \fIvisual\fP] [\-delay \fIusecs\fP] [\-mode \fImode\fP]
8 .SH DESCRIPTION
9 The \fIdecayscreen\fP program creates a melting effect by randomly
10 shifting rectangles around the screen.
11
12 The image that it manipulates will be grabbed from the portion of
13 the screen underlying the window, or from the system's video input, 
14 or from a random file on disk, as indicated by 
15 the \fIgrabDesktopImages\fP, \fIgrabVideoFrames\fP, 
16 and \fIchooseRandomImages\fP options in the \fI~/.xscreensaver\fP
17 file; see
18 .BR xscreensaver-demo (1)
19 for more details.
20 .SH OPTIONS
21 .I decayscreen
22 accepts the following options:
23 .TP 8
24 .B \-window
25 Draw on a newly-created window.  This is the default.
26 .TP 8
27 .B \-root
28 Draw on the root window.
29 .TP 8
30 .B \-mono 
31 If on a color display, pretend we're on a monochrome display.
32 .TP 8
33 .B \-install
34 Install a private colormap for the window.
35 .TP 8
36 .B \-visual \fIvisual\fP
37 Specify which visual to use.  Legal values are the name of a visual class,
38 or the id number (decimal or hex) of a specific visual.
39 .TP 8
40 .B \-delay \fImicroseconds\fP
41 Slow it down.
42 .TP 8
43 .B \-mode \fImode\fP
44 The direction in which the image should tend to slide.  Legal values are
45 \fIrandom\fP (meaning pick one), \fIup\fP, \fIleft\fP, \fIright\fP, 
46 \fIdown\fP, \fIupleft\fP, \fIdownleft\fP, \fIupright\fP, \fIdownright\fP, 
47 \fIshuffle\fP (meaning perfer no particular direction), \fIin\fP (meaning
48 move things toward the center), \fIout\fP (meaning move things away
49 from the center), \fImelt\fP (meaning melt straight 
50 downward),  \fIstretch\fP (meaning stretch the screen downward),
51 and \fIfuzz\fP (meaning go blurry instead of melty).
52 .SH ENVIRONMENT
53 .PP
54 .TP 8
55 .B DISPLAY
56 to get the default host and display number.
57 .TP 8
58 .B XENVIRONMENT
59 to get the name of a resource file that overrides the global resources
60 stored in the RESOURCE_MANAGER property.
61 .SH "SEE ALSO"
62 .BR X (1),
63 .BR xscreensaver (1),
64 .BR xscreensaver\-demo (1),
65 .BR xscreensaver\-getimage (1)
66 .SH COPYRIGHT
67 Copyright 1992 by Vivek Khera.  Permission to use, copy, modify, distribute, 
68 and sell this software and its documentation for any purpose is hereby granted
69 without fee, provided that the above copyright notice appear in all copies and
70 that both that copyright notice and this permission notice appear in 
71 supporting documentation.  No representations are made about the suitability
72 of this software for any purpose.  It is provided "as is" without express or
73 implied warranty.
74 .SH AUTHOR
75 Vivek Khera <khera@cs.duke.edu>, 05-Aug-93; based on code by David Wald, 1988.
76 Modified by jwz, 28-Nov-97.  
77 Modified by Rick Schultz <rick@skapunx.net> 05-Apr-1999.