doc/rrace-motif.1

   1 .Dd March 9, 2021
   2 .Os rrace-motif
   3 .Dt RRACE-MOTIF \&1 "RRace Reference Manual"
   4 .Sh NAME
   5 .Nm rrace-motif
   6 .Nd Slide puzzle game for the X Window System.
   7 .Sh SYNOPSIS
   8 .Nm
   9 .Op Fl display Ar displayname
  10 .Op Ar options
  11 .Sh DESCRIPTION
  12 .Nm
  13 is a slide puzzle racing game.
  14 The goal is to re-arrange coloured tiles in the play area to create the
  15 objective pattern as quickly as possible.
  16 .Pp
  17 The game is played on a 5x5 grid of tiles, with one empty position.
  18 Clicking on a tile in the same row or column as the empty position will move
  19 that tile one position towards the empty space, along with any other tiles
  20 between the selected tile and the empty space.
  21 The 3x3 objective pattern (shown beside the main game area) must be formed in
  22 the centre of the game area to win.
  23 .Sh OPTIONS
  24 Most options are provided by the X toolkit.
  25 It is not the goal of this manual to describe all Xt options which will be
  26 accepted by
  27 .Nm .
  28 A selection of useful options, as well as those unique to this application,
  29 are documented in this section.
  30 .Bl -tag -width indent
  31 .It Fl display Ar displayname
  32 Open a window on the named X display.
  33 If this option is not specified, the DISPLAY environment variable is used.
  34 .It Fl geometry Oo Ar W Oc Ns Oo Li x Ns Ar H Oc Ns Oo
  35 .Li + Ns Ar X Ns Op Li + Ns Ar Y Oc
  36 Set the initial window geometry.  Any of the window's
  37 .Ar W Ns idth , Ar H Ns eight , Ar X No or Ar Y
  38 position may be configured.
  39 .It Fl iconic
  40 The program will start in the iconified state.
  41 .It Fl xrm Ar string
  42 Add the provided
  43 .Ar string
  44 as if it were specified in an X resource file.
  45 This will supersede other resource specifications.
  46 .It Fl version
  47 Print a version message and exit.
  48 .It Fl help
  49 Print a help message and exit.
  50 .El
  51 .Sh RESOURCES
  52 Various aspects of
  53 .Nm
  54 can be configured via X resources.
  55 .Pp
  56 .Bl -tag -width indent -compact
  57 .It Li rrace.colour0 , rrace.colour1 , Em ... Li rrace.colour5
  58 .It Li rrace.colourDark0 , rrace.colourDark1 , Em ... Li rrace.colourDark5
  59 .It Li rrace.colourLight0, rrace.colourLight1 , Em ... Li rrace.colourLight5
  60 These resources configure the six primary tile colours as well as their
  61 corresponding light and dark shades.
  62 .El
  63 .Sh AUTHORS
  64 Nick Bowler <nbowler@draconx.ca>
  65 .Sh COPYRIGHT
  66 Copyright \(co 2022 Nick Bowler
  67 .Pp
  68 Permission is granted to copy, distribute and/or modify this manual under the
  69 terms of the GNU General Public License as published by the Free Software
  70 Foundation, either version 3 of the License, or (at your option) any later
  71 version.