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