add man page

Signed-off-by: Mattias Andrée <maandree@member.fsf.org>

1 files changed, 41 insertions, 0 deletions

diff --git a/doc/man/learn-your-telephone-number.1 b/doc/man/learn-your-telephone-number.1
new file mode 100644
index 0000000..3813666
--- /dev/null
+++ b/doc/man/learn-your-telephone-number.1
@@ -0,0 +1,41 @@
+.TH LEARN-YOUR-TELEPHONE-NUMBER 1 LEARN-YOUR-TELEPHONE-NUMBER
+.SH NAME
+learn-your-telephone-number - Learn your telephone number
+.SH SYNOPSIS
+.B learn-your-telephone-number
+.I TELEPHONE-NUMBER
+.SH DESCRIPTION
+.B learn-your-telephone-number
+asks you to enter your telephone number. If the entered number is
+.I TELEPHONE-NUMBER
+the program exits with status 0, if not the program will print
+the differences and exit with status 1.
+.PP
+It is recommended to make your shell sometimes when opened, starts
+this program. Or when you log in on your laptop.
+.SH OPTIONS
+None.
+.SH
+EXIT STATUS
+.TP
+0
+The entered number matched
+.IR TELEPHONE-NUMBER .
+.TP
+1
+The entered number did not match
+.IR TELEPHONE-NUMBER .
+.TP
+2
+The command fail.
+.SH "SEE ALSO"
+No related or similar projects known.
+.SH AUTHORS
+Principal author, Mattias Andrée. See the LICENSE file for the
+full list of authors.
+.SH LICENSE
+Expat License.
+.SH BUGS
+Please report bugs to
+https://github.com/maandree/learn-your-telephone-number/issues
+or to maandree@member.fsf.org