refactoring needed for win32 crash

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

diff --git a/doc/yoink.6.in b/doc/yoink.6.in
index ce90f1dfc38caa7e5221b19da5968f52580e0f10..7e100d3eec623b747472ed91f12d113a6c5aae31 100644 (file)
--- a/doc/yoink.6.in
+++ b/doc/yoink.6.in
@@ -105,16 +105,12 @@ artifacts caused by the animation of the game.  Otherwise, a single buffer
 will be used.  The default value is true.
 .TP
 .B framerate
-The maximum number of frames to be drawn per second.  If your computer is
+The target 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
 effectively render as many frames as is possible, but the actual rate could
 be limited by vertical display synchronization, depending on the X11 driver
-and settings used.  You should not set this option higher than the point
-where the vertical synchronization effectively limits the draw rate or else
-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.
+and settings used.  The default value is 50.
 .TP
 .B fullscreen
 If true, the window will capture the display and render the game in full
@@ -150,20 +146,17 @@ need to.
 .SH EXAMPLES
 Here are some examples of typical usage:
 .TP
-$ yoink framerate=60
-Cap the allowable frame-rate to 60Hz.
+$ yoink detail=2
+Set the level of detail to 2 so that less stuff is drawn to the screen.
 .TP
-$ yoink fullscreen=true
-Run \fByoink\fP in full-screen mode.
-.TP
-$ yoink videomode=\\{1024,768\\}
-Run \fByoink\fP with a resolution of 1024x768.  Notice the escapes for the
-curly braces so the shell doesn't parse them.
+$ yoink fullscreen=true videomode=\\{1024,768\\}
+Run \fByoink\fP at full screen with a resolution of 1024x768.  Notice the
+escapes for the curly braces so the shell doesn't parse them.
 .SH ENVIRONMENT
 \fByoink\fP responds to some variables in the environment:
 .TP
 .I HOME
-If set to a path of a valid directory (presumably a user's home directory),
+If set to a path of a valid directory (presumably your home directory),
 \fByoink\fP will look for a file at \fI$HOME/.yoinkrc\fP and load it as a
 config file.
 .TP
@@ -198,11 +191,16 @@ This can speed up a software renderer considerably.
 .TP
 2. Decrease the level of rendering detail.
 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 \fBframerate\fP
-option.  Remember the trade-off here is decreased simulation accuracy.
+but that's probably better than choppy animation if you can avoid it.
+.TP
+3. Decrease the framerate and/or timestep.
+If your machine can't meet the target framerate, your actual framerate will
+probably vary.  You will have a better visual experience if you can reduce
+the \fBframerate\fP to a point such that the actual framerate is basically
+constant.  A constant 20fps or 30fps will look better than a sporadic
+40-60fps.  You can also decrease the \fBtimestep\fP at the expense of
+decreased simulation accuracy.  You'll have to experiment with this value
+to find out acceptable levels.
 .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