aboutsummaryrefslogtreecommitdiff
path: root/src/unalf.rst
diff options
context:
space:
mode:
authorB. Watson <urchlay@slackware.uk>2025-11-22 02:30:02 -0500
committerB. Watson <urchlay@slackware.uk>2025-11-22 02:30:02 -0500
commitbf5425f6ae2e3666e232d003c6a8a32b38079383 (patch)
tree038d616ae389e87519f6afef4ba2cbbff3b0ba80 /src/unalf.rst
parent32e2a0ceb6b36a8a2ded2b3b147c4bb294ca344e (diff)
downloadunalf-bf5425f6ae2e3666e232d003c6a8a32b38079383.tar.gz
Man page: group diagnostics into fatal errors and warnings.
Diffstat (limited to 'src/unalf.rst')
-rw-r--r--src/unalf.rst29
1 files changed, 20 insertions, 9 deletions
diff --git a/src/unalf.rst b/src/unalf.rst
index ef4d928..a1b8abe 100644
--- a/src/unalf.rst
+++ b/src/unalf.rst
@@ -206,13 +206,22 @@ DIAGNOSTICS
Besides the standard error messages such as "no such file or directory":
-**this is an ARC file, not ALF**
+Fatal errors
+------------
+
+**unalf** will exit with status 1 immediately after these errors:
+
+**fatal: this is an ARC file, not ALF**
Self-explanatory. Use the **arc**\(1) utility for this file.
-**not an ALF file**
+**fatal: not an ALF file**
Self-explanatory. Either the file is too small (less than 29 bytes)
or its first two bytes don't match the *ALF* signature **0x1a** **0x0f**\.
+**fatal: stack underrun/overrun**
+ Generally means the archive is corrupt. Valid ALF files should never
+ cause these errors.
+
**junk at EOF (ignored)**
Usually this is caused by the .alf file being stored on a CP/M disk
at some time, or by a dumb file transfer protocol. Either way, the
@@ -220,17 +229,19 @@ Besides the standard error messages such as "no such file or directory":
Usually, the padding characters are **0x1a**, aka ASCII control-Z.
If you see this message, you can ignore it. It's intended to let
- you know that this .alf file can't be appended to by the **ALF.COM**
- aka **LZ.COM** Atari utility.
+ you know that this .alf file can't be appended to by the
+ **LZ.COM** (aka **ALF.COM**) Atari utility.
+
+Warnings
+--------
+
+**unalf** will continue after these messages occur.
**checksum error on** *<file>*
The archive is corrupt. If *<file>* is a text file, it may be
partially readable. If it's an executable or other binary file, it's
- probably unrecoverable.
-
-**stack underrun/overrun**
- Generally means the archive is corrupt. Valid ALF files should never
- cause these errors.
+ probably unrecoverable. **unalf** will try to extract the rest of
+ the archive, but will exit with status 2 when it's done.
If you have an ALF file that does this, try it with the Atari
**DZ.COM** and see if it has the same problem. If it doesn't,