@database lzx.guide @author "Jonathan Forbes" @(c) "Copyright © 1995 Data Compression Technologies" @$VER: LZX Documentation 1.0 (February 1995) @node Main "LZX Documentation" @{b}LZX - The New Amiga Archiver@{ub} Version 1.00 February 5, 1995 Copyright © 1995 Data Compression Technologies @{" Introduction " Link Introduction} @{" System requirements " Link SystemRequirements} @{" Commands " Link Commands} @{" Options " Link Options} @{" Environment variables " Link EnvironmentVariables} @{" Limitations " Link Limitations} @{" Benchmarks " Link Benchmarks} @{" Registration and the future " Link FutureAndRegistration} @{" Glossary " Link Glossary} @endnode @node Introduction "Introduction" @{b}INTRODUCTION@{ub} LZX is a brand new data compression program developed on and for the Amiga, sporting mind-blowing compression rates, and brain-staggering speed. LZX is a co-development between @{" Jonathan Forbes " Link AboutJonathan} (author of the LZ and LX archivers, as well as the commercial Bulletin Board Software package Xenolink), and @{" Tomi Poutanen " Link AboutTomi}. LZX uses compression technology that is absolutely state of the art, and offers a compression/performance ratio superior to that of all other programs for the Amiga, as well as to all programs for MS-DOS. @endnode @node AboutJonathan "About Jonathan" @{b}ABOUT JONATHAN@{ub} Jonathan is 21 years of age, and is a fourth year Computer Engineering student at the University of Waterloo. The Computer Engineering curriculum is a continuous 5 year co-op programme (no holidays) including 6 four month terms of employment and the standard 4 academic years. Jonathan has worked on contract for Communications Canada, where he developed a real-time eye tracking software library, and for Northern Telecom for over a year, where he was involved with the development of Northern Telecom's Meridian IVR (Interactive Voice Response) Fax Response software. Jonathan was born in the United Kingdom, but moved to Canada in 1986, where he abandoned his BBC Microcomputer 32K for an Amiga 1000. In 1988 he learned C, and in 1989 he learned 68000 assembly language, and he has participated heavily in the evolution of Amiga data compression programs ever since; see the @{" archiver chronology " Link Glossary_Archiver_Chronology} for details. Jonathan is the author of the @{" Lhunarc " Link Glossary_Lhunarc} @{" LZ " Link Glossary_LZ} and @{" LX " Link Glossary_LX} compression programs, as well as @{" Xenolink " Link Xenolink}, the commercial Bulletin Board Software package. Jonathan currently owns an Amiga 3000 with a 35 MHz 68040 card (and not much else), and his original Amiga 1000. @endnode @node AboutTomi "About Tomi" @{b}ABOUT TOMI@{ub} Tomi is a Finnish citizen currently residing in Canada. He was born into a Swedish speaking family in Finland in 1972. Besides Finland and Canada, Tomi has lived in Germany, Austria, Kuwait, Cameroon and the U.S. He emmigrated to Canada in 1985 and has resided in Toronto ever since. Tomi is a fourth year Computer Engineering student at the University of Waterloo. As part of the co-operative work programme, he has worked for Reuters, Honeywell, and as a Software Design Engineer and a Program Manager for Microsoft. Since its inception, LZX has been developed simultaneously on the Amiga and the PC. The compression related research was conducted by both Jonathan and Tomi in portable C, and once complete, was separated for the two platforms. Jonathan is responsible for development on the Amiga platform, and Tomi is responsible for the PC platform. As of the release of this Amiga version, Tomi is trying to negotiate the hardships of the MS-DOS platform, such as the 64K segments and the lack of usable RAM. The Amiga has proved to be a much more efficient and flexible platform to develop under. As a result, the PC version is several months behind, requires the development of new technology, and as a result, may ultimately have to sacrifice performance to operate efficiently under the platform restrictions. Fortunately, the Win95 and WinNT platforms have overcome the aformentioned shortcomings and as a consequence, the archiver will first be built around Win32 technology, while providing a DOS decompressor. A DOS archiver will follow at a later date. For development, Tomi uses a 486/50DX2 with 24 MB RAM running Windows NT 3.51. @endnode @node Xenolink "Xenolink" @{b}XENOLINK@{ub} Xenolink is the fastest commercial Bulletin Board Software package available for the Amiga; if you think LZX is fast and efficient, consider that Xenolink has been developed continuously since its first release in 1990. Xenolink offers superlative reliability, state of the art software design, an object oriented door interface, full multi-line capability, foreign language support, an attractive user interface, and is very easy to use. Xenolink also offers unparalleled support through a large private network linking together hundreds of Xenolink owners. For a complete Xenolink feature list, as well as current pricing, write to: Xenomiga Technology 383 Lawrence Avenue West Toronto, Ontario M5M 1B9 Canada A demo version of Xenolink will be available within the next 2 months, so please send your name and address if you would like to be mailed a copy of the demo version as soon as it is available. Note: Xenolink is currently available at almost half price through a limited time promotional offer. Please write for details. @endnode @node SystemRequirements "System Requirements" @{b}SYSTEM REQUIREMENTS@{ub} LZX will run on an Amiga with any 680x0 CPU and AmigaDOS 1.2 or later, although it prefers AmigaDOS Release 2 or later. If running on AmigaDOS 1.2 or 1.3, LZX will attempt to open @{" arp.library " Link ArpLibrary} to emulate functionality missing from the early versions of AmigaDOS; if arp.library is then not available, some @{" functionality " Link MissingFunctionality} will be missing from LZX. By default, LZX requires approximately 500K of RAM to archive files, and this includes the size of the LZX executable and the stack. To decompress files, LZX requires approximately 175K of RAM, and this also includes the size of the LZX executable and the stack. LZX's command line options allow it to be configured to use @{" less memory " Link LessMemory}, however. Three versions of LZX are provided, to support the 6 different CPU's in the Motorola 680x0 series. Each version has been hand-crafted to provide optimal performance for two particular CPUs. @{" More CPU Info " Link MoreCPUInfo} @endnode @node MoreCPUInfo "More information on CPU dependent versions of LZX" @{b}CPU INFO@{ub} Versions are provided for the 68000/68010, the 68020/68030, and the 68040/68060, and are named LZX_68000EC, LZX_68020, and LZX_68040, respectively. In addition, only the 68000/68010 version supports AmigaDOS 1.3; the 68020/68030 and 68040/68060 versions do not. Users with a 68000 or 68010 CPU can run only the 68000/68010 version, while users with a 68020-68060 CPU can run any version if they have AmigaDOS Release 2 or later. LZX has been carefully hand-crafted for each CPU; performance will be degraded somewhat if running a version not optimised for your CPU. Unlike most programs which provide CPU depdendent versions, LZX was designed around the instruction set of the 68020-68060, which required that the 68000/68010 version be specially written to use only 68000/68010 instructions. The 68000/68010 version has all of the functionality of the other versions, but receives the "EC" (economy) designation to identify it as being somewhat different internally. The 68000/68010 version runs a little more slowly than the other versions, but not much more slowly. Two special versions providing even higher performance are in the works for registered owners of LZX; 68020/68030 ZX and 68040/68060 ZX. These versions use more memory than the standard LZX, but are even faster. The LZX @{" family tree " Link FamilyTree} is fairly extensive! @endnode @node FamilyTree "LZX Family Tree" @{b}LZX FAMILY TREE@{ub} 68000/68010 EC Evaluation Evaluation version for 68000/68010 68020/68030 Evaluation Evaluation version for 68020/68030 68040/68060 Evaluation Evaluation version for 68040/68060 68000/68010 EC Registered Registered version for 68000/68010 68020/68030 Registered Registered version for 68020/68030 68040/68060 Registered Registered version for 68040/68060 68020/68030 ZX Registered High performance registered version for 68020/68030 68040/68060 ZX Registered High performance registered version for 68040/68060 @endnode @node ArpLibrary "arp.library" @{b}ARP.LIBRARY@{ub} The arp.library was created by individuals as part of the AmigaDOS Resource Project (but not affiliated with Commodore in any way) for AmigaDOS Release 1 (versions 1.2 and 1.3). Its intent was to provide additional functionality not present in AmigaDOS at that time, including the developer-friendly wildcarding functions and date<->string functions that LZX uses. All of these features (and more) were added in AmigaDOS Release 2, making arp.library redundant there. However, for users running AmigaDOS 1.2 or 1.3, arp.library provides very useful functionality for software developers. @endnode @node MissingFunctionality "Missing functionality due to lack of arp.library" @{b}MISSING FUNCTIONALITY@{ub} If running AmigaDOS 1.2 or 1.3 and arp.library is not present, LZX will not support wildcarding or directory recursion. For example, the following commands would not work: lzx a cdir.lzh c:#? lzx -x -r a test.lzh #?.info @endnode @node LessMemory "Lower memory usage" @{b}LOWER MEMORY USAGE@{ub} The @{" -bi " Link OptSetInputBufferSize} and @{" -bo " Link OptSetOutputBufferSize} options allow one to set LZX's input and output buffer sizes, respectively, and the @{" -w " Link OptSetWorkDirectory} parameter allow one to specify LZX's work directory, which defaults to "T:", which is usually assigned to "RAM:T". Portions of LZX are currently being improved to use significantly less memory. @endnode @node Glossary "Glossary" @{b}GLOSSARY@{ub} Glossary of terms and archiving programs: @{" ARJ " Link Glossary_ARJ} @{" Compression " Link Glossary_Compression} @{" Compression ratio " Link Glossary_CompressionRatio} @{" CRC " Link Glossary_CRC} @{" Decompression " Link Glossary_Decompression} @{" File merging " Link Glossary_FileMerging} @{" Lharc (Amiga) " Link Glossary_Lharc_Amiga} @{" LHARC (DOS) " Link Glossary_LHARC_DOS} @{" LharcA " Link Glossary_LharcA} @{" LhA (Amiga) " Link Glossary_LhA_Amiga} @{" LHA (DOS) " Link Glossary_LHA_DOS} @{" Lhunarc " Link Glossary_Lhunarc} @{" LX " Link Glossary_LX} @{" LZ " Link Glossary_LZ} @{" LZX " Link Glossary_LZX} @{" PKZIP " Link Glossary_PKZIP} @endnode @node Glossary_ARJ "ARJ (DOS)" @{b}ARJ@{ub} ARJ is an archiving program for MS-DOS. Its main attractions are its huge array of features, and easy-to-use implementation of multi-volume archiving. It is generally slower and less compressive than PKZIP. There is no ARJ archiver for the Amiga, although there is an UNARJ program which can decompress ARJ archives. Author: Robert Jung @endnode @node Glossary_Compression "Compression" @{b}COMPRESSION@{ub} The process by which data is represented in a more compact fashion by eliminating redundancies. @endnode @node Glossary_CompressionRatio "Compression ratio" @{b}COMPRESSION RATIO@{ub} There are two popular ways of representing a compression ratio as a percentage; either as the size of the input divided by the size of the output (times 100), or as 100% minus the aforementioned ratio. LZX uses the former method, since it is more intuitive; if a file has a compression ratio of 35%, then it was compressed to 35% of its original size. A program which didn't compress at all will have a compression ratio of 100%. Note that programs such as LZ and LhA use the second type of ratio, so a file which compressed to 35% of its original size would be represented by a compression ratio of 65%. @endnode @node Glossary_CRC "CRC" @{b}CRC@{ub} CRC stands for Cyclic Redundancy Check, and is generally superior to a checksum for checking data integrity. LZX uses a 32-bit CRC for greater error detection, rather than the 16-bit CRC used by the LHA programs. @endnode @node Glossary_Decompression "Decompression" @{b}DECOMPRESSION@{ub} Decompression is the process of converting compressed data back into its original form. @endnode @node Glossary_FileMerging "File merging" @{b}FILE MERGING@{ub} File merging is a feature of LZX which enables compression to be increased, often very significantly, by allowing data from one file to be compressed using the knowledge of previous files in the archive. This feature, unique to LZX on the Amiga, often improves compression by 300% or more! @{" Example " Link FileMergingExample1} This feature is very useful when compressing text files and source files, where there is often a large amount of text common to many files. @{" Example " Link FileMergingExample2} There is also a significant advantage to this feature when compressing a large number of small files, since the data overhead of re-starting compression for each file is now removed. This is particularly true when compressing ".info" files. @{" Example " Link FileMergingExample3} Even decompression time is improved, since there is now much less compressed data to procress. There are only minor disadvantages to file merging, which appear when deleting files from a merged group, or extracting only some (but not all) files from a merged group. To see the advantages of file merging first-hand, try recompressing the LZX distribution archive with LZX; LZX will compress the three executables (for the 68000/68010, 68020/68030, and 68040/68060) down to a tiny size because they are fairly similar. @endnode @node FileMergingDisadvantages "File merging disadvantages" @{b}FILE MERGING DISADVANTAGES@{ub} When extracting only some files (but not all) from a merged group, all of the files in the merged group up to the last one to be extracted, must be decompressed internally. Luckily, LZX is obscenely quick at decompressing files, so this is not a significant setback. @{" Example " LinkFileMergingDeletionExample} When deleting files from a merged group, the whole group must be decompressed internally, and the files which are not to be deleted must be recompressed. Deleting a small file from a very large merged group can be time consuming, which is why LZX, by default, limits the maximum size of a merged group. @endnode @node FileMergingDeletionExample "Deleting from a merged file group" @{b}EXAMPLE OF DELETING FROM A MERGED FILE GROUP@{ub} Assume that the following files were merged into a single group within the archive: File1 File2 File3 File4 In order to delete File3, the whole group (File1, File2, File3, File4) would have to be decompressed internally, and then File1, File2, and File4 would be recompressed. The decompression and recompression (if necessary) is performed transparently by LZX when deleting from archives. @endnode @node FileMergingExample1 "File merging example" @{b}EXAMPLE OF FILE MERGING@{ub} For example, in the archive "XPRZ31.LHA" (xprzmodem.library, version 3.1), 4 versions of the xprzmodem.library are distributed, comprising a total of 90932 bytes: * One for the 68000/68010 with AmigaDOS Release 1.x * One for the 68000/68010 with AmigaDOS Release 2.x * One for the 68020-68040 with AmigaDOS Release 1.x * One for the 68020-68040 with AmigaDOS Release 2.x While LhA 1.50r compresses these four files to 52985 bytes, LZX compresses *all four* to an unbeliveable 17148 bytes, only marginally more than the 12758 bytes it took to compress just one of the four files. This is due to LZX's ability to transparently look for compressible data across multiple files, before adding them to an archive. @endnode @node FileMergingExample2 "File merging example" @{b}EXAMPLE OF FILE MERGING@{ub} For example, all of the header (".h") files in the SAS/C 6.5x include directory, comprising 980K of data, compress to 345K with LhA 1.50r, and to 254K with LZX. @endnode @node FileMergingExample3 "File merging example" @{b}EXAMPLE OF FILE MERGING@{ub} For example, when compressing the icons as part of the Magic Workbench distribution, LhA 1.50r compresses 352K of icon data to 90K, while LZX compresses the data down to 62K. @endnode @node Glossary_PKZIP "PKZIP (DOS)" @{b}PKZIP@{ub} PKZIP is an archiving program for MS-DOS. Its main attractions are its speed and good compression. It has long been the market leading program for DOS. InfoZip, a PKZIP-compatible archiver, is available for the Amiga, as is Unzip, a decompressor for ZIP files. Author: Phil Katz (PKWare Inc.) @endnode @node Glossary_LHARC_DOS "LHARC (DOS)" @{b}LHARC@{ub} LHARC is one of the original archiving programs for DOS. LHARC compression is supported on the Amiga in the form of the "-lh1-" compression format, which is supported by Lharc, LZ, LX, and LhA. The second version of LHARC was renamed LHA. Author: Haruyasu Yoshizaki @endnode @node Glossary_Lharc_Amiga "Lharc" @{b}LHARC (Amiga)@{ub} Lharc was the first program to support the -lh1- (LZH) format on the Amiga, and started the rapid move away from .arc and .zoo files. Although Lharc was later superseded by other compatible utilities, it deserves credit as the first LZH program for the Amiga. Author: Paolo Zibetti @endnode @node Glossary_LharcA "LhArcA" @{b}LHARCA@{ub} LhArcA is an archiving program supporting the -lh1- (LZH) format. When released, it was far faster than its only competition, Amiga Lharc. It was later supplanted in its position by LZ. Author: Stefan Boberg @endnode @node Glossary_LHA_DOS "LHA (DOS)" @{b}LHA@{ub} LHA is the second version of LHARC for DOS. The LHA format is supported on the Amiga in the form of the "-lh5-" compression modes supported by LZ, LX, and LhA. Most popular compression programs in use today were originally based on the source code or ideas of "AR002" (an LHA compatible program), although most programs have advanced since then. Author: Haruyasu Yoshizaki @endnode @node Glossary_LhA_Amiga "LhA" @{b}LHA@{ub} LhA is an archiver for the Amiga, supporting both the -lh1- (LZH) and -lh5- (LHA) compression formats. Since its inception in late 1991, LhA has been the fastest archiver for -lh1- and -lh5- files, although it was supplanted by LX in 1993 for the fastest decompression of these files. Author: Stefan Boberg @endnode @node Glossary_Lhunarc "Lhunarc" @{b}LHUNARC@{ub} Lhunarc is a decompressor for -lh1- (LZH) files, and was the first program to provide high speed decoding (for that era) on the Amiga. Lhunarc was the precursor to LZ 0.80. Author: Jonathan Forbes @endnode @node Glossary_LX "LX" @{b}LX@{ub} LX is a decompression only utility, supporting both the -lh1- (LZH) and -lh5- (LHA) compression formats. LX's claims to fame are a small code size (16K) (ideal for installation applications), asynchronous disk i/o (ideal for floppy drive applications), and fast decompression (the fastest available for LZH or LHA files). Author: Jonathan Forbes @endnode @node Glossary_LZ "LZ" @{b}LZ@{ub} LZ is an archiver for the Amiga, supporting both the -lh1- (LZH) and -lh5- (LHA) compression formats. It was the first program for the Amiga to support the -lh5- format. When it was first released in early 1990, LZ was far faster and more compressive than its competition, Lharc and LharcA, and retained this position throughout its development history, until the end of 1991. Author: Jonathan Forbes @endnode @node Glossary_LZX "LZX" @{b}LZX@{ub} LZX is the latest and greatest archiver for the Amiga. LZX is the most compressive utility available, sporting some revolutionary new ideas in data compression technology. It also decompresses data faster than any other popular Amiga program, including LX and LhA. Authors: Jonathan Forbes and Tomi Poutanen @endnode @node Glossary_Archiver_Chronology "Archiver chronology" @{b}ARCHIVER CHRONOLOGY@{ub} The chronology of the popular archivers is most interesting, consisting of programs continuously improving in performance and in compression. To date, all programs which became popular on the Amiga originated on the PC. It would be quite the irony if the PC port of LZX, an Amiga program, took over from the market leaders of the PC! Program name Platform Date Formats Author(s) PKZIP 1.x DOS ?Q 1989 ZIP1 Phil Katz Lharc 1.x DOS 2Q 1989 LH1 Haruyasu Yoshizaki Lharc 0.50 Amiga 3Q 1989 LH1 Paolo Zibetti Lhunarc 0.90 Amiga 1Q 1990 LH1 Jonathan Forbes LharcA Amiga 1Q 1990 LH1 Stefan Boberg LZ 0.80 Amiga 2Q 1990 LH1 Jonathan Forbes LHA 2.02a DOS 4Q 1990 LH1,LH5 Haruyasu Yoshizaki ARJ 1.x DOS 4Q 1990 ARJ Robert Jung LZ 1.80 Amiga 1Q 1991 LH1,LH5 Jonathan Forbes ARJ 2.x DOS 3Q 1991 ARJ Robert Jung LhA 1.00 Amiga 4Q 1991 LH1,LH5 Stefan Boberg PKZIP 2.x DOS 4Q 1992 ZIP2 Phil Katz LX 1.00 Amiga 1Q 1993 LH1,LH5 Jonathan Forbes LZX 1.00 Amiga 1Q 1995 LZX Jonathan Forbes and Tomi Poutanen @endnode @node Commands "Commands" @{b}COMMANDS@{ub} LZX supports commands standard on most Amiga archivers. Entering "LZX" by itself from the command line provides a list of available commands and options (@{" Example " Link ExampleCommandLine}). Each option will have one or two letters beside it in parentheses; either "(ax)", "(a )", or "( x)". These denote whether the option is used when archiving and extracting, only when archiving, or only when extracting, respectively. Note that in this case, archiving means adding, updating, freshening, or replacing. @{" Example " Link CmdLineAXExample} Command Descriptions @{" a " Link CmdAdd} Add file(s) to archive @{" d " Link CmdDelete} Delete file(s) from archive @{" e " Link CmdExtractNoPath} Extract file(s) from archive @{" f " Link CmdFreshen} Freshen file(s) in archive @{" l " Link CmdList} List file(s) in archive @{" r " Link CmdReplace} Replace file(s) in archive @{" t " Link CmdTest} Test file(s) in archive @{" u " Link CmdUpdate} Update file(s) in archive @{" v " Link CmdView} List file(s) in archive [Verbose] @{" x " Link CmdExtractFullPath} Extract file(s) from archive [With full path] @endnode @node ExampleCommandLine "Example command line display" LZX 1.00 (Evaluation) Archive/Extract utility - 68040/68060 Version Copyright © 1995 Data Compression Technologies. All rights reserved. Commercial use of this unregistered program is prohibited Usage: LZX [-] [...] [] : a Add file(s) to archive r Replace file(s) in archive d Delete file(s) from archive t Test file(s) in archive e Extract file(s) u Update file(s) in archive f Freshen file(s) in archive v[n] List file(s) [verbose] l List file(s) [terse] x Extract file(s) with full path : -a (ax) Preserve file attributes -q (ax) Configure console output -bi(ax) Set input buffer size (Kb) -r (a ) Recurse into subdirectories -bo(ax) Set output buffer size (Kb) -R (ax) Collect archives recursively -c (ax) Confirm files/archives -s (a ) Add only files with no A bit -C ( x) Clear arc (A) bit on extract -S (a ) Set A bit on added files -e (a ) Archive empty directories -u (ax) Make file names upper case -E ( x) Touch extracted files -U (ax) Set update rate (Kb) -f (ax) Ignore filenotes -w (a ) Set work directory -F (ax) Fast progress display -x (a ) Preserve path names -k ( x) Keep partial extractions -X (ax) Control .LZX suffixing -l (ax) Make file names lower case -y (a ) Store files with ratio >= x% -m (ax) Disable interactivity -Y (a ) Compress archives -M (a ) Set merge group size limits -0 (a ) Store files -o (ax) On or after date (yyyy/mm/dd) -1 (a ) Fast compression -O (ax) On or before date (yyyy/mm/dd) -2 (a ) Default compression -p (ax) Pause after loading -3 (a ) Maximum compression -P (ax) Set task priority -- (ax) Stop further option parsing @endnode @node CmdLineAXExample "Example" For example, the "-C" option (Clear arc (A) bit on extract) has "( x)" beside it, indicating that the option is meaningful only when extracting (or testing) files. The "-3" option (Maximum compression) has "(a )" beside it, indicating that it is meaningful only when compressing files. The "-P" option (Set task priority) has "(ax)" beside it, meaning that it is meaningful both when extracting and when compressing. @endnode @node OptionUsage "Option Usage" @{b}OPTION USAGE@{ub} LZX options may be specified anywhere on the command line, and begin with the dash (-) character. The option letter(s) and any optional parameter(s) should follow the dash character. Example Comment LZX a testfile.lzx dh0:test No options LZX -x x testfile.lzx -x option LZX x -x testfile.lzx -x option (same effect as above) LZX x testfile.lzx -x -x option (same effect as above) LZX -bi32 x testfile.lzx -bi option with parameter "32" LZX -x -a0 a testfile.lzx dh0:test -x and -a0 options LZX a -x testfile.lzx dh0:test -a0 -x and -a0 options (same as above) Since LZX allows options to appear anywhere on the command line, the following command could be considered ambiguous: "LZX a testfile.lzx -testfile2". In this case one is actually trying to add a file which has a name starting with the dash (-) character. LZX would take "-testfile2" to be the "-t" option with "estfile2" as a parameter. To solve this problem, the double dash (--) option exists; LZX will not parse any options on the command line after a double dash. To correctly perform the above command, one would use: "LZX -- a testfile.lzx -testfile2". The double dash, like any other option, can be placed anywhere on the command line, but must appear before the "-testfile2" parameter. @endnode @node Options "Options" @{b}COMMAND LINE OPTIONS@{ub} @{" Option usage " Link OptionUsage} @{" Option descriptions " Link OptionDescriptions} @endnode @node OptionDescriptions "Option Descriptions" @{" -a " Link OptPreserveFileAttributes} Preserve file attributes @{" -bi " Link OptSetInputBufferSize} Set input buffer size @{" -bo " Link OptSetOutputBufferSize} Set output buffer size @{" -c " Link OptConfirmFiles} Confirm files/archives @{" -C " Link OptClearArcOnExtract} Clear arc (A) bit on extract @{" -e " Link OptArchiveEmptyDirs} Archive empty directories @{" -E " Link OptTouchExtractedFiles} Touch extracted files @{" -f " Link OptIgnoreFileNotes} Ignore file notes @{" -F " Link OptFastProgressDisplay} Fast progress display @{" -k " Link OptKeepPartialExtractions} Keep partially extracted files @{" -l " Link OptLowerCaseFileNames} Make file names lower case @{" -m " Link OptDisableInteractivity} Disable interactivity @{" -M " Link OptSetMaxMergeGroupSize} Set maximum merge group size @{" -o " Link OptOnOrAfterDate} On or after date (yyyy/mm/dd) @{" -O " Link OptOnOrBeforeDate} On or before date (yyyy/mm/dd) @{" -p " Link OptPauseAfterLoading} Pause after loading @{" -P " Link OptSetTaskPriority} Set task priority @{" -q " Link OptQuietMode} Set quiet mode @{" -r " Link OptRecurseIntoSubdirs} Recurse into subdirectories @{" -R " Link OptCollectArchivesRecursively} Collect archives recursively @{" -s " Link OptAddOnlyFilesWithNoABit} Add only files with no arc (A) bit @{" -S " Link OptSetABitOnAddedFiles} Set arc (A) bit on added files @{" -u " Link OptUpperCaseFileNames} Make file names uuper case @{" -U " Link OptSetUpdateRate} Set console update rate @{" -w " Link OptSetWorkDirectory} Set work directory @{" -x " Link OptPreservePathNames} Preserve path names @{" -X " Link OptControlLZXSuffixing} Control '.LZX' suffixing @{" -y " Link OptStoreFilesWithRatio} Store files with ratio > x% @{" -Y " Link OptCompressArchives} Compress archives @{" -0 " Link OptStoreAllFiles} Store all files @{" -1 " Link OptFastCompression} Fast compression @{" -2 " Link OptDefaultCompression} Default compression @{" -3 " Link OptMaximumCompression} Maximum compression @endnode @node OptPreserveFileAttributes "Preserve file attributes" @{b}'-a' - PRESERVE FILE ATTRIBUTES@{ub} If this option is enabled, LZX will store (when archiving) and restore (when extracting) @{" file attributes " Link FileAttributes}. This option is ENABLED by default. To disable it, enter '-a0' on the command line. When this option is disabled, files added to, or extracted from archives will have the '----rwed' attributes. In order to ensure that file attributes are properly preserved, preservation of file attributes must be active both when the files were archived and when they are extracted. File attributes will be properly preserved and translated across all platforms for which LZX is available. Note that by default LZX will clear the archive attribute ('a') for any file extracted; enter @{" '-C0' " Link OptClearArcOnExtract} on the command line to disable this feature. VALIDITY This option is valid with the following commands: a (add) e (extract) f (freshen) r (replace) u (update) x (extract) @endnode @node OptSetInputBufferSize "Set input buffer size" @{b}'-bi' - SET INPUT BUFFER SIZE@{ub} This option sets LZX's input buffer size. The input buffer size is affects decompression only. The input buffer size determines the amount of compressed data which LZX will read from disk at one time. For example, if the input buffer size were 8K, then LZX would read compressed data from disk 8K at a time. Larger buffer sizes yield faster performance, but require more memory. The default buffer size is 64K, which is quite sufficient for almost all systems. Users with exceptionally fast CPU's and hard drives may wish to increase the buffer size further, while users with much slower CPU's and hard drives can probably lower the buffer size without significantly affecting performance. VALIDITY This option is valid with the following commands: e (extract) t (test) x (extract) @endnode @node OptSetOutputBufferSize "Set output buffer size" @{b}'-bo' - SET OUTPUT BUFFER SIZE@{ub} This option sets LZX's output buffer size. The output buffer size affects both compression and decompression performance. DECOMPRESSION For decompression (extraction), the output buffer size determines the amount of data which LZX will buffer in memory before writing to disk; for example, if the input buffer size were 8K, then LZX would write decompressed data to disk in 8K pieeces. Because of the way in which decompression is done, using a larger output buffer will always improve the speed of decompression (up to the point where the buffer size equals the size of the largest file or solid file group; increasing the input buffer size beyond this size will have no effect on speed). Buffer sizes as low as 8K are generally quite inefficient and should be used only when the amount of available memory is very low. Buffer sizes above 256K are highly excessive. LZX's default output buffer size is 64K. COMPRESSION For compression (archiving), the output buffer size determines the amount of compressed data which LZX will buffer in memory before writing to disk. For example, if the output buffer size were 8K, then LZX would write compressed data to disk 8K at a time. Larger buffer sizes yield faster performance, but require more memory. The default buffer size is 64K, which is sufficient for most systems. Increasing the output buffer size can have a significant positive effect on compression time, if you can spare the extra memory. VALIDITY This option is valid with the following commands: a (add) e (extract) f (freshen) r (replace) t (test) u (update) x (extract) @endnode @node OptConfirmFiles "Confirm files" @{b}'-c' - CONFIRM FILES@{ub} If this option is enabled, LZX will ask for confirmation for operation on any file or archive. For example, if extracting files with a command such as 'lzx -c x archive.lzx', then LZX will prompt you for each file in the archive 'archive.lzx', asking whether you wish to extract the file; for example: Extract 'testfile'? (Yes/No/All/Quit): In response to the question, you may enter 'Y' (extract the file), 'N' (do not extract the file), 'A' (extract all further files in this archive), or 'Q' (quit extracting from this archive). If operating on multiple archives, LZX will also prompt for which archives should be operated on; for example, if the command 'lzx -c x *.lzx' was used (which tells LZX to extract files from all archives ending in '.lzx') then you might be confronted with something similar to the following: Extract files in ARCHIVE 'testarc.lzx'? (Yes/No/All/Quit): n Extract files in ARCHIVE 'johns_archive.lzx'? (Yes/No/All/Quit): y Extract 'file001'? (Yes/No/All/Quit): n Extract 'testing'? (Yes/No/All/Quit): n Extract 'hello.txt'? (Yes/No/All/Quit): y Note that when extracting from multiple archives, there are two levels of prompts; the prompts which ask whether any files should be extracted from a particular archive (the 'archive prompt'), and the prompts which ask which files to extract from that archive (the 'file prompt'). If at a 'file prompt', the 'A' (extract all) and 'Q' (quit) commands affect only the current archive; these responses would cause all files from the current archive to be extracted, or quit processing of the current archive, respectively. if at an 'archive prompt', the 'A' (extract all) prompt will cause LZX to assume a 'Y' (yes) response for all further archives. However, you will still receive the 'file prompt' for files in these archives. Entering 'Q' (quit) will cause LZX to terminate immediately. This option is disabled by default. VALIDITY This option is valid with the following commands: a (add) e (extract) f (freshen) l (list) r (replace) t (test) u (update) v (view) x (extract) @endnode @node OptClearArcOnExtract "Clear arc (A) bit on extract" @{b}'-C' - CLEAR ARCHIVE BIT ON EXTRACT@{ub} If this option is enabled, LZX will unset the archive ('a') protection bit for all files extracted. This feature is provided for use with hard drive backup programs, which assume that any file with the archive protection bit has not been changed since the last backup. This option is ENABLED by default; therefore, by default, the archive protection flag is not preserved on extraction even if the '-a' option is used. To disable this option, enter '-C0'. VALIDITY This option is valid with the following commands: e (extract) x (extract) @endnode @node OptArchiveEmptyDirs "Archive empty directories" @{b}'-e' - ARCHIVE EMPTY DIRECTORIES@{ub} If this option is enabled, LZX will archive empty directories when the '-r' (recurse into subdirectories) option is used. An empty directory is a directory with no files or subdirectories in it. This option is disabled by default; empty directories will not be added to archives. VALIDITY This option is valid with the following commands: a (add) f (freshen) r (replace) u (update) @endnode @node OptTouchExtractedFiles "Touch extracted files" @{b}'-E' - TOUCH EXTRACTED FILES@{ub} If this option is enabled, LZX will set the file modification date of all extracted files to the current date and time. This option is useful if you perform hard drive backups using the file date as an indicator of whether has been changed, as opposed to using the archive ('a') protection bit. This option is disabled by default. VALIDITY This option is valid with the following commands: e (extract) x (extract) @endnode @node OptIgnoreFileNotes "Ignore filenotes" @{b}'-f' - IGNORE FILENOTES@{ub} If this option is enabled when compressing, then LZX will not store filenotes in the archive. If enabled when extracting, then LZX will not restore filenotes to the extracted files. There is no need to disable filenotes, even if archiving for other platforms; if the other platform does not support filenotes, LZX (on the other platform) will simply ignore the filenote. This option is disabled by default. VALIDITY This option is valid with the following commands: a (add) e (extract) f (freshen) r (replace) u (update) x (extract) @endnode @node OptFastProgressDisplay "Fast progress display" @{b}'-F' - FAST PROGRESS DISPLAY@{ub} If this option is enabled, then LZX will not output a line feed (ASCII 10) on the console after each file has been compressed or decompressed. Since scrolling the display can take a substantial amount of time (often more than the amount of time required to compress or decompress the file, for small enough files or fast enough CPU's!) this option can greatly decrease the time required for LZX to perform its operations. LZX will still emit line feeds when listing the archives processed, so that all processed archives can be seen. If errors occur on any file, LZX will emit a line feed for that file so that its information remains visible. This option is disabled by default, but is highly recommended. VALIDITY This option is valid with the following commands: a (add) e (extract) f (freshen) r (replace) t (test) u (update) x (extract) @endnode @node OptKeepPartialExtractions "Keep partially extracted files" @{b}'-k' - KEEP PARTIALLY EXTRACTED FILES@{ub} This option causes LZX to keep as much as it can of files which are only partially extracted. A file may be partially extracted because of a corrupted archive, a disk full error, or a user abort. VALIDITY This option is valid with the following commands: e (extract) x (extract) @endnode @node OptLowerCaseFileNames "Make file names lower case" @{b}'-l' - MAKE FILE NAMES LOWER CASE@{ub} This option causes all file names to be converted to lower case. If adding files to archives, the names of all files added will be stored in lower case. If extracting from archives, all files will be extracted using lower case file names. If viewing or listing archives, all files will be shown as having lower case file names even if this is in fact not the case. VALIDITY This option is valid with the following commands: a (add) e (extract) f (freshen) l (list) r (replace) t (test) u (update) v (view) x (extract) @endnode @node OptDisableInteractivity "Disable interactivity" @{b}'-m' - DISABLE INTERACTIVITY@{ub} This option causes LZX to not prompt for the response to a question; instead, LZX will default to a sensible response. When LZX would normally prompt asking whether a file should be overwritten, this option will cause the answer to automatically be "yes". This option is enabled automatically if LZX detects that standard input is not interactive (for example, if it is run in the background). VALIDITY This option is valid with the following commands: a (add) e (extract) f (freshen) l (list) r (replace) t (test) u (update) v (view) x (extract) @endnode @node OptSetMaxMergeGroupSize "Set maximum merge group size" @{b}'-M' - SET MAXIMUM MERGE GROUP SIZE@{ub} This option sets the maximum size of a merged file group when adding files to an archive. This sets an upper limit on the amount of file data that can be merged together. The only reason a maximum merge group size exists is to prevent the situation where one may wish to delete or update one file in a very large merged group (e.g. 10 MB of merged files). Since all undeleted data must be compacted (recompressed) after a deletion, it is advantageous to make the merged group size not too large. On the other hand, if the merged group size is too small, then compression suffers. The default merged group size is 260K. The minimum allowable is 8K, and the maximum allowable is just over 8000K (8 Megabytes). The parameter to this option is specified in 1000's of bytes (not 1024); for example, -M500 would specify a maximum merged group size of 500,000 bytes. VALIDITY This option is valid with the following commands: a (add) d (delete) f (freshen) r (replace) u (update) @endnode @node OptOnOrAfterDate "On or after date (yyyy/mm/dd)" @{b}'-o' - ON OR AFTER DATE@{ub} This option puts a date constraint on the files on which LZX will operate; LZX will ONLY operate on any files which have a modification date equal to or later than that specified as a parameter to this option, in the form "yyyy/mm/dd". For example, if extracting files and using the option "-o 1994/04/20", then only files which have a modification date on or after April 4, 1994 in the archive will be extracted. Similarly, if adding files to an archive, only files with a date on or after the one supplied as a parameter wlil be added. This option works in conjunction with other constraints, so the command "LZX -o 1994/01/01 x test.lzx *.c" would extract from the archive "test.lzx" all files which had the extension ".c" AND which also had a modification date of January 1, 1994 or later. If updating, freshening, or replacing files already existing in an archive, then the "on or after" date refers to the date of the physical file, rather than the date of the file in archive. As a sidenote, the format of the date parameter was chosen as "yyyy/mm/dd" because this format is unambigious; European countries all use different date formats, which are often different from those used in North America and the rest of the world. VALIDITY This option is valid with the following commands: a (add) d (delete) e (extract) f (freshen) l (list) r (replace) t (test) u (update) v (view) x (extract) @endnode @node OptOnOrBeforeDate "On or before date (yyyy/mm/dd)" @{b}'-O' - ON OR BEFORE DATE@{ub} This option puts a date constraint on the files on which LZX will operate; LZX will ONLY operate on any files which have a modification date equal to or before than that specified as a parameter to this option, in the form "yyyy/mm/dd". Otherwise, this option behaves in an analagous fashion to the -o (On or after date) option. VALIDITY This option is valid with the following commands: a (add) d (delete) e (extract) f (freshen) l (list) r (replace) t (test) u (update) v (view) x (extract) @endnode @node OptPauseAfterLoading "Pause after loading" @{b}'-p' - PAUSE AFTER LOADING@{ub} This option causes LZX to pause and wait for the user to press a key, after it has loaded. This feature is provided for users with floppy drive systems only, who may wish to swap disks before allowing LZX to start operating. VALIDITY This option is valid with the following commands: a (add) d (delete) e (extract) f (freshen) l (list) r (replace) t (test) u (update) v (view) x (extract) @endnode @node OptSetTaskPriority "Set task priority" @{b}'-P' - SET TASK PRIORITY@{ub} This option sets the priority of the LZX process for the duration of its running. The priority may be any value from -127 to +127, although only values between -5 and +5 should be used. The higher the priority, the more CPU time will be used by LZX. Because of the way in which the Amiga's process priority system works, and because LZX is very processor intensive, setting LZX to a high priority will probably stop (or at least slow to a very slow crawl) any lower priority processes. The one time LZX does not use much CPU is when it is waiting for disk i/o to complete (from an actual physical disk; RAM drives do not count). The default task priority of LZX is zero. VALIDITY This option is valid with the following commands: a (add) d (delete) e (extract) f (freshen) l (list) r (replace) t (test) u (update) v (view) x (extract) @endnode @node OptQuietMode "Set quiet mode" @{b}'-q' - SET QUIET MODE@{ub} This option tells LZX to not output anything to standard output. Two modes are supported: '-q 0' - Normal output (the default) '-q 1' - Disable all output Entering '-q' as an option is equivalent to entering '-q 1', which disables all LZX output to the console. @endnode @node OptRecurseIntoSubdirs "Recurse into subdirectories" @{b}'-r' - RECURSE INTO SUBDIRECTORIES@{ub} This option is used in conjunction with wildcarding, and causes LZX to search all subdirectories (in addition to the current directory) for matching file names (and directories, if applicable). Note that the '-x' (preserve path names) option is automatically enabled when the '-r' option is used. If you do not wish to preserve path names, enter the '-x0' option after '-r' on the command line. VALIDITY This option is valid with the following commands: a (add) f (freshen) r (replace) u (update) @endnode @node OptCollectArchivesRecursively "Collect archives recursively" @{b}'-R' - COLLECT ARCHIVES RECURSIVELY@{ub} This option causes LZX to recurse into subdirectories (in addition to the current directory) to look for matching archives. For example, to view all files ending in ".h" in all LZX archives in the current directory and its subdirectories, one would type: "LZX -R v #?.lzx #?.h". To add the file "MYBBS.ADV" to all LZX archives in the current directory and its subdirectories, one would type: "LZX -R a #?.lzx MYBBS.ADV". Similarly, to delete the file "zzzendpad.foo" from all LZX archives in the current directory and its subdirectories, one would type: "LZX -R d #?.lzx zzzendpad.foo" VALIDITY This option is valid with the following commands: a (add) d (delete) e (extract) f (freshen) l (list) r (replace) t (test) u (update) v (view) x (extract) @endnode @node OptAddOnlyFilesWithNoABit "Add only files with no arc (A) bit" @{b}'-s' - ADD ONLY FILES WITH NO ARC (A) BIT@{ub} This command causes LZX to add only files without the arc (A) protection bit. This option is useful for performing incremental backups, and is most often used in combination with the -S (Set A bit on added files) option. VALIDITY This option is valid with the following commands: a (add) @endnode @node OptSetABitOnAddedFiles "Set arc (A) bit on added files" @{b}'-S' - SET ARC (A) BIT ON ADDED FILES@{ub} This option causes LZX to set the A protection bit on all files which are added to an archive. This option is used primarily in incremental hard drive backups, and is most commonly used with the -s (add only files with no arc (A) bit set) option. VALIDITY This option is valid with the following commands: a (add) @endnode @node OptUpperCaseFileNames "Make file names upper case" @{b}'-u' - MAKE FILE NAMES UPPER CASE@{ub} This option causes all file names to be converted to upper case. If adding files to archives, the names of all files added will be stored in upper case. If extracting from archives, all files will be extracted using upper case file names. If viewing or listing archives, all files will be shown as having upper case file names even if this is in fact not the case. VALIDITY This option is valid with the following commands: a (add) e (extract) f (freshen) l (list) r (replace) t (test) u (update) v (view) x (extract) @endnode @node OptSetUpdateRate "Set console update rate" @{b}'-U' - SET CONSOLE UPDATE RATE@{ub} This option sets the update rate of the console when compressing data (archiving files, or compacting a merged file group when deleting files); LZX will update the console each time the supplied number of Kilobytes is compressed. Due to LZX's file merging, it currently uses a percentage display to update the console, but the calculation of when to update the console is still perform in bytes. LZX checks the CPU on your system to set the default rate to something sensible for your system, be it a 68000 or a 68060. As mentioned previously, the parameter should be specified in Kilobytes. For example "-U4" will cause LZX to update the display for each 4K of data compressed. This parameter only affects the update rate for encoding; the update rate for decoding is determined solely by the output buffer size. VALIDITY This option is valid with the following commands: a (add) d (delete) f (freshen) r (replace) u (update) @endnode @node OptSetWorkDirectory "Set work directory" @{b}'-w' - SET WORK DIRECTORY@{ub} This option specifies the work directory of LZX. The work directory is used to hold temporary files when adding, updating, freshening, replacing, or deleting files from archives. The default work directory is "T:", which is usually assigned logically to "RAM:T". For systems with a small amount of memory, there may not be enough memory to compress data using "RAM:T" as the work directory. This can also be the case if compressing very large files. The name of the work directory supplied must end in either a colon (:) or a slash (/); if it does not, LZX will complain. VALIDITY This option is valid with the following commands: a (add) d (delete) f (freshen) r (replace) u (update) @endnode @node OptPreservePathNames "Preserve path names" @{b}'-x' - PRESERVE PATH NAMES@{ub} This option tells LZX to preserve the full path name (excluding the device name) of any file added to (if adding) or extracted from (if extracting) the archive. This is useful if one wishes to preserve a complete directory structure. By default this option is not set. In order to preserve the directory structure, this option must be used both when creating the archive, and when extracting it. This option is set automatically when the '-r' (recurse into subdirectories) option is used; to use '-r' without activating this option (preserve path names), enter '-x0' after the '-r' on the command line; i.e. "-r -x0". VALIDITY This option is valid with the following commands: a (add) e (extract) f (freshen) r (replace) u (update) x (extract) @endnode @node OptControlLZXSuffixing "Control '.lzx' suffixing" @{b}'-X' - CONTROL '.LZX' SUFFIXING@{ub} This option tells LZX to append '.lzx' to an archive name if it does not already end in '.lzx'. This option is enabled by default; that is, the following command will add the file 'somefile' to 'myarc.lzx': "lzx a myarc somefile". To disable this behavior, use the -X0 option. For example, the following command will add 'somefile' to 'myarc': "lzx -X0 a myarc somefile". VALIDITY This option is valid with the following commands: a (add) e (extract) f (freshen) l (list) r (replace) t (test) u (update) v (view) x (extract) @endnode @node OptStoreFilesWithRatio "Store files with ratio > x%" @{b}'-y' - STORE FILES WITH RATIO > X%@{ub} This option causes LZX to store files which have a compression ratio of greater than the specified percentage. For example '-y95' would cause LZX to store all files which compressed to 95% or more of their original size. Specifying a number greater than or equal to 100 makes no sense; LZX will always store any file which compressed to more than its original size. This option is a carry-over from the other Amiga archivers which often decompress poorly compressed files very slowly. LZX is very fast at decompressing any type of file, but it must be said that decompressing a stored file is quicker (it's all disk i/o and very little CPU usage; for a stored file, the disk i/o will be the bottleneck). Note that merged file groups are treated as one file for all intents and purposes; therefore, the whole merged group will be stored if the compressed group is greater than the group's combined original size. VALIDITY This option is valid with the following commands: a (add) d (delete) f (freshen) r (replace) u (update) @endnode @node OptCompressArchives "Compress archives" @{b}'-Y' - COMPRESS ARCHIVES@{ub} This option forces LZX to compress files which are known by their extension to already be compressed. By default, LZX will simply store these files without attempting to compress them, the reason being that attempting to compress one of these types of files yields very little (invariably 0-3%) in the way of additional compression. The following file extensions are treated as indicating an archive: AIN ARC ARJ DMS GIF HAP JPG LHA LHW LZH LZX PAK PP RAR UC2 WRP ZAP ZIP ZOO Additional file extensions will be added as more archive types become available. VALIDITY This option is valid with the following commands: a (add) u (update) @endnode @node OptStoreAllFiles "Store all files" @{b}'-0' - STORE ALL FILES@{ub} This option causes LZX to store (i.e. not compress) all new files added to an archive. This option is useful if one wishes to make use of LZX only as an archiving tool, rather than as a compressive tool. If updating an archive, existing files will be recompressed with whatever compression mode they were originally compressed. VALIDITY This option is valid with the following commands: a (add) u (update) @endnode @node OptFastCompression "Fast compression" @{b}'-1' - FAST COMPRESSION@{ub} This option causes LZX to use its "fast compression" mode; this mode is completely output compatible with LZX's other compression modes, except that the compression parameters have been tweaked to favour speed over compression. The loss in compression is not very significant; usually about 1-2%. If updating an archive, existing files will be recompressed with whatever compression mode they were originally compressed. VALIDITY This option is valid with the following commands: a (add) u (update) @endnode @node OptDefaultCompression "Default compression" @{b}'-2' - DEFAULT COMPRESSION@{ub} This option causes LZX to use its "default compression" mode; this mode is completely output compatible with LZX's other compression modes. In this case, the compression parameters have been selected to provide an nearly optimal balance between compression speed and degree of compression. If updating an archive, existing files will be recompressed with whatever compression mode they were originally compressed. VALIDITY This option is valid with the following commands: a (add) u (update) @endnode @node OptMaximumCompression "Maximum compression" @{b}'-3' - MAXIMUM COMPRESSION@{ub} This option causes LZX to use its "maximum compression" mode; this mode is completely output compatible with LZX's other compression modes. In this case, the compression parameters have been tweaked to provide greater compression at the expense of speed. Generally speaking, the difference between "maximum compression" and "default compression" is much smaller than the difference between "default compression" and "fast compression". If updating an archive, existing files will be recompressed with whatever compression mode they were originally compressed. VALIDITY This option is valid with the following commands: a (add) u (update) @endnode @node CmdAdd "Add" @{b}'a' - ADD FILES TO ARCHIVE(S)@{ub} The add command adds one or more files to one or more archives, although typically it is used to add files to only one archive. If the archive specified does not already exist, it will be created. Otherwise, files will be appended to the archive. LZX will not add files to an archive if they are aleady present in the archive; attempting to do so will elicit a warning message from LZX, although it will continue to add any other files you may have specified. By default, only the file name component of the file is stored in the archive; that is, any preceding path name is not stored. In order to preserve the path name as well, use the -x option. If you specify the -r option to recurse into subdirectories, then the -x option is set automatically. To preserve empty directories, select the -e option. The -x, -r, and -e options can be used to preserve a directory structure. @{" Examples " Link CmdAdd_Example} @endnode @node CmdAdd_Example "Examples of the ADD command" @{b}EXAMPLES OF THE ADD COMMAND@{ub} 'LZX a myarchive.lzx testfile.txt' would add the file 'testfile.txt' to the archive 'myarchive.lzx'. However, if 'testfile.txt' were already present in the archive, then it would not be added. If 'myarchive.lzx' didn't exist at the time the command was invoked, then 'myarchive.lzx' would be created as a new archive. 'LZX a myarchive newfile.txt' would perform exactly the same operation as the above, since LZX would automatically append the '.lzx' extension onto the archive name 'myarchive'. To alter this behavior, the -X option can be used. 'LZX a myarchive *.txt *.doc test.tmp' would add to the archive 'myarchive.lzx' all files ending in '.txt', '.doc', and the file 'test.tmp'. 'LZX a myarchive.lzx subdir/newfile.txt' would add the file 'subdir/newfile.txt' to the archive 'myarchive.lzx'. The file would be stored as 'newfile.txt' within the archive; that is, the 'subdir/' prefix would not be preserved. In order to have the file stored as 'subdir/newfile.txt' within the archive, the -x option would be required: 'LZX -x a myarchive.lzx subdir/newfile.txt' @endnode @node CmdDelete "Delete" @{b}'d' - DELETE FILES FROM ARCHIVE(S)@{ub} The delete command deletes files from one or more archives, although typically it is used to delete files from only one archive. LZX requires temporary storage in the current directory in order to condense the remaining files in the archive. If any of the files to be deleted were part of a merged file group, then LZX will recompress the undeleted files in the affected groups. The files will be recompressed using the default compression mode, or the selected one if one is specified via one of the options '-1', '-2', or '-3' on the command line. @endnode @node CmdExtractNoPath "Extract" @{b}'e' - EXTRACT FILES FROM ARCHIVE(S) [NO PATH PRESERVATION]@{ub} This extract command is used to extract files from an archive. It differs from the 'x' extract command in that path names and directory structure will not be preserved by default. For example, if one were to extract files from an archive, and a file named "mydir/subdir/myfile" were present in the archive, then the file 'myfile' would be created in the current directory. Note that using the -x1 parameter with this command causes this command to behave in exactly the same was as the 'x' extract command. @endnode @node CmdExtractFullPath "Extract" @{b}'x' - EXTRACT FILES FROM ARCHIVE(S) [PATH PRESERVATION]@{ub} This extract command is used to extract files from an archive. It differs from the "e" extract command in that path names and directory structure are preserved by default. For example, if one were to extract files from an archive, and a file named "mydir/subdir/myfile" were present in the archive, then the file "mydir/subdir/myfile" would be created. If the "mydir/subdir" directory did not already exist, then it would first be created. Note that using the -x0 parameter with this command causes this command to behave in exactly the same was as the 'e' extract command. @endnode @node CmdFreshen "Freshen" @{b}'f' - FRESHEN FILES IN ARCHIVE(S)@{ub} The freshen command freshens one or more files in one or more archives, although typically it is used to freshen files in only one archive. The freshening process replaces older files which already exist in the archive. When replacing files, the 'last modification dates' of the files in the archive are compared with those of their counterparts specified at the command line, and the earlier modification date is assumed to represent the older file. As with the add command, only the file name component of the file is stored by default. The -x or -r options should be used to preserve path names. The freshen command is almost identical to the update command, except that the freshen command does not add any new files to the archive; it will only freshen existing ones. The replace command is similar to the freshen command, except that it always replaces files in the archive, regardless of their modification dates. @endnode @node CmdUpdate "Update" @{b}'u' - UPDATE FILES IN ARCHIVE(S)@{ub} The update command updates one or more files in one or more archives, although typically it is used to update files in only one archive. The updating process adds files which are not yet in the archive, and replaces older files which already exist in the archive. When replacing files, the 'last modification dates' of the files in the archive are compared with those of their counterparts specified at the command line, and the earlier modification date is assumed to represent the older file. As with the add command, only the file name component of the file is stored by default. The -x or -r options should be used to preserve path names. Two commands similar to update are the freshen and replace commands. The freshen command is almost identical to the update command, except that no new files will be added to the archive; only existing files in the archive may be updated, depending on their last modification date. The replace command is almost identical to the freshen command, except that all specified files are always updated, regardless of their last modification date. @endnode @node CmdReplace "Replace" @{b}'r' - REPLACE FILES IN ARCHIVE(S)@{ub} The replace command replaces one or more files in one or more archives, although typically it is used to replace files in only one archive. The replacing process replaces files which already exist in the archive with those specified at the command line. As with the add command, only the file name component of the file is stored by default. The -x or -r options should be used to preserve path names. The replace command is similar to the freshen command. @endnode @node CmdTest "Test" @{b}'t' - TEST FILES IN ARCHIVE(S)@{ub} The test command is used to test the integrity of files in archives. This is done by extracting the file data and throwing it away (i.e. no files are created). If no file names are specified on the command line, then all files in the archive(s) are tested; otherwise, only the specified files are tested. If any of the tested files are corrupted, or a problem is encountered in any archive(s), LZX will exit with an error code. @endnode @node CmdList "List" @{b}'l' - LIST FILES IN ARCHIVE(S) [TERSE]@{ub} The list command is used to display the contents of archives. The list command displays the following information for each file in an archive: File name Original file size Packed file size Compression ratio (packed/original as a percentage) File modification date and time In addition, similar statistics for the whole archive itself are tallied and displayed. Sample output might be: Viewing archive 'testarchive.lzx': Original Packed Ratio Date Time Name -------- -------- ----- --------- -------- ----------- 156492 78826 50.3% 10-Mar-94 22:29:14 test 419328 164352 39.1% 19-May-93 09:25:12 book1 -------- -------- ----- --------- -------- 575820 243178 42.2% 09-Nov-94 17:17:06 2 file(s) 1 archive(s) viewed The information under the second dotted line is for the archive itself. For example, the archive contains a total of 575820 bytes worth of data, compressed down to 243178 bytes, for an average compression ratio of 42.2%, and the modification date of the archive is 09-Nov-94 17:17:06. Two files were present the archive. Note that one can list only some of the files in the archive, if desired; these files can be specified on the command line, either explicitly, or as wildcards. For example, in the above case, if one were to enter 'lzx l testarchive.lzx book1', the following would be displayed: Viewing archive 'ram:blah.lzx': Original Packed Ratio Date Time Name -------- -------- ----- --------- -------- ----------- 419328 164352 39.1% 19-May-93 09:25:12 book1 -------- -------- ----- --------- -------- 419328 164352 39.1% 09-Nov-94 17:17:06 1 file(s) 1 archive(s) viewed Note that in this case, the information tallied under the second dotted line is only for the files listed, and not for the complete archive; that is, 419328 bytes worth of uncompressed file data was listed, and this data was compresed to 164352 bytes, for a compression ratio of 39.1%, and 1 file was listed. When solid file groups are present in the archive, the situation is slightly different, as multiple files have been compressed together as if they were one large file. In this situation, LZX estimates the compressed file size of each of the solid files by giving it a compressed size proportional to that of its actual size when compared to the solid group. An asterisk will appear between the original file size and compressed file size of any file which is a member of a solid file group, to inform you that the packed file size is an estimated value. @endnode @node CmdView "View" @{b}'v' - LIST FILES IN ARCHIVE(S) [VERBOSE]@{ub} The view command is similar to the list command, in that it is used to display the contents of archives. The difference is that the view command displays more information than the list command. There are in fact two view commands (not counting the 'list' command); the ordinary view command ('v') and the verbose view command ('v1'). The 'v1' command displays even more information than the 'v' command, as is explained below. The list command ('l') displays the following information: File name Original file size Packed file size Compression ratio (packed/original as a percentage) File modification date and time The view command ('v') displays the following additional information: @(" File attributes " Link FileAttributes} @(" File CRC " Link FileCRC} @(" Compression mode " Link LZXCompressionModes} If the verbose view command ('v1') is used, then the following additional information is also displayed: @(" Host operating system " Link HostOperatingSystem} Note that the information in the verbose view ('v1') command will not fit on an 80 column display. The sample output of the view command ('v') might be: Viewing archive 'test.lzx': Original Packed Ratio Date Time FileAttr CRC-32 M Name -------- -------- ----- --------- -------- -------- -------- - ----------- 151496 76854 50.7% 15-Nov-94 02:17:15 --p-rwed 8CA65049 1 testfile -------- -------- ----- --------- -------- 151496 76854 50.7% 15-Nov-94 02:17:21 ----rwed 1 file(s) 1 archive(s) viewed The sample output of the verbose view command ('v1') might be: Viewing archive 'test.lzx': Original Packed Ratio Date Time FileAttr CRC-32 Host OS M Name -------- -------- ----- --------- -------- -------- -------- ------- - ----------- 151496 76854 50.7% 15-Nov-94 02:17:15 --p-rwed 8CA65049 Amiga 1 testfile -------- -------- ----- --------- -------- 151496 76854 50.7% 15-Nov-94 02:17:21 ----rwed 1 file(s) 1 archive(s) viewed @endnode @node HostOperatingSystem "Host operating system" @{b}HOST OPERATING SYSTEM@{ub} In order to ensure easy transportation of files across platforms, LZX records a Host OS (Operating System) for each file added to the archive, so that file attributes can be translated compatibly across platforms. LZX currently is aware of the following operating systems: Amiga MS-DOS Windows OS/2 UNIX @endnode @node FileAttributes "File attributes" @{b}AMIGADOS FILE ATTRIBUTES@{ub} The following file attributes are supported by AmigaDOS and LZX: @{" h " Link FileAttributeHidden} @{" s " Link FileAttributeScript} @{" p " Link FileAttributePure} @{" a " Link FileAttributeArchive} @{" r " Link FileAttributeReadable} @{" w " Link FileAttributeWriteable} @{" e " Link FileAttributeExecutable} @{" d " Link FileAttributeDeleteable} @endnode @node FileAttributeHidden "Hidden" @{b}THE AMIGADOS 'HIDDEN' ('h') FILE ATTRIBUTE@{ub} The 'hidden' attribute is not used under AmigaDOS; setting it does not cause files to be hidden from directory listings. In fact, the AmigaDOS 3.1 'protect' command does not recognise the 'h' bit. @endnode @node FileAttributeScript "Script" @{b}THE AMIGADOS 'SCRIPT' ('s') FILE ATTRIBUTE@{ub} The 'script' attribute indicates that the file is an AmigaDOS shell script file. @endnode @node FileAttributePure "Pure" @{b}THE AMIGADOS 'PURE' ('p') FILE ATTRIBUTE@{ub} The 'pure' attribute indicates that the file is residentable and re-entrant, and can be made resident with the AmigaDOS 'resident' command, or equivalent command if operating under a different shell. @endnode @node FileAttributeArchive "Archived" @{b}THE AMIGADOS 'ARCHIVED' ('a') FILE ATTRIBUTE@{ub} The 'archived' attribute is used by most backup programs as a way of determining which files have been changed since the last backup; any write to a file with the 'a' attribute set will unset the 'a' attribute. @endnode @node FileAttributeReadable "Readable" @{b}THE AMIGADOS 'READABLE' ('r') FILE ATTRIBUTE@{ub} The 'readable' attribute is used to indicate that a file can be read; a file without this attribute cannot be read. Almost all files have the 'readable' attribute set. @endnode @node FileAttributeWriteable "Writeable" @{b}THE AMIGADOS 'WRITEABLE' ('w') FILE ATTRIBUTE@{ub} The 'writeable' attribute is used to indicate that a file can be written to; a file without this attribute cannot be written to, although it can be deleted (the 'delete' attribute must be unset in order to prevent deletion). @endnode @node FileAttributeExecutable "Executable" @{b}THE AMIGADOS 'EXECUTABLE' ('e') FILE ATTRIBUTE@{ub} The 'executable' attribute is used to indicate that the file is a binary load file, which can be executed from the shell, for example. @endnode @node FileAttributeDeleteable "Deleteable" @{b}THE AMIGADOS 'DELETE' ('d') FILE ATTRIBUTE@{ub} The 'deletable' attribute is used to indicate that a file can be deleted using the AmigaDOS 'delete' command (or any other command or operating system call which provides the same functionality). If the 'deletable' attribute is not set, then the file cannot be deleted. @endnode @node Limitations "Limitations" @{b}LIMITATIONS@{ub} LZX's limitations are as follows: * Path names are limited to a maximum 255 characters in length. * The size of a single archive must not exceed 2 Gigabytes. * The maximum number of files that can be compressed in one invocation is limited only by available memory. @endnode @node EnvironmentVariables "Environment Variables" @{b}ENVIRONMENT VARIABLES@{ub} The evaluation version of LZX does not support environment variables, or a set of environment-specified default options. @endnode @node FutureAndRegistration "Registration and The Future" @{b}REGISTRATION AND THE FUTURE@{ub} LZX was developed over the period of approximately one and a half years. A lot of thought went into every component of LZX, and countless brainstorming sessions kept us up until 5 AM for weeks on end, while our university marks nose-dived due to all of our missed classes. A PC version of LZX is being developed in parallel with the Amiga version, although the PC version is several months behind the Amiga version, due to MS-DOS's numerous architectural problems. We dearly hope that LZX, an Amiga program, will oust the market leaders on the PC, but it will be a tough battle; PKZIP is heavily entrenched in the PC market. The LZX project needs your support! LZX is fairly inexpensive as shareware programs go, especially when you consider what you get: Registered users will get the 68020/68030 ZX and 68040/68060 ZX enhanced performance versions of LZX which also feature asynchronous disk i/o, a scaled down extract-only version (LZXX), as well as numerous features not present in the evaluation version. Additional features will include multi-volume archiving, encryption support, and BBS advertisement support. The evaluation (unregistered) version of LZX will remain fairly bare-bone as far as features go, although it will always be able to decompress anything that the registered version produces. One feature currently under consideration is the support of full-disk (track by track) compression; essentially similar to DMS, except offering LZX's exceptional compression and speed. Please let us know if you would find this a useful feature. In addition to the above, registered owners of LZX will have access to the LZX support areas provided by the LZX support sites. Through the support areas you will be able to speak directly to the authors and to other registered LZX users. The LZX support sites are networked together using the global Xenolink support network linking North America, Europe, and Australia and New Zealand. This network already links Xenolink distributors, Xenolink support sites, and Xenolink owners (as you may recall, Jonathan Forbes is the author of Xenolink as well as the co-author of LZX). The LZX message area may or may not be moved onto the FidoNet backbone in the future, depending on demand; the Xenolink support backbone has a much faster turnaround than the FidoNet backbone, however, in part due to the fact that some of the Xenolink support sites use the InterNet to transfer mail, meaning that messages are often received by a destination system within minutes, rather than within several days as can be the case with FidoNet. If you have a feature you would like added, feel free to let us know, and drop us a line either by @{" Email " Link Email}, @{" Snail-mail " Link SnailMail}, @{" fax " Link Fax}, or even @{" telephone " Link Telephone}. @{b}PAYMENT DETAILS@{ub} The registration fee for LZX is US$ 25, which can be paid by either cheque or money order if in the U.S. or Canada, or by postal money order if elsewhere. Alternatively, you may send cash; the cash may be either US$ 25, or its equivalent at the current exchange rate to the currencies of the following countries: Canada U.K. Germany Sweden Denmark This alternative payment scheme is available so that one does not have to make the trek down to the post office and pay an extra fee for the creating of a money order; now all one has to do is hide cash in the envelope and send it off. For example, if you wished to send Canadian dollars, you would look up the current exchange rate (currently 1 US$ ~= CDN$ 1.39) and then send the equivalent amount (CDN$ 34.96, or CDN$ 35). Note: Only bills/notes are accepted. Foreign coins are not accepted, because they cannot be exchanged at a local bank. A note about sending cash in the mail; make absolutely sure that it is disguised; if it is not, you can bet that along the way someone will open it and take the money out - it happens. Enclose the cash in two pieces of non-white paper to disguise it. We cannot take responsibility for cash lost in the mail; if you think this may happen, send a money order instead. To check the status of your order, you can contact the authors as described above. You will receive a disk with the registered versions of LZX, as well as a list of available LZX support sites where you will be able to obtain further releases of LZX and keep up on the LZX developments as they occur. @endnode @node Email "Contacting the authors via Email" @{b}CONTACTING THE AUTHORS VIA EMAIL@{ub} Please Email us with your comments, questions, and suggestions! Jonathan Forbes: jonathan.forbes@canrem.com (always) jadforbe@electrical.watstar.uwaterloo.ca (May 4 - Aug 12, 1995) jadforbe@electrical.watstar.uwaterloo.ca (Jan 4 - Apr 18, 1996) Tomi Poutanen: t-tomip@microsoft.com (Jan 9 - Apr 30, 1995) tjpoutan@elecom2.watstar.uwaterloo.ca (May 4 - Aug 12, 1995) tjpoutan@elecom2.watstar.uwaterloo.ca (Jan 4 - Apr 18, 1996) @endnode @node Fax "Contacting the authors via Fax" @{b}CONTACTING THE AUTHORS VIA FAX@{ub} The authors can be faxed at the number below, which is located at the address of Jonathan Forbes. The fax machine resides on a dedicated line, and is available 24 hours a day. If appropriate, please indicate who the fax is for. This number will be valid starting on February 16, 1995. FAX: (416)-781-1502 (Toronto, Ontario, Canada) @endnode @node Telephone "Contacting the authors via Telephone" @{b}CONTACTING THE AUTHORS VIA TELEPHONE@{ub} Jonathan Forbes can be reached at the number below, from February 16, 1995 onwards: Voice: (416)-781-1501 (Toronto, Ontario, Canada) @endnode @node SnailMail "Contacting the authors via Snail Mail" @{b}CONTACTING THE AUTHORS VIA SNAIL MAIL@{ub} Please mail us your comments, questions, and suggestions! The authors can be contacted via snail mail at the following address: Data Compression Technologies 383 Lawrence Avenue West Toronto, Ontario M5M 1B9 Canada @endnode @node Benchmarks "Benchmarks" @{b}BENCHMARKS@{ub} The benchmarks were performed on the following setup: Amiga 3000/25 35 MHz 68040 Accelerator 8 Megabytes of 60 ns FAST RAM 4 Megabytes of 80 ns FAST RAM 2 Megabytes of CHIP RAM The following programs were benchmarked; LZX, LhA, Shrink, InfoZip, and Zoo. Details on the programs are as follows: Program Version Comments ========= ======= =========== LZX *1.0 Best compression of all, very fast LhA *1.38e Poor compression, but very fast Shrink 1.1 Excellent compression, but very very slow InfoZip 1.9l Good compression, slow, but portable Zoo 2.1 Poor compression, but very fast * The evaluation version of LZX 1.0 for the 68040/68060 was used * The evaluation version of LhA 1.38 was used. Since only a 68000 version of LhA is provided for evaluation, that was used. All tests were performed in the RAM: drive, and all programs and files were loaded into RAM: beforehand. Two sets of tests were run; a single file test, and a multiple file test. As one might guess, the single file test involves compressing only a single file; while this nullifies the effect of LZX's file merging capability, the results clearly demonstrate that LZX, even on single files, is far superior to all other compression programs on the Amiga. The multiple file test involves compressing many files at once. Here, LZX's file merging capability allows it to compress data far more effectively than the other programs. One interesting result of note is borne out; not only does LZX compress better than all other Amiga archivers, but it also decompresses faster, and, in many cases, compresses faster! @{" Single File Test " Link SingleFileBenchmark} @{" Multiple File Test " Link MultipleFileBenchmark} @endnode @node SingleFileBenchmark "Single File Test" @{b}SINGLE FILE TEST@{ub} Two of the files tested ("book1" and "obj2") were taken from the Calgary Corpus, a popular benchmark for compression programs. These are a text file and a binary object file, respectively. Note that only the first 420K of "book1" was taken in the test case (this was originally done to keep the file to a manageable size when performance testing on a 68000); statistics for the original complete "book1" file will replace those below in the near future. Also tested was "xenomsgs" (a capture file from a BBS, consisting of highly compressible information). All files are sorted in order of best compression to worst compression. [ ================================ "book1" ================================ ] (From the Calgary Corpus - text taken from a book) Original size: 419328 bytes Program Compressed Compression Decompression size time (s) time (s) ------------ --------------- ------------------ -------------- LZX 1.00 -3 164398 6.82 0.46 LZX 1.00 -2 164720 6.57 0.46 LZX 1.00 -1 169260 4.84 0.46 Shrink 1.1 169628 14.51 10.28 Zip -9 172350 10.81 1.40 LhA 1.38e -2 185998 5.63 0.64 Zoo 214944 5.51 2.33 [ ================================ "obj2" ================================ ] (From the Calgary Corpus - object file) Original size: 246814 bytes Program Compressed Compression Decompression size time (s) time (s) ------------ --------------- ------------------ -------------- LZX 1.00 -3 75063 2.90 0.26 LZX 1.00 -2 75775 2.40 0.26 LZX 1.00 -1 78347 2.09 0.27 Shrink 1.1 79462 6.00 5.47 Zip -9 81170 8.04 0.72 LhA 1.38e -2 84943 3.55 0.32 Zoo 132152 3.41 1.40 [ ============================== "xenomsgs" ============================== ] (Capture file from a BBS) Original size: 876135 bytes Program Compressed Compression Decompression size time (s) time (s) ------------ --------------- ------------------ -------------- LZX 1.00 -3 212435 10.22 0.71 LZX 1.00 -2 213617 9.15 0.71 LZX 1.00 -1 217227 7.48 0.71 Shrink 1.1 224354 19.13 15.03 Zip -9 241759 13.21 2.20 LhA 1.38e -2 301480 8.65 1.09 Zoo 441081 11.39 4.83 @endnode @node MultipleFileBenchmark "Multiple File Test" @{b}MULTIPLE FILE TEST@{ub} The files in "lha_e138.run" (the distribution archive of LhA 1.38e) were extracted and recompressed with various archivers. Also tested were compressing the complete INCLUDE directory of SAS/C 6.51 (C and ASM header files), and compressing the C directory of SAS/C 6.51 (containing all the compiler's command-line tools). The appropriate commands were used for each archiver in order for it to preserve path names and recurse into subdirectories. For LZX, the "-M5000" option was also used to allow large merged file groups. These results demonstrate that not only is LZX by far the most compressive utility for the Amiga, but that it is, astoundingly, also one of the fastest! [ =================== "LhA 1.38 Distribution Archive" =================== ] Original size: 240262 bytes Program Compressed Compression Decompression size time (s) time (s) ------------ --------------- ------------------ -------------- LZX 1.00 -3 88952 3.14 0.31 LZX 1.00 -2 89258 2.83 0.31 LZX 1.00 -1 90646 2.39 0.31 Shrink 1.1 97294 8.29 6.80 Zip -9 99905 7.45 0.84 LhA 1.38e -2 102399 3.64 0.38 [ =================== "SAS/C 6.51 Include Directory" ==================== ] Original size: 1639236 bytes Program Compressed Compression Decompression size time (s) time (s) ------------ --------------- ------------------ -------------- LZX 1.00 -3 458267 24.72 2.15 LZX 1.00 -2 461643 21.76 2.15 LZX 1.00 -1 469943 19.36 2.16 LhA 1.38e -2 621870 23.36 3.48 Shrink 1.1 623570 49.39 50.62 Zip -9 651848 26.23 6.14 [ ====================== "SAS/C 6.51 C Directory" ======================= ] Original size: 1333620 bytes Program Compressed Compression Decompression size time (s) time (s) ------------ --------------- ------------------ -------------- LZX 1.00 -3 624672 16.10 1.70 LZX 1.00 -2 629746 14.33 1.72 LZX 1.00 -1 639986 12.53 1.72 Shrink 1.1 754322 46.86 53.60 Zip -9 783595 31.25 5.71 LhA 1.38e -2 791379 19.97 2.32 @endnode