From 11578e85cd04a79c8fa47e3f7ad9f09b9e55531a Mon Sep 17 00:00:00 2001 From: "B. Watson" Date: Mon, 1 Dec 2025 06:51:40 -0500 Subject: Update unalf man page. --- src/alf.1 | 31 +++++++++++++++++++++---------- src/alf.rst | 47 ++++++++++++++++++++++++++++++++--------------- 2 files changed, 53 insertions(+), 25 deletions(-) diff --git a/src/alf.1 b/src/alf.1 index 3733915..763b404 100644 --- a/src/alf.1 +++ b/src/alf.1 @@ -36,7 +36,7 @@ alf \- create Atari 8-bit ALF archives . .SH SYNOPSIS .sp -alf [\fB\-\-help\fP] | [\fB\-a\fP | \fB\-o\fP ] [\fB\-t[dgz]\fP] \fIalf\-file\fP \fIfile\fP [\fIfile\fP ...] +alf [\fB\-\-help\fP] | [\fB\-\-version\fP | \fB\-V\fP | [\fB\-a\fP | \fB\-o\fP ] [\fB\-t[dgz]\fP] [\fB\-v\fP] \fIalf\-file\fP \fIfile\fP [\fIfile\fP ...] .SH DESCRIPTION .sp \fBalf\fP creates \fIALF\fP archives. @@ -114,6 +114,11 @@ Use zero for timestamps (0 ??? 80 12:00a). . .INDENT 0.0 .TP +.B \-v +Verbose operation. Shows more information about what \fBalf\fP is doing. +Can be given twice for more detail, or 3 times to dump the token +tables (\fIlots\fP of output; for debugging only). +.TP .B \-V\fP,\fB \-\-version Show \fBunalf\fP version number and exit. .UNINDENT @@ -132,10 +137,9 @@ 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 +Besides the standard error messages such as "no such file or +directory": +.SS Filenames .INDENT 0.0 .TP .B \fBfilename has underscore, OK on Sparta/MyDOS, not Atari DOS 2.x\fP @@ -149,12 +153,19 @@ Atari DOS filenames. \fI\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. +With either of the above, 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. +.SS File Size +.INDENT 0.0 +.TP +.B \fBthis file is too large; only compressing the first 16MB.\fP +The \fIALF\fP file format doesn\(aqt support files larger than +16MB. Actually the \fIfile format\fP does, but the decompressor +(either \fBDZ.COM\fP or \fBunalf\fP) does not. +.UNINDENT .SH NOTES .SS Compatibility .sp diff --git a/src/alf.rst b/src/alf.rst index 0d2020e..6c68cce 100644 --- a/src/alf.rst +++ b/src/alf.rst @@ -21,7 +21,7 @@ create Atari 8-bit ALF archives SYNOPSIS ======== -alf [**--help**] | [**-a** | **-o** ] [**-t[dgz]**] *alf-file* *file* [*file* ...] +alf [**--help**] | [**--version** | **-V** | [**-a** | **-o** ] [**-t[dgz]**] [**-v**] *alf-file* *file* [*file* ...] DESCRIPTION =========== @@ -88,6 +88,11 @@ OPTIONS .. use zero timestamps. +-v + Verbose operation. Shows more information about what **alf** is doing. + Can be given twice for more detail, or 3 times to dump the token + tables (*lots* of output; for debugging only). + -V, --version Show **unalf** version number and exit. @@ -107,23 +112,35 @@ EXIT STATUS DIAGNOSTICS =========== -Besides the standard error messages such as "no such file or directory", **alf** -can generate warnings about the filenames it's compressing: +Besides the standard error messages such as "no such file or +directory": + +Filenames +--------- + +**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** ** ** + The filename stored in the ALF header doesn't follow the rules for + Atari DOS filenames. ** 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**). - **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. +With either of the above, 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. - **bad Atari filename** ** ** - The filename stored in the ALF header doesn't follow the rules for - Atari DOS filenames. ** 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**). +File Size +--------- -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. +**this file is too large; only compressing the first 16MB.** + The *ALF* file format doesn't support files larger than + 16MB. Actually the *file format* does, but the decompressor + (either **DZ.COM** or **unalf**) does not. NOTES ===== -- cgit v1.2.3