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] [\-delay \fIusecs\fP] [\-radius \fIpixels\fP]
   8 [\-speed \fIint\fP] [\-number \fIint\fP] [\-swamp] [\-bounce] [\-reflect]
   9 [\-vortex] [\-magnify] [\-blackhole] [\-slow] [\-shm] [\-no\-shm]
  10 .SH DESCRIPTION
  11 The \fIdistort\fP program takes an image and lets circular zones of
  12 distortion wander randomly around it, distorting what is under them.
  13 The mode of distortion and the overall behaviour of the zones can be
  14 influenced in various ways.
  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 distort
  26 accepts the following options:
  27 .TP 8
  28 .B \-root
  29 Draw on the root window.
  30 .TP 8
  31 .B \-window
  32 Draw on a newly-created window. This is the default.
  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 \-noinstall
  41 Don't 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
  45 class or the id number (decimal or hex) of a specific visual.
  46 .TP 8
  47 .B \-window\-id \fIwindow\-id\fP
  48 Specify which window id to use.
  49 .TP 8
  50 .B \-delay \fIusecs\fP
  51 Specify the delay between subsequent animation frames in microseconds.
  52 .TP 8
  53 .B \-radius \fIpixels\fP
  54 Specify the radius of the distortion zone in pixels.
  55 .TP 8
  56 .B \-speed \fIint\fP
  57 Specify the speed at which the distortion zone moves, where 0 is slow,
  58 higher numbers are faster (10 is pretty fast.)
  59 .TP 8
  60 .B \-number \fIint\fP
  61 Specify the number of distortion zones.
  62 .TP 8
  63 .B \-swamp
  64 Instead of letting zones wander around, let small zones pop up like
  65 bubbles in a swamp and leave permanent distortion.
  66 .TP 8
  67 .B \-bounce
  68 Let zones wander around and bounce off the window border. This is the
  69 default.
  70 .TP 8
  71 .B \-reflect
  72 Mode of distortion that resembles reflection by a cylindrical mirror.
  73 .TP 8
  74 .B \-vortex
  75 Whirlpool-shaped distortion. Way cool.
  76 .TP 8
  77 .B \-magnify
  78 This mode of distortion looks like a magnifying glass.
  79 .TP 8
  80 .B \-blackhole
  81 Suck your pixels beyond the event horizon. Favourite mode of Dr
  82 Stephen Hawking.
  83 .TP 8
  84 .B \-slow
  85 Make the zone wander slower.
  86 .TP 8
  87 .B \-shm
  88 Use shared memory extension.
  89 .TP 8
  90 .B \-no\-shm
  91 Don't use shared memory extension.
  92 .SH ENVIRONMENT
  93 .PP
  94 .TP 8
  95 .B DISPLAY
  96 to get the default host and display number
  97 .TP 8
  98 .B XENVIRONMENT
  99 to get the name of a resource file that overrides the global resources
 100 stored in the RESOURCE_MANAGER property.
 101 .SH SEE ALSO
 102 .BR X (1),
 103 .BR xscreensaver (1),
 104 .BR xscreensaver\-demo (1),
 105 .BR xscreensaver\-getimage (1)
 106 .SH COPYRIGHT
 107 Copyright \(co 1998 by Jonas Munsin and Jamie Zawinski.  Permission to use,
 108 copy, modify, distribute, and sell this software and its documentation for
 109 any purpose is hereby granted without fee, provided that the above
 110 copyright notice appear in all copies and that both that copyright
 111 notice and this permission notice appear in supporting documentation.
 112 No representations are made about the suitability of this software for
 113 any purpose.  It is provided "as is" without express or implied
 114 warranty.
 115 .SH AUTHORS
 116 Jonas Munsin <jmunsin@iki.fi> and Jamie Zawinski <jwz@jwz.org>.
 117 This manual page by Matthias Warkus <mawa@iname.com>, 17-Oct-1999.