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