A file format designed for highly efficient deltas while maintaining good compression
Branch: master
Clone or download
jdieter Bump to 1.0.3
Signed-off-by: Jonathan Dieter <jdieter@gmail.com>
Latest commit ce7195b Jan 24, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
autotest Switch up testing to allow separation of image creation and building Nov 14, 2018
contrib
include Add functions to get chunk number and get chunk by number Dec 2, 2018
src Fix off by one error Jan 24, 2019
test Bump to 1.0.3 Jan 24, 2019
.gitignore Switch up testing to allow separation of image creation and building Nov 14, 2018
DOCKER_TESTING.md Switch up testing to allow separation of image creation and building Nov 14, 2018
Jenkinsfile Update checkout to be generic Nov 14, 2018
LICENSE Update LICENSE and README Mar 7, 2018
README.md Add test to build instructions Nov 14, 2018
meson.build Bump to 1.0.3 Jan 24, 2019
meson_options.txt Add coverity flag to fix builds for coverity Sep 14, 2018
prep-Jenkinsfile Add zchunk image preparation Jenkinsfile Nov 14, 2018
zchunk_format.txt Add new checksum types and make clear that data excluded from the sig… Nov 19, 2018

README.md

zchunk

Coverity Scan Build Status
Jenkins Build Status

zchunk is a compressed file format that splits the file into independent chunks. This allows you to only download changed chunks when downloading a new version of the file, and also makes zchunk files efficient over rsync.

zchunk files are protected with strong checksums to verify that the file you downloaded is, in fact, the file you wanted.

zchunk-0.9.0 has been released with the proposed final ABI. Once zchunk-1.0 has been released, the ABI will be marked as stable, and the only allowed API/ABI and file format changes will be additions

Installation

To build and install zchunk, first install meson and run

meson build
cd build
ninja
ninja test
sudo ninja install

Using the utilities

To decompress a zchunk file, simply run:

unzck <filename>

To compress a new zchunk file, run:

zck <filename>

To download a zchunk file, run:

zckdl -s <source> <url of target>

To read a zchunk header, run:

zck_read_header <file>

C API

#TODO