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