diff options
Diffstat (limited to 'support/latexdiff/README')
| -rw-r--r-- | support/latexdiff/README | 55 |
1 files changed, 38 insertions, 17 deletions
diff --git a/support/latexdiff/README b/support/latexdiff/README index 6f4d1a280a..f0310ce32d 100644 --- a/support/latexdiff/README +++ b/support/latexdiff/README @@ -1,4 +1,13 @@ +latexdiff +========= + +Compares two latex files and marks up significant differences between them. Releases on https://ctan.org/pkg/latexdiff and mirrors. + +Link to full manual: http://mirrors.ctan.org/support/latexdiff/doc/latexdiff-man.pdf + + INTRODUCTION +------------ latexdiff is a Perl script, which compares two latex files and marks up significant differences between them (i.e. a diff for latex files). @@ -16,11 +25,9 @@ behaviour and accept or reject selected changes only. The author is F Tilmann. -Project webpage: https://github.com/ftilmann/latexdiff/ -CTAN page: http://www.ctan.org/pkg/latexdiff - REQUIREMENTS +------------ Perl 5.8 or higher must be installed. The latexdiff script makes use of the Perl package Algorithm::Diff (available @@ -38,6 +45,7 @@ UNIX-diff mean that the resulting set of differences will generally not be the s for the standard latexdiff. In most practical cases, these differences are minor, though. INSTALLATION UNIX/LINUX +----------------------- The basic installation procedure is almost trivial: @@ -53,34 +61,40 @@ The basic installation procedure is almost trivial: The attached trivial Makefile contains example commands to carry out above steps as root for a typical UNIX installation. Type - make install (for the stand alone version) + `make install` (for the stand alone version) + or - make install-ext (for the version using the external Algorithm::Diff) + + `make install-ext` (for the version using the external Algorithm::Diff) + or - make install-fast (for the version using the UNIX 'diff' function for fast differencing) + + `make install-fast` (for the version using the UNIX 'diff' function for fast differencing) to get it rolling. You can type - make test -or - make test-ext -or - make test-fast + `make test` or + + `make test-ext` or + + `make test-fast` to test the respective versions on a brief example before installation. It will often be as easy to carry out these steps manually instead of using the Makefile. -DOCUMENTATION: +DOCUMENTATION +------------- Usage instructions are in the manual latexdiff-man.pdf as well as the man pages. -CHANGELOGS: - +CHANGELOGS +---------- Check out the comment lines at the beginning of the perl scripts (latexdiff, latexdiff-vc, latexrevise) CONTRIBUTIONS +------------- The directory contrib contains code written by others relating to latexdiff. Currently this directory contains: @@ -97,15 +111,19 @@ Contributions by the following authors were incorporated into the latexdiff code extend latexdiff in a similar way: J. Paisley, N. Becker, K. Huebner EXTERNAL LATEXDIFF SUPPORT PROGRAMS +----------------------------------- + +LATEXDIDFFR (Author: David Hugh-Jones) is a small library that uses the latexdiff command to create a diff of two Rmarkdown, .Rnw or TeX files. +https://github.com/hughjonesd/latexdiffr LATEXDIFFCITE (Author: Christer van der Meeren) is a wrapper around latexdiff to make citations diff properly. It works by expanding \cite type commands using the bbl or bib file, such that citations are treated just like normal text rather than as atomic in the plain latexdiff. -https://latexdiffcite.readthedocs.org +https://github.com/twilsonco/latexdiffcite GIT-LATEXDIFF (lead author: Matthieu Moy) is a wrapper (bash script) around latexdiff that allows using it to diff two revisions of a LaTeX file under git revision control (similar functionality is provided by latexdiff-vc --git with --flatten option included with this distribution but git-latexdiff allows more fine-grained control on (not to be confused with latexdiff-git, which is normally installed as a soft link to latexdiff-vc) https://gitorious.org/git-latexdiff/ -LICENSE (also see file COPYING) - +LICENSE +------- This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License Version 3 as published by the Free Software Foundation. @@ -116,3 +134,6 @@ MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details (file LICENSE in the distribution). + + + |