http://packetstorm.tacticalflex.com/UNIX/admin/xscreensaver-3.27.tar.gz
[xscreensaver] / hacks / zoom.man
1 .TH XScreenSaver 1 "20-Nov-2000" "X Version 11"
2 .SH NAME
3 zoom - wander around magified desktop
4 .SH SYNOPSIS
5 .B zoom
6 [\-display \fIhost:display.screen\fP] [\-foreground \fIcolor\fP] [\-background \fIcolor\fP] [\-window] [\-root] [\-mono] [\-install] [\-visual \fIvisual\fP] [\-delay \fIusecs\fP] [\-lenses] [\-pixwidth \fIpixels\fP] [\-pixheight \fIpixels\fP] [\-pixspacex \fIpixels\fP] [\-pixspacey \fIpixels\fP] [\-lensoffsetx \fIpixels\fP] [\-lensoffsety \fIpixels\fP]
7 .SH DESCRIPTION
8 The \fIzoom\fP program magnifies a portion of the desktop and moves around.
9 .SH OPTIONS
10 .I zoom
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 \-delay \fImicroseconds\fP
30 Slow it down.
31 .TP 8
32 .B \-lenses
33 Instead of doing magnification we just copy an offset region from the original
34 image.  If lensoffsetx < pixwidth (and similarly for Y) then consecutive
35 regions will overlap, giving the effect of looking through an array of
36 lenses.
37 .TP 8
38 .B \-pixwidth \fIpixels\fP
39 Width of the magnified pixels.
40 .TP 8
41 .B \-pixheight \fIpixels\fP
42 Height of the magnified pixels.
43 .TP 8
44 .B \-pixspacex \fIpixels\fP
45 Amount of black space between magnified pixels (X direction).
46 .TP 8
47 .B \-pixspacey \fIpixels\fP
48 Amount of black space between magnified pixels (Y direction).
49 .TP 8
50 .B \-lensoffsetx \fIpixels\fP
51 Distance in X direction between consective copied regions (only effective
52 when 
53 .I -lenses
54 used).
55 .TP 8
56 .B \-lensoffsety \fIpixels\fP
57 Distance in Y direction between consective copied regions (only effective
58 when 
59 .I -lenses
60 used).
61 .TP 8
62 .SH ENVIRONMENT
63 .PP
64 .TP 8
65 .B DISPLAY
66 to get the default host and display number.
67 .TP 8
68 .B XENVIRONMENT
69 to get the name of a resource file that overrides the global resources
70 stored in the RESOURCE_MANAGER property.
71 .SH SEE ALSO
72 .BR X (1),
73 .BR xscreensaver (1)
74 .SH COPYRIGHT
75 Copyright \(co 2000 by James Macnicol.  Permission to use, copy, modify, 
76 distribute, and sell this software and its documentation for any purpose is 
77 hereby granted without fee, provided that the above copyright notice appear 
78 in all copies and that both that copyright notice and this permission notice
79 appear in supporting documentation.  No representations are made about the 
80 suitability of this software for any purpose.  It is provided "as is" without
81 express or implied warranty.
82 .SH AUTHOR
83 James Macnicol <james.macnicol@mailexcite.com>, 20-Nov-2000.  Much code was
84 shamelessly stolen from the 
85 .B spotlight 
86 hack and a few others.
87