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