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: Update --long-help and man page for new --filters option.

Browse source
This commit is contained in:
Jia Tan 2023-01-06 00:03:06 +08:00
parent 9ded880a02
commit 5f3b898d07
2 changed files with 42 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
src/xz/message.c
View file

@ -1057,6 +1057,12 @@ message_help(bool long_help)
puts(_(
"\n Custom filter chain for compression (alternative for using presets):"));
puts(_(
"\n"
" --filters=FILTERS set the filter chain using the liblzma filter string\n"
" syntax; use --filters-help for more information"
));
#if defined(HAVE_ENCODER_LZMA1) || defined(HAVE_DECODER_LZMA1) \
|| defined(HAVE_ENCODER_LZMA2) || defined(HAVE_DECODER_LZMA2)
// TRANSLATORS: The word "literal" in "literal context bits"

41
src/xz/xz.1
View file

@ -1295,15 +1295,24 @@ in the chain.
Depending on the filter, this limitation is either inherent to
the filter design or exists to prevent security issues.
.PP
A custom filter chain is specified by using one or more
filter options in the order they are wanted in the filter chain.
That is, the order of filter options is significant!
A custom filter chain is specified in two different ways.
The option
.BI \-\-filters= filters
allows specifying the entire filter chain in one option.
Alternatively, filter chains can be specified by using one or more
individual filter options in the order they are wanted in the filter chain.
That is, the order of individual filter options is significant!
When decoding raw streams
.RB ( \-\-format=raw ),
the filter chain is specified in the same order as
the filter chain must be specified in the same order as
it was specified when compressing.
Any individual filters or presets specified before the full chain option
(\fB\-\-filters=\fIfilters\fR)
will be forgotten.
Individual filters specified after the full chain option will reset the
filter chain.
.PP
Filters take filter-specific
Both the full and individual filter options take filter-specific
.I options
as a comma-separated list.
Extra commas in
@ -1321,6 +1330,28 @@ use
twice).
This works also for viewing the filter chain options used by presets.
.TP
\fB\-\-filters\fR\fB=\fIfilters\fR
.PD
Specify the full filter chain or a preset in a single option.
Each filter can be separated by spaces or two dashes
.RB ( \-\- ).
.I filters
may need to be quoted on the shell command line so it is
parsed as a single option.
To denote
.IR options ,
use
.B :
or
.BR = .
A preset can be prefixed with a
.B \-
and followed with zero or more flags.
The only supported flag is
.B e
to apply the same options as
.BR \-\-extreme .
.TP
\fB\-\-lzma1\fR[\fB=\fIoptions\fR]
.PD 0
.TP