|Dictionary compression How To:
Create the dictionary
zstd --train FullPathToTrainingSet/* -o dictionaryName
Compress with dictionary
zstd -D dictionaryName FILE
Decompress with dictionary
zstd -D dictionaryName --decompress FILE.zst
If your system is compatible with standard
make in root directory will generate
zstd cli in root directory.
Other available options include:
make install : create and install zstd cli, library and man pages
make check : create and run
zstd, tests its behavior on local platform
cmake project generator is provided within
It can generate Makefiles or other build scripts
zstd binary, and
libzstd dynamic and static libraries.
CMAKE_BUILD_TYPE is set to
A Meson project is provided within
build instructions in that directory.
You can also take a look at
.travis.yml file for an
example about how Meson is used to build this project.
Note that default build type is release.
You can build and install zstd vcpkg dependency manager:
git clone https://github.com/Microsoft/vcpkg.git
./vcpkg integrate install
./vcpkg install zstd
The zstd port in vcpkg is kept up to date by Microsoft team members and community contributors.
If the version is out of date, please create an issue or pull request on the vcpkg repository.
Visual Studio (Windows)
build directory, you will find additional possibilities:
- Projects for Visual Studio 2005, 2008 and 2010.
- VS2010 project is compatible with VS2012, VS2013, VS2015 and VS2017.
- Automated build scripts for Visual compiler by @KrzysFR, in
which will build
zstd cli and
libzstd library without any need to open Visual Studio solution.
You can build the zstd binary via buck by executing:
buck build programs:zstd from the root of the repo.
The output binary will be in
Zstandard is currently deployed within Facebook. It is used continuously to compress large amounts of data in multiple formats and use cases.
Zstandard is considered safe for production environments.
Zstandard is dual-licensed under BSD and GPLv2.
The "dev" branch is the one where all contributions are merged before reaching "master".
If you plan to propose a patch, please commit into the "dev" branch, or its own feature branch.
Direct commit to "master" are not permitted.
For more information, please read CONTRIBUTING.