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: Fix outdated threading related info on the man page.

Browse source
This commit is contained in:
Lasse Collin 2024-02-13 11:38:10 +02:00
parent 3182a330c1
commit 0709c2b2d7
1 changed files with 14 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

22
src/xz/xz.1
View file

@ -4,7 +4,7 @@
.\" Authors: Lasse Collin .\" Authors: Lasse Collin
.\" Jia Tan .\" Jia Tan
.\" .\"
.TH XZ 1 "2024-01-23" "Tukaani" "XZ Utils" .TH XZ 1 "2024-02-13" "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
@ -799,8 +799,6 @@ in the single-threaded mode.
It may vary slightly between It may vary slightly between
.B xz .B xz
versions. versions.
Memory requirements of some of the future multithreaded modes may
be dramatically higher than that of the single-threaded mode.
.IP \(bu 3 .IP \(bu 3
DecMem contains the decompressor memory requirements. DecMem contains the decompressor memory requirements.
That is, the compression settings determine That is, the compression settings determine
@ -809,6 +807,15 @@ The exact decompressor memory usage is slightly more than
the LZMA2 dictionary size, but the values in the table the LZMA2 dictionary size, but the values in the table
have been rounded up to the next full MiB. have been rounded up to the next full MiB.
.RE .RE
.IP ""
Memory requirements of the multi-threaded mode are
significantly higher than that of the single-threaded mode.
With the default value of
.BR \-\-block\-size ,
each thread needs 3*3*DictSize plus CompMem or DecMem.
For example, four threads with preset
.B \-6
needs 660\(en670\ MiB of memory.
.TP .TP
.BR \-e ", " \-\-extreme .BR \-e ", " \-\-extreme
Use a slower variant of the selected compression preset level Use a slower variant of the selected compression preset level
@ -900,17 +907,16 @@ Using
.I size .I size
less than the LZMA2 dictionary size is waste of RAM less than the LZMA2 dictionary size is waste of RAM
because then the LZMA2 dictionary buffer will never get fully used. because then the LZMA2 dictionary buffer will never get fully used.
The sizes of the blocks are stored in the block headers, In multi-threaded mode,
which a future version of the sizes of the blocks are stored in the block headers.
.B xz This size information is required for multi-threaded decompression.
will use for multi-threaded decompression.
.IP "" .IP ""
In single-threaded mode no block splitting is done by default. In single-threaded mode no block splitting is done by default.
Setting this option doesn't affect memory usage. Setting this option doesn't affect memory usage.
No size information is stored in block headers, No size information is stored in block headers,
thus files created in single-threaded mode thus files created in single-threaded mode
won't be identical to files created in multi-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 The lack of size information also means that
.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