1\"
2\" lz4.1: This is a manual page for 'lz4' program. This file is part of the
3\" lz4 <https://code.google.com/p/lz4/> project.
4\"
5
6\" No hyphenation
7.hy 0
8.nr HY 0
9
10.TH lz4 "1" "2014-02-27" "lz4" "User Commands"
11.SH NAME
12\fBlz4\fR - Extremely fast compression algorithm
13
14.SH SYNOPSIS
15.TP 5
16\fBlz4\fR [\fBOPTIONS\fR] [-|INPUT-FILE] <OUTPUT-FILE>
17
18.SH DESCRIPTION
19.PP
20\fBlz4\fR is an extremely fast lossless compression algorithm. It is based on
21the \fBLZ77\fR family of compression scheme. At the compression speed of 400
22MB/s per core, \fBlz4\fR is also scalable with multi-core CPUs. It features
23an extremely fast decoder, with speed in multiple GB/s per core, typically
24reaching the RAM speed limits on multi-core systems. \fBlz4\fR supports
25following options
26
27.SH OPTIONS
28.TP
29.B \-1
30 fast compression (default)
31.TP
32.B \-9
33 high compression
34.TP
35.B \-d
36 decompression
37.TP
38.B \-f
39 overwrite output without prompting
40.TP
41.B \-h/\-H
42 display help/long help and exit
43.TP
44.B \-V
45 display Version number and exit
46.TP
47.B \-v
48 verbose mode
49.TP
50.B \-q
51 suppress warnings; specify twice to suppress errors too
52.TP
53.B \-c
54 force write to standard output, even if it is the console
55.TP
56.B \-t
57 test compressed file integrity
58.TP
59.B \-z
60 force compression
61.TP
62.B \-l
63 use Legacy format (useful for Linux Kernel compression)
64.TP
65.B \-B#
66 block size [4-7](default : 7)
67 B4= 64KB ; B5= 256KB ; B6= 1MB ; B7= 4MB
68.TP
69.B \-BD
70 block dependency (improve compression ratio)
71.TP
72.B \-BX
73 enable block checksum (default:disabled)
74.TP
75.B \-Sx
76 disable stream checksum (default:enabled)
77.TP
78.B \-b
79 benchmark file(s)
80.TP
81.B \-i#
82 iteration loops [1-9](default : 3), benchmark mode only
83
84.SH BUGS
85Report bugs at:- https://code.google.com/p/lz4/
86
87.SH AUTHOR
88Yann Collet
89