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