From ebfad791508af77f7f8e942c88a6f5dc88bd6d41 Mon Sep 17 00:00:00 2001 From: "B. Watson" Date: Tue, 18 Nov 2025 06:57:14 -0500 Subject: Improve alfsum usage a bit. --- src/alfsum.1 | 21 ++++++++++++++++----- 1 file changed, 16 insertions(+), 5 deletions(-) (limited to 'src/alfsum.1') diff --git a/src/alfsum.1 b/src/alfsum.1 index 6c51056..127b2f4 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-17" "0.1.0" "Urchlay's Atari 8-bit Tools" +.TH "ALFSUM" 1 "2025-11-18" "0.1.0" "Urchlay's Atari 8-bit Tools" .SH NAME alfsum \- calculate ALF checksums .\" RST source for alfsum(1) man page. Convert with: @@ -36,14 +36,25 @@ alfsum \- calculate ALF checksums . .SH SYNOPSIS .sp -alfsum \fBfile\fP [\fBfile\fP ...] +alfsum \fBfile\fP [\fBfile\fP ...] | [\fB\-\-help\fP | \fB\-h\fP] | [\fB\-\-version\fP | \fB\-V\fP] .SH DESCRIPTION .sp \fBalfsum\fP calculates the checksums used by the \fBALF\fP compression utility on the Atari 8\-bit platform. .sp -There are no options. Use \fB\-\fP to read from standard input. Use -\fB\&./\-file\fP to read a file whose name begins with \fB\-\fP\&. +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)). +.SH OPTIONS +.INDENT 0.0 +.TP +.B \-h\fP,\fB \-\-help +Show built\-in help message. +.TP +.B \-V\fP,\fB \-\-version +Show \fBalfsum\fP version number and exit. +.UNINDENT .SH NOTES .sp The checksum algorithm is very simple: all the bytes in the file are @@ -58,7 +69,7 @@ Success. File I/O error count. If there are more than 254 I/O errors, 254 is returned. .TP .B 255 -Error in command\-line arguments. +Error in command\-line arguments: no filenames given. .UNINDENT .SH COPYRIGHT .sp -- cgit v1.2.3