diff options
author | Yann Collet <Cyan4973@users.noreply.github.com> | 2019-04-23 17:18:40 (GMT) |
---|---|---|
committer | GitHub <noreply@github.com> | 2019-04-23 17:18:40 (GMT) |
commit | 398e36c756a3067de8e2b35dd380baef040dfe0d (patch) | |
tree | fe7d22f46d7345bf1316a91c2eedad4765f997f1 /programs/lz4.1.md | |
parent | 131896ab9d4fc9b8c606616327ed223d5d86472b (diff) | |
parent | f665291e6cb651cb084bf9450a071ae0fd494782 (diff) | |
download | lz4-1.9.1.zip lz4-1.9.1.tar.gz lz4-1.9.1.tar.bz2 |
Merge pull request #692 from lz4/devv1.9.1
v1.9.1
Diffstat (limited to 'programs/lz4.1.md')
-rw-r--r-- | programs/lz4.1.md | 32 |
1 files changed, 18 insertions, 14 deletions
diff --git a/programs/lz4.1.md b/programs/lz4.1.md index 10449a0..8874467 100644 --- a/programs/lz4.1.md +++ b/programs/lz4.1.md @@ -31,29 +31,29 @@ The native file format is the `.lz4` format. `lz4` supports a command line syntax similar _but not identical_ to `gzip(1)`. Differences are : - * `lz4` preserves original files * `lz4` compresses a single file by default (see `-m` for multiple files) * `lz4 file1 file2` means : compress file1 _into_ file2 * `lz4 file.lz4` will default to decompression (use `-z` to force compression) + * `lz4` preserves original files * `lz4` shows real-time notification statistics during compression or decompression of a single file (use `-q` to silence them) - * If no destination name is provided, result is sent to `stdout` - _except if stdout is the console_. - * If no destination name is provided, __and__ if `stdout` is the console, - `file` is compressed into `file.lz4`. - * As a consequence of previous rules, note the following example : - `lz4 file | consumer` sends compressed data to `consumer` through `stdout`, - hence it does _not_ create `file.lz4`. - * Another consequence of those rules is that to run `lz4` under `nohup`, - you should provide a destination file: `nohup lz4 file file.lz4`, - because `nohup` writes the specified command's output to a file. + * When no destination is specified, result is sent on implicit output, + which depends on `stdout` status. + When `stdout` _is Not the console_, it becomes the implicit output. + Otherwise, if `stdout` is the console, the implicit output is `filename.lz4`. + * It is considered bad practice to rely on implicit output in scripts. + because the script's environment may change. + Always use explicit output in scripts. + `-c` ensures that output will be `stdout`. + Conversely, providing a destination name, or using `-m` + ensures that the output will be either the specified name, or `filename.lz4` respectively. Default behaviors can be modified by opt-in commands, detailed below. * `lz4 -m` makes it possible to provide multiple input filenames, which will be compressed into files using suffix `.lz4`. - Progress notifications are also disabled by default (use `-v` to enable them). + Progress notifications become disabled by default (use `-v` to enable them). This mode has a behavior which more closely mimics `gzip` command line, with the main remaining difference being that source files are preserved by default. * Similarly, `lz4 -m -d` can decompress multiple `*.lz4` files. @@ -81,8 +81,7 @@ In some cases, some options can be expressed using short command `-x` or long command `--long-word`. Short commands can be concatenated together. For example, `-d -c` is equivalent to `-dc`. -Long commands cannot be concatenated. -They must be clearly separated by a space. +Long commands cannot be concatenated. They must be clearly separated by a space. ### Multiple commands @@ -114,6 +113,10 @@ only the latest one will be applied. * `-b#`: Benchmark mode, using `#` compression level. +* `--list`: + List information about .lz4 files. + note : current implementation is limited to single-frame .lz4 files. + ### Operation modifiers * `-#`: @@ -161,6 +164,7 @@ only the latest one will be applied. Multiple input files. Compressed file names will be appended a `.lz4` suffix. This mode also reduces notification level. + Can also be used to list multiple files. `lz4 -m` has a behavior equivalent to `gzip -k` (it preserves source files by default). |