From 311c71486f5f6074e5ba62a7f4c5397c8700b868 Mon Sep 17 00:00:00 2001 From: openvcdiff Date: Tue, 26 Aug 2008 19:29:25 +0000 Subject: Mon, 16 Jun 2008 15:15:51 -0700 Google Inc. * open-vcdiff: initial release: The open-vcdiff package provides an encoder and decoder for the VCDIFF format described in RFC 3284 (http://www.ietf.org/rfc/rfc3284.txt). git-svn-id: http://open-vcdiff.googlecode.com/svn/trunk@7 132ac840-3546-0410-a738-d3f8764196be --- README | 43 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 43 insertions(+) create mode 100644 README (limited to 'README') diff --git a/README b/README new file mode 100644 index 0000000..c67823b --- /dev/null +++ b/README @@ -0,0 +1,43 @@ +open-vcdiff is an encoder and decoder for the VCDIFF format, as described in +RFC 3284 : The VCDIFF Generic Differencing and Compression Data Format +(http://www.ietf.org/rfc/rfc3284.txt) +A library with a simple API is included, as well as a command-line executable +that can apply the encoder and decoder to source, target, and delta files. +For further details, please refer to: +http://code.google.com/p/open-vcdiff/wiki/HowToUseOpenVcdiff + +See INSTALL for (generic) installation instructions for C++: basically + ./configure && make && make install + +This should compile the unit tests as well as "vcdiff", a simple command-line +utility to run the encoder and decoder. Typical usage of vcdiff is as follows +(the "<" and ">" are file redirect operations, not optional arguments): + vcdiff encode -dictionary file.dict < target_file > delta_file + vcdiff decode -dictionary file.dict < delta_file > target_file +To see the command-line syntax of vcdiff, use "vcdiff --help" or just "vcdiff". + +To call the encoder from C++ code, assuming that dictionary, target, and delta +are all std::string objects: +#include // Read this file for interface details +[...] + open_vcdiff::VCDiffEncoder encoder(dictionary.data(), dictionary.size()); + encoder.SetFormatFlags(open_vcdiff::VCD_FORMAT_INTERLEAVED); + encoder.Encode(target.data(), target.size(), &delta); + +Calling the decoder is just as simple: +#include // Read this file for interface details +[...] + open_vcdiff::VCDiffDecoder decoder; + decoder.Decode(dictionary.data(), dictionary.size(), delta, &target); + +When using the encoder, the C++ application must be linked with the library +options -lvcdcom and -lvcdenc; when using the decoder, it must be linked with +-lvcdcom and -lvcddec. + +To verify that the package works on your system, especially after making +modifications to the source code, please run the unit tests using + make check + +For further details, please refer to: +http://code.google.com/p/open-vcdiff/wiki/HowToUseOpenVcdiff + -- cgit v1.2.3