From: Nick Bowler <nbowler@draconx.ca>
Date: Thu, 10 Mar 2022 03:58:11 +0000 (-0500)
Subject: Add a man page to explain the game and program options.
X-Git-Url: http://git.draconx.ca/gitweb/rrace.git/commitdiff_plain/2dcb637c0cbb469418b15b9c1d9741024b4d2a5c

Add a man page to explain the game and program options.
---

diff --git a/Makefile.am b/Makefile.am
index 26111a3..fba2274 100644
--- a/Makefile.am
+++ b/Makefile.am
@@ -19,6 +19,7 @@ AM_CFLAGS = $(MOTIF_CFLAGS)
 
 if HAVE_MOTIF
 bin_PROGRAMS = rrace-motif
+dist_man_MANS = doc/rrace-motif.1
 endif
 
 rrace_motif_SOURCES = src/game.c src/x11.c src/game.h src/motif.h \
diff --git a/doc/rrace-motif.1 b/doc/rrace-motif.1
new file mode 100644
index 0000000..ab85b7b
--- /dev/null
+++ b/doc/rrace-motif.1
@@ -0,0 +1,71 @@
+.Dd March 9, 2021
+.Os rrace-motif
+.Dt RRACE-MOTIF \&1 "RRace Reference Manual"
+.Sh NAME
+.Nm rrace-motif
+.Nd Slide puzzle game for the X Window System.
+.Sh SYNOPSIS
+.Nm
+.Op Fl display Ar displayname
+.Op Ar options
+.Sh DESCRIPTION
+.Nm
+is a slide puzzle racing game.
+The goal is to re-arrange coloured tiles in the play area to create the
+objective pattern as quickly as possible.
+.Pp
+The game is played on a 5x5 grid of tiles, with one empty position.
+Clicking on a tile in the same row or column as the empty position will move
+that tile one position towards the empty space, along with any other tiles
+between the selected tile and the empty space.
+The 3x3 objective pattern (shown beside the main game area) must be formed in
+the centre of the game area to win.
+.Sh OPTIONS
+Most options are provided by the X toolkit.
+It is not the goal of this manual to describe all Xt options which will be
+accepted by
+.Nm .
+A selection of useful options, as well as those unique to this application,
+are documented in this section.
+.Bl -tag -width indent
+.It Fl display Ar displayname
+Open a window on the named X display.
+If this option is not specified, the DISPLAY environment variable is used.
+.It Fl geometry Oo Ar W Oc Ns Oo Li x Ns Ar H Oc Ns Oo
+.Li + Ns Ar X Ns Op Li + Ns Ar Y Oc
+Set the initial window geometry.  Any of the window's
+.Ar W Ns idth , Ar H Ns eight , Ar X No or Ar Y
+position may be configured.
+.It Fl iconic
+The program will start in the iconified state.
+.It Fl xrm Ar string
+Add the provided
+.Ar string
+as if it were specified in an X resource file.
+This will supersede other resource specifications.
+.It Fl version
+Print a version message and exit.
+.It Fl help
+Print a help message and exit.
+.El
+.Sh RESOURCES
+Various aspects of
+.Nm
+can be configured via X resources.
+.Pp
+.Bl -tag -width indent -compact
+.It Li rrace.colour0 , rrace.colour1 , Em ... Li rrace.colour5
+.It Li rrace.colourDark0 , rrace.colourDark1 , Em ... Li rrace.colourDark5
+.It Li rrace.colourLight0, rrace.colourLight1 , Em ... Li rrace.colourLight5
+These resources configure the six primary tile colours as well as their
+corresponding light and dark shades.
+.El
+.Sh AUTHORS
+Nick Bowler <nbowler@draconx.ca>
+.Sh COPYRIGHT
+Copyright \(co 2022 Nick Bowler
+.Pp
+Permission is granted to copy, distribute and/or modify this manual under the
+terms of the GNU General Public License as published by the Free Software
+Foundation, either version 3 of the License, or (at your option) any later
+version.