root
/
xz
mirror of https://git.tukaani.org/xz.git
1
0
Fork 0
Code Issues Releases Wiki Activity

xz: Add a section to man page for robot mode --filters-help.

This commit is contained in:
Jia Tan 2023-06-20 20:32:59 +08:00
parent e10f2db5d1
commit c12e429f26
1 changed files with 30 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
src/xz/xz.1
View File

@ -940,7 +940,7 @@ A special value of
may be used as the last size to indicate that may be used as the last size to indicate that
the rest of the file should be encoded as a single block. the rest of the file should be encoded as a single block.
.IP "" .IP ""
An alternative custom filter chain for each block can be An alternative filter chain for each block can be
specified in combination with the specified in combination with the
.BI \-\-filters1= filters .BI \-\-filters1= filters
\&...\& \&...\&
@ -1343,7 +1343,7 @@ and
.BI \-\-filters1= filters .BI \-\-filters1= filters
\&...\& \&...\&
.BI \-\-filters9= filters .BI \-\-filters9= filters
allows specifying an entire filter chain in one option using the allow specifying an entire filter chain in one option using the
liblzma filter string syntax. liblzma filter string syntax.
Alternatively, a filter chain can be specified by using one or more Alternatively, a filter chain can be specified by using one or more
individual filter options in the order they are wanted in the filter chain. individual filter options in the order they are wanted in the filter chain.
@ -2050,6 +2050,7 @@ Currently
.B \-\-robot .B \-\-robot
is supported only together with is supported only together with
.BR \-\-list , .BR \-\-list ,
.BR \-\-filters\-help ,
.BR \-\-info\-memory , .BR \-\-info\-memory ,
and and
.BR \-\-version . .BR \-\-version .
@ -2340,6 +2341,33 @@ Future versions may add new line types and
new columns can be added to the existing line types, new columns can be added to the existing line types,
but the existing columns won't be changed. but the existing columns won't be changed.
. .
.SS "Filters help"
.B "xz \-\-robot \-\-filters-help"
prints the supported filters in the following format:
.PP
\fIfilter\fB:\fIoption\fB=<\fIvalue\fB>,\fIoption\fB=<\fIvalue\fB>\fR...
.TP
.I filter
Name of the filter
.TP
.I option
Name of a filter specific option
.TP
.I value
Numeric
.I value
ranges appear as
\fB<\fImin\fB\-\fImax\fB>\fR.
String
.I value
choices are shown within
.B "< >"
and separated by a
.B |
character.
.PP
Each filter is printed on its own line.
.
.SS "Memory limit information" .SS "Memory limit information"
.B "xz \-\-robot \-\-info\-memory" .B "xz \-\-robot \-\-info\-memory"
prints a single line with three tab-separated columns: prints a single line with three tab-separated columns: