Debian Codegraph @

texmf-dist/doc/man/man1/texdiff.1

raw
1 .\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.32
2 .\"
3 .\" Standard preamble:
4 .\" ========================================================================
5 .de Sh \" Subsection heading
6 .br
7 .if t .Sp
8 .ne 5
9 .PP
10 \fB\\$1\fR
11 .PP
12 ..
13 .de Sp \" Vertical space (when we can't use .PP)
14 .if t .sp .5v
15 .if n .sp
16 ..
17 .de Vb \" Begin verbatim text
18 .ft CW
19 .nf
20 .ne \\$1
21 ..
22 .de Ve \" End verbatim text
23 .ft R
24 .fi
25 ..
26 .\" Set up some character translations and predefined strings. \*(-- will
27 .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left
28 .\" double quote, and \*(R" will give a right double quote. | will give a
29 .\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to
30 .\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C'
31 .\" expand to `' in nroff, nothing in troff, for use with C<>.
32 .tr \(*W-|\(bv\*(Tr
33 .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p'
34 .ie n \{\
35 . ds -- \(*W-
36 . ds PI pi
37 . if (\n(.H=4u)&(1m=24u) .ds -- \(*W\h'-12u'\(*W\h'-12u'-\" diablo 10 pitch
38 . if (\n(.H=4u)&(1m=20u) .ds -- \(*W\h'-12u'\(*W\h'-8u'-\" diablo 12 pitch
39 . ds L" ""
40 . ds R" ""
41 . ds C` ""
42 . ds C' ""
43 'br\}
44 .el\{\
45 . ds -- \|\(em\|
46 . ds PI \(*p
47 . ds L" ``
48 . ds R" ''
49 'br\}
50 .\"
51 .\" If the F register is turned on, we'll generate index entries on stderr for
52 .\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index
53 .\" entries marked with X<> in POD. Of course, you'll have to process the
54 .\" output yourself in some meaningful fashion.
55 .if \nF \{\
56 . de IX
57 . tm Index:\\$1\t\\n%\t"\\$2"
58 ..
59 . nr % 0
60 . rr F
61 .\}
62 .\"
63 .\" For nroff, turn off justification. Always turn off hyphenation; it makes
64 .\" way too many mistakes in technical documents.
65 .hy 0
66 .if n .na
67 .\"
68 .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
69 .\" Fear. Run. Save yourself. No user-serviceable parts.
70 . \" fudge factors for nroff and troff
71 .if n \{\
72 . ds #H 0
73 . ds #V .8m
74 . ds #F .3m
75 . ds #[ \f1
76 . ds #] \fP
77 .\}
78 .if t \{\
79 . ds #H ((1u-(\\\\n(.fu%2u))*.13m)
80 . ds #V .6m
81 . ds #F 0
82 . ds #[ \&
83 . ds #] \&
84 .\}
85 . \" simple accents for nroff and troff
86 .if n \{\
87 . ds ' \&
88 . ds ` \&
89 . ds ^ \&
90 . ds , \&
91 . ds ~ ~
92 . ds /
93 .\}
94 .if t \{\
95 . ds ' \\k:\h'-(\\n(.wu*8/10-\*(#H)'\'\h"|\\n:u"
96 . ds ` \\k:\h'-(\\n(.wu*8/10-\*(#H)'\`\h'|\\n:u'
97 . ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'^\h'|\\n:u'
98 . ds , \\k:\h'-(\\n(.wu*8/10)',\h'|\\n:u'
99 . ds ~ \\k:\h'-(\\n(.wu-\*(#H-.1m)'~\h'|\\n:u'
100 . ds / \\k:\h'-(\\n(.wu*8/10-\*(#H)'\z\(sl\h'|\\n:u'
101 .\}
102 . \" troff and (daisy-wheel) nroff accents
103 .ds : \\k:\h'-(\\n(.wu*8/10-\*(#H+.1m+\*(#F)'\v'-\*(#V'\z.\h'.2m+\*(#F'.\h'|\\n:u'\v'\*(#V'
104 .ds 8 \h'\*(#H'\(*b\h'-\*(#H'
105 .ds o \\k:\h'-(\\n(.wu+\w'\(de'u-\*(#H)/2u'\v'-.3n'\*(#[\z\(de\v'.3n'\h'|\\n:u'\*(#]
106 .ds d- \h'\*(#H'\(pd\h'-\w'~'u'\v'-.25m'\f2\(hy\fP\v'.25m'\h'-\*(#H'
107 .ds D- D\\k:\h'-\w'D'u'\v'-.11m'\z\(hy\v'.11m'\h'|\\n:u'
108 .ds th \*(#[\v'.3m'\s+1I\s-1\v'-.3m'\h'-(\w'I'u*2/3)'\s-1o\s+1\*(#]
109 .ds Th \*(#[\s+2I\s-2\h'-\w'I'u*3/5'\v'-.3m'o\v'.3m'\*(#]
110 .ds ae a\h'-(\w'a'u*4/10)'e
111 .ds Ae A\h'-(\w'A'u*4/10)'E
112 . \" corrections for vroff
113 .if v .ds ~ \\k:\h'-(\\n(.wu*9/10-\*(#H)'\s-2\u~\d\s+2\h'|\\n:u'
114 .if v .ds ^ \\k:\h'-(\\n(.wu*10/11-\*(#H)'\v'-.4m'^\v'.4m'\h'|\\n:u'
115 . \" for low resolution devices (crt and lpr)
116 .if \n(.H>23 .if \n(.V>19 \
117 \{\
118 . ds : e
119 . ds 8 ss
120 . ds o a
121 . ds d- d\h'-1'\(ga
122 . ds D- D\h'-1'\(hy
123 . ds th \o'bp'
124 . ds Th \o'LP'
125 . ds ae ae
126 . ds Ae AE
127 .\}
128 .rm #[ #] #H #V #F C
129 .\" ========================================================================
130 .\"
131 .IX Title "TEXDIFF 1"
132 .TH TEXDIFF 1 "2009-09-24" "perl v5.8.8" "User Contributed Perl Documentation"
133 .SH "NAME"
134 \&\fBtexdiff\fR \- Compares two (La)TeX documents to create a merged version showing changes, similar to that of 'Change Tracking' in some word processors.
135 .SH "SYNOPSIS"
136 .IX Header "SYNOPSIS"
137 texdiff [\-\-nofloats|\-n] old.tex new.tex [diff.tex]
138 .SH "DESCRIPTION"
139 .IX Header "DESCRIPTION"
140 The first two files are compared and a new TeX file is output. When
141 the output file is processed with (La)TeX it marks new changes with
142 blue and old text with red with a strike-through line. Furthermore,
143 passages with changes are marked at the margin with grey bars by the
144 LaTeX \f(CW\*(C`changebar\*(C'\fR package (although only after running \f(CW\*(C`dvips\*(C'\fR, in
145 \&\f(CW\*(C`xdvi\*(C'\fR the bars are one inch too far left to compensate the one inch
146 offset inserted by TeX printer drivers).
147 .PP
148 \&\f(CW\*(C`texdiff\*(C'\fR uses and therefore requires the \f(CW\*(C`wdiff\*(C'\fR command to insert
149 these marks. If LaTeX macros are included in those striked out or
150 underlined passages, the latex run will most likely fail. The source
151 of most problems lies in \f(CW\*(C`wdiff\*(C'\fR tearing apart pairs of
152 braces. Therefore \f(CW\*(C`texdiff\*(C'\fR is a perl script that calls \f(CW\*(C`wdiff\*(C'\fR internally
153 and fixes \f(CW\*(C`wdiff\*(C'\fR's output by re-pairing braces again and handling some
154 commonly used LaTeX macros.
155 .PP
156 For texdiff to work, the following LaTeX code must be inserted in the
157 preamble of the LaTeX document:
158 .PP
159 .Vb 3
160 \& \eusepackage{xcolor} \eusepackage{ulem} \eusepackage{changebar}
161 \& \enewcommand\eTLSins[1]{\ecbstart{}\etextcolor{ins}{\euline{#1}}\ecbend{}}
162 \& \enewcommand\eTLSdel[1]{\ecbdelete{}\etextcolor{del}{\esout{#1}}}
163 .Ve
164 .PP
165 Define editing colors \f(CW\*(C`ins\*(C'\fR and \f(CW\*(C`del\*(C'\fR with existing \f(CW\*(C`xcolor\*(C'\fR color names:
166 \ecolorlet{ins}{blue} \ecolorlet{del}{red}
167 .PP
168 Or from scratch:
169 \edefinecolor{ins}{rgb}{0, 0.5, 0}
170 .PP
171 These macros are \s-1NOT\s0 automatically interted at \ebegin{document} like
172 the original scripts did (see the \fB\s-1ACKNOWLEDGMENTS\s0\fR section below),
173 because this will not work on files of a multi-file document (those
174 included by \einclude or \einput). Furthermore, if you insert the
175 macros manually, you can tune them as you like, i. e. change text
176 color or position of changebars. Have a look at the documentation of
177 the ulem and changebar packages on how to do this!
178 .SH "OPTIONS"
179 .IX Header "OPTIONS"
180 .IP "\fB\-\-nofloats\fR, \fB\-n\fR" 4
181 .IX Item "--nofloats, -n"
182 If given, skips contents of figure environments, but does show
183 insertions and deletions in the caption commands. This is done to
184 avoid complex messups in subfloat or complex figure environments.
185 .IP "\fB\-\-debug\fR, \fB\-d\fR" 4
186 .IX Item "--debug, -d"
187 Turns on debugging. Temporary files that contain numbered braces are
188 kept and a raw difference file is written as output file name appended
189 with '\-wdiff.tex'. In addition, several regular expression diagnostics
190 are printed. \fBWarning: produces a lot of output.\fR
191 .SH "AUTHOR"
192 .IX Header "AUTHOR"
193 Mark Doll <markdoll<\s-1AT\s0>gmx.net>, Cengiz Gunay <cengique<\s-1AT\s0>users.sf.net>.
194 .SH "ACKNOWLEDGMENTS"
195 .IX Header "ACKNOWLEDGMENTS"
196 .IP "\fB*\fR" 4
197 .IX Item "*"
198 Version 0.4, by \s-1CG\s0, 2009/09/15. Added use of GetOpt to take an optional
199 parameter to skip float (e.g., figure or table) contents. Added an
200 optional debug mode. Embedded \s-1POD\s0 documentation. Fixed problem
201 with insertion and deletions appearing in the middle of sectioning
202 commands by throwing off LaTeX.
203 .IP "\fB*\fR" 4
204 .IX Item "*"
205 Version 0.3, modified by Cengiz Gunay <[email protected]>,
206 2009/06/30. Added some Latex commands that should be excluded and
207 fixed handling of '\e%' characters.
208 .IP "\fB*\fR" 4
209 .IX Item "*"
210 Version 0.2, is a perl implementation of TeXdiff by Mark Doll
211 <[email protected]>, 2006/08/09. It was derived from the original bash
212 and perl scripts created by Robert Maron <[email protected]>,
213 available at http://www.robmar.net/TexDiff/. This version of texdiff
214 is available at http://mark.doll.name/texdiff/.
215 .SH "COPYRIGHT AND LICENSE"
216 .IX Header "COPYRIGHT AND LICENSE"
217 Copyleft 2006\-2009, Mark Doll and Cengiz Gunay
218 .PP
219 This library is free software; you may redistribute it and/or modify
220 it under the same terms as Perl itself.