updated programs\README.md
This commit is contained in:
parent
8b48d5e446
commit
632ab3b8d4
@ -102,7 +102,7 @@ test_script:
|
|||||||
- ECHO *** &&
|
- ECHO *** &&
|
||||||
ECHO Testing %COMPILER% %PLATFORM% %CONFIGURATION% &&
|
ECHO Testing %COMPILER% %PLATFORM% %CONFIGURATION% &&
|
||||||
ECHO ***
|
ECHO ***
|
||||||
- if [%COMPILER%]==[unknown] (
|
- if not [%COMPILER%]==[unknown] (
|
||||||
CD programs &&
|
CD programs &&
|
||||||
lz4 -h &&
|
lz4 -h &&
|
||||||
lz4 -i1b lz4.exe &&
|
lz4 -i1b lz4.exe &&
|
||||||
@ -120,7 +120,6 @@ artifacts:
|
|||||||
deploy:
|
deploy:
|
||||||
- provider: GitHub
|
- provider: GitHub
|
||||||
artifact: bin\lz4_x64.zip
|
artifact: bin\lz4_x64.zip
|
||||||
release: lz4_x64-v$(appveyor_build_version)
|
|
||||||
auth_token:
|
auth_token:
|
||||||
secure: w6UJaGie0qbZvffr/fqyhO/Vj8rMiQWnv9a8qm3gxfngdHDTMT42wYupqJpIExId
|
secure: w6UJaGie0qbZvffr/fqyhO/Vj8rMiQWnv9a8qm3gxfngdHDTMT42wYupqJpIExId
|
||||||
force_update: true
|
force_update: true
|
||||||
@ -128,11 +127,10 @@ deploy:
|
|||||||
on:
|
on:
|
||||||
COMPILER: gcc
|
COMPILER: gcc
|
||||||
PLATFORM: "mingw64"
|
PLATFORM: "mingw64"
|
||||||
#appveyor_repo_tag: true
|
appveyor_repo_tag: true
|
||||||
|
|
||||||
- provider: GitHub
|
- provider: GitHub
|
||||||
artifact: bin\lz4_x86.zip
|
artifact: bin\lz4_x86.zip
|
||||||
release: lz4_x86-v$(appveyor_build_version)
|
|
||||||
auth_token:
|
auth_token:
|
||||||
secure: w6UJaGie0qbZvffr/fqyhO/Vj8rMiQWnv9a8qm3gxfngdHDTMT42wYupqJpIExId
|
secure: w6UJaGie0qbZvffr/fqyhO/Vj8rMiQWnv9a8qm3gxfngdHDTMT42wYupqJpIExId
|
||||||
force_update: true
|
force_update: true
|
||||||
@ -140,4 +138,4 @@ deploy:
|
|||||||
on:
|
on:
|
||||||
COMPILER: gcc
|
COMPILER: gcc
|
||||||
PLATFORM: "mingw32"
|
PLATFORM: "mingw32"
|
||||||
#appveyor_repo_tag: true
|
appveyor_repo_tag: true
|
||||||
|
@ -11,6 +11,19 @@ The static and dynamic LZ4 libraries
|
|||||||
- `static\liblz4_static.lib` : The static LZ4 library
|
- `static\liblz4_static.lib` : The static LZ4 library
|
||||||
|
|
||||||
|
|
||||||
|
#### Usage of Command Line Interface
|
||||||
|
|
||||||
|
Command Line Interface (CLI) supports gzip-like arguments.
|
||||||
|
By default CLI takes an input file and compresses it to an output file:
|
||||||
|
```
|
||||||
|
Usage: lz4 [arg] [input] [output]
|
||||||
|
```
|
||||||
|
The full list of commands for CLI can be obtained with `-h` or `-H`.
|
||||||
|
The ratio can be improved with commands from `-3` to `-16` but higher levels also have slower compression.
|
||||||
|
CLI supports aggregation of parameters i.e. `-b1`, `-e18`, and `-i1` can be joined into `-b1e18i1`.
|
||||||
|
CLI includes in-memory compression benchmark module with compression levels starting from `-b` and ending with `-e` with iteration time of `-i` seconds.
|
||||||
|
|
||||||
|
|
||||||
#### The example of usage of static and dynamic LZ4 libraries with gcc/MinGW
|
#### The example of usage of static and dynamic LZ4 libraries with gcc/MinGW
|
||||||
|
|
||||||
Use `cd example` and `make` to build `fullbench-dll` and `fullbench-lib`.
|
Use `cd example` and `make` to build `fullbench-dll` and `fullbench-lib`.
|
||||||
|
@ -21,7 +21,7 @@ It makes benchmark more precise as it eliminates I/O overhead.
|
|||||||
|
|
||||||
The benchmark measures ratio, compressed size, compression and decompression speed.
|
The benchmark measures ratio, compressed size, compression and decompression speed.
|
||||||
One can select compression levels starting from `-b` and ending with `-e`.
|
One can select compression levels starting from `-b` and ending with `-e`.
|
||||||
The `-i` parameter selects a number of iterations used for each of tested levels.
|
The `-i` parameter selects a number of seconds used for each of tested levels.
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
@ -39,6 +39,7 @@ Arguments :
|
|||||||
-d : decompression (default for .lz4 extension)
|
-d : decompression (default for .lz4 extension)
|
||||||
-z : force compression
|
-z : force compression
|
||||||
-f : overwrite output without prompting
|
-f : overwrite output without prompting
|
||||||
|
--rm : remove source file(s) after successful de/compression
|
||||||
-h/-H : display help/long help and exit
|
-h/-H : display help/long help and exit
|
||||||
|
|
||||||
Advanced arguments :
|
Advanced arguments :
|
||||||
@ -48,18 +49,20 @@ Advanced arguments :
|
|||||||
-c : force write to standard output, even if it is the console
|
-c : force write to standard output, even if it is the console
|
||||||
-t : test compressed file integrity
|
-t : test compressed file integrity
|
||||||
-m : multiple input files (implies automatic output filenames)
|
-m : multiple input files (implies automatic output filenames)
|
||||||
|
-r : operate recursively on directories (sets also -m)
|
||||||
-l : compress using Legacy format (Linux kernel compression)
|
-l : compress using Legacy format (Linux kernel compression)
|
||||||
-B# : Block size [4-7](default : 7)
|
-B# : Block size [4-7] (default : 7)
|
||||||
-BD : Block dependency (improve compression ratio)
|
-BD : Block dependency (improve compression ratio)
|
||||||
--no-frame-crc : disable stream checksum (default:enabled)
|
--no-frame-crc : disable stream checksum (default:enabled)
|
||||||
--content-size : compressed frame includes original size (default:not present)
|
--content-size : compressed frame includes original size (default:not present)
|
||||||
--[no-]sparse : sparse mode (default:enabled on file, disabled on stdout)
|
--[no-]sparse : sparse mode (default:enabled on file, disabled on stdout)
|
||||||
Benchmark arguments :
|
|
||||||
Benchmark arguments :
|
Benchmark arguments :
|
||||||
-b# : benchmark file(s), using # compression level (default : 1)
|
-b# : benchmark file(s), using # compression level (default : 1)
|
||||||
-e# : test all compression levels from -bX to # (default: 1)
|
-e# : test all compression levels from -bX to # (default : 1)
|
||||||
-i# : iteration loops [1-9](default : 3), benchmark mode only
|
-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
|
#### License
|
||||||
|
|
||||||
|
Loading…
Reference in New Issue
Block a user