http://www.jwz.org/xscreensaver/xscreensaver-5.10.tar.gz
[xscreensaver] / hacks / zoom.man
1 .TH XScreenSaver 1 "20-Nov-2000" "X Version 11"
2 .SH NAME
3 zoom - wander around magnified desktop
4 .SH SYNOPSIS
5 .B zoom
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP]
7 [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install]
8 [\-visual \fIvisual\fP]
9 [\-delay \fIusecs\fP]
10 [\-duration \fIsecs\fP]
11 [\-lenses]
12 [\-pixwidth \fIpixels\fP] [\-pixheight \fIpixels\fP]
13 [\-pixspacex \fIpixels\fP] [\-pixspacey \fIpixels\fP]
14 [\-lensoffsetx \fIpixels\fP] [\-lensoffsety \fIpixels\fP]
15 [\-fps]
16 .SH DESCRIPTION
17 The \fIzoom\fP program takes an image, magnifies it, and scrolls around
18 it, fatbits-style.
19
20 The image that it manipulates will be grabbed from the portion of
21 the screen underlying the window, or from the system's video input,
22 or from a random file on disk, as indicated by
23 the \fIgrabDesktopImages\fP, \fIgrabVideoFrames\fP,
24 and \fIchooseRandomImages\fP options in the \fI~/.xscreensaver\fP
25 file; see
26 .BR xscreensaver-demo (1)
27 for more details.
28 .SH OPTIONS
29 .I zoom
30 accepts the following options:
31 .TP 8
32 .B \-window
33 Draw on a newly-created window.  This is the default.
34 .TP 8
35 .B \-root
36 Draw on the root window.
37 .TP 8
38 .B \-mono 
39 If on a color display, pretend we're on a monochrome display.
40 .TP 8
41 .B \-install
42 Install a private colormap for the window.
43 .TP 8
44 .B \-visual \fIvisual\fP
45 Specify which visual to use.  Legal values are the name of a visual class,
46 or the id number (decimal or hex) of a specific visual.
47 .TP 8
48 .B \-delay \fImicroseconds\fP
49 Slow it down.
50 .TP 8
51 .B \-duration \fIseconds\fP
52 How long to run before loading a new image.  Default 120 seconds.
53 .TP 8
54 .B \-lenses
55 Instead of doing magnification we just copy an offset region from the original
56 image.  If lensoffsetx < pixwidth (and similarly for Y) then consecutive
57 regions will overlap, giving the effect of looking through an array of
58 lenses.
59 .TP 8
60 .B \-pixwidth \fIpixels\fP
61 Width of the magnified pixels.
62 .TP 8
63 .B \-pixheight \fIpixels\fP
64 Height of the magnified pixels.
65 .TP 8
66 .B \-pixspacex \fIpixels\fP
67 Amount of black space between magnified pixels (X direction).
68 .TP 8
69 .B \-pixspacey \fIpixels\fP
70 Amount of black space between magnified pixels (Y direction).
71 .TP 8
72 .B \-lensoffsetx \fIpixels\fP
73 Distance in X direction between consecutive copied regions (only effective
74 when 
75 .I -lenses
76 used).
77 .TP 8
78 .B \-lensoffsety \fIpixels\fP
79 Distance in Y direction between consecutive copied regions (only effective
80 when 
81 .I -lenses
82 used).
83 .TP 8
84 .SH ENVIRONMENT
85 .PP
86 .TP 8
87 .B DISPLAY
88 to get the default host and display number.
89 .TP 8
90 .B XENVIRONMENT
91 to get the name of a resource file that overrides the global resources
92 stored in the RESOURCE_MANAGER property.
93 .SH SEE ALSO
94 .BR X (1),
95 .BR xscreensaver (1),
96 .BR xscreensaver\-demo (1),
97 .BR xscreensaver\-getimage (1)
98 .SH COPYRIGHT
99 Copyright \(co 2000 by James Macnicol.  Permission to use, copy, modify, 
100 distribute, and sell this software and its documentation for any purpose is 
101 hereby granted without fee, provided that the above copyright notice appear 
102 in all copies and that both that copyright notice and this permission notice
103 appear in supporting documentation.  No representations are made about the 
104 suitability of this software for any purpose.  It is provided "as is" without
105 express or implied warranty.
106 .SH AUTHOR
107 James Macnicol <james.macnicol@mailexcite.com>, 20-Nov-2000.  Much code was
108 shamelessly stolen from the 
109 .B spotlight 
110 hack and a few others.
111