aboutsummaryrefslogtreecommitdiff
path: root/src/alf.rst
diff options
context:
space:
mode:
Diffstat (limited to 'src/alf.rst')
-rw-r--r--src/alf.rst47
1 files changed, 32 insertions, 15 deletions
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** *<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**).
- **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** *<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**).
+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
=====