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

xz: Update the man page about --block-size.

This commit is contained in:
Lasse Collin 2014-12-16 20:57:43 +02:00
parent 7dddfbeb49
commit 009823448b
1 changed files with 33 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
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 "2013-11-12" "Tukaani" "XZ Utils" .TH XZ 1 "2014-12-16" "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
@ -826,14 +826,39 @@ When compressing to the
format, split the input data into blocks of format, split the input data into blocks of
.I size .I size
bytes. bytes.
The blocks are compressed independently from each other. The blocks are compressed independently from each other,
.\" FIXME: Explain how to these can be used for random access and threading. which helps with multi-threading and
makes limited random-access decompression possible.
This option is typically used to override the default
block size in multi-threaded mode,
but this option can be used in single-threaded mode too.
.IP "" .IP ""
In multi-threaded mode the sizes of the blocks In multi-threaded mode about three times
are stored in the block headers. .I size
This isn't done in single-threaded mode, bytes will be allocated in each thread for buffering input and output.
so the encoded output won't be The default
identical to that of the multi-threaded mode. .I size
is three times the LZMA2 dictionary size or 1 MiB,
whichever is more.
Typically a good value is 2\-4 times
the size of the LZMA2 dictionary or at least 1 MiB.
Using
.I size
less than the LZMA2 dictionary size is waste of RAM
because then the LZMA2 dictionary buffer will never get fully used.
The sizes of the blocks are stored in the block headers,
which a future version of
.B xz
will use for multi-threaded decompression.
.IP ""
In single-threaded mode no block splitting is done by default.
Setting this option doesn't affect memory usage.
No size information is stored in block headers,
thus files created in single-threaded mode
won't be identical to files created in multi-threaded mode.
The lack of size information also means that a future version of
.B xz
won't be able decompress the files in multi-threaded mode.
.TP .TP
.BI \-\-block\-list= sizes .BI \-\-block\-list= sizes
When compressing to the When compressing to the