summaryrefslogtreecommitdiff
path: root/man/man1/fire.1
diff options
context:
space:
mode:
Diffstat (limited to 'man/man1/fire.1')
-rw-r--r--man/man1/fire.159
1 files changed, 59 insertions, 0 deletions
diff --git a/man/man1/fire.1 b/man/man1/fire.1
new file mode 100644
index 0000000..c3f214f
--- /dev/null
+++ b/man/man1/fire.1
@@ -0,0 +1,59 @@
+.TH fire 1 2026-04-17 utils
+
+.SH NAME
+fire \- exothermic oxygenation
+
+.SH SYNOPSIS
+.SY fire
+.YS
+
+.SH DESCRIPTION
+.B fire
+is a shell script that prints a burning fire into the terminal.
+.P
+If you are cold, you can make a
+.B fire
+to use your computer as an electric heater.
+(Disclaimer:
+While
+.B fire
+may increase the CPU temperature from frequent calculation and printing,
+it is not guaranteed to do so. Its main purpose is to look pretty.)
+.P
+On a printer or a mechanical teletype terminal, it will only waste your paper and ink.
+
+.SH OPTIONS
+.B fire
+has no options at this time.
+
+.SH EXIT STATUS
+No exit status is defined.
+
+.SH NOTES
+.B fire
+does not use an artificial delay, but prints as fast as it can,
+This may be too slow or too fast to have the desired effect,
+but slowing it down is trivial by commenting out and adjusting the
+.BR sleep (1)
+command in the script, near the botton.
+Making it faster is not as trivial; the bottleneck is almost certainly the terminal.
+
+.SH BUGS
+.B fire
+requires that the terminal supports certain capabilities, such as
+ANSI escape codes for colour.
+It does not check for those capabilities, but it does make use of
+.BR tput (1).
+.P
+.B fire
+currently only uses ASCII characters and the standard 16 colour palette.
+.BR termcap (5)
+permitting, it should support 256 colours
+(there are currently no terminals supporting 16 bit or 24 bit palettes),
+and maybe use glyphs that are better suited for rendering a convincing fire.
+
+.SH EXAMPLES
+.B fire
+
+.SH SEE ALSO
+.BR rain (1)