OLD | NEW |
(Empty) | |
| 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-03-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_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 \-c ", " \-\-stdout ", " \-\-to-stdout |
| 74 Ignored for |
| 75 .BR xz (1) |
| 76 compatibility. |
| 77 .B xzdec |
| 78 always writes the decompressed data to standard output. |
| 79 .TP |
| 80 \fB\-M\fR \fIlimit\fR, \fB\-\-memory=\fIlimit |
| 81 Set the memory usage |
| 82 .IR limit . |
| 83 If this option is specified multiple times, the last one takes effect. The |
| 84 .I limit |
| 85 can be specified in multiple ways: |
| 86 .RS |
| 87 .IP \(bu 3 |
| 88 The |
| 89 .I limit |
| 90 can be an absolute value in bytes. Using an integer suffix like |
| 91 .B MiB |
| 92 can be useful. Example: |
| 93 .B "\-\-memory=80MiB" |
| 94 .IP \(bu 3 |
| 95 The |
| 96 .I limit |
| 97 can be specified as a percentage of physical RAM. Example: |
| 98 .B "\-\-memory=70%" |
| 99 .IP \(bu 3 |
| 100 The |
| 101 .I limit |
| 102 can be reset back to its default value by setting it to |
| 103 .BR 0 . |
| 104 .IP \(bu 3 |
| 105 The memory usage limiting can be effectively disabled by setting |
| 106 .I limit |
| 107 to |
| 108 .BR max . |
| 109 This isn't recommended. It's usually better to use, for example, |
| 110 .BR \-\-memory=90% . |
| 111 .RE |
| 112 .IP |
| 113 The current |
| 114 .I limit |
| 115 can be seen near the bottom of the output of the |
| 116 .B \-\-help |
| 117 option. |
| 118 .TP |
| 119 .BR \-q ", " \-\-quiet |
| 120 Specifying this once does nothing since |
| 121 .B xzdec |
| 122 never displays any warnings or notices. |
| 123 Specify this twice to suppress errors. |
| 124 .TP |
| 125 .BR \-Q ", " \-\-no-warn |
| 126 Ignored for |
| 127 .BR xz (1) |
| 128 compatibility. |
| 129 .B xzdec |
| 130 never uses the exit status |
| 131 .BR "2" . |
| 132 .TP |
| 133 .BR \-h ", " \-\-help |
| 134 Display a help message and exit successfully. |
| 135 .TP |
| 136 .BR \-V ", " \-\-version |
| 137 Display the version number of |
| 138 .B xzdec |
| 139 and liblzma. |
| 140 .SH "EXIT STATUS" |
| 141 .TP |
| 142 .B 0 |
| 143 All was good. |
| 144 .TP |
| 145 .B 1 |
| 146 An error occurred. |
| 147 .PP |
| 148 .B xzdec |
| 149 doesn't have any warning messages like |
| 150 .BR xz (1) |
| 151 has, thus the exit status |
| 152 .B 2 |
| 153 is not used by |
| 154 .BR xzdec . |
| 155 .SH NOTES |
| 156 .B xzdec |
| 157 and |
| 158 .B lzmadec |
| 159 are not really that small. The size can be reduced further by dropping |
| 160 features from liblzma at compile time, but that shouldn't usually be done |
| 161 for executables distributed in typical non-embedded operating system |
| 162 distributions. If you need a truly small |
| 163 .B .xz |
| 164 decompressor, consider using XZ Embedded. |
| 165 .SH "SEE ALSO" |
| 166 .BR xz (1) |
| 167 .PP |
| 168 XZ Embedded: <http://tukaani.org/xz/embedded.html> |
OLD | NEW |