ZXC documentation
This documentation describes ZXC 0.15.0. It is generated from the docs/ directory of the source repository, so it always matches the released code. If you are new to ZXC, start with the quick start and then the examples.
Guides
- Whitepaper
- Why an asymmetric codec, how the bitstream is laid out, and where the speed comes from.
- Examples
- Complete programs for the buffer, stream, context, seekable and dictionary APIs.
- Integration
- Vendoring ZXC, building as a subproject, and embedding it in another build.
- Migration
- Upgrading between releases and converting archives across format versions.
Reference
- API reference
- Every public function, type, constant and error code, with ABI rules.
- CLI manual
- The zxc(1) manual page: modes, options, exit codes.
- Format specification
- The on-disk wire format, precise enough to write an independent decoder.
- Doxygen reference
- Generated from the headers and sources: every symbol with its documentation and source, searchable.
Project
- Changelog
- What changed in each release.