Imported Upstream version 1.22.4
[platform/upstream/groff.git] / contrib / gdiffmk / README
1 gdiffmk is approximately a recreation of the original Bell Labs/AT&T diffmk
2 command for troff/nroff documents, with enhancements.
3
4 It should not be confused with 'diffmk' commands that operate on XML.
5
6 The inspiration for this code was a Perl 2 version written in 1989 by Randal
7 L. Schwartz.  See
8   landfield.com/software/comp.sources.misc/archive-name/volume06/diffmk.p.gz
9
10 The command also attempts to reproduce some of the functionality of the old
11 'nrchbar' command.  See
12   open-systems.ufl.edu/mirrors/ftp.isc.org/usenet/comp.sources.unix/volume10/nrchbar.Z
13
14 Thanks to Werner Lemberg for help in making the package more portable and
15 fit into the GNU groff source structure.
16
17 Gnu diff(1) with the -Dname option does all of the work and sed(1)
18 translates the output into something groff/troff/nroff can handle.
19
20 Note the BUGS on the man page.
21
22 The 'tests' directory contains simple tests.  'runtests run' runs them and
23 compares the output against baseline files.  Calling 'runtests' without
24 argument gives the usage.
25
26 ----------------------------------------------------------------------------
27
28 Copyright (C) 2004-2018 Free Software Foundation, Inc.
29 Written by Mike Bianchi <MBianchi@Foveal.com <mailto:MBianchi@Foveal.com>>
30
31 This file is part of the gdiffmk utility, which is part of groff.
32
33 groff is free software; you can redistribute it and/or modify it
34 under the terms of the GNU General Public License as published by
35 the Free Software Foundation, either version 3 of the License, or
36 (at your option) any later version.
37
38 groff is distributed in the hope that it will be useful, but WITHOUT
39 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
40 or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public
41 License for more details.
42
43 You should have received a copy of the GNU General Public License
44 along with groff; see the files COPYING and LICENSE in the top
45 directory of the groff source.  If not, write to the Free Software
46 Foundation, 51 Franklin St - Fifth Floor, Boston, MA 02110-1301, USA.
47
48 # Emacs settings
49 Local Variables:
50 mode: text
51 End: