/contrib/groff/contrib/gdiffmk/gdiffmk.man

https://bitbucket.org/freebsd/freebsd-head/ · Unknown · 281 lines · 277 code · 4 blank · 0 comment · 0 complexity · 7c3f901e4dc373f06cb354d2eb0d2d6e MD5 · raw file

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