|
jpayne@68
|
1 .\" SPDX-License-Identifier: 0BSD
|
|
jpayne@68
|
2 .\"
|
|
jpayne@68
|
3 .\" Author: Lasse Collin
|
|
jpayne@68
|
4 .\"
|
|
jpayne@68
|
5 .TH XZDEC 1 "2024-04-08" "Tukaani" "XZ Utils"
|
|
jpayne@68
|
6 .SH NAME
|
|
jpayne@68
|
7 xzdec, lzmadec \- Small .xz and .lzma decompressors
|
|
jpayne@68
|
8 .SH SYNOPSIS
|
|
jpayne@68
|
9 .B xzdec
|
|
jpayne@68
|
10 .RI [ option... ]
|
|
jpayne@68
|
11 .RI [ file... ]
|
|
jpayne@68
|
12 .br
|
|
jpayne@68
|
13 .B lzmadec
|
|
jpayne@68
|
14 .RI [ option... ]
|
|
jpayne@68
|
15 .RI [ file... ]
|
|
jpayne@68
|
16 .SH DESCRIPTION
|
|
jpayne@68
|
17 .B xzdec
|
|
jpayne@68
|
18 is a liblzma-based decompression-only tool for
|
|
jpayne@68
|
19 .B .xz
|
|
jpayne@68
|
20 (and only
|
|
jpayne@68
|
21 .BR .xz )
|
|
jpayne@68
|
22 files.
|
|
jpayne@68
|
23 .B xzdec
|
|
jpayne@68
|
24 is intended to work as a drop-in replacement for
|
|
jpayne@68
|
25 .BR xz (1)
|
|
jpayne@68
|
26 in the most common situations where a script
|
|
jpayne@68
|
27 has been written to use
|
|
jpayne@68
|
28 .B "xz \-\-decompress \-\-stdout"
|
|
jpayne@68
|
29 (and possibly a few other commonly used options) to decompress
|
|
jpayne@68
|
30 .B .xz
|
|
jpayne@68
|
31 files.
|
|
jpayne@68
|
32 .B lzmadec
|
|
jpayne@68
|
33 is identical to
|
|
jpayne@68
|
34 .B xzdec
|
|
jpayne@68
|
35 except that
|
|
jpayne@68
|
36 .B lzmadec
|
|
jpayne@68
|
37 supports
|
|
jpayne@68
|
38 .B .lzma
|
|
jpayne@68
|
39 files instead of
|
|
jpayne@68
|
40 .B .xz
|
|
jpayne@68
|
41 files.
|
|
jpayne@68
|
42 .PP
|
|
jpayne@68
|
43 To reduce the size of the executable,
|
|
jpayne@68
|
44 .B xzdec
|
|
jpayne@68
|
45 doesn't support multithreading or localization,
|
|
jpayne@68
|
46 and doesn't read options from
|
|
jpayne@68
|
47 .B XZ_DEFAULTS
|
|
jpayne@68
|
48 and
|
|
jpayne@68
|
49 .B XZ_OPT
|
|
jpayne@68
|
50 environment variables.
|
|
jpayne@68
|
51 .B xzdec
|
|
jpayne@68
|
52 doesn't support displaying intermediate progress information: sending
|
|
jpayne@68
|
53 .B SIGINFO
|
|
jpayne@68
|
54 to
|
|
jpayne@68
|
55 .B xzdec
|
|
jpayne@68
|
56 does nothing, but sending
|
|
jpayne@68
|
57 .B SIGUSR1
|
|
jpayne@68
|
58 terminates the process instead of displaying progress information.
|
|
jpayne@68
|
59 .SH OPTIONS
|
|
jpayne@68
|
60 .TP
|
|
jpayne@68
|
61 .BR \-d ", " \-\-decompress ", " \-\-uncompress
|
|
jpayne@68
|
62 Ignored for
|
|
jpayne@68
|
63 .BR xz (1)
|
|
jpayne@68
|
64 compatibility.
|
|
jpayne@68
|
65 .B xzdec
|
|
jpayne@68
|
66 supports only decompression.
|
|
jpayne@68
|
67 .TP
|
|
jpayne@68
|
68 .BR \-k ", " \-\-keep
|
|
jpayne@68
|
69 Ignored for
|
|
jpayne@68
|
70 .BR xz (1)
|
|
jpayne@68
|
71 compatibility.
|
|
jpayne@68
|
72 .B xzdec
|
|
jpayne@68
|
73 never creates or removes any files.
|
|
jpayne@68
|
74 .TP
|
|
jpayne@68
|
75 .BR \-c ", " \-\-stdout ", " \-\-to-stdout
|
|
jpayne@68
|
76 Ignored for
|
|
jpayne@68
|
77 .BR xz (1)
|
|
jpayne@68
|
78 compatibility.
|
|
jpayne@68
|
79 .B xzdec
|
|
jpayne@68
|
80 always writes the decompressed data to standard output.
|
|
jpayne@68
|
81 .TP
|
|
jpayne@68
|
82 .BR \-q ", " \-\-quiet
|
|
jpayne@68
|
83 Specifying this once does nothing since
|
|
jpayne@68
|
84 .B xzdec
|
|
jpayne@68
|
85 never displays any warnings or notices.
|
|
jpayne@68
|
86 Specify this twice to suppress errors.
|
|
jpayne@68
|
87 .TP
|
|
jpayne@68
|
88 .BR \-Q ", " \-\-no-warn
|
|
jpayne@68
|
89 Ignored for
|
|
jpayne@68
|
90 .BR xz (1)
|
|
jpayne@68
|
91 compatibility.
|
|
jpayne@68
|
92 .B xzdec
|
|
jpayne@68
|
93 never uses the exit status 2.
|
|
jpayne@68
|
94 .TP
|
|
jpayne@68
|
95 .BR \-h ", " \-\-help
|
|
jpayne@68
|
96 Display a help message and exit successfully.
|
|
jpayne@68
|
97 .TP
|
|
jpayne@68
|
98 .BR \-V ", " \-\-version
|
|
jpayne@68
|
99 Display the version number of
|
|
jpayne@68
|
100 .B xzdec
|
|
jpayne@68
|
101 and liblzma.
|
|
jpayne@68
|
102 .SH "EXIT STATUS"
|
|
jpayne@68
|
103 .TP
|
|
jpayne@68
|
104 .B 0
|
|
jpayne@68
|
105 All was good.
|
|
jpayne@68
|
106 .TP
|
|
jpayne@68
|
107 .B 1
|
|
jpayne@68
|
108 An error occurred.
|
|
jpayne@68
|
109 .PP
|
|
jpayne@68
|
110 .B xzdec
|
|
jpayne@68
|
111 doesn't have any warning messages like
|
|
jpayne@68
|
112 .BR xz (1)
|
|
jpayne@68
|
113 has, thus the exit status 2 is not used by
|
|
jpayne@68
|
114 .BR xzdec .
|
|
jpayne@68
|
115 .SH NOTES
|
|
jpayne@68
|
116 Use
|
|
jpayne@68
|
117 .BR xz (1)
|
|
jpayne@68
|
118 instead of
|
|
jpayne@68
|
119 .B xzdec
|
|
jpayne@68
|
120 or
|
|
jpayne@68
|
121 .B lzmadec
|
|
jpayne@68
|
122 for normal everyday use.
|
|
jpayne@68
|
123 .B xzdec
|
|
jpayne@68
|
124 or
|
|
jpayne@68
|
125 .B lzmadec
|
|
jpayne@68
|
126 are meant only for situations where it is important to have
|
|
jpayne@68
|
127 a smaller decompressor than the full-featured
|
|
jpayne@68
|
128 .BR xz (1).
|
|
jpayne@68
|
129 .PP
|
|
jpayne@68
|
130 .B xzdec
|
|
jpayne@68
|
131 and
|
|
jpayne@68
|
132 .B lzmadec
|
|
jpayne@68
|
133 are not really that small.
|
|
jpayne@68
|
134 The size can be reduced further by dropping
|
|
jpayne@68
|
135 features from liblzma at compile time,
|
|
jpayne@68
|
136 but that shouldn't usually be done for executables distributed
|
|
jpayne@68
|
137 in typical non-embedded operating system distributions.
|
|
jpayne@68
|
138 If you need a truly small
|
|
jpayne@68
|
139 .B .xz
|
|
jpayne@68
|
140 decompressor, consider using XZ Embedded.
|
|
jpayne@68
|
141 .SH "SEE ALSO"
|
|
jpayne@68
|
142 .BR xz (1)
|
|
jpayne@68
|
143 .PP
|
|
jpayne@68
|
144 XZ Embedded: <https://tukaani.org/xz/embedded.html>
|
