XZ Utils

XZ Utils is free general-purpose data compression software with a high compression ratio. XZ Utils were written for POSIX-like systems, but also work on some not-so-POSIX systems. XZ Utils are the successor to LZMA Utils.

The core of the XZ Utils compression code is based on LZMA SDK, but it has been modified quite a lot to be suitable for XZ Utils. The primary compression algorithm is currently LZMA2, which is used inside the .xz container format. With typical files, XZ Utils create 30 % smaller output than gzip and 15 % smaller output than bzip2.

XZ Utils consist of several components:

While liblzma has a zlib-like API, liblzma doesn't include any file I/O functions. A separate I/O library is planned, which would abstract handling of .gz, .bz2, and .xz files with an easy to use API.

Source code

The files have been signed with this OpenPGP key.

See the NEWS file for a summary of changes between versions.

Stable

5.4.2 was released on 2023-03-18. A minor bug fix release 5.2.11 to the old stable branch was released on 2023-03-18.

Note: Versions from 5.2.6 to 5.4.2 have a build system bug that prevents building of shared libzma on some operating systems if --disable-threads is used when running configure. To build without threading support, a workaround is to pass also EGREP='grep -E' as an argument to configure.

The packages of the stable XZ Utils releases are hosted on Sourceforge and thus some of the links below redirect to the XZ Utils files section on Sourceforge. This means that if you use a web browser (detected from the user agent), you will see the Sourceforge download page before the download starts. The redirection shouldn't affect users of GNU Wget and similar utilities.

xz-5.4.2.tar.gz (2734 KiB) signature
xz-5.4.2.tar.bz2 (2016 KiB) signature
xz-5.4.2.tar.zst (1630 KiB) signature
xz-5.4.2.tar.xz (1574 KiB) signature

Old stable is still maintained:

xz-5.2.11.tar.gz (2081 KiB) signature
xz-5.2.11.tar.bz2 (1597 KiB) signature
xz-5.2.11.tar.zst (1308 KiB) signature
xz-5.2.11.tar.xz (1266 KiB) signature

Development

The new APIs, command line options etc. in development releases should be considered unstable. Incompatible changes to unstable features may be done before they get included in a stable release.

There currently are no development releases.

Git repository

The primary repository is on GitHub:

git clone https://github.com/tukaani-project/xz

It is mirrored with some delay to git.tukaani.org:

git clone https://git.tukaani.org/xz.git

Gitweb

Branches:

Building the code from the git repository requires GNU Autotools. Here are the minimum versions that should work with XZ Utils; using the latest versions is strongly recommended:

The following are optional dependencies. The autogen.sh script will fail if they are missing but autogen.sh takes command line arguments to disable these dependencies.

Security issues

xzgrep CVE-2022-1271, ZDI-CAN-16587

A patch to fix a security vulnerability in xzgrep (CVE-2022-1271, ZDI-CAN-16587) was made public on 2022-04-07. The patch applies to 4.999.9beta to 5.2.5, 5.3.1alpha, and 5.3.2alpha. Newer XZ Utils releases include an improved fix for the problem.

It is a severe issue if an attacker can control the filenames that are given on the xzgrep command line. The vulnerability was discovered by cleemy desu wayo working with Trend Micro Zero Day Initiative. For more information, see the detailed description in the patch file linked below.

xzgrep-ZDI-CAN-16587.patch
xzgrep-ZDI-CAN-16587.patch.sig

Bindings

Python

Python 3.3 includes bindings for liblzma. A backport of these bindings are available for Python 2 in the backports.lzma package.

lzmaffi is another Python binding which adds random-access decompression support.

The original Python 2 binding for liblzma is PylibLZMA.

Perl

Perl bindings for liblzma: IO-Compress-Lzma and Compress-Raw-Lzma.

Haskell

Haskell bindings.

Delphi and Free Pascal

Bindings and example programs for Delphi and Free Pascal are available here.

Pre-built binaries

Many free software operating systems already provide easy-to-install XZ Utils binaries. It doesn't make sense to provide links to all those here. Instead, binaries or links to websites providing binaries are listed here only for operating systems that don't have well-known repositories where users would get software like this.

If you have a website that provides up-to-date XZ Utils binaries for an operating system that meets the the criteria above, let me know and I will include a link here. Note that I won't host the binaries themselves without a good reason.

Windows

The Windows version of XZ Utils includes binaries for 32-bit and 64-bit x86. The binaries only depend on msvcrt.dll, which is available on Windows 98 and later out of the box.

5.2.10 or 5.2.11 does not have anything significant for Windows so only 5.2.9 is here. 5.4.x builds are not provided for now.

xz-5.2.9-windows.zip (1473 KiB) signature
xz-5.2.9-windows.7z (708 KiB) signature

DOS

The DOS version of XZ Utils includes only the xz command line tool and some documentation. The xz tool should work e.g. on FreeDOS (also in DOSEMU), MS-DOS, and Windows 95/98/98SE/ME. This doesn't necessarily work in DOSBox at all, and at least some problems are expected under Windows XP Command Prompt (signal handling doesn't work).

Since the DOS version is naturally going to get very little testing, it is recommended to use the Windows version instead of the DOS version if you need xz under Windows 98 or later. It is likely that that the DOS version will be updated only occasionally.

5.2.0 and later have experimental support for 8.3 filenames. See xz-dos.txt in the binary package or dos/README.txt in the source package for details.

xz-5.4.0-dos.zip (277 KiB) signature

The package includes some copylefted code from DJGPP and CWSDPMI. The relevant source code is available from their home pages, and copies are also available below.

djlsr205.zip (2000 KiB)
djtst205.zip (1061 KiB)
csdpmi7s.zip (88 KiB)

Juan Manuel Guerrero has made a more complete port of XZ Utils to DOS. It also has support for short file names (8.3), but the naming method is different from the one found in 5.2.0 and later. It is available from DJGPP mirrors under /current/v2apps (e.g. xz-500b.zip for 5.0.0 binaries).

Old versions

Source and binary packages of old XZ Utils releases are available on a separate page.

Supported platforms

Below is an incomplete and somewhat vague (version numbers mostly missing) list of operating systems on which XZ Utils should work. The compiler(s) or toolchains are mentioned in parenthesis. GCC refers to GCC 3 or later. If you have additions or corrections, please email them to me.

[1] See also the platform-specific notes in the INSTALL file.

[2] 2010-09-22: HP ANSI C compiler crashes when compiling XZ Utils on PA-RISC. On Itanium there are no problems.

[3] On Solaris 8 and 9 one may need to pass ac_cv_prog_cc_c99= to configure if using Sun Studio.

[4] Use --disable-threads when running configure.

Documentation

Doxygen-generated liblzma API documentation is also included in the source packages since XZ Utils 5.4.2.

Licensing

The most interesting parts of XZ Utils (e.g. liblzma) are in the public domain. You can do whatever you want with the public domain parts.

Some parts of XZ Utils (e.g. build system and some utilities) are under different free software licenses such as GNU LGPLv2.1, GNU GPLv2, or GNU GPLv3.

See the file COPYING for more details.