contrib/gdiffmk/gdiffmk.man

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