tools/vbindiff/README.md

   1 VBinDiff - Visual Binary Diff
   2 =============================
   3
   4 [Visual Binary Diff (VBinDiff)](http://www.cjmweb.net/vbindiff/) displays files in hexadecimal and ASCII (or EBCDIC).  It can also display two files at once, and highlight the differences between them.  Unlike diff, it works well with large files (up to 4 GB).
   5
   6 VBinDiff was inspired by the Compare Files function of the [ProSel utilities by Glen Bredon](http://www.apple2.org.za/gswv/USA2WUG/Glen.Bredon.In.Memoriam/A2.Software/), for the [Apple II](https://en.wikipedia.org/wiki/Apple_II).  When I couldn't find a similar utility for the PC, I wrote it myself.
   7
   8 The single-file mode was inspired by the LIST utility of [4DOS and friends](http://jpsoft.com/take-command-windows-scripting.html).  While [less](http://www.greenwoodsoftware.com/less/) provides a good line-oriented display, it has no equivalent to LIST's hex display.  (True, you can pipe the file through [hexdump](http://linux.die.net/man/1/hexdump), but that's incredibly inefficient on multi-gigabyte files.)
   9
  10
  11 Working with This Repository
  12 ----------------------------
  13
  14 This repository uses a submodule to pull in my [Free GetOpt](https://github.com/madsen/free-getopt) package, which makes it a bit trickier to get started with than the average Git repository.  Here's how to get started.
  15
  16 1. Clone this repository and `cd` into it.
  17 2. Run `git submodule update --init`
  18 3. If you're working on a Unix system, run `autoreconf -i`
  19
  20 Now you're ready to use the normal `./configure && make` process on Unix, or open `win32/vbindiff.dsw` on Windows.
  21
  22 To build the documentation, you'll also need [Perl](http://www.perl.org/), [Date::Format](https://metacpan.org/module/Date::Format), and [Template-Toolkit](https://metacpan.org/release/Template-Toolkit).  For Windows, I recommend [Strawberry Perl](http://strawberryperl.com/), which comes with the necessary modules.  On Unix, your distro may have packages, or you can install from [CPAN](http://www.cpan.org/).  Package names for some distros are:
  23
  24 * [Arch Linux](https://www.archlinux.org/): `perl perl-template-toolkit perl-timedate`
  25 * [Gentoo Linux](http://www.gentoo.org/): `dev-lang/perl dev-perl/Template-Toolkit dev-perl/TimeDate`
  26 * [Ubuntu](http://www.ubuntu.com/): `perl libtemplate-perl libtimedate-perl`
  27
  28 If you're developing on Unix, I suggest you also `cp -a tools/post-commit .git/hooks/`.  That hook will touch `configure.ac` after each commit that modifies it, causing `configure` to be regenerated and making `AC_REVISION` reflect the new commit.
  29
  30
  31 Copyright and License
  32 ---------------------
  33
  34 Visual Binary Diff is copyright 1995-2013 by Christopher J. Madsen
  35
  36 This program is free software; you can redistribute it and/or modify it under the terms of the [GNU General Public License](http://www.gnu.org/licenses/gpl.html) as published by the Free Software Foundation; either [version 2 of the License](http://www.gnu.org/licenses/old-licenses/gpl-2.0.html), or (at your option) any later version.
  37
  38 This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License for more details.