foundational changes; tying up some loose ends

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

diff --git a/doc/yoink.6.in b/doc/yoink.6.in
index ece0fa5b474108bbbde5a81c5682d245c5018b31..ec41deebeb4913b918a558727cdd2e27220f4910 100644 (file)
--- a/doc/yoink.6.in
+++ b/doc/yoink.6.in
@@ -70,61 +70,28 @@ around, especially in the sky, if you can't find the last few.
 .br
 .SH OPTIONS
 .PP
-There are a plethora of options available for tweaking various aspects of the
-game.  All options can be set either from a configuration file or by passing
-them as arguments.
-.PP
-A
-.B yoink
-configuration file ("yoinkrc") consists of key-value pairs.  The format is not
-unlike that of other configuration files you are already familiar with.  The
-syntax used is lua.
+Options are set from config files and command-line arguments.  A
 .B yoink
-looks for configuration files and loads them in this order, the options from
-each subsequent configuration files taking precedence over the same options if
-they exist in previous files.
+configfile ("yoinkrc") consists of key-value pairs.  They are loaded in this
+order:
 .TP
 1. @DATADIR@/yoinkrc
-This is the base configuration file which should be considered read-only.  Look
-to this file as an example of the format used for configuration files.
+This is the base config file which should be considered read-only.  Look to this
+file as an example of the format used for config files.
 .TP
 2. /etc/yoinkrc
-This is the system-wide configuration file.  Not available on Windows.
+This is the system-wide config file.  Not available on Windows.
 .TP
 3. $HOME/.yoinkrc
-This is your own personal configuration file.
+This is your own personal config file.
 .TP
 4. $YOINKRC
-This is an optional environment variable you can set to point to a configuration
-file.
-.PP
-Options that are passed as arguments take precedence over options loaded from
-the configuration file(s).  This mechanism can be used to play the game with
-temporary settings which you do not intend to retain.  Here are some examples of
-passing options on the command-line:
-.PP
-.TP
-yoink fullscreen=true
-Run Yoink with the option
-.I fullscreen
-as true.  This will run the game in full-screen mode.
-.TP
-yoink maxfps=60
-Run Yoink with the option
-.I maxfps
-as 60.  This will cap the display rate at 60Hz.
+This is an optional environment variable you can set to the path of a config
+file at a non-standard location.
 .PP
-You can also set options with array values.  Arrays can be passed on the command
-line by surrounding all the parts with curly brackets and separating each part
-by a comma.  You may also have to quote the brackets so your shell doesn't parse
-them.  For example:
-.TP
-yoink videomode=\\{1024,768\\}
-Run Yoink with the top
-.I videomode
-as the numbers 1024 and 768.  The video size will be 1024x768.
-.PP
-Here is a list of some of the options available:
+As usual, options that are passed as arguments take precedence over options
+loaded from the config file(s).  Here is a list of some of the options available
+at your disposal:
 .TP
 .B detail
 The level of detail.  Possible values are 1, 2, or 3 where 1 means the least
@@ -180,11 +147,26 @@ is 80.
 .B videomode
 The resolution or size of the window.  The value is an array with three number
 elements representing the width, height, and bits per pixel that make up the
-video mode.  The third number is optional.  The default value is {800, 600}.
+video mode.  The third number is optional.  The default value is {800,600}.  You
+may need to escape the curly braces so the shell doesn't parse them.
 .PP
 This is only a list of the more useful options.  You'll have to use the source
 to find out about the more esoteric options, but you probably won't need to.
 .br
+.SH EXAMPLES
+.PP
+Here are some examples of typical usage:
+.PP
+.TP
+yoink fullscreen=true
+Run Yoink in full-screen mode.
+.TP
+yoink maxfps=60
+Cap the allowable frame-rate to 60Hz.
+.TP
+yoink videomode=\\{1024,768\\}
+Run yoink with a resultion of 1024x768.  Notice the escapes for the curly
+braces so the shell doesn't parse them.
 .SH ENVIRONMENT
 .PP
 .B yoink
@@ -195,7 +177,7 @@ If set to a path of a valid directory (presumably a user's home directory),
 .B yoink
 will look for a file at
 .I $HOME/.yoinkrc
-and load it as a configuration file.
+and load it as a config file.
 .TP
 USER
 .B yoink
@@ -210,10 +192,10 @@ variable if you move the game's assets to another directory or perhaps want to
 load your own custom assets rather than the defaults.
 .TP
 YOINKRC
-If set to a path of a valid configuration file, 
+If set to a path of a valid config file, 
 .B yoink
 will load the options from that file, and those options will take precedence
-over options loaded from other configuration files.
+over options loaded from other config files.
 .br
 .SH NOTES
 .PP
@@ -239,10 +221,10 @@ Use the
 option.  You can set the timestep to be as low as the your
 .I maxfps
 option, but it is not recommended to set this lower than the target frame rate.
-Remember the trade-off here is decreased simulation accuracy.  Try this to set
-your frame rate to 30Hz and your timestep to 60Hz:
+Remember the trade-off here is decreased simulation accuracy.  Try to set your
+maxfps to 30Hz and your timestep to 60Hz:
 .PP
-yoink maxfps=30 timestep=maxfps\\*2
+yoink maxfps=30 timestep=60
 .TP
 3. Decrease the level of rendering detail.
 Use the
@@ -253,7 +235,9 @@ than choppy animation.
 .SH BUGS
 .PP
 Although the pixelated graphics are intentional, there are some unintended
-artifacts which are more obvious on certain OpenGL implementations.
+artifacts which are more obvious with certain video drivers.
+.PP
+The robots are not very bright.
 .PP
 Send bug reports, patches, and love notes to:
 .br