mirror of
https://git.tukaani.org/xz.git
synced 2024-04-04 12:36:23 +02:00
xz: Update the man page for --block-list and --filtersX
The --block-list option description needed updating since the new --filtersX option changes how it can be used. The new entry for --filters1=FILTERS ... --filter9=FILTERS was created right after the --filters option.
This commit is contained in:
parent
47a63cad2a
commit
95f1a414b1
1 changed files with 80 additions and 26 deletions
106
src/xz/xz.1
106
src/xz/xz.1
|
@ -915,36 +915,77 @@ The lack of size information also means that a future version of
|
||||||
.B xz
|
.B xz
|
||||||
won't be able decompress the files in multi-threaded mode.
|
won't be able decompress the files in multi-threaded mode.
|
||||||
.TP
|
.TP
|
||||||
.BI \-\-block\-list= sizes
|
.BI \-\-block\-list= items
|
||||||
When compressing to the
|
When compressing to the
|
||||||
.B .xz
|
.B .xz
|
||||||
format, start a new block after
|
format, start a new block with an optional custom filter chain after
|
||||||
the given intervals of uncompressed data.
|
the given intervals of uncompressed data.
|
||||||
.IP ""
|
.IP ""
|
||||||
The uncompressed
|
The
|
||||||
.I sizes
|
.I items
|
||||||
of the blocks are specified as a comma-separated list.
|
are a comma-separated list.
|
||||||
Omitting a size (two or more consecutive commas) is a shorthand
|
Each item consists of an optional filter chain number
|
||||||
to use the size of the previous block.
|
between 0 and 9 followed by a colon
|
||||||
|
.RB ( : )
|
||||||
|
and a required size of uncompressed data.
|
||||||
|
Omitting an item (two or more consecutive commas) is a
|
||||||
|
shorthand to use the size and filters of the previous item.
|
||||||
.IP ""
|
.IP ""
|
||||||
If the input file is bigger than the sum of
|
If the input file is bigger than the sum of
|
||||||
.IR sizes ,
|
the sizes in
|
||||||
the last value in
|
.IR items ,
|
||||||
.I sizes
|
the last item is repeated until the end of the file.
|
||||||
is repeated until the end of the file.
|
|
||||||
A special value of
|
A special value of
|
||||||
.B 0
|
.B 0
|
||||||
may be used as the last value 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 ""
|
||||||
If one specifies
|
An alternative custom filter chain for each block can be
|
||||||
.I sizes
|
specified in combination with the
|
||||||
that exceed the encoder's block size
|
.BI \-\-filters1= filters
|
||||||
|
\&...\&
|
||||||
|
.BI \-\-filters9= filters
|
||||||
|
options.
|
||||||
|
These options define filter chains with an identifier
|
||||||
|
between 1\(en9.
|
||||||
|
Filter chain 0 can be used to refer to the default filter chain,
|
||||||
|
which is the same as not specifying a filter chain.
|
||||||
|
The filter chain identifier can be used before the uncompressed
|
||||||
|
size, followed by a colon
|
||||||
|
.RB ( : ).
|
||||||
|
For example, if one specifies
|
||||||
|
.B \-\-block\-list=1:2MiB,3:2MiB,2:4MiB,,2MiB,0:4MiB
|
||||||
|
then blocks will be created using:
|
||||||
|
.RS
|
||||||
|
.IP \(bu 3
|
||||||
|
The filter chain specified by
|
||||||
|
.B \-\-filters1
|
||||||
|
and 2 MiB input
|
||||||
|
.IP \(bu 3
|
||||||
|
The filter chain specified by
|
||||||
|
.B \-\-filters3
|
||||||
|
and 2 MiB input
|
||||||
|
.IP \(bu 3
|
||||||
|
The filter chain specified by
|
||||||
|
.B \-\-filters2
|
||||||
|
and 4 MiB input
|
||||||
|
.IP \(bu 3
|
||||||
|
The filter chain specified by
|
||||||
|
.B \-\-filters2
|
||||||
|
and 4 MiB input
|
||||||
|
.IP \(bu 3
|
||||||
|
The default filter chain and 2 MiB input
|
||||||
|
.IP \(bu 3
|
||||||
|
The default filter chain and 4 MiB input for every block until
|
||||||
|
end of input.
|
||||||
|
.RE
|
||||||
|
.IP ""
|
||||||
|
If one specifies a size that exceeds the encoder's block size
|
||||||
(either the default value in threaded mode or
|
(either the default value in threaded mode or
|
||||||
the value specified with \fB\-\-block\-size=\fIsize\fR),
|
the value specified with \fB\-\-block\-size=\fIsize\fR),
|
||||||
the encoder will create additional blocks while
|
the encoder will create additional blocks while
|
||||||
keeping the boundaries specified in
|
keeping the boundaries specified in
|
||||||
.IR sizes .
|
.IR items .
|
||||||
For example, if one specifies
|
For example, if one specifies
|
||||||
.B \-\-block\-size=10MiB
|
.B \-\-block\-size=10MiB
|
||||||
.B \-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB
|
.B \-\-block\-list=5MiB,10MiB,8MiB,12MiB,24MiB
|
||||||
|
@ -1295,18 +1336,24 @@ in the chain.
|
||||||
Depending on the filter, this limitation is either inherent to
|
Depending on the filter, this limitation is either inherent to
|
||||||
the filter design or exists to prevent security issues.
|
the filter design or exists to prevent security issues.
|
||||||
.PP
|
.PP
|
||||||
A custom filter chain is specified in two different ways.
|
A custom filter chain can be specified in two different ways.
|
||||||
The option
|
The options
|
||||||
.BI \-\-filters= filters
|
.BI \-\-filters= filters
|
||||||
allows specifying the entire filter chain in one option.
|
and
|
||||||
Alternatively, filter chains can be specified by using one or more
|
.BI \-\-filters1= filters
|
||||||
|
\&...\&
|
||||||
|
.BI \-\-filters9= filters
|
||||||
|
allows specifying an entire filter chain in one option using the
|
||||||
|
liblzma filter string syntax.
|
||||||
|
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.
|
||||||
That is, the order of individual filter options is significant!
|
That is, the order of the individual filter options is significant!
|
||||||
When decoding raw streams
|
When decoding raw streams
|
||||||
.RB ( \-\-format=raw ),
|
.RB ( \-\-format=raw ),
|
||||||
the filter chain must be specified in the same order as
|
the filter chain must be specified in the same order as
|
||||||
it was specified when compressing.
|
it was specified when compressing.
|
||||||
Any individual filters or presets specified before the full chain option
|
Any individual filter or preset options specified before the full
|
||||||
|
chain option
|
||||||
(\fB\-\-filters=\fIfilters\fR)
|
(\fB\-\-filters=\fIfilters\fR)
|
||||||
will be forgotten.
|
will be forgotten.
|
||||||
Individual filters specified after the full chain option will reset the
|
Individual filters specified after the full chain option will reset the
|
||||||
|
@ -1318,8 +1365,8 @@ as a comma-separated list.
|
||||||
Extra commas in
|
Extra commas in
|
||||||
.I options
|
.I options
|
||||||
are ignored.
|
are ignored.
|
||||||
Every option has a default value, so you need to
|
Every option has a default value, so
|
||||||
specify only those you want to change.
|
specify those you want to change.
|
||||||
.PP
|
.PP
|
||||||
To see the whole filter chain and
|
To see the whole filter chain and
|
||||||
.IR options ,
|
.IR options ,
|
||||||
|
@ -1330,8 +1377,7 @@ use
|
||||||
twice).
|
twice).
|
||||||
This works also for viewing the filter chain options used by presets.
|
This works also for viewing the filter chain options used by presets.
|
||||||
.TP
|
.TP
|
||||||
\fB\-\-filters\fR\fB=\fIfilters\fR
|
.BI \-\-filters= filters
|
||||||
.PD
|
|
||||||
Specify the full filter chain or a preset in a single option.
|
Specify the full filter chain or a preset in a single option.
|
||||||
Each filter can be separated by spaces or two dashes
|
Each filter can be separated by spaces or two dashes
|
||||||
.RB ( \-\- ).
|
.RB ( \-\- ).
|
||||||
|
@ -1352,6 +1398,14 @@ The only supported flag is
|
||||||
to apply the same options as
|
to apply the same options as
|
||||||
.BR \-\-extreme .
|
.BR \-\-extreme .
|
||||||
.TP
|
.TP
|
||||||
|
\fB\-\-filters1\fR=\fIfilters\fR ... \fB\-\-filters9\fR=\fIfilters
|
||||||
|
Specify up to nine additional filter chains that can be used with
|
||||||
|
.BR \-\-block\-list .
|
||||||
|
.IP ""
|
||||||
|
For example, when compressing an archive with executable files
|
||||||
|
followed by text files, the executable part could use a filter
|
||||||
|
chain with a BCJ filter and the text part only the LZMA2 filter.
|
||||||
|
.TP
|
||||||
\fB\-\-lzma1\fR[\fB=\fIoptions\fR]
|
\fB\-\-lzma1\fR[\fB=\fIoptions\fR]
|
||||||
.PD 0
|
.PD 0
|
||||||
.TP
|
.TP
|
||||||
|
|
Loading…
Reference in a new issue