aboutsummaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorEugene Kliuchnikov <eustas@google.com>2017-08-04 10:02:56 +0200
committerGitHub <noreply@github.com>2017-08-04 10:02:56 +0200
commitd63e8f75f5c16a6d7c8308bfd28c43cbdb6ad390 (patch)
tree9fd22d0e842c81ed36c561107c6f3196fd915855 /docs
parent06082531107d666ba44bb4dc341970a0916ef587 (diff)
downloadbrotli-d63e8f75f5c16a6d7c8308bfd28c43cbdb6ad390.zip
brotli-d63e8f75f5c16a6d7c8308bfd28c43cbdb6ad390.tar.gz
brotli-d63e8f75f5c16a6d7c8308bfd28c43cbdb6ad390.tar.bz2
Update API, and more (#581)
Update API, and more: * remove "custom dictionary" support * c/encoder: fix #580: big-endian build * Java: reduce jar size * Java: speedup decoding * Java: add 32-bit CPU support * Java: make source code JS transpiler-ready
Diffstat (limited to 'docs')
-rwxr-xr-xdocs/brotli.16
-rwxr-xr-xdocs/decode.h.342
-rwxr-xr-xdocs/encode.h.339
-rwxr-xr-xdocs/types.h.32
4 files changed, 4 insertions, 85 deletions
diff --git a/docs/brotli.1 b/docs/brotli.1
index b755e67..c55b906 100755
--- a/docs/brotli.1
+++ b/docs/brotli.1
@@ -1,4 +1,4 @@
-.TH "BROTLI" "1" "May 2017" "brotli 1.0.0" "User commands"
+.TH "BROTLI" "1" "August 2017" "brotli 1.0.0" "User commands"
.SH "NAME"
\fBbrotli\fR \- brotli, unbrotli \- compress or decompress files
.SH SYNOPSIS
@@ -108,10 +108,6 @@ Conflicting or duplicate \fIoptions\fR are not allowed\.
windows size improve density; decoder might require up to window size
memory to operate
.IP \(bu 2
-\fB\-D FILE\fP, \fB\-\-dictionary=FILE\fP:
- use FILE as LZ77 dictionary; same dictionary MUST be used both for
- compression and decompression
-.IP \(bu 2
\fB\-S SUF\fP, \fB\-\-suffix=SUF\fP:
output file suffix (default: \fB\|\.br\fP)
.IP \(bu 2
diff --git a/docs/decode.h.3 b/docs/decode.h.3
index 447c67b..965d07f 100755
--- a/docs/decode.h.3
+++ b/docs/decode.h.3
@@ -1,4 +1,4 @@
-.TH "decode.h" 3 "Tue Jun 13 2017" "Brotli" \" -*- nroff -*-
+.TH "decode.h" 3 "Wed Aug 2 2017" "Brotli" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -72,10 +72,6 @@ decode.h \- API for Brotli decompression\&.
.br
.RI "\fIChecks if instance has already consumed input\&. \fP"
.ti -1c
-.RI "void \fBBrotliDecoderSetCustomDictionary\fP (\fBBrotliDecoderState\fP *state, size_t size, const uint8_t dict[size])"
-.br
-.RI "\fIPrepends LZ77 dictionary\&. \fP"
-.ti -1c
.RI "\fBBROTLI_BOOL\fP \fBBrotliDecoderSetParameter\fP (\fBBrotliDecoderState\fP *state, \fBBrotliDecoderParameter\fP param, uint32_t value)"
.br
.RI "\fISets the specified parameter to the given decoder instance\&. \fP"
@@ -346,42 +342,6 @@ Checks if instance has already consumed input\&. Instance that returns \fBBROTLI
.RE
.PP
-.SS "void BrotliDecoderSetCustomDictionary (\fBBrotliDecoderState\fP * state, size_t size, const uint8_t dict[size])"
-
-.PP
-Prepends LZ77 dictionary\&. Fills the fresh \fBBrotliDecoderState\fP with additional data corpus for LZ77 backward references\&.
-.PP
-\fBNote:\fP
-.RS 4
-Not to be confused with the static dictionary (see RFC7932 section 8)\&.
-.RE
-.PP
-\fBWarning:\fP
-.RS 4
-The dictionary must exist in memory until decoding is done and is owned by the caller\&.
-.RE
-.PP
-Workflow:
-.IP "1." 4
-Allocate and initialize state with \fBBrotliDecoderCreateInstance\fP
-.IP "2." 4
-Invoke \fBBrotliDecoderSetCustomDictionary\fP
-.IP "3." 4
-Use \fBBrotliDecoderDecompressStream\fP
-.IP "4." 4
-Clean up and free state with \fBBrotliDecoderDestroyInstance\fP
-.PP
-.PP
-\fBParameters:\fP
-.RS 4
-\fIstate\fP decoder instance
-.br
-\fIsize\fP length of \fCdict\fP; should be less or equal to 2^24 (16MiB), otherwise the dictionary will be ignored
-.br
-\fIdict\fP 'dictionary'; \fBMUST\fP be the same as used during compression
-.RE
-.PP
-
.SS "\fBBROTLI_BOOL\fP BrotliDecoderSetParameter (\fBBrotliDecoderState\fP * state, \fBBrotliDecoderParameter\fP param, uint32_t value)"
.PP
diff --git a/docs/encode.h.3 b/docs/encode.h.3
index 51570b7..01b4f4f 100755
--- a/docs/encode.h.3
+++ b/docs/encode.h.3
@@ -1,4 +1,4 @@
-.TH "encode.h" 3 "Tue Feb 28 2017" "Brotli" \" -*- nroff -*-
+.TH "encode.h" 3 "Wed Aug 2 2017" "Brotli" \" -*- nroff -*-
.ad l
.nh
.SH NAME
@@ -100,10 +100,6 @@ encode.h \- API for Brotli compression\&.
.br
.RI "\fICalculates the output size bound for the given \fCinput_size\fP\&. \fP"
.ti -1c
-.RI "void \fBBrotliEncoderSetCustomDictionary\fP (\fBBrotliEncoderState\fP *state, size_t size, const uint8_t dict[size])"
-.br
-.RI "\fIPrepends imaginary LZ77 dictionary\&. \fP"
-.ti -1c
.RI "\fBBROTLI_BOOL\fP \fBBrotliEncoderSetParameter\fP (\fBBrotliEncoderState\fP *state, \fBBrotliEncoderParameter\fP param, uint32_t value)"
.br
.RI "\fISets the specified parameter to the given encoder instance\&. \fP"
@@ -482,39 +478,6 @@ Result is not applicable to \fBBrotliEncoderCompressStream\fP output, because ev
.RE
.PP
-.SS "void BrotliEncoderSetCustomDictionary (\fBBrotliEncoderState\fP * state, size_t size, const uint8_t dict[size])"
-
-.PP
-Prepends imaginary LZ77 dictionary\&. Fills the fresh \fBBrotliEncoderState\fP with additional data corpus for LZ77 backward references\&.
-.PP
-\fBNote:\fP
-.RS 4
-Not to be confused with the static dictionary (see RFC7932 section 8)\&.
-.RE
-.PP
-Workflow:
-.IP "1." 4
-Allocate and initialize state with \fBBrotliEncoderCreateInstance\fP
-.IP "2." 4
-Set \fBBROTLI_PARAM_LGWIN\fP parameter
-.IP "3." 4
-Invoke \fBBrotliEncoderSetCustomDictionary\fP
-.IP "4." 4
-Use \fBBrotliEncoderCompressStream\fP
-.IP "5." 4
-Clean up and free state with \fBBrotliEncoderDestroyInstance\fP
-.PP
-.PP
-\fBParameters:\fP
-.RS 4
-\fIstate\fP encoder instance
-.br
-\fIsize\fP length of \fCdict\fP; at most 'window size' bytes are used
-.br
-\fIdict\fP 'dictionary'; \fBMUST\fP use same dictionary during decompression
-.RE
-.PP
-
.SS "\fBBROTLI_BOOL\fP BrotliEncoderSetParameter (\fBBrotliEncoderState\fP * state, \fBBrotliEncoderParameter\fP param, uint32_t value)"
.PP
diff --git a/docs/types.h.3 b/docs/types.h.3
index 7dd8dc4..e72ae6e 100755
--- a/docs/types.h.3
+++ b/docs/types.h.3
@@ -1,4 +1,4 @@
-.TH "types.h" 3 "Tue Feb 28 2017" "Brotli" \" -*- nroff -*-
+.TH "types.h" 3 "Wed Aug 2 2017" "Brotli" \" -*- nroff -*-
.ad l
.nh
.SH NAME