1LATEXDIFF-VC(1) LATEXDIFF-VC(1)
2
3
4
6 latexdiff-vc - wrapper script that calls latexdiff for different
7 versions of a file under version management (CVS, RCS or SVN)
8
10 latexdiff-vc [ latexdiff-options ] [ latexdiff-vc-options ] -r [rev1]
11 [-r rev2] file1.tex [ file2.tex ...]
12
13 or
14
15 latexdiff-vc [ latexdiff-options ] [ latexdiff-vc-options ][
16 --postscript | --pdf ] old.tex new.tex
17
19 latexdiff-vc is a wrapper script that applies latexdiff to a file, or
20 multiple files under version control (git, subversion (SVN), mercurial
21 (hg), CVS, RCS), and optionally runs the sequence of "latex" and
22 "dvips" or "pdflatex" commands necessary to produce pdf or postscript
23 output of the difference tex file(s). It can also be applied to a pair
24 of files to automatise the generation of difference file in postscript
25 or pdf format.
26
28 --rcs, --svn, --cvs, --git or --hg
29 Set the version system. If no version system is specified,
30 latexdiff-vc will venture a guess.
31
32 latexdiff-cvs, latexdiff-rcs etc are variants of latexdiff-vc which
33 default to the respective versioning system. However, this default
34 can still be overridden using the options above.
35
36 -r, -r rev or --revision, --revision=rev
37 Choose revision (under RCS, CVS, SVN, GIT or HG). One or two -r
38 options can be specified, and they result in different behaviour:
39
40 latexdiff-vc -r file.tex ...
41 compares file.tex with the most recent version checked into
42 RCS.
43
44 latexdiff-vc -r rev1 file.tex ...
45 compares file.tex with revision rev1.
46
47 latexdiff-vc -r rev1 -r rev2 file.tex ...
48 compares revisions rev1 and rev2 of file.tex.
49
50 Multiple files can be specified for all of the above options.
51 All files must have the extension ".tex", though.
52
53 latexdiff-vc old.tex new.tex
54 compares two files.
55
56 The name of the difference file is generated automatically and
57 reported to stdout.
58
59 -d or --dir -d path or --dir=path
60 Rather than appending the string "diff" and optionally the version
61 numbers given to the output-file, this will prepend a directory
62 name "diff" to the original filename, creating the directory and
63 subdirectories should they not exist already. This is particularly
64 useful in order to clone a complete directory hierarchy.
65 Optionally, a pathname path can be specified, which is prepended
66 instead of "diff".
67
68 --flatten,--flatten=keep-intermediate
69 If combined with "--git", "--svn" or "--hg" option or the
70 corresponding modes, check out the revisions to compare in a
71 separate temporary directory, and then pass on option "--flatten"
72 to latexdiff. The directory in which "latexdiff-vc" is invoked
73 defines the subtree which will be checked out. Note that if
74 additional files are needed which are not included in the flatten
75 procedure (package files, included graphics), they need to be
76 accessible in the current directory. If you use bibtex, it is
77 recommended to include the ".bbl" file in the version management.
78
79 The generic usage of this function is : "latexdiff-vc --flatten -r
80 rev1 [-r rev2] master.tex" where master.tex is the project file
81 containing the highest level of includes etc.
82
83 With "--flatten=keep-intermediate", the intermediate revision
84 snapshots are kept in the current directory (Default is to store
85 them in a temporary directory and delete them after generating the
86 diff file.)
87
88 --config var1=val1,var2=val2,... or -c var1=val1,..
89 --only-changes
90 Post-process the output such that only pages with changes on them
91 are displayed. This requires the use of subtype ZLABEL in
92 latexdiff, which will be set automatically, but any manually set -s
93 option will be overruled (also requires zref package to be
94 installed). (note that this option must be combined with --ps or
95 --pdf to make sense)
96
97 --force
98 Overwrite existing diff files without asking for confirmation.
99 Default behaviour is to ask for confirmation before overwriting an
100 existing difference file.
101
102 --run
103 run latex command on diff file after generation of diff file.
104
105 --dvi
106 run latex and dvixxx commands after generation of diff file.
107
108 -c configfile
109 Set configuration variables for latexdiff and latexdiff-vc. The
110 option can be repeated to set different variables (as an
111 alternative to the comma-separated list). Available variables for
112 latexdiff-vc:
113
114 "LATEXDIFF" latexdiff command (e.g. latexdiff-fast, latexdiff-so).
115 This command should support the option "--interaction=batchmode"
116 "LATEX" latex command (e.g. pdflatex, lualatex)
117 "DVI2" Command for conversion of dvi file (e.g. dvips, dvipdf)
118 "BIBTEX" Command replacing bibtex
119
120 All other config variables are passed to latexdiff. Explicity set
121 configuration changes always override implicit changes by the
122 following shortcut options --fast, --so, --ps and --pdf.
123
124 --fast or --so
125 Use "latexdiff-fast" or "latexdiff-so", respectively (instead of
126 "latexdiff").
127
128 --ps or --postscript
129 Generate postscript output from difference file. This will run the
130 sequence "latex; latex; dvips" on the difference file (do not use
131 this option in the rare cases, where three "latex" commands are
132 required if you care about correct referencing). If the difference
133 file contains a "\bibliography" tag, run the sequence "latex;
134 bibtex; latex; latex; dvips".
135
136 --pdf
137 Generate pdf output from difference file using "pdflatex". This
138 will run the sequence "pdflatex; pdflatex" on the difference file,
139 or "pdflatex; bibtex; pdflatex; pdflatex" for files requiring
140 bibtex. Note that this is not just a shortcut for setting
141 configuration variable but also triggers some special behaviour.
142
143 --show-config
144 Show values of configuration variables.
145
146 --help or -h
147 Show help text
148
149 --version
150 Show version number
151
152 All other options are passed on to "latexdiff".
153
155 latexdiff
156
158 latexdiff-vc uses external commands and is therefore dependent on the
159 system architecture; it has been tested mainly on Unix-like systems. It
160 also requires the a version control system and latex to be installed on
161 the system to make use of all features. Modules from Perl 5.8 or
162 higher are required.
163
165 Please submit bug reports using the issue tracker of the github
166 repository page https://github.com/ftilmann/latexdiff.git, or send them
167 to tilmann -- AT -- gfz-potsdam.de. Include the version number of
168 latexdiff-vc (option "--version").
169
171 Version 1.2.1 Copyright (C) 2005-2017 Frederik Tilmann
172
173 This program is free software; you can redistribute it and/or modify it
174 under the terms of the GNU General Public License Version 3
175 Contributors: S Utcke, H Bruyninckx; some ideas have been inspired by
176 git-latexdiff bash script. C. Junghans: Mercurial Support.
177
178
179
180perl v5.18.2 2017-06-22 LATEXDIFF-VC(1)