aboutsummaryrefslogtreecommitdiff
path: root/src/lzmainfo/lzmainfo.1
diff options
context:
space:
mode:
authorLasse Collin <lasse.collin@tukaani.org>2009-08-13 12:55:45 +0300
committerLasse Collin <lasse.collin@tukaani.org>2009-08-13 12:55:45 +0300
commite51b4e49e800bd84e6d589dca2964d3985e88139 (patch)
treeb1aa08694cb4b00a220ca35d5ce62ec7f7b8792e /src/lzmainfo/lzmainfo.1
parentSync some error messages from xz to xzdec. (diff)
downloadxz-e51b4e49e800bd84e6d589dca2964d3985e88139.tar.xz
Add lzmainfo for backward compatibility with LZMA Utils.
lzmainfo now links against static liblzma. In contrast to other command line tools in XZ Utils, linking lzmainfo against static liblzma by default is dumb. This will be fixed once I have fixed some related issues in configure.ac.
Diffstat (limited to 'src/lzmainfo/lzmainfo.1')
-rw-r--r--src/lzmainfo/lzmainfo.155
1 files changed, 55 insertions, 0 deletions
diff --git a/src/lzmainfo/lzmainfo.1 b/src/lzmainfo/lzmainfo.1
new file mode 100644
index 00000000..ef736a6c
--- /dev/null
+++ b/src/lzmainfo/lzmainfo.1
@@ -0,0 +1,55 @@
+.\"
+.\" Author: Lasse Collin
+.\"
+.\" This file has been put into the public domain.
+.\" You can do whatever you want with this file.
+.\"
+.TH LZMAINFO 1 "2009-08-13" "Tukaani" "XZ Utils"
+.SH NAME
+lzmainfo \- show infomation stored in the .lzma file header
+.SH SYNOPSIS
+.B lzmainfo
+.RB [ \-\-help ]
+.RB [ \-\-version ]
+.RI [ file ]...
+.SH DESCRIPTION
+.B lzmainfo
+shows information stored in the
+.B .lzma
+file header. It reads the first 13 bytes from the specified
+.IR file ,
+decodes the header, and prints it to standard output in human
+readable format. If no
+.I files
+are given or
+.I file
+is
+.BR \- ,
+standard input is read.
+.PP
+Usually the most interesting information is the uncompressed size and
+the dictionary size. Uncompressed size can be shown only if the file is
+in the non-streamed
+.B .lzma
+format variant. The amount of memory required to decompress the file is
+a few dozen kilobytes plus the dictionary size.
+.PP
+.B lzmainfo
+is included in XZ Utils primarily for backward compatibility with LZMA Utils.
+.SH EXIT STATUS
+.TP
+.B 0
+All is good.
+.TP
+.B 1
+An error occurred.
+.SH BUGS
+.B lzmainfo
+uses
+.B MB
+while the correct suffix would be
+.B MiB
+(2^20 bytes).
+This is to keep the output compatible with LZMA Utils.
+.SH SEE ALSO
+.BR xz (1)