src/xzdec/xzdec.1

   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 "2009-06-04" "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 has been written to use
  29 .B "xz \-\-decompress \-\-stdout"
  30 (and possibly a few other commonly used options) to decompress
  31 .B .xz
  32 files.
  33 .B lzmadec
  34 is identical to
  35 .B xzdec
  36 except that
  37 .B lzmadec
  38 supports
  39 .B .lzma
  40 files instead of
  41 .B .xz
  42 files.
  43 .PP
  44 To reduce the size of the executable,
  45 .B xzdec
  46 doesn't support multithreading or localization, and doesn't read options from
  47 .B XZ_OPT
  48 environment variable.
  49 .B xzdec
  50 doesn't support displaying intermediate progress information: sending
  51 .B SIGINFO
  52 to
  53 .B xzdec
  54 does nothing, but sending
  55 .B SIGUSR1
  56 terminates the process instead of displaying progress information.
  57 .SH OPTIONS
  58 .TP
  59 .BR \-d ", " \-\-decompress ", " \-\-uncompress
  60 Ignored for
  61 .BR xz (1)
  62 compatibility.
  63 .B xzdec
  64 supports only decompression.
  65 .TP
  66 .BR \-k ", " \-\-keep
  67 Ignored for
  68 .BR xz (1)
  69 compatibility.
  70 .B xzdec
  71 never creates or removes any files.
  72 .TP
  73 .BR \-f ", " \-\-force
  74 Ignored for
  75 .BR xz (1)
  76 compatibility.
  77 .TP
  78 .BR \-c ", " \-\-stdout ", " \-\-to-stdout
  79 Ignored for
  80 .BR xz (1)
  81 compatibility.
  82 .B xzdec
  83 always writes the decompressed data to standard output.
  84 .TP
  85 \fB\-M\fR \fIlimit\fR, \fB\-\-memory=\fIlimit
  86 Set the memory usage
  87 .IR limit .
  88 If this option is specified multiple times, the last one takes effect. The
  89 .I limit
  90 can be specified in multiple ways:
  91 .RS
  92 .IP \(bu 3
  93 The
  94 .I limit
  95 can be an absolute value in bytes. Using an integer suffix like
  96 .B MiB
  97 can be useful. Example:
  98 .B "\-\-memory=80MiB"
  99 .IP \(bu 3
 100 The
 101 .I limit
 102 can be specified as a percentage of physical RAM. Example:
 103 .B "\-\-memory=70%"
 104 .IP \(bu 3
 105 The
 106 .I limit
 107 can be reset back to its default value (currently 40 % of physical RAM)
 108 by setting it to
 109 .BR 0 .
 110 .IP \(bu 3
 111 The memory usage limiting can be effectively disabled by setting
 112 .I limit
 113 to
 114 .BR max .
 115 This isn't recommended. It's usually better to use, for example,
 116 .BR \-\-memory=90% .
 117 .RE
 118 .IP
 119 The current
 120 .I limit
 121 can be seen near the bottom of the output of the
 122 .B \-\-help
 123 option.
 124 .TP
 125 .BR \-q ", " \-\-quiet
 126 Specifying this once does nothing since
 127 .B xzdec
 128 never displays any warnings or notices.
 129 Specify this twice to suppress errors.
 130 .TP
 131 .BR \-Q ", " \-\-no-warn
 132 Ignored for
 133 .BR xz (1)
 134 compatibility.
 135 .B xzdec
 136 never uses the exit status
 137 .BR "2" .
 138 .TP
 139 .BR \-h ", " \-\-help
 140 Display a help message and exit successfully.
 141 .TP
 142 .BR \-V ", " \-\-version
 143 Display the version number of
 144 .B xzdec
 145 and liblzma.
 146 .SH "EXIT STATUS"
 147 .TP
 148 .B 0
 149 All was good.
 150 .TP
 151 .B 1
 152 An error occurred.
 153 .PP
 154 .B xzdec
 155 doesn't have any warning messages like
 156 .BR xz (1)
 157 has, thus the exit status
 158 .B 2
 159 is not used by
 160 .BR xzdec .
 161 .SH NOTES
 162 .B xzdec
 163 and
 164 .B lzmadec
 165 are not really that small. The size can be reduced further by dropping
 166 features from liblzma at compile time, but that shouldn't usually be done
 167 for executables distributed in typical non-embedded operating system
 168 distributions. If you need a truly small
 169 .B .xz
 170 decompressor, consider using XZ Embedded.
 171 .\" TODO: Provide URL to XZ Embedded.
 172 .SH "SEE ALSO"
 173 .BR xz (1)