History

Nick Terrell a7cc0b590a Fix make install * Uninstall didn't remove the pkg-config correctly. * Fix `mandir` * Allow overriding either upper- or lower-case location variables, but always use the lower case variables. * Add test case that ensures overriding both upper- and lower-case variables is the same, and that the directory is empty after uninstall.		2018-05-04 13:50:23 -07:00
..
.gitignore	fix #284 , reported by @beiDei8z : added test cases for path/to/lz4cat	2016-12-07 14:49:04 -08:00
bench.c	bench: introduced hidden command -S	2018-03-19 17:19:25 -07:00
bench.h	bench: introduced hidden command -S	2018-03-19 17:19:25 -07:00
COPYING	Makefile : added capability to install libraries	2014-01-07 18:47:50 +00:00
datagen.c	programs/datagen : attempt to please static analyzer	2018-01-13 22:24:32 -08:00
datagen.h	added a few dates	2016-11-21 15:51:39 -08:00
lz4.1	update man page	2018-01-13 19:06:33 -08:00
lz4.1.md	minor man fix on clevels	2018-03-19 16:18:10 -07:00
lz4cli.c	fasterDecSpeed can be triggered from cli with --favor-decSpeed	2018-04-26 15:49:32 -07:00
lz4io.c	fasterDecSpeed can be triggered from cli with --favor-decSpeed	2018-04-26 15:49:32 -07:00
lz4io.h	fasterDecSpeed can be triggered from cli with --favor-decSpeed	2018-04-26 15:49:32 -07:00
Makefile	Fix make install	2018-05-04 13:50:23 -07:00
platform.h	minor updates to examples	2017-11-24 17:18:46 -08:00
README.md	updated programs\README.md	2016-11-16 10:53:06 +01:00
util.h	added a test case for LZ4_decompress_fast_usingDict	2018-04-29 07:42:24 -07:00

README.md

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:

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

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. The file is read into memory. It makes benchmark more precise as it eliminates I/O overhead.

The benchmark measures ratio, compressed size, compression and decompression speed. One can select compression levels starting from -b and ending with -e. The -i parameter selects a number of seconds used for each of tested levels.

Usage of Command Line Interface

The full list of commands can be obtained with -h or -H parameter:

Usage :
      lz4 [arg] [input] [output]

input   : a filename
          with no FILE, or when FILE is - or stdin, read standard input
Arguments :
 -1     : Fast compression (default)
 -9     : High compression
 -d     : decompression (default for .lz4 extension)
 -z     : force compression
 -f     : overwrite output without prompting
--rm    : remove source file(s) after successful de/compression
 -h/-H  : display help/long help and exit

Advanced arguments :
 -V     : display Version number and exit
 -v     : verbose mode
 -q     : suppress warnings; specify twice to suppress errors too
 -c     : force write to standard output, even if it is the console
 -t     : test compressed file integrity
 -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)
 -BD    : Block dependency (improve compression ratio)
--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)
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)

License

All files in this directory are licensed under GPL-v2. See COPYING for details. The text of the license is also included at the top of each source file.