a66dfda3b19697eed431e93a59e968151b9ebe5d
[xscreensaver] / hacks / fireworkx.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 fireworkx - pyrotechnics simulation eye-candy.
4 .SH SYNOPSIS
5 .B fireworkx
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-verbose]
11 [\-fade]
12 [\-nolight]
13 [\-shoot]
14 [\-delay \fInumber\fP]
15 [\-maxlife \fInumber\fP]
16 .SH DESCRIPTION
17 Simulates fireworks (pyrotechnics); explodes better on faster machines.
18 .SH OPTIONS
19 .TP 8
20 .B \-visual \fIvisual\fP
21 Specify which visual to use.  Legal values are the name of a visual class,
22 or the id number (decimal or hex) of a specific visual.
23 .TP 8
24 .B \-window
25 Draw on a newly-created window.  This is the default.
26 .TP 8
27 .B \-root
28 Draw on the root window.
29 .TP 8
30 .B \-nolight
31 Turns off light effect; runs faster.
32 .TP 8
33 .B \-fade
34 Cuts the extra blur; looks more realistic.
35 .TP 8
36 .B \-shoot
37 Shows shooting of the shells.
38 .TP 8
39 .B \-delay \fInumber\fP
40 Delay between frames. In microseconds. 
41 .TP 8
42 .B \-maxlife \fInumber\fP
43 Maximum decay period for an explosion. (Default: 1200)
44 .TP 8
45 .B \-verbose
46 Listen what the program have to say, via console.
47 .SH ENVIRONMENT
48 .PP
49 .TP 8
50 .B DISPLAY
51 to get the default host and display number.
52 .TP 8
53 .B XENVIRONMENT
54 to get the name of a resource file that overrides the global resources
55 stored in the RESOURCE_MANAGER property.
56 .SH SEE ALSO
57 .BR X (1),
58 .BR xscreensaver (1)
59 .SH COPYRIGHT
60 Copyright \(co 1999-2004 by Rony B Chandran.  Permission to use, copy, modify, 
61 distribute, and sell this software and its documentation for any purpose is 
62 hereby granted without fee, provided that the above copyright notice appear 
63 in all copies and that both that copyright notice and this permission notice
64 appear in supporting documentation.  No representations are made about the 
65 suitability of this software for any purpose.  It is provided "as is" without
66 express or implied warranty.
67 .SH AUTHOR
68 Written by Rony B Chandran <ronybc@asia.com>
69
70 Added support for different display color modes
71 by Jean-Pierre Demailly <Jean-Pierre.Demailly@ujf-grenoble.fr>
72
73 .SH URL 
74 http://www.ronybc.8k.com
75