aboutsummaryrefslogtreecommitdiff
path: root/src/alfsum.rst
diff options
context:
space:
mode:
authorB. Watson <urchlay@slackware.uk>2025-11-13 05:39:38 -0500
committerB. Watson <urchlay@slackware.uk>2025-11-13 05:39:38 -0500
commite2da2bffe58a76c091d3496bd3ca2d2f18ea2eb6 (patch)
tree5195b221457842d781fadcb94331c93058046744 /src/alfsum.rst
downloadunalf-e2da2bffe58a76c091d3496bd3ca2d2f18ea2eb6.tar.gz
initial commit
Diffstat (limited to 'src/alfsum.rst')
-rw-r--r--src/alfsum.rst65
1 files changed, 65 insertions, 0 deletions
diff --git a/src/alfsum.rst b/src/alfsum.rst
new file mode 100644
index 0000000..1d1ee87
--- /dev/null
+++ b/src/alfsum.rst
@@ -0,0 +1,65 @@
+.. RST source for alfsum(1) man page. Convert with:
+.. rst2man.py alfsum.rst > alfsum.1
+
+.. |version| replace:: 0.0.0
+.. |date| date::
+
+======
+alfsum
+======
+
+-----------------------
+calculate ALF checksums
+-----------------------
+
+:Manual section: 1
+:Manual group: Urchlay's Atari 8-bit Tools
+:Date: |date|
+:Version: |version|
+
+SYNOPSIS
+========
+
+alfsum **file** [**file** ...]
+
+DESCRIPTION
+===========
+
+**alfsum** calculates the checksums used by the **ALF** compression
+utility on the Atari 8-bit platform.
+
+There are no options. Use **-** to read from standard input. Use
+**./-file** to read a file whose name begins with **-**.
+
+NOTES
+=====
+
+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.
+
+EXIT STATUS
+===========
+
+0
+ Success.
+
+1 to 254
+ File I/O error count. If there are more than 254 I/O errors, 254 is returned.
+
+255
+ Error in command-line arguments.
+
+COPYRIGHT
+=========
+
+**unalf** is released under the WTPFL: Do WTF you want with this.
+
+AUTHORS
+=======
+
+B. Watson <urchlay@slackware.uk>
+
+SEE ALSO
+========
+
+TODO