http://www.tienza.es/crux/src/www.jwz.org/xscreensaver/xscreensaver-5.06.tar.gz
[xscreensaver] / hacks / rotzoomer.man
1 .TH XScreenSaver 1 "14-Mar-01" "X Version 11"
2 .SH NAME
3 rotzoomer - animated rotations and scalings of portions of the screen
4 .SH SYNOPSIS
5 .B rotzoomer
6 [\-display \fIhost:display.screen\fP]
7 [\-move | \-no\-move]
8 [\-delay \fImillisecs\fP]
9 [\-duration \fIsecs\fP]
10 [\-n \fIcount\fP]
11 [\-shm | \-no\-shm]
12 [\-window] [\-root] [\-install] [\-visual \fIvisual\fP]
13 .SH DESCRIPTION
14 The \fIrotzoomer\fP program grabs an image, then picks
15 rectangles and draws scaled and rotated animations of that 
16 section.
17
18 The image that it manipulates will be grabbed from the portion of
19 the screen underlying the window, or from the system's video input,
20 or from a random file on disk, as indicated by
21 the \fIgrabDesktopImages\fP, \fIgrabVideoFrames\fP,
22 and \fIchooseRandomImages\fP options in the \fI~/.xscreensaver\fP
23 file; see
24 .BR xscreensaver-demo (1)
25 for more details.
26 .SH OPTIONS
27 .I rotzoomer
28 accepts the following options:
29 .TP 8
30 .B \-window
31 Draw on a newly-created window.  This is the default.
32 .TP 8
33 .B \-root
34 Draw on the root window.
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 \-delay \fImilliseconds\fP
44 How much of a delay should be introduced between steps of the animation.
45 Default 10, or about 1/100th second.
46 .TP 8
47 .B \-duration \fIseconds\fP
48 How long to run before loading a new image.  Default 120 seconds.
49 .TP 8
50 .B \-move
51 Make the rectangles should wander around the screen.
52 .TP 8
53 .B \-no\-move
54 Make the rectangles be stationary.  This is the default.
55 .TP 8
56 .B \-n \fIcount\fP
57 How many rectangles to animate simultaneously.  Default 2.
58 .TP 8
59 .B \-no\-shm
60 Disable use of the SHM extension, even if it appears to be available.
61 .SH ENVIRONMENT
62 .PP
63 .TP 8
64 .B DISPLAY
65 to get the default host and display number.
66 .TP 8
67 .B XENVIRONMENT
68 to get the name of a resource file that overrides the global resources
69 stored in the RESOURCE_MANAGER property.
70 .SH SEE ALSO
71 .BR X (1),
72 .BR xscreensaver (1),
73 .BR xscreensaver\-demo (1),
74 .BR xscreensaver\-getimage (1)
75 .SH COPYRIGHT
76 Copyright \(co 2001 by Claudio Matsuoka.  Permission to use, copy, modify, 
77 distribute, and sell this software and its documentation for any purpose is 
78 hereby granted without fee, provided that the above copyright notice appear 
79 in all copies and that both that copyright notice and this permission notice
80 appear in supporting documentation.  No representations are made about the 
81 suitability of this software for any purpose.  It is provided "as is" without
82 express or implied warranty.
83 .SH AUTHOR
84 Claudio Matsuoka <claudio@helllabs.org>