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

   1 .TH XScreenSaver 1 "" "X Version 11"
   2 .SH NAME
   3 Eruption.
   4 .SH SYNOPSIS
   5 .B Eruption
   6 [\-display \fIhost:display.screen\fP]
   7 [\-visual \fIvisual\fP]
   8 [\-window]
   9 [\-root]
  10 [\-ncolors \fInumber\fP]
  11 [\-nParticles \fInumber\fP]
  12 [\-Heat \fInumber\fP]
  13 [\-Cooling \fInumber\fP]
  14 [\-Gravity \fInumber\fP]
  15 [\-delay \fInumber\fP]
  16 [\-cycles \fInumber\fP]
  17 .SH DESCRIPTION
  18 This hack creates an eruption of pieces of hot volcanic rock.
  19 Ported from the demo effects collection (http://demo-effects.sourceforge.net)
  20 .SH OPTIONS
  21 .TP 8
  22 .B \-visual \fIvisual\fP
  23 Specify which visual to use.  Legal values are the name of a visual class,
  24 or the id number (decimal or hex) of a specific visual.
  25 .TP 8
  26 .B \-window
  27 Draw on a newly-created window.  This is the default.
  28 .TP 8
  29 .B \-root
  30 Draw on the root window.
  31 .TP 8
  32 .B \-ncolors \fInumber\fP
  33 Number of Colors.  Default: 256.
  34 .TP 8
  35 .B \-particles \fInumber\fP
  36 Number of Particles. Default: 300.
  37 .TP 8
  38 .B \-cooloff \fInumber\fP
  39 Eruption Cooloff. Default: 2.
  40 .TP 8
  41 .B \-heat \fInumber\fP
  42 Heat of Eruption. Default: 256.
  43 .TP 8
  44 .B \-gravity \fInumber\fP
  45 Gravity. Default: 1.
  46 .TP 8
  47 .B \-delay \fInumber\fP
  48 Per-frame delay, in microseconds.  Default: 5000 (0.01 seconds.).
  49 .TP 8
  50 .B \-cycles \fInumber\fP
  51 Duration.  10 - 3000.  Default: 80.
  52 .SH ENVIRONMENT
  53 .PP
  54 .TP 8
  55 .B DISPLAY
  56 to get the default host and display number.
  57 .TP 8
  58 .B XENVIRONMENT
  59 to get the name of a resource file that overrides the global resources
  60 stored in the RESOURCE_MANAGER property.
  61 .SH SEE ALSO
  62 .BR X (1),
  63 .BR xscreensaver (1)
  64 .SH COPYRIGHT
  65 Copyright \(co 2002-2003 by W.P. van Paassen.  Permission to use, copy, modify,
  66 distribute, and sell this software and its documentation for any purpose is
  67 hereby granted without fee, provided that the above copyright notice appear
  68 in all copies and that both that copyright notice and this permission notice
  69 appear in supporting documentation.  No representations are made about the
  70         suitability of this software for any purpose.  It is provided "as is" without
  71 express or implied warranty.
  72 .SH AUTHOR
  73 W.P. van Paassen