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.
This commit is contained in:
Lasse Collin
parent
075257ab04
commit
cec0ddc8ec
|
|
@ -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)
|
||||
|
|
|
|||
|
|
@ -6,7 +6,7 @@
|
|||
.\"
|
||||
.\" License: GNU GPLv2+
|
||||
.\"
|
||||
.TH XZDIFF 1 "2009-07-05" "Tukaani" "XZ Utils"
|
||||
.TH XZDIFF 1 "2010-09-27" "Tukaani" "XZ Utils"
|
||||
.SH NAME
|
||||
xzcmp, xzdiff, lzcmp, lzdiff \- compare compressed files
|
||||
.SH SYNOPSIS
|
||||
|
|
@ -22,7 +22,7 @@ xzcmp, xzdiff, lzcmp, lzdiff \- compare compressed files
|
|||
.B lzdiff
|
||||
.RI [ diff_options "] " file1 " [" file2 ]
|
||||
.SH DESCRIPTION
|
||||
.B xzcmp
|
||||
.B xzcmp
|
||||
and
|
||||
.B xzdiff
|
||||
invoke
|
||||
|
|
@ -36,22 +36,23 @@ on files compressed with
|
|||
or
|
||||
.BR bzip2 (1).
|
||||
All options specified are passed directly to
|
||||
.B cmp
|
||||
.BR cmp (1)
|
||||
or
|
||||
.BR diff .
|
||||
.BR diff (1).
|
||||
If only one file is specified, then the files compared are
|
||||
.I file1
|
||||
(which must have a suffix of a supported compression format) and
|
||||
.I file1
|
||||
from which the compression format suffix has been stripped.
|
||||
If two files are specified, then they are uncompressed if necessary and fed to
|
||||
If two files are specified,
|
||||
then they are uncompressed if necessary and fed to
|
||||
.BR cmp (1)
|
||||
or
|
||||
.BR diff (1).
|
||||
The exit status from
|
||||
.B cmp
|
||||
.BR cmp (1)
|
||||
or
|
||||
.B diff
|
||||
.BR diff (1)
|
||||
is preserved.
|
||||
.PP
|
||||
The names
|
||||
|
|
|
|||
|
|
@ -6,15 +6,15 @@
|
|||
.\"
|
||||
.\" License: GNU GPLv2+
|
||||
.\"
|
||||
.TH XZGREP 1 "2009-07-05" "Tukaani" "XZ Utils"
|
||||
.TH XZGREP 1 "2010-09-27" "Tukaani" "XZ Utils"
|
||||
.SH NAME
|
||||
xzgrep \- search compressed files for a regular expression
|
||||
.SH SYNOPSIS
|
||||
.B xzgrep
|
||||
.RI [ grep_options ]
|
||||
.RB [ \-e ]
|
||||
.RB [ \-e ]
|
||||
.I pattern
|
||||
.IR file ".\|.\|."
|
||||
.IR file "..."
|
||||
.br
|
||||
.B xzegrep
|
||||
.RB ...
|
||||
|
|
@ -31,7 +31,7 @@ xzgrep \- search compressed files for a regular expression
|
|||
.B lzfgrep
|
||||
.RB ...
|
||||
.SH DESCRIPTION
|
||||
.B xzgrep
|
||||
.B xzgrep
|
||||
invokes
|
||||
.BR grep (1)
|
||||
on
|
||||
|
|
@ -47,7 +47,8 @@ All options specified are passed directly to
|
|||
.PP
|
||||
If no
|
||||
.I file
|
||||
is specified, then the standard input is decompressed if necessary and fed to
|
||||
is specified, then standard input is decompressed if necessary
|
||||
and fed to
|
||||
.BR grep (1).
|
||||
When reading from standard input,
|
||||
.BR gzip (1)
|
||||
|
|
|
|||
|
|
@ -7,7 +7,7 @@
|
|||
.\"
|
||||
.\" (Note that this file is not based on gzip's zless.1.)
|
||||
.\"
|
||||
.TH XZLESS 1 "2009-07-05" "Tukaani" "XZ Utils"
|
||||
.TH XZLESS 1 "2010-09-27" "Tukaani" "XZ Utils"
|
||||
.SH NAME
|
||||
xzless, lzless \- view xz or lzma compressed (text) files
|
||||
.SH SYNOPSIS
|
||||
|
|
@ -17,7 +17,7 @@ xzless, lzless \- view xz or lzma compressed (text) files
|
|||
.B lzless
|
||||
.RI [ file ...]
|
||||
.SH DESCRIPTION
|
||||
.B xzless
|
||||
.B xzless
|
||||
is a filter that displays text from compressed files to a terminal.
|
||||
It works on files compressed with
|
||||
.BR xz (1)
|
||||
|
|
@ -32,9 +32,11 @@ reads from standard input.
|
|||
.B xzless
|
||||
uses
|
||||
.BR less (1)
|
||||
to present its output. Unlike
|
||||
to present its output.
|
||||
Unlike
|
||||
.BR xzmore ,
|
||||
its choice of pager cannot be altered by setting an environment variable.
|
||||
its choice of pager cannot be altered by
|
||||
setting an environment variable.
|
||||
Commands are based on both
|
||||
.BR more (1)
|
||||
and
|
||||
|
|
@ -50,7 +52,8 @@ is provided for backward compatibility with LZMA Utils.
|
|||
.SH ENVIRONMENT
|
||||
.TP
|
||||
.B LESSMETACHARS
|
||||
A list of characters special to the shell. Set by
|
||||
A list of characters special to the shell.
|
||||
Set by
|
||||
.B xzless
|
||||
unless it is already set in the environment.
|
||||
.TP
|
||||
|
|
|
|||
|
|
@ -4,22 +4,23 @@
|
|||
.\"
|
||||
.\" License: GNU GPLv2+
|
||||
.\"
|
||||
.TH XZMORE 1 "2009-07-05" "Tukaani" "XZ Utils"
|
||||
.TH XZMORE 1 "2010-09-27" "Tukaani" "XZ Utils"
|
||||
.SH NAME
|
||||
xzmore, lzmore \- view xz or lzma compressed (text) files
|
||||
.SH SYNOPSIS
|
||||
.B xzmore
|
||||
.RI [ "filename ..." ]
|
||||
.RI [ "filename ..." ]
|
||||
.br
|
||||
.B lzmore
|
||||
.RI [ "filename ..." ]
|
||||
.RI [ "filename ..." ]
|
||||
.SH DESCRIPTION
|
||||
.B xzmore
|
||||
is a filter which allows examination of
|
||||
.BR xz (1)
|
||||
or
|
||||
.BR lzma (1)
|
||||
compressed text files one screenful at a time on a soft-copy terminal.
|
||||
compressed text files one screenful at a time
|
||||
on a soft-copy terminal.
|
||||
.PP
|
||||
To use a pager other than the default
|
||||
.B more,
|
||||
|
|
|
|||
1966
src/xz/xz.1
1966
src/xz/xz.1
File diff suppressed because it is too large
Load Diff
|
|
@ -4,7 +4,7 @@
|
|||
.\" This file has been put into the public domain.
|
||||
.\" You can do whatever you want with this file.
|
||||
.\"
|
||||
.TH XZDEC 1 "2010-08-07" "Tukaani" "XZ Utils"
|
||||
.TH XZDEC 1 "2010-09-27" "Tukaani" "XZ Utils"
|
||||
.SH NAME
|
||||
xzdec, lzmadec \- Small .xz and .lzma decompressors
|
||||
.SH SYNOPSIS
|
||||
|
|
@ -25,7 +25,8 @@ files.
|
|||
.B xzdec
|
||||
is intended to work as a drop-in replacement for
|
||||
.BR xz (1)
|
||||
in the most common situations where a script has been written to use
|
||||
in the most common situations where a script
|
||||
has been written to use
|
||||
.B "xz \-\-decompress \-\-stdout"
|
||||
(and possibly a few other commonly used options) to decompress
|
||||
.B .xz
|
||||
|
|
@ -43,7 +44,8 @@ files.
|
|||
.PP
|
||||
To reduce the size of the executable,
|
||||
.B xzdec
|
||||
doesn't support multithreading or localization, and doesn't read options from
|
||||
doesn't support multithreading or localization,
|
||||
and doesn't read options from
|
||||
.B XZ_DEFAULTS
|
||||
and
|
||||
.B XZ_OPT
|
||||
|
|
@ -90,8 +92,7 @@ Ignored for
|
|||
.BR xz (1)
|
||||
compatibility.
|
||||
.B xzdec
|
||||
never uses the exit status
|
||||
.BR "2" .
|
||||
never uses the exit status 2.
|
||||
.TP
|
||||
.BR \-h ", " \-\-help
|
||||
Display a help message and exit successfully.
|
||||
|
|
@ -111,18 +112,32 @@ An error occurred.
|
|||
.B xzdec
|
||||
doesn't have any warning messages like
|
||||
.BR xz (1)
|
||||
has, thus the exit status
|
||||
.B 2
|
||||
is not used by
|
||||
has, thus the exit status 2 is not used by
|
||||
.BR xzdec .
|
||||
.SH NOTES
|
||||
Use
|
||||
.BR xz (1)
|
||||
instead of
|
||||
.B xzdec
|
||||
or
|
||||
.B lzmadec
|
||||
for normal everyday use.
|
||||
.B xzdec
|
||||
or
|
||||
.B lzmadec
|
||||
are meant only for situations where it is important to have
|
||||
a smaller decompressor than the full-featured
|
||||
.BR xz (1).
|
||||
.PP
|
||||
.B xzdec
|
||||
and
|
||||
.B lzmadec
|
||||
are not really that small. The size can be reduced further by dropping
|
||||
features from liblzma at compile time, but that shouldn't usually be done
|
||||
for executables distributed in typical non-embedded operating system
|
||||
distributions. If you need a truly small
|
||||
are not really that small.
|
||||
The size can be reduced further by dropping
|
||||
features from liblzma at compile time,
|
||||
but that shouldn't usually be done for executables distributed
|
||||
in typical non-embedded operating system distributions.
|
||||
If you need a truly small
|
||||
.B .xz
|
||||
decompressor, consider using XZ Embedded.
|
||||
.SH "SEE ALSO"
|
||||
|
|
|
|||
Loading…
Reference in New Issue