X-Git-Url: https://git.dogcows.com/gitweb?p=chaz%2Fyoink;a=blobdiff_plain;f=doc%2Fyoink.6.in;h=ce90f1dfc38caa7e5221b19da5968f52580e0f10;hp=fd00dad8b91c8a215082d7d68480c217b62bf731;hb=4f62ce947db282f0bbf4d49b3aafb83d7cf51adc;hpb=a295f8def17036c8071b56e181364f99a377cae7 diff --git a/doc/yoink.6.in b/doc/yoink.6.in index fd00dad..ce90f1d 100644 --- a/doc/yoink.6.in +++ b/doc/yoink.6.in @@ -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,7 +201,7 @@ 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