xz-utils: Advertise XZ_DEFAULTS in README.Debian
[xz/debian.git] / debian / xz-utils.README.Debian
blobc79d8d4fcb7ee15b4cea500214acb2db11421a0f
1 XZ Utils for Debian
2 -------------------
4 XZ Utils should have been called LZMA Utils 4.42, but it came too late.
5 The old .lzma file format has some problems, worst of which is the lack
6 of magic number, but it gets enough use to still need to be supported.
7 See /usr/share/doc/xz-utils/history.txt.gz for the full story.
9 To support old scripts and muscle memory, XZ Utils can emulate the
10 legacy LZMA Utils interface.  To use this feature, you can install some
11 subset of the following list of symbolic links to your $PATH.
13         lzma, unlzma, lzcat -> /usr/bin/xz
14         lzgrep, lzegrep, lzfgrep -> /usr/bin/xzgrep
15         lzless -> /usr/bin/xzless
16         lzmore -> /usr/bin/xzmore
17         lzdiff, lzcmp -> /usr/bin/xzdiff
19 To allow administrators to keep the old lzma package, the xz-utils
20 package does not provide those links itself.  If you would like XZ Utils
21 to provide these commands by default for all users, install the
22 xz-lzma package.
24 The memory usage of xz can vary from a few hundred kilobytes to several
25 gigabytes depending on the compression settings.  If you would like xz
26 to automatically scale down its settings while compressing to decrease
27 memory usage, you can declare so by adding an option like the
28 following to your environment (e.g., in ~/.profile):
30         XZ_DEFAULTS=--memlimit-compress=256MiB
31         export XZ_DEFAULTS
33 See the "Memory usage" section of the xz(1) manual page for details.
35  -- Jonathan Nieder <jrnieder@gmail.com>  Sun, 26 Sep 2010 14:33:55 -0500