new timer class

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

diff --git a/doc/yoink.6.in b/doc/yoink.6.in
index 5425c3a91f23021168972ed7120e6e1b591fcfa3..d9e90bfdd20133ca43bdbe20c311a4c46752dd6d 100644 (file)
--- a/doc/yoink.6.in
+++ b/doc/yoink.6.in
@@ -28,7 +28,7 @@
 .SH NAME
 Yoink \- An alien-smashing action game.
 .SH SYNOPSIS
-.B yoink [-h|--help] [-v|--version] [OPTION=VALUE]...
+.B yoink [-h|--help] [OPTION=VALUE]...
 .br
 .SH DESCRIPTION
 .PP
@@ -43,9 +43,6 @@ action.  Basic arguments include:
 .TP
 .B -h, --help
 display this help and exit
-.TP
-.B -v, --version
-output version information and exit
 .br
 .SH TIPS
 .PP
@@ -85,14 +82,15 @@ looks for configuration files and loads them in this order, with the options in
 prior configuration files taking precedence over the same options if they exist
 in multiple configuration files:
 .TP
-1. $YOINK_CONFIGFILE
-This is an optional environment variable.
+1. $YOINKRC
+This is an optional environment variable you can set to point to a configuration
+file.
 .TP
 2. $HOME/.yoinkrc
-This is a specific user's configuration file.
+This is a specific user's personal configuration file.
 .TP
 3. /etc/yoinkrc
-This is the system-wide configuration file.
+This is the system-wide configuration file.  Not available on Windows.
 .TP
 4. @DATADIR@/yoinkrc
 This is the base configuration file which should be considered read-only.  Look
@@ -104,9 +102,10 @@ temporary setting which you do not intend to retain.  Keep in mind that if you
 edit and save options in-game, any options you have passed as arguments during
 the invocation of the game will be saved to the
 .I $HOME/.yoinkrc
-configuration file.  You may have to go into that file and remove any options
-you didn't intend to set.  When passing options as arguments, you must use the
-fully qualified name of the option if it exists in a subgroup.  For example:
+configuration file.  If this is not what you intended, you may have to go into
+that file and remove any options you didn't intend to set.  When passing options
+as arguments, you must use the fully qualified name of the option if it exists
+in a subgroup.  For example:
 .PP
 .TP
 yoink video.fullscreen=true
@@ -130,6 +129,10 @@ to an array with numbers 1024 and 768.  The video size will be 1024x768.
 .PP
 Here is a list of some of the options available:
 .TP
+.B engine.rngseed
+The number value used as a seed for the random number generator.  Set this to
+make the game more predictable.  This is typically only useful for debugging.
+.TP
 .B engine.timestep
 The amount of time in seconds between each update of the physics state.  A value
 of 0.01 or lower is ideal for accurate physics approximations.  Values that are
@@ -213,29 +216,33 @@ responds to some variables in the environment:
 HOME
 If set to a path of a valid directory (presumably a user's home directory),
 .B yoink
-will load options from the configuration file at $HOME/.yoinkrc, if it exists.
-Saving options within the game will cause this file to be over-written with the
-new options.
+will look for a file at
+.I $HOME/.yoinkrc
+and load it as a configuration file.  Saving options within the game will cause
+this file to be over-written with the new options, unless the
+.I YOINKRC
+variable is set.
 .TP
 USER
 .B yoink
 uses this variable to guess the user's nickname, for a high score entry or
 whatever.
 .TP
-YOINK_CONFIGFILE
-If set to a path of a valid configuration file, 
-.B yoink
-will load the options from that file, and those options will take precedence
-over options loaded from other configuration files.  Any in-game saving will
-cause this file to be over-written by the new options rather than the file at
-$HOME/.yoinkrc.
-.TP
 YOINK_DATADIR
 If set to a path of a valid directory, 
 .B yoink
 will look in this directory first when it is loading game assets.  Set this
-variable if you move the game's assets to another directory or want to load your
-own assets.
+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, 
+.B yoink
+will load the options from that file, and those options will take precedence
+over options loaded from other configuration files.  Any in-game saving will
+cause this file to be over-written by the new options rather than the
+.I $HOME/.yoinkrc
+config file.
 .br
 .SH NOTES
 .PP
@@ -272,17 +279,14 @@ option.
 .br
 .SH BUGS
 .PP
-No sound yet.  The original game never had sound, but it would probably be a
-good idea.
-.PP
-The pixelated graphics are actually intentional.  It adds to the charm of the
-game, don't you think?
+Although the pixelated graphics are intentional, there are some unintended
+artifacts which are more obvious on certain OpenGL implementations.
 .PP
 Send bug reports, patches, and love notes to:
 .br
-Charles McGarvey <onefriedrice@brokenzipper.com>
+Charles McGarvey <@PACKAGE_BUGREPORT@>
 .SH AUTHOR
 .PP
 Neil Carter was the original creator of Yoink, his winning entry in the
-uDevGames 2003 Mac game development contest.  Charles McGarvey rewrote the game
-with SDL and is the current maintainer.
+uDevGames 2003 Mac game development contest.  Charles McGarvey restored the game
+and is the current maintainer.