diff options
| author | Yann Collet <Cyan4973@users.noreply.github.com> | 2019-04-16 17:07:41 (GMT) |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2019-04-16 17:07:41 (GMT) |
| commit | f1226ac53dee1b41a801e8003bb3708a2e671d12 (patch) | |
| tree | dd17db72ce5d38e4d1cc65e4a298b11d2d96c817 /programs/README.md | |
| parent | 01d2a721d393646384291af2f6f2f940493cd78f (diff) | |
| parent | fc3176f6aa6b8034e0a27598c23bdda559b5cf9c (diff) | |
| download | lz4-f1226ac53dee1b41a801e8003bb3708a2e671d12.zip lz4-f1226ac53dee1b41a801e8003bb3708a2e671d12.tar.gz lz4-f1226ac53dee1b41a801e8003bb3708a2e671d12.tar.bz2 | |
Merge pull request #670 from lz4/dev
v1.9.0
Diffstat (limited to 'programs/README.md')
| -rw-r--r-- | programs/README.md | 27 |
1 files changed, 20 insertions, 7 deletions
diff --git a/programs/README.md b/programs/README.md index 2ad0449..c1995af 100644 --- a/programs/README.md +++ b/programs/README.md @@ -1,18 +1,26 @@ Command Line Interface for LZ4 library ============================================ -Command Line Interface (CLI) can be created using the `make` command without any additional parameters. -There are also multiple targets that create different variations of CLI: +### Build +The Command Line Interface (CLI) can be generated +using the `make` command without any additional parameters. + +The `Makefile` script supports all [standard conventions](https://www.gnu.org/prep/standards/html_node/Makefile-Conventions.html), +including standard targets (`all`, `install`, `clean`, etc.) +and standard variables (`CC`, `CFLAGS`, `CPPFLAGS`, etc.). + +For advanced use cases, there are targets to different variations of the CLI: - `lz4` : default CLI, with a command line syntax close to gzip - `lz4c` : Same as `lz4` with additional support legacy lz4 commands (incompatible with gzip) - `lz4c32` : Same as `lz4c`, but forced to compile in 32-bits mode +The CLI generates and decodes [LZ4-compressed frames](../doc/lz4_Frame_format.md). + #### Aggregation of parameters CLI supports aggregation of parameters i.e. `-b1`, `-e18`, and `-i1` can be joined into `-b1e18i1`. - #### Benchmark in Command Line Interface CLI includes in-memory compression benchmark module for lz4. The benchmark is conducted using a given filename. @@ -38,7 +46,9 @@ Arguments : -9 : High compression -d : decompression (default for .lz4 extension) -z : force compression + -D FILE: use FILE as dictionary -f : overwrite output without prompting + -k : preserve source files(s) (default) --rm : remove source file(s) after successful de/compression -h/-H : display help/long help and exit @@ -51,17 +61,20 @@ Advanced arguments : -m : multiple input files (implies automatic output filenames) -r : operate recursively on directories (sets also -m) -l : compress using Legacy format (Linux kernel compression) - -B# : Block size [4-7] (default : 7) + -B# : cut file into blocks of size # bytes [32+] + or predefined block size [4-7] (default: 7) -BD : Block dependency (improve compression ratio) + -BX : enable block checksum (default:disabled) --no-frame-crc : disable stream checksum (default:enabled) --content-size : compressed frame includes original size (default:not present) --[no-]sparse : sparse mode (default:enabled on file, disabled on stdout) +--favor-decSpeed: compressed files decompress faster, but are less compressed +--fast[=#]: switch to ultra fast compression level (default: 1) + Benchmark arguments : -b# : benchmark file(s), using # compression level (default : 1) -e# : test all compression levels from -bX to # (default : 1) - -i# : minimum evaluation time in seconds (default : 3s) - -B# : cut file into independent blocks of size # bytes [32+] - or predefined block size [4-7] (default: 7) + -i# : minimum evaluation time in seconds (default : 3s)``` ``` #### License |