xz: Document --flush-timeout=TIMEOUT on the man page.

This commit is contained in:
Lasse Collin 2013-10-22 20:03:12 +03:00
parent ba413da1d5
commit 56feb8665b
1 changed files with 36 additions and 1 deletions

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-06-21" "Tukaani" "XZ Utils" .TH XZ 1 "2013-10-22" "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
@ -835,6 +835,41 @@ the rest of the file should be encoded as a single block.
.B "Currently this option is badly broken if used together with" .B "Currently this option is badly broken if used together with"
.B "\-\-block\-size or with multithreading." .B "\-\-block\-size or with multithreading."
.TP .TP
.BI \-\-flush\-timeout= timeout
When compressing, if more than
.I timeout
milliseconds (a positive integer) has passed since the previous flush and
reading more input would block,
all the pending input data is flushed from the encoder and
made available in the output stream.
This can be useful if
.B xz
is used to compress data that is streamed over a network.
Small
.I timeout
values make the data available at the receiving end
with a small delay, but large
.I timeout
values give better compression ratio.
.IP ""
This feature is disabled by default.
If this option is specified more than once, the last one takes effect.
The special
.I timeout
value of
.B 0
can be used to explicitly disable this feature.
.IP ""
This feature is not available on non-POSIX systems.
.IP ""
.\" FIXME
.B "This feature is still experimental."
Currently
.B xz
is unsuitable for decompressing the stream in real time due to how
.B xz
does buffering.
.TP
.BI \-\-memlimit\-compress= limit .BI \-\-memlimit\-compress= limit
Set a memory usage limit for compression. Set a memory usage limit for compression.
If this option is specified multiple times, If this option is specified multiple times,