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 threading.

This commit is contained in:
Lasse Collin 2011-04-12 11:08:55 +03:00
parent 24e0406c0f
commit 70e750f597
1 changed files with 20 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
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 "2011-04-11" "Tukaani" "XZ Utils" .TH XZ 1 "2011-04-12" "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
@ -907,24 +907,30 @@ Automatic adjusting is always disabled when creating raw streams
.TP .TP
\fB\-T\fR \fIthreads\fR, \fB\-\-threads=\fIthreads \fB\-T\fR \fIthreads\fR, \fB\-\-threads=\fIthreads
Specify the number of worker threads to use. Specify the number of worker threads to use.
Setting
.I threads
to a special value
.B 0
makes
.B xz
use as many threads as there are CPU cores on the system.
The actual number of threads can be less than The actual number of threads can be less than
.I threads .I threads
if the input file is not big enough
for threading with the given settings or
if using more threads would exceed the memory usage limit. if using more threads would exceed the memory usage limit.
.IP "" .IP ""
.B "Multithreaded compression and decompression are not" Currently the only threading method is to split the input into
.B "implemented yet, so this option has no effect for now." blocks and compress them independently from each other.
The default block size depends on the compression level and
can be overriden with the
.BI \-\-block\-size= size
option.
.IP "" .IP ""
.B "As of writing (2010-09-27), it hasn't been decided" .B "It is possible that the details of this option change before"
.B "if threads will be used by default on multicore systems" .B "the next stable XZ Utils release."
.B "once support for threading has been implemented." .B "This may include the meaning of the special value 0."
.B "Comments are welcome." .\" FIXME
The complicating factor is that using many threads
will increase the memory usage dramatically.
Note that if multithreading will be the default,
it will probably be done so that single-threaded and
multithreaded modes produce the same output,
so compression ratio won't be significantly affected
if threading will be enabled by default.
. .
.SS "Custom compressor filter chains" .SS "Custom compressor filter chains"
A custom filter chain allows specifying A custom filter chain allows specifying