aboutsummaryrefslogtreecommitdiffstats
path: root/sumart.1
blob: 9ecabf9751d9782a194817021aadc5f372cf6f22 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
.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
The following exit values are returned:
.TP
0
Successful completion.
.TP
1
An error occurred.

.SH SEE ALSO
None.