2048-cli/man/2048.1

59 lines
1.1 KiB
Groff
Raw Normal View History

.TH 2048 1
.SH NAME
2048 \- play the game 2048 in your terminal
.SH SYNOPSIS
.B 2048
[\fB\-hrcCaA\fR]
[\fB\-s\fR \fISIZE\fR]
[\fB\-b\fR \fIRATE\fR]
[\fB\-g\fR \fIGOAL\fR]
.SH DESCRIPTION
.B 2048
is an implementation of the popular game, 2048, designed to be run on a
terminal. It is deisgned to be easy to understand and extend.
.SH CONTROLS
.TP
.BR hjkl " " and " " wasd
Default movement keys. Depending on the graphics implementation, there may be
extra alternatives.
.TP
.BR \q
Quit the current game.
.SH OPTIONS
.TP
.BR \-h
Print the program usage.
.TP
.BR \-c
Turn on color support (default).
.TP
.BR \-C
Turn off color support.
.TP
.BR \-a
Turn on animations (default).
.TP
.BR \-A
Turn off animations.
.TP
.BR \-s " " \fISIZE\fR
Set the size of the playing field. Default is 4. Maximum value is 16, minimum is 4.
.TP
.BR \-b " " \fIRATE\fR
Set the rate at which blocks are spawned. Default is 1.
.TP
.BR \-g " " \fIGOAL\fR
Set the target end condition. Default is 2048.
.SH AUTHORS
Originally written by Tiehuis.
All contributions can be found at \fIhttps://github.com/Tiehuis/2048-cli\fR.
.SH COPYRIGHT
MIT License (2014)