\# vim: ft=groff
.TH uhm 1
.SH NAME
uhm \- ultra hangman
.SH SYNPOSIS
uhm [-h] [-w \fIword\fP] [-d \fIfile\fP]
.SH DESCRIPTION
Play a game of hangman, optionally using a custom dictionary or custom word.
The terminal screen will always get cleared before playing.

The player can input a single letter per turn. The player's turn is indicated
by a caret `> ' prompt. When the word contains the input letter, the player
keeps the same amount of turns. When the word does not contain the input
letter, the player loses a turn. The game exits once all turns are depleted, or
the player has guessed the word.
.SH OPTIONS
.TP
\fB-h\fP
Show help
.TP
\fB-w \fIword\fP
Set custom word to \fIword\fP
.TP
\fB-d \fIfile\fP
Load random word from dictionary \fIfile\fP.

\fIfile\fP must be a regular file containing a single word on each line. The
default dictionary used is /usr/share/dict/words.

Any words containing spaces, apostrophes, or words longer than 12 characters
will get filtered. 
.SH AUTHOR
Written by Loek Le Blansch.
.SH COPYRIGHT
MIT License

Copyright (c) 2023 lonkaars

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.
.SH NOTES
The main game logic is programmed in \fBawk\fR(1), so this implementation also
supports non-ascii words.