summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2017-06-26 21:22:49 +0000
committerKarl Berry <karl@freefriends.org>2017-06-26 21:22:49 +0000
commitb41810159701157d4c4082233224c298a27f4574 (patch)
treea61fa5dc80943832d2f5eb7d18055771d21fb56c /Master/texmf-dist/doc/man/man1
parent7837dac6397945497b0c4c0afd80c45099572453 (diff)
latexdiff (26jun17)
git-svn-id: svn://tug.org/texlive/trunk@44704 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/man/man1')
-rw-r--r--Master/texmf-dist/doc/man/man1/latexdiff-vc.167
-rw-r--r--Master/texmf-dist/doc/man/man1/latexdiff-vc.man1.pdfbin32190 -> 15599 bytes
-rw-r--r--Master/texmf-dist/doc/man/man1/latexdiff.160
-rw-r--r--Master/texmf-dist/doc/man/man1/latexdiff.man1.pdfbin67322 -> 44766 bytes
-rw-r--r--Master/texmf-dist/doc/man/man1/latexrevise.man1.pdfbin29912 -> 11551 bytes
5 files changed, 91 insertions, 36 deletions
diff --git a/Master/texmf-dist/doc/man/man1/latexdiff-vc.1 b/Master/texmf-dist/doc/man/man1/latexdiff-vc.1
index e2475f33891..de15edbc0ec 100644
--- a/Master/texmf-dist/doc/man/man1/latexdiff-vc.1
+++ b/Master/texmf-dist/doc/man/man1/latexdiff-vc.1
@@ -133,7 +133,7 @@
.\" ========================================================================
.\"
.IX Title "LATEXDIFF-VC 1"
-.TH LATEXDIFF-VC 1 "2016-08-15" "perl v5.18.2" " "
+.TH LATEXDIFF-VC 1 "2017-06-22" "perl v5.18.2" " "
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -207,6 +207,52 @@ Note that if additional files are needed which are not included in the flatten p
The generic usage of this function is : \f(CW\*(C`latexdiff\-vc \-\-flatten \-r rev1 [\-r rev2] master.tex\*(C'\fR where master.tex is the project file containing the highest level of includes etc.
.Sp
With \f(CW\*(C`\-\-flatten=keep\-intermediate\*(C'\fR, the intermediate revision snapshots are kept in the current directory (Default is to store them in a temporary directory and delete them after generating the diff file.)
+.IP "\fB\-\-config var1=val1,var2=val2,...\fR or \fB\-c var1=val1,..\fR" 4
+.IX Item "--config var1=val1,var2=val2,... or -c var1=val1,.."
+.PD 0
+.IP "\fB\-\-only\-changes\fR" 4
+.IX Item "--only-changes"
+.PD
+Post-process the output such that only pages with changes on them are displayed. This requires the use of subtype \s-1ZLABEL \s0
+in latexdiff, which will be set automatically, but any manually set \-s option will be overruled (also requires zref package to
+be installed). (note that this option must be combined with \-\-ps or \-\-pdf to make sense)
+.IP "\fB\-\-force\fR" 4
+.IX Item "--force"
+Overwrite existing diff files without asking for confirmation. Default
+behaviour is to ask for confirmation before overwriting an existing difference
+file.
+.IP "\fB\-\-run\fR" 4
+.IX Item "--run"
+run latex command on diff file after generation of diff file.
+.IP "\fB\-\-dvi\fR" 4
+.IX Item "--dvi"
+run latex and dvixxx commands after generation of diff file.
+.IP "\fB\-c configfile\fR" 4
+.IX Item "-c configfile"
+Set configuration variables for latexdiff and latexdiff-vc. The option can be repeated to set different
+variables (as an alternative to the comma-separated list).
+Available variables for latexdiff-vc:
+.RS 4
+.ie n .IP """LATEXDIFF"" latexdiff command (e.g. latexdiff-fast, latexdiff-so). This command should support the option ""\-\-interaction=batchmode""" 8
+.el .IP "\f(CWLATEXDIFF\fR latexdiff command (e.g. latexdiff-fast, latexdiff-so). This command should support the option \f(CW\-\-interaction=batchmode\fR" 8
+.IX Item "LATEXDIFF latexdiff command (e.g. latexdiff-fast, latexdiff-so). This command should support the option --interaction=batchmode"
+.PD 0
+.ie n .IP """LATEX"" latex command (e.g. pdflatex, lualatex)" 8
+.el .IP "\f(CWLATEX\fR latex command (e.g. pdflatex, lualatex)" 8
+.IX Item "LATEX latex command (e.g. pdflatex, lualatex)"
+.ie n .IP """DVI2"" Command for conversion of dvi file (e.g. dvips, dvipdf)" 8
+.el .IP "\f(CWDVI2\fR Command for conversion of dvi file (e.g. dvips, dvipdf)" 8
+.IX Item "DVI2 Command for conversion of dvi file (e.g. dvips, dvipdf)"
+.ie n .IP """BIBTEX"" Command replacing bibtex" 8
+.el .IP "\f(CWBIBTEX\fR Command replacing bibtex" 8
+.IX Item "BIBTEX Command replacing bibtex"
+.RE
+.RS 4
+.PD
+.Sp
+All other config variables are passed to latexdiff. Explicity set configuration changes always override implicit
+changes by the following shortcut options \fB\-\-fast\fR, \fB\-\-so\fR, \fB\-\-ps\fR and \fB\-\-pdf\fR.
+.RE
.IP "\fB\-\-fast\fR or \fB\-\-so\fR" 4
.IX Item "--fast or --so"
Use \f(CW\*(C`latexdiff\-fast\*(C'\fR or \f(CW\*(C`latexdiff\-so\*(C'\fR, respectively (instead of \f(CW\*(C`latexdiff\*(C'\fR).
@@ -223,16 +269,11 @@ bibtex; latex; latex; dvips\*(C'\fR.
Generate pdf output from difference file using \f(CW\*(C`pdflatex\*(C'\fR. This will
run the sequence \f(CW\*(C`pdflatex; pdflatex\*(C'\fR on the difference file, or
\&\f(CW\*(C`pdflatex; bibtex; pdflatex; pdflatex\*(C'\fR for files requiring bibtex.
-.IP "\fB\-\-only\-changes\fR" 4
-.IX Item "--only-changes"
-Post-process the output such that only pages with changes on them are displayed. This requires the use of subtype \s-1ZLABEL \s0
-in latexdiff, which will be set automatically, but any manually set \-s option will be overruled (also requires zref package to
-be installsed). (note that this option must be combined with \-\-ps or \-\-pdf to make sense)
-.IP "\fB\-\-force\fR" 4
-.IX Item "--force"
-Overwrite existing diff files without asking for confirmation. Default
-behaviour is to ask for confirmation before overwriting an existing difference
-file.
+Note that this is not just a shortcut for setting configuration variable but also triggers
+some special behaviour.
+.IP "\fB\-\-show\-config\fR" 4
+.IX Item "--show-config"
+Show values of configuration variables.
.IP "\fB\-\-help\fR or \fB\-h\fR" 4
.IX Item "--help or -h"
Show help text
@@ -257,8 +298,8 @@ or send them to \fItilmann \*(-- \s-1AT\s0 \*(-- gfz\-potsdam.de\fR. Include th
(option \f(CW\*(C`\-\-version\*(C'\fR).
.SH "AUTHOR"
.IX Header "AUTHOR"
-Version 1.2.0
-Copyright (C) 2005\-2016 Frederik Tilmann
+Version 1.2.1
+Copyright (C) 2005\-2017 Frederik Tilmann
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the \s-1GNU\s0 General Public License Version 3
diff --git a/Master/texmf-dist/doc/man/man1/latexdiff-vc.man1.pdf b/Master/texmf-dist/doc/man/man1/latexdiff-vc.man1.pdf
index d5079eeac6a..c94ae59d978 100644
--- a/Master/texmf-dist/doc/man/man1/latexdiff-vc.man1.pdf
+++ b/Master/texmf-dist/doc/man/man1/latexdiff-vc.man1.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/man/man1/latexdiff.1 b/Master/texmf-dist/doc/man/man1/latexdiff.1
index 9e243a356ca..2c00994c9b1 100644
--- a/Master/texmf-dist/doc/man/man1/latexdiff.1
+++ b/Master/texmf-dist/doc/man/man1/latexdiff.1
@@ -133,7 +133,7 @@
.\" ========================================================================
.\"
.IX Title "LATEXDIFF 1"
-.TH LATEXDIFF 1 "2016-08-15" "perl v5.18.2" " "
+.TH LATEXDIFF 1 "2017-06-22" "perl v5.18.2" " "
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -416,22 +416,26 @@ entry for \fB\-\-exclude\-safecmd\fR directly above for further details.
.IP "\fB\-\-replace\-context1cmd=replace\-file\fR" 4
.IX Item "--replace-context1cmd=replace-file"
.PD 0
-.ie n .IP "\fB\-\-append\-context1cmd=append\-file\fR or =item \fB\-\-append\-context1cmd=""cmd1,cmd2,...""\fR" 4
-.el .IP "\fB\-\-append\-context1cmd=append\-file\fR or =item \fB\-\-append\-context1cmd=``cmd1,cmd2,...''\fR" 4
-.IX Item "--append-context1cmd=append-file or =item --append-context1cmd=cmd1,cmd2,..."
+.IP "\fB\-\-append\-context1cmd=append\-file\fR or" 4
+.IX Item "--append-context1cmd=append-file or"
+.ie n .IP "\fB\-\-append\-context1cmd=""cmd1,cmd2,...""\fR" 4
+.el .IP "\fB\-\-append\-context1cmd=``cmd1,cmd2,...''\fR" 4
+.IX Item "--append-context1cmd=cmd1,cmd2,..."
.PD
Replace or append to the list of regex matching commands
whose last argument is text but which require a particular
-context to work, e.g. \ecaption will only work within a figure
+context to work, e.g. \f(CW\*(C`\ecaption\*(C'\fR will only work within a figure
or table. These commands behave like text commands, except when
they occur in a deleted section, when they are disabled, but their
argument is shown as deleted text.
.IP "\fB\-\-replace\-context2cmd=replace\-file\fR" 4
.IX Item "--replace-context2cmd=replace-file"
.PD 0
-.ie n .IP "\fB\-\-append\-context2cmd=append\-file\fR or =item \fB\-\-append\-context2cmd=""cmd1,cmd2,...""\fR" 4
-.el .IP "\fB\-\-append\-context2cmd=append\-file\fR or =item \fB\-\-append\-context2cmd=``cmd1,cmd2,...''\fR" 4
-.IX Item "--append-context2cmd=append-file or =item --append-context2cmd=cmd1,cmd2,..."
+.IP "\fB\-\-append\-context2cmd=append\-file\fR or" 4
+.IX Item "--append-context2cmd=append-file or"
+.ie n .IP "\fB\-\-append\-context2cmd=""cmd1,cmd2,...""\fR" 4
+.el .IP "\fB\-\-append\-context2cmd=``cmd1,cmd2,...''\fR" 4
+.IX Item "--append-context2cmd=cmd1,cmd2,..."
.PD
As corresponding commands for context1. The only difference is that
context2 commands are completely disabled in deleted sections, including
@@ -445,7 +449,7 @@ their arguments.
.IX Item "--append-mboxsafecmd=append-file or --append-mboxsafecmd=cmd1,cmd2,..."
.PD
Define safe commands, which additionally need to be protected by encapsulating
-in an \e\embox{..}. This is sometimes needed to get around incompatibilities
+in an \f(CW\*(C`\embox{..}\*(C'\fR. This is sometimes needed to get around incompatibilities
between external packages and the ulem package, which is used for highlighting
in the default style \s-1UNDERLINE\s0 as well as \s-1CULINECHBAR CFONTSTRIKE\s0
.IP "\fB\-\-config var1=val1,var2=val2,...\fR or \fB\-c var1=val1,..\fR" 4
@@ -481,6 +485,15 @@ Available variables (see below for further explanations):
\&\f(CW\*(C`PICTUREENV\*(C'\fR (RegEx)
.Sp
\&\f(CW\*(C`SCALEDELGRAPHICS\*(C'\fR (Float)
+.IP "\fB\-\-add\-to\-config varenv1=pattern1,varenv2=pattern2,...\fR" 4
+.IX Item "--add-to-config varenv1=pattern1,varenv2=pattern2,..."
+For configuration variables, which are a regular expression (essentially those ending
+in \s-1ENV,\s0 and \s-1COUNTERCMD,\s0 see list above) this provides an alternative way to modify the configuration
+variables. Instead of setting the complete pattern, with this option it is possible to add an
+alternative pattern. \f(CW\*(C`varenv\*(C'\fR must be one of the variables listed above that take a regular
+expression as argument, and pattern is any regular expression (which might need to be
+protected from the shell by quotation). Several patterns can be added at once by using semi-colons
+to separate them, e.g. \f(CW\*(C`\-\-add\-to\-config "LISTENV=myitemize;myenumerate,COUNTERCMD=endnote"\*(C'\fR
.IP "\fB\-\-show\-safecmd\fR" 4
.IX Item "--show-safecmd"
Print list of RegEx matching and excluding safe commands.
@@ -530,19 +543,20 @@ This mode is most suitable, if only minor changes to equations are
expected, e.g. correction of typos.
.IP "\fB\-\-graphics\-markup=level\fR" 4
.IX Item "--graphics-markup=level"
-.Vb 2
+.Vb 1
\& Change highlight style for graphics embedded with C<\eincludegraphics> commands.
-\& Possible values for level:
-\&
-\& C<none, C<off> or C<0>: no highlighting for figures
-\&
-\& C<new\-only> or C<1>: surround newly added or changed figures with a blue frame [Default if graphicx package loaded]
-\&
-\& C<both> or C<2>: highlight new figures with a blue frame and show deleted figures at reduced
-\& scale, and crossed out with a red diagonal cross. Use configuration
-\& variable SCALEDELGRAPHICS to set size of deleted figures.
.Ve
.Sp
+Possible values for level:
+.Sp
+\&\f(CW\*(C`none\*(C'\fR, \f(CW\*(C`off\*(C'\fR or \f(CW0\fR: no highlighting for figures
+.Sp
+\&\f(CW\*(C`new\-only\*(C'\fR or \f(CW1\fR: surround newly added or changed figures with a blue frame [Default if graphicx package loaded]
+.Sp
+\&\f(CW\*(C`both\*(C'\fR or \f(CW2\fR: highlight new figures with a blue frame and show deleted figures at reduced
+scale, and crossed out with a red diagonal cross. Use configuration
+variable \s-1SCALEDELGRAPHICS\s0 to set size of deleted figures.
+.Sp
Note that changes to the optional parameters will make the figure appear as changed
to latexdiff, and this figure will thus be highlighted
.IP "\fB\-\-disable\-citation\-markup\fR or \fB\-\-disable\-auto\-mbox\fR" 4
@@ -585,8 +599,8 @@ labels like this \f(CW\*(C`\-L labelold \-L labelnew\*(C'\fR.
.IP "\fB\-\-no\-label\fR" 4
.IX Item "--no-label"
Suppress inclusion of old and new file names as comment in output file
-.IP "\fB\-\-visble\-label\fR" 4
-.IX Item "--visble-label"
+.IP "\fB\-\-visible\-label\fR" 4
+.IX Item "--visible-label"
Include old and new filenames (or labels set with \f(CW\*(C`\-\-label\*(C'\fR option) as
visible output.
.IP "\fB\-\-flatten\fR" 4
@@ -849,8 +863,8 @@ version, \fIlatexdiff-so\fR, which has this package inlined, is available, too.
\&\fIlatexdiff-fast\fR requires the \fIdiff\fR command to be present.
.SH "AUTHOR"
.IX Header "AUTHOR"
-Version 1.2.0
-Copyright (C) 2004\-2015 Frederik Tilmann
+Version 1.2.1
+Copyright (C) 2004\-2017 Frederik Tilmann
.PP
This program is free software; you can redistribute it and/or modify
it under the terms of the \s-1GNU\s0 General Public License Version 3
diff --git a/Master/texmf-dist/doc/man/man1/latexdiff.man1.pdf b/Master/texmf-dist/doc/man/man1/latexdiff.man1.pdf
index a4cc5c29024..d3c5d590d81 100644
--- a/Master/texmf-dist/doc/man/man1/latexdiff.man1.pdf
+++ b/Master/texmf-dist/doc/man/man1/latexdiff.man1.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/man/man1/latexrevise.man1.pdf b/Master/texmf-dist/doc/man/man1/latexrevise.man1.pdf
index a55040360a7..64ba308264f 100644
--- a/Master/texmf-dist/doc/man/man1/latexrevise.man1.pdf
+++ b/Master/texmf-dist/doc/man/man1/latexrevise.man1.pdf
Binary files differ