aboutsummaryrefslogtreecommitdiff
path: root/doc/maze.1
blob: e7700bd3a7ec624f589341439cbc390ecd236ba0 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
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>