diff options
| author | Yann Collet <cyan@fb.com> | 2019-04-12 18:27:44 (GMT) |
|---|---|---|
| committer | Yann Collet <cyan@fb.com> | 2019-04-12 18:27:44 (GMT) |
| commit | 21ff1a839afcf18e68ee7dbb0ec0d6cccb4c1be0 (patch) | |
| tree | 4318e6bcebc94455ed166cea1b096b7d9bc93fdb /programs | |
| parent | 780aac520b69d6369f4e3995624c37e56d75498d (diff) | |
| download | lz4-21ff1a839afcf18e68ee7dbb0ec0d6cccb4c1be0.zip lz4-21ff1a839afcf18e68ee7dbb0ec0d6cccb4c1be0.tar.gz lz4-21ff1a839afcf18e68ee7dbb0ec0d6cccb4c1be0.tar.bz2 | |
updated doc to underline difference between block and frame
as this is a very frequent source of confusion for new users.
Diffstat (limited to 'programs')
| -rw-r--r-- | programs/README.md | 14 |
1 files changed, 11 insertions, 3 deletions
diff --git a/programs/README.md b/programs/README.md index 23c944b..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. |