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