src/xzdec/xzdec.1

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