jpayne@68: .\" SPDX-License-Identifier: 0BSD
jpayne@68: .\"
jpayne@68: .\" Author: Lasse Collin
jpayne@68: .\"
jpayne@68: .TH XZDEC 1 "2024-04-08" "Tukaani" "XZ Utils"
jpayne@68: .SH NAME
jpayne@68: xzdec, lzmadec \- Small .xz and .lzma decompressors
jpayne@68: .SH SYNOPSIS
jpayne@68: .B xzdec
jpayne@68: .RI [ option... ]
jpayne@68: .RI [ file... ]
jpayne@68: .br
jpayne@68: .B lzmadec
jpayne@68: .RI [ option... ]
jpayne@68: .RI [ file... ]
jpayne@68: .SH DESCRIPTION
jpayne@68: .B xzdec
jpayne@68: is a liblzma-based decompression-only tool for
jpayne@68: .B .xz
jpayne@68: (and only
jpayne@68: .BR .xz )
jpayne@68: files.
jpayne@68: .B xzdec
jpayne@68: is intended to work as a drop-in replacement for
jpayne@68: .BR xz (1)
jpayne@68: in the most common situations where a script
jpayne@68: has been written to use
jpayne@68: .B "xz \-\-decompress \-\-stdout"
jpayne@68: (and possibly a few other commonly used options) to decompress
jpayne@68: .B .xz
jpayne@68: files.
jpayne@68: .B lzmadec
jpayne@68: is identical to
jpayne@68: .B xzdec
jpayne@68: except that
jpayne@68: .B lzmadec
jpayne@68: supports
jpayne@68: .B .lzma
jpayne@68: files instead of
jpayne@68: .B .xz
jpayne@68: files.
jpayne@68: .PP
jpayne@68: To reduce the size of the executable,
jpayne@68: .B xzdec
jpayne@68: doesn't support multithreading or localization,
jpayne@68: and doesn't read options from
jpayne@68: .B XZ_DEFAULTS
jpayne@68: and
jpayne@68: .B XZ_OPT
jpayne@68: environment variables.
jpayne@68: .B xzdec
jpayne@68: doesn't support displaying intermediate progress information: sending
jpayne@68: .B SIGINFO
jpayne@68: to
jpayne@68: .B xzdec
jpayne@68: does nothing, but sending
jpayne@68: .B SIGUSR1
jpayne@68: terminates the process instead of displaying progress information.
jpayne@68: .SH OPTIONS
jpayne@68: .TP
jpayne@68: .BR \-d ", " \-\-decompress ", " \-\-uncompress
jpayne@68: Ignored for
jpayne@68: .BR xz (1)
jpayne@68: compatibility.
jpayne@68: .B xzdec
jpayne@68: supports only decompression.
jpayne@68: .TP
jpayne@68: .BR \-k ", " \-\-keep
jpayne@68: Ignored for
jpayne@68: .BR xz (1)
jpayne@68: compatibility.
jpayne@68: .B xzdec
jpayne@68: never creates or removes any files.
jpayne@68: .TP
jpayne@68: .BR \-c ", " \-\-stdout ", " \-\-to-stdout
jpayne@68: Ignored for
jpayne@68: .BR xz (1)
jpayne@68: compatibility.
jpayne@68: .B xzdec
jpayne@68: always writes the decompressed data to standard output.
jpayne@68: .TP
jpayne@68: .BR \-q ", " \-\-quiet
jpayne@68: Specifying this once does nothing since
jpayne@68: .B xzdec
jpayne@68: never displays any warnings or notices.
jpayne@68: Specify this twice to suppress errors.
jpayne@68: .TP
jpayne@68: .BR \-Q ", " \-\-no-warn
jpayne@68: Ignored for
jpayne@68: .BR xz (1)
jpayne@68: compatibility.
jpayne@68: .B xzdec
jpayne@68: never uses the exit status 2.
jpayne@68: .TP
jpayne@68: .BR \-h ", " \-\-help
jpayne@68: Display a help message and exit successfully.
jpayne@68: .TP
jpayne@68: .BR \-V ", " \-\-version
jpayne@68: Display the version number of
jpayne@68: .B xzdec
jpayne@68: and liblzma.
jpayne@68: .SH "EXIT STATUS"
jpayne@68: .TP
jpayne@68: .B 0
jpayne@68: All was good.
jpayne@68: .TP
jpayne@68: .B 1
jpayne@68: An error occurred.
jpayne@68: .PP
jpayne@68: .B xzdec
jpayne@68: doesn't have any warning messages like
jpayne@68: .BR xz (1)
jpayne@68: has, thus the exit status 2 is not used by
jpayne@68: .BR xzdec .
jpayne@68: .SH NOTES
jpayne@68: Use
jpayne@68: .BR xz (1)
jpayne@68: instead of
jpayne@68: .B xzdec
jpayne@68: or
jpayne@68: .B lzmadec
jpayne@68: for normal everyday use.
jpayne@68: .B xzdec
jpayne@68: or
jpayne@68: .B lzmadec
jpayne@68: are meant only for situations where it is important to have
jpayne@68: a smaller decompressor than the full-featured
jpayne@68: .BR xz (1).
jpayne@68: .PP
jpayne@68: .B xzdec
jpayne@68: and
jpayne@68: .B lzmadec
jpayne@68: are not really that small.
jpayne@68: The size can be reduced further by dropping
jpayne@68: features from liblzma at compile time,
jpayne@68: but that shouldn't usually be done for executables distributed
jpayne@68: in typical non-embedded operating system distributions.
jpayne@68: If you need a truly small
jpayne@68: .B .xz
jpayne@68: decompressor, consider using XZ Embedded.
jpayne@68: .SH "SEE ALSO"
jpayne@68: .BR xz (1)
jpayne@68: .PP
jpayne@68: XZ Embedded: <https://tukaani.org/xz/embedded.html>