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.1153
1 files changed, 88 insertions, 65 deletions
diff --git a/Master/texmf-dist/doc/man/man1/latexdiff.1 b/Master/texmf-dist/doc/man/man1/latexdiff.1
index 24834cbde14..815f23d874e 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.25 (Pod::Simple 3.16)
+.\" Automatically generated by Pod::Man 2.27 (Pod::Simple 3.28)
.\"
.\" Standard preamble:
.\" ========================================================================
@@ -38,6 +38,8 @@
. ds PI \(*p
. ds L" ``
. ds R" ''
+. ds C`
+. ds C'
'br\}
.\"
.\" Escape single quotes in literal strings from groff's Unicode transform.
@@ -48,17 +50,24 @@
.\" titles (.TH), headers (.SH), subsections (.SS), items (.Ip), and index
.\" entries marked with X<> in POD. Of course, you'll have to process the
.\" output yourself in some meaningful fashion.
-.ie \nF \{\
-. de IX
-. tm Index:\\$1\t\\n%\t"\\$2"
+.\"
+.\" Avoid warning from groff about undefined register 'F'.
+.de IX
..
-. nr % 0
-. rr F
-.\}
-.el \{\
-. de IX
+.nr rF 0
+.if \n(.g .if rF .nr rF 1
+.if (\n(rF:(\n(.g==0)) \{
+. if \nF \{
+. de IX
+. tm Index:\\$1\t\\n%\t"\\$2"
..
+. if !\nF==2 \{
+. nr % 0
+. nr F 2
+. \}
+. \}
.\}
+.rr rF
.\"
.\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2).
.\" Fear. Run. Save yourself. No user-serviceable parts.
@@ -124,7 +133,7 @@
.\" ========================================================================
.\"
.IX Title "LATEXDIFF 1"
-.TH LATEXDIFF 1 "2015-04-14" "perl v5.14.2" " "
+.TH LATEXDIFF 1 "2015-12-26" "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
@@ -270,7 +279,7 @@ CHANGEBAR CCHANGEBAR CULINECHBAR CFONTCBHBAR BOLD\*(C'\fR
Add code to preamble for selected style for bracketing
commands (e.g. to mark changes in margin). This option defines
\&\f(CW\*(C`\eDIFaddbegin\*(C'\fR, \f(CW\*(C`\eDIFaddend\*(C'\fR, \f(CW\*(C`\eDIFdelbegin\*(C'\fR and \f(CW\*(C`\eDIFdelend\*(C'\fR commands.
-Available styles: \f(CW\*(C`SAFE MARGINAL COLOR DVIPSCOL ZLABEL ONLYCHANGEDPAGE (LABEL)*\*(C'\fR
+Available styles: \f(CW\*(C`SAFE MARGIN COLOR DVIPSCOL ZLABEL ONLYCHANGEDPAGE (LABEL)*\*(C'\fR
.Sp
[ Default: \f(CW\*(C`SAFE\*(C'\fR ]
* Subtype \f(CW\*(C`LABEL\*(C'\fR is deprecated
@@ -294,7 +303,7 @@ obtained by executing
.Sp
[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
+encoding chosen by this command is asssumed. Note that \s-1ASCII \s0(standard
latex) is a subset of utf8]
.IP "\fB\-\-preamble=file\fR or \fB\-p file\fR" 4
.IX Item "--preamble=file or -p file"
@@ -352,9 +361,9 @@ Define most of the glossaries commands as safe, protecting them with \embox'es w
.el .IP "\f(CWmhchem\fR" 8
.IX Item "mhchem"
Treat \f(CW\*(C`\ece\*(C'\fR as a safe command, i.e. it will be highlighted (note that \f(CW\*(C`\ecee\*(C'\fR will not be highlighted in equations as this leads to processing errors)
-.ie n .IP """chemformula""" 8
-.el .IP "\f(CWchemformula\fR" 8
-.IX Item "chemformula"
+.ie n .IP """chemformula"" or ""chemmacros""" 8
+.el .IP "\f(CWchemformula\fR or \f(CWchemmacros\fR" 8
+.IX Item "chemformula or chemmacros"
Treat \f(CW\*(C`\ech\*(C'\fR as a safe command outside equations, i.e. it will be highlighted (note that \f(CW\*(C`\ech\*(C'\fR will not be highlighted in equations as this leads to processing errors)
.RE
.RS 4
@@ -369,7 +378,7 @@ Print generated or included preamble commands to stdout.
.IX Subsection "Configuration"
.ie n .IP "\fB\-\-exclude\-safecmd=exclude\-file\fR or \fB\-A exclude-file\fR or \fB\-\-exclude\-safecmd=""cmd1,cmd2,...""\fR" 4
.el .IP "\fB\-\-exclude\-safecmd=exclude\-file\fR or \fB\-A exclude-file\fR or \fB\-\-exclude\-safecmd=``cmd1,cmd2,...''\fR" 4
-.IX Item "--exclude-safecmd=exclude-file or -A exclude-file or --exclude-safecmd=cmd1,cmd2,..."
+.IX Item "--exclude-safecmd=exclude-file or -A exclude-file or --exclude-safecmd=cmd1,cmd2,..."
.PD 0
.IP "\fB\-\-replace\-safecmd=replace\-file\fR" 4
.IX Item "--replace-safecmd=replace-file"
@@ -438,7 +447,7 @@ their arguments.
Define safe commands, which additionally need to be protected by encapsulating
in an \e\embox{..}. 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\s0 \s-1CFONTSTRIKE\s0
+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
.IX Item "--config var1=val1,var2=val2,... or -c var1=val1,.."
.PD 0
@@ -449,23 +458,27 @@ Set configuration variables. The option can be repeated to set different
variables (as an alternative to the comma-separated list).
Available variables (see below for further explanations):
.Sp
-\&\f(CW\*(C`MINWORDSBLOCK\*(C'\fR (integer)
+\&\f(CW\*(C`ARRENV\*(C'\fR (RegEx)
.Sp
-\&\f(CW\*(C`FLOATENV\*(C'\fR (RegEx)
+\&\f(CW\*(C`COUNTERCMD\*(C'\fR (RegEx)
.Sp
-\&\f(CW\*(C`PICTUREENV\*(C'\fR (RegEx)
+\&\f(CW\*(C`FLOATENV\*(C'\fR (RegEx)
.Sp
-\&\f(CW\*(C`MATHENV\*(C'\fR (RegEx)
+\&\f(CW\*(C`ITEMCMD\*(C'\fR (RegEx)
.Sp
-\&\f(CW\*(C`MATHREPL\*(C'\fR (String)
+\&\f(CW\*(C`LISTENV\*(C'\fR (RegEx)
.Sp
\&\f(CW\*(C`MATHARRENV\*(C'\fR (RegEx)
.Sp
\&\f(CW\*(C`MATHARRREPL\*(C'\fR (String)
.Sp
-\&\f(CW\*(C`ARRENV\*(C'\fR (RegEx)
+\&\f(CW\*(C`MATHENV\*(C'\fR (RegEx)
.Sp
-\&\f(CW\*(C`COUNTERCMD\*(C'\fR (RegEx)
+\&\f(CW\*(C`MATHREPL\*(C'\fR (String)
+.Sp
+\&\f(CW\*(C`MINWORDSBLOCK\*(C'\fR (integer)
+.Sp
+\&\f(CW\*(C`PICTUREENV\*(C'\fR (RegEx)
.IP "\fB\-\-show\-safecmd\fR" 4
.IX Item "--show-safecmd"
Print list of RegEx matching and excluding safe commands.
@@ -516,7 +529,7 @@ expected, e.g. correction of typos.
.IP "\fB\-\-disable\-citation\-markup\fR or \fB\-\-disable\-auto\-mbox\fR" 4
.IX Item "--disable-citation-markup or --disable-auto-mbox"
Suppress citation markup and markup of other vulnerable commands in styles
-using ulem (\s-1UNDERLINE\s0,FONTSTRIKE, \s-1CULINECHBAR\s0)
+using ulem (\s-1UNDERLINE,FONTSTRIKE, CULINECHBAR\s0)
(the two options are identical and are simply aliases)
.IP "\fB\-\-enable\-citation\-markup\fR or \fB\-\-enforce\-auto\-mbox\fR" 4
.IX Item "--enable-citation-markup or --enforce-auto-mbox"
@@ -532,7 +545,7 @@ Default is to work silently.
.IP "\fB\-\-driver=type\fR" 4
.IX Item "--driver=type"
Choose driver for changebar package (only relevant for styles using
- changebar: \s-1CCHANGEBAR\s0 \s-1CFONTCHBAR\s0 \s-1CULINECHBAR\s0 \s-1CHANGEBAR\s0). Possible
+ changebar: \s-1CCHANGEBAR CFONTCHBAR CULINECHBAR CHANGEBAR\s0). Possible
drivers are listed in changebar manual, e.g. pdftex,dvips,dvitops
[Default: dvips]
.IP "\fB\-\-ignore\-warnings\fR" 4
@@ -688,13 +701,23 @@ Mark additions the same way as in the main text. Deleted environments are marke
Make no difference between the main text and floats.
.SS "Configuration Variables"
.IX Subsection "Configuration Variables"
-.ie n .IP """MINWORDSBLOCK""" 10
-.el .IP "\f(CWMINWORDSBLOCK\fR" 10
-.IX Item "MINWORDSBLOCK"
-Minimum number of tokens required to form an independent block. This value is
-used in the algorithm to detect changes of complete blocks by merging identical text parts of less than \f(CW\*(C`MINWORDSBLOCK\*(C'\fR to the preceding added and discarded parts.
+.ie n .IP """ARRENV""" 10
+.el .IP "\f(CWARRENV\fR" 10
+.IX Item "ARRENV"
+If a match to \f(CW\*(C`ARRENV\*(C'\fR is found within an inline math environment within a deleted or added block, then the inlined math
+is surrounded by \f(CW\*(C`\embox{\*(C'\fR...\f(CW\*(C`}\*(C'\fR. This is necessary as underlining does not work within inlined array environments.
.Sp
-[ Default: 3 ]
+[ Default: \f(CW\*(C`ARRENV\*(C'\fR=\f(CW\*(C`(?:array|[pbvBV]matrix)\*(C'\fR\
+.ie n .IP """COUNTERCMD""" 10
+.el .IP "\f(CWCOUNTERCMD\fR" 10
+.IX Item "COUNTERCMD"
+If a command in a deleted block which is also in the textcmd list matches \f(CW\*(C`COUNTERCMD\*(C'\fR then an
+additional command \f(CW\*(C`\eaddtocounter{\*(C'\fR\fIcntcmd\fR\f(CW\*(C`}{\-1}\*(C'\fR, where \fIcntcmd\fR is the matching command, is appended in the diff file such that the numbering in the diff file remains synchronized with the
+numbering in the new file.
+.Sp
+[ 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 """FLOATENV""" 10
.el .IP "\f(CWFLOATENV\fR" 10
.IX Item "FLOATENV"
@@ -703,19 +726,22 @@ considered floats. Within these environments, the \fIlatexdiff\fR markup comman
are replaced by their \s-1FL\s0 variaties.
.Sp
[ Default: \f(CW\*(C`(?:figure|table|plate)[\ew\ed*@]*\*(C'\fR\ ]
-.ie n .IP """PICTUREENV""" 10
-.el .IP "\f(CWPICTUREENV\fR" 10
-.IX Item "PICTUREENV"
-Within environments whose name matches the regular expression in \f(CW\*(C`PICTUREENV\*(C'\fR
-all latexdiff markup is removed (in pathologic cases this might lead to
- inconsistent markup but this situation should be rare).
-.Sp
-[ Default: \f(CW\*(C`(?:picture|DIFnomarkup)[\ew\ed*@]*\*(C'\fR\ ]
+.ie n .IP """ITEMCMD""" 10
+.el .IP "\f(CWITEMCMD\fR" 10
+.IX Item "ITEMCMD"
+Commands representing new item line with list environments.
+.Sp
+[ Default: \e\f(CW\*(C`item\*(C'\fR ]
+.ie n .IP """LISTENV""" 10
+.el .IP "\f(CWLISTENV\fR" 10
+.IX Item "LISTENV"
+Environments whose name matches the regular expression in \f(CW\*(C`LISTENV\*(C'\fR are list environments.
+.Sp
+[ Default: \f(CW\*(C`(?:itemize|enumerate|description)\*(C'\fR\ ]
.ie n .IP """MATHENV"",""MATHREPL""" 10
.el .IP "\f(CWMATHENV\fR,\f(CWMATHREPL\fR" 10
.IX Item "MATHENV,MATHREPL"
-If both \ebegin and \eend for a math environment (environment name matching \f(CW\*(C`MATHENV\*(C'\fR
-or \e[ and \e])
+If both \ebegin and \eend for a math environment (environment name matching \f(CW\*(C`MATHENV\*(C'\fR or \e[ and \e])
are within the same deleted block, they are replaced by a \ebegin and \eend commands for \f(CW\*(C`MATHREPL\*(C'\fR
rather than being commented out.
.Sp
@@ -726,23 +752,21 @@ rather than being commented out.
as \f(CW\*(C`MATHENV\*(C'\fR,\f(CW\*(C`MATHREPL\*(C'\fR but for equation arrays
.Sp
[ Default: \f(CW\*(C`MATHARRENV\*(C'\fR=\f(CW\*(C`eqnarray\e*?\*(C'\fR\ , \f(CW\*(C`MATHREPL\*(C'\fR=\f(CW\*(C`eqnarray\*(C'\fR\ ]
-.ie n .IP """ARRENV""" 10
-.el .IP "\f(CWARRENV\fR" 10
-.IX Item "ARRENV"
-If a match to \f(CW\*(C`ARRENV\*(C'\fR is found within an inline math environment within a deleted or added block, then the inlined math
-is surrounded by \f(CW\*(C`\embox{\*(C'\fR...\f(CW\*(C`}\*(C'\fR. This is necessary as underlining does not work within inlined array environments.
-.Sp
-[ Default: \f(CW\*(C`ARRENV\*(C'\fR=\f(CW\*(C`(?:array|[pbvBV]matrix)\*(C'\fR\
-.ie n .IP """COUNTERCMD""" 10
-.el .IP "\f(CWCOUNTERCMD\fR" 10
-.IX Item "COUNTERCMD"
-If a command in a deleted block which is also in the textcmd list matches \f(CW\*(C`COUNTERCMD\*(C'\fR then an
-additional command \f(CW\*(C`\eaddtocounter{\*(C'\fR\fIcntcmd\fR\f(CW\*(C`}{\-1}\*(C'\fR, where \fIcntcmd\fR is the matching command, is appended in the diff file such that the numbering in the diff file remains synchronized with the
-numbering in the new file.
+.ie n .IP """MINWORDSBLOCK""" 10
+.el .IP "\f(CWMINWORDSBLOCK\fR" 10
+.IX Item "MINWORDSBLOCK"
+Minimum number of tokens required to form an independent block. This value is
+used in the algorithm to detect changes of complete blocks by merging identical text parts of less than \f(CW\*(C`MINWORDSBLOCK\*(C'\fR to the preceding added and discarded parts.
.Sp
-[ Default: \f(CW\*(C`COUNTERCMD\*(C'\fR=\f(CW\*(C`(?:footnote|part|section|subsection\*(C'\fR ...
+[ Default: 3 ]
+.ie n .IP """PICTUREENV""" 10
+.el .IP "\f(CWPICTUREENV\fR" 10
+.IX Item "PICTUREENV"
+Within environments whose name matches the regular expression in \f(CW\*(C`PICTUREENV\*(C'\fR
+all latexdiff markup is removed (in pathologic cases this might lead to
+inconsistent markup but this situation should be rare).
.Sp
-\&\f(CW\*(C`|subsubsection|paragraph|subparagraph)\*(C'\fR ]
+[ Default: \f(CW\*(C`(?:picture|DIFnomarkup)[\ew\ed*@]*\*(C'\fR\ ]
.SH "COMMON PROBLEMS AND FAQ"
.IX Header "COMMON PROBLEMS AND FAQ"
.IP "Citations result in overfull boxes" 10
@@ -762,18 +786,17 @@ For custom packages you can define the commands which need to be protected by \f
.IP "Changes in complicated mathematical equations result in latex processing errors" 10
.IX Item "Changes in complicated mathematical equations result in latex processing errors"
Try options \f(CW\*(C`\-\-math\-markup=whole\*(C'\fR. If even that fails, you can turn off mark up for equations with \f(CW\*(C`\-\-math\-markup=off\*(C'\fR.
-.IP "How can I just show the pages" 10
-.IX Item "How can I just show the pages"
+.IP "How can I just show the pages where changes had been made" 10
+.IX Item "How can I just show the pages where changes had been made"
Use options \-\f(CW\*(C`\-s ZLABEL\*(C'\fR (some postprocessing required) or \f(CW\*(C`\-s ONLYCHANGEDPAGE\*(C'\fR. \f(CW\*(C`latexdiff\-vc \-\-ps|\-\-pdf\*(C'\fR with \f(CW\*(C`\-\-only\-changes\*(C'\fR option takes care of
-the post-processing for you (requires zref packages).
+the post-processing for you (requires zref package to be installed).
.SH "BUGS"
.IX Header "BUGS"
-Option allow-spaces not implemented entirely consistently. It breaks
-the rules that number and type of white space does not matter, as
-different numbers of inter-argument spaces are treated as significant.
+.IP "Option allow-spaces not implemented entirely consistently. It breaks the rules that number and type of white space does not matter, as different numbers of inter-argument spaces are treated as significant." 10
+.IX Item "Option allow-spaces not implemented entirely consistently. It breaks the rules that number and type of white space does not matter, as different numbers of inter-argument spaces are treated as significant."
.PP
Please submit bug reports using the issue tracker of the github repository page \fIhttps://github.com/ftilmann/latexdiff.git\fR,
-or send them to \fItilmann \*(-- \s-1AT\s0 \*(-- gfz\-potsdam.de\fR. Include the serial number of \fIlatexdiff\fR
+or send them to \fItilmann \*(-- \s-1AT\s0 \*(-- gfz\-potsdam.de\fR. Include the version number of \fIlatexdiff\fR
(from comments at the top of the source or use \fB\-\-version\fR). If you come across latex
files that are error-free and conform to the specifications set out
above, and whose differencing still does not result in error-free
@@ -797,7 +820,7 @@ 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.1.0
+Version 1.1.1
Copyright (C) 2004\-2015 Frederik Tilmann
.PP
This program is free software; you can redistribute it and/or modify