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