README

   1
   2                         X-Diff  Version 0.9.6
   3
   4 What is it?
   5 -----------
   6
   7 X-Diff is a tool for detecting difference between two XML documents.
   8
   9
  10 Documentation
  11 -------------
  12
  13 The core algorithm of X-Diff is described in the paper, "X-Diff: An
  14 Efficient Change Detection Algorithm for XML Documents", ICDE 2003.
  15 (http://www.cs.wisc.edu/~yuanwang/research/xdiff.pdf).
  16
  17
  18 Installation
  19 ------------
  20
  21 -- Java version:
  22
  23 Required: Xerces Java v1.4.0+.
  24
  25 On UNIX/LINUX,
  26
  27         tar zxf xdiff-j-0.9.6.tar.gz
  28         cd X-Diff
  29         make
  30
  31 On Windows,
  32
  33         unzip xdiff-j-0.9.6.zip
  34         cd X-Diff
  35         make.bat
  36
  37 -- C++ version
  38
  39 Required: Xerces C++ v1.4.0, g++ v2.9.*
  40
  41         tar zxf xdiff-j-0.9.6.tar.gz
  42         cd X-Diff
  43         make
  44
  45
  46 Running X-Diff
  47 --------------
  48
  49 java XDiff [-o|-g] [-p percent] xml_file1 xml_file2 result_file
  50
  51 or,
  52
  53 xdiff [-o|-g] [-p percent] xml_file1 xml_file2 result_file
  54
  55 Options:
  56
  57         The default mode is "-o -p 0.3".
  58
  59   -o    The optimal mode, to get the diff result with minimum editing
  60         distance.
  61
  62   -g    The greedy mode, to get a diff result quickly, the result may not
  63         be "optimal".
  64
  65   -p    The maximum change percentage allowed. X-Diff will not try to match
  66         nodes that are much different from each other.
  67
  68
  69 Bug Reporting
  70 -------------
  71
  72 Please report any bugs or send your comments to Yuan Wang at
  73 yuanwang@cs.wisc.edu
  74
  75
  76 Copyright Information
  77 ---------------------
  78
  79 X-Diff is an open source product, which open source license permits you to
  80 use X-Diff at no charge under the condition that if you use the software in
  81 an application you redistribute, the complete source code for your application
  82 must be available and freely redistributable under reasonable conditions.
  83 If you do not want to release the source code for your application, you may
  84 purchase a license from me.
  85
  86
  87
  88 Copyright (c) 2001 - 2005
  89         Yuan Wang. All rights reserved.
  90
  91 Redistribution and use in source and binary forms, with or without
  92 modification, are permitted provided that the following conditions
  93 are met:
  94 1. Redistributions of source code must retain the above copyright notice,
  95 this list of conditions and the following disclaimer.
  96 2. Redistributions in binary form must reproduce the above copyright
  97 notice, this list of conditions and the following disclaimer in the
  98 documentation and/or other materials provided with the distribution.
  99 3. Redistributions in any form must be accompanied by information on
 100 how to obtain complete source code for the X-Diff software and any
 101 accompanying software that uses the X-Diff software.  The source code
 102 must either be included in the distribution or be available for no
 103 more than the cost of distribution plus a nominal fee, and must be
 104 freely redistributable under reasonable conditions.  For an executable
 105 file, complete source code means the source code for all modules it
 106 contains.  It does not include source code for modules or files that
 107 typically accompany the major components of the operating system on
 108 which the executable file runs.
 109
 110 THIS SOFTWARE IS PROVIDED BY YUAN WANG "AS IS" AND ANY EXPRESS OR IMPLIED
 111 WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
 112 MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE, OR NON-INFRINGEMENT,
 113 ARE DISCLAIMED.  IN NO EVENT SHALL YUAN WANG BE LIABLE FOR ANY DIRECT,
 114 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
 115 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
 116 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
 117 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
 118 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
 119 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
 120 POSSIBILITY OF SUCH DAMAGE.
 121