ftp://ftp.linux.ncsu.edu/mirror/ftp.redhat.com/pub/redhat/linux/enterprise/4/en/os...
[xscreensaver] / hacks / anemotaxis.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 anemotaxis - directional search on a plane.
4 .SH SYNOPSIS
5 .B anemotaxis
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-delay \fInumber\fP]
11 [\-distance \fInumber\fP]
12 [\-sources \fInumber\fP]
13 [\-searchers \fInumber\fP]
14 .SH DESCRIPTION
15 The program demonstrates a search algorithm designed for locating a
16 source of odor in turbulent atmosphere. The odor is convected by wind
17 which has a constant mean direction and fluctuations around it. The
18 searcher is able to sense the odor and determine local instantaneous
19 wind direction. The goal is to find the source in the shortest mean
20 time.  Some animals face this task to find mates, food, home etc. They
21 exhibit very particular, zigzagging search trajectories.
22
23 This is modeled as a search on a discrete two-dimensional lattice. The
24 source releases particles that drift with constant velocity in one
25 direction and walk randomly in the other direction. The searcher knows
26 if it hit a particle, and if so, particle's position one time step
27 earlier (local wind direction). The program paints sources and
28 particles released by them as well as trajectories of serchers who are
29 trying to capture the sources.
30 .SH OPTIONS
31 .TP 8
32 .B \-visual \fIvisual\fP
33 Specify which visual to use.  Legal values are the name of a visual class,
34 or the id number (decimal or hex) of a specific visual.
35 .TP 8
36 .B \-window
37 Draw on a newly-created window.  This is the default.
38 .TP 8
39 .B \-root
40 Draw on the root window.
41 .TP 8
42 .B \-delay \fInumber\fP
43 Per-frame delay, in microseconds.  Default: 20000 (0.02 seconds.).
44 .TP 8
45 .B \-distance \fInumber\fP
46 Max initial distance to the source .  10 - 250.  Default: 40.
47 .TP 8
48 .B \-sources \fInumber\fP
49 Max number of sources.  Default: 25.
50 .TP 8
51 .B \-searchers \fInumber\fP
52 Max number of searchers. Default: 25.
53
54 .SH ENVIRONMENT
55 .PP
56 .TP 8
57 .B DISPLAY
58 to get the default host and display number.
59 .TP 8
60 .B XENVIRONMENT
61 to get the name of a resource file that overrides the global resources
62 stored in the RESOURCE_MANAGER property.
63 .SH SEE ALSO
64 .BR X (1),
65 .BR xscreensaver (1)
66 .SH COPYRIGHT
67 Copyright \(co 2004 by Eugene Balkovsky.  Permission to use, copy, modify, 
68 distribute, and sell this software and its documentation for any purpose is 
69 hereby granted without fee, provided that the above copyright notice appear 
70 in all copies and that both that copyright notice and this permission notice
71 appear in supporting documentation.  No representations are made about the 
72 suitability of this software for any purpose.  It is provided "as is" without
73 express or implied warranty.
74 .SH AUTHOR
75 Eugene Balkovsky