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