1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
|
.TH BROTLI-RS 1
.SH NAME
brotli\-rs \- A brotli compressor and decompressor.
.SH SYNOPSIS
\fBbrotli\-rs\fR [FLAGS]
.SH DESCRIPTION
A brotli compressor and decompressor that with an interface avoiding the rust stdlib.
This makes it suitable for embedded devices and kernels. It is designed with a pluggable allocator so that
the standard lib's allocator may be employed. All included code is safe.
.SH FLAGS
.TP
\fB\-catable\fR, \fB\-\-catable\fR
Enable concatable mode, so that the generated data can be added to block generated with \-\-apendable
.TP
\fB\-nothreadpool\fR, \fB\-\-nothreadpool\fR
Disables the work thread pool
.TP
\fB\-appendable\fR, \fB\-\-appendable\fR
Enables apendable mode, so that the datastream can be extended with more data from the \-\-catable mode
.TP
\fB\-magic\fR, \fB\-\-magic\fR
Enables magic number as the first bytes, so that a brotli compressed stream can be easily detected
.TP
\fB\-customdictionary=[FILE]\fR
Reads a custom dictionare from file
.TP
\fB\-\-dump\-dictionary\fR
Prints the dictionary used
.TP
\fB\-utf8\fR
Forces the utf8 context mode in the compression
.TP
\fB\-msb\fR
Forces the msb context mode in the compression
.TP
\fB\-lsb\fR
Forces the lsb context mode in the compression
.TP
\fB\-signed\fR
Forces the signed context mode in the compression
.TP
\fB\-efficient\fR
favor cpu efficiency over low latency
.TP
\fB\-lowlatency\fR
favor cpu low latency over efficiency
.TP
\fB\-i\fR
display the intermediate representation of metablocks
.TP
\fB\-0\fR, \fB\-q0\fR
Sets quality = 0
.TP
\fB\-1\fR, \fB\-q1\fR
Sets quality = 1
.TP
\fB\-2\fR, \fB\-q2\fR
Sets quality = 2
.TP
\fB\-3\fR, \fB\-q3\fR
Sets quality = 3
.TP
\fB\-4\fR, \fB\-q4\fR
Sets quality = 4
.TP
\fB\-5\fR, \fB\-q5\fR
Sets quality = 5
.TP
\fB\-6\fR, \fB\-q6\fR
Sets quality = 6
.TP
\fB\-7\fR, \fB\-q7\fR
Sets quality = 7
.TP
\fB\-8\fR, \fB\-q8\fR
Sets quality = 8
.TP
\fB\-9\fR, \fB\-q9\fR
Sets quality = 9
.TP
\fB\-10\fR, \fB\-q10\fR
Sets quality = 10
.TP
\fB\-11\fR, \fB\-q11\fR
Sets quality = 11
.TP
\fB\-9.5\fR, \fB\-q9.5\fR
Sets quality = 10
.TP
\fB\-9.5x\fR, \fB\-q9.5x\fR
Sets quality = 11
.TP
\fB\-q9.5y\fR
Sets quality = 12
.TP
\fB\-l[NUMBER]\fR
Sets the input block size
.TP
\fB\-j[NUMBER]\fR
Sets maximum size of the threadpool
.TP
\fB\-bytescore=[NUMBER]\fR
Sets the literal_byte_score value of the hasher, default 0
.TP
\fB\-w[NUMBER]\fR
Sets the lgwin value, default 22
.TP
\fB\-validate\fR, \fB\-\-validate\fR
Enables validation
.TP
\fB\-bs[NUMBER]\fR
Sets the buffer size
.TP
\fB\-findprior\fR
Enables prior bitmask detection
.TP
\fB\-findspeed=[NUMBER]\fR
Sets cdf adaptation detection to [NUMBER]
.TP
\fB\-basicstride\fR
Sets stride
.TP
\fB\-stride\fR
Sets stride
.TP
\fB\-advstride\fR
Sets stride
.TP
\fB\-speed=[NUMBER]\fR
Sets speed
.TP
\fB\-avoiddistanceprefixsearch\fR
Avoids distance prefix search
.TP
\fB\-b[NUMBER]\fR
Does benchmark
.TP
\fB\-c\fR
Enables compression mode
.TP
\fB\-h\fR, \fB\-\-help\fR
Prints the help text
.SH EXIT STATUS
.TP
\fB0\fR
Successful program execution.
.TP
\fB1\fR
Unsuccessful program execution.
.TP
\fB101\fR
The program panicked.
.SH EXAMPLES
.TP
compresses the content of /tmp/input and writes it to /tmp/output
\fB$ brotli\-rs \-c /tmp/input /tmp/output\fR
.SH AUTHOR
.P
.RS 2
.nf
Daniel Reiter Horn <danielrh@dropbox.com>
|
