utils

commit: b487c1fa18e42c2167995e87b0aa862480067970
parent: ff0ca5579d96693932a58a5edb33f429f0d97088
Author: Haelwenn (lanodan) Monnier <contact@hacktivis.me>
Date:   Sun,  3 Mar 2019 04:10:34 +0100

src/lolcat.1: Add manpage for src/lolcat.c

Diffstat:
A
src/lolcat.1
29
+++++++++++++++++++++++++++++

1 file changed, 29 insertions(+), 0 deletions(-)
diff --git a/src/lolcat.1 b/src/lolcat.1
@@ -0,0 +1,29 @@
+.Dd 2019-03-03
+.Dt LOLCAT 1
+.Os
+.Sh NAME
+.Nm lolcat
+.Nd Put a truecolor rainbow filter
+.Sh SYNOPSIS
+.Nm
+takes no options
+.Sh DESCRIPTION
+.Nm
+takes each character from it's standard input and prints it with a truecolor escape sequence, making the text output rainbow colored given enough characters.
+.Sh KNOWN ISSUES & LIMITATIONS
+.Bl
+.It
+Does not strip already existing escape codes, thus creating a mess when some are already present, considered a non-issue since programs should avoid coloring piped output.
+.It
+Frequence is not adjustable yet
+.It
+.Nm
+puts escape codes even when stdout isn't a tty, this is expected, do not call
+.Nm
+otherwise
+.Sh EXIT STATUS
+.Ex -std
+.Sh SEE ALSO
+.Lk https://github.com/busyloop/lolcat "Original lolcat program, in ruby"
+.Sh AUTHORS
+.An Haelwenn (lanodan) Monnier Aq Mt contact@hacktivis.me