diff options
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/latexdiff.1')
| -rw-r--r-- | Master/texmf-dist/doc/man/man1/latexdiff.1 | 153 |
1 files changed, 105 insertions, 48 deletions
diff --git a/Master/texmf-dist/doc/man/man1/latexdiff.1 b/Master/texmf-dist/doc/man/man1/latexdiff.1 index cc7c69a5fd5..24834cbde14 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.25 (Pod::Simple 3.16) .\" .\" Standard preamble: .\" ======================================================================== @@ -38,8 +38,6 @@ . ds PI \(*p . ds L" `` . ds R" '' -. ds C` -. ds C' 'br\} .\" .\" Escape single quotes in literal strings from groff's Unicode transform. @@ -50,24 +48,17 @@ .\" 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. -.\" -.\" Avoid warning from groff about undefined register 'F'. -.de IX +.ie \nF \{\ +. de IX +. tm Index:\\$1\t\\n%\t"\\$2" .. -.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" +. nr % 0 +. rr F +.\} +.el \{\ +. de IX .. -. 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. @@ -133,7 +124,7 @@ .\" ======================================================================== .\" .IX Title "LATEXDIFF 1" -.TH LATEXDIFF 1 "2014-07-21" "perl v5.18.2" " " +.TH LATEXDIFF 1 "2015-04-14" "perl v5.14.2" " " .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -271,7 +262,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\*(C'\fR +CHANGEBAR CCHANGEBAR CULINECHBAR CFONTCBHBAR BOLD\*(C'\fR .Sp [ Default: \f(CW\*(C`UNDERLINE\*(C'\fR ] .IP "\fB\-\-subtype=markstyle\fR or \fB\-s markstyle\fR" 4 @@ -279,9 +270,10 @@ CHANGEBAR CCHANGEBAR CULINECHBAR CFONTCBHBAR\*(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 LABEL\*(C'\fR +Available styles: \f(CW\*(C`SAFE MARGINAL COLOR DVIPSCOL ZLABEL ONLYCHANGEDPAGE (LABEL)*\*(C'\fR .Sp [ Default: \f(CW\*(C`SAFE\*(C'\fR ] +* Subtype \f(CW\*(C`LABEL\*(C'\fR is deprecated .IP "\fB\-\-floattype=markstyle\fR or \fB\-f markstyle\fR" 4 .IX Item "--floattype=markstyle or -f markstyle" Add code to preamble for selected style which @@ -302,7 +294,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" @@ -327,7 +319,8 @@ The following packages trigger special behaviour: .ie n .IP """amsmath""" 8 .el .IP "\f(CWamsmath\fR" 8 .IX Item "amsmath" -Configuration variable amsmath is set to \f(CW\*(C`align*\*(C'\fR (Default: \f(CW\*(C`eqnarray*\*(C'\fR) +Configuration variable \s-1MATHARRREPL\s0 is set to \f(CW\*(C`align*\*(C'\fR (Default: \f(CW\*(C`eqnarray*\*(C'\fR). (Note that many of the +amsmath array environments are already recognised by default as such) .ie n .IP """endfloat""" 8 .el .IP "\f(CWendfloat\fR" 8 .IX Item "endfloat" @@ -343,11 +336,31 @@ errors). .el .IP "\f(CWapacite\fR" 8 .IX Item "apacite" Redefine the commands recognised as citation commands. +.ie n .IP """siunitx""" 8 +.el .IP "\f(CWsiunitx\fR" 8 +.IX Item "siunitx" +Treat \f(CW\*(C`\eSI\*(C'\fR as equivalent to citation commands (i.e. protect with \f(CW\*(C`\embox\*(C'\fR if markup style uses ulem package. +.ie n .IP """cleveref""" 8 +.el .IP "\f(CWcleveref\fR" 8 +.IX Item "cleveref" +Treat \f(CW\*(C`\ecref,\eCref\*(C'\fR, etc as equivalent to citation commands (i.e. protect with \f(CW\*(C`\embox\*(C'\fR if markup style uses ulem package. +.ie n .IP """glossaries""" 8 +.el .IP "\f(CWglossaries\fR" 8 +.IX Item "glossaries" +Define most of the glossaries commands as safe, protecting them with \embox'es where needed +.ie n .IP """mhchem""" 8 +.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" +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 .Sp -[ Default: scan the preamble for \f(CW\*(C`\e\eusepackage\*(C'\fR commands to determine - loaded packages.] +[ Default: scan the preamble for \f(CW\*(C`\eusepackage\*(C'\fR commands to determine + loaded packages. ] .RE .IP "\fB\-\-show\-preamble\fR" 4 .IX Item "--show-preamble" @@ -356,7 +369,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" @@ -407,11 +420,28 @@ 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 As corresponding commands for context1. The only difference is that context2 commands are completely disabled in deleted sections, including their arguments." 4 -.el .IP "\fB\-\-append\-context2cmd=append\-file\fR or =item \fB\-\-append\-context2cmd=``cmd1,cmd2,...''\fR As corresponding commands for context1. The only difference is that context2 commands are completely disabled in deleted sections, including their arguments." 4 -.IX Item "--append-context2cmd=append-file or =item --append-context2cmd=cmd1,cmd2,... As corresponding commands for context1. The only difference is that context2 commands are completely disabled in deleted sections, including their arguments." +.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,..." +.PD +As corresponding commands for context1. The only difference is that +context2 commands are completely disabled in deleted sections, including +their arguments. +.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,..." +.PD 0 +.ie n .IP "\fB\-\-append\-mboxsafecmd=append\-file\fR or \fB\-\-append\-mboxsafecmd=""cmd1,cmd2,...""\fR" 4 +.el .IP "\fB\-\-append\-mboxsafecmd=append\-file\fR or \fB\-\-append\-mboxsafecmd=``cmd1,cmd2,...''\fR" 4 +.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 +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 .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\-c configfile\fR" 4 .IX Item "-c configfile" .PD @@ -483,13 +513,16 @@ being changed. [Default] \&\f(CW\*(C`fine\*(C'\fR or \f(CW3\fR: Detect small change in equations and mark up at fine granularity. This mode is most suitable, if only minor changes to equations are expected, e.g. correction of typos. -.IP "\fB\-\-disable\-citation\-markup\fR" 4 -.IX Item "--disable-citation-markup" -Suppress citation markup in styles using ulem (\s-1UNDERLINE, -FONTSTRIKE, CULINECHBAR\s0) -.IP "\fB\-\-enable\-citation\-markup\fR" 4 -.IX Item "--enable-citation-markup" -Protect citation commands in changed sections with \e\embox command [i.e. use default behaviour for ulem package for other packages] +.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) +(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" +Protect citation commands and other vulnerable commands in changed sections +with \f(CW\*(C`\embox\*(C'\fR command, i.e. use default behaviour for ulem package for other packages +(the two options are identical and are simply aliases) .SS "Miscellaneous" .IX Subsection "Miscellaneous" .IP "\fB\-\-verbose\fR or \fB\-V\fR" 4 @@ -499,7 +532,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 CFONTCHBAR CULINECHBAR CHANGEBAR\s0). Possible + changebar: \s-1CCHANGEBAR\s0 \s-1CFONTCHBAR\s0 \s-1CULINECHBAR\s0 \s-1CHANGEBAR\s0). Possible drivers are listed in changebar manual, e.g. pdftex,dvips,dvitops [Default: dvips] .IP "\fB\-\-ignore\-warnings\fR" 4 @@ -522,7 +555,7 @@ labels like this \f(CW\*(C`\-L labelold \-L labelnew\*(C'\fR. Suppress inclusion of old and new file names as comment in output file .IP "\fB\-\-visble\-label\fR" 4 .IX Item "--visble-label" -Include old and new filenames (or labels set with \-\-label option) as +Include old and new filenames (or labels set with \f(CW\*(C`\-\-label\*(C'\fR option) as visible output. .IP "\fB\-\-flatten\fR" 4 .IX Item "--flatten" @@ -592,6 +625,10 @@ No mark up of text, but mark margins with changebars (Requires changebar package .el .IP "\f(CWINVISIBLE\fR" 10 .IX Item "INVISIBLE" No visible markup (but generic markup commands will still be inserted. +.ie n .IP """BOLD""" 10 +.el .IP "\f(CWBOLD\fR" 10 +.IX Item "BOLD" +Added text is set in bold face, discarded is not shown. .SS "Subtypes" .IX Subsection "Subtypes" The subtype defines the commands that are inserted at the begin and end of added or discarded blocks, irrespectively of whether these blocks contain text or commands (Defined commands: \f(CW\*(C`\eDIFaddbegin, \eDIFaddend, \eDIFdelbegin, \eDIFdelend\*(C'\fR) @@ -619,6 +656,19 @@ An alternative way of marking added passages in blue, and deleted ones in red. N that \f(CW\*(C`DVIPSCOL\*(C'\fR only works with the dvips converter, e.g. not pdflatex. (it is recommeneded to use instead the main types to effect colored markup, although in some cases coloring with dvipscol can be more complete). +.ie n .IP """ZLABEL""" 10 +.el .IP "\f(CWZLABEL\fR" 10 +.IX Item "ZLABEL" +can be used to highlight only changed pages, but requires post-processing. It is recommend to not call this option manually but use \f(CW\*(C`latexdiff\-vc\*(C'\fR with \f(CW\*(C`\-\-only\-changes\*(C'\fR option. Alternatively, use the script given within preamble of diff files made using this style. +.ie n .IP """ONLYCHANGEDPAGE""" 10 +.el .IP "\f(CWONLYCHANGEDPAGE\fR" 10 +.IX Item "ONLYCHANGEDPAGE" +also highlights changed pages, without the need for post-processing, but might not work reliably if +there is floating material (figures, tables). +.ie n .IP """LABEL""" 10 +.el .IP "\f(CWLABEL\fR" 10 +.IX Item "LABEL" +is similar to \f(CW\*(C`ZLABEL\*(C'\fR, but does not need the zref package and works less reliably (deprecated). .SS "Float Types" .IX Subsection "Float Types" Some of the markup used in the main text might cause problems when used within @@ -693,22 +743,29 @@ 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 ] -.SH "COMMON PROBLEMS" -.IX Header "COMMON PROBLEMS" +.SH "COMMON PROBLEMS AND FAQ" +.IX Header "COMMON PROBLEMS AND FAQ" .IP "Citations result in overfull boxes" 10 .IX Item "Citations result in overfull boxes" There is an incompatibility between the \f(CW\*(C`ulem\*(C'\fR package, which \f(CW\*(C`latexdiff\*(C'\fR uses for underlining and striking out in the \s-1UNDERLINE\s0 style, -the default style. In order to be able to mark up citations properly, they are placed with an \f(CW\*(C`\embox\*(C'\fR command in post-processing. As mboxes -cannot be broken across lines, this procedure frequently results in overfull boxes, possibly obscuring the content as it extends beyond the right margin. If this is a problem, you have two possibilities: +the default style, and the way citations are generated. In order to be able to mark up citations properly, they are enclosed with an \f(CW\*(C`\embox\*(C'\fR +command. As mboxes cannot be broken across lines, this procedure frequently results in overfull boxes, possibly obscuring the content as it extends beyond the right margin. The same occurs for some other packages (e.g., siunitx). If this is a problem, you have two possibilities. .Sp -1. Use \f(CW\*(C`COLOR\*(C'\fR or \f(CW\*(C`DVIPSCOL\*(C'\fR subtype markup (option \f(CW\*(C`\-s COLOR\*(C'\fR): If this markup is chosen, then changed citations are no longer marked up -with the wavy line (additions) or struck out (deletions), but are still highlighted in the appropriate color. +1. Use \f(CW\*(C`CFONT\*(C'\fR type markup (option \f(CW\*(C`\-t CFONT\*(C'\fR): If this markup is chosen, then changed citations are no longer marked up +with the wavy line (additions) or struck out (deletions), but are still highlighted in the appropriate color, and deleted text is shown with a different font. Other styles not using the \f(CW\*(C`ulem\*(C'\fR package will also work. .Sp 2. Choose option \f(CW\*(C`\-\-disable\-citation\-markup\*(C'\fR which turns off the marking up of citations: deleted citations are no longer shown, and -added ctations are shown without markup. (This was the default behaviour of latexdiff at versions 0.6 and older) +added citations are shown without markup. (This was the default behaviour of latexdiff at versions 0.6 and older) +.Sp +For custom packages you can define the commands which need to be protected by \f(CW\*(C`\embox\*(C'\fR with \f(CW\*(C`\-\-append\-mboxsafecmd\*(C'\fR and \f(CW\*(C`\-\-excludemboxsafecmd\*(C'\fR options +(submit your lists of command as feature request at github page to set the default behaviour of future versions, see section 6) .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" +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). .SH "BUGS" .IX Header "BUGS" Option allow-spaces not implemented entirely consistently. It breaks @@ -716,7 +773,7 @@ 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@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 serial 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 @@ -740,8 +797,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.0.4 -Copyright (C) 2004\-2012 Frederik Tilmann +Version 1.1.0 +Copyright (C) 2004\-2015 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 |