add man page

3 files changed, 47 insertions, 1 deletions

diff --git a/Makefile b/Makefile
index 62a9a16..883deab 100644
--- a/Makefile
+++ b/Makefile
@@ -17,6 +17,9 @@ install: XD
 	mkdir -p $(PREFIX)/bin
 	cp -f XD $(PREFIX)/bin
 	chmod 755 $(PREFIX)/bin/XD
+	mkdir -p $(MANDIR)/man1
+	cp -f XD.1 $(MANDIR)/man1
+	chmod 644 $(PREFIX)/man1/XD.1
 
 uninstall: XD
-	rm -f $(PREFIX)/bin/XD
+	rm -f $(PREFIX)/bin/XD $(MANDIR)/man1/XD.1
diff --git a/XD.1 b/XD.1
new file mode 100644
index 0000000..ec4da56
--- /dev/null
+++ b/XD.1
@@ -0,0 +1,42 @@
+.Dd December 19, 2024
+.Dt XD 1
+.Sh NAME
+.Nm XD
+.Nd smiley face to explain info on the shell
+.Os
+.Sh SYNOPSIS
+.Nm
+.Op Fl v
+.Sh DESCRIPTION
+.Nm
+Displays information using a smiley face like so: :)
+to interpret it refer to the following tables:
+.Ss Eyes
+.TS
+tab(;) allbox;
+c;l.
+ :;default
+ \;;in a git repo
+ 8;in a git repo with stashed changes
+ B;in a git repo with no commits
+.TE
+.Ss Nose
+.TS
+tab(;) allbox;
+c;l.
+ ;default
+ *;current git repo has staged changes
+ ^;current git repo has untracked changes
+ -;git repo's HEAD is detached
+.TE
+.Ss Mouth
+.TS
+tab(;) allbox;
+c;l.
+ |;no signal provided
+ );previous signal is 0
+ O;SIGINT sen't (Ctrl-c)
+ P;permission denied
+ /;command not found
+ (;previous signal is failure
+.TE
diff --git a/config.mk b/config.mk
index 7ec485d..bf199e0 100644
--- a/config.mk
+++ b/config.mk
@@ -4,6 +4,7 @@ PKG_CONFIG = pkg-config
 
 # paths
 PREFIX = /usr/local
+MANDIR = $(PREFIX)/share/man
 
 GIT =
 GITLIB =