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 "2010-08-07" "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_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
  94 .BR "2" .
  95 .TP
  96 .BR \-h ", " \-\-help
  97 Display a help message and exit successfully.
  98 .TP
  99 .BR \-V ", " \-\-version
 100 Display the version number of
 101 .B xzdec
 102 and liblzma.
 103 .SH "EXIT STATUS"
 104 .TP
 105 .B 0
 106 All was good.
 107 .TP
 108 .B 1
 109 An error occurred.
 110 .PP
 111 .B xzdec
 112 doesn't have any warning messages like
 113 .BR xz (1)
 114 has, thus the exit status
 115 .B 2
 116 is not used by
 117 .BR xzdec .
 118 .SH NOTES
 119 .B xzdec
 120 and
 121 .B lzmadec
 122 are not really that small. The size can be reduced further by dropping
 123 features from liblzma at compile time, but that shouldn't usually be done
 124 for executables distributed in typical non-embedded operating system
 125 distributions. If you need a truly small
 126 .B .xz
 127 decompressor, consider using XZ Embedded.
 128 .SH "SEE ALSO"
 129 .BR xz (1)
 130 .PP
 131 XZ Embedded: <http://tukaani.org/xz/embedded.html>