build system enhancements

[chaz/yoink] / doc / yoinkrc.5.in

diff --git a/doc/yoinkrc.5.in b/doc/yoinkrc.5.in
new file mode 100644 (file)
index 0000000..2d964a1
--- /dev/null
+++ b/doc/yoinkrc.5.in
@@ -0,0 +1,79 @@
+.\"
+.\" Copyright (c) 2009-2011, Charles McGarvey
+.\" All rights reserved.
+.\" 
+.\" Distributable under the terms and conditions of the 2-clause BSD
+.\" license; see the file COPYING for a complete text of the license.
+.\"
+.Dd July 24, 2009
+.Dt YOINKRC 5
+.Os
+.Sh NAME
+.Nm yoinkrc
+.Nd user configuration for yoink
+.Sh DESCRIPTION
+Yoink configuration files are little more than Lua scripts with meaningful
+variables.  The syntax for variable assignment is similar to that in other
+languages, where the variable name appears on the left side of an equals
+\(lq=\(rq character, and the value to be assigned appears on the right
+side.  Please refer to the distributed configuration file at
+.Pa @pkgdatadir@/yoinkrc
+for an example of the syntax.  Here is a list of some of the available
+options:
+.Bl -tag -width Fl
+.It Va detail
+The level of detail.  Possible values are 1, 2, or 3 where 1 means the
+least amount of detail and 3 means the most.  This effects the number of
+objects drawn to the screen.  A high level of detail will draw everything
+but could cause poor frame rates if the graphics driver can't keep up with
+the load.  Lower levels will omit certain details which aren't crucial for
+playing the game with the possible benefit of higher frame rates.  See the
+Notes for more ways to increase the game's performance.  The default value
+is 3.
+.It Va doublebuffer
+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.
+.It Va framerate
+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.  The default value is 50.
+.It Va 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.
+.It Va resizable
+If true, the window will be resizable by the window manager.  This option
+is meaningless if the game is drawing to the full screen.  The default
+option is true.
+.It Va showfps
+If true, the current number of frames being drawn per second will be
+printed to the console every second.  The default value is false.
+.It Va timestep
+The number of times per second the simulation state will be updated.  A
+value of 100 or higher is ideal for a better physical simulation.  Values
+that are much lower cause the CPU to do less work, but accuracy will
+suffer.  Errors could be introduced in the game with extremely low values.
+The default value is 80.
+.It Va 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}.
+.El
+.Sh FILES
+.Bl -tag -compact
+.It Pa @pkgdatadir@/yoinkrc
+.It Pa /etc/yoinkrc
+.It Pa ~/.yoinkrc
+.El
+.Sh SEE ALSO
+.Xr yoink 6
+.Sh AUTHORS
+.Bl -tag -width 2i -compact
+.It An Charles McGarvey
+.Mt chaz@dogcows.com
+.El