diff options
Diffstat (limited to 'Master/texmf/doc/man')
| -rw-r--r-- | Master/texmf/doc/man/man1/latexdiff-vc.1 | 75 | ||||
| -rw-r--r-- | Master/texmf/doc/man/man1/latexdiff-vc.man1.pdf | bin | 8339 -> 8547 bytes | |||
| -rw-r--r-- | Master/texmf/doc/man/man1/latexdiff.1 | 266 | ||||
| -rw-r--r-- | Master/texmf/doc/man/man1/latexdiff.man1.pdf | bin | 30073 -> 34808 bytes | |||
| -rw-r--r-- | Master/texmf/doc/man/man1/latexrevise.1 | 58 | ||||
| -rw-r--r-- | Master/texmf/doc/man/man1/latexrevise.man1.pdf | bin | 8667 -> 8915 bytes |
6 files changed, 251 insertions, 148 deletions
diff --git a/Master/texmf/doc/man/man1/latexdiff-vc.1 b/Master/texmf/doc/man/man1/latexdiff-vc.1 index 1c5946d6fdf..497b8fed20b 100644 --- a/Master/texmf/doc/man/man1/latexdiff-vc.1 +++ b/Master/texmf/doc/man/man1/latexdiff-vc.1 @@ -1,15 +1,7 @@ -.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) .\" .\" Standard preamble: .\" ======================================================================== -.de Sh \" Subsection heading -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp @@ -25,11 +17,11 @@ .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. | will give a -.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to -.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' -.\" expand to `' in nroff, nothing in troff, for use with C<>. -.tr \(*W-|\(bv\*(Tr +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- @@ -48,22 +40,25 @@ . ds R" '' 'br\} .\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" 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. -.if \nF \{\ +.ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} -.\" -.\" For nroff, turn off justification. Always turn off hyphenation; it makes -.\" way too many mistakes in technical documents. -.hy 0 -.if n .na +.el \{\ +. de IX +.. +.\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -129,7 +124,11 @@ .\" ======================================================================== .\" .IX Title "LATEXDIFF-VC 1" -.TH LATEXDIFF-VC 1 "2007-07-24" "perl v5.8.5" " " +.TH LATEXDIFF-VC 1 "2012-12-16" "perl v5.12.4" " " +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh .SH "NAME" latexdiff\-vc \- wrapper script that calls latexdiff for different versions of a file under version management (CVS, RCS or SVN) .SH "SYNOPSIS" @@ -144,15 +143,15 @@ latexdiff\-vc \- wrapper script that calls latexdiff for different versions of a .SH "DESCRIPTION" .IX Header "DESCRIPTION" \&\fIlatexdiff-vc\fR is a wrapper script that applies \fIlatexdiff\fR to a -file, or multiple files under version control (\s-1CVS\s0 or \s-1RCS\s0), and optionally runs the +file, or multiple files under version control (\s-1CVS\s0, \s-1RCS\s0 or \s-1SVN\s0), and optionally runs the sequence of \f(CW\*(C`latex\*(C'\fR and \f(CW\*(C`dvips\*(C'\fR or \f(CW\*(C`pdflatex\*(C'\fR commands necessary to produce pdf or postscript output of the difference tex file(s). It can also be applied to a pair of files to automatise the generation of difference file in postscript or pdf format. .SH "OPTIONS" .IX Header "OPTIONS" -.IP "\fB\-\-rcs\fR, \fB\-\-svn\fR, or \fB\-\-cvs\fR" 4 -.IX Item "--rcs, --svn, or --cvs" +.IP "\fB\-\-rcs\fR, \fB\-\-svn\fR, \fB\-\-cvs\fR, or \fB\-\-git\fR" 4 +.IX Item "--rcs, --svn, --cvs, or --git" Set the version system. If no version system is specified, latexdiff-vc will venture a guess. .Sp @@ -160,8 +159,8 @@ latexdiff-cvs and latexdiff-rcs are variants of latexdiff-vc which default to the respective versioning system. However, this default can still be overridden using the options above. .IP "\fB\-r\fR, \fB\-r\fR \fIrev\fR or \fB\-\-revision\fR, \fB\-\-revision=\fR\fIrev\fR" 4 .IX Item "-r, -r rev or --revision, --revision=rev" -Choose revision (under \s-1RCS\s0, \s-1CVS\s0 or \s-1SVN\s0). One or two \fB\-r\fR options can be -specified, and the resulting in different behaviour: +Choose revision (under \s-1RCS\s0, \s-1CVS\s0, \s-1SVN\s0 or \s-1GIT\s0). One or two \fB\-r\fR options can be +specified, and they result in different behaviour: .RS 4 .IP "\fBlatexdiff-vc\fR \-r \fIfile.tex\fR ..." 4 .IX Item "latexdiff-vc -r file.tex ..." @@ -187,10 +186,13 @@ reported to stdout. .IP "\fB\-d\fR or \fB\-\-dir\fR \fB\-d\fR \fIpath\fR or \fB\-\-dir=\fR\fIpath\fR" 4 .IX Item "-d or --dir -d path or --dir=path" Rather than appending the string \f(CW\*(C`diff\*(C'\fR and optionally the version -numbers given to the output\-file, this will prepend a directory name \f(CW\*(C`diff\*(C'\fR +numbers given to the output-file, this will prepend a directory name \f(CW\*(C`diff\*(C'\fR to the original filename, creating the directory and subdirectories should they not exist already. This is particularly useful in order to clone a complete directory hierarchy. Optionally, a pathname \fIpath\fR can be specified, which is prepended instead of \f(CW\*(C`diff\*(C'\fR. +.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). .IP "\fB\-\-ps\fR or \fB\-\-postscript\fR" 4 .IX Item "--ps or --postscript" Generate postscript output from difference file. This will run the @@ -226,10 +228,19 @@ latexdiff limited to Unix-like systems. It also requires the \s-1RCS\s0 version control system and latex to be installed on the system. Modules from Perl 5.8 or higher are required. -.SH "AUTHOR" -.IX Header "AUTHOR" -Copyright (C) 2005 Frederik Tilmann +.SH "BUG REPORTING" +.IX Header "BUG REPORTING" +.Vb 6 +\& Please submit bug reports through +\&the latexdiff project page I<http://developer.berlios.de/projects/latexdiff/> or send +\&to I<tilmann@gfz\-potsdam.de>. Include the serial number of I<latexdiff\-vc> +\&(option C<\-\-version>) +\&. +\&=head1 AUTHOR +.Ve +.PP +Copyright (C) 2005,2012 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 2 +it under the terms of the \s-1GNU\s0 General Public License Version 3 Contributors: S Utcke, H Bruyninckx diff --git a/Master/texmf/doc/man/man1/latexdiff-vc.man1.pdf b/Master/texmf/doc/man/man1/latexdiff-vc.man1.pdf Binary files differindex 4006570e376..779eaa29e23 100644 --- a/Master/texmf/doc/man/man1/latexdiff-vc.man1.pdf +++ b/Master/texmf/doc/man/man1/latexdiff-vc.man1.pdf diff --git a/Master/texmf/doc/man/man1/latexdiff.1 b/Master/texmf/doc/man/man1/latexdiff.1 index 7b6653fca4e..2f075daa0a9 100644 --- a/Master/texmf/doc/man/man1/latexdiff.1 +++ b/Master/texmf/doc/man/man1/latexdiff.1 @@ -1,15 +1,7 @@ -.\" Automatically generated by Pod::Man v1.34, Pod::Parser v1.13 +.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) .\" .\" Standard preamble: .\" ======================================================================== -.de Sh \" Subsection heading -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp @@ -25,11 +17,11 @@ .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. | will give a -.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to -.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' -.\" expand to `' in nroff, nothing in troff, for use with C<>. -.tr \(*W-|\(bv\*(Tr +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- @@ -48,22 +40,25 @@ . ds R" '' 'br\} .\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" 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. -.if \nF \{\ +.ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} -.\" -.\" For nroff, turn off justification. Always turn off hyphenation; it makes -.\" way too many mistakes in technical documents. -.hy 0 -.if n .na +.el \{\ +. de IX +.. +.\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -129,7 +124,11 @@ .\" ======================================================================== .\" .IX Title "LATEXDIFF 1" -.TH LATEXDIFF 1 "2007-10-19" "perl v5.8.0" " " +.TH LATEXDIFF 1 "2012-12-16" "perl v5.12.4" " " +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh .SH "NAME" latexdiff \- determine and markup differences between two latex files .SH "SYNOPSIS" @@ -157,25 +156,21 @@ differences, the resulting file \f(CW\*(C`diff.tex\*(C'\fR will be similar to \&\f(CW\*(C`new.tex\*(C'\fR. At the end of the preamble, the definitions for \fIlatexdiff\fR markup commands are inserted. In differencing the main body of the text, \fIlatexdiff\fR attempts to satisfy the following guidelines (in order of priority): -.IP "1" 3 -.IX Item "1" +.IP "1." 3 If both \f(CW\*(C`old.tex\*(C'\fR and \f(CW\*(C`new.tex\*(C'\fR are valid LaTeX, then the resulting \&\f(CW\*(C`diff.tex\*(C'\fR should also be valid LateX. (\s-1NB\s0 If a few plain TeX commands are used within \f(CW\*(C`old.tex\*(C'\fR or \f(CW\*(C`new.tex\*(C'\fR then \f(CW\*(C`diff.tex\*(C'\fR is not guaranteed to work but usually will). -.IP "2" 3 -.IX Item "2" +.IP "2." 3 Significant differences are determined on the level of individual words. All significant differences, including differences between comments should be clearly marked in the resulting source code \&\f(CW\*(C`diff.tex\*(C'\fR. -.IP "3" 3 -.IX Item "3" +.IP "3." 3 If a changed passage contains text or text-producing commands, then running \f(CW\*(C`diff.tex\*(C'\fR through LateX should produce output where added and discarded passages are highlighted. -.IP "4" 3 -.IX Item "4" +.IP "4." 3 Where there are insignificant differences, e.g. in the positioning of line breaks, \f(CW\*(C`diff.tex\*(C'\fR should follow the formatting of \f(CW\*(C`new.tex\*(C'\fR .PP @@ -195,7 +190,7 @@ curly braces immediately following a command (i.e. a sequence of letters beginning with a backslash) are arguments for that command. As a restriction to condition 1 above it is thus necessary to surround all arguments with curly braces, and to not insert -extraneous spaces. For example, write +extraneous spaces. For example, write .PP .Vb 1 \& \esection{\etextem{This is an emphasized section title}} @@ -225,7 +220,7 @@ protect parts of the latex file where the markup results in illegal markup. You have to surround the offending passage in both the old and new file by \f(CW\*(C`\ebegin{DIFnomarkup}\*(C'\fR and \f(CW\*(C`\eend{DIFnomarkup}\*(C'\fR. You must define the environment in the preambles of both old and new -documents. I prefer to define it as a null\-environment, +documents. I prefer to define it as a null-environment, .PP \&\f(CW\*(C`\enewenvironment{DIFnomarkup}{}{}\*(C'\fR .PP @@ -255,7 +250,7 @@ and curly braces within deleted blocks are commented out with \&\*(R"\f(CW\*(C`%DIFDELCMD\ <\ \*(C'\fR". .SH "OPTIONS" .IX Header "OPTIONS" -.Sh "Preamble" +.SS "Preamble" .IX Subsection "Preamble" The following options determine the visual markup style by adding the appropriate command definitions to the preamble. See the end of this section for a description of @@ -264,7 +259,7 @@ available styles. .IX Item "--type=markupstyle or -t markupstyle" Add code to preamble for selected markup style. This option defines \&\f(CW\*(C`\eDIFadd\*(C'\fR and \f(CW\*(C`\eDIFdel\*(C'\fR commands. -Available styles: +Available styles: .Sp \&\f(CW\*(C`UNDERLINE CTRADITIONAL TRADITIONAL CFONT FONTSTRIKE INVISIBLE CHANGEBAR CCHANGEBAR CULINECHBAR CFONTCBHBAR\*(C'\fR @@ -275,7 +270,7 @@ 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 DVIPSCOL\*(C'\fR +Available styles: \f(CW\*(C`SAFE MARGINAL COLOR DVIPSCOL\*(C'\fR .Sp [ Default: \f(CW\*(C`SAFE\*(C'\fR ] .IP "\fB\-\-floattype=markstyle\fR or \fB\-f markstyle\fR" 4 @@ -292,9 +287,9 @@ Available styles: \f(CW\*(C`FLOATSAFE TRADITIONALSAFE IDENTICAL\*(C'\fR .IX Item "--encoding=enc or -e enc" Specify encoding of old.tex and new.tex. Typical encodings are \&\f(CW\*(C`ascii\*(C'\fR, \f(CW\*(C`utf8\*(C'\fR, \f(CW\*(C`latin1\*(C'\fR, \f(CW\*(C`latin9\*(C'\fR. A list of available encodings can be -obtained by executing +obtained by executing .Sp -\&\f(CW\*(C`perl \-MEncode \-e 'print join ("\en",Encode\-\*(C'\fRencodings( \*(L":all\*(R" )) ;' > +\&\f(CW\*(C`perl \-MEncode \-e \*(Aqprint join ("\en",Encode\-\*(C'\fRencodings( \*(L":all\*(R" )) ;' > .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 @@ -344,7 +339,7 @@ errors). .IP "\fB\-\-show\-preamble\fR" 4 .IX Item "--show-preamble" Print generated or included preamble commands to stdout. -.Sh "Configuration" +.SS "Configuration" .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 @@ -396,8 +391,8 @@ context to work, e.g. \ecaption 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\-context1cmd=replace\-file\fR" 4 -.IX Item "--replace-context1cmd=replace-file" +.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 @@ -409,7 +404,7 @@ argument is shown as deleted text. .PD 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): +Available variables (see below for further explanations): .Sp \&\f(CW\*(C`MINWORDSBLOCK\*(C'\fR (integer) .Sp @@ -443,29 +438,87 @@ Combine all \-\-show commands. .Sp \&\s-1NB\s0 For all \-\-show commands, no \f(CW\*(C`old.tex\*(C'\fR or \f(CW\*(C`new.tex\*(C'\fR file needs to be specified, and no differencing takes place. -.Sh "Miscellaneous" +.SS "Other configuration options:" +.IX Subsection "Other configuration options:" +.IP "\fB\-\-allow\-spaces\fR" 4 +.IX Item "--allow-spaces" +Allow spaces between bracketed or braced arguments to commands. Note +that this option might have undesirable side effects (unrelated scope +might get lumpeded with preceding commands) so should only be used if the +default produces erroneous results. (Default requires arguments to +directly follow each other without intervening spaces). +.IP "\fB\-\-math\-markup=level\fR" 4 +.IX Item "--math-markup=level" +Determine granularity of markup in displayed math environments: +Possible values for level are (both numerical and text labels are acceptable): +.Sp +\&\f(CW\*(C`off\*(C'\fR or \f(CW0\fR: suppress markup for math environments. Deleted equations will not +appear in diff file. This mode can be used if all the other modes +cause invalid latex code. +.Sp +\&\f(CW\*(C`whole\*(C'\fR or \f(CW1\fR: Differencing on the level of whole equations. Even trivial changes +to equations cause the whole equation to be marked changed. This +mode can be used if processing in coarse or fine mode results in +invalid latex code. +.Sp +\&\f(CW\*(C`coarse\*(C'\fR or \f(CW2\fR: Detect changes within equations marked up with a coarse +granularity; changes in equation type (e.g.displaymath to equation) +appear as a change to the complete equation. This mode is recommended +for situations where the content and order of some equations are still +being changed. [Default] +.Sp +\&\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\s0, +\&\s-1FONTSTRIKE\s0, \s-1CULINECHBAR\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] +.SS "Miscellaneous" .IX Subsection "Miscellaneous" -.IP "\fB\-\-verbose\fR or \fB\-V\fR" 4 -.IX Item "--verbose or -V" +.RS 4 Output various status information to stderr during processing. Default is to work silently. -.IP "\fB\-\-ignore\-warnings\fR" 4 -.IX Item "--ignore-warnings" +.Sp +\&\fB\-\-driver=type\fR +.Sp +Choose driver for changebar package (only relevant for styles using + 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] +.Sp +\&\fB\-\-ignore\-warnings\fR +.Sp Suppress warnings about inconsistencies in length between input and parsed strings and missing characters. These warning messages are often related to non-standard latex or latex constructions with a syntax unknown to \f(CW\*(C`latexdiff\*(C'\fR but the resulting difference argument is often fully functional anyway, particularly if the non-standard latex only occurs in parts of the text which have not changed. -.IP "\fB\-\-allow\-spaces\fR" 4 -.IX Item "--allow-spaces" -Allow spaces between bracketed or braced arguments to commands. Note -that this option might have undesirable side effects (unrelated scope -might get lumpeded with preceding commands) so should only be used if the -default produces erroneous results. (Default requires arguments to -directly follow each other without intervening spaces). -.IP "\fB\-\-flatten\fR" 4 -.IX Item "--flatten" +.Sp +\&\fB\-\-label=label\fR or +\&\fB\-L label\fR +.Sp +Sets the labels used to describe the old and new files. The first use +of this option sets the label describing the old file and the second +use of the option sets the label for the new file, i.e. set both +labels like this \f(CW\*(C`\-L labelold \-L labelnew\*(C'\fR. +[Default: use the filename and modification dates for the label] +.Sp +\&\fB\-\-no\-label\fR +.Sp +Suppress inclusion of old and new file names as comment in output file +.Sp +\&\fB\-\-visble\-label\fR +.Sp +Include old and new filenames (or labels set with \-\-label option) as +visible output. +.Sp +\&\fB\-\-flatten\fR +.Sp Replace \f(CW\*(C`\einput\*(C'\fR and \f(CW\*(C`\einclude\*(C'\fR commands within body by the content of the files in their argument. If \f(CW\*(C`\eincludeonly\*(C'\fR is present in the preamble, only those files are expanded into the document. However, @@ -473,20 +526,25 @@ no recursion is done, i.e. \f(CW\*(C`\einput\*(C'\fR and \f(CW\*(C`\einclude\*(C included sections are not expanded. The included files are assumed to be located in the same directories as the old and new master files, respectively, making it possible to organise files into old and new directories. +\&\-\-flatten is applied recursively, so inputted files can contain further +\&\f(CW\*(C`\einput\*(C'\fR statements. +.Sp +Use of this option might result in prohibitive processing times for +larger documents, and the resulting difference document +no longer reflects the structure of the input documents. +.Sp +\&\fB\-\-help\fR or +\&\fB\-h\fR .Sp -Use of this option is not recommended -primarily the processing time for the large documents is prohibitive, and -the resulting difference document no longer reflects the structure of the -input documents. -.IP "\fB\-\-help\fR or \fB\-h\fR" 4 -.IX Item "--help or -h" Show help text -.IP "\fB\-\-version\fR" 4 -.IX Item "--version" +.Sp +\&\fB\-\-version\fR +.Sp Show version number -.Sh "Predefined styles" +.RE +.SS "Predefined styles" .IX Subsection "Predefined styles" -.Sh "Major types" +.SS "Major types" .IX Subsection "Major types" The major type determine the markup of plain text and some selected latex commands outside floats by defining the markup commands \f(CW\*(C`\eDIFadd{...}\*(C'\fR and \f(CW\*(C`\eDIFdel{...}\*(C'\fR . .ie n .IP """UNDERLINE""" 10 @@ -497,7 +555,7 @@ Added text is wavy-underlined and blue, discarded text is struck out and red .ie n .IP """CTRADITIONAL""" 10 .el .IP "\f(CWCTRADITIONAL\fR" 10 .IX Item "CTRADITIONAL" -Added text is blue and set in sans\-serif, and a red footnote is created for each discarded +Added text is blue and set in sans-serif, and a red footnote is created for each discarded piece of text. (Requires color package) .ie n .IP """TRADITIONAL""" 10 .el .IP "\f(CWTRADITIONAL\fR" 10 @@ -506,11 +564,11 @@ Like \f(CW\*(C`CTRADITIONAL\*(C'\fR but without the use of color. .ie n .IP """CFONT""" 10 .el .IP "\f(CWCFONT\fR" 10 .IX Item "CFONT" -Added text is blue and set in sans\-serif, and discarded text is red and very small size. +Added text is blue and set in sans-serif, and discarded text is red and very small size. .ie n .IP """FONTSTRIKE""" 10 .el .IP "\f(CWFONTSTRIKE\fR" 10 .IX Item "FONTSTRIKE" -Added tex is set in sans\-serif, discarded text small and struck out +Added tex is set in sans-serif, discarded text small and struck out .ie n .IP """CCHANGEBAR""" 10 .el .IP "\f(CWCCHANGEBAR\fR" 10 .IX Item "CCHANGEBAR" @@ -531,9 +589,9 @@ 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. -.Sh "Subtypes" +.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) +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) .ie n .IP """SAFE""" 10 .el .IP "\f(CWSAFE\fR" 10 .IX Item "SAFE" @@ -544,6 +602,13 @@ No additional markup (Recommended choice) Mark beginning and end of changed blocks with symbols in the margin nearby (using the standard \f(CW\*(C`\emarginpar\*(C'\fR command \- note that this sometimes moves somewhat from the intended position. +.ie n .IP """COLOR""" 10 +.el .IP "\f(CWCOLOR\fR" 10 +.IX Item "COLOR" +An alternative way of marking added passages in blue, and deleted ones in red. +(It is recommeneded to use instead the main types to effect colored markup, +although in some cases coloring with dvipscol can be more complete, for example +with citation commands). .ie n .IP """DVIPSCOL""" 10 .el .IP "\f(CWDVIPSCOL\fR" 10 .IX Item "DVIPSCOL" @@ -551,7 +616,7 @@ 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). -.Sh "Float Types" +.SS "Float Types" .IX Subsection "Float Types" Some of the markup used in the main text might cause problems when used within floats (e.g. figures or tables). For this reason alternative versions of all @@ -559,7 +624,7 @@ markup commands are used within floats. The float type defines these alternative .ie n .IP """FLOATSAFE""" 10 .el .IP "\f(CWFLOATSAFE\fR" 10 .IX Item "FLOATSAFE" -Use identical markup for text as in the main body, but set all commands marking the begin and end of changed blocks to null\-commands. You have to choose this float type if your subtype is \f(CW\*(C`MARGIN\*(C'\fR as \f(CW\*(C`\emarginpar\*(C'\fR does not work properly within floats. +Use identical markup for text as in the main body, but set all commands marking the begin and end of changed blocks to null-commands. You have to choose this float type if your subtype is \f(CW\*(C`MARGIN\*(C'\fR as \f(CW\*(C`\emarginpar\*(C'\fR does not work properly within floats. .ie n .IP """TRADITIONALSAFE""" 10 .el .IP "\f(CWTRADITIONALSAFE\fR" 10 .IX Item "TRADITIONALSAFE" @@ -568,7 +633,7 @@ Mark additions the same way as in the main text. Deleted environments are marke .el .IP "\f(CWIDENTICAL\fR" 10 .IX Item "IDENTICAL" Make no difference between the main text and floats. -.Sh "Configuration Variables" +.SS "Configuration Variables" .IX Subsection "Configuration Variables" .ie n .IP """MINWORDSBLOCK""" 10 .el .IP "\f(CWMINWORDSBLOCK\fR" 10 @@ -593,7 +658,7 @@ 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 """MATHENV""\fR,\f(CW""MATHREPL""" 10 +.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 @@ -602,7 +667,7 @@ are within the same deleted block, they are replaced by a \ebegin and \eend comm rather than being commented out. .Sp [ Default: \f(CW\*(C`MATHENV\*(C'\fR=\f(CW\*(C`(?:displaymath|equation)\*(C'\fR\ , \f(CW\*(C`MATHREPL\*(C'\fR=\f(CW\*(C`displaymath\*(C'\fR\ ] -.ie n .IP """MATHARRENV""\fR,\f(CW""MATHARRREPL""" 10 +.ie n .IP """MATHARRENV"",""MATHARRREPL""" 10 .el .IP "\f(CWMATHARRENV\fR,\f(CWMATHARRREPL\fR" 10 .IX Item "MATHARRENV,MATHARRREPL" as \f(CW\*(C`MATHENV\*(C'\fR,\f(CW\*(C`MATHREPL\*(C'\fR but for equation arrays @@ -614,7 +679,7 @@ as \f(CW\*(C`MATHENV\*(C'\fR,\f(CW\*(C`MATHREPL\*(C'\fR but for equation arrays 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\ +[ 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" @@ -625,25 +690,42 @@ 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" +.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: +.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. +.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) +.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. .SH "BUGS" .IX Header "BUGS" -\&\s-1UTF\-8\s0 support requires a relatively new version of perl (5.8.0 is sufficient -but 5.6.2 up would work \s-1OK\s0, too). -.PP 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 send bug reports -to \fItilmann@esc.cam.ac.uk\fR. Include the serial number of \fIlatexdiff\fR +Please submit bug reports on the latexdiff project page \fIhttp://latexdiff.berlios.de\fR, +send them to user discussion list \f(CW\*(C`latexdiff\-users@lists.berlios,de\*(C'\fR (prior subscription +to list required, also on project webpage) +or send them to \fItilmann@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 latex, please send me those files, ideally edited to only contain the -offending passage as long as that still reproduces the problem. +offending passage as long as that still reproduces the problem. If your +file relies on non-standard class files, you must include those. I will not +look at examples where I have trouble to latex the original files. .SH "SEE ALSO" .IX Header "SEE ALSO" -latexrevise +latexrevise, latexdiff-vc .SH "PORTABILITY" .IX Header "PORTABILITY" \&\fIlatexdiff\fR does not make use of external commands and thus should run @@ -657,10 +739,20 @@ 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" -Copyright (C) 2004\-2007 Frederik Tilmann +Version 1.0.2 +Copyright (C) 2004\-2012 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 2 +it under the terms of the \s-1GNU\s0 General Public License Version 3 .PP -Contributors of fixes and additions: V. Kuhlmann, J. Paisley, N. Becker, T. Doerges, K. Huebner -Thanks to everyone who send in bug reports. +Contributors of fixes and additions: V. Kuhlmann, J. Paisley, N. Becker, T. Doerges, K. Huebner, +T. Connors, Sebastian Gouezel and many others. +Thanks to the many people who send in bug reports, feature suggestions, and other feedback. +.SH "POD ERRORS" +.IX Header "POD ERRORS" +Hey! \fBThe above document had some coding errors, which are explained below:\fR +.IP "Around line 2942:" 4 +.IX Item "Around line 2942:" +=over should be: '=over' or '=over positive_number' +.Sp +You can't have =items (as at line 2948) unless the first thing after the =over is an =item diff --git a/Master/texmf/doc/man/man1/latexdiff.man1.pdf b/Master/texmf/doc/man/man1/latexdiff.man1.pdf Binary files differindex e3ab33271c6..efa57b96109 100644 --- a/Master/texmf/doc/man/man1/latexdiff.man1.pdf +++ b/Master/texmf/doc/man/man1/latexdiff.man1.pdf diff --git a/Master/texmf/doc/man/man1/latexrevise.1 b/Master/texmf/doc/man/man1/latexrevise.1 index 283c614677b..b8d0d2da807 100644 --- a/Master/texmf/doc/man/man1/latexrevise.1 +++ b/Master/texmf/doc/man/man1/latexrevise.1 @@ -1,15 +1,7 @@ -.\" Automatically generated by Pod::Man v1.37, Pod::Parser v1.14 +.\" Automatically generated by Pod::Man 2.23 (Pod::Simple 3.14) .\" .\" Standard preamble: .\" ======================================================================== -.de Sh \" Subsection heading -.br -.if t .Sp -.ne 5 -.PP -\fB\\$1\fR -.PP -.. .de Sp \" Vertical space (when we can't use .PP) .if t .sp .5v .if n .sp @@ -25,11 +17,11 @@ .. .\" Set up some character translations and predefined strings. \*(-- will .\" give an unbreakable dash, \*(PI will give pi, \*(L" will give a left -.\" double quote, and \*(R" will give a right double quote. | will give a -.\" real vertical bar. \*(C+ will give a nicer C++. Capital omega is used to -.\" do unbreakable dashes and therefore won't be available. \*(C` and \*(C' -.\" expand to `' in nroff, nothing in troff, for use with C<>. -.tr \(*W-|\(bv\*(Tr +.\" double quote, and \*(R" will give a right double quote. \*(C+ will +.\" give a nicer C++. Capital omega is used to do unbreakable dashes and +.\" therefore won't be available. \*(C` and \*(C' expand to `' in nroff, +.\" nothing in troff, for use with C<>. +.tr \(*W- .ds C+ C\v'-.1v'\h'-1p'\s-2+\h'-1p'+\s0\v'.1v'\h'-1p' .ie n \{\ . ds -- \(*W- @@ -48,22 +40,25 @@ . ds R" '' 'br\} .\" +.\" Escape single quotes in literal strings from groff's Unicode transform. +.ie \n(.g .ds Aq \(aq +.el .ds Aq ' +.\" .\" If the F register is turned on, we'll generate index entries on stderr for -.\" titles (.TH), headers (.SH), subsections (.Sh), items (.Ip), and index +.\" 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. -.if \nF \{\ +.ie \nF \{\ . de IX . tm Index:\\$1\t\\n%\t"\\$2" .. . nr % 0 . rr F .\} -.\" -.\" For nroff, turn off justification. Always turn off hyphenation; it makes -.\" way too many mistakes in technical documents. -.hy 0 -.if n .na +.el \{\ +. de IX +.. +.\} .\" .\" Accent mark definitions (@(#)ms.acc 1.5 88/02/08 SMI; from UCB 4.2). .\" Fear. Run. Save yourself. No user-serviceable parts. @@ -129,7 +124,11 @@ .\" ======================================================================== .\" .IX Title "LATEXREVISE 1" -.TH LATEXREVISE 1 "2007-09-07" "perl v5.8.5" " " +.TH LATEXREVISE 1 "2012-12-16" "perl v5.12.4" " " +.\" For nroff, turn off justification. Always turn off hyphenation; it makes +.\" way too many mistakes in technical documents. +.if n .ad l +.nh .SH "NAME" latexrevise \- selectively remove markup and text from latexdiff output .SH "SYNOPSIS" @@ -171,7 +170,7 @@ and \f(CW\*(C`\eDIFaddend\*(C'\fR). .IX Item "-s or --simplify" Run in \fI\s-1SIMPLIFY\s0\fR mode (Keep all \f(CW\*(C`\eDIFaddbegin\*(C'\fR, \f(CW\*(C`\eDIFaddend\*(C'\fR, \&\f(CW\*(C`\eDIFdelbegin\*(C'\fR, \f(CW\*(C`\eDIFdelend\*(C'\fR tokens, but remove all other latexdiff -markup from body). +markup from body). .PP Note that the three mode options are mutually exclusive. If no mode option is given, \&\fIlatexrevise\fR simply removes user annotations and markup according to the following four @@ -195,7 +194,7 @@ blocks. .IP "\fB\-m cmd\fR or \fB\-\-markup=cmd\fR" 4 .IX Item "-m cmd or --markup=cmd" Remove the markup command \f(CW\*(C`\ecmd\*(C'\fR but leave its argument, i.e. -turn \f(CW\*(C`\ecmd{abc}\*(C'\fR into \f(CW\*(C`abc\*(C'\fR. +turn \f(CW\*(C`\ecmd{abc}\*(C'\fR into \f(CW\*(C`abc\*(C'\fR. .IP "\fB\-n envir\fR or \fB\-\-markup\-environment=envir\fR" 4 .IX Item "-n envir or --markup-environment=envir" Similarly, remove \f(CW\*(C`\ebegin{envir}\*(C'\fR and \f(CW\*(C`\eend{envir}\*(C'\fR commands but @@ -210,15 +209,16 @@ which should have been removed already. .SH "BUGS" .IX Header "BUGS" The current version is a beta version which has not yet been -extensively tested, but worked fine locally. Please send bug reports -to \fItilmann@esc.cam.ac.uk\fR. Include the serial number of \fIlatexrevise\fR +extensively tested, but worked fine locally. Please submit bug reports through +the latexdiff project page \fIhttp://developer.berlios.de/projects/latexdiff/\fR or send +to \fItilmann@gfz\-potsdam.de\fR. Include the serial number of \fIlatexrevise\fR (from comments at the top of the source). If you come across latexdiff output which is not processed correctly by \fIlatexrevise\fR please include the problem file as well as the old and new files on which it is based, ideally edited to only contain the offending passage as long as that still reproduces the problem. .PP -\&\fIlatexrevise\fR gets confused by commented \f(CW\*(C`\ebegin{document}\*(C'\fR or +Note that \fIlatexrevise\fR gets confused by commented \f(CW\*(C`\ebegin{document}\*(C'\fR or \&\f(CW\*(C`\eend{document}\*(C'\fR statements .SH "SEE ALSO" .IX Header "SEE ALSO" @@ -226,10 +226,10 @@ latexdiff .SH "PORTABILITY" .IX Header "PORTABILITY" \&\fIlatexrevise\fR does not make use of external commands and thus should run -on any platform supporting \s-1PERL\s0 v5 or higher. +on any platform supporting \s-1PERL\s0 v5 or higher. .SH "AUTHOR" .IX Header "AUTHOR" Copyright (C) 2004 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 2 +it under the terms of the \s-1GNU\s0 General Public License Version 3 diff --git a/Master/texmf/doc/man/man1/latexrevise.man1.pdf b/Master/texmf/doc/man/man1/latexrevise.man1.pdf Binary files differindex a2e788c29dc..623a87d27af 100644 --- a/Master/texmf/doc/man/man1/latexrevise.man1.pdf +++ b/Master/texmf/doc/man/man1/latexrevise.man1.pdf |