git.hungrycats.org Git - xscreensaver/blob - hacks/distort.man

   1 .TH XScreenSaver 1 "17-Oct-99" "X Version 11"
   2 .SH NAME
   3 distort \- distort the content of the screen in interesting ways
   4 .SH SYNOPSIS
   5 .B distort
   6 [\-root] [\-window] [\-mono] [\-install] [\-noinstall] [\-visual \fIvisual\fP]
   7 [\-window\-id \fIwindow\-id\fP]
   8 [\-delay \fIusecs\fP]
   9 [\-duration \fIsecs\fP]
  10 [\-radius \fIpixels\fP]
  11 [\-speed \fIint\fP]
  12 [\-number \fIint\fP]
  13 [\-swamp]
  14 [\-bounce]
  15 [\-reflect]
  16 [\-vortex]
  17 [\-magnify]
  18 [\-blackhole]
  19 [\-slow]
  20 [\-shm] [\-no\-shm]
  21 .SH DESCRIPTION
  22 The \fIdistort\fP program takes an image and lets circular zones of
  23 distortion wander randomly around it, distorting what is under them.
  24 The mode of distortion and the overall behaviour of the zones can be
  25 influenced in various ways.
  26
  27 The image that it manipulates will be grabbed from the portion of
  28 the screen underlying the window, or from the system's video input,
  29 or from a random file on disk, as indicated by
  30 the \fIgrabDesktopImages\fP, \fIgrabVideoFrames\fP,
  31 and \fIchooseRandomImages\fP options in the \fI~/.xscreensaver\fP
  32 file; see
  33 .BR xscreensaver-demo (1)
  34 for more details.
  35 .SH OPTIONS
  36 .I distort
  37 accepts the following options:
  38 .TP 8
  39 .B \-root
  40 Draw on the root window.
  41 .TP 8
  42 .B \-window
  43 Draw on a newly-created window. This is the default.
  44 .TP 8
  45 .B \-mono
  46 If on a color display, pretend we're on a monochrome display.
  47 .TP 8
  48 .B \-install
  49 Install a private colormap for the window.
  50 .TP 8
  51 .B \-noinstall
  52 Don't install a private colormap for the window.
  53 .TP 8
  54 .B \-visual \fIvisual\fP
  55 Specify which visual to use. Legal values are the name of a visual
  56 class or the id number (decimal or hex) of a specific visual.
  57 .TP 8
  58 .B \-window\-id \fIwindow\-id\fP
  59 Specify which window id to use.
  60 .TP 8
  61 .B \-delay \fIusecs\fP
  62 Specify the delay between subsequent animation frames in microseconds.
  63 .TP 8
  64 .B \-duration \fIseconds\fP
  65 How long to run before loading a new image.  Default 120 seconds.
  66 .TP 8
  67 .B \-radius \fIpixels\fP
  68 Specify the radius of the distortion zone in pixels.
  69 .TP 8
  70 .B \-speed \fIint\fP
  71 Specify the speed at which the distortion zone moves, where 0 is slow,
  72 higher numbers are faster (10 is pretty fast.)
  73 .TP 8
  74 .B \-number \fIint\fP
  75 Specify the number of distortion zones.
  76 .TP 8
  77 .B \-swamp
  78 Instead of letting zones wander around, let small zones pop up like
  79 bubbles in a swamp and leave permanent distortion.  \fBWARNING:\fP
  80 this option uses a \fIcolossal\fP amount of memory: keep the \fI\-radius\fP
  81 small when using \fI\-swamp\fP.
  82 .TP 8
  83 .B \-bounce
  84 Let zones wander around and bounce off the window border. This is the
  85 default.
  86 .TP 8
  87 .B \-reflect
  88 Mode of distortion that resembles reflection by a cylindrical mirror.
  89 .TP 8
  90 .B \-vortex
  91 Whirlpool-shaped distortion. Way cool.
  92 .TP 8
  93 .B \-magnify
  94 This mode of distortion looks like a magnifying glass.
  95 .TP 8
  96 .B \-blackhole
  97 Suck your pixels beyond the event horizon. Favourite mode of Dr
  98 Stephen Hawking.
  99 .TP 8
 100 .B \-slow
 101 Make the zone wander slower.
 102 .TP 8
 103 .B \-shm
 104 Use shared memory extension.
 105 .TP 8
 106 .B \-no\-shm
 107 Don't use shared memory extension.
 108 .SH ENVIRONMENT
 109 .PP
 110 .TP 8
 111 .B DISPLAY
 112 to get the default host and display number
 113 .TP 8
 114 .B XENVIRONMENT
 115 to get the name of a resource file that overrides the global resources
 116 stored in the RESOURCE_MANAGER property.
 117 .SH SEE ALSO
 118 .BR X (1),
 119 .BR xscreensaver (1),
 120 .BR xscreensaver\-demo (1),
 121 .BR xscreensaver\-getimage (1)
 122 .SH COPYRIGHT
 123 Copyright \(co 1998 by Jonas Munsin and Jamie Zawinski.  Permission to use,
 124 copy, modify, distribute, and sell this software and its documentation for
 125 any purpose is hereby granted without fee, provided that the above
 126 copyright notice appear in all copies and that both that copyright
 127 notice and this permission notice appear in supporting documentation.
 128 No representations are made about the suitability of this software for
 129 any purpose.  It is provided "as is" without express or implied
 130 warranty.
 131 .SH AUTHORS
 132 Jonas Munsin <jmunsin@iki.fi> and Jamie Zawinski <jwz@jwz.org>.
 133 This manual page by Matthias Warkus <mawa@iname.com>, 17-Oct-1999.