@database XZDEC
@master "XZDEC.1"
@remark "manual page source format generated by PolyglotMan v3.2 available at http://polyglotman.sourceforge.net/"
@wordwrap
@tab 8

@node sect0 "Name"
xzdec, lzmadec - Small .xz and .lzma decompressors 
@endnode

@node sect1 "Synopsis"
@{b}xzdec@{ub} [@{i}option@{ui}]...@{i}@{ui} [@{i}file@{ui}]...@{i}@{ui} 
@{b}lzmadec@{ub} [@{i}option@{ui}]...@{i}@{ui} [@{i}file@{ui}]...@{i}@{ui} 
@endnode

@node sect2 "Description"
@{b}xzdec@{ub} is a liblzma-based decompression-only tool for @{b}.xz@{ub} (and only @{b}.xz@{ub}) files. @{b}xzdec@{ub} is intended to work as a drop-in replacement for @{"@{b}xz@{ub}(1)" link %s.%sxz1/main} in the most common situations where a script has been written to use @{b}xz --decompress --stdout@{ub} (and possibly a few other commonly used options) to decompress @{b}.xz@{ub} files. @{b}lzmadec@{ub} is identical to @{b}xzdec@{ub} except that @{b}lzmadec@{ub} supports @{b}.lzma@{ub} files instead of @{b}.xz@{ub} files. To reduce the size of the executable, @{b}xzdec@{ub} doesn't support multithreading or localization, and doesn't read options from @{b}XZ_DEFAULTS@{ub} and @{b}XZ_OPT@{ub} environment variables. @{b}xzdec@{ub} doesn't support displaying intermediate progress information: sending @{b}SIGINFO@{ub} to @{b}xzdec@{ub} does nothing, but sending @{b}SIGUSR1@{ub} terminates the process instead of displaying progress information. 


@endnode

@node sect3 "Options"


· @{b}-d@{ub}, @{b}--decompress@{ub}, @{b}--uncompress@{ub} @{lindent 3}
Ignored for @{"@{b}xz@{ub}(1)" link %s.%sxz1/main} compatibility. @{b}xzdec@{ub} supports only decompression. @{lindent 0}

· @{b}-k@{ub}, @{b}--keep@{ub} @{lindent 3}
Ignored for @{"@{b}xz@{ub}(1)" link %s.%sxz1/main} compatibility. @{b}xzdec@{ub} never creates or removes any files. @{lindent 0}

· @{b}-c@{ub}, @{b}--stdout@{ub}, @{b}--to-stdout@{ub} @{lindent 3}
Ignored for @{"@{b}xz@{ub}(1)" link %s.%sxz1/main} compatibility. @{b}xzdec@{ub} always writes the decompressed data to standard output. @{lindent 0}

· @{b}-q@{ub}, @{b}--quiet@{ub} @{lindent 3}
Specifying this once does nothing since @{b}xzdec@{ub} never displays any warnings or notices. Specify this twice to suppress errors. @{lindent 0}

· @{b}-Q@{ub}, @{b}--no-warn@{ub} @{lindent 3}
Ignored for @{"@{b}xz@{ub}(1)" link %s.%sxz1/main} compatibility. @{b}xzdec@{ub} never uses the exit status 2. @{lindent 0}

· @{b}-h@{ub}, @{b}--help@{ub} @{lindent 3}
Display a help message and exit successfully. @{lindent 0}

· @{b}-V@{ub}, @{b}--version@{ub} @{lindent 3}
Display the version number of @{b}xzdec@{ub} and liblzma. @{lindent 0}


@endnode

@node sect4 "Exit Status"


· @{b}0@{ub} @{lindent 3}
All was good. @{lindent 0}

· @{b}1@{ub} @{lindent 3}
An error occurred. @{lindent 0}

@{b}xzdec@{ub} doesn't have any warning messages like @{"@{b}xz@{ub}(1)" link %s.%sxz1/main} has, thus the exit status 2 is not used by @{b}xzdec@{ub}. 


@endnode

@node sect5 "Notes"
Use @{"@{b}xz@{ub}(1)" link %s.%sxz1/main} instead of @{b}xzdec@{ub} or @{b}lzmadec@{ub} for normal everyday use. @{b}xzdec@{ub} or @{b}lzmadec@{ub} are meant only for situations where it is important to have a smaller decompressor than the full-featured @{"@{b}xz@{ub}(1)" link %s.%sxz1/main}. @{b}xzdec@{ub} and @{b}lzmadec@{ub} are not really that small. The size can be reduced further by dropping features from liblzma at compile time, but that shouldn't usually be done for executables distributed in typical non-embedded operating system distributions. If you need a truly small @{b}.xz@{ub} decompressor, consider using XZ Embedded. 


@endnode

@node sect6 "See Also"
@{"@{b}xz@{ub}(1)" link %s.%sxz1/main} XZ Embedded: <http://tukaani.org/xz/embedded.html> 


@endnode
@node main "XZDEC(1)"
@next sect0
@{b}Table of Contents@{ub}

@{"Name" link sect0}
@{"Synopsis" link sect1}
@{"Description" link sect2}
@{"Options" link sect3}
@{"Exit Status" link sect4}
@{"Notes" link sect5}
@{"See Also" link sect6}

@endnode
