* All affected files: Update postal address of FSF.
[s-roff.git] / contrib / gdiffmk / README
blob9428717ede8cb832470cefc397afbb079a1357c5
1 gdiffmk is approximately a recreation of the original Bell Labs/AT&T diffmk
2 command for troff/nroff documents, with enhancements.
4 It should not be confused with `diffmk' commands that operate on XML.
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
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
14 Thanks to Werner Lemberg for help in making the package more portable and
15 fit into the GNU groff source structure.
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.
20 Note the BUGS on the man page.
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.
26 ----------------------------------------------------------------------------
28 Copyright (C) 2004, 2005 Free Software Foundation, Inc.
29 Written by Mike Bianchi <MBianchi@Foveal.com <mailto:MBianchi@Foveal.com>>
31 This file is part of the gdiffmk utility, which is part of groff.
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 2, or (at your option)
36 any later version.
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.
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.