home *** CD-ROM | disk | FTP | other *** search
/ PC World 2000 August / PCWorld_2000-08_cd.bin / Software / Vyzkuste / tiptrik / Upx101d / upx101d.exe / upx.doc < prev    next >
Text File  |  2000-04-09  |  20KB  |  526 lines
  1. NAME
  2.     upx - compress or expand executable files
  3.  
  4. SYNOPSIS
  5.     upx [ *command* ] [ *options* ] *filename*...
  6.  
  7. ABSTRACT
  8.                 The Ultimate Packer for eXecutables
  9.       Copyright (c) 1996-2000 Markus Oberhumer & Laszlo Molnar
  10.            http://wildsau.idv.uni-linz.ac.at/mfx/upx.html
  11.                       http://www.nexus.hu/upx
  12.                         http://upx.tsx.org
  13.  
  14.     UPX is a portable, extendable, high-performance executable
  15.     packer for several different executable formats. It achieves an
  16.     excellent compression ratio and offers **very** fast
  17.     decompression. Your executables suffer no memory overhead or
  18.     other drawbacks for most of the formats supported.
  19.  
  20.     While you may use UPX freely for both non-commercial and
  21.     commercial executables (for details see the file LICENSE), we
  22.     would highly appreciate if you credit UPX and ourselves in the
  23.     documentation, possibly including a reference to the UPX home
  24.     page. Thanks.
  25.  
  26.     [ Using UPX in non-OpenSource applications without proper
  27.     credits is considered not politically correct ;-) ]
  28.  
  29. DISCLAIMER
  30.     UPX comes with ABSOLUTELY NO WARRANTY; for details see the file
  31.     LICENSE.
  32.  
  33.     Having said that, we think that UPX is quite stable now. Indeed
  34.     we have compressed lots of files without any problems. Also, the
  35.     current version has undergone several months of beta testing -
  36.     actually it's almost 2 years since our first public beta.
  37.  
  38.     This is the first production quality release, and we plan that
  39.     future 1.xx releases will be backward compatible with this
  40.     version.
  41.  
  42.     Please report all problems or suggestions to the authors.
  43.     Thanks.
  44.  
  45. DESCRIPTION
  46.     UPX is a versatile executable packer with the following
  47.     features:
  48.  
  49.       - excellent compression ratio: compresses better than zip/gzip,
  50.           use UPX to decrease the size of your distribution !
  51.  
  52.       - very fast decompression: about 10 MB/sec even on my old Pentium 133
  53.  
  54.       - no memory overhead for your compressed executables for most of the
  55.           supported formats
  56.  
  57.       - safe: you can list, test and unpack your executables
  58.           Also, a checksum of both the compressed and uncompressed file is
  59.           maintained internally.
  60.  
  61.       - universal: UPX can pack a number of executable formats:
  62.           * dos/exe
  63.           * dos/sys
  64.           * dos/com
  65.           * djgpp2/coff
  66.           * watcom/le (supporting DOS4G, PMODE/W, DOS32a and CauseWay)
  67.           * win32/pe
  68.           * rtm32/pe
  69.           * tmt/adam
  70.           * linux/i386
  71.           * atari/tos
  72.  
  73.       - portable: UPX is written in portable endian-neutral C++
  74.  
  75.       - extendable: because of the class layout it's very easy to support
  76.           new executable formats or add new compression algorithms
  77.  
  78.       - free: UPX can be distributed and used freely. And from version 0.99
  79.           the full source code of UPX is released under the GNU General Public
  80.           License (GPL) !
  81.  
  82.     You probably understand now why we call UPX the "*ultimate*"
  83.     executable packer.
  84.  
  85. COMMANDS
  86.   Compress
  87.  
  88.     This is the default operation, eg. upx yourfile.exe will
  89.     compress the file specified on the command line.
  90.  
  91.   Decompress
  92.  
  93.     All UPX supported file formats can be unpacked using the -d
  94.     switch, eg. upx -d yourfile.exe will uncompress the file you've
  95.     just compressed.
  96.  
  97.   Test
  98.  
  99.     The -t command tests the integrity of the compressed and
  100.     uncompressed data, eg. upx -t yourfile.exe check whether your
  101.     file can be safely decompressed. Note, that this command doesn't
  102.     check the whole file, only the part that will be uncompressed
  103.     during program execution. This means that you should not use
  104.     this command instead of a virus checker.
  105.  
  106.   List
  107.  
  108.     The -l command prints out some information about the compressed
  109.     files specified on the command line as parameters, eg upx -l
  110.     yourfile.exe shows the compressed / uncompressed size and the
  111.     compression ratio of *yourfile.exe*.
  112.  
  113. OPTIONS
  114.     -q: be quiet, suppress warnings
  115.  
  116.     -q -q (or -qq): be very quiet, suppress errors
  117.  
  118.     -q -q -q (or -qqq): produce no output at all
  119.  
  120.     --help: prints the help
  121.  
  122.     --version: print the version of UPX
  123.  
  124.     --stdout: writes all output to stdout
  125.  
  126.     [ ...to be written... - type `upx --help' for now ]
  127.  
  128. COMPRESSION LEVELS & TUNING
  129.     UPX offers ten different compression levels from -1 to -9, and -
  130.     -best. The default compression level is -7.
  131.  
  132.     *   Compression levels 1, 2 and 3 are pretty fast.
  133.  
  134.     *   Compression levels 4, 5 and 6 achieve a good time/ratio
  135.         performance.
  136.  
  137.     *   Compression levels 7, 8 and 9 favor compression ratio over
  138.         speed.
  139.  
  140.     *   Compression level --best may take a very long time.
  141.  
  142.     Note that compression level -9 can be quite slow for some large
  143.     files, but you definitely should use it when releasing a final
  144.     version of your program. (E.g. it took about 20 minutes to
  145.     compress the almost 5 MB MAME 0.34 with -9 on my Pentium 133,
  146.     but the resulting executable was still ~65 kB smaller than when
  147.     using -7.)
  148.  
  149.     Since UPX 0.70 there is also an extra compression level --best
  150.     which squeezes out even some more compression ratio. While it is
  151.     usually fine to use this option with your favorite .com file it
  152.     may take several hours to compress a multi-megabyte program. You
  153.     have been warned.
  154.  
  155.     Tips for even better compression:
  156.  
  157.     *   Try if --overlay=strip works.
  158.  
  159.     *   For win32/pe programs there's --strip-relocs=0. See notes below.
  160.  
  161. OVERLAY HANDLING OPTIONS
  162.     UPX handles overlays like many other executable packers do: it
  163.     simply copies the overlay after the compressed image. This works
  164.     with some files, but doesn't work with others.
  165.  
  166.     Since version 0.90 UPX defaults to --overlay=copy for all
  167.     executable formats.
  168.  
  169.       --overlay=copy    Copy any extra data attached to the file. [DEFAULT]
  170.  
  171.       --overlay=strip   Strip any overlay from the program instead of
  172.                         copying it. Be warned, this may make the compressed
  173.                         program crash or otherwise unusable.
  174.  
  175.       --overlay=skip    Refuse to compress any program which has an overlay.
  176.  
  177. ENVIRONMENT
  178.     The environment variable UPX can hold a set of default options
  179.     for UPX. These options are interpreted first and can be
  180.     overwritten by explicit command line parameters. For example:
  181.  
  182.         for DOS/Windows:   set UPX=-9 --compress-icons#1
  183.         for sh/ksh/zsh:    UPX="-9 --compress-icons=1"; export UPX
  184.         for csh/tcsh:      setenv UPX "-9 --compress-icons=1"
  185.  
  186.     Under DOS/Windows you must use '#' instead of '=' when setting
  187.     the environment variable because of a command.com limitiation.
  188.  
  189.     On Vax/VMS, the name of the environment variable is UPX_OPT, to
  190.     avoid a conflict with the symbol set for invocation of the
  191.     program.
  192.  
  193.     Not all of the options are valid in the environment variable -
  194.     UPX will tell you.
  195.  
  196.     You can use the --no-env option to turn this support off.
  197.  
  198. NOTES FOR THE SUPPORTED EXECUTABLE FORMATS
  199.   NOTES FOR ATARI/TOS
  200.  
  201.     This is the executable format used by the Atari ST, a 68000
  202.     based personal computer which was popular in the late '80s.
  203.     Support of this format is only because of nostalgic feelings of
  204.     one of the authors and serves no practical purpose :-).
  205.  
  206.     Packed programs will be byte-identical to the original after
  207.     uncompression. All debug information will be stripped, though.
  208.  
  209.     Extra options available for this executable format:
  210.  
  211.       (none)
  212.  
  213.   NOTES FOR DOS/COM
  214.  
  215.     Obviously UPX won't work with executables that want to read data
  216.     from themselves (like some commandline utilities that ship with
  217.     Win95/98).
  218.  
  219.     Compressed programs only work on a 286+.
  220.  
  221.     Packed programs will be byte-identical to the original after
  222.     uncompression.
  223.  
  224.     Maximum uncompressed size: ~65100 bytes.
  225.  
  226.     Extra options available for this executable format:
  227.  
  228.       --8086              Create an executable that works on any 8086 CPU.
  229.  
  230.   NOTES FOR DOS/EXE
  231.  
  232.     dos/exe stands for all "normal" 16-bit DOS executables.
  233.  
  234.     Obviously UPX won't work with executables that want to read data
  235.     from themselves (like some command line utilities that ship with
  236.     Win95/98).
  237.  
  238.     Compressed programs only work on a 286+.
  239.  
  240.     Extra options available for this executable format:
  241.  
  242.       --8086              Create an executable that works on any 8086 CPU.
  243.  
  244.       --no-reloc          Use no relocation records in the exe header.
  245.  
  246.   NOTES FOR DOS/SYS
  247.  
  248.     You can only compress plain sys files, sys/exe (two in one)
  249.     combos are not supported.
  250.  
  251.     Compressed programs only work on a 286+.
  252.  
  253.     Packed programs will be byte-identical to the original after
  254.     uncompression.
  255.  
  256.     Maximum uncompressed size: ~65350 bytes.
  257.  
  258.     Extra options available for this executable format:
  259.  
  260.       --8086              Create an executable that works on any 8086 CPU.
  261.  
  262.   NOTES FOR DJGPP2/COFF
  263.  
  264.     First of all, it is recommended to use UPX *instead* of strip.
  265.     strip has the very bad habit of replacing your stub with its own
  266.     (outdated) version. Additionally UPX corrects a bug/feature in
  267.     strip v2.8.x: it will fix the 4 KByte aligment of the stub.
  268.  
  269.     UPX includes the full functionality of stubify. This means it
  270.     will automatically stubify your COFF files. Use the option --
  271.     coff to disable this behaviour (see below).
  272.  
  273.     UPX automatically handles Allegro packfiles.
  274.  
  275.     The DLM format (a rather exotic shared library extension) is not
  276.     supported.
  277.  
  278.     Packed programs will be byte-identical to the original after
  279.     uncompression. All debug information and trailing garbage will
  280.     be stripped, though.
  281.  
  282.     BTW, UPX is the successor of the DJP executable packer.
  283.  
  284.     Extra options available for this executable format:
  285.  
  286.       --coff              Produce COFF output instead of EXE. By default
  287.                           UPX keeps your current stub.
  288.  
  289.   NOTES FOR LINUX/i386
  290.  
  291.     How it works:
  292.  
  293.       Because Linux is a real operating system, the in-place in-memory
  294.       decompression scheme used in the other executable formats doesn't
  295.       work here.
  296.  
  297.       Instead we must use temporary decompression to disk. Interestingly -
  298.       because of the good memory management of the Linux kernel - this
  299.       often does not introduce a noticable delay, and in fact there
  300.       will be no disk access at all if you have enough free memory as
  301.       the entire process takes places within the filesystem buffers.
  302.  
  303.       A compressed executable consists of the UPX stub and an overlay
  304.       which contains the original program in a compressed form.
  305.  
  306.       The UPX stub is a statically linked ELF executable and does
  307.       the following at program startup:
  308.  
  309.         1) decompress the overlay to a temporary location in /tmp
  310.         2) open the temporary file for reading
  311.         3) try to delete the temporary file and start (execve)
  312.            the uncompressed program in /tmp using /proc/<pid>/fd/X as
  313.            attained by step 2)
  314.         4) if that fails, fork off a subprocess to clean up and
  315.            start the program in /tmp in the meantime
  316.  
  317.       The UPX stub is about 1700 bytes long, partly written in assembler
  318.       and only uses kernel syscalls. It is not linked against any libc.
  319.  
  320.     Benefits:
  321.  
  322.       - UPX can compress all executables, be it AOUT, ELF, libc4, libc5,
  323.         libc6, Shell/Perl/Python/... scripts, standalone Java .class
  324.         binaries, or whatever...
  325.         All scripts and programs will work just as before.
  326.  
  327.       - Compressed programs are completely self-contained. No need for
  328.         any external program.
  329.  
  330.       - UPX keeps your original program untouched. This means that
  331.         after decompression you will have a byte-identical version,
  332.         and you can use UPX as a file compressor just like gzip.
  333.         [ Note that UPX maintains a checksum of the file internally,
  334.           so it is indeed a reliable alternative. ]
  335.  
  336.       - As the stub only uses syscalls and isn't linked against libc it
  337.         should run under any Linux configuration that can run ELF
  338.         binaries and has working /proc support.
  339.  
  340.       - For the same reason compressed executables should run under
  341.         FreeBSD and other systems which can run Linux binaries.
  342.         [ Please send feedback on this topic ]
  343.  
  344.     Drawbacks:
  345.  
  346.       - You need additional free disk space for the uncompressed program
  347.         in your /tmp directory. This program is deleted immediately after
  348.         decompression, but you still need it for the full execution time
  349.         of the program.
  350.  
  351.       - You must have /proc filesystem support as the stub wants to open
  352.         /proc/<pid>/exe and needs /proc/<pid>/fd/X. This also means that you
  353.         cannot compress programs that are used during the boot sequence
  354.         before /proc is mounted.
  355.  
  356.       - `ldd' and `size' won't show anything useful because all they
  357.         see is the statically linked stub (since version 0.82 the section
  358.         headers are stripped from the UPX stub and `size' doesn't even
  359.         recognize the file format any longer - looks like a binutils bug).
  360.  
  361.       - Utilities like `top' will display numerical values in the process
  362.         name field. This is because Linux computes the process name from
  363.         the first argument of the last execve syscall (which is typically
  364.         something like /proc/<pid>/fd/3).
  365.  
  366.       - To reduce memory requirements during uncompression UPX splits the
  367.         original file into blocks, so the compression ratio is a little bit
  368.         worse than with the other executable formats (but still quite nice).
  369.         [ Advise from kernel experts which can tell me more about the
  370.           execve memory semantics is welcome. Maybe this shortcoming
  371.           could be removed. ]
  372.  
  373.       - Because of temporary decompression to disk the decompression speed
  374.         is not as fast as with the other executable formats. Still, I can see
  375.         no noticable delay when starting programs like my ~3 MB emacs (which
  376.         is less than 1 MB when compressed :-).
  377.  
  378.     Notes:
  379.  
  380.       - As UPX leaves your original program untouched it is advantageous
  381.         to strip it before compression.
  382.  
  383.       - It is not advisable to compress programs which usually have many
  384.         instances running (like `make') because the common segments of
  385.         compressed programs won't be shared any longer between different
  386.         processes.
  387.  
  388.       - If you compress a script you will lose platform independence -
  389.         this could be a problem if you are using NFS mounted disks.
  390.  
  391.       - Compression of suid, guid and sticky-bit programs is rejected
  392.         because of possible security implications.
  393.  
  394.       - For the same reason there is no sense in making any compressed
  395.         program suid.
  396.  
  397.       - Obviously UPX won't work with executables that want to read data
  398.         from themselves. E.g., this might be a problem for Perl scripts
  399.         which access their __DATA__ lines.
  400.  
  401.       - In case of internal errors the stub will abort with exitcode 127.
  402.         Typical reasons for this to happen are that the program has somehow
  403.         been modified after compression, you have run out of disk space
  404.         or your /proc filesystem is not yet mounted.
  405.         Running `strace -o strace.log compressed_exe' will tell you more.
  406.  
  407.     Extra options available for this executable format:
  408.  
  409.       (none)
  410.  
  411.   NOTES FOR RTM32/PE
  412.  
  413.     Same as win32/pe.
  414.  
  415.   NOTES FOR TMT/ADAM
  416.  
  417.     This format is used by the TMT Pascal compiler - see
  418.     http://www.tmt.com/ .
  419.  
  420.     Extra options available for this executable format:
  421.  
  422.       (none)
  423.  
  424.   NOTES FOR WATCOM/LE
  425.  
  426.     UPX has been successfully tested with the following extenders:
  427.     DOS4G, DOS4GW, PMODE/W, DOS32a, CauseWay. The WDOS/X extender is
  428.     partly supported (for details see the file bugs BUGS).
  429.  
  430.     Yes, you can use your compressed executables with DOS4GW.
  431.  
  432.     The LX format is not yet supported.
  433.  
  434.     DLLs are not supported.
  435.  
  436.     Extra options available for this executable format:
  437.  
  438.       --le                Produce an unbound LE output instead of
  439.                           keeping the current stub.
  440.  
  441.   NOTES FOR WIN32/PE
  442.  
  443.     The PE support in UPX is quite stable now, but definitely there
  444.     are still some incompabilities with some files.
  445.  
  446.     Because of the way UPX (and other packers for this format)
  447.     works, you can see increased memory usage of your compressed
  448.     files. If you start several instances of huge compressed
  449.     programs you're wasting memory because the common segements of
  450.     the program won't get shared across the instances. On the other
  451.     hand if you're compressing only smaller programs, or running
  452.     only one instance of larger programs, then this penalty is
  453.     smaller, but it's still there.
  454.  
  455.     If you're running executables from network, then compressed
  456.     programs will load faster, and require less bandwidth during
  457.     execution.
  458.  
  459.     DLLs are supported.
  460.  
  461.     Extra options available for this executable format:
  462.  
  463.      --compress-exports=0 Don't compress the export section.
  464.                           Use this if you plan to run the compressed
  465.                           program under Wine.
  466.      --compress-exports=1 Compress the export section. [DEFAULT]
  467.                           Compression of the export section can improve the
  468.                           compression ratio quite a bit but may not work
  469.                           with all programs (like winword.exe).
  470.                           UPX never compresses the export section of a DLL
  471.                           regardless of this option.
  472.  
  473.       --compress-icons=0  Don't compress any icons.
  474.       --compress-icons=1  Compress all but the first icon.
  475.       --compress-icons=2  Compress all icons which are not in the
  476.                           first icon directory. [DEFAULT]
  477.  
  478.       --compress-resources=0  Don't compress any resources at all.
  479.  
  480.       --force             Force compression even when there is an
  481.                           unexpected value in a header field.
  482.                           Use with care.
  483.  
  484.       --strip-relocs=0    Don't strip relocation records.
  485.       --strip-relocs=1    Strip relocation records. [DEFAULT]
  486.                           This option only works on executables with base
  487.                           address greater or equal to 0x400000. Usually the
  488.                           compressed files becomes smaller, but some files
  489.                           may become larger. Note that the resulting file will
  490.                           not work under Win32s.
  491.                           UPX never strips relocations from a DLL
  492.                           regardless of this option.
  493.  
  494. DIAGNOSTICS
  495.     Exit status is normally 0; if an error occurs, exit status is 1.
  496.     If a warning occurs, exit status is 2.
  497.  
  498.     UPX's diagnostics are intended to be self-explanatory.
  499.  
  500. BUGS
  501.     Please report all bugs immediately to the authors.
  502.  
  503. AUTHORS
  504.      Markus F.X.J. Oberhumer <markus.oberhumer@jk.uni-linz.ac.at>
  505.      http://wildsau.idv.uni-linz.ac.at/mfx/upx.html
  506.  
  507.      Laszlo Molnar <ml1050@cdata.tvnet.hu>
  508.      http://www.nexus.hu/upx
  509.  
  510. COPYRIGHT
  511.     Copyright (C) 1996-2000 Markus Franz Xaver Johannes Oberhumer
  512.     Copyright (C) 1996-2000 Laszlo Molnar
  513.  
  514.     This program may be used freely, and you are welcome to
  515.     redistribute it under certain conditions.
  516.  
  517.     This program is distributed in the hope that it will be useful,
  518.     but WITHOUT ANY WARRANTY; without even the implied warranty of
  519.     MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the UPX
  520.     License Agreement for more details.
  521.  
  522.     You should have received a copy of the UPX License Agreement
  523.     along with this program; see the file LICENSE. If not, visit the
  524.     UPX home page.
  525.  
  526.