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