aboutsummaryrefslogtreecommitdiff
path: root/src/lzmainfo/lzmainfo.1
diff options
context:
space:
mode:
authorLasse Collin <lasse.collin@tukaani.org>2010-09-27 23:29:34 +0300
committerLasse Collin <lasse.collin@tukaani.org>2010-09-27 23:29:34 +0300
commitcec0ddc8ec4ce81685a51998b978e22167e461f9 (patch)
treeec8d24147a46b901f215ab3bed6cac17fa0108bc /src/lzmainfo/lzmainfo.1
parentFix the preset -3e. (diff)
downloadxz-cec0ddc8ec4ce81685a51998b978e22167e461f9.tar.xz
Major man page updates.
Lots of content was updated on the xz man page. Technical improvements: - Start a new sentence on a new line. - Use fairly short lines. - Use constant-width font for examples (where supported). - Some minor cleanups. Thanks to Jonathan Nieder for some language fixes.
Diffstat (limited to 'src/lzmainfo/lzmainfo.1')
-rw-r--r--src/lzmainfo/lzmainfo.125
1 files changed, 15 insertions, 10 deletions
diff --git a/src/lzmainfo/lzmainfo.1 b/src/lzmainfo/lzmainfo.1
index 235a6b5e..f2b93b4c 100644
--- a/src/lzmainfo/lzmainfo.1
+++ b/src/lzmainfo/lzmainfo.1
@@ -4,7 +4,7 @@
.\" This file has been put into the public domain.
.\" You can do whatever you want with this file.
.\"
-.TH LZMAINFO 1 "2010-07-28" "Tukaani" "XZ Utils"
+.TH LZMAINFO 1 "2010-09-27" "Tukaani" "XZ Utils"
.SH NAME
lzmainfo \- show information stored in the .lzma file header
.SH SYNOPSIS
@@ -16,10 +16,12 @@ lzmainfo \- show information stored in the .lzma file header
.B lzmainfo
shows information stored in the
.B .lzma
-file header. It reads the first 13 bytes from the specified
+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
+readable format.
+If no
.I files
are given or
.I file
@@ -27,16 +29,19 @@ 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
+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
+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
+is included in XZ Utils primarily for
+backward compatibility with LZMA Utils.
+.SH "EXIT STATUS"
.TP
.B 0
All is good.
@@ -51,5 +56,5 @@ while the correct suffix would be
.B MiB
(2^20 bytes).
This is to keep the output compatible with LZMA Utils.
-.SH SEE ALSO
+.SH "SEE ALSO"
.BR xz (1)