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