http://www.jwz.org/xscreensaver/xscreensaver-5.13.tar.gz
[xscreensaver] / hacks / flow.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 flow - strange attractors.
4 .SH SYNOPSIS
5 .B flow
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-count \fInumber\fP]
11 [\-cycles \fInumber\fP]
12 [\-periodic|\-no\-periodic]
13 [\-search|\-no\-search]
14 [\-rotate|\-no\-rotate]
15 [\-ride|\-no\-ride]
16 [\-box|\-no\-box]
17 [\-dbuf|\-no\-dbuf]
18 [\-ncolors \fInumber\fP]
19 [\-delay \fInumber\fP]
20 [\-fps]
21 .SH DESCRIPTION
22 Strange attractors formed of flows in a 3D differential equation phase
23 space.  Features the popular attractors described by \fBLorentz\fP,
24 \fBRoessler\fP, \fBBirkhoff\fP and \fBDuffing\fP, and can discover
25 entirely new attractors by itself.
26 .SH OPTIONS
27 .TP 8
28 .B \-visual \fIvisual\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 \-window
33 Draw on a newly-created window.  This is the default.
34 .TP 8
35 .B \-root
36 Draw on the root window.
37 .TP 8
38 .B \-count \fInumber\fP
39 Number of particles in the flow.  Default: 3000
40 .TP 8
41 .B \-size \fInumber\fP
42 Length of particle trails.  Negative values indicate
43 randomness.  The computational load of a given flow depends on
44 (particle count) * (trail length).  Default: -10
45 .TP 8
46 .B \-cycles \fInumber\fP
47 Timeout before changing objects.  0 - 800000.  Default: 10000.
48 .TP 8
49 .B \-periodic
50 .TP 8
51 .B \-no\-periodic
52 turn on/off periodic attractors.  These are flows in 2 dependent
53 variables, with a periodic dependence on a third independent variable
54 (eg time).  Flow will sometimes choose to start all the particles in
55 the same phase to illustrate the flow's cross-section.  Default:
56 on
57 .TP 8
58 .B \-search
59 .TP 8
60 .B \-no\-search
61 turn on/off search for new attractors.  If this is enabled, a fraction
62 of the computing cycles is directed to searching a 60-dimensional
63 parameter space for new strange attractors.  If periodic flows are
64 enabled, these can be searched too.  Watch carefully - you are quite
65 likely to see mathematical objects that have never been seen before,
66 and since the parameters are not recorded, you'll probably never see
67 them again!  Default: on
68 .TP 8
69 .B \-rotate
70 .TP 8
71 .B \-no\-rotate
72 turn on/off rotating around attractor.  Default: on
73 .TP 8
74 .B \-ride
75 .TP 8
76 .B \-no\-ride
77 turn on/off ride in the flow.  Default: on
78
79 If both -rotate and -ride are enabled the viewpoint will occasionally
80 fly between the two views.
81 .TP 8
82 .B \-box
83 .TP 8
84 .B \-no\-box
85 turn on/off bounding box.  Default: on
86 .TP 8
87 .B \-dbuf
88 .TP 8
89 .B \-no\-dbuf
90 turn on/off double buffering.  If Flow runs slowly in full screen, but
91 fast in a smaller window (eg on old graphics cards with too little
92 memory), try turning this option off.  Default: on
93 .TP 8
94 .B \-ncolors \fInumber\fP
95 Number of Colors.  Default: 200.
96 .TP 8
97 .B \-delay \fInumber\fP
98 Per-frame delay, in microseconds.  Default: 10000 (0.01 seconds.).
99 .TP 8
100 .B \-fps
101 Display the current frame rate and CPU load.
102 .SH ENVIRONMENT
103 .PP
104 .TP 8
105 .B DISPLAY
106 to get the default host and display number.
107 .TP 8
108 .B XENVIRONMENT
109 to get the name of a resource file that overrides the global resources
110 stored in the RESOURCE_MANAGER property.
111 .SH SEE ALSO
112 .BR X (1),
113 .BR xscreensaver (1)
114 .SH COPYRIGHT
115 Copyright (c) 1996 by Tim Auckland <Tim.Auckland@Procket.com>
116 Incorporating some code from Stephen Davies Copyright (c) 2000
117
118 Search code based on techniques described in "Strange Attractors:
119 Creating Patterns in Chaos" by Julien C. Sprott
120
121 Permission to use, copy, modify, and distribute this software and its
122 documentation for any purpose and without fee is hereby granted,
123 provided that the above copyright notice appear in all copies and that
124 both that copyright notice and this permission notice appear in
125 supporting documentation.
126
127 This file is provided AS IS with no warranties of any kind.  The author
128 shall have no liability with respect to the infringement of copyrights,
129 trade secrets or any patents by this file or any part thereof.  In no
130 event will the author be liable for any lost revenue or profits or
131 other special, indirect and consequential damages.
132
133 Adapted from swarm.c Copyright (c) 1991 by Patrick J. Naughton.
134
135 Adapted from xswarm by Jeff Butterworth. (butterwo@ncsc.org).
136 .SH AUTHOR
137 Tim Auckland