revi-archive/xz-archive
1
0
Fork 0
mirror of https://git.tukaani.org/xz.git synced 2024-04-04 12:36:23 +02:00
Code Activity

xz: A couple of man page fixes.

Browse source 
Now the interaction of presets and custom filter chains
is described correctly. Earlier it contradicted itself.

Thanks to DevHC who reported these issues on IRC to me
on 2012-12-14.
This commit is contained in:
Lasse Collin 2013-06-21 21:54:59 +03:00
parent 45edf2966f
commit 19b447b64b
1 changed files with 23 additions and 12 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

35
src/xz/xz.1
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 "2012-10-03" "Tukaani" "XZ Utils" .TH XZ 1 "2013-06-21" "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
@ -897,11 +897,14 @@ if threading will be enabled by default.
.SS "Custom compressor filter chains" .SS "Custom compressor filter chains"
A custom filter chain allows specifying A custom filter chain allows specifying
the compression settings in detail instead of relying on the compression settings in detail instead of relying on
the settings associated to the preset levels. the settings associated to the presets.
When a custom filter chain is specified, When a custom filter chain is specified,
the compression preset level options preset options (\fB\-0\fR ... \fB\-9\fR and \fB\-\-extreme\fR)
(\fB\-0\fR ... \fB\-9\fR and \fB\-\-extreme\fR) are earlier on the command line are forgotten.
silently ignored. If a preset option is specified
after one or more custom filter chain options,
the new preset takes effect and
the custom filter chain options specified earlier are forgotten.
.PP .PP
A filter chain is comparable to piping on the command line. A filter chain is comparable to piping on the command line.
When compressing, the uncompressed input goes to the first filter, When compressing, the uncompressed input goes to the first filter,
@ -934,6 +937,15 @@ Extra commas in
are ignored. are ignored.
Every option has a default value, so you need to Every option has a default value, so you need to
specify only those you want to change. specify only those you want to change.
.PP
To see the whole filter chain and
.IR options ,
use
.B "xz \-vv"
(that is, use
.B \-\-verbose
twice).
This works also for viewing the filter chain options used by presets.
.TP .TP
\fB\-\-lzma1\fR[\fB=\fIoptions\fR] \fB\-\-lzma1\fR[\fB=\fIoptions\fR]
.PD 0 .PD 0
@ -976,13 +988,12 @@ The only supported modifier is currently
.BR e , .BR e ,
which matches which matches
.BR \-\-extreme . .BR \-\-extreme .
The default If no
.I preset .B preset
is is specified, the default values of LZMA1 or LZMA2
.BR 6 ,
from which the default values for the rest of the LZMA1 or LZMA2
.I options .I options
are taken. are taken from the preset
.BR 6 .
.TP .TP
.BI dict= size .BI dict= size
Dictionary (history buffer) Dictionary (history buffer)
@ -1578,7 +1589,7 @@ is supported only together with
.BR \-\-info\-memory , .BR \-\-info\-memory ,
and and
.BR \-\-list . .BR \-\-list .
It will be supported for normal compression and It will be supported for compression and
decompression in the future. decompression in the future.
. .
.SS Version .SS Version