src/lzmainfo/lzmainfo.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 LZMAINFO 1 "2010-09-27" "Tukaani" "XZ Utils"
   8 .SH NAME
   9 lzmainfo \- show information stored in the .lzma file header
  10 .SH SYNOPSIS
  11 .B lzmainfo
  12 .RB [ \-\-help ]
  13 .RB [ \-\-version ]
  14 .RI [ file ]...
  15 .SH DESCRIPTION
  16 .B lzmainfo
  17 shows information stored in the
  18 .B .lzma
  19 file header.
  20 It reads the first 13 bytes from the specified
  21 .IR file ,
  22 decodes the header, and prints it to standard output in human
  23 readable format.
  24 If no
  25 .I files
  26 are given or
  27 .I file
  28 is
  29 .BR \- ,
  30 standard input is read.
  31 .PP
  32 Usually the most interesting information is
  33 the uncompressed size and the dictionary size.
  34 Uncompressed size can be shown only if
  35 the file is in the non-streamed
  36 .B .lzma
  37 format variant.
  38 The amount of memory required to decompress the file is
  39 a few dozen kilobytes plus the dictionary size.
  40 .PP
  41 .B lzmainfo
  42 is included in XZ Utils primarily for
  43 backward compatibility with LZMA Utils.
  44 .SH "EXIT STATUS"
  45 .TP
  46 .B 0
  47 All is good.
  48 .TP
  49 .B 1
  50 An error occurred.
  51 .SH BUGS
  52 .B lzmainfo
  53 uses
  54 .B MB
  55 while the correct suffix would be
  56 .B MiB
  57 (2^20 bytes).
  58 This is to keep the output compatible with LZMA Utils.
  59 .SH "SEE ALSO"
  60 .BR xz (1)