d513654c2e61cda72963fe95b4dba1e19d769462
[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] [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-ncolors \fIinteger\fP] [\-iterations \fIinteger\fP] [\-points \fIinteger\fP] [\-delay \fImicroseconds\fP] [\-delay2 \fImicroseconds\fP]
7 .SH DESCRIPTION
8 The \fIslip\fP program does lots of blits and chews up your screen image.
9 .SH OPTIONS
10 .I slip
11 accepts the following options:
12 .TP 8
13 .B \-window
14 Draw on a newly-created window.  This is the default.
15 .TP 8
16 .B \-root
17 Draw on the root window.
18 .TP 8
19 .B \-mono 
20 If on a color display, pretend we're on a monochrome display.
21 .TP 8
22 .B \-install
23 Install a private colormap for the window.
24 .TP 8
25 .B \-visual \fIvisual\fP
26 Specify which visual to use.  Legal values are the name of a visual class,
27 or the id number (decimal or hex) of a specific visual.
28 .TP 8
29 .B \-ncolors \fIinteger\fP
30 How many colors should be used (if possible).  Default 128.
31 The colors used cycle through the hue, making N stops around 
32 the color wheel.
33 .TP 8
34 .B \-count \fIinteger\fP
35 How many whooziwhatsis to generate.  Default 35.
36 .TP 8
37 .B \-cycles \fIinteger\fP
38 How long to frobnicate.  Default 50.
39 .TP 8
40 .B \-delay \fImicroseconds\fP
41 How long we should wait between drawing each step.  Default 50000,
42 or about 1/20th second.
43
44 .SH RESOURCES
45 On some systems (currently, only SGIs), this program can, instead of grabbing
46 a desktop image, grab a frame of video from an external camera and manipulate
47 that instead.  The following resources control that.
48 .PP
49 .TP 8
50 .B grabVideoProbability \fR(Float)\fP
51 What portion of the time to grab video rather than a screen image, 
52 between 0.0 and 1.0.  Defaults to 0.5, or half the time.
53 .TP 8
54 .B videoDevice \fR(Integer)\fP
55 The number of the default video input device to check first.  If unspecified, 
56 the default camera (from videopanel(1)) will be checked first.  After that, all
57 other available video input devices will be checked in order.  
58
59 The first one which produces a non-black image will be used.  If all images
60 are black, the others will be re-checked a few times before giving up and
61 falling back to simply grabbing a desktop image (but note that this takes a
62 few seconds, so if you don't actually have any video sources hooked up, you
63 should consider turning off video grabbing by setting
64 \fBgrabVideoProbability\fP to 0.0.)
65 .TP 8
66 .B videoGain \fR(Float)\fP
67 The amount by which to brighten the grabbed image.  This defaults to 2.2.
68 .SH ENVIRONMENT
69 .PP
70 .TP 8
71 .B DISPLAY
72 to get the default host and display number.
73 .TP 8
74 .B XENVIRONMENT
75 to get the name of a resource file that overrides the global resources
76 stored in the RESOURCE_MANAGER property.
77 .SH SEE ALSO
78 .BR X (1),
79 .BR xscreensaver (1),
80 .BR xlock (1)
81 .SH COPYRIGHT
82 Copyright \(co 1992 by Scott Draves.
83
84 Permission to use, copy, modify, and distribute this software and its
85 documentation for any purpose and without fee is hereby granted,
86 provided that the above copyright notice appear in all copies and that
87 both that copyright notice and this permission notice appear in
88 supporting documentation. 
89 .SH AUTHOR
90 Scott Graves <spot@cs.cmu.edu>.
91
92 Ability to run standalone or with \fIxscreensaver\fP added by 
93 Jamie Zawinski <jwz@jwz.org>, 18-Oct-93.