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