From http://www.jwz.org/xscreensaver/xscreensaver-5.30.tar.gz
[xscreensaver] / hacks / slip.man
1 .TH XScreenSaver 1 "24-Nov-97" "X Version 11"
2 .SH NAME
3 slip - sucks your screen into a jet engine
4 .SH SYNOPSIS
5 .B slip
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP]
7 [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install]
8 [\-visual \fIvisual\fP] [\-ncolors \fIinteger\fP]
9 [\-iterations \fIinteger\fP] [\-points \fIinteger\fP]
10 [\-delay \fImicroseconds\fP] [\-delay2 \fImicroseconds\fP]
11 [\-fps]
12 .SH DESCRIPTION
13 The \fIslip\fP program does lots of blits and chews up an image.
14
15 The image that it manipulates will be grabbed from the portion of
16 the screen underlying the window, or from the system's video input,
17 or from a random file on disk, as indicated by
18 the \fIgrabDesktopImages\fP, \fIgrabVideoFrames\fP,
19 and \fIchooseRandomImages\fP options in the \fI~/.xscreensaver\fP
20 file; see
21 .BR xscreensaver-demo (1)
22 for more details.
23 .SH OPTIONS
24 .I slip
25 accepts the following options:
26 .TP 8
27 .B \-window
28 Draw on a newly-created window.  This is the default.
29 .TP 8
30 .B \-root
31 Draw on the root window.
32 .TP 8
33 .B \-mono 
34 If on a color display, pretend we're on a monochrome display.
35 .TP 8
36 .B \-install
37 Install a private colormap for the window.
38 .TP 8
39 .B \-visual \fIvisual\fP
40 Specify which visual to use.  Legal values are the name of a visual class,
41 or the id number (decimal or hex) of a specific visual.
42 .TP 8
43 .B \-ncolors \fIinteger\fP
44 How many colors should be used (if possible).  Default 200.
45 The colors used cycle through the hue, making N stops around 
46 the color wheel.
47 .TP 8
48 .B \-count \fIinteger\fP
49 How many whooziwhatsis to generate.  Default 35.
50 .TP 8
51 .B \-cycles \fIinteger\fP
52 How long to frobnicate.  Default 50.
53 .TP 8
54 .B \-delay \fImicroseconds\fP
55 How long we should wait between drawing each step.  Default 50000,
56 or about 1/20th second.
57 .TP 8
58 .B \-fps
59 Display the current frame rate and CPU load.
60 .SH ENVIRONMENT
61 .PP
62 .TP 8
63 .B DISPLAY
64 to get the default host and display number.
65 .TP 8
66 .B XENVIRONMENT
67 to get the name of a resource file that overrides the global resources
68 stored in the RESOURCE_MANAGER property.
69 .SH SEE ALSO
70 .BR X (1),
71 .BR xscreensaver (1),
72 .BR xscreensaver\-demo (1),
73 .BR xscreensaver\-getimage (1)
74 .SH COPYRIGHT
75 Copyright \(co 1992 by Scott Draves.
76
77 Permission to use, copy, modify, and distribute this software and its
78 documentation for any purpose and without fee is hereby granted,
79 provided that the above copyright notice appear in all copies and that
80 both that copyright notice and this permission notice appear in
81 supporting documentation. 
82 .SH AUTHOR
83 Scott Graves <spot@cs.cmu.edu>.
84
85 Ability to run standalone or with \fIxscreensaver\fP added by 
86 Jamie Zawinski <jwz@jwz.org>, 18-Oct-93.