                            UPXDUMP User Manual
                            ===================

Chapter 1: Introduction
-----------------------

       In tradition of our products released earlier UPXDUMP is a small
       tool serving only one specific purpose. UPXDUMP is a replacement for
       the undocumented `--file-info' option in the free, high-performance
       executable packer UPX.

       The main reason to write UPXDUMP was to show a file's compression
       method in human-readable manner.

       And where UPX fails UPXDUMP can also handle malformed executables
       created by a broken DOS port of UPX 2.93.

       UPXDUMP comes in two flavours:

        -  A tiny 16-bit version (file `dos16\upxdump.exe') suitable for
           computer systems prior to the 80386 microprocessor.

        -  For newer systems there is a 32-bit version (file
           `dos32\upxdump.exe'), that additionally supports long file
           names.

       Otherwise there are no functional differences between the two.

Chapter 2: Licence
------------------

       Copyright (C) 1997-2009  Robert Riebisch

       UPXDUMP is free software; you can redistribute it and/or modify it
       under the terms of the GNU General Public License as published by
       the Free Software Foundation; either version 2 of the License, or
       (at your option) any later version.

       UPXDUMP is distributed in the hope that it will be useful, but
       WITHOUT ANY WARRANTY; without even the implied warranty of
       MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
       General Public License for more details.

       You should have received a copy of the GNU General Public License
       along with this program; see the file `licence.txt'.

Chapter 3: System requirements
------------------------------

   3.1 For the 16-bit version

        -  Intel 8086/88 microprocessor (or compatibles)

        -  Microsoft MS-DOS 3.0 (or compatibles)

   3.2 For the 32-bit version

        -  Intel 80386 microprocessor (or compatibles)

        -  Microsoft MS-DOS 3.0 (or compatibles)

        -  32-bit DPMI server (e.g. CWSDPMI)

        -  optional: LFN API (e.g. DOSLFN) for long file name support

Chapter 4: Installation
-----------------------

       Decompress the archive with, e.g., Info-ZIP UnZip to an empty
       directory.

Chapter 5: Usage
----------------

       UPXDUMP is a command-line application. It only accepts one option
       passed to it. This must be either a relative or absolute file name
       or `/?', `-?' to print the very short help screen.

   5.1 Sample output

 5.1.1 For the 16-bit version

       Running UPXDUMP in directory `C:\TEMP\UPX' examing file `upx.ttp'
       from package upx303a.zip.

         C:\TEMP\UPX>upxdump atari\upx.ttp
         Analyzing `C:\TEMP\UPX\ATARI\UPX.TTP'...
         
         File size:                          354320 bytes
         Data format version:                    13
         Executable format:                     129 ("atari/tos")
         Compression method:                      9 ("nrv2e/8")
         Compression level:                      10
         Uncompressed data length:          1415884 bytes
         Compressed data length:             353605 bytes
         Original file size:                1415888 bytes
         Filter:                                  0/0

 5.1.2 For the 32-bit version

       Running UPXDUMP in directory `C:\TEMP\UPX' examing file
       `upx.exe' from package upx303w.zip. Please notice long file name
       `c:\Program Files\UPX\upx.exe'.

         C:\TEMP\UPX>upxdump "c:\program files\upx\upx.exe"
         Analyzing `C:\program files\upx\upx.exe'...
         
         File size:                          271872 bytes
         Data format version:                    13
         Executable format:                       9 ("win32/pe")
         Compression method:                     14 ("lzma")
         Compression level:                      10
         Uncompressed data length:          1337009 bytes
         Compressed data length:             266671 bytes
         Original file size:                1297408 bytes
         Filter:                                 38/18

Chapter 6: Technical support
----------------------------

       Please visit `http://www.bttr-software.de/' for help or updates.

Chapter 7: Version history
--------------------------

   7.1 2009-04-19

        -  first public release

Chapter 8: Trivia
-----------------

       UPXDUMP has been created using Turbo Pascal 5.5 to 7.01,
       Free Pascal 2.2.4, aPACK 0.99b, UPX 3.03, Notepad2 3.0.20, and
       Halibut r8112.

Appendix A: aPACK advertisement
-------------------------------

       This product uses the aPACK executable compressor, Copyright
       (C) 1997-2000 by Joergen Ibsen, All Rights Reserved. For more
       information, please visit: `http://www.ibsensoftware.com/'

