aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorNarayan Kamath <narayan@google.com>2013-03-01 10:03:55 +0000
committerNarayan Kamath <narayan@google.com>2013-03-01 10:21:01 +0000
commit0a58c5c2f73e5047b36f12b5f12b12d6f2a9f69d (patch)
tree8514c70c3fe2d6d59ec2a77eb2d5404d54bea550 /README
parentee3c14f87acd9a5c55e0b7953a995064ee0337bf (diff)
downloadopen-vcdiff-0a58c5c2f73e5047b36f12b5f12b12d6f2a9f69d.tar.gz
Import open-vcdiff 0.8.3
This is an unmodified copy of the source code tar at: https://open-vcdiff.googlecode.com/files/open-vcdiff-0.8.3.tar.gz Change-Id: I3f7afa389e773a18adba3a83c6e0ea9ba7f0763b
Diffstat (limited to 'README')
-rw-r--r--README43
1 files changed, 43 insertions, 0 deletions
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 <google/vcencoder.h> // 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 <google/vcdecoder.h> // 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
+