mirrors/lz4
0
0
Fork 0
mirror of https://github.com/lz4/lz4.git synced 2024-11-24 02:14:51 +08:00
Code Issues Packages Projects Releases Wiki Activity

clarify man page on lz4 CLI being single threaded.

Browse Source 
should properly answer comments in #807
This commit is contained in:
Yann Collet 2023-12-26 12:18:12 -08:00
parent e6b4f27009
commit af08a062cf
2 changed files with 7 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
programs/lz4.1
View File

@ -1,5 +1,5 @@
.
.TH "LZ4" "1" "August 2022" "lz4 v1.9.4" "User Commands"
.TH "LZ4" "1" "December 2023" "lz4 1.9.5" "User Commands"
.
.SH "NAME"
\fBlz4\fR \- lz4, unlz4, lz4cat \- Compress or decompress \.lz4 files
@ -17,7 +17,7 @@
When writing scripts that need to decompress files, it is recommended to always use the name \fBlz4\fR with appropriate arguments (\fBlz4 \-d\fR or \fBlz4 \-dc\fR) instead of the names \fBunlz4\fR and \fBlz4cat\fR\.
.
.SH "DESCRIPTION"
\fBlz4\fR is an extremely fast lossless compression algorithm, based on \fBbyte\-aligned LZ77\fR family of compression scheme\. \fBlz4\fR offers compression speeds > 500 MB/s per core, linearly scalable with multi\-core CPUs\. It features an extremely fast decoder, offering speed in multiple GB/s per core, typically reaching RAM speed limit on multi\-core systems\. The native file format is the \fB\.lz4\fR format\.
\fBlz4\fR is a CLI based on \fBliblz4\fR, an extremely fast implementation of lossless compression algorithm\. It offers a default compression speed typically > 500 MB/s, and its extremely fast decoder is mostly I/O bound, reaching multiple GB/s\. While \fBliblz4\fR is multi\-threadable, note that the \fBlz4\fR CLI uses only one thread to offer these speeds\. Its native file format is the \fB\.lz4\fR format\.
.
.SS "Difference between lz4 and gzip"
\fBlz4\fR supports a command line syntax similar \fIbut not identical\fR to \fBgzip(1)\fR\. Differences are :

13
programs/lz4.1.md
View File

@ -18,13 +18,10 @@ it is recommended to always use the name `lz4` with appropriate arguments
DESCRIPTION
-----------
`lz4` is an extremely fast lossless compression algorithm,
based on **byte-aligned LZ77** family of compression scheme.
`lz4` offers compression speeds > 500 MB/s per core,
linearly scalable with multi-core CPUs.
It features an extremely fast decoder, offering speed in multiple GB/s per core,
typically reaching RAM speed limit on multi-core systems.
The native file format is the `.lz4` format.
`lz4` is a CLI based on `liblz4`, an extremely fast implementation of lossless compression algorithm.
It offers a default compression speed typically > 500 MB/s, and its extremely fast decoder is mostly I/O bound, reaching multiple GB/s.
While `liblz4` is multi-threadable, note that the `lz4` CLI uses only one thread to offer these speeds.
Its native file format is the `.lz4` format.
### Difference between lz4 and gzip
@ -59,7 +56,7 @@ Default behaviors can be modified by opt-in commands, detailed below.
* Similarly, `lz4 -m -d` can decompress multiple `*.lz4` files.
* It's possible to opt-in to erase source files
on successful compression or decompression, using `--rm` command.
* Consequently, `lz4 -m --rm` behaves the same as `gzip`.
* Consequently, `lz4 -m --rm` features a behavior closer to the `gzip` one.
### Concatenation of .lz4 files