gdiffmk(1)

1GDIFFMK(1)                  General Commands Manual                 GDIFFMK(1)
2
3
4

NAME

6       gdiffmk - mark differences between groff/nroff/troff files
7

SYNOPSIS

9       gdiffmk [ -aaddmark ] [ -cchangemark ] [ -ddeletemark ] [ -D [ -B ]
10               [ -Mmark1 mark2 ] ] [ -xdiffcmd ] [ -- ] [ --help ]
11               [ --version ] file1 file2 [ output ]
12

DESCRIPTION

14       gdiffmk  compares  two groff(1), nroff(1), or troff(1) documents, file1
15       and file2, and creates an output which  is  file2  with  added  `margin
16       character' (.mc) commands that indicate the differences.
17
18       If  the output filename is present, the output is written there.  If it
19       is - or absent the output is written to the standard output.
20
21       If the file1 or file2 argument is - the standard input is read for that
22       input.  Clearly both cannot be -.
23
24       Note that the output is not necessarily compatible with all macro pack‐
25       ages and all preprocessors.  See the BUGS section below.
26

OPTIONS

28       -aaddmark
29              Use the addmark for source lines not in  file1  but  present  in
30              file2.  Default: +.
31
32       -B     By  default,  the deleted texts marked by the -D option end with
33              an added troff break command, .br, to ensure that the  deletions
34              are  marked  properly.   This  is the only way to guarantee that
35              deletions and small changes get flagged.   This  option  directs
36              the program not to insert these breaks; it makes no sense to use
37              it without -D.
38
39       -cchangemark
40              Use the changemark for changed source lines.  Default: |.
41
42       -ddeletemark
43              Use the deletemark for deleted source lines.  Default: *.
44
45       -D     Show  the  deleted  portions  from  changed  and  deleted  text.
46              Default delimiting marks: [[ .... ]].
47
48       -Mmark1 mark2
49              Change  the  delimiting  marks  for  the -D option.  It makes no
50              sense to use this option without -D.
51
52       -xdiffcmd
53              Use the diffcmd command to perform the comparison of  file1  and
54              file2.  In particular, diffcmd should accept the GNU diff -Dname
55              option.  Default: diff(1).
56
57       --     All the following arguments are treated as file names,  even  if
58              they begin with -.
59
60       --help Print a usage message on standard error output and exit.
61
62       --version
63              Print version information on the standard output and exit.
64

BUGS

66       The  output  is  not necessarily compatible with all macro packages and
67       all preprocessors.  A workaround that is often successful against  pre‐
68       processor  problems  is  to  run  gdiffmk on the output of all the pre‐
69       processors instead of the input source.
70
71       gdiffmk relies on the -Dname option of GNU diff(1)  to  make  a  merged
72       `#ifdef'  output  format.  It hasn't been tested whether other versions
73       of diff(1) do support this option.  See also the -xdiffcmd option.
74
75       Report bugs to bug-groff@gnu.org.  Include a  complete,  self-contained
76       example that will allow the bug to be reproduced, and say which version
77       of gdiffmk you are using.
78

AUTHORS

80       This  document  was  written  and  is  maintained   by   Mike   Bianchi
81       ⟨MBianchi@Foveal.com⟩.
82
83       This document is distributed under the terms of the FDL (GNU Free Docu‐
84       mentation License) version 1.1 or later.  You should  have  received  a
85       copy of the FDL on your system, it is also available on-line at the GNU
86       copyleft site ⟨http://www.gnu.org/copyleft/fdl.html⟩.
87
88       gdiffmk is part of the groff GNU free software project.  All  parts  of
89       the groff package are protected by GNU copyleft licenses.  The software
90       files are distributed under the terms of the GNU General Public License
91       (GPL), while the documentation files mostly use the GNU Free Documenta‐
92       tion License (FDL).
93

COPYRIGHT

95       Copyright © 2004, 2005, 2008 Free Software Foundation, Inc.
96
97       gdiffmk is free software; you can  redistribute  it  and/or  modify  it
98       under  the  terms of the GNU General Public License as published by the
99       Free Software Foundation, either version 3 of the License, or (at  your
100       option) any later version.
101
102       gdiffmk  is distributed in the hope that it will be useful, but WITHOUT
103       ANY WARRANTY; without even the implied warranty of  MERCHANTABILITY  or
104       FITNESS  FOR  A PARTICULAR PURPOSE.  See the GNU General Public License
105       for more details.
106
107       You should have received a copy of the GNU General Public License along
108       with this program. If not, see <http://www.gnu.org/licenses/>.
109