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

   1 .TH XScreenSaver 1 "" "X Version 11"
   2 .SH NAME
   3 ripples - interference patterns.
   4 .SH SYNOPSIS
   5 .B ripples
   6 [\-display \fIhost:display.screen\fP]
   7 [\-visual \fIvisual\fP]
   8 [\-window]
   9 [\-root]
  10 [\-delay \fInumber\fP]
  11 [\-duration \fIsecs\fP]
  12 [\-rate \fInumber\fP]
  13 [\-fluidity \fInumber\fP]
  14 [\-light \fInumber\fP]
  15 [\-water]
  16 [\-stir]
  17 [\-oily]
  18 [\-grayscale]
  19 [\-colors \fInumber\fP]
  20 [\-no-shm]
  21 .SH DESCRIPTION
  22 This draws rippling interference patterns like splashing water. With the
  23 -water option, it manipulates your desktop image to look like something is
  24 dripping into it.
  25 .SH OPTIONS
  26 .TP 8
  27 .B \-visual \fIvisual\fP
  28 Specify which visual to use.  Legal values are the name of a visual class,
  29 or the id number (decimal or hex) of a specific visual.
  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 \-delay \fInumber\fP
  38 Per-frame delay, in microseconds.  Default: 50000 (0.05 seconds.).
  39 .TP 8
  40 .B \-duration \fIseconds\fP
  41 How long to run before loading a new image.  Default 120 seconds.
  42 .TP 8
  43 .B \-rate \fInumber\fP
  44 Drizzle.  1 - 100.  Default: 5.
  45 .TP 8
  46 .B \-fluidity \fInumber\fP
  47 Small Drops.  0 - 16.  Default: 6.
  48 .TP 8
  49 .B \-light \fInumber\fP
  50 Lighting Effect.  0 - 8.  Default: 0.
  51 .TP 8
  52 .B \-water | \-no-water
  53 Grab Screen Image.  Boolean.
  54 .TP 8
  55 .B \-stir | \-no-stir
  56 Moving Splashes.  Boolean.
  57 .TP 8
  58 .B \-oily | \-no-oily
  59 Psychedelic Colors.  Boolean.
  60 .TP 8
  61 .B \-grayscale
  62 Convert the screen image to grayscale.
  63 Ignored if we don't grab the screen image or if our screen doesn't have
  64 enough color depth.
  65 .TP 8
  66 .B \-colors \fInumber\fP
  67 Colors Two.  Default: 200.
  68 .TP 8
  69 .B \-shm | \-no-shm
  70 Use Shared Memory.  Boolean.
  71 .SH ENVIRONMENT
  72 .PP
  73 .TP 8
  74 .B DISPLAY
  75 to get the default host and display number.
  76 .TP 8
  77 .B XENVIRONMENT
  78 to get the name of a resource file that overrides the global resources
  79 stored in the RESOURCE_MANAGER property.
  80 .SH SEE ALSO
  81 .BR X (1),
  82 .BR xscreensaver (1)
  83 .SH COPYRIGHT
  84 Copyright \(co 2002 by Tom Hammersley.  Permission to use, copy, modify,
  85 distribute, and sell this software and its documentation for any purpose is
  86 hereby granted without fee, provided that the above copyright notice appear
  87 in all copies and that both that copyright notice and this permission notice
  88 appear in supporting documentation.  No representations are made about the
  89 suitability of this software for any purpose.  It is provided "as is" without
  90 express or implied warranty.
  91 .SH AUTHOR
  92 Tom Hammersley.