First commit

Signed-off-by: Mattias Andrée <m@maandree.se>

1 files changed, 79 insertions, 0 deletions

diff --git a/sumart.1 b/sumart.1
new file mode 100644
index 0000000..bf50214
--- /dev/null
+++ b/sumart.1
@@ -0,0 +1,79 @@
+.TH SUMART 1 SUMART
+.SH NAME
+sumart \- Visualise a checksum
+
+.SH SYNOPSIS
+.B sumart
+.RI [ rows
+.IR columns ]
+.RI [ checksum ]
+
+.SH DESCRIPTION
+The
+.B sumart
+utility creates a visualisation of a checksum
+using symbols and colours in a grid.
+.PP
+If no
+.I checksum
+is specified, it is read from the standard input.
+.PP
+Any symbol that is not a hexadecimal digit
+is silently discarded from the checksum.
+
+.SH OPTIONS
+The
+.B sumart
+utility conforms to the Base Definitions volume of
+POSIX.1-2024,
+.IR "Section 12.2" ,
+.IR "Utility Syntax Guidelines" .
+.PP
+No options are supported.
+
+.SH OPERANDS
+The following operands are supported:
+.TP
+.I rows
+The number of rows tall the visualisation should be.
+.TP
+.I colums
+The number of columns wide the visualisation should be.
+.TP
+.I checksum
+The checksum to visualise.
+
+.SH STDIN
+The
+.B sumart
+utility reads the checksum from the standard input
+if no checksum is specified.
+
+.SH INPUT FILES
+None.
+
+.SH ENVIRONMENT VARIABLES
+No environment variables affect the execution of sumart.
+
+.SH STDOUT
+The
+.B sumart
+utility prints the visualisation to the
+standard output.
+
+.SH STDERR
+The standard error is only used for diagnostic messages.
+
+.SH OUTPUT FILES
+None.
+
+.SH EXIT STATUS
+.TP
+0
+Successful completion.
+.TP
+1
+An error occurred.
+
+.SH SEE ALSO
+None.