aboutsummaryrefslogtreecommitdiff
path: root/src/unalf.1
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.1
parent32e2a0ceb6b36a8a2ded2b3b147c4bb294ca344e (diff)
downloadunalf-bf5425f6ae2e3666e232d003c6a8a32b38079383.tar.gz
Man page: group diagnostics into fatal errors and warnings.
Diffstat (limited to 'src/unalf.1')
-rw-r--r--src/unalf.129
1 files changed, 19 insertions, 10 deletions
diff --git a/src/unalf.1 b/src/unalf.1
index b424038..5ca8547 100644
--- a/src/unalf.1
+++ b/src/unalf.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 "UNALF" 1 "2025-11-21" "0.1.0" "Urchlay's Atari 8-bit Tools"
+.TH "UNALF" 1 "2025-11-22" "0.1.0" "Urchlay's Atari 8-bit Tools"
.SH NAME
unalf \- extract Atari 8-bit ALF archives
.\" RST source for unalf(1) man page. Convert with:
@@ -250,15 +250,22 @@ has a bad checksum.
.SH DIAGNOSTICS
.sp
Besides the standard error messages such as "no such file or directory":
+.SS Fatal errors
+.sp
+\fBunalf\fP will exit with status 1 immediately after these errors:
.INDENT 0.0
.TP
-.B \fBthis is an ARC file, not ALF\fP
+.B \fBfatal: this is an ARC file, not ALF\fP
Self\-explanatory. Use the \fBarc\fP(1) utility for this file.
.TP
-.B \fBnot an ALF file\fP
+.B \fBfatal: not an ALF file\fP
Self\-explanatory. Either the file is too small (less than 29 bytes)
or its first two bytes don\(aqt match the \fIALF\fP signature \fB0x1a\fP \fB0x0f\fP\&.
.TP
+.B \fBfatal: stack underrun/overrun\fP
+Generally means the archive is corrupt. Valid ALF files should never
+cause these errors.
+.TP
.B \fBjunk at EOF (ignored)\fP
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
@@ -266,17 +273,19 @@ file gets padded to the block size of the filesystem or protocol.
Usually, the padding characters are \fB0x1a\fP, aka ASCII control\-Z.
.sp
If you see this message, you can ignore it. It\(aqs intended to let
-you know that this .alf file can\(aqt be appended to by the \fBALF.COM\fP
-aka \fBLZ.COM\fP Atari utility.
+you know that this .alf file can\(aqt be appended to by the
+\fBLZ.COM\fP (aka \fBALF.COM\fP) Atari utility.
+.UNINDENT
+.SS Warnings
+.sp
+\fBunalf\fP will continue after these messages occur.
+.INDENT 0.0
.TP
.B \fBchecksum error on\fP \fI<file>\fP
The archive is corrupt. If \fI<file>\fP is a text file, it may be
partially readable. If it\(aqs an executable or other binary file, it\(aqs
-probably unrecoverable.
-.TP
-.B \fBstack underrun/overrun\fP
-Generally means the archive is corrupt. Valid ALF files should never
-cause these errors.
+probably unrecoverable. \fBunalf\fP will try to extract the rest of
+the archive, but will exit with status 2 when it\(aqs done.
.sp
If you have an ALF file that does this, try it with the Atari
\fBDZ.COM\fP and see if it has the same problem. If it doesn\(aqt,