First commit. This is mostly the state of the project as I left it around the end of 2019.HEADmaster

1 files changed, 102 insertions, 0 deletions

diff --git a/doc/maze.1 b/doc/maze.1
new file mode 100644
index 0000000..e7700bd
--- /dev/null
+++ b/doc/maze.1
@@ -0,0 +1,102 @@
+.TH MAZE 6
+.SH NAME
+maze - command line maze game
+.SH SYNOPSIS
+.B maze
+.RB [ \-i
+.IR INPUT_FILE ]
+.RB [ \-o
+.IR OUTPUT_FILE ]
+.RB [ \-log
+.IR PATH ]
+.RB [ \-h ]
+.RB [ \-g ]
+.RB [ \-s ]
+.SH DESCRIPTION
+maze is a command line maze game.
+
+It can generates random mazes or read them from file.
+.SH OPTIONS
+.TP
+.BI "\-i " INPUT_FILE
+Load maze from
+.IR INPUT_FILE
+file.
+.TP
+.BI "\-o " OUTPUT_FILE
+Save maze to
+.IR OUTPUT_FILE
+file.
+.TP
+.BI "\-log " PATH
+Enable logging and set the path of the log file to 
+.IR PATH .
+.TP
+.B \-h
+Hide the menu.
+.TP
+.B \-g
+Generate random maze.
+.TP
+.B \-s
+Start the game.
+
+.SH KEY BINDINGS
+In the game you can use the following key combinations for controlling the enviroment.
+
+.TP
+.B k, Up
+Move the line up.
+.TP
+.B j, Down
+Move the line down.
+.TP
+.B h, Left
+Move the line left.
+.TP
+.B l, Right
+Move the line right.
+.TP
+.B Ctrl-k, Ctrl-Up
+Move the maze up.
+.TP
+.B Ctrl-j, Ctrl-Down
+Move the maze down.
+.TP
+.B Ctrl-h, Ctrl-Left
+Move the maze left.
+.TP
+.B Ctrl-l, Ctrl-Right
+Move the maze right.
+.TP
+.B :
+Enter the
+.B maze
+command prompt.
+.TP
+.B n
+Move the line by one into the direction of exit.
+.TP
+.B s
+Solve the maze.
+.TP
+.B p
+Show/hide path.
+.TP
+.B r
+Generate new maze with the same size of the previous maze.
+.TP
+.B m
+Go to menu.
+.TP
+.B q
+Quit from the program.
+
+.SH COMMANDS
+This section contains the commands, you can run if you enter to the
+.B maze
+command prompt.
+
+.SH AUTHOR
+Sopár Adrián   <\fIadrian.sopar@protonmail.com\fR>
+