summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/latexdiff.1
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/latexdiff.1')
-rw-r--r--Master/texmf-dist/doc/man/man1/latexdiff.164
1 files changed, 57 insertions, 7 deletions
diff --git a/Master/texmf-dist/doc/man/man1/latexdiff.1 b/Master/texmf-dist/doc/man/man1/latexdiff.1
index 2c00994c9b1..f48444e3074 100644
--- a/Master/texmf-dist/doc/man/man1/latexdiff.1
+++ b/Master/texmf-dist/doc/man/man1/latexdiff.1
@@ -1,4 +1,4 @@
-.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
+.\" Automatically generated by Pod::Man 2.28 (Pod::Simple 3.29)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -133,7 +133,7 @@
.\" ========================================================================
.\"
.IX Title "LATEXDIFF 1"
-.TH LATEXDIFF 1 "2017-06-22" "perl v5.18.2" " "
+.TH LATEXDIFF 1 "2018-10-07" "perl v5.22.1" " "
.\" For nroff, turn off justification. Always turn off hyphenation; it makes
.\" way too many mistakes in technical documents.
.if n .ad l
@@ -152,7 +152,8 @@ between them (i.e., ignoring the number of white spaces and position
of line breaks), and adds special commands to highlight the
differences. Where visual highlighting is not possible, e.g. for changes
in the formatting, the differences are
-nevertheless marked up in the source.
+nevertheless marked up in the source. Note that old.tex and new.tex need to
+be real files (not pipes or similar) as they are opened twice (unless \f(CW\*(C`\-\-encoding\*(C'\fR option is used)
.PP
The program treats the preamble differently from the main document.
Differences between the preambles are found using line-based
@@ -271,7 +272,7 @@ Add code to preamble for selected markup style. This option defines
Available styles:
.Sp
\&\f(CW\*(C`UNDERLINE CTRADITIONAL TRADITIONAL CFONT FONTSTRIKE INVISIBLE
-CHANGEBAR CCHANGEBAR CULINECHBAR CFONTCBHBAR BOLD PDFCOMMENT\*(C'\fR
+CHANGEBAR CCHANGEBAR CULINECHBAR CFONTCHBAR BOLD PDFCOMMENT\*(C'\fR
.Sp
[ Default: \f(CW\*(C`UNDERLINE\*(C'\fR ]
.IP "\fB\-\-subtype=markstyle\fR or \fB\-s markstyle\fR" 4
@@ -301,6 +302,7 @@ obtained by executing
.Sp
\&\f(CW\*(C`perl \-MEncode \-e \*(Aqprint join ("\en",Encode\-\*(C'\fRencodings( \*(L":all\*(R" )) ;' >
.Sp
+If this option is used, then old.tex, new.tex are only opened once.
[Default encoding is utf8 unless the first few lines of the preamble contain
an invocation \f(CW\*(C`\eusepackage[..]{inputenc}\*(C'\fR in which case the
encoding chosen by this command is asssumed. Note that \s-1ASCII \s0(standard
@@ -440,6 +442,10 @@ argument is shown as deleted text.
As corresponding commands for context1. The only difference is that
context2 commands are completely disabled in deleted sections, including
their arguments.
+.Sp
+context2 commands are also the only commands in the preamble, whose argument will be processed in
+word-by-word mode (which only works, if they occur no more than once in the preamble). The algorithm currently cannot cope with repeated context2 commands in the preamble, as they occur e.g. for the \f(CW\*(C`\eauthor\*(C'\fR argument in some journal styles (not in the standard styles, though
+If such a repetition is detected, the whole preamble will be processed in line-by-line mode. In such a case, use \f(CW\*(C`\-\-replace\-context2cmd\*(C'\fR option to just select the commands, which should be processed and are not used repeatedly in the preamble.
.ie n .IP "\fB\-\-exclude\-mboxsafecmd=exclude\-file\fR or \fB\-\-exclude\-mboxsafecmd=""cmd1,cmd2,...""\fR" 4
.el .IP "\fB\-\-exclude\-mboxsafecmd=exclude\-file\fR or \fB\-\-exclude\-mboxsafecmd=``cmd1,cmd2,...''\fR" 4
.IX Item "--exclude-mboxsafecmd=exclude-file or --exclude-mboxsafecmd=cmd1,cmd2,..."
@@ -466,6 +472,8 @@ Available variables (see below for further explanations):
.Sp
\&\f(CW\*(C`COUNTERCMD\*(C'\fR (RegEx)
.Sp
+\&\f(CW\*(C`CUSTODIFCMD\*(C'\fR (RegEx)
+.Sp
\&\f(CW\*(C`FLOATENV\*(C'\fR (RegEx)
.Sp
\&\f(CW\*(C`ITEMCMD\*(C'\fR (RegEx)
@@ -488,7 +496,7 @@ Available variables (see below for further explanations):
.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
+in \s-1ENV, COUNTERCMD\s0 and \s-1CUSTOMDIFCMD,\s0 see list above) this option 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
@@ -624,6 +632,12 @@ Show help text
.IP "\fB\-\-version\fR" 4
.IX Item "--version"
Show version number
+.SS "Internal options"
+.IX Subsection "Internal options"
+These options are mostly for automated use by latexdiff-vc. They can be used directly, but the \s-1API\s0 should be considered less stable than for the other options.
+.IP "\fB\-\-no\-links\fR" 4
+.IX Item "--no-links"
+Suppress generation of hyperreferences, used for minimal diffs (option \-\-only\-changes of latexdiff-vc)
.SS "Predefined styles"
.IX Subsection "Predefined styles"
.SS "Major types"
@@ -755,6 +769,25 @@ numbering in the new file.
[ Default: \f(CW\*(C`COUNTERCMD\*(C'\fR=\f(CW\*(C`(?:footnote|part|section|subsection\*(C'\fR ...
.Sp
\&\f(CW\*(C`|subsubsection|paragraph|subparagraph)\*(C'\fR ]
+.ie n .IP """CUSTOMDIFCMD""" 10
+.el .IP "\f(CWCUSTOMDIFCMD\fR" 10
+.IX Item "CUSTOMDIFCMD"
+This option is for advanced users and allows definition of special versions of commands, which do not work as safe commands.
+.Sp
+Commands in \f(CW\*(C`CUSTOMDIFCMD\*(C'\fR that occur in added or deleted blocks will be given an \s-1ADD\s0 or \s-1DEL\s0 prefix.
+The prefixed versions of the command must be defined in the preamble, either by putting them
+in the preamble of at least the new file, or by creating a custom preamble file (Option \-\-preamble).
+For example the command \f(CW\*(C`\eblindtext\*(C'\fR (from package blindtext) does not interact well with underlining, so that
+for the standard markup type, it is not satisfactory to define it as a safe command. Instead, a customised versions
+without underlining can be defined in the preamble:
+.Sp
+\&\f(CW\*(C`\enewcommand{\eDELblindtext}{{\ecolor{red}\eblindtext}}\*(C'\fR
+.Sp
+\&\f(CW\*(C`\enewcommand{\eADDblindtext}{{\ecolor{blue}\eblindtext}}\*(C'\fR
+.Sp
+and then latexdiff should be invoked with the option \f(CW\*(C`\-c CUSTOMDIFCMD=blindtext\*(C'\fR.
+.Sp
+[ Default: none ]
.ie n .IP """FLOATENV""" 10
.el .IP "\f(CWFLOATENV\fR" 10
.IX Item "FLOATENV"
@@ -810,6 +843,23 @@ inconsistent markup but this situation should be rare).
If \f(CW\*(C`\-\-graphics\-markup=both\*(C'\fR is chosen, \f(CW\*(C`SCALEDELGRAPHICS\*(C'\fR is the factor, by which deleted figures will be scaled (i.e. 0.5 implies they are shown at half linear size).
.Sp
[ Default: 0.5 ]
+.ie n .IP """VERBATIMENV""" 10
+.el .IP "\f(CWVERBATIMENV\fR" 10
+.IX Item "VERBATIMENV"
+RegEx describing environments like verbatim, whose contents should be taken verbatim. The content of these environments will not be processed in any way:
+deleted content is commented out, new content is not marked up
+.Sp
+[ Default: \f(CW\*(C`comment\*(C'\fR\ ]
+.ie n .IP """VERBATIMLINEENV""" 10
+.el .IP "\f(CWVERBATIMLINEENV\fR" 10
+.IX Item "VERBATIMLINEENV"
+RegEx describing environments like verbatim, whose contents should be taken verbatim. The content of environments described by \s-1VERBATIMLINEENV\s0 are compared in
+line mode, and changes are marked up using the listings package. The markup style is set based on the chosen mains markup type (Option \-t), or on an analysis
+of the preamble.
+Note that \*(L"listings.sty\*(R" must be installed. If this file is not found the fallback solution is to
+treat \s-1VERBATIMLINEENV\s0 environments treated exactly the same way as \s-1VERBATIMENV\s0 environments.
+.Sp
+[ Default: \f(CW\*(C`(?:verbatim[*]?|lstlisting\*(C'\fR\ ]
.SH "COMMON PROBLEMS AND FAQ"
.IX Header "COMMON PROBLEMS AND FAQ"
.IP "Citations result in overfull boxes" 10
@@ -863,8 +913,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.1
-Copyright (C) 2004\-2017 Frederik Tilmann
+Version 1.3.0
+Copyright (C) 2004\-2018 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