A few more languages files to the xz man page.

Thanks to Jonathan Nieder.
This commit is contained in:
Lasse Collin 2010-10-04 19:43:01 +03:00
parent f9722dbeca
commit 80b5675fa6
1 changed files with 24 additions and 21 deletions

View File

@ -5,7 +5,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 XZ 1 "2010-09-27" "Tukaani" "XZ Utils" .TH XZ 1 "2010-10-04" "Tukaani" "XZ Utils"
. .
.SH NAME .SH NAME
xz, unxz, xzcat, lzma, unlzma, lzcat \- Compress or decompress .xz and .lzma files xz, unxz, xzcat, lzma, unlzma, lzcat \- Compress or decompress .xz and .lzma files
@ -127,7 +127,7 @@ if any of the following applies:
.I File .I File
is not a regular file. is not a regular file.
Symbolic links are not followed, Symbolic links are not followed,
thus they are not considered to be regular files. and thus they are not considered to be regular files.
.IP \(bu 3 .IP \(bu 3
.I File .I File
has more than one hard link. has more than one hard link.
@ -135,7 +135,7 @@ has more than one hard link.
.I File .I File
has setuid, setgid, or sticky bit set. has setuid, setgid, or sticky bit set.
.IP \(bu 3 .IP \(bu 3
The operation mode is set to compress, and the The operation mode is set to compress and the
.I file .I file
already has a suffix of the target file format already has a suffix of the target file format
.RB ( .xz .RB ( .xz
@ -151,7 +151,7 @@ when compressing to the
.B .lzma .B .lzma
format). format).
.IP \(bu 3 .IP \(bu 3
The operation mode is set to decompress, and the The operation mode is set to decompress and the
.I file .I file
doesn't have a suffix of any of the supported file formats doesn't have a suffix of any of the supported file formats
.RB ( .xz , .RB ( .xz ,
@ -238,7 +238,7 @@ by using \fB\-\-memlimit\-compress=\fIlimit\fR and
\fB\-\-memlimit\-decompress=\fIlimit\fR. \fB\-\-memlimit\-decompress=\fIlimit\fR.
Using these two options outside Using these two options outside
.B XZ_DEFAULTS .B XZ_DEFAULTS
is rarely useful, because a single run of is rarely useful because a single run of
.B xz .B xz
cannot do both compression and decompression and cannot do both compression and decompression and
.BI \-\-memlimit= limit .BI \-\-memlimit= limit
@ -334,7 +334,7 @@ the last one takes effect.
.BR \-z ", " \-\-compress .BR \-z ", " \-\-compress
Compress. Compress.
This is the default operation mode when no operation mode option This is the default operation mode when no operation mode option
is specified, and no other operation mode is implied from is specified and no other operation mode is implied from
the command name (for example, the command name (for example,
.B unxz .B unxz
implies implies
@ -369,7 +369,7 @@ To get more detailed information, use also the
option. option.
For even more information, use For even more information, use
.B \-\-verbose .B \-\-verbose
twice, but note that it may be slow, because getting all the extra twice, but note that this may be slow, because getting all the extra
information requires many seeks. information requires many seeks.
The width of verbose output exceeds The width of verbose output exceeds
80 characters, so piping the output to e.g.\& 80 characters, so piping the output to e.g.\&
@ -440,8 +440,8 @@ By default, if decompressing into a regular file,
.B xz .B xz
tries to make the file sparse if the decompressed data contains tries to make the file sparse if the decompressed data contains
long sequences of binary zeros. long sequences of binary zeros.
It works also when writing to standard output It also works when writing to standard output
as long as standard output is connected to a regular file, as long as standard output is connected to a regular file
and certain additional conditions are met to make it safe. and certain additional conditions are met to make it safe.
Creating sparse files may save disk space and speed up Creating sparse files may save disk space and speed up
the decompression by reducing the amount of disk I/O. the decompression by reducing the amount of disk I/O.
@ -542,8 +542,11 @@ which normally would have been stored in the container headers.
.RE .RE
.TP .TP
\fB\-C\fR \fIcheck\fR, \fB\-\-check=\fIcheck \fB\-C\fR \fIcheck\fR, \fB\-\-check=\fIcheck
Specify the type of the integrity check, which is calculated Specify the type of the integrity check.
from the uncompressed data. The check is calculated from the uncompressed data and
stored in the
.B .xz
file.
This option has an effect only when compressing into the This option has an effect only when compressing into the
.B .xz .B .xz
format; the format; the
@ -785,7 +788,7 @@ If the compression settings exceed the
will adjust the settings downwards so that will adjust the settings downwards so that
the limit is no longer exceeded and display a notice that the limit is no longer exceeded and display a notice that
automatic adjustment was done. automatic adjustment was done.
Adjustment is never done when compressing with Such adjustments are not made when compressing with
.B \-\-format=raw .B \-\-format=raw
or if or if
.B \-\-no\-adjust .B \-\-no\-adjust
@ -828,7 +831,7 @@ This is currently equivalent to setting the
.I limit .I limit
to to
.B max .B max
i.e. no memory usage limit. (no memory usage limit).
Once multithreading support has been implemented, Once multithreading support has been implemented,
there may be a difference between there may be a difference between
.B 0 .B 0
@ -846,7 +849,7 @@ See also the section
.TP .TP
.BI \-\-memlimit\-decompress= limit .BI \-\-memlimit\-decompress= limit
Set a memory usage limit for decompression. Set a memory usage limit for decompression.
This affects also the This also affects the
.B \-\-list .B \-\-list
mode. mode.
If the operation is not possible without exceeding the If the operation is not possible without exceeding the
@ -907,7 +910,7 @@ The output of the last filter gets written to the compressed file.
The maximum number of filters in the chain is four, The maximum number of filters in the chain is four,
but typically a filter chain has only one or two filters. but typically a filter chain has only one or two filters.
.PP .PP
Many filters have limitations where they can be Many filters have limitations on where they can be
in the filter chain: in the filter chain:
some filters can work only as the last filter in the chain, some filters can work only as the last filter in the chain,
some only as a non-last filter, and some work in any position some only as a non-last filter, and some work in any position
@ -1417,8 +1420,8 @@ is almost never useful.
.RE .RE
.TP .TP
\fB\-\-delta\fR[\fB=\fIoptions\fR] \fB\-\-delta\fR[\fB=\fIoptions\fR]
Add Delta filter to the filter chain. Add the Delta filter to the filter chain.
The Delta filter can be used only as non-last filter The Delta filter can be only used as a non-last filter
in the filter chain. in the filter chain.
.IP "" .IP ""
Currently only simple byte-wise delta calculation is supported. Currently only simple byte-wise delta calculation is supported.
@ -1471,7 +1474,7 @@ The progress indicator shows the following information:
.IP \(bu 3 .IP \(bu 3
Completion percentage is shown Completion percentage is shown
if the size of the input file is known. if the size of the input file is known.
That is, percentage cannot be shown in pipes. That is, the percentage cannot be shown in pipes.
.IP \(bu 3 .IP \(bu 3
Amount of compressed data produced (compressing) Amount of compressed data produced (compressing)
or consumed (decompressing). or consumed (decompressing).
@ -2043,7 +2046,7 @@ The uncompressed size of the file can be stored in the
header. header.
LZMA Utils does that when compressing regular files. LZMA Utils does that when compressing regular files.
The alternative is to mark that uncompressed size is unknown The alternative is to mark that uncompressed size is unknown
and use end of payload marker to indicate and use end-of-payload marker to indicate
where the decompressor should stop. where the decompressor should stop.
LZMA Utils uses this method when uncompressed size isn't known, LZMA Utils uses this method when uncompressed size isn't known,
which is the case for example in pipes. which is the case for example in pipes.
@ -2051,11 +2054,11 @@ which is the case for example in pipes.
.B xz .B xz
supports decompressing supports decompressing
.B .lzma .B .lzma
files with or without end of payload marker, but all files with or without end-of-payload marker, but all
.B .lzma .B .lzma
files created by files created by
.B xz .B xz
will use end of payload marker and have uncompressed size will use end-of-payload marker and have uncompressed size
marked as unknown in the marked as unknown in the
.B .lzma .B .lzma
header. header.