home *** CD-ROM | disk | FTP | other *** search
/ Geek Gadgets 1 / ADE-1.bin / ade-dist / wdiff-0.5-src.tgz / tar.out / fsf / wdiff / README < prev    next >
Text File  |  1996-09-28  |  5KB  |  129 lines
  1. `wdiff' is a front-end to GNU `diff'.  It compares two files, finding
  2. which words have been deleted or added to the first in order to create
  3. the second.  It has many output formats and interacts well with
  4. terminals and pagers (notably with `less').  `wdiff' is particularily
  5. useful when two texts differ only by a few words and paragraphs have
  6. been refilled.
  7.  
  8. GNU `wdiff' has been written by Franc,ois Pinard.  It is an evolving
  9. product, and specifications might change in future releases.
  10.  
  11. Below, you will find various installation hints on special systems.
  12. Look further down for a mini-FAQ (frequently asked questions).
  13.  
  14. See file `BACKLOG' for a summary of pending mail and articles.
  15. See file `COPYING' for copying conditions.
  16. See file `INSTALL' for compilation and installation instructions.
  17. See file `NEWS' for a list of major changes in the current release.
  18. See file `THANKS' for a list of contributors.
  19.  
  20. Your feedback will help us to make a better and more portable
  21. product.  Mail suggestions and bug reports (including documentation
  22. errors) for this program to `bug-gnu-utils@prep.ai.mit.edu'.
  23.  
  24. .-------.
  25. | Hints |
  26. `-------'
  27.  
  28. Here are a few hints which might help installing `wdiff' on some
  29. systems.  Most may be applied by temporary presetting environment
  30. variables while calling `./configure'.  File `INSTALL' explains this.
  31.  
  32. * This program does not require termcap, but takes advantage of it
  33. when it is available.  You may want to get and install GNU termcap
  34. first from /@prep.ai.mit.edu:pub/gnu/termcap-1.2.tar.gz, or better.
  35.  
  36. * If you have termcap emulation routines in libcurses.a and you do not
  37. have libtermcap.a, and until I find a way to do better, please use:
  38.  
  39.     LIBS=-lcurses ./configure
  40.  
  41. * If you have both more and less and you prefer more over less, then
  42. prefix the call to configure with your pager selection, as in:
  43.  
  44.     PAGER=more ./configure
  45.  
  46. * There is a simple minded change bars producer in `wdiff', which is
  47. not installed by default, nor documented.  If you nevertheles want
  48. it, one way to get it is requesting, at configure time:
  49.  
  50.     ./configure --enable-cbars
  51.  
  52. .-----.
  53. | FAQ |
  54. `-----'
  55.  
  56. Finally, here is a kind of FAQ for `wdiff', made up of replies I
  57. wrote many times for questions received over email.
  58.  
  59. Q: How is `wdiff' different from `diff -w'?
  60.  
  61.    `wdiff' finds word differences, ignoring spaces, tabs and
  62.    newlines, while `diff -w' finds *line* differences, ignoring
  63.    spaces and tabs.  Also, each program uses its own output format.
  64.  
  65. Q: Why not simply apply `diff' to files split one word per line?
  66.  
  67.    You like the way `wdiff' formats its output.  And it's speedier too.
  68.  
  69. Q: Why calling an external `diff'?  Could not diff be built in `wdiff'?
  70.  
  71.    It's not fruitful to rewrite another `diff'.  I'd rather see
  72.    `wdiff' integrated in GNU `diff' than the other way around.
  73.    When `wdiff' will have matured enough, it *might* be integrated
  74.    into GNU `diff' distribution, or in GNU `diff' itself.
  75.  
  76.    Many user requests for additions to `wdiff' have been postponed
  77.    until `wdiff' is integrated in `diff'.  However, for the time
  78.    being, the integration project has been put on the back burner.
  79.  
  80. Q: How about `spiff' by Dan Nachbar <nachbar@bellcore.com>?
  81.  
  82.    `spiff' is far more general than `wdiff'.  On the other end,
  83.    `wdiff' is a lot faster, needs almost no memory, and can afford
  84.    handling big files in reasonnable time.  Despite its lack of
  85.    generality, `wdiff' does one of the most usual jobs, so it
  86.    is quite useful after all.  I might try retrofitting some of
  87.    `spiff' features into `wdiff', but not on short term.
  88.  
  89. Q: How do I get to `wdiff' documentation?
  90.  
  91.    There are many ways:
  92.  
  93.    1) Calling just `wdiff', without arguments, will summarize
  94.    its usage.
  95.  
  96.    2) You can look at the file `wdiff.info' using any ASCII editor,
  97.    or even print the file as is.
  98.  
  99.    3) If properly installed, you may browse `wdiff.info' from
  100.    inside GNU Emacs by typing the command:
  101.  
  102.     C-u M-x info RET wdiff.info RET   .
  103.  
  104.    4) With the standalone Info reader, use `info -f wdiff.info'.
  105.    You can find the standalone info reader in file texinfo-3.?.tar.gz
  106.    in /pub/gnu from prep.ai.mit.edu: just unpack it and look into
  107.    the C subdirectory.
  108.  
  109.    5) If you have TeX, execute the command `make dvi' then
  110.    process and print `wdiff.dvi' the usual way.
  111.  
  112.    6) Colin Brough <cmb@epcc.ed.ac.uk> contributed a man page,
  113.    describing `wdiff' at level 0.04.  The man page will be
  114.    distributed and installed along with `wdiff' as long as Colin
  115.    will want to maintain it.
  116.  
  117. Q: Can we use `wdiff' from within GNU Emacs?
  118.  
  119.    Of course.  You might be loosing some output features.  James
  120.    Ganong <jeg@ced.berkeley.edu> wrote `collatew.el', generalizing
  121.    the Emacs LISP compare-windows function in the spirit of `wdiff'.
  122.  
  123. Q: How much memory `wdiff' exactly needs?
  124.  
  125.    `wdiff' uses a fixed amount of memory.  Long lines or long files
  126.    are no handicap.  All the true work is done by `diff' under the
  127.    scene, and `diff' needs memory itself.  GNU `diff' swallows both
  128.    files in memory first.
  129.