1.ig \"-*- nroff -*- 2Copyright (C) 2004, 2005 Free Software Foundation, Inc. 3 4This file is part of the gdiffmk utility, which is part of groff. 5Written by Mike Bianchi <MBianchi@Foveal.com <mailto:MBianchi@Foveal.com>> 6 7Permission is granted to make and distribute verbatim copies of 8this manual provided the copyright notice and this permission notice 9are preserved on all copies. 10 11Permission is granted to copy and distribute modified versions of this 12manual under the conditions for verbatim copying, provided that the 13entire resulting derived work is distributed under the terms of a 14permission notice identical to this one. 15 16Permission is granted to copy and distribute translations of this 17manual into another language, under the above conditions for modified 18versions, except that this permission notice may be included in 19translations approved by the Free Software Foundation instead of in 20the original English. 21.. 22. 23.do mso www.tmac 24. 25.TH GDIFFMK @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@" 26. 27. 28.SH NAME 29gdiffmk \- mark differences between groff/nroff/troff files 30. 31. 32.SH SYNOPSIS 33.nr a \n(.j 34.ad l 35.nr i \n(.i 36.in +\w'\fBgdiffmk 'u 37.ti \niu 38.B gdiffmk 39.de OP 40. ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]" 41. el .RB "[\ " "\\$1" "\ ]" 42.. 43.OP \-a \%addmark 44.OP \-c \%changemark 45.OP \-d \%deletemark 46[\ \c 47.B \-D 48.OP \-B 49.OP \-M "mark1 mark2" 50] 51.OP \-x \%diffcmd 52.OP \-\- 53.OP \-\-help 54.OP \%\-\-version 55.I \%file1 56.I \%file2 57[\ \c 58.IR \%output \ \c 59] 60.br 61.ad \na 62. 63. 64.SH DESCRIPTION 65.B gdiffmk 66compares two 67.BR groff (1), 68.BR nroff (1), 69or 70.BR troff (1) 71documents, 72.I file1 73and 74.IR file2 , 75and creates an output which is 76.I file2 77with added `margin character' (.mc) commands that indicate the differences. 78. 79.LP 80If the 81.I output 82filename is present, 83the output is written there. 84If it is 85.B \- 86or absent the output is written to the standard output. 87. 88.LP 89If the 90.I file1 91or 92.I file2 93argument is 94.B \- 95the standard input is read for that input. 96Clearly both cannot be 97.BR \- . 98. 99.LP 100Note that the output is not necessarily compatible with all macro packages 101and all preprocessors. 102See the 103.B BUGS 104section below. 105. 106. 107.SH OPTIONS 108.TP 109.BI \-a addmark 110Use the 111.I addmark 112for source lines not in 113.I file1 114but present in 115.IR file2 . 116Default: 117.BR + . 118. 119.TP 120.B \-B 121By default, the deleted texts marked by the 122.B \-D 123option end 124with an added troff break command, 125.BR .br , 126to ensure that the deletions are marked properly. 127This is the only way to guarantee that deletions and small 128changes get flagged. 129This option directs the program not to insert these breaks; it makes no 130sense to use it without 131.BR \-D . 132. 133.TP 134.BI \-c changemark 135Use the 136.I changemark 137for changed source lines. 138Default: 139.BR | . 140. 141.TP 142.BI \-d deletemark 143Use the 144.I deletemark 145for deleted source lines. 146Default: 147.BR * . 148. 149.TP 150.B \-D 151Show the deleted portions from changed and deleted text. 152Default delimiting marks: 153.BR "[[" " .\&.\&.\&. " "]]" . 154. 155.TP 156.BI \-M "mark1 mark2" 157Change the delimiting marks for the 158.B \-D 159option. 160It makes no sense to use this option without 161.BR \-D . 162. 163.TP 164.BI \-x diffcmd 165Use the 166.I diffcmd 167command to perform the comparison of 168.I file1 169and 170.IR file2 . 171In particular, 172.I diffcmd 173should accept the GNU 174.B diff 175.BI \-D name 176option. 177Default: 178.BR diff (1). 179. 180.TP 181.B \-\- 182All the following arguments are treated as file names, 183even if they begin with 184.BR \- . 185. 186.TP 187.B \-\-help 188Print a usage message on standard error output and exit. 189. 190.TP 191.B \-\-version 192Print version information on the standard output and exit. 193. 194. 195.SH BUGS 196The output is not necessarily compatible with all macro packages 197and all preprocessors. 198A workaround that is often successful against preprocessor problems 199is to run 200.B gdiffmk 201on the output of all the preprocessors instead of the input source. 202. 203.LP 204.B gdiffmk 205relies on the 206.BI \-D name 207option of GNU 208.BR diff (1) 209to make a merged `#ifdef' output format. 210It hasn't been tested whether other versions of 211.BR diff (1) 212do support this option. 213See also the 214.BI \-x diffcmd 215option. 216. 217.LP 218Report bugs to bug-groff@gnu.org. 219Include a complete, self-contained example that will allow the bug to 220be reproduced, and say which version of 221.B gdiffmk 222you are using. 223. 224. 225.SH AUTHORS 226This document was written and is maintained by 227.MTO MBianchi@Foveal.com "Mike Bianchi" . 228. 229.LP 230This document is distributed under the terms of the FDL (GNU Free 231Documentation License) version 1.1 or later. 232You should have received a copy of the FDL on your system, it is also 233available on-line at the 234.URL http://\:www.gnu.org/\:copyleft/\:fdl.html "GNU copyleft site" . 235. 236.LP 237.B gdiffmk 238is part of the 239.I groff 240GNU free software project. 241All parts of the 242.I groff package 243are protected by GNU copyleft licenses. 244The software files are distributed under the terms of the GNU General 245Public License (GPL), while the documentation files mostly use the GNU 246Free Documentation License (FDL). 247. 248. 249.SH COPYRIGHT 250Copyright \(co 2004, 2005 Free Software Foundation, Inc. 251. 252.LP 253.B gdiffmk 254is free software; you can redistribute it and/or modify it under 255the terms of the GNU General Public License as published by the Free 256Software Foundation; either version 2, or (at your option) any later 257version. 258. 259.LP 260.B gdiffmk 261is distributed in the hope that it will be useful, but WITHOUT ANY 262WARRANTY; without even the implied warranty of MERCHANTABILITY or 263FITNESS FOR A PARTICULAR PURPOSE. 264See the GNU General Public License for more details. 265. 266.LP 267You should have received a copy of the GNU General Public License along 268with groff; see the file COPYING. 269If not, write to the Free Software 270Foundation, 51 Franklin St - Fifth Floor, Boston, MA 02110-1301, USA. 271. 272. 273.SH "SEE ALSO" 274.BR groff (@MAN1EXT@), 275.BR nroff (@MAN1EXT@), 276.BR gtroff (@MAN1EXT@), 277.BR diff (@MAN1EXT@) 278. 279.\" Local Variables: 280.\" mode: nroff 281.\" End: 282