1Acorn-specific usage instructions
2---------------------------------
3
4As zipfiles can come from a variety of sources apart from Acorn machines,
5consideration had to be given to the handling of dot-extensions, e.g.
6"DOSFILE.TXT", "unix-filename.tar.gz". These are extracted as "DOSFILE/TXT"
7and "unix-filename/tar/gz"; their names may or may not be truncated,
8depending on where the files are being created: what filing system and, for
9Filecore-based filing systems such as ADFS or an IDEFS or SCSIFS, which
10disk/partition format (names will not be truncated if you're using E+ or F+).
11
12Where truncation occurs, you must be REALLY careful about extracting files
13from archives. The files
14
15    dummy_source.c and dummy_source.h
16
17will both be extracted as
18
19    dummy_sour
20
21UnZip will prompt you for confirmation of the over-writing of these files,
22but you must be really careful unless you wish to lose files! Also, because
23UnZip is a unix-ported program, the filenames are CASE SENSITIVE.
24
25    *unzip new/zip newfile
26
27will extract 'newfile', but not 'NewFile', 'NEWFILE' or any other
28combinations. However, you can use the -C option to force operations to
29disregard the case of filenames.
30
31The Acorn UnZip port has an additional feature to cope with the extraction of
32files containing 'c' code. As you may be aware, Acorn Desktop C requires all
33files called "foo.c" to be renamed to "c.foo", ie "foo" in a directory called
34"c".
35
36There are two ways of using this feature.
37
38- The old way: use a colon-separated environment variable named "Unzip$Exts".
39
40  Any extensions found in this variable will be extracted to directories
41  named after the extension, with the extension stripped. For example:
42
43    *Set Unzip$Exts "c:h:o:s"
44    *unzip foo/zip
45
46- The new way: use the -/ option. For example:
47
48  Any extensions found in the parameter for this option will be extracted to
49  directories named after the extension, with the extension stripped. For
50  example:
51
52    *unzip -/c:h:o:s foo/zip
53
54If foo/zip contains a file named "foo.c", this file will be written as "foo"
55in directory "c". This can be used to include "c:h:o:s:txt" to pull all the
56text files out to a separate directory.
57
58UnZip fully supports SparkFS Extra Field. This means that zipfiles created
59with SparkFS or Zip (on RISC OS) will be correctly unzipped, including
60filetypes.
61
62UnZipSFX can be used to create self-extracting archives. To use it, just
63create a common zipfile using Zip (or SparkFS), then load the UnZipSFX
64executable into an editor (eg. Edit, Zap), go with the caret the end of the
65file (using CTRL-CursorDown) and drag the zipfile to the editor window (in
66other words, append the zipfile to the UnZipSFX executable). Now, saving the
67resulting file (with filetype Absolute (&FF8)), you have a self-extracting
68archive (ie. double-clicking on it will unzip the contents of the original
69zipfile to the currently selected directory).
70