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:
parent
075257ab04
commit
cec0ddc8ec
|
@ -4,7 +4,7 @@
|
||||||
.\" This file has been put into the public domain.
|
.\" This file has been put into the public domain.
|
||||||
.\" You can do whatever you want with this file.
|
.\" 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
|
.SH NAME
|
||||||
lzmainfo \- show information stored in the .lzma file header
|
lzmainfo \- show information stored in the .lzma file header
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
|
@ -16,10 +16,12 @@ lzmainfo \- show information stored in the .lzma file header
|
||||||
.B lzmainfo
|
.B lzmainfo
|
||||||
shows information stored in the
|
shows information stored in the
|
||||||
.B .lzma
|
.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 ,
|
.IR file ,
|
||||||
decodes the header, and prints it to standard output in human
|
decodes the header, and prints it to standard output in human
|
||||||
readable format. If no
|
readable format.
|
||||||
|
If no
|
||||||
.I files
|
.I files
|
||||||
are given or
|
are given or
|
||||||
.I file
|
.I file
|
||||||
|
@ -27,16 +29,19 @@ is
|
||||||
.BR \- ,
|
.BR \- ,
|
||||||
standard input is read.
|
standard input is read.
|
||||||
.PP
|
.PP
|
||||||
Usually the most interesting information is the uncompressed size and
|
Usually the most interesting information is
|
||||||
the dictionary size. Uncompressed size can be shown only if the file is
|
the uncompressed size and the dictionary size.
|
||||||
in the non-streamed
|
Uncompressed size can be shown only if
|
||||||
|
the file is in the non-streamed
|
||||||
.B .lzma
|
.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.
|
a few dozen kilobytes plus the dictionary size.
|
||||||
.PP
|
.PP
|
||||||
.B lzmainfo
|
.B lzmainfo
|
||||||
is included in XZ Utils primarily for backward compatibility with LZMA Utils.
|
is included in XZ Utils primarily for
|
||||||
.SH EXIT STATUS
|
backward compatibility with LZMA Utils.
|
||||||
|
.SH "EXIT STATUS"
|
||||||
.TP
|
.TP
|
||||||
.B 0
|
.B 0
|
||||||
All is good.
|
All is good.
|
||||||
|
@ -51,5 +56,5 @@ while the correct suffix would be
|
||||||
.B MiB
|
.B MiB
|
||||||
(2^20 bytes).
|
(2^20 bytes).
|
||||||
This is to keep the output compatible with LZMA Utils.
|
This is to keep the output compatible with LZMA Utils.
|
||||||
.SH SEE ALSO
|
.SH "SEE ALSO"
|
||||||
.BR xz (1)
|
.BR xz (1)
|
||||||
|
|
|
@ -6,7 +6,7 @@
|
||||||
.\"
|
.\"
|
||||||
.\" License: GNU GPLv2+
|
.\" License: GNU GPLv2+
|
||||||
.\"
|
.\"
|
||||||
.TH XZDIFF 1 "2009-07-05" "Tukaani" "XZ Utils"
|
.TH XZDIFF 1 "2010-09-27" "Tukaani" "XZ Utils"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
xzcmp, xzdiff, lzcmp, lzdiff \- compare compressed files
|
xzcmp, xzdiff, lzcmp, lzdiff \- compare compressed files
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
|
@ -36,22 +36,23 @@ on files compressed with
|
||||||
or
|
or
|
||||||
.BR bzip2 (1).
|
.BR bzip2 (1).
|
||||||
All options specified are passed directly to
|
All options specified are passed directly to
|
||||||
.B cmp
|
.BR cmp (1)
|
||||||
or
|
or
|
||||||
.BR diff .
|
.BR diff (1).
|
||||||
If only one file is specified, then the files compared are
|
If only one file is specified, then the files compared are
|
||||||
.I file1
|
.I file1
|
||||||
(which must have a suffix of a supported compression format) and
|
(which must have a suffix of a supported compression format) and
|
||||||
.I file1
|
.I file1
|
||||||
from which the compression format suffix has been stripped.
|
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)
|
.BR cmp (1)
|
||||||
or
|
or
|
||||||
.BR diff (1).
|
.BR diff (1).
|
||||||
The exit status from
|
The exit status from
|
||||||
.B cmp
|
.BR cmp (1)
|
||||||
or
|
or
|
||||||
.B diff
|
.BR diff (1)
|
||||||
is preserved.
|
is preserved.
|
||||||
.PP
|
.PP
|
||||||
The names
|
The names
|
||||||
|
|
|
@ -6,7 +6,7 @@
|
||||||
.\"
|
.\"
|
||||||
.\" License: GNU GPLv2+
|
.\" License: GNU GPLv2+
|
||||||
.\"
|
.\"
|
||||||
.TH XZGREP 1 "2009-07-05" "Tukaani" "XZ Utils"
|
.TH XZGREP 1 "2010-09-27" "Tukaani" "XZ Utils"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
xzgrep \- search compressed files for a regular expression
|
xzgrep \- search compressed files for a regular expression
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
|
@ -14,7 +14,7 @@ xzgrep \- search compressed files for a regular expression
|
||||||
.RI [ grep_options ]
|
.RI [ grep_options ]
|
||||||
.RB [ \-e ]
|
.RB [ \-e ]
|
||||||
.I pattern
|
.I pattern
|
||||||
.IR file ".\|.\|."
|
.IR file "..."
|
||||||
.br
|
.br
|
||||||
.B xzegrep
|
.B xzegrep
|
||||||
.RB ...
|
.RB ...
|
||||||
|
@ -47,7 +47,8 @@ All options specified are passed directly to
|
||||||
.PP
|
.PP
|
||||||
If no
|
If no
|
||||||
.I file
|
.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).
|
.BR grep (1).
|
||||||
When reading from standard input,
|
When reading from standard input,
|
||||||
.BR gzip (1)
|
.BR gzip (1)
|
||||||
|
|
|
@ -7,7 +7,7 @@
|
||||||
.\"
|
.\"
|
||||||
.\" (Note that this file is not based on gzip's zless.1.)
|
.\" (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
|
.SH NAME
|
||||||
xzless, lzless \- view xz or lzma compressed (text) files
|
xzless, lzless \- view xz or lzma compressed (text) files
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
|
@ -32,9 +32,11 @@ reads from standard input.
|
||||||
.B xzless
|
.B xzless
|
||||||
uses
|
uses
|
||||||
.BR less (1)
|
.BR less (1)
|
||||||
to present its output. Unlike
|
to present its output.
|
||||||
|
Unlike
|
||||||
.BR xzmore ,
|
.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
|
Commands are based on both
|
||||||
.BR more (1)
|
.BR more (1)
|
||||||
and
|
and
|
||||||
|
@ -50,7 +52,8 @@ is provided for backward compatibility with LZMA Utils.
|
||||||
.SH ENVIRONMENT
|
.SH ENVIRONMENT
|
||||||
.TP
|
.TP
|
||||||
.B LESSMETACHARS
|
.B LESSMETACHARS
|
||||||
A list of characters special to the shell. Set by
|
A list of characters special to the shell.
|
||||||
|
Set by
|
||||||
.B xzless
|
.B xzless
|
||||||
unless it is already set in the environment.
|
unless it is already set in the environment.
|
||||||
.TP
|
.TP
|
||||||
|
|
|
@ -4,7 +4,7 @@
|
||||||
.\"
|
.\"
|
||||||
.\" License: GNU GPLv2+
|
.\" License: GNU GPLv2+
|
||||||
.\"
|
.\"
|
||||||
.TH XZMORE 1 "2009-07-05" "Tukaani" "XZ Utils"
|
.TH XZMORE 1 "2010-09-27" "Tukaani" "XZ Utils"
|
||||||
.SH NAME
|
.SH NAME
|
||||||
xzmore, lzmore \- view xz or lzma compressed (text) files
|
xzmore, lzmore \- view xz or lzma compressed (text) files
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
|
@ -19,7 +19,8 @@ is a filter which allows examination of
|
||||||
.BR xz (1)
|
.BR xz (1)
|
||||||
or
|
or
|
||||||
.BR lzma (1)
|
.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
|
.PP
|
||||||
To use a pager other than the default
|
To use a pager other than the default
|
||||||
.B more,
|
.B more,
|
||||||
|
|
1964
src/xz/xz.1
1964
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.
|
.\" This file has been put into the public domain.
|
||||||
.\" You can do whatever you want with this file.
|
.\" 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
|
.SH NAME
|
||||||
xzdec, lzmadec \- Small .xz and .lzma decompressors
|
xzdec, lzmadec \- Small .xz and .lzma decompressors
|
||||||
.SH SYNOPSIS
|
.SH SYNOPSIS
|
||||||
|
@ -25,7 +25,8 @@ files.
|
||||||
.B xzdec
|
.B xzdec
|
||||||
is intended to work as a drop-in replacement for
|
is intended to work as a drop-in replacement for
|
||||||
.BR xz (1)
|
.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"
|
.B "xz \-\-decompress \-\-stdout"
|
||||||
(and possibly a few other commonly used options) to decompress
|
(and possibly a few other commonly used options) to decompress
|
||||||
.B .xz
|
.B .xz
|
||||||
|
@ -43,7 +44,8 @@ files.
|
||||||
.PP
|
.PP
|
||||||
To reduce the size of the executable,
|
To reduce the size of the executable,
|
||||||
.B xzdec
|
.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
|
.B XZ_DEFAULTS
|
||||||
and
|
and
|
||||||
.B XZ_OPT
|
.B XZ_OPT
|
||||||
|
@ -90,8 +92,7 @@ Ignored for
|
||||||
.BR xz (1)
|
.BR xz (1)
|
||||||
compatibility.
|
compatibility.
|
||||||
.B xzdec
|
.B xzdec
|
||||||
never uses the exit status
|
never uses the exit status 2.
|
||||||
.BR "2" .
|
|
||||||
.TP
|
.TP
|
||||||
.BR \-h ", " \-\-help
|
.BR \-h ", " \-\-help
|
||||||
Display a help message and exit successfully.
|
Display a help message and exit successfully.
|
||||||
|
@ -111,18 +112,32 @@ An error occurred.
|
||||||
.B xzdec
|
.B xzdec
|
||||||
doesn't have any warning messages like
|
doesn't have any warning messages like
|
||||||
.BR xz (1)
|
.BR xz (1)
|
||||||
has, thus the exit status
|
has, thus the exit status 2 is not used by
|
||||||
.B 2
|
|
||||||
is not used by
|
|
||||||
.BR xzdec .
|
.BR xzdec .
|
||||||
.SH NOTES
|
.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
|
.B xzdec
|
||||||
and
|
and
|
||||||
.B lzmadec
|
.B lzmadec
|
||||||
are not really that small. The size can be reduced further by dropping
|
are not really that small.
|
||||||
features from liblzma at compile time, but that shouldn't usually be done
|
The size can be reduced further by dropping
|
||||||
for executables distributed in typical non-embedded operating system
|
features from liblzma at compile time,
|
||||||
distributions. If you need a truly small
|
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
|
.B .xz
|
||||||
decompressor, consider using XZ Embedded.
|
decompressor, consider using XZ Embedded.
|
||||||
.SH "SEE ALSO"
|
.SH "SEE ALSO"
|
||||||
|
|
Loading…
Reference in New Issue