UPX - the Ultimate Packer for eXecutables
Go to file
Markus F.X.J. Oberhumer 13276d93fa all: bump tentative release date 2022-10-18 21:07:48 +02:00
.github CI: update for new GitHub Actions deprecated set-output commands 2022-10-12 16:29:20 +02:00
doc all: bump tentative release date 2022-10-18 21:07:48 +02:00
misc misc: update misc/rebuild-stubs-with-podman so that we can build 2022-10-05 16:07:12 +02:00
src all: bump tentative release date 2022-10-18 21:07:48 +02:00
vendor submodules: update for new version 2022-10-18 20:32:03 +02:00
.clang-format misc: update clang-format files 2022-09-16 13:26:13 +02:00
.editorconfig misc: update files 2022-09-11 13:26:32 +02:00
.gitattributes misc: add .gitattributes for GitHub linguist 2022-09-11 13:26:32 +02:00
.gitignore doc: work on improving docs; add generated files to Git repo 2022-09-16 13:26:13 +02:00
.gitmodules submodules: add new upx-vendor submodules in directory "vendor" 2022-09-11 13:26:29 +02:00
CMakeLists.txt all: add support for a basic "make test" 2022-10-06 14:10:35 +02:00
COPYING Whitespace changes. 2006-12-05 17:06:37 +01:00
LICENSE Initial commit (from git) 2000-05-19 16:04:55 +00:00
Makefile make: add new top-level Makefile, now using CMake 2022-09-11 13:26:32 +02:00
NEWS all: bump tentative release date 2022-10-18 21:07:48 +02:00
README doc: work on README 2022-09-16 13:26:13 +02:00
README.SRC doc: update README.SRC, mention misc/rebuild-stubs-with-podman 2022-09-16 13:26:13 +02:00
THANKS Welcome 2022. 2022-09-04 04:24:39 +02:00
compile_flags.txt misc: add compile_flags.txt to support editors using clangd LSP 2022-09-11 13:26:32 +02:00

README

                 ooooo     ooo  ooooooooo.  ooooooo  ooooo
                 `888'     `8'  `888   `Y88. `8888    d8'
                  888       8    888   .d88'   Y888..8P
                  888       8    888ooo88P'     `8888'
                  888       8    888           .8PY888.
                  `88.    .8'    888          d8'  `888b
                    `YbodP'     o888o       o888o  o88888o


                    The Ultimate Packer for eXecutables
   Copyright (c) 1996-2022 Markus Oberhumer, Laszlo Molnar & John Reiser
                           https://upx.github.io



WELCOME
=======

Welcome to UPX !

Please don't forget to read the file LICENSE - UPX is distributed
under the GNU General Public License (GPL) with special exceptions
allowing the distribution of all compressed executables, including
commercial programs.


INTRODUCTION
============

UPX is an advanced executable file compressor. UPX will typically
reduce the file size of programs and DLLs by around 50%-70%, thus
reducing disk space, network load times, download times and
other distribution and storage costs.

Programs and libraries compressed by UPX are completely self-contained
and run exactly as before, with no runtime or memory penalty for most
of the supported formats.

UPX supports a number of different executable formats, including
Windows programs and DLLs, macOS apps and Linux executables.

UPX is free software distributed under the term of the GNU General
Public License. Full source code is available.

UPX may be distributed and used freely, even with commercial applications.
See the UPX License Agreement for details.


SECURITY CONTEXT
================

IMPORTANT NOTE: UPX inherits the security context of any files it handles.

This means that packing, unpacking, or even testing or listing a file requires
the same security considerations as actually executing the file.

Use UPX on trusted files only!


SHORT DOCUMENTATION
===================

'upx program.exe' will compress a program or DLL. For best compression
results try 'upx --best program.exe' or 'upx --brute program.exe'.

Please see the file UPX.DOC for the full documentation. The files
NEWS and BUGS also contain various tidbits of information.


THE FUTURE
==========

  - Stay up-to-date with ongoing OS and executable format changes.

  - RISC-V 64 for Linux.

  - We will *NOT* add any sort of protection and/or encryption.
    This only gives people a false feeling of security because
    all "protectors" can be broken by definition.

  - Fix all remaining bugs - please report any issues
    https://github.com/upx/upx/issues


COPYRIGHT
=========

Copyright (C) 1996-2022 Markus Franz Xaver Johannes Oberhumer
Copyright (C) 1996-2022 Laszlo Molnar
Copyright (C) 2000-2022 John F. Reiser

This program may be used freely, and you are welcome to
redistribute it under certain conditions.

This program 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
UPX License Agreement for more details.

You should have received a copy of the UPX License Agreement along
with this program; see the file LICENSE. If not, visit the UPX home page.


Share and enjoy,
Markus & Laszlo & John


   Markus F.X.J. Oberhumer              Laszlo Molnar
   <markus@oberhumer.com>               <ezerotven+github@gmail.com>

   John F. Reiser
   <jreiser@BitWagon.com>


[ The term UPX is a shorthand for the Ultimate Packer for eXecutables
  and holds no connection with potential owners of registered trademarks
  or other rights. ]