diff options
| author | B. Watson <urchlay@slackware.uk> | 2025-11-29 04:22:46 -0500 |
|---|---|---|
| committer | B. Watson <urchlay@slackware.uk> | 2025-11-29 04:22:46 -0500 |
| commit | 4856221ec9a08d472390df8a9f669854a811814c (patch) | |
| tree | a44cc4588a6c92358a5e900616f8debd5532bda2 | |
| parent | 03d7065b337bb62db3f25f3ef3e330cc29929e03 (diff) | |
| download | alftools-4856221ec9a08d472390df8a9f669854a811814c.tar.gz | |
Add DIAGNOSTICS to alf man page.
| -rw-r--r-- | src/alf.1 | 25 | ||||
| -rw-r--r-- | src/alf.rst | 21 |
2 files changed, 46 insertions, 0 deletions
@@ -130,6 +130,31 @@ Success. .B 1 Fatal error (I/O or bad command\-line arguments). .UNINDENT +.SH DIAGNOSTICS +.sp +Besides the standard error messages such as "no such file or directory", \fBalf\fP +can generate warnings about the filenames it\(aqs compressing: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.TP +.B \fBfilename has underscore, OK on Sparta/MyDOS, not Atari DOS 2.x\fP +Not an actual problem, unless you try to extract this ALF file on +an Atari running Atari DOS 2.0/2.5, or any other DOS that doesn\(aqt +allow underscores in filenames. +.TP +.B \fBbad Atari filename\fP \fI<filename>\fP \fI<reason>\fP +The filename stored in the ALF header doesn\(aqt follow the rules for +Atari DOS filenames. \fI<reason>\fP will be something like "doesn\(aqt start +with A\-Z" or "invalid character". The filename will be printed with +any unprintable characters as hex values (e.g. \fB$01\fP). +.UNINDENT +.UNINDENT +.UNINDENT +.sp +The resulting \fIALF\fP archive will extract with \fBunalf\fP, but will have +problems with \fBDZ.COM\fP running on an Atari. Or you can just rename +the files so they comply with Atari DOS filename restrictions. .SH NOTES .SS Compatibility .sp diff --git a/src/alf.rst b/src/alf.rst index 4b011aa..59dc2af 100644 --- a/src/alf.rst +++ b/src/alf.rst @@ -104,6 +104,27 @@ EXIT STATUS 1 Fatal error (I/O or bad command-line arguments). +DIAGNOSTICS +=========== + +Besides the standard error messages such as "no such file or directory", **alf** +can generate warnings about the filenames it's compressing: + + **filename has underscore, OK on Sparta/MyDOS, not Atari DOS 2.x** + Not an actual problem, unless you try to extract this ALF file on + an Atari running Atari DOS 2.0/2.5, or any other DOS that doesn't + allow underscores in filenames. + + **bad Atari filename** *<filename>* *<reason>* + The filename stored in the ALF header doesn't follow the rules for + Atari DOS filenames. *<reason>* will be something like "doesn't start + with A-Z" or "invalid character". The filename will be printed with + any unprintable characters as hex values (e.g. **$01**). + +The resulting *ALF* archive will extract with **unalf**, but will have +problems with **DZ.COM** running on an Atari. Or you can just rename +the files so they comply with Atari DOS filename restrictions. + NOTES ===== |