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]
   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 .SH DESCRIPTION
  16 The \fIzoom\fP program takes an image, magnifies it, and scrolls around
  17 it, fatbits-style.
  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 zoom
  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 \-mono
  38 If on a color display, pretend we're on a monochrome display.
  39 .TP 8
  40 .B \-install
  41 Install a private colormap for the window.
  42 .TP 8
  43 .B \-visual \fIvisual\fP
  44 Specify which visual to use.  Legal values are the name of a visual class,
  45 or the id number (decimal or hex) of a specific visual.
  46 .TP 8
  47 .B \-delay \fImicroseconds\fP
  48 Slow it down.
  49 .TP 8
  50 .B \-duration \fIseconds\fP
  51 How long to run before loading a new image.  Default 120 seconds.
  52 .TP 8
  53 .B \-lenses
  54 Instead of doing magnification we just copy an offset region from the original
  55 image.  If lensoffsetx < pixwidth (and similarly for Y) then consecutive
  56 regions will overlap, giving the effect of looking through an array of
  57 lenses.
  58 .TP 8
  59 .B \-pixwidth \fIpixels\fP
  60 Width of the magnified pixels.
  61 .TP 8
  62 .B \-pixheight \fIpixels\fP
  63 Height of the magnified pixels.
  64 .TP 8
  65 .B \-pixspacex \fIpixels\fP
  66 Amount of black space between magnified pixels (X direction).
  67 .TP 8
  68 .B \-pixspacey \fIpixels\fP
  69 Amount of black space between magnified pixels (Y direction).
  70 .TP 8
  71 .B \-lensoffsetx \fIpixels\fP
  72 Distance in X direction between consecutive copied regions (only effective
  73 when
  74 .I -lenses
  75 used).
  76 .TP 8
  77 .B \-lensoffsety \fIpixels\fP
  78 Distance in Y direction between consecutive copied regions (only effective
  79 when
  80 .I -lenses
  81 used).
  82 .TP 8
  83 .SH ENVIRONMENT
  84 .PP
  85 .TP 8
  86 .B DISPLAY
  87 to get the default host and display number.
  88 .TP 8
  89 .B XENVIRONMENT
  90 to get the name of a resource file that overrides the global resources
  91 stored in the RESOURCE_MANAGER property.
  92 .SH SEE ALSO
  93 .BR X (1),
  94 .BR xscreensaver (1),
  95 .BR xscreensaver\-demo (1),
  96 .BR xscreensaver\-getimage (1)
  97 .SH COPYRIGHT
  98 Copyright \(co 2000 by James Macnicol.  Permission to use, copy, modify,
  99 distribute, and sell this software and its documentation for any purpose is
 100 hereby granted without fee, provided that the above copyright notice appear
 101 in all copies and that both that copyright notice and this permission notice
 102 appear in supporting documentation.  No representations are made about the
 103 suitability of this software for any purpose.  It is provided "as is" without
 104 express or implied warranty.
 105 .SH AUTHOR
 106 James Macnicol <james.macnicol@mailexcite.com>, 20-Nov-2000.  Much code was
 107 shamelessly stolen from the
 108 .B spotlight
 109 hack and a few others.
 110