diff options
Diffstat (limited to 'Master/texmf-dist/doc/man')
26 files changed, 390 insertions, 137 deletions
diff --git a/Master/texmf-dist/doc/man/man1/bibdoiadd.1 b/Master/texmf-dist/doc/man/man1/bibdoiadd.1 index 737f4f2a4be..1425b1e08d6 100644 --- a/Master/texmf-dist/doc/man/man1/bibdoiadd.1 +++ b/Master/texmf-dist/doc/man/man1/bibdoiadd.1 @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "bibdoiadd 1" -.TH bibdoiadd 1 2023-08-20 "" "LATEX CROSSREFWARE" +.TH bibdoiadd 1 2024-09-02 "" "LATEX CROSSREFWARE" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -73,7 +73,7 @@ Configuration file. If this file is absent, some defaults are used. See below for its format. .IP "\fB\-C\fR 1|0" 4 .IX Item "-C 1|0" -Whether to canonize names in the output (1) or not (0). By default, 1. +Whether to canonicalize names in the output (1) or not (0). By default, 1. .IP \fB\-e\fR 4 .IX Item "-e" If 1 (default), add empty doi if a doi cannot be found. This prevents @@ -96,19 +96,29 @@ corresponding DOI. The result is a BibTeX file with the fields The name of the output file is either set by the \fB\-o\fR option or is derived by adding the suffix \f(CW\*(C`_doi\*(C'\fR to the output file. .PP -There are two options for making queries with Crossref: free account -and paid membership. In the first case you still must register with -Crossref and are limited to a small number of queries, see the +Every BibTeX record in the input is parsed, using BibTeX::Parser, but +only the ones that do not have the \f(CW\*(C`doi\*(C'\fR field (or \f(CW\*(C`mrnumber\*(C'\fR or +\&\f(CW\*(C`zblnumber\*(C'\fR for the sibling scripts) are processed. These entries +without the requested field are written back, as described in +BibTeX::Parser::Entry. +.PP +The bib records that are not processed (because they already have the +requested field) are written back as-is, without any reformatting. +.PP +There are (were?) two options for making queries with Crossref: free +account and paid membership. In the first case you still must register +with Crossref and are limited to a small number of queries, see the agreement at -\&\f(CW\*(C`http://www.crossref.org/01company/free_services_agreement.html\*(C'\fR. In +\&\f(CW\*(C`http://www.crossref.org/01company/free_services_agreement.html\*(C'\fR. In the second case you have a username and password, and can use them for -automatic queries. I am not sure whether the use of this script is -allowed for the free account holders. Anyway if you try to add DOI -to a large number of entries, you should register as a paid member. +automatic queries. I am not sure whether the use of this script is +allowed for the free account holders. At any rate, if you want to add +DOIs to a large number of entries, you should register as a paid member. .SH "CONFIGURATION FILE" .IX Header "CONFIGURATION FILE" -The configuration file is mostly self-explanatory: it has comments -(starting with \f(CW\*(C`#\*(C'\fR) and assginments in the form +The configuration file relates to the Crossref queries, and is mostly +self-explanatory: it has comments (starting with \f(CW\*(C`#\*(C'\fR) and assginments +in the form .PP .Vb 1 \& $field = value ; @@ -128,7 +138,7 @@ members. Boris Veytsman .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" -Copyright (C) 2014\-2021 Boris Veytsman +Copyright (C) 2014\-2024 Boris Veytsman .PP This is free software. You may redistribute copies of it under the terms of the GNU General Public License diff --git a/Master/texmf-dist/doc/man/man1/bibdoiadd.man1.pdf b/Master/texmf-dist/doc/man/man1/bibdoiadd.man1.pdf Binary files differindex 9eb2ad7739b..18cb5f70d12 100644 --- a/Master/texmf-dist/doc/man/man1/bibdoiadd.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/bibdoiadd.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/bibmradd.1 b/Master/texmf-dist/doc/man/man1/bibmradd.1 index ee49fd52389..54e5c430950 100644 --- a/Master/texmf-dist/doc/man/man1/bibmradd.1 +++ b/Master/texmf-dist/doc/man/man1/bibmradd.1 @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "bibmradd 1" -.TH bibmradd 1 2023-08-20 "" "LATEX CROSSREFWARE" +.TH bibmradd 1 2024-09-02 "" "LATEX CROSSREFWARE" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -84,19 +84,20 @@ Output file. If this option is not used, the name for the output file is formed by adding \f(CW\*(C`_mr\*(C'\fR to the input file .SH DESCRIPTION .IX Header "DESCRIPTION" -The script reads a BibTeX file. It checks whether the entries have -mrnumberss. If not, tries to contact internet to get the numbers. The -result is a BibTeX file with the fields -\&\f(CW\*(C`mrnumber=...\*(C'\fR added. +The script reads a BibTeX file. It checks whether the entries have +mrnumbers. If not, it tries to find the numbers from Internet sites. The +result is a BibTeX file with \f(CW\*(C`mrnumber=...\*(C'\fR fields added. .PP The name of the output file is either set by the \fB\-o\fR option or is derived by adding the suffix \f(CW\*(C`_mr\*(C'\fR to the output file. +.PP +See the \f(CW\*(C`bibdoiadd\*(C'\fR script for more details on the processing. .SH AUTHOR .IX Header "AUTHOR" Boris Veytsman .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" -Copyright (C) 2014\-2022 Boris Veytsman +Copyright (C) 2014\-2024 Boris Veytsman .PP This is free software. You may redistribute copies of it under the terms of the GNU General Public License diff --git a/Master/texmf-dist/doc/man/man1/bibmradd.man1.pdf b/Master/texmf-dist/doc/man/man1/bibmradd.man1.pdf Binary files differindex eb973b9cb25..8902edc7f86 100644 --- a/Master/texmf-dist/doc/man/man1/bibmradd.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/bibmradd.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/bibzbladd.1 b/Master/texmf-dist/doc/man/man1/bibzbladd.1 index 755536c73be..ce4240144e0 100644 --- a/Master/texmf-dist/doc/man/man1/bibzbladd.1 +++ b/Master/texmf-dist/doc/man/man1/bibzbladd.1 @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "bibzbladd 1" -.TH bibzbladd 1 2023-08-20 "" "LATEX CROSSREFWARE" +.TH bibzbladd 1 2024-09-02 "" "LATEX CROSSREFWARE" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -85,18 +85,19 @@ output file is formed by adding \f(CW\*(C`_zbl\*(C'\fR to the input file .SH DESCRIPTION .IX Header "DESCRIPTION" The script reads a BibTeX file. It checks whether the entries have -Zbls. If not, tries to contact internet to get the numbers. The -result is a BibTeX file with the fields -\&\f(CW\*(C`zblnumber=...\*(C'\fR added. +Zbls. If not, it tries to find the numbers from Internet sites. The +result is a BibTeX file with \f(CW\*(C`zblnumber=...\*(C'\fR fields added. .PP The name of the output file is either set by the \fB\-o\fR option or is derived by adding the suffix \f(CW\*(C`_zbl\*(C'\fR to the output file. +.PP +See the \f(CW\*(C`bibdoiadd\*(C'\fR script for more details on the processing. .SH AUTHOR .IX Header "AUTHOR" Boris Veytsman .SH "COPYRIGHT AND LICENSE" .IX Header "COPYRIGHT AND LICENSE" -Copyright (C) 2014\-2021 Boris Veytsman +Copyright (C) 2014\-2024 Boris Veytsman .PP This is free software. You may redistribute copies of it under the terms of the GNU General Public License diff --git a/Master/texmf-dist/doc/man/man1/bibzbladd.man1.pdf b/Master/texmf-dist/doc/man/man1/bibzbladd.man1.pdf Binary files differindex 6cbf8dc774f..24809a4a4ce 100644 --- a/Master/texmf-dist/doc/man/man1/bibzbladd.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/bibzbladd.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/bookshelf-listallfonts.1 b/Master/texmf-dist/doc/man/man1/bookshelf-listallfonts.1 new file mode 100644 index 00000000000..90b1cf00349 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/bookshelf-listallfonts.1 @@ -0,0 +1,119 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds C` +. ds C' +'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 >0, we'll generate index entries on stderr for +.\" 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 +.. +.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 +.\" ======================================================================== +.\" +.IX Title "BOOKSHELF-LISTALLFONTS 1" +.TH BOOKSHELF-LISTALLFONTS 1 2024-10-08 "perl v5.38.2" "User Contributed Perl Documentation" +.\" 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 +bookshelf\-listallfonts \- list all fonts known to LuaTeX with "interesting" features +.SH SYNOPSIS +.IX Header "SYNOPSIS" +bookshelf-listallfonts [\-d] [\-f FEATURES_FILE] [\-x EXCLUDED_PATTERNS_FILE] +.PP +bookshelf-listallfonts \-h +.PP +bookshelf-listallfonts \-v +.PP +bookshelf-listallfonts \-m +.SH DESCRIPTION +.IX Header "DESCRIPTION" +List all fonts known to LuaTeX adding "interesting" features to the +listing. +.PP +The script queries luaotfload databases and outputs the list of fonts +and features as a tab-separated stream with two field: font +name+feature name, and LuaTeX loading command. This form is suitable +for \fBmkfontsel.pl\fR\|(1) command from the \fIbookshelf\fR package. +.PP +We always include default features, \f(CW\*(C`+clig;+liga;+tlig\*(C'\fR. +.PP +It is recommended to issue +.PP +.Vb 1 +\& luaotfload\-tool \-\-update \-\-force +.Ve +.PP +before running the script. +.SH OPTIONS +.IX Header "OPTIONS" +.IP \fB\-d\fR 4 +.IX Item "-d" +Print debug information on the standard output. +.IP "\fB\-f\fR \fIFEATURES_FILE\fR" 4 +.IX Item "-f FEATURES_FILE" +Use patterns in the \fIFEATURES\fR file instead of the default ones. +.IP "\fB\-x\fR \fIEXCLUDED_PATTERNS_FILE\fR" 4 +.IX Item "-x EXCLUDED_PATTERNS_FILE" +Exclude patterns (font paths and features or combinations) listed +in \fIEXCLUDED_PATTERNS_FILE\fR. +.IP \fB\-v\fR 4 +.IX Item "-v" +Print version information +.IP \fB\-h\fR 4 +.IX Item "-h" +Print usage information +.IP \fB\-m\fR 4 +.IX Item "-m" +Print manual page +.SH AUTHOR +.IX Header "AUTHOR" +Boris Veytsman, 2024 +.SH LICENSE +.IX Header "LICENSE" +LPPL 1.3c diff --git a/Master/texmf-dist/doc/man/man1/bookshelf-listallfonts.man1.pdf b/Master/texmf-dist/doc/man/man1/bookshelf-listallfonts.man1.pdf Binary files differnew file mode 100644 index 00000000000..612ff0bb0aa --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/bookshelf-listallfonts.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/bookshelf-mkfontsel.1 b/Master/texmf-dist/doc/man/man1/bookshelf-mkfontsel.1 new file mode 100644 index 00000000000..a79a8556dcd --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/bookshelf-mkfontsel.1 @@ -0,0 +1,90 @@ +.\" -*- mode: troff; coding: utf-8 -*- +.\" Automatically generated by Pod::Man 5.01 (Pod::Simple 3.43) +.\" +.\" Standard preamble: +.\" ======================================================================== +.de Sp \" Vertical space (when we can't use .PP) +.if t .sp .5v +.if n .sp +.. +.de Vb \" Begin verbatim text +.ft CW +.nf +.ne \\$1 +.. +.de Ve \" End verbatim text +.ft R +.fi +.. +.\" \*(C` and \*(C' are quotes in nroff, nothing in troff, for use with C<>. +.ie n \{\ +. ds C` "" +. ds C' "" +'br\} +.el\{\ +. ds C` +. ds C' +'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 >0, we'll generate index entries on stderr for +.\" 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 +.. +.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 +.\" ======================================================================== +.\" +.IX Title "BOOKSHELF-MKFONTSEL 1" +.TH BOOKSHELF-MKFONTSEL 1 2024-10-08 "perl v5.38.2" "User Contributed Perl Documentation" +.\" 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 +bookshelf\-mkfontsel \- a script to populate "fontsel" directory and create "pickfont.tex" file for bookshelf package +.SH SYNOPSIS +.IX Header "SYNOPSIS" +bookshelf-mkfontsel FONTFILE +.SH DESCRIPTION +.IX Header "DESCRIPTION" +Create and populate fontsel directory from the file +produced by \fBlistallfonts.pl\fR\|(1) script, and create +\&\f(CW\*(C`pickfont.tex\*(C'\fR file. Used by +\&\fIbookshelf\fR package. +.SH OPTIONS +.IX Header "OPTIONS" +.IP \fB\-v\fR 4 +.IX Item "-v" +Print version information +.IP \fB\-h\fR 4 +.IX Item "-h" +Print usage information +.IP \fB\-m\fR 4 +.IX Item "-m" +Print manual page +.SH AUTHOR +.IX Header "AUTHOR" +Boris Veytsman, 2024 +.SH LICENSE +.IX Header "LICENSE" +LPPL 1.3c diff --git a/Master/texmf-dist/doc/man/man1/bookshelf-mkfontsel.man1.pdf b/Master/texmf-dist/doc/man/man1/bookshelf-mkfontsel.man1.pdf Binary files differnew file mode 100644 index 00000000000..1c39efe7458 --- /dev/null +++ b/Master/texmf-dist/doc/man/man1/bookshelf-mkfontsel.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/citeproc-lua.1 b/Master/texmf-dist/doc/man/man1/citeproc-lua.1 index 2c523ef3149..b88aac73a10 100644 --- a/Master/texmf-dist/doc/man/man1/citeproc-lua.1 +++ b/Master/texmf-dist/doc/man/man1/citeproc-lua.1 @@ -1,4 +1,4 @@ -.TH citeproc-lua 1 "0.6.2" +.TH citeproc-lua 1 "0.6.5" .SH NAME citeproc-lua \- make CSL citations and bibliography for LaTeX .SH SYNOPSIS diff --git a/Master/texmf-dist/doc/man/man1/citeproc-lua.man1.pdf b/Master/texmf-dist/doc/man/man1/citeproc-lua.man1.pdf Binary files differindex c0d7cb013ec..0075421bbfe 100644 --- a/Master/texmf-dist/doc/man/man1/citeproc-lua.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/citeproc-lua.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/eolang.1 b/Master/texmf-dist/doc/man/man1/eolang.1 index 8ab1954d875..d14e5fb8c2a 100644 --- a/Master/texmf-dist/doc/man/man1/eolang.1 +++ b/Master/texmf-dist/doc/man/man1/eolang.1 @@ -1,4 +1,4 @@ -.TH eolang 1 "2024-02-14" +.TH eolang 1 "0000-00-00" .SH NAME eolang \- Automated Editor of TeX Files that Use "eolang" Package .SH SYNOPSIS @@ -21,4 +21,4 @@ Yegor Bugayenko (yegor256@gmail.com) Please log issues on the GitHub homepage: https://github.com/objectionary/eolang.sty/issues. .SH SEE ALSO -See eolang.pdf for more details. +See eolang.pdf for more details.
\ No newline at end of file diff --git a/Master/texmf-dist/doc/man/man1/eolang.man1.pdf b/Master/texmf-dist/doc/man/man1/eolang.man1.pdf Binary files differindex 092c3afd9f1..48d26af0e0b 100644 --- a/Master/texmf-dist/doc/man/man1/eolang.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/eolang.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/l3build.1 b/Master/texmf-dist/doc/man/man1/l3build.1 index d42e486f3ca..cefd4849a1a 100644 --- a/Master/texmf-dist/doc/man/man1/l3build.1 +++ b/Master/texmf-dist/doc/man/man1/l3build.1 @@ -1,4 +1,4 @@ -.TH L3BUILD 1 "2024-05-27" "LaTeX" +.TH L3BUILD 1 "2024-10-16" "LaTeX" .SH NAME l3build @@ -7,16 +7,19 @@ l3build Usage l3build <target> [<options>] [<names>] .SH DESCRIPTION ------- -The l3build module is designed to support the development of + +The "l3build" module is designed to support the development of high-quality LaTeX code by providing: -* A unit testing system -* Automated typesetting of code sources -* A reliable packaging system for CTAN releases + + * A unit testing system + + * Automated typesetting of code sources + + * A reliable packaging system for CTAN releases The bundle consists of a Lua script to run the tasks and a -.tex file which provides the testing environment. These were +".tex" file which provides the testing environment. These were originally developed for supporting LaTeX development but are designed such that they can be readily used by others. Full documentation is provided. @@ -38,8 +41,9 @@ Valid targets are: .SH OPTIONS Valid options are: --config|-c Sets the config(s) used for running tests - --date Sets the date to insert into sources + --date|-d Sets the date to insert into sources --debug Runs target in debug mode + --dev Use the development LaTeX format --dirty Skips cleaning up the test area --dry-run Dry run for install or upload --email Email address of CTAN uploader diff --git a/Master/texmf-dist/doc/man/man1/l3build.man1.pdf b/Master/texmf-dist/doc/man/man1/l3build.man1.pdf Binary files differindex 037e91e199d..666b6b63a5e 100644 --- a/Master/texmf-dist/doc/man/man1/l3build.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/l3build.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/latexdiff-vc.1 b/Master/texmf-dist/doc/man/man1/latexdiff-vc.1 index 8b6c6f8db70..8ed1715873d 100644 --- a/Master/texmf-dist/doc/man/man1/latexdiff-vc.1 +++ b/Master/texmf-dist/doc/man/man1/latexdiff-vc.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) +.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "LATEXDIFF-VC 1" -.TH LATEXDIFF-VC 1 "2022-03-05" "perl v5.30.0" " " +.TH LATEXDIFF-VC 1 "2024-07-20" "perl v5.34.0" " " .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -204,7 +204,7 @@ complete directory hierarchy. Optionally, a pathname \fIpath\fR can be specifie .IP "\fB\-\-flatten,\-\-flatten=keep\-intermediate\fR" 4 .IX Item "--flatten,--flatten=keep-intermediate" If combined with \f(CW\*(C`\-\-git\*(C'\fR, \f(CW\*(C`\-\-svn\*(C'\fR or \f(CW\*(C`\-\-hg\*(C'\fR option or the corresponding modes, check out the revisions to compare in a separate temporary directory, and then pass on option \f(CW\*(C`\-\-flatten\*(C'\fR to latexdiff. The directory in which \f(CW\*(C`latexdiff\-vc\*(C'\fR is invoked defines the subtree which will be checked out. -Note that if additional files are needed which are not included in the flatten procedure (package files, included graphics), they need to be accessible in the current directory. If you use bibtex, it is recommended to include the \f(CW\*(C`.bbl\*(C'\fR file in the version management. +Note that if additional files are needed which are not included in the flatten procedure (package files, included graphics), they need to be accessible in the current directory. If you use bibtex, it is recommended to include the \f(CW\*(C`.bbl\*(C'\fR file in the version management. From latexdiff-vc >=1.3.4 there is an attempt to create the \f(CW\*(C`.bbl\*(C'\fR file by running bibtex in the retrieved subdirectories; note that the bibtex is run in the temporary subdirectories so any .bib or .bst files either need to be under version management, or in the global search paths for bibtex (shell environment variables \f(CW\*(C`BIBINPUTS\*(C'\fR and \f(CW\*(C`BSTINPUTS\*(C'\fR). .Sp 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 @@ -232,9 +232,9 @@ Set configuration variables for latexdiff and latexdiff-vc. The option can be r 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" +.ie n .IP """LATEXDIFF"" latexdiff command (e.g. latexdiff-fast, latexdiff-so). This command should support the options ""\-draftmode"" and ""\-interaction=batchmode""" 8 +.el .IP "\f(CWLATEXDIFF\fR latexdiff command (e.g. latexdiff-fast, latexdiff-so). This command should support the options \f(CW\-draftmode\fR and \f(CW\-interaction=batchmode\fR" 8 +.IX Item "LATEXDIFF latexdiff command (e.g. latexdiff-fast, latexdiff-so). This command should support the options -draftmode and -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 @@ -280,7 +280,7 @@ Show help text .IX Item "--version" Show version number .PP -All other options are passed on to \f(CW\*(C`latexdiff\*(C'\fR. +All other options are passed on to \f(CW\*(C`latexdiff\*(C'\fR. Note that it is not always easy for latexdiff to correctly assign arguments to options when short form (single letter) options are used so it is recommended to use long-form options. .SH "SEE ALSO" .IX Header "SEE ALSO" latexdiff @@ -297,7 +297,7 @@ 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.3.2 +Version 1.3.4a Copyright (C) 2005\-2017 Frederik Tilmann .PP This program is free software; you can redistribute it and/or modify diff --git a/Master/texmf-dist/doc/man/man1/latexdiff-vc.man1.pdf b/Master/texmf-dist/doc/man/man1/latexdiff-vc.man1.pdf Binary files differindex 9389c0274bd..efb03296ccc 100644 --- a/Master/texmf-dist/doc/man/man1/latexdiff-vc.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/latexdiff-vc.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/latexdiff.1 b/Master/texmf-dist/doc/man/man1/latexdiff.1 index 53644f607eb..a52d6f03ac9 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 4.11 (Pod::Simple 3.35) +.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "LATEXDIFF 1" -.TH LATEXDIFF 1 "2022-09-25" "perl v5.30.0" " " +.TH LATEXDIFF 1 "2024-07-20" "perl v5.34.0" " " .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -158,8 +158,8 @@ be real files (not pipes or similar) as they are opened twice (unless \f(CW\*(C` The program treats the preamble differently from the main document. Differences between the preambles are found using line-based differencing (similarly to the Unix diff command, but ignoring white -spaces). A comment, "\f(CW\*(C`%DIF\ >\*(C'\fR" is appended to each added line, i.e. a -line present in \f(CW\*(C`new.tex\*(C'\fR but not in \f(CW\*(C`old.tex\*(C'\fR. Discarded lines +spaces). A comment, "\f(CW\*(C`%DIF\ >\*(C'\fR" is appended to each added line, i.e. a +line present in \f(CW\*(C`new.tex\*(C'\fR but not in \f(CW\*(C`old.tex\*(C'\fR. Discarded lines are deactivated by prepending "\f(CW\*(C`%DIF\ <\*(C'\fR". Changed blocks are preceded by comment lines giving information about line numbers in the original files. Where there are insignificant differences, the resulting file \f(CW\*(C`diff.tex\*(C'\fR will be similar to @@ -238,7 +238,7 @@ but the choice is yours. Any markup within the environment will be removed, and generally everything within the environment will just be taken from the new file. .PP -It is also possible to difference files which do not have a preamble. +It is also possible to difference files which do not have a preamble. In this case, the file is processed in the main document mode, but the definitions of the markup commands are not inserted. .PP @@ -256,14 +256,14 @@ the scope of \f(CW\*(C`\eDIFadd\*(C'\fR. Added comments are marked by prependin .PP Within deleted blocks text is highlighted with \f(CW\*(C`\eDIFdel\*(C'\fR. Deleted comments are marked by prepending "\f(CW\*(C`%DIF\ <\ \*(C'\fR\*(L". Non-safe command -and curly braces within deleted blocks are commented out with +and curly braces within deleted blocks are commented out with \&\*(R"\f(CW\*(C`%DIFDELCMD\ <\ \*(C'\fR". .SH "OPTIONS" .IX Header "OPTIONS" .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 +command definitions to the preamble. See the end of this section for a description of available styles. .IP "\fB\-\-type=markupstyle\fR or \fB\-t markupstyle\fR" 4 .IX Item "--type=markupstyle or -t markupstyle" @@ -271,8 +271,9 @@ 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: .Sp -\&\f(CW\*(C`UNDERLINE CTRADITIONAL TRADITIONAL CFONT FONTSTRIKE INVISIBLE -CHANGEBAR CCHANGEBAR CULINECHBAR CFONTCHBAR BOLD PDFCOMMENT\*(C'\fR +\&\f(CW\*(C`UNDERLINE CTRADITIONAL TRADITIONAL CFONT FONTSTRIKE INVISIBLE +CHANGEBAR CCHANGEBAR CULINECHBAR CFONTCHBAR BOLD PDFCOMMENT +LUAUNDERLINE\*(C'\fR .Sp [ Default: \f(CW\*(C`UNDERLINE\*(C'\fR ] .IP "\fB\-\-subtype=markstyle\fR or \fB\-s markstyle\fR" 4 @@ -286,10 +287,10 @@ Available styles: \f(CW\*(C`SAFE MARGIN COLOR DVIPSCOL ZLABEL ONLYCHANGEDPAGE ( * 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 +Add code to preamble for selected style which replace standard marking and markup commands within floats (e.g., marginal remarks cause an error within floats -so marginal marking can be disabled thus). This option defines all +so marginal marking can be disabled thus). This option defines all \&\f(CW\*(C`\eDIF...FL\*(C'\fR commands. Available styles: \f(CW\*(C`FLOATSAFE TRADITIONALSAFE IDENTICAL\*(C'\fR .Sp @@ -297,14 +298,14 @@ Available styles: \f(CW\*(C`FLOATSAFE TRADITIONALSAFE IDENTICAL\*(C'\fR .IP "\fB\-\-encoding=enc\fR or \fB\-e enc\fR" 4 .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 +\&\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 .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 +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 latex) is a subset of utf8] .IP "\fB\-\-preamble=file\fR or \fB\-p file\fR" 4 @@ -334,7 +335,7 @@ Ensure that \f(CW\*(C`\ebegin{figure}\*(C'\fR and \f(CW\*(C`\eend{figure}\*(C'\f .ie n .IP """hyperref""" 8 .el .IP "\f(CWhyperref\fR" 8 .IX Item "hyperref" -Change name of \f(CW\*(C`\eDIFadd\*(C'\fR and \f(CW\*(C`\eDIFdel\*(C'\fR commands to \f(CW\*(C`\eDIFaddtex\*(C'\fR and \f(CW\*(C`\eDIFdeltex\*(C'\fR and +Change name of \f(CW\*(C`\eDIFadd\*(C'\fR and \f(CW\*(C`\eDIFdel\*(C'\fR commands to \f(CW\*(C`\eDIFaddtex\*(C'\fR and \f(CW\*(C`\eDIFdeltex\*(C'\fR and define new \f(CW\*(C`\eDIFadd\*(C'\fR and \f(CW\*(C`\eDIFdel\*(C'\fR commands, which provide a wrapper for these commands, using them for the text but not for the link defining command (where any markup would cause errors). @@ -384,13 +385,13 @@ Print generated or included preamble commands to stdout. .IX Item "--append-safecmd=append-file or -a append-file or --append-safecmd=cmd1,cmd2,..." .PD Exclude from, replace or append to the list of regular expressions (RegEx) -matching commands which are safe to use within the +matching commands which are safe to use within the scope of a \f(CW\*(C`\eDIFadd\*(C'\fR or \f(CW\*(C`\eDIFdel\*(C'\fR command. The file must contain one Perl-RegEx per line (Comment lines beginning with # or % are -ignored). Note that the RegEx needs to match the whole of +ignored). Note that the RegEx needs to match the whole of the token, i.e., /^regex$/ is implied and that the initial -\&\*(L"\e\*(R" of the command is not included. -The \fB\-\-exclude\-safecmd\fR and \fB\-\-append\-safecmd\fR options can be combined with the \-\fB\-\-replace\-safecmd\fR +\&\*(L"\e\*(R" of the command is not included. +The \fB\-\-exclude\-safecmd\fR and \fB\-\-append\-safecmd\fR options can be combined with the \-\fB\-\-replace\-safecmd\fR option and can be used repeatedly to add cumulatively to the lists. \fB\-\-exclude\-safecmd\fR and \fB\-\-append\-safecmd\fR can also take a comma separated list as input. If a @@ -422,7 +423,7 @@ entry for \fB\-\-exclude\-safecmd\fR directly above for further details. 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. \f(CW\*(C`\ecaption\*(C'\fR will only work within a figure -or table. These commands behave like text commands, except when +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 @@ -438,7 +439,7 @@ 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 +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 @@ -450,7 +451,7 @@ If such a repetition is detected, the whole preamble will be processed in line-b .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 \f(CW\*(C`\embox{..}\*(C'\fR. 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 @@ -489,10 +490,10 @@ 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, COUNTERCMD\s0 and \s-1CUSTOMDIFCMD,\s0 see list above) this option 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 +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 @@ -508,7 +509,7 @@ Show values of configuration variables. .IX Item "--show-all" 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 +\&\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. .SS "Other configuration options:" .IX Subsection "Other configuration options:" @@ -521,20 +522,20 @@ 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: +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 +\&\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 +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) +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] @@ -554,29 +555,29 @@ Possible values for level: .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 +\&\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 +Note that changes to the optional parameters will make the figure appear as changed to latexdiff, and this figure will thus be highlighted. .Sp In some circumstances \*(L"Misplaced \enoalign\*(R" error can occur if there are certain types -of changes in tables. In this case please use \f(CW\*(C`\-\-graphics\-markup=none\*(C'\fR as a +of changes in tables. In this case please use \f(CW\*(C`\-\-graphics\-markup=none\*(C'\fR as a work-around. .IP "\fB\-\-no\-del\fR" 4 .IX Item "--no-del" -Suppress deleted text from the diff. It is similar in effect to the \s-1BOLD\s0 style, -but the deleted text ist not just invisible in the output, it is also not included in the diff text file. +Suppress deleted text from the diff. It is similar in effect to the \s-1BOLD\s0 style, +but the deleted text ist not just invisible in the output, it is also not included in the diff text file. This can be more robust than just making it invisible. .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 +Suppress citation markup and markup of other vulnerable commands in styles 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" -Protect citation commands and other vulnerable commands in changed sections +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" @@ -611,17 +612,17 @@ 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\-\-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 +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" 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, -no recursion is done, i.e. \f(CW\*(C`\einput\*(C'\fR and \f(CW\*(C`\einclude\*(C'\fR commands within -included sections are not expanded. The included files are assumed to +preamble, only those files are expanded into the document. However, +no recursion is done, i.e. \f(CW\*(C`\einput\*(C'\fR and \f(CW\*(C`\einclude\*(C'\fR commands within +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. +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. Also handles files included by the import package (\f(CW\*(C`\eimport\*(C'\fR and \f(CW\*(C`\esubimport\*(C'\fR), and \f(CW\*(C`\esubfile\*(C'\fR command. @@ -660,10 +661,15 @@ The major type determine the markup of plain text and some selected latex comman .IX Item "UNDERLINE" Added text is wavy-underlined and blue, discarded text is struck out and red (Requires color and ulem packages). Overstriking does not work in displayed math equations such that deleted parts of equation are underlined, not struck out (this is a shortcoming inherent to the ulem package). +.ie n .IP """LUAUNDERLINE""" 10 +.el .IP "\f(CWLUAUNDERLINE\fR" 10 +.IX Item "LUAUNDERLINE" +Added text is underlined and blue, discarded text is struck out and red +(Requires lua-ul package + LuaLaTeX). .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 @@ -723,7 +729,7 @@ from the intended position. .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 +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 @@ -747,7 +753,7 @@ there is floating material (figures, tables). 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 +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 markup commands are used within floats. The float type defines these alternative commands. .ie n .IP """FLOATSAFE""" 10 @@ -767,7 +773,7 @@ Make no difference between the main text and floats. .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 +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\ @@ -787,9 +793,9 @@ numbering in the new file. 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 +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 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 @@ -803,7 +809,7 @@ and then latexdiff should be invoked with the option \f(CW\*(C`\-c CUSTOMDIFCMD= .ie n .IP """FLOATENV""" 10 .el .IP "\f(CWFLOATENV\fR" 10 .IX Item "FLOATENV" -Environments whose name matches the regular expression in \f(CW\*(C`FLOATENV\*(C'\fR are +Environments whose name matches the regular expression in \f(CW\*(C`FLOATENV\*(C'\fR are considered floats. Within these environments, the \fIlatexdiff\fR markup commands are replaced by their \s-1FL\s0 variaties. .Sp @@ -852,55 +858,62 @@ If \f(CW\*(C`\-\-graphics\-markup=both\*(C'\fR is chosen, \f(CW\*(C`SCALEDELGRAP .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: +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 +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 +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 -.IX Item "Citations result in overfull boxes" +.IP "Changed citations result in overfull boxes" 10 +.IX Item "Changed 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, 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. +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 several possibilities. .Sp 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 citations are shown without markup. (This was the default behaviour of latexdiff at versions 0.6 and older) -.Sp +added citations are shown without markup. (This was the default behaviour of latexdiff at versions 0.6 and older). 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 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 +.Sp +3. If you are using luatex >= 1.12.0 you can use option \s-1LUAUNDERLINE\s0 that uses lua-ul instead of ulem for underlining, which does not have this problem (experimental feature). +.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 option \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 "Deleted parts in equations are not struck out but underlined." 10 +.IX Item "Deleted parts in equations are not struck out but underlined." +This is a limitation of the ulem package that implements the strike-out. If you use the amsmath package, then the strike-out command is redefined in such a way that deleted passages are wrapped with \f(CW\*(C`\etext\*(C'\fR command; adding \f(CW\*(C`\eusepackage{amsmath}\*(C'\fR to your preamble will trigger this behaviour. (If amsmath is not included directly, but imported by another package, latexdiff will not be able to detect its availability; in this case you can give latexdiff a hint with option \f(CW\*(C`\-\-packages=amsmath\*(C'\fR. +.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 package to be installed). +.IP "The character encoding breaks when running latexdiff from powershell." 10 +.IX Item "The character encoding breaks when running latexdiff from powershell." +This problem is not limited to \f(CW\*(C`latexdiff\*(C'\fR and has to do with the default settings of \f(CW\*(C`powershell\*(C'\fR in Windows. It is recommended to use \f(CW\*(C`cmd\*(C'\fR instead. .SH "BUGS" .IX Header "BUGS" .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, +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 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 latex, please send me those files, ideally edited to only contain the -offending passage as long as that still reproduces the problem. If your +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" @@ -909,22 +922,22 @@ latexrevise, latexdiff-vc .SH "PORTABILITY" .IX Header "PORTABILITY" \&\fIlatexdiff\fR does not make use of external commands and thus should run -on any platform supporting Perl 5.6 or higher. If files with encodings +on any platform supporting Perl 5.6 or higher. If files with encodings other than \s-1ASCII\s0 or \s-1UTF\-8\s0 are processed, Perl 5.8 or higher is required. .PP The standard version of \fIlatexdiff\fR requires installation of the Perl package -\&\f(CW\*(C`Algorithm::Diff\*(C'\fR (available from \fIwww.cpan.org\fR \- +\&\f(CW\*(C`Algorithm::Diff\*(C'\fR (available from \fIwww.cpan.org\fR \- \&\fIhttp://search.cpan.org/~nedkonz/Algorithm\-Diff\-1.15\fR) but a stand-alone 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.3.3 -Copyright (C) 2004\-2022 Frederik Tilmann +Version 1.3.4 +Copyright (C) 2004\-2024 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 .PP -Contributors of fixes and additions: V. Kuhlmann, J. Paisley, N. Becker, T. Doerges, K. Huebner, +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 sent in bug reports, feature suggestions, and other feedback. diff --git a/Master/texmf-dist/doc/man/man1/latexdiff.man1.pdf b/Master/texmf-dist/doc/man/man1/latexdiff.man1.pdf Binary files differindex e241f442245..09595329435 100644 --- a/Master/texmf-dist/doc/man/man1/latexdiff.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/latexdiff.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/latexrevise.1 b/Master/texmf-dist/doc/man/man1/latexrevise.1 index a67d09564fd..d2d91dbe412 100644 --- a/Master/texmf-dist/doc/man/man1/latexrevise.1 +++ b/Master/texmf-dist/doc/man/man1/latexrevise.1 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.11 (Pod::Simple 3.35) +.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) .\" .\" Standard preamble: .\" ======================================================================== @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "LATEXREVISE 1" -.TH LATEXREVISE 1 "2021-12-27" "perl v5.30.0" " " +.TH LATEXREVISE 1 "2021-12-27" "perl v5.34.0" " " .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/Master/texmf-dist/doc/man/man1/latexrevise.man1.pdf b/Master/texmf-dist/doc/man/man1/latexrevise.man1.pdf Binary files differindex 1c016df1b29..950d6c15c2a 100644 --- a/Master/texmf-dist/doc/man/man1/latexrevise.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/latexrevise.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/ltx2crossrefxml.1 b/Master/texmf-dist/doc/man/man1/ltx2crossrefxml.1 index 9f6800d8b7a..5c9fc681e21 100644 --- a/Master/texmf-dist/doc/man/man1/ltx2crossrefxml.1 +++ b/Master/texmf-dist/doc/man/man1/ltx2crossrefxml.1 @@ -55,7 +55,7 @@ .\" ======================================================================== .\" .IX Title "ltx2crossrefxml 1" -.TH ltx2crossrefxml 1 2024-02-03 "" "LATEX CROSSREFWARE" +.TH ltx2crossrefxml 1 2024-09-02 "" "LATEX CROSSREFWARE" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -91,8 +91,10 @@ ignored, and \fIlatex_file\fR itself is not read (and need not even exist). Each \f(CW\*(C`.rpi\*(C'\fR file specifies the metadata for a single article to be uploaded to Crossref (a \f(CW\*(C`journal_article\*(C'\fR element in their schema); an example is below. These files are output by the \f(CW\*(C`resphilosophica\*(C'\fR -package (<https://ctan.org/pkg/resphilosophica>), but (as always) can -also be created by hand or by whatever other method you implement. +package (<https://ctan.org/pkg/resphilosophica>) and the TUGboat +publication procedure (<https://tug.org/TUGboat/repository.html>), but +(as always) can also be created by hand or by whatever other method you +implement. .PP Any \f(CW\*(C`.bbl\*(C'\fR files present are used for the citation information in the output XML. See the CITATIONS section below. @@ -102,18 +104,25 @@ citations), standard TeX control sequences are replaced with plain text or UTF\-8 or eliminated, as appropriate. The \f(CW\*(C`LaTeX::ToUnicode::convert\*(C'\fR routine is used for this (<https://ctan.org/pkg/bibtexperllibs>). Tricky TeX control sequences will almost surely not be handled -correctly. If \f(CW\*(C`\-\-rpi\-is\-xml\*(C'\fR is given, the author and title strings -from the rpi files are output as-is, assuming they are valid XML; no -checking is done. Citation text from \f(CW\*(C`.bbl\*(C'\fR files is always converted -from LaTeX to plain text. +correctly. .PP -This script just writes an XML file. It's up to you to actually do the +If \f(CW\*(C`\-\-rpi\-is\-xml\*(C'\fR is given, the author and title strings from the rpi +files are output as-is, assuming they are valid XML; no checking is +done. +.PP +Citation text from \f(CW\*(C`.bbl\*(C'\fR files is always converted from LaTeX to plain +text. +.PP +This script just writes an XML file. It's up to you to do the uploading to Crossref; for example, you can use their Java tool \&\f(CW\*(C`crossref\-upload\-tool.jar\*(C'\fR (<https://www.crossref.org/education/member\-setup/direct\-deposit\-xml/https\-post>). -For the definition of their schema, see -<https://data.crossref.org/reports/help/schema_doc/4.4.2/index.html> -(this is the schema version currently followed by this script). +.PP +For the definition of the Crossref schema currently output by this +script, see +<https://data.crossref.org/reports/help/schema_doc/5.3.1/index.html> +with additional links and information at +<https://www.crossref.org/documentation/schema\-library/metadata\-deposit\-schema\-5\-3\-1/>. .SH "CONFIGURATION FILE FORMAT" .IX Header "CONFIGURATION FILE FORMAT" The configuration file is read as Perl code. Thus, comment lines @@ -188,7 +197,8 @@ Any other journal must always specify this. The \f(CW%authors\fR field is split at \f(CW\*(C`\eand\*(C'\fR (ignoring whitespace before and after), and output as the \f(CW\*(C`contributors\*(C'\fR element, using \&\f(CW\*(C`sequence="first"\*(C'\fR for the first listed, \f(CW\*(C`sequence="additional"\*(C'\fR for -the remainder. +the remainder. The authors are parsed using \f(CW\*(C`BibTeX::Parser::Author\*(C'\fR +(<https://ctan.org/pkg/bibtexperllibs>). .PP If the \f(CW%publicationType\fR is not specified, it defaults to \&\f(CW\*(C`full_text\*(C'\fR, since that has historically been the case; \f(CW\*(C`full_text\*(C'\fR @@ -200,8 +210,7 @@ from the given \f(CW\*(C`journal_article\*(C'\fR element. Each \f(CW\*(C`.rpi\*(C'\fR must contain information for only one article, but multiple files can be read in a single run. It would not be difficult to support multiple articles in a single \f(CW\*(C`.rpi\*(C'\fR file, but it makes debugging and -error correction easier when each uploaded XML contains a single -article. +error correction easier to keep the input to one article per file. .SS "MORE ABOUT AUTHOR NAMES" .IX Subsection "MORE ABOUT AUTHOR NAMES" The three formats for names recognized are (not coincidentally) the same @@ -220,7 +229,8 @@ separators are not supported, unlike BibTeX. In short, you may almost always use the first form; you shouldn't if either there's a Jr part, or the Last part has multiple tokens but there's no von part. See the \f(CW\*(C`btxdoc\*(C'\fR (``BibTeXing'' by Oren Patashnik) -document for details. +document for details. The authors are parsed using +\&\f(CW\*(C`BibTeX::Parser::Author\*(C'\fR (<https://ctan.org/pkg/bibtexperllibs>). .PP In the \f(CW%authors\fR line of a \f(CW\*(C`.rpi\*(C'\fR file, some secondary directives are recognized, indicated by \f(CW\*(C`|\*(C'\fR characters. Easiest to explain with an @@ -284,12 +294,17 @@ this same format. .PP Feature request: if anyone is interested in figuring out how to generate structured citations -(<https://data.crossref.org/reports/help/schema_doc/5.3.1/schema_5_3_1.html#citation>) -instead of these flat text dumps, that would be great. Except the schema -seems to support much less than described at -<https://www.crossref.org/documentation/principles\-practices/best\-practices/bibliographic/>? -Anyway, the most viable approach is probably to change tugboat.bst to -output no-op TeX commands like \etubibauthor, \etubibtitle, etc. (a la +(<https://data.crossref.org/reports/help/schema_doc/5.3.1/common5_3_1_xsd.html#citation>), +that would be great. The schema does not support many useful fields, so +we also want to keep the unstructured text output. +.PP +Norman Gray's beastie program (<https://heptapod.host/nxg/beastie>) +supports this, via \f(CW\*(C`beastie extract\-bib.scm \-O crossref $(doc).aux\*(C'\fR, +as invoked in the TUGboat \f(CW\*(C`Common.mak\*(C'\fR file. Work in progress. +.PP +By the way, if for some reason we have to switch away from using +beastie, the most viable approach is probably to change \f(CW\*(C`tugboat.bst\*(C'\fR +to output no-op TeX commands like \etubibauthor, \etubibtitle, etc. (a la biblatex), and use those commands to discern the various crossref field values. We can't start from the .bib because then we'd have to reimplement Bib(La)TeX. diff --git a/Master/texmf-dist/doc/man/man1/ltx2crossrefxml.man1.pdf b/Master/texmf-dist/doc/man/man1/ltx2crossrefxml.man1.pdf Binary files differindex d7bdbf0c5d5..106737af9a7 100644 --- a/Master/texmf-dist/doc/man/man1/ltx2crossrefxml.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/ltx2crossrefxml.man1.pdf diff --git a/Master/texmf-dist/doc/man/man1/ltx2unitxt.1 b/Master/texmf-dist/doc/man/man1/ltx2unitxt.1 index 8dc8e714264..e3f1065bba4 100644 --- a/Master/texmf-dist/doc/man/man1/ltx2unitxt.1 +++ b/Master/texmf-dist/doc/man/man1/ltx2unitxt.1 @@ -1,5 +1,5 @@ .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.49.3. -.TH LTX2UNITXT "1" "November 2023" "ltx2unitxt " "User Commands" +.TH LTX2UNITXT "1" "September 2024" "ltx2unitxt " "User Commands" .SH NAME ltx2unitxt \- convert LaTeX source fragment to plain (Unicode) text or simple html .SH SYNOPSIS diff --git a/Master/texmf-dist/doc/man/man1/ltx2unitxt.man1.pdf b/Master/texmf-dist/doc/man/man1/ltx2unitxt.man1.pdf Binary files differindex 65577b000dd..a61608377a2 100644 --- a/Master/texmf-dist/doc/man/man1/ltx2unitxt.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/ltx2unitxt.man1.pdf |