827c94e04163d3b368b09384c3c2f5d6915bc878
[xscreensaver] / hacks / metaballs.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 MetaBalls.
4 .SH SYNOPSIS
5 .B MetaBalls
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-ncolors \fInumber\fP]
11 [\-count \fInumber\fP]
12 [\-delay \fInumber\fP]
13 [\-cycles \fInumber\fP]
14 [\-radius \fInumber\fP]
15 [\-delta \fInumber\fP]
16 [\-fps]
17 .SH DESCRIPTION
18 This hack draws 2D metaballs to the screen by calculating the sum of the colors of all metaballs covering a pixel. 
19 Ported from the demo effects collection (http://demo-effects.sourceforge.net)
20 .SH OPTIONS
21 .TP 8
22 .B \-visual \fIvisual\fP
23 Specify which visual to use.  Legal values are the name of a visual class,
24 or the id number (decimal or hex) of a specific visual.
25 .TP 8
26 .B \-window
27 Draw on a newly-created window.  This is the default.
28 .TP 8
29 .B \-root
30 Draw on the root window.
31 .TP 8
32 .B \-ncolors \fInumber\fP
33 Number of Colors.  Default: 256.
34 .TP 8
35 .B \-count \fInumber\fP
36 Number of MetaBalls.    2 - 255.  Default: 10.
37 .TP 8
38 .B \-delay \fInumber\fP
39 Per-frame delay, in microseconds.  Default: 5000 (0.005 seconds.).
40 .TP 8
41 .B \-cycles \fInumber\fP
42 Duration.  100 - 3000.  Default: 1000.
43 .TP 8
44 .B \-radius \fInumber\fP
45 MetaBall Radius.  2 - 100.  Default: 100.
46 .TP 8
47 .B \-delta \fInumber\fP
48 MetaBall Movement.  1 - 20.  Default: 3.
49 .TP 8
50 .B \-fps
51 Display the current frame rate and CPU load.
52 .SH ENVIRONMENT
53 .PP
54 .TP 8
55 .B DISPLAY
56 to get the default host and display number.
57 .TP 8
58 .B XENVIRONMENT
59 to get the name of a resource file that overrides the global resources
60 stored in the RESOURCE_MANAGER property.
61 .SH SEE ALSO
62 .BR X (1),
63 .BR xscreensaver (1)
64 .SH COPYRIGHT
65 Copyright \(co 2002-2003 by W.P. van Paassen.  Permission to use, copy, modify, 
66 distribute, and sell this software and its documentation for any purpose is 
67 hereby granted without fee, provided that the above copyright notice appear 
68 in all copies and that both that copyright notice and this permission notice
69 appear in supporting documentation.  No representations are made about the 
70         suitability of this software for any purpose.  It is provided "as is" without
71 express or implied warranty.
72 .SH AUTHOR
73 W.P. van Paassen