summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorYann Collet <cyan@fb.com>2016-11-05 01:29:07 (GMT)
committerYann Collet <cyan@fb.com>2016-11-05 01:29:07 (GMT)
commit8195ba8f7bbf0153a1dc01d2ada8823a29462afa (patch)
tree9abe5d8ea0cd78cebee165852650ad4aef04cc5b
parent96565816bd38632e47bc70b76548b0f3c99c3b27 (diff)
downloadlz4-8195ba8f7bbf0153a1dc01d2ada8823a29462afa.zip
lz4-8195ba8f7bbf0153a1dc01d2ada8823a29462afa.tar.gz
lz4-8195ba8f7bbf0153a1dc01d2ada8823a29462afa.tar.bz2
Updated man page
-rw-r--r--programs/README.md12
-rw-r--r--programs/lz4.133
2 files changed, 32 insertions, 13 deletions
diff --git a/programs/README.md b/programs/README.md
index 7a5d2e2..b67408f 100644
--- a/programs/README.md
+++ b/programs/README.md
@@ -2,20 +2,20 @@ Command Line Interface for LZ4 library
============================================
Command Line Interface (CLI) can be created using the `make` command without any additional parameters.
-There are however other Makefile targets that create different variations of CLI:
-- `lz4` : default CLI supporting gzip-like arguments
-- `lz4c` : Same as `lz4` with additional support for decompression of legacy lz4 versions
+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`.
+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 benchmark is conducted using a given filename.
The file is read into memory.
It makes benchmark more precise as it eliminates I/O overhead.
@@ -26,7 +26,7 @@ The `-i` parameter selects a number of iterations used for each of tested levels
#### Usage of Command Line Interface
-The full list of options can be obtained with `-h` or `-H` parameter:
+The full list of commands can be obtained with `-h` or `-H` parameter:
```
Usage :
lz4 [arg] [input] [output]
diff --git a/programs/lz4.1 b/programs/lz4.1
index 059b820..529d36a 100644
--- a/programs/lz4.1
+++ b/programs/lz4.1
@@ -50,12 +50,16 @@ The native file format is the
format.
.B lz4
-supports a command line syntax similar but not identical to
+supports a command line syntax similar \fIbut not identical\fR to
.BR gzip (1).
Differences are :
-\fBlz4\fR preserve original files ;
-\fBlz4 file1 file2\fR means : compress file1 \fIinto\fR file2 ;
-\fBlz4 file\fR shows real-time statistics during compression .
+ \fBlz4\fR preserves original files
+ \fBlz4\fR compresses a single file by default (use \fB-m\fR for multiple files)
+ \fBlz4 file1 file2\fR means : compress file1 \fIinto\fR file2
+ When no destination name is provided, compressed file name receives a \fB.lz4\fR suffix
+ When no destination name is provided, if \fBstdout\fR is \fInot\fR the console, it becomes the output (like a silent \fB-c\fR)
+ Therefore \fBlz4 file > /dev/null\fR will not create \fBfile.lz4\fR
+ \fBlz4 file\fR shows real-time statistics during compression (use \fB-q\fR to silent them)
Default behaviors can be modified by opt-in commands, described below.
\fBlz4 --quiet --multiple\fR more closely mimics \fBgzip\fR behavior.
@@ -129,6 +133,11 @@ Test the integrity of compressed
files.
The decompressed data is discarded.
No files are created nor removed.
+
+.TP
+.BR \-b#
+Benchmark mode, using # compression level.
+
.
.SS "Operation modifiers"
.TP
@@ -215,12 +224,22 @@ hence for a file. It won't work with unknown source size, such as stdin or pipe.
.BR \-k ", " \--keep
Don't delete source file.
This is default behavior anyway, so this option is just for compatibility with gzip/xz.
+
+.
+.SS "Benchmark mode"
+.TP
+.B \-b#
+ benchmark file(s), using # compression level
.TP
-.B \-b
- benchmark file(s)
+.B \-e#
+ benchmark multiple compression levels, from b# to e# (included)
.TP
.B \-i#
- iteration loops [1-9](default : 3), benchmark mode only
+ minimum evaluation in seconds [1-9] (default : 3)
+.TP
+.B \-r
+ operate recursively on directories
+
.SH BUGS
Report bugs at: https://github.com/Cyan4973/lz4/issues