5183baa326ffb2029e0d7919a6eb4428a22a4db3
[xscreensaver] / hacks / glx / crackberg.man
1 .TH XScreenSaver 1 "" "X Version 11"
2 .SH NAME
3 crackberg - Lose your way wandering some height fields, and enjoy candy.
4 .SH SYNOPSIS
5 .B crackberg
6 [\-root]
7 [\-window]
8 [\-install]
9 [\-display \fIhost:display.screen\fP]
10 [\-visual \fIvisual\fP]
11 [\-window-id \fIid\fP]
12 [\-delay \fIusecs\fP]
13 [\-fps]
14 [\-crack]
15 [\-lit]
16 [\-boring]
17 [\-letterbox]
18 [\-flat]
19 [\-wire]
20 [\-nowater]
21 [\-visibility \fIfloat\fP]
22 [\-color \fIstring\fP]
23 [\-nsubdivs \fIinteger\fP]
24 .SH DESCRIPTION
25 Flies through height maps, optionally animating the instantiation and
26 destruction of generated tiles; by default, tiles 'grow' into place (height
27 gradually increased up to correct value).  In windowed mode the following key
28 controls are available:
29 .TP 8
30 .B left, right
31 Turn left and right.
32 .TP 8
33 .B a,w,s,d
34 Move left, forwards, backwards, and to the right, respectively.
35 .TP 8
36 .B 1,2
37 Decrease and increase manual speed, respectively.
38 .TP 8
39 .B Spacebar
40 Return to automatic control.
41 .SH OPTIONS
42 .I crackberg
43 accepts the following options:
44 .TP 8
45 .B \-root
46 Draw on the root window.
47 .TP 8
48 .B \-window
49 Draw on a newly-created window.  This is the default.
50 .TP 8
51 .B \-install
52 Install a private colormap for the window.
53 .TP 8
54 .B \-visual \fIvisual\fP
55 Specify which visual to use.  Legal values are the name of a visual
56 class, or the id number (decimal or hex) of a specific visual.
57 .TP 8
58 .B \-delay \fImicroseconds\fP
59 Delay between frames; default 20000 (1/50th of a second).
60 .TP 8
61 .B \-fps
62 Display the current frame rate, CPU load, and polygon count.
63 .TP 8
64 .B \-crack
65 Use all possible methods to animate tile instantiation.
66 .TP 8
67 .B \-boring
68 Do not animate instatiation at all; use this to get standard landscape 
69 generator behavior.
70 .TP 8
71 .B \-letterbox
72 Drawable window region has a 16:9 aspect ratio, regardless of actual
73 window size.
74 .TP 8
75 .B \-lit
76 Enable lighting.
77 .TP 8
78 .B \-flat
79 Flat shading (OpenGL will use one color per primitive, rather than
80 interpolating betwixt vertices).
81 .TP 8
82 .B \-wire
83 Wireframe.
84 .TP 8
85 .B \-nowater
86 Do not display 'water' (forces negative values to zero, and selects a 
87 different coloring method).
88 .TP 8
89 .B \-visibility \fIfloat\fP
90 Value in range [0.2,1.0] (default 0.6) specifying proportion of viewable 
91 XY plane which is to be drawn upon.
92 .TP 8
93 .B \-color \fIstring\fP
94 Selects color scheme.  Use with no or bogus argument for current list.
95 .TP 8
96 .B \-nsubdivs \fIinteger\fP
97 Number of times to recursively subdivide each triangular tile.  Each 
98 increment increases total triangles by a factor of 4; for instance the default
99 setting 4 results in 256 triangles per tile.
100
101 .SH ENVIRONMENT
102 .PP
103 .TP 8
104 .B DISPLAY
105 to get the default host and display number.
106 .TP 8
107 .B XENVIRONMENT
108 to get the name of a resource file that overrides the global resources
109 stored in the RESOURCE_MANAGER property.
110 .SH SEE ALSO
111 .BR X (1),
112 .BR xscreensaver (1)
113 .SH COPYRIGHT
114 Copyright \(co 2005 by Matus Telgarsky.  Permission to use, copy,
115 modify, distribute, and sell this software and its documentation for
116 any purpose is hereby granted without fee, provided that the above
117 copyright notice appear in all copies and that both that copyright
118 notice and this permission notice appear in supporting documentation.
119 No representations are made about the suitability of this software for
120 any purpose.  It is provided "as is" without express or implied
121 warranty.
122 .SH AUTHOR
123 Matus Telgarsky <catachresis@cmu.edu>, 2005.