http://se.aminet.net/pub/Linux/distributions/slackware/slackware-10.1/source/xap...
[xscreensaver] / hacks / flow.man
index 4b9e8c2ae3fde4b49371917d68463bc5409340fa..548a39146dd9a0b79684a0ff3c3ffb507eb99416 100644 (file)
@@ -9,18 +9,19 @@ flow - strange attractors.
 [\-root]
 [\-count \fInumber\fP]
 [\-cycles \fInumber\fP]
-[\-delay \fInumber\fP]
+[\-periodic|\-no\-periodic]
+[\-search|\-no\-search]
+[\-rotate|\-no\-rotate]
+[\-ride|\-no\-ride]
+[\-box|\-no\-box]
+[\-dbuf|\-no\-dbuf]
 [\-ncolors \fInumber\fP]
-[\-rotate \fIbool\fP]
-[\-ride \fIbool\fP]
-[\-zoom \fIbool\fP]
-[\-box \fIbool\fP]
-[\-freeze \fIbool\fP]
-[\-allow2d \fIbool\fP]
-[\-slow \fIbool\fP]
+[\-delay \fInumber\fP]
 .SH DESCRIPTION
-Another series of strange attractors: a flowing series of points, making
-strange rotational shapes.
+Strange attractors formed of flows in a 3D differential equation phase
+space.  Features the popular attractors described by \fBLorentz\fP,
+\fBRössler\fP, \fBBirkhoff\fP and \fBDuffing\fP, and can now discover
+entirely new attractors by itself.
 .SH OPTIONS
 .TP 8
 .B \-visual \fIvisual\fP
@@ -34,37 +35,66 @@ Draw on a newly-created window.  This is the default.
 Draw on the root window.
 .TP 8
 .B \-count \fInumber\fP
-Number of pixels.  Default: 500.
+Number of particles in the flow.  Default: 3000
+.TP 8
+.B \-size \fInumber\fP
+Length of particle trails.  Negative values indicate
+randomness.  The computational load of a given flow depends on
+(particle count) * (trail length).  Default: -10
 .TP 8
 .B \-cycles \fInumber\fP
-Timeout before changing objects.  0 - 800000.  Default: 3000.
+Timeout before changing objects.  0 - 800000.  Default: 10000.
 .TP 8
-.B \-delay \fInumber\fP
-Per-frame delay, in microseconds.  Default: 1000 (0.001 seconds.).
+.B \-periodic
 .TP 8
-.B \-ncolors \fInumber\fP
-Number of Colors.  Default: 200.
+.B \-no\-periodic
+turn on/off periodic attractors.  These are flows in 2 dependent
+variables, with a periodic dependence on a third independent variable
+(eg time).  Flow will sometimes choose to start all the particles in
+the same phase to illustrate the flow's cross-section.  Default:
+on
+.TP 8
+.B \-search
+.TP 8
+.B \-no\-search
+turn on/off search for new attractors.  If this is enabled, a fraction
+of the computing cycles is directed to searching a 60-dimensional
+parameter space for new strange attractors.  If periodic flows are
+enabled, these can be searched too.  Watch carefully - you are quite
+likely to see mathematical objects that have never been seen before,
+and since the parameters are not recorded, you'll probably never see
+them again!  Default: on
 .TP 8
 .B \-rotate
-Rotate Around Attractor.
+.TP 8
+.B \-no\-rotate
+turn on/off rotating around attractor.  Default: on
 .TP 8
 .B \-ride
-Ride a Trained Bee.
 .TP 8
-.B \-zoom
-Zoom In and Out.
+.B \-no\-ride
+turn on/off ride in the flow.  Default: on
+
+If both -rotate and -ride are enabled the viewpoint will occasionally
+fly between the two views.
 .TP 8
 .B \-box
-Show Bounding Box.
 .TP 8
-.B \-freeze
-Freeze Some Bees.
+.B \-no\-box
+turn on/off bounding box.  Default: on
+.TP 8
+.B \-dbuf
+.TP 8
+.B \-no\-dbuf
+turn on/off double buffering.  If Flow runs slowly in full screen, but
+fast in a smaller window (eg on old graphics cards with too little
+memory), try turning this option off.  Default: on
 .TP 8
-.B \-allow2d
-Allow 2D Attractors.
+.B \-ncolors \fInumber\fP
+Number of Colors.  Default: 200.
 .TP 8
-.B \-slow
-Slow Bees with Antifreeze.
+.B \-delay \fInumber\fP
+Per-frame delay, in microseconds.  Default: 10000 (0.01 seconds.).
 .SH ENVIRONMENT
 .PP
 .TP 8
@@ -78,15 +108,26 @@ stored in the RESOURCE_MANAGER property.
 .BR X (1),
 .BR xscreensaver (1)
 .SH COPYRIGHT
+Copyright (c) 1996 by Tim Auckland <Tim.Auckland@Procket.com>
+Incorporating some code from Stephen Davies Copyright (c) 2000
+
+Search code based on techniques described in "Strange Attractors:
+Creating Patterns in Chaos" by Julien C. Sprott
+
+Permission to use, copy, modify, and distribute this software and its
+documentation for any purpose and without fee is hereby granted,
+provided that the above copyright notice appear in all copies and that
+both that copyright notice and this permission notice appear in
+supporting documentation.
+
+This file is provided AS IS with no warranties of any kind.  The author
+shall have no liability with respect to the infringement of copyrights,
+trade secrets or any patents by this file or any part thereof.  In no
+event will the author be liable for any lost revenue or profits or
+other special, indirect and consequential damages.
 
-Copyright \(co 2002 by Tim Auckland and Jeff Butterworth.  Permission
-to use, copy, modify, distribute, and sell this software and its
-documentation for any purpose is hereby granted without fee, provided
-that the above copyright notice appear in all copies and that both that
-copyright notice and this permission notice appear in supporting
-documentation.  No representations are made about the suitability of
-this software for any purpose.  It is provided "as is" without express
-or implied warranty.
+Adapted from swarm.c Copyright (c) 1991 by Patrick J. Naughton.
 
+Adapted from xswarm by Jeff Butterworth. (butterwo@ncsc.org).
 .SH AUTHOR
-Tim Auckland based on code by Jeff Butterworth.
+Tim Auckland