a3e9d902f5fc65aeff5ad9a978dc1c443d8c0251
[xscreensaver] / local / man / man.1 / slidescreen.1
1 .TH XScreenSaver 1 "24-Nov-97" "X Version 11"
2 .SH NAME
3 slidescreen - permute the screen image like an 8-puzzle
4 .SH SYNOPSIS
5 .B slidescreen
6 [\-display \fIhost:display.screen\fP] [\-background \fIcolor\fP] [\-grid-size \fIpixels\fP] [\-ibw \fIpixels\fP] [\-increment \fIpixels\fP] [\-delay \fIusecs\fP] [\-delay2 \fIusecs\fP] [\-window] [\-root] [\-install] [\-visual \fIvisual\fP]
7 .SH DESCRIPTION
8 The \fIslidescreen\fP program takes an image of the screen, divides it into
9 a grid, deletes a random square of that grid, and then randomly slides 
10 one of the neighbors of this "hole" into the hole (and repeat.)
11 .SH OPTIONS
12 .I slidescreen
13 accepts the following options:
14 .TP 8
15 .B \-window
16 Draw on a newly-created window.  This is the default.
17 .TP 8
18 .B \-root
19 Draw on the root window.
20 .TP 8
21 .B \-install
22 Install a private colormap for the window.
23 .TP 8
24 .B \-visual \fIvisual\fP
25 Specify which visual to use.  Legal values are the name of a visual class,
26 or the id number (decimal or hex) of a specific visual.
27 .TP 8
28 .B \-grid-size \fIpixels\fP
29 The size of the grid cells.  Default 70 pixels.
30 .TP 8
31 .B \-ibw \fIpixels\fP
32 The size of the "gutter" between grid cells.  Default 1 pixel.
33 .TP 8
34 .B \-increment \fIpixels\fP
35 How many pixels by which a piece should be moved when sliding to a new 
36 location.  Default 10 pixels.
37 .TP 8
38 .B \-delay \fImicroseconds\fP
39 How much of a delay should be introduced between steps of the animation of
40 the motion of each segment.  Default 50000, which is 0.05 seconds.  This
41 is closely related to the \fI\-increment\fP parameter.
42 .TP 8
43 .B \-delay \fImicroseconds\fP
44 How much of a delay should be introduced between the end of the motion of
45 one segment and the beginning of the motion of another.  Default 1000000,
46 which is one second.
47 .SH RESOURCES
48 On some systems (currently, only SGIs), this program can, instead of grabbing
49 a desktop image, grab a frame of video from an external camera and manipulate
50 that instead.  The following resources control that.
51 .PP
52 .TP 8
53 .B grabVideoProbability \fR(Float)\fP
54 What portion of the time to grab video rather than a screen image, 
55 between 0.0 and 1.0.  Defaults to 0.5, or half the time.
56 .TP 8
57 .B videoDevice \fR(Integer)\fP
58 The number of the default video input device to check first.  If unspecified, 
59 the default camera (from videopanel(1)) will be checked first.  After that, all
60 other available video input devices will be checked in order.  
61
62 The first one which produces a non-black image will be used.  If all images
63 are black, the others will be re-checked a few times before giving up and
64 falling back to simply grabbing a desktop image (but note that this takes a
65 few seconds, so if you don't actually have any video sources hooked up, you
66 should consider turning off video grabbing by setting
67 \fBgrabVideoProbability\fP to 0.0.)
68 .TP 8
69 .B videoGain \fR(Float)\fP
70 The amount by which to brighten the grabbed image.  This defaults to 2.2.
71 .SH ENVIRONMENT
72 .PP
73 .TP 8
74 .B DISPLAY
75 to get the default host and display number.
76 .TP 8
77 .B XENVIRONMENT
78 to get the name of a resource file that overrides the global resources
79 stored in the RESOURCE_MANAGER property.
80 .SH SEE ALSO
81 .BR X (1),
82 .BR xscreensaver (1)
83 .SH COPYRIGHT
84 Copyright \(co 1992 by Jamie Zawinski.  Permission to use, copy, modify, 
85 distribute, and sell this software and its documentation for any purpose is 
86 hereby granted without fee, provided that the above copyright notice appear 
87 in all copies and that both that copyright notice and this permission notice
88 appear in supporting documentation.  No representations are made about the 
89 suitability of this software for any purpose.  It is provided "as is" without
90 express or implied warranty.
91 .SH AUTHOR
92 Jamie Zawinski <jwz@jwz.org>, 3-dec-92.