aboutsummaryrefslogtreecommitdiff
path: root/src/alfsum.1
diff options
context:
space:
mode:
Diffstat (limited to 'src/alfsum.1')
-rw-r--r--src/alfsum.175
1 files changed, 75 insertions, 0 deletions
diff --git a/src/alfsum.1 b/src/alfsum.1
new file mode 100644
index 0000000..1f4ec5b
--- /dev/null
+++ b/src/alfsum.1
@@ -0,0 +1,75 @@
+.\" Man page generated from reStructuredText.
+.
+.
+.nr rst2man-indent-level 0
+.
+.de1 rstReportMargin
+\\$1 \\n[an-margin]
+level \\n[rst2man-indent-level]
+level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
+-
+\\n[rst2man-indent0]
+\\n[rst2man-indent1]
+\\n[rst2man-indent2]
+..
+.de1 INDENT
+.\" .rstReportMargin pre:
+. RS \\$1
+. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
+. nr rst2man-indent-level +1
+.\" .rstReportMargin post:
+..
+.de UNINDENT
+. RE
+.\" indent \\n[an-margin]
+.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.nr rst2man-indent-level -1
+.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
+.in \\n[rst2man-indent\\n[rst2man-indent-level]]u
+..
+.TH "ALFSUM" 1 "2025-11-04" "0.0.0" "Urchlay's Atari 8-bit Tools"
+.SH NAME
+alfsum \- calculate ALF checksums
+.\" RST source for alfsum(1) man page. Convert with:
+.
+.\" rst2man.py alfsum.rst > alfsum.1
+.
+.SH SYNOPSIS
+.sp
+alfsum \fBfile\fP [\fBfile\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\&.
+.SH NOTES
+.sp
+The checksum algorithm is very simple: all the bytes in the file are
+added together, and the low 16 bits of the result are the checksum.
+.SH EXIT STATUS
+.INDENT 0.0
+.TP
+.B 0
+Success.
+.TP
+.B 1 to 254
+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.
+.UNINDENT
+.SH COPYRIGHT
+.sp
+\fBunalf\fP is released under the WTPFL: Do WTF you want with this.
+.SH AUTHORS
+.INDENT 0.0
+.IP B. 3
+Watson <\fI\%urchlay@slackware.uk\fP>
+.UNINDENT
+.SH SEE ALSO
+.sp
+TODO
+.\" Generated by docutils manpage writer.
+.