0c2df5ab59f21610e70a75429ccd7920300d75b3
[xscreensaver] / hacks / glx / atlantis.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 atlantis - draw swimming sharks, whales, and dolphins.
4 .SH SYNOPSIS
5 .B atlantis
6 [\-display \fIhost:display.screen\fP]
7 [\-visual \fIvisual\fP]
8 [\-window]
9 [\-root]
10 [\-whalespeed \fInumber\fP]
11 [\-delay \fInumber\fP]
12 [\-size \fInumber\fP]
13 [\-count \fInumber\fP]
14 [\-no-texture]
15 [\-gradient]
16 [\-wireframe]
17 [\-fps]
18 .SH DESCRIPTION
19 This is xfishtank writ large: a GL animation of a number of sharks,
20 dolphins, and whales. The swimming motions are great.
21 .SH OPTIONS
22 .TP 8
23 .B \-visual \fIvisual\fP
24 Specify which visual to use.  Legal values are the name of a visual class,
25 or the id number (decimal or hex) of a specific visual.
26 .TP 8
27 .B \-window
28 Draw on a newly-created window.  This is the default.
29 .TP 8
30 .B \-root
31 Draw on the root window.
32 .TP 8
33 .B \-whalespeed \fInumber\fP
34 Whale Speed.  0 - 1000.  Default: 250.
35 .TP 8
36 .B \-cycles \fInumber\fP
37 Shark Speed.  Default: 100.
38 .TP 8
39 .B \-size \fInumber\fP
40 Shark Proximity.  100 - 10000.  Default: 6000.
41 .TP 8
42 .B \-count \fInumber\fP
43 Number of Sharks.  0 - 20.  Default: 4.
44 .TP 8
45 .B \-texture | \-no-texture
46 Whether to show shimmering water.
47 .TP 8
48 .B \-gradient
49 Whether to draw a gradient on the background, making it darker at the bottom.
50 .TP 8
51 .B \-wireframe
52 Render in wireframe instead of solid.
53 .TP 8
54 .B \-fps
55 Display the current frame rate, CPU load, and polygon count.
56 .SH ENVIRONMENT
57 .PP
58 .TP 8
59 .B DISPLAY
60 to get the default host and display number.
61 .TP 8
62 .B XENVIRONMENT
63 to get the name of a resource file that overrides the global resources
64 stored in the RESOURCE_MANAGER property.
65 .SH SEE ALSO
66 .BR X (1),
67 .BR xscreensaver (1)
68 .SH COPYRIGHT
69 Copyright \(co 2002 by Mark Kilgard.  Permission to use, copy, modify, 
70 distribute, and sell this software and its documentation for any purpose is 
71 hereby granted without fee, provided that the above copyright notice appear 
72 in all copies and that both that copyright notice and this permission notice
73 appear in supporting documentation.  No representations are made about the 
74 suitability of this software for any purpose.  It is provided "as is" without
75 express or implied warranty.
76 .SH AUTHOR
77 Mark Kilgard.
78