5e06b89f0dc17d60c79ee82ac490d6df212a1a65
[xscreensaver] / hacks / fluidballs.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 fluidballs - the physics of bouncing balls.
4 .SH SYNOPSIS
5 .B fluidballs
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-count \fInumber\fP]
11 [\-size \fInumber\fP]
12 [\-gravity \fInumber\fP]
13 [\-wind \fInumber\fP]
14 [\-friction \fInumber\fP]
15 [\-delay \fInumber\fP]
16 [\-nonrandom]
17 [\-no-shake]
18 [\-fps]
19 .SH DESCRIPTION
20 Models the physics of bouncing balls, or of particles in a gas or fluid,
21 depending on the settings. If "Shake Box" is selected, then every now and
22 then, the box will be rotated, changing which direction is down (in order
23 to keep the settled balls in motion.) 
24 .SH OPTIONS
25 .TP 8
26 .B \-visual \fIvisual\fP
27 Specify which visual to use.  Legal values are the name of a visual class,
28 or the id number (decimal or hex) of a specific visual.
29 .TP 8
30 .B \-window
31 Draw on a newly-created window.  This is the default.
32 .TP 8
33 .B \-root
34 Draw on the root window.
35 .TP 8
36 .B \-count \fInumber\fP
37 How many balls to display.  Default: 300.
38 .TP 8
39 .B \-size \fInumber\fP
40 Maximum size of each ball.  Default: 25.
41 .TP 8
42 .B \-gravity \fInumber\fP
43 Coefficient of gravity.  Useful values are < 0.1.  Default: 0.01.
44 .TP 8
45 .B \-wind \fInumber\fP
46 Wind.  Useful values are < 0.1.  Default: 0.00.
47 .TP 8
48 .B \-friction \fInumber\fP
49 Coefficient of friction (or viscosity.)  Useful values are < 4.  Default: 0.8.
50 .TP 8
51 .B \-delay \fInumber\fP
52 Per-frame delay, in microseconds.  Default: 10000 (0.01 seconds.).
53 .TP 8
54 .B \-nonrandom
55 Make all balls be the same size.
56 .TP 8
57 .B \-no-nonrandom
58 Make the balls be random sizes.  Default.
59 .TP 8
60 .B \-shake | \-no-shake
61 Whether to shake the box if the system seems to have settled down.
62 "Shake" means "change the direction of Down."
63 .TP 8
64 .B \-fps | \-no-fps
65 Whether to show a frames-per-second display at the bottom of the screen.
66 .SH ENVIRONMENT
67 .PP
68 .TP 8
69 .B DISPLAY
70 to get the default host and display number.
71 .TP 8
72 .B XENVIRONMENT
73 to get the name of a resource file that overrides the global resources
74 stored in the RESOURCE_MANAGER property.
75 .SH SEE ALSO
76 .BR X (1),
77 .BR xscreensaver (1)
78 .SH COPYRIGHT
79 Copyright \(co 2002 by Peter Birtles and Jamie Zawinski.  Permission to
80 use, copy, modify, distribute, and sell this software and its
81 documentation for any purpose is hereby granted without fee, provided
82 that the above copyright notice appear in all copies and that both that
83 copyright notice and this permission notice appear in supporting
84 documentation.  No representations are made about the suitability of
85 this software for any purpose.  It is provided "as is" without express
86 or implied warranty.
87 .SH AUTHOR
88 Peter Birtles and Jamie Zawinski.
89