.Dd Febuary 18, 2025
.Dt XD 1
.Sh NAME
.Nm XD
.Nd smiley face to explain info on the shell
.Os
.Sh SYNOPSIS
.Nm
.Op Fl v
.Op Fl e
.Op number
.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 sent (Ctrl-c)
 P;permission denied
 /;command not found
 (;previous signal is failure
.TE
.Sh OPTIONS
.Ss -v
Print version information to stdout and exit.
.Ss -e
Explain the output instead of putting a smiley face.

.Sh EXAMPLES
Running
.Nm
and passing in the previous return code ($?) results in a smiley face, if you
then follow that by \fBXD -e $?\fR then you will get an explination of what the
face is explaining.

$ \fBXD $?\fR
.br
:)
.br
$ \fBXD -e $?\fR
.br
Not in a git repository.
.br
Return code of 0, no errors.

$ \fBXD $?\fR
.br
;*O
.br
$ \fBXD -e $?\fR
.br
In a git repository.
.br
The're staged changes.
.br
Return code of 130, ctrl-c was pressed, or SIGTERM sent.