UPX - the Ultimate Packer for eXecutables
Go to file
Markus F.X.J. Oberhumer 334be287fc CI: add minimal-ci
2023-01-17 23:43:24 +01:00
.github CI: add minimal-ci 2023-01-17 23:43:24 +01:00
doc all: bump version date 2023-01-01 19:53:28 +01:00
misc all: cleanups 2023-01-15 13:49:27 +01:00
src all: cleanups 2023-01-15 13:49:27 +01:00
vendor submodules: add vendor/rangeless 2023-01-15 03:23:22 +01:00
.clang-format all: clang-format-15.0.6 2022-12-12 19:25:31 +01: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 CI: update CI 2022-12-21 10:08:21 +01:00
.gitmodules submodules: add vendor/rangeless 2023-01-15 03:23:22 +01:00
CMakeLists.txt CI: add minimal-ci 2023-01-17 23:43:24 +01:00
compile_flags.txt src: add boost-pfr 2023-01-05 00:57:05 +01: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 CI: add minimal-ci 2023-01-17 23:43:24 +01:00
NEWS all: bump version date 2023-01-01 19:53:28 +01:00
README all: welcome 2023 2023-01-01 19:49:30 +01:00
README.SRC cmake: compile compression libs with -O2 even in Debug mode 2023-01-16 09:47:39 +01:00
THANKS all: welcome 2023 2023-01-01 19:49:30 +01:00

                 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-2023 Markus Oberhumer, Laszlo Molnar & John Reiser
                           https://upx.github.io



WELCOME
=======

Welcome to UPX !

UPX is a free, secure, portable, extendable, high-performance
executable packer for several executable formats.


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 Agreements 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

  - ARM64 for Windows (help wanted)

  - 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-2023 Markus Franz Xaver Johannes Oberhumer
Copyright (C) 1996-2023 Laszlo Molnar
Copyright (C) 2000-2023 John F. Reiser

UPX is distributed with full source code under the terms of the
GNU General Public License v2+; either under the pure GPLv2+ (see
the file COPYING), or (at your option) under the GPLv+2 with special
exceptions and restrictions granting the free usage for all binaries
including commercial programs (see the file LICENSE).

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.

You should have received a copy of the UPX License Agreements along
with this program; see the files COPYING and 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. ]