finally fixed broken main loop

[chaz/yoink] / doc / yoink.6.in

diff --git a/doc/yoink.6.in b/doc/yoink.6.in
index 5b37c38e78e1ab322d9e895bd2f23e1b0cfbd8ab..ce90f1dfc38caa7e5221b19da5968f52580e0f10 100644 (file)
--- a/doc/yoink.6.in
+++ b/doc/yoink.6.in
@@ -33,7 +33,7 @@ Yoink \- An alien-smashing action game.
 .SH DESCRIPTION
 Leap tall buildings!  Crush stupid robots beneath your feet!  Wield your
 extra-terrestrial powers in the defence of humanity, and send those alien
-invaders back from whence they came!  This is Yoink.
+invaders back from whence they came!
 
 You play the part of a flying alien heroine who must defend her home on
 Earth from other airborne alien invaders.  The game draws inspiration from
@@ -104,12 +104,7 @@ If true, double-buffering will be used to help minimize distortion and
 artifacts caused by the animation of the game.  Otherwise, a single buffer
 will be used.  The default value is true.
 .TP
-.B fullscreen
-If true, the window will capture the display and render the game in full
-screen splendor.  A value of false means the game will run in a window.
-The default value is false.
-.TP
-.B maxfps
+.B framerate
 The maximum number of frames to be drawn per second.  If your computer is
 really old, you can get away with decreasing this value and still have
 reasonably smooth animation.  You can set this to a very high number to
@@ -121,9 +116,14 @@ the game may not be able to update the physics on schedule which could
 actually significantly lower the quality of the animation.  The default
 value is 40.
 .TP
-.B printfps
+.B fullscreen
+If true, the window will capture the display and render the game in full
+screen splendor.  A value of false means the game will run in a window.
+The default value is false.
+.TP
+.B showfps
 If true, the current number of frames being drawn per second will be
-printed to the console.  The default value is false.
+printed to the console every second.  The default value is false.
 .TP
 .B resizable
 If true, the window will be resizable by the window manager.  This option
@@ -150,7 +150,7 @@ need to.
 .SH EXAMPLES
 Here are some examples of typical usage:
 .TP
-$ yoink maxfps=60
+$ yoink framerate=60
 Cap the allowable frame-rate to 60Hz.
 .TP
 $ yoink fullscreen=true
@@ -201,8 +201,14 @@ Use the \fBdetail\fP option.  The game world may look sparse or incomplete,
 but that's probably better than choppy animation.
 .TP
 3. Decrease the timestep.
-You can set the \fBtimestep\fP to be as low as the your \fBmaxfps\fP
+You can set the \fBtimestep\fP to be as low as the your \fBframerate\fP
 option.  Remember the trade-off here is decreased simulation accuracy.
+.PP
+If you are having audio problems, you may need to upgrade OpenAL.  Some
+systems still provide an old, busted version of OpenAL which may result in
+stuttering, lag, and other oddities.  See about installing a recent version
+of openal-soft, a high-quality software implementation that is still being
+maintained.
 .SH BUGS
 .IP \(bu 3
 The robots are currently lacking in intelligence.