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

   1 .TH XScreenSaver 1 "27-Feb-00" "X Version 11"
   2 .SH NAME
   3 xflame - draws animated flames
   4 .SH SYNOPSIS
   5 .B xflame
   6 [\-display \fIhost:display.screen\fP] [\-window] [\-root] [\-install]
   7 [\-visual \fIvisual\fP]
   8 [\-foreground \fIcolor\fP]
   9 [\-hspread \fIint\fP] [\-vspread \fIint\fP]
  10 [\-residual \fIint\fP] [\-variance \fIint\fP] [\-vartrend \fIint\fP]
  11 [\-bloom \| \-no\-bloom]
  12 [\-bitmap \fIxbm\-file\fP] [\-baseline \fIint\fP]
  13 [\-fps]
  14 .SH DESCRIPTION
  15 The \fIxflame\fP program draws animated flames across the bottom of the
  16 screen.  The flames occasionally flare up.  If a bitmap is specified,
  17 that image will float above the flames, burning.
  18 .SH OPTIONS
  19 .I xflame
  20 accepts the following options:
  21 .TP 8
  22 .B \-window
  23 Draw on a newly-created window.  This is the default.
  24 .TP 8
  25 .B \-root
  26 Draw on the root window.
  27 .TP 8
  28 .B \-install
  29 Install a private colormap for the window.
  30 .TP 8
  31 .B \-visual \fIvisual\fP\fP
  32 Specify which visual to use.  Legal values are the name of a visual class,
  33 or the id number (decimal or hex) of a specific visual.
  34 .TP 8
  35 .B \-foreground \fIcolor\fP\fP or \fB\-fg\fP \fIcolor\fP\fP
  36 The color of the flames; default red.  (The background color is always black.)
  37 .TP 8
  38 .B \-bitmap \fIfilename\fP\fP
  39 Specifies the bitmap file to use (a monochrome XBM file.)
  40 The name "none" means not to use a bitmap at all.
  41 If unspecified, a built-in image will be used.
  42 .PP
  43 The other options are arcane.  If someone would care to document them,
  44 that would be great.
  45 .TP 8
  46 .B \-fps
  47 Display the current frame rate and CPU load.
  48 .SH ENVIRONMENT
  49 .PP
  50 .TP 8
  51 .B DISPLAY
  52 to get the default host and display number.
  53 .TP 8
  54 .B XENVIRONMENT
  55 to get the name of a resource file that overrides the global resources
  56 stored in the RESOURCE_MANAGER property.
  57 .SH SEE ALSO
  58 .BR X (1),
  59 .BR xscreensaver (1)
  60 .SH COPYRIGHT
  61 Copyright \(co 1996-1999 by Carsten Haitzler.  Permission to use, copy,
  62 modify, distribute, and sell this software and its documentation for
  63 any purpose is hereby granted without fee, provided that the above
  64 copyright notice appear in all copies and that both that copyright
  65 notice and this permission notice appear in supporting documentation.
  66 No representations are made about the suitability of this software for
  67 any purpose.  It is provided "as is" without express or implied
  68 warranty.
  69 .SH AUTHOR
  70 Primarily written by Carsten Haitzler <raster@redhat.com>.
  71 Modified over the years by Rahul Jain <rahul@rice.edu>,
  72 Daniel Zahn <stumpy@religions.com>, and Jamie Zawinski <jwz@jwz.org>.