diff options
| author | Todd Short <tshort@akamai.com> | 2021-08-09 16:56:37 -0400 |
|---|---|---|
| committer | Todd Short <todd.short@me.com> | 2022-10-18 09:30:21 -0400 |
| commit | caf9317d7d75213990014e07048384be15688889 (patch) | |
| tree | 50cf59d363c17f389d6c8dbc2372795e3e53658d /INSTALL.md | |
| parent | 12e96a23604a7aa1cd8f83486b02f1bcab6d468f (diff) | |
Add ZSTD compression support (RFC8478bis)
Reviewed-by: Matt Caswell <matt@openssl.org>
Reviewed-by: Hugo Landau <hlandau@openssl.org>
(Merged from https://github.com/openssl/openssl/pull/18186)
Diffstat (limited to 'INSTALL.md')
| -rw-r--r-- | INSTALL.md | 37 |
1 files changed, 37 insertions, 0 deletions
diff --git a/INSTALL.md b/INSTALL.md index 234f39c201..fdd234fa57 100644 --- a/INSTALL.md +++ b/INSTALL.md @@ -440,6 +440,32 @@ then this flag is optional and defaults to `ZLIB1` if not provided. This flag is optional and if not provided then `GNV$LIBZSHR`, `GNV$LIBZSHR32` or `GNV$LIBZSHR64` is used by default depending on the pointer size chosen. +### with-zstd-include + + --with-zstd-include=DIR + +The directory for the location of the Zstd include file. This option is only +necessary if [enable-std](#enable-zstd) is used and the include file is not +already on the system include path. + +OpenSSL requires Zstd 1.4 or greater. The Linux kernel source contains a +*zstd.h* file that is not compatible with the 1.4.x Zstd distribution, the +compilation will generate an error if the Linux *zstd.h* is included before +(or instead of) the Zstd distribution header. + +### with-zstd-lib + + --with-zstd-lib=LIB + +**On Unix**: this is the directory containing the Zstd library. +If not provided the system library path will be used. + +**On Windows:** this is the filename of the Zstd library (with or +without a path). This flag must be provided if the +[enable-zstd-dynamic](#enable-zstd-dynamic) option is not also used. +If `zstd-dynamic` is used then this flag is optional and defaults +to `LIBZSTD` if not provided. + Seeding the Random Generator ---------------------------- @@ -1014,6 +1040,17 @@ when needed. This is only supported on systems where loading of shared libraries is supported. +### enable-zstd + +Build with support for Zstd compression/decompression. + +### enable-zstd-dynamic + +Like the enable-zstd option, but has OpenSSL load the Zstd library dynamically +when needed. + +This is only supported on systems where loading of shared libraries is supported. + ### 386 In 32-bit x86 builds, use the 80386 instruction set only in assembly modules |