aboutsummaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorB. Watson <urchlay@slackware.uk>2025-11-20 02:39:53 -0500
committerB. Watson <urchlay@slackware.uk>2025-11-20 02:39:53 -0500
commita0b3efe4e52d4d95ea2b76c21d9d308127be64ca (patch)
tree665aa691f077f3523aeed73f5b8ba8521515fe2a
parent6259ba06fcf9574eae28c9c3222e14605c2cf27b (diff)
downloadunalf-a0b3efe4e52d4d95ea2b76c21d9d308127be64ca.tar.gz
Expand alfsum man page a bit.
-rw-r--r--src/alfsum.110
-rw-r--r--src/alfsum.rst8
2 files changed, 15 insertions, 3 deletions
diff --git a/src/alfsum.1 b/src/alfsum.1
index 127b2f4..82919bf 100644
--- a/src/alfsum.1
+++ b/src/alfsum.1
@@ -27,7 +27,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
..
-.TH "ALFSUM" 1 "2025-11-18" "0.1.0" "Urchlay's Atari 8-bit Tools"
+.TH "ALFSUM" 1 "2025-11-20" "0.1.0" "Urchlay's Atari 8-bit Tools"
.SH NAME
alfsum \- calculate ALF checksums
.\" RST source for alfsum(1) man page. Convert with:
@@ -42,10 +42,16 @@ alfsum \fBfile\fP [\fBfile\fP ...] | [\fB\-\-help\fP | \fB\-h\fP] | [\fB\-\-vers
\fBalfsum\fP calculates the checksums used by the \fBALF\fP compression
utility on the Atari 8\-bit platform.
.sp
-To read from standard input, use \fB\-\fP as a filename
+To read from standard input, use \fB\-\fP as a filename.
.sp
Output lines have a tab separating the checksum and filename, for ease
of scripting (e.g. with \fBcut\fP(1) or \fBawk\fP(1)).
+.sp
+\fBalfsum\fP\(aqs primary use is to check files extracted from \fBALF\fP
+archives against the checksums stored in the archive. The \fBunalf\fP
+program already does this, but \fBalfsum\fP is a separate (much simpler)
+program. It serves as a second opinion, in case you suspect a bug in
+\fBunalf\fP\&.
.SH OPTIONS
.INDENT 0.0
.TP
diff --git a/src/alfsum.rst b/src/alfsum.rst
index cf9c7d3..03ab2f5 100644
--- a/src/alfsum.rst
+++ b/src/alfsum.rst
@@ -29,11 +29,17 @@ DESCRIPTION
**alfsum** calculates the checksums used by the **ALF** compression
utility on the Atari 8-bit platform.
-To read from standard input, use **-** as a filename
+To read from standard input, use **-** as a filename.
Output lines have a tab separating the checksum and filename, for ease
of scripting (e.g. with **cut**\(1) or **awk**\(1)).
+**alfsum**'s primary use is to check files extracted from **ALF**
+archives against the checksums stored in the archive. The **unalf**
+program already does this, but **alfsum** is a separate (much simpler)
+program. It serves as a second opinion, in case you suspect a bug in
+**unalf**.
+
OPTIONS
=======