diff options
| author | Karl Berry <karl@freefriends.org> | 2023-12-26 21:04:28 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2023-12-26 21:04:28 +0000 |
| commit | fe829413d0bd9dc19ad3c6be07fa409482505020 (patch) | |
| tree | 6790d12802feaed4c6cf34fb3f10395dc9ed1da3 /Master/texmf-dist/doc/support/latexmk | |
| parent | da3d3c074cb252bb820563d7b502dddb7236111d (diff) | |
latexmk (26dec23)
git-svn-id: svn://tug.org/texlive/trunk@69221 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support/latexmk')
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/CHANGES | 18 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/INSTALL | 6 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/README | 8 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/example_rcfiles/glossaries_latexmkrc | 25 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/example_rcfiles/glossary_latexmkrc | 43 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/latexmk.pdf | bin | 215760 -> 218897 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/latexmk.txt | 3266 |
7 files changed, 1755 insertions, 1611 deletions
diff --git a/Master/texmf-dist/doc/support/latexmk/CHANGES b/Master/texmf-dist/doc/support/latexmk/CHANGES index 09e5cd9b2e8..96abc635cba 100644 --- a/Master/texmf-dist/doc/support/latexmk/CHANGES +++ b/Master/texmf-dist/doc/support/latexmk/CHANGES @@ -873,3 +873,21 @@ From v. 4.80 to 4.81 preview_continuous_mode, incorrect extra runs were sometimes made. Other bug fixes. +From v. 4.81 to 4.82 + Fixed various anomalies in working with biber, especially under error conditions. + Fixed various anomalies with use of -bibtex- and -bibtex-cond options. + Fixed problem that -Werror worked only with bibtex and not biber. (This + is the option that causes latexmk to return a non-zero exit code to + flag an error when there are missing-citation messages in the .log + file.) + Added -dir-report-only option. + Fixed lack of quoting on command line to kpsewhich. + Implemented support for hilatex (-hnt option, $hnt_mode configuration + variable). + Allow sleep times of under a second. (That gives very responsive + performance on fast computers.) + Support ^^ format in .log file for non-ASCII bytes/characters. + Document $filetime_causality_threshold configuration variable. + Other documentation improvements. + + diff --git a/Master/texmf-dist/doc/support/latexmk/INSTALL b/Master/texmf-dist/doc/support/latexmk/INSTALL index 359686d527a..7be569f740e 100644 --- a/Master/texmf-dist/doc/support/latexmk/INSTALL +++ b/Master/texmf-dist/doc/support/latexmk/INSTALL @@ -1,6 +1,6 @@ INSTALLING latexmk ================== - (Version 4.81, 6 Nov. 2023) + (Version 4.82, 24 Dec. 2023) John Collins Physics Department @@ -9,8 +9,8 @@ University Park PA 16802 U.S.A. - http://www.personal.psu.edu/jcc8/ - http://www.personal.psu.edu/jcc8/latexmk/ + https://www.cantab.net/users/johncollins/ + https://www.cantab.net/users/johncollins/latexmk/ username jcc8 at node psu.edu Latexmk is a "make" tool for building latex documents. It runs latex diff --git a/Master/texmf-dist/doc/support/latexmk/README b/Master/texmf-dist/doc/support/latexmk/README index 72848ce8f3a..a21eba5af9a 100644 --- a/Master/texmf-dist/doc/support/latexmk/README +++ b/Master/texmf-dist/doc/support/latexmk/README @@ -1,5 +1,5 @@ -Latexmk, version 4.81, 6 Nov 2023 ---------------------------------- +Latexmk, version 4.82, 24 Dec 2023 +---------------------------------- Latexmk completely automates the process of generating a LaTeX document. Essentially, it is a highly specialized cousin of the @@ -36,7 +36,7 @@ written by David J. Musliner. Now it is supported by University Park PA 16802 U.S.A. - http://www.personal.psu.edu/jcc8/ + https://www.cantab.net/users/johncollins/ username jcc8 at node psu.edu The start of the script file has copyright notices and disclaimers. @@ -56,7 +56,7 @@ NOTES:- b. On the CTAN tex archive --- see http://www.ctan.org/pkg/latexmk - c. From the author's site at http://www.personal.psu.edu/jcc8/latexmk/ + c. From the author's site at https://www.cantab.net/users/johncollins/latexmk/ This site also includes previous versions, and sometimes newer versions under development. diff --git a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/glossaries_latexmkrc b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/glossaries_latexmkrc index 7e8dfab3ac2..b99a33d2e46 100644 --- a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/glossaries_latexmkrc +++ b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/glossaries_latexmkrc @@ -3,7 +3,7 @@ # (http://www.ctan.org/pkg/glossaries-extra) with latexmk. # N.B. There is also the OBSOLETE glossary package -# (http://www.ctan.org/pkg/glossary), which has some differences. See item 2. +# (http://www.ctan.org/pkg/glossary), which has some differences. See item 3. # 1. If you use the glossaries or the glossaries-extra package, then you can use: @@ -37,3 +37,26 @@ # return system "makeindex", @args; # } +# 3. If you use the OBSOLETE glossary package, then you can do the following: +# (Note that the code lines are commented out to avoid trouble when this +# file is simply copied into a latexmkrc or this file is arranged to be +# read by latexmk, and one of the modern packages glossaries and +# glossaries-extra is used.) + + ## For the main glossary: + #add_cus_dep( 'glo', 'gls', 0, 'makeglo2gls' ); + #sub makeglo2gls { + # system("makeindex -s \"$_[0].ist\" -t \"$_[0].glg\" -o \"$_[0].gls\" \"$_[0].glo\"" ); + #} + + ## For acronyms: + ## + ## ===> WARNING: The code below is ONLY FOR PACKAGE glossary, NOT FOR + ## glossaries and glossaries-extra. In the current glossaries and + ## glossaries-extra packages the roles of the .acr and .acn files are + ## exchanged compared with the old glossary package. Hence the the + ## code below will fail with the more modern packages. + #add_cus_dep( 'acr', 'acn', 0, 'makeacr2acn' ); + #sub makeacr2acn { + # system( "makeindex -s \"$_[0].ist\" -t \"$_[0].alg\" -o \"$_[0].acn\" \"$_[0].acr\"" ); + #} diff --git a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/glossary_latexmkrc b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/glossary_latexmkrc index 7e8dfab3ac2..18f5afb7927 100644 --- a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/glossary_latexmkrc +++ b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/glossary_latexmkrc @@ -1,39 +1,10 @@ -# This shows how to use the glossaries package -# (http://www.ctan.org/pkg/glossaries) and the glossaries-extra package -# (http://www.ctan.org/pkg/glossaries-extra) with latexmk. +# In many earlier versions of latexmk, there was a file glossary_latexmrc that +# originally showed how to use the glossary package with latexmk. That +# package is now OBSOLETE, and one should use the glossaries package or the +# glossaries-extra package. -# N.B. There is also the OBSOLETE glossary package -# (http://www.ctan.org/pkg/glossary), which has some differences. See item 2. +# The code for using the glossaries package with latexmk is in the file +# glossaries_latexmkrc. It also contains (commented out) code for the use +# of the glossary package, and has some comments on the issues involved. -# 1. If you use the glossaries or the glossaries-extra package, then you can use: - - add_cus_dep( 'acn', 'acr', 0, 'makeglossaries' ); - add_cus_dep( 'glo', 'gls', 0, 'makeglossaries' ); - $clean_ext .= " acr acn alg glo gls glg"; - - sub makeglossaries { - my ($base_name, $path) = fileparse( $_[0] ); - my @args = ( "-q", "-d", $path, $base_name ); - if ($silent) { unshift @args, "-q"; } - return system "makeglossaries", "-d", $path, $base_name; - } - -# 2. The above will tend to run makeglossaries more often than needed, since -# each out of date file will trigger the use of makeglossaries, even -# though makeglossaries makes all the glossaries. The following solution -# solves this, but at the expense of not having the convenience that -# makeglossaries can change how it makes the glossaries depending on the -# settings of the glossaries package. -# A better solution will need more advanced work. -# -# add_cus_dep( 'acn', 'acr', 0, 'makeglossaries' ); -# add_cus_dep( 'glo', 'gls', 0, 'makeglossaries' ); -# $clean_ext .= " acr acn alg glo gls glg"; -# -# sub makeglossaries { -# my @args = ( "-s", "$_[0].ist", "-t", "$$Psource.ilg", -# "-o", $$Pdest, $$Psource ); -# if ($silent) { unshift @args, "-q"; } -# return system "makeindex", @args; -# } diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.pdf b/Master/texmf-dist/doc/support/latexmk/latexmk.pdf Binary files differindex 4c2ed709641..f3aab26e20c 100644 --- a/Master/texmf-dist/doc/support/latexmk/latexmk.pdf +++ b/Master/texmf-dist/doc/support/latexmk/latexmk.pdf diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.txt b/Master/texmf-dist/doc/support/latexmk/latexmk.txt index 720022a6348..e7c60216436 100644 --- a/Master/texmf-dist/doc/support/latexmk/latexmk.txt +++ b/Master/texmf-dist/doc/support/latexmk/latexmk.txt @@ -61,7 +61,7 @@ DESCRIPTION - 6 November 2023 1 + 24 December 2023 1 @@ -127,7 +127,7 @@ LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE - 6 November 2023 2 + 24 December 2023 2 @@ -193,7 +193,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 6 November 2023 3 + 24 December 2023 3 @@ -259,7 +259,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 6 November 2023 4 + 24 December 2023 4 @@ -280,52 +280,52 @@ LATEXMK(1) General Commands Manual LATEXMK(1) variable to 1 in a configuration file. Note that when biber is used, and a bib file doesn't exist, this - option does not currently prevent biber from being run. See the - documentation on $bibtex_use for more details. However, a bbl - file is treated as precious. + option does not prevent biber from being run, with the bbl file + then being incorrect. See the documentation on $bibtex_use for + more details. However, a bbl file is treated as precious in a + clean up operation. -bibtex-cond1 The same as -bibtex-cond except that .bbl files are only treated as precious if one or more bibfiles fails to exist. - Thus if all the bib files exist, bibtex is run to generate .bbl - files as needed, and then it is appropriate to delete the bbl + Thus if all the bib files exist, bibtex is run to generate .bbl + files as needed, and then it is appropriate to delete the bbl files in a cleanup operation since they can be re-generated. - This property can also be configured by setting the $bibtex_use + This property can also be configured by setting the $bibtex_use variable to 1.5 in a configuration file. Note that when biber is used, and a bib file doesn't exist, this - option does not currently prevent biber from being run. See the - documentation on $bibtex_use for more details. + option does not prevent biber from being run, with the bbl file + then being incorrect. See the documentation on $bibtex_use for + more details. However, a bbl file is treated as precious in a + clean up operation. -bibtexfudge or -bibfudge - Turn on the change-directory fudge for bibtex. See documenta- + Turn on the change-directory fudge for bibtex. See documenta- tion of $bibtex_fudge for details. -bibtexfudge- or -bibfudge- - Turn off the change-directory fudge for bibtex. See documenta- + Turn off the change-directory fudge for bibtex. See documenta- tion of $bibtex_fudge for details. -bm <message> - A banner message to print diagonally across each page when con- - verting the dvi file to postscript. The message must be a sin- + A banner message to print diagonally across each page when con- + verting the dvi file to postscript. The message must be a sin- gle argument on the command line so be careful with quoting spa- ces and such. - Note that if the -bm option is specified, the -ps option is as- + Note that if the -bm option is specified, the -ps option is as- sumed. - - - - 6 November 2023 5 + 24 December 2023 5 @@ -335,16 +335,16 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -bi <intensity> - How dark to print the banner message. A decimal number between + How dark to print the banner message. A decimal number between 0 and 1. 0 is black and 1 is white. The default is 0.95, which is OK unless your toner cartridge is getting low. -bs <scale> - A decimal number that specifies how large the banner message - will be printed. Experimentation is necessary to get the right - scale for your message, as a rule of thumb the scale should be - about equal to 1100 divided by the number of characters in the + A decimal number that specifies how large the banner message + will be printed. Experimentation is necessary to get the right + scale for your message, as a rule of thumb the scale should be + about equal to 1100 divided by the number of characters in the message. The default is 220.0 which is just right for 5 charac- ter messages. @@ -356,42 +356,42 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -c Clean up (remove) all regeneratable files generated by latex and bibtex or biber except dvi, postscript and pdf. These files are - a combination of log files, aux files, latexmk's database file - of source file information, and those with extensions specified - in the @generated_exts configuration variable. In addition, + a combination of log files, aux files, latexmk's database file + of source file information, and those with extensions specified + in the @generated_exts configuration variable. In addition, files specified by the $clean_ext and @generated_exts configura- tion variables are removed. - This cleanup is instead of a regular make. See the -gg option + This cleanup is instead of a regular make. See the -gg option if you want to do a cleanup followed by a make. - Treatment of .bbl files: If $bibtex_use is set to 0 or 1, bbl - files are always treated as non-regeneratable. If $bibtex_use + Treatment of .bbl files: If $bibtex_use is set to 0 or 1, bbl + files are always treated as non-regeneratable. If $bibtex_use is set to 1.5, bbl files are counted as non-regeneratable condi- - tionally: If the bib file exists, then bbl files are regenerat- - able, and are deleted in a clean up. But if $bibtex_use is 1.5 - and a bib file doesn't exist, then the bbl files are treated as + tionally: If the bib file exists, then bbl files are regenerat- + able, and are deleted in a clean up. But if $bibtex_use is 1.5 + and a bib file doesn't exist, then the bbl files are treated as non-regeneratable and hence are not deleted. - In contrast, if $bibtex_use is set to 2, bbl files are always + In contrast, if $bibtex_use is set to 2, bbl files are always treated as regeneratable, and are deleted in a cleanup. - Treatment of files generated by custom dependencies: If - $cleanup_includes_cusdep_generated is nonzero, regeneratable - files are considered as including those generated by custom de- - pendencies and are also deleted. Otherwise these files are not + Treatment of files generated by custom dependencies: If + $cleanup_includes_cusdep_generated is nonzero, regeneratable + files are considered as including those generated by custom de- + pendencies and are also deleted. Otherwise these files are not deleted. -C Clean up (remove) all regeneratable files generated by latex and bibtex or biber. This is the same as the -c option with the ad- - dition of dvi, postscript and pdf files, and those specified in + dition of dvi, postscript and pdf files, and those specified in the $clean_full_ext configuration variable. - 6 November 2023 6 + 24 December 2023 6 @@ -400,64 +400,64 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - This cleanup is instead of a regular make. See the -gg option + This cleanup is instead of a regular make. See the -gg option if you want to do a cleanup followed by a make. - See the -c option for the specification of whether or not .bbl + See the -c option for the specification of whether or not .bbl files are treated as non-regeneratable or regeneratable. - If $cleanup_includes_cusdep_generated is nonzero, regeneratable - files are considered as including those generated by custom de- - pendencies and are also deleted. Otherwise these files are not + If $cleanup_includes_cusdep_generated is nonzero, regeneratable + files are considered as including those generated by custom de- + pendencies and are also deleted. Otherwise these files are not deleted. - -CA (Obsolete). Now equivalent to the -C option. See that option + -CA (Obsolete). Now equivalent to the -C option. See that option for details. - -cd Change to the directory containing the main source file before - processing it. Then all the generated files (.aux, .log, .dvi, + -cd Change to the directory containing the main source file before + processing it. Then all the generated files (.aux, .log, .dvi, .pdf, etc) will be relative to the source file. - This option is particularly useful when latexmk is invoked from - a GUI configured to invoke latexmk with a full pathname for the + This option is particularly useful when latexmk is invoked from + a GUI configured to invoke latexmk with a full pathname for the source file. - This option works by setting the $do_cd configuration variable - to one; you can set that variable if you want to configure la- + This option works by setting the $do_cd configuration variable + to one; you can set that variable if you want to configure la- texmk to have the effect of the -cd option without specifying it on the command line. See the documentation for that variable. - -cd- Do NOT change to the directory containing the main source file + -cd- Do NOT change to the directory containing the main source file before processing it. Then all the generated files (.aux, .log, - .dvi, .pdf, etc) will be relative to the current directory + .dvi, .pdf, etc) will be relative to the current directory rather than the source file. - This is the default behavior and corresponds to the behavior of + This is the default behavior and corresponds to the behavior of the *latex programs. However, it is not desirable behavior when - latexmk is invoked by a GUI configured to invoke latexmk with a + latexmk is invoked by a GUI configured to invoke latexmk with a full pathname for the source file. See the -cd option. - This option works by setting the $do_cd configuration variable - to zero. See the documentation for that variable for more in- + This option works by setting the $do_cd configuration variable + to zero. See the documentation for that variable for more in- formation. - -CF Remove the file containing the database of source file informa- + -CF Remove the file containing the database of source file informa- tion, before doing the other actions requested. - -d Set draft mode. This prints the banner message "DRAFT" across - your page when converting the dvi file to postscript. Size and + -d Set draft mode. This prints the banner message "DRAFT" across + your page when converting the dvi file to postscript. Size and intensity can be modified with the -bs and -bi options. The -bm - option will override this option as this is really just a short + option will override this option as this is really just a short way of specifying: - 6 November 2023 7 + 24 December 2023 7 @@ -468,27 +468,27 @@ LATEXMK(1) General Commands Manual LATEXMK(1) latexmk -bm DRAFT - Note that if the -d option is specified, the -ps option is as- + Note that if the -d option is specified, the -ps option is as- sumed. -deps Show a list of dependent files after processing. This is in the - form of a dependency list of the form used by the make program, + form of a dependency list of the form used by the make program, and it is therefore suitable for use in a Makefile. It gives an overall view of the files without listing intermediate files, as well as latexmk can determine them. - By default the list of dependent files is sent to stdout (i.e., - normally to the screen unless you've redirected latexmk's out- + By default the list of dependent files is sent to stdout (i.e., + normally to the screen unless you've redirected latexmk's out- put). But you can set the filename where the list is sent by the -deps-out= option. - See the section "USING latexmk WITH make" for an example of how + See the section "USING latexmk WITH make" for an example of how to use a dependency list with make. - Users familiar with GNU automake and gcc will find that the - -deps option is very similar in its purpose and results to the - -M option to gcc. (In fact, latexmk also has options -M, -MF, + Users familiar with GNU automake and gcc will find that the + -deps option is very similar in its purpose and results to the + -M option to gcc. (In fact, latexmk also has options -M, -MF, and -MP options that behave like those of gcc.) @@ -496,7 +496,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Equivalent to -deps. - -deps- Do not show a list of dependent files after processing. (This + -deps- Do not show a list of dependent files after processing. (This is the default.) @@ -506,24 +506,24 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -deps-escape=<string> Set the kind of escaping used for spaces in the dependency list. - The possible values are "none", "unix", "nmake", corresponding - respectively to no escaping, escaping with a "\" suitable for - standard Unix make, and escaping with "^", suitable for Micro- + The possible values are "none", "unix", "nmake", corresponding + respectively to no escaping, escaping with a "\" suitable for + standard Unix make, and escaping with "^", suitable for Micro- soft's nmake. -deps-out=FILENAME - Set the filename to which the list of dependent files is writ- - ten. If the FILENAME argument is omitted or set to "-", then + Set the filename to which the list of dependent files is writ- + ten. If the FILENAME argument is omitted or set to "-", then the output is sent to stdout. - Use of this option also turns on the output of the list of de- + Use of this option also turns on the output of the list of de- pendent files after processing. - 6 November 2023 8 + 24 December 2023 8 @@ -532,10 +532,10 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - -dF Dvi file filtering. The argument to this option is a filter - which will generate a filtered dvi file with the extension - ".dviF". All extra processing (e.g. conversion to postscript, - preview, printing) will then be performed on this filtered dvi + -dF Dvi file filtering. The argument to this option is a filter + which will generate a filtered dvi file with the extension + ".dviF". All extra processing (e.g. conversion to postscript, + preview, printing) will then be performed on this filtered dvi file. Example usage: To use dviselect to select only the even pages of @@ -545,91 +545,97 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -diagnostics - Print detailed diagnostics during a run. This may help for de- - bugging problems or to understand latexmk's behavior in diffi- + Print detailed diagnostics during a run. This may help for de- + bugging problems or to understand latexmk's behavior in diffi- cult situations. -dir-report - For each .tex file processed, list the settings for aux and out - directories, after they have been normalized from the settings - specified during initialization. See the description of the + For each .tex file processed, list the settings for aux and out + directories, after they have been normalized from the settings + specified during initialization. See the description of the variable $aux_out_dir_report for more details. -dir-report- - Do not report the settings for aux and out directories. (De- + Do not report the settings for aux and out directories. (De- fault) + -dir-report-only + After all initialization is complete, give the settings for the + aux and out directories, and then halt. This option is primar- + ily used for debugging configuration issues. + + -dvi Generate dvi version of document using latex. -dvilua - Generate dvi version of document using lualatex instead of la- + Generate dvi version of document using lualatex instead of la- tex. - -dvi- Turn off generation of dvi version of document. (This may get - overridden, if some other file is made (e.g., a .ps file) that - is generated from the dvi file, or if no generated file at all + -dvi- Turn off generation of dvi version of document. (This may get + overridden, if some other file is made (e.g., a .ps file) that + is generated from the dvi file, or if no generated file at all is requested.) -dvilualatex="COMMAND" This sets the string specifying the command to run dvi lualatex. - It behaves like the -pdflatex option, but sets the variable + It behaves like the -pdflatex option, but sets the variable $dvilualatex. - Note: This option when provided with the COMMAND argument only - sets the command for invoking dvilualatex; it does not turn on - the use of dvilualatex. That is done by other options or in an - initialization file. + 24 December 2023 9 - 6 November 2023 9 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1) General Commands Manual LATEXMK(1) + Note: This option when provided with the COMMAND argument only + sets the command for invoking dvilualatex; it does not turn on + the use of dvilualatex. That is done by other options or in an + initialization file. -e <code> - Execute the specified initialization code before processing. - The code is Perl code of the same form as is used in latexmk's - initialization files. For more details, see the information on - the -r option, and the section about "Configuration/initializa- - tion (RC) files". The code is typically a sequence of assign- + Execute the specified initialization code before processing. + The code is Perl code of the same form as is used in latexmk's + initialization files. For more details, see the information on + the -r option, and the section about "Configuration/initializa- + tion (RC) files". The code is typically a sequence of assign- ment statements separated by semicolons. - The code is executed when the -e option is encountered during - latexmk's parsing of its command line. See the -r option for a - way of executing initialization code from a file. An error re- - sults in latexmk stopping. Multiple instances of the -r and -e + The code is executed when the -e option is encountered during + latexmk's parsing of its command line. See the -r option for a + way of executing initialization code from a file. An error re- + sults in latexmk stopping. Multiple instances of the -r and -e options can be used, and they are executed in the order they ap- pear on the command line. Some care is needed to deal with proper quoting of special char- - acters in the code on the command line. For example, suppose - you want to set the latex command to use its -shell-escape op- + acters in the code on the command line. For example, suppose + you want to set the latex command to use its -shell-escape op- tion, then under UNIX/Linux you could use the line latexmk -e '$latex=q/latex %O -shell-escape %S/' file.tex - Note that the single quotes block normal UNIX/Linux command - shells from treating the characters inside the quotes as spe- - cial. (In this example, the q/.../ construct is a Perl idiom - equivalent to using single quotes. This avoids the complica- - tions of getting a quote character inside an already quoted - string in a way that is independent of both the shell and the + Note that the single quotes block normal UNIX/Linux command + shells from treating the characters inside the quotes as spe- + cial. (In this example, the q/.../ construct is a Perl idiom + equivalent to using single quotes. This avoids the complica- + tions of getting a quote character inside an already quoted + string in a way that is independent of both the shell and the operating-system.) - The above command line will NOT work under MS-Windows with - cmd.exe or command.com or 4nt.exe. For MS-Windows with these + The above command line will NOT work under MS-Windows with + cmd.exe or command.com or 4nt.exe. For MS-Windows with these command shells you could use latexmk -e "$latex=q/latex %O -shell-escape %S/" file.tex @@ -638,24 +644,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) latexmk -e "$latex='latex %O -shell-escape %S'" file.tex - The last two examples will NOT work with UNIX/Linux command + The last two examples will NOT work with UNIX/Linux command shells. - (Note: the above examples show are to show how to use the -e to - specify initialization code to be executed. But the particular + (Note: the above examples show are to show how to use the -e to + specify initialization code to be executed. But the particular effect can be achieved also by the use of the -latex option with less problems in dealing with quoting.) - -emulate-aux-dir - Emulate the use of an aux directory instead of leaving it to the - *latex programs to do it. (MiKTeX supports -aux-directory, but - TeXLive doesn't.) - - - 6 November 2023 10 + 24 December 2023 10 @@ -664,42 +664,47 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - See the section AUXILIARY AND OUTPUT DIRECTORIES for more de- + -emulate-aux-dir + Emulate the use of an aux directory instead of leaving it to the + *latex programs to do it. (MiKTeX supports -aux-directory, but + TeXLive doesn't.) + + See the section AUXILIARY AND OUTPUT DIRECTORIES for more de- tails. -emulate-aux-dir- Turn off emulation to implement an aux directory and leave it to - the *latex program to handle the case that the aux directory is - different from the output directory. Note that if you use - TeXLive, which doesn't support -aux-directory, latexmk will au- - tomatically switch aux_dir emulation on after the first run of + the *latex program to handle the case that the aux directory is + different from the output directory. Note that if you use + TeXLive, which doesn't support -aux-directory, latexmk will au- + tomatically switch aux_dir emulation on after the first run of *latex, because it will find the .log file in the wrong place. - -f Force latexmk to continue document processing despite errors. + -f Force latexmk to continue document processing despite errors. Normally, when latexmk detects that LaTeX or another program has found an error which will not be resolved by further processing, no further processing is carried out. - Note: "Further processing" means the running of other programs - or the rerunning of latex (etc) that would be done if no errors - had occurred. If instead, or additionally, you want the latex - (etc) program not to pause for user input after an error, you - should arrange this by an option that is passed to the program, - e.g., by latexmk's option -interaction=nonstopmode (which la- + Note: "Further processing" means the running of other programs + or the rerunning of latex (etc) that would be done if no errors + had occurred. If instead, or additionally, you want the latex + (etc) program not to pause for user input after an error, you + should arrange this by an option that is passed to the program, + e.g., by latexmk's option -interaction=nonstopmode (which la- texmk passes to *latex). -f- Turn off the forced processing-past-errors such as is set by the - -f option. This could be used to override a setting in a con- + -f option. This could be used to override a setting in a con- figuration file. - -g Force latexmk to process document fully, even under situations - where latexmk would normally decide that no changes in the - source files have occurred since the previous run. This option - is useful, for example, if you change some options and wish to + -g Force latexmk to process document fully, even under situations + where latexmk would normally decide that no changes in the + source files have occurred since the previous run. This option + is useful, for example, if you change some options and wish to reprocess the files. @@ -714,14 +719,9 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Print help information. - -jobname=STRING - Set the basename of output files(s) to STRING, instead of the - default, which is the basename of the specified TeX file. (At - present, STRING should not contain spaces.) - - 6 November 2023 11 + 24 December 2023 11 @@ -730,6 +730,15 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) + -hnt Generate hnt (HINT) version of document using hilatex. (And + turn off dvi, postscript, and pdf modes.) + + + -jobname=STRING + Set the basename of output files(s) to STRING, instead of the + default, which is the basename of the specified TeX file. (At + present, STRING should not contain spaces.) + This is like the same option for current implementations of the *latex, and the passing of this option to these programs is part of latexmk's implementation of -jobname. @@ -776,26 +785,25 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -latex="COMMAND" option. - -latex="COMMAND" - This sets the string specifying the command to run latex, and is - typically used to add desired options. Since the string nor- - mally contains spaces, it should be quoted, e.g., - latexmk -latex="latex --shell-escape %O %S" foo.tex - - The specification of the contents of the string are the same as + 24 December 2023 12 - 6 November 2023 12 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1) General Commands Manual LATEXMK(1) + -latex="COMMAND" + This sets the string specifying the command to run latex, and is + typically used to add desired options. Since the string nor- + mally contains spaces, it should be quoted, e.g., + latexmk -latex="latex --shell-escape %O %S" foo.tex + The specification of the contents of the string are the same as for the $latex configuration variable. Depending on your oper- ating system and the command-line shell you are using, you may need to change the single quotes to double quotes (or something @@ -841,25 +849,25 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -lualatex="COMMAND" This sets the string specifying the command to run lualatex. It - behaves like the -pdflatex option, but sets the variable $luala- - tex. + behaves like the -pdflatex option, but sets the variable - Note: This option when provided with the COMMAND argument only - sets the command for invoking lualatex; it does not turn on the - use of lualatex. That is done by other options or in an initial- - ization file. + 24 December 2023 13 - 6 November 2023 13 +LATEXMK(1) General Commands Manual LATEXMK(1) + $lualatex. -LATEXMK(1) General Commands Manual LATEXMK(1) + Note: This option when provided with the COMMAND argument only + sets the command for invoking lualatex; it does not turn on the + use of lualatex. That is done by other options or in an initial- + ization file. -M Show list of dependent files after processing. This is equiva- @@ -887,6 +895,10 @@ LATEXMK(1) General Commands Manual LATEXMK(1) tation of $makeindex_fudge for details. + $min_sleep_time [0.01] + This is the minimum nonzero value allowed for $sleep_time. + + -MSWinBackSlash This option only has an effect when latexmk is running under MS- Windows. This is that when latexmk runs a command under MS-Win- @@ -903,37 +915,37 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -MSWinBackSlash- This option only has an effect when latexmk is running under MS- Windows. This is that when latexmk runs a command under MS-Win- - dows, the substitution of "\" for the separator character be- - tween directory components of a file name is not done. Instead - the forward slash "/" is used, the same as on Unix-like systems. - This is acceptable in most situations under MS-Windows, provided - that filenames are properly quoted, as latexmk does by default. + dows, the substitution of "\" for the separator character - See the documentation for the configuration variable - $MSWin_back_slash for more details. - -new-viewer - When in continuous-preview mode, always start a new viewer to - view the generated file. By default, latexmk will, in + 24 December 2023 14 - 6 November 2023 14 +LATEXMK(1) General Commands Manual LATEXMK(1) + between directory components of a file name is not done. Instead + the forward slash "/" is used, the same as on Unix-like systems. + This is acceptable in most situations under MS-Windows, provided + that filenames are properly quoted, as latexmk does by default. -LATEXMK(1) General Commands Manual LATEXMK(1) + See the documentation for the configuration variable + $MSWin_back_slash for more details. - continuous-preview mode, test for a previously running previewer - for the same file and not start a new one if a previous pre- - viewer is running. However, its test sometimes fails (notably - if there is an already-running previewer that is viewing a file - of the same name as the current file, but in a different direc- - tory). This option turns off the default behavior. + -new-viewer + When in continuous-preview mode, always start a new viewer to + view the generated file. By default, latexmk will, in continu- + ous-preview mode, test for a previously running previewer for + the same file and not start a new one if a previous previewer is + running. However, its test sometimes fails (notably if there is + an already-running previewer that is viewing a file of the same + name as the current file, but in a different directory). This + option turns off the default behavior. -new-viewer- @@ -970,31 +982,31 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -outdir=FOO or -output-directory=FOO - Sets the directory for the output files of *latex. - If the aux directory is not set or is the same as the output di- - rectory, then all output files of *latex are sent to the output - directory. - If the aux directory is set, e.g., by the option -auxdir, and is - not equal to the output directory, then only final output files - (.dvi, .ps, .pdf, .synctex, .synctex.gz) are sent to the output - directory. Other generated files are sent to the aux directory. - See the section AUXILIARY AND OUTPUT DIRECTORIES for more + 24 December 2023 15 - 6 November 2023 15 +LATEXMK(1) General Commands Manual LATEXMK(1) + Sets the directory for the output files of *latex. -LATEXMK(1) General Commands Manual LATEXMK(1) + If the aux directory is not set or is the same as the output di- + rectory, then all output files of *latex are sent to the output + directory. + If the aux directory is set, e.g., by the option -auxdir, and is + not equal to the output directory, then only final output files + (.dvi, .ps, .pdf, .synctex, .synctex.gz) are sent to the output + directory. Other generated files are sent to the aux directory. - details. + See the section AUXILIARY AND OUTPUT DIRECTORIES for more de- + tails. -output-format=FORMAT @@ -1036,6 +1048,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -pdf Generate pdf version of document using pdflatex. (If you wish to use lualatex or xelatex, you can use whichever of the options + + + + 24 December 2023 16 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + -pdflua, -pdfxe, -lualatex or -xelatex applies.) To configure latexmk to have such behavior by default, see the section on "Configuration/initialization (rc) files". @@ -1050,16 +1074,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -dvilua option or by setting $dvi_mode to 2. - - 6 November 2023 16 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - -pdflua Generate pdf version of document using lualatex. @@ -1100,32 +1114,32 @@ LATEXMK(1) General Commands Manual LATEXMK(1) used in the $latex configuration variable). - -pdflatex - This sets the generation of pdf files by pdflatex, and turns off - the generation of dvi and ps files. - Note: to set the command used when pdflatex is specified, see - the -pdflatex="COMMAND" option. - -pdflatex="COMMAND" - This sets the string specifying the command to run pdflatex, and - is typically used to add desired options. Since the string nor- - mally contains spaces, it should be quoted, e.g., + 24 December 2023 17 - latexmk -pdf -pdflatex="pdflatex --shell-escape %O %S" - 6 November 2023 17 +LATEXMK(1) General Commands Manual LATEXMK(1) + -pdflatex + This sets the generation of pdf files by pdflatex, and turns off + the generation of dvi and ps files. + Note: to set the command used when pdflatex is specified, see + the -pdflatex="COMMAND" option. -LATEXMK(1) General Commands Manual LATEXMK(1) + -pdflatex="COMMAND" + This sets the string specifying the command to run pdflatex, and + is typically used to add desired options. Since the string nor- + mally contains spaces, it should be quoted, e.g., + latexmk -pdf -pdflatex="pdflatex --shell-escape %O %S" foo.tex The specification of the contents of the string are the same as @@ -1166,31 +1180,32 @@ LATEXMK(1) General Commands Manual LATEXMK(1) An example: latexmk -pretex='\AtBeginDocument{Message\par}' -usepretex - foo.tex - But this is better written - latexmk -usepretex='\AtBeginDocument{Message\par}' foo.tex - If you already have a suitable command configured, you only need + 24 December 2023 18 + - latexmk -pretex='\AtBeginDocument{Message\par}' foo.tex - -print=dvi, -print=ps, -print=pdf, -print=auto, - Define which kind of file is printed. This option also ensures - that the requisite file is made, and turns on printing. +LATEXMK(1) General Commands Manual LATEXMK(1) - 6 November 2023 18 + foo.tex + But this is better written + latexmk -usepretex='\AtBeginDocument{Message\par}' foo.tex + If you already have a suitable command configured, you only need + latexmk -pretex='\AtBeginDocument{Message\par}' foo.tex -LATEXMK(1) General Commands Manual LATEXMK(1) + -print=dvi, -print=ps, -print=pdf, -print=auto, + Define which kind of file is printed. This option also ensures + that the requisite file is made, and turns on printing. The (default) case -print=auto determines the kind of print file automatically from the set of files that is being made. The @@ -1233,6 +1248,16 @@ LATEXMK(1) General Commands Manual LATEXMK(1) turns them off. + + 24 December 2023 19 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + -pv- Turn off -pv. @@ -1246,18 +1271,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) compatible with the -p and -pv options, so it turns these op- tions off. - - - - 6 November 2023 19 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - The -pvc option also turns off force mode (-f), as is normally best for continuous preview mode. If you really want force mode, use the options in the order -pvc -f. @@ -1298,31 +1311,33 @@ LATEXMK(1) General Commands Manual LATEXMK(1) compiling the document. - -pvctimeout- - Don't do timeout in pvc mode after inactivity. - -pvctimeoutmins=<time> - Set period of inactivity in minutes for pvc timeout. - -quiet Same as -silent + 24 December 2023 20 - -r <rcfile> - Read the specified initialization file ("RC file") before pro- - cessing. - 6 November 2023 20 +LATEXMK(1) General Commands Manual LATEXMK(1) + -pvctimeout- + Don't do timeout in pvc mode after inactivity. + -pvctimeoutmins=<time> + Set period of inactivity in minutes for pvc timeout. -LATEXMK(1) General Commands Manual LATEXMK(1) + -quiet Same as -silent + + + -r <rcfile> + Read the specified initialization file ("RC file") before pro- + cessing. Be careful about the ordering: (1) Standard initialization files -- see the section below on "Configuration/initialization (RC) @@ -1363,31 +1378,31 @@ LATEXMK(1) General Commands Manual LATEXMK(1) den in an initialization file. For further information, see the documentation for the $recorder - configuration variable. - -recorder- - Do not supply the -recorder option with *latex. + 24 December 2023 21 - -rules Show a list of latemk's rules and dependencies after processing. - -rules- - Do not show a list of latexmk's rules and dependencies after - processing. (This is the default.) +LATEXMK(1) General Commands Manual LATEXMK(1) + configuration variable. - 6 November 2023 21 + -recorder- + Do not supply the -recorder option with *latex. + -rules Show a list of latemk's rules and dependencies after processing. -LATEXMK(1) General Commands Manual LATEXMK(1) + -rules- + Do not show a list of latexmk's rules and dependencies after + processing. (This is the default.) -showextraoptions @@ -1429,6 +1444,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) tions. Also reduce the number of informational messages that latexmk + + + + 24 December 2023 22 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + itself generates. To change the options used to make the commands run silently, @@ -1445,17 +1472,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Sets the commands for latex, etc, so that they are the standard ones. This is useful to override special configurations. - - - 6 November 2023 22 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - The result is that $latex = 'latex %O %S', and similarly for $pdflatex, $lualatex, and $xelatex. (The option -no-pdf needed for $xelatex is provided automatically, given that %O appears in @@ -1495,6 +1511,17 @@ LATEXMK(1) General Commands Manual LATEXMK(1) fault.) + + + 24 December 2023 23 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + -usepretex Sets the command lines for latex, etc, so that they use the code that is defined by the variable $pre_tex_code or that is set by @@ -1511,17 +1538,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -usepretex=CODE Equivalent to -pretex=CODE -usepretex. Example - - - 6 November 2023 23 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - latexmk -usepretex='\AtBeginDocument{Message\par}' foo.tex @@ -1561,6 +1577,17 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -xdv Generate xdv version of document using xelatex. + + + 24 December 2023 24 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + -xelatex Use xelatex. That is, use xelatex to process the source file(s) to pdf. The generation of dvi and postscript files is turned @@ -1576,18 +1603,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) file, and does all the extra runs needed (including those of bibtex, etc). Only after that does it make the pdf file from the .xdv file, using xdvipdfmx. See the documentation for the - - - - 6 November 2023 24 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - -pdfxe for why this is done.] @@ -1627,6 +1642,18 @@ EXAMPLES % latexmk thesis # run latex enough times to resolve cross-references + + + + 24 December 2023 25 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + % latexmk -pvc -ps thesis# run latex enough times to resolve cross-references, make a postscript file, start a previewer. Then @@ -1644,16 +1671,6 @@ EXAMPLES - - 6 November 2023 25 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - DEALING WITH ERRORS, PROBLEMS, ETC Some possibilities: @@ -1691,6 +1708,18 @@ DEALING WITH ERRORS, PROBLEMS, ETC f. There's a useful trick that can be used when you use lualatex in- stead of pdflatex (and in some related situations). The problem is + + + + 24 December 2023 26 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + that latexmk won't notice a dependency on a file, bar.baz say, that is input by the lua code in your document instead of by the LaTeX part. (Thus if you change bar.baz and rerun latexmk, then latexmk will think @@ -1708,18 +1737,6 @@ DEALING WITH ERRORS, PROBLEMS, ETC g. See also the section "Advanced Configuration: Some extra resources". - - - - 6 November 2023 26 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - h. Look on tex.stackexchange, i.e., at http://tex.stackex- change.com/questions/tagged/latexmk Someone may have already solved your problem. @@ -1757,6 +1774,18 @@ AUXILIARY AND OUTPUT DIRECTORIES tex programs, these directories default to the current directory, and then the generated files aren't segregated. If the two directories are the same, as is the simplest situation, then all generated files are + + + + 24 December 2023 27 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + written to the same directory, and one often simply refers to the out- put directory, without mentioning a separate aux directory. @@ -1774,18 +1803,6 @@ AUXILIARY AND OUTPUT DIRECTORIES separate aux and output directories. Latexmk deals with this by being able to emulating a separate aux directory: In this method it invokes *latex with just an -output-directory option, with the directory set - - - - 6 November 2023 27 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - not to the desired output directory, but to the aux directory. After running *latex, it moves the relevant final output file(s) to the in- tended output directory. Emulation can be turned on by setting the @@ -1822,8 +1839,20 @@ LATEXMK(1) General Commands Manual LATEXMK(1) cause of compatibility issues, is of .fls files: See below. Note that xelatex when invoked with its -no-pdf option, as latexmk - does, generates an .xdv file, which would appear to have the same sta- - tus as a .dvi file generated by latex. Nevertheless, latexmk treats + does, generates an .xdv file, which would appear to have the same + + + + 24 December 2023 28 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + + status as a .dvi file generated by latex. Nevertheless, latexmk treats .xdv as an intermediate file that is found in the aux directory. This is to match MiKTeX's treatment of the -aux-directory option. As fur- ther justification, one can say that under modern conditions an .xdv @@ -1840,18 +1869,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) the default is to set it equal to the output directory. For the output directory, the default is to be the current directory. - - - - 6 November 2023 28 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - For the turning on and off of the emulation mode, there is the configu- ration variable $emulate_aux and the options -emulate-aux-dir, -emu- late-aux-dir-, -noemulate-aux-dir. @@ -1889,6 +1906,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) programs, by default, will refuse to work when they find that they are asked to write to a file in a directory that appears not to be the cur- rent working directory or one of its subdirectories. This is part of + + + + 24 December 2023 29 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + security measures by the whole TeX system that try to prevent malicious or errant TeX documents from incorrectly messing with a user's files. @@ -1907,17 +1936,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) variable openout_any to "a" (as in "all"), to override the default "paranoid" setting. - - - 6 November 2023 29 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - Certain names of aux and output directories not allowed on Microsoft Windows: It is natural to want to use the name "aux" for the aux direc- tory, e.g., by using the option -auxdir=aux. But on Microsoft operat- @@ -1954,6 +1972,18 @@ ALLOWING FOR CHANGE OF OUTPUT FILE TYPE and then latexmk can adjust its processing to accommodate this situa- tion. The difference in output file type can happen for two reasons: One is that for latex, pdflatex and lualatex the document itself can + + + + 24 December 2023 30 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + override the defaults. The other is that there may be a configuration, or misconfiguration, such that the program that latexmk invokes to com- pile the document is not the expected one, or is given options incom- @@ -1973,17 +2003,6 @@ ALLOWING FOR CHANGE OF OUTPUT FILE TYPE useful to force output to be of the .dvi format by inserting \pdfout- put=0 in the preamble of the document. - - - 6 November 2023 30 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - Another example is where the document uses graphics file of the .pdf, .jpg, and png types. With the default setting for the graphicx pack- age, these can be processed in compilation to .pdf but not with compi- @@ -2021,6 +2040,16 @@ LATEXMK(1) General Commands Manual LATEXMK(1) + + 24 December 2023 31 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + CONFIGURATION/INITIALIZATION (RC) FILES In this section is explained which configuration files are read by la- texmk. Subsequent sections "How to Set Variables in Initialization @@ -2038,18 +2067,6 @@ CONFIGURATION/INITIALIZATION (RC) FILES The directories are searched in the following order, and latexmk uses the first such file it finds (if any): - - - - 6 November 2023 31 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - "/etc", "/opt/local/share/latexmk", "/usr/local/share/latexmk", @@ -2089,6 +2106,16 @@ LATEXMK(1) General Commands Manual LATEXMK(1) texmk does not look for an RC file under it. + + 24 December 2023 32 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + 3) The RC file in the current working directory. This file can be named either "latexmkrc" or ".latexmkrc", and the first of these to be found is used, if any. @@ -2104,18 +2131,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Note that command line options are obeyed in the order in which they are written; thus any RC file specified on the command line with the -r - - - - 6 November 2023 32 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - option can override previous options but can be itself overridden by later options on the command line. There is also the -e option, which allows initialization code to be specified in latexmk's command line. @@ -2155,6 +2170,18 @@ HOW TO SET VARIABLES IN INITIALIZATION FILES quotes, as in many programming languages. But then the Perl program- ming language brings into play some special rules for interpolating variables into strings. People not fluent in Perl will want to avoid + + + + 24 December 2023 33 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + these complications.) You can do much more complicated things, but for this you will need to @@ -2171,17 +2198,6 @@ FORMAT OF COMMAND SPECIFICATIONS bilities listed here do not apply to the $kpsewhich variable; see its documentation.) - - - 6 November 2023 33 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - Placeholders: Supposed you wanted latexmk to use the command elatex in place of the regular latex command, and suppose moreover that you wanted to give it the option "--shell-escape". You could do this by @@ -2220,6 +2236,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) source file is read. If the variable $pre_tex_code is the empty string, then %P is + + + + 24 December 2023 34 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + equivalent to %S. %R root filename. This is the base name for the main tex file. @@ -2237,17 +2265,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) substituted for %U (appropriately quoted). Otherwise it is re- placed by a null string. - - - 6 November 2023 34 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - %Y Name of directory for auxiliary output files (see the configura- tion variable $aux_dir). A directory separation character ('/') is appended if $aux_dir is non-empty and does not end in a suit- @@ -2285,6 +2302,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) "Detaching" a command: Normally when latexmk runs a command, it waits for the command to run to completion. This is appropriate for commands + + + + 24 December 2023 35 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + like latex, of course. But for previewers, the command should normally run detached, so that latexmk gets the previewer running and then re- turns to its next task (or exits if there is nothing else to do). To @@ -2302,18 +2331,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) cludes the possibility of running a command named start. (3) If the word start occurs more than once at the beginning of the command string, that is equivalent to having just one. (4) Under cygwin, some - - - - 6 November 2023 35 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - complications happen, since cygwin amounts to a complicated merging of UNIX and MS-Windows. See the source code for how I've handled the problem. @@ -2352,6 +2369,17 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $dvi_previewer = 'start %S'; + + + 24 December 2023 36 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + Under MS-Windows, this will cause to be run whatever program the system has associated with dvi files. (The same applies for a postscript viewer and a pdf viewer.) But note that this trick is not always suit- @@ -2368,18 +2396,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) your system. The string after the "NONE" is effectively a comment. Options to commands: Setting the name of a command can be used not only - - - - 6 November 2023 36 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - for changing the name of the command called, but also to add options to command. Suppose you want latexmk to use latex with source specials enabled. Then you might use the following line in an initialization @@ -2419,6 +2435,17 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $pdflatex = 'pdflatex --shell-escape %O %S; pst2pdf_for_latexmk %B'; + + + 24 December 2023 37 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + This definition assumes you are using a UNIX-like system (which in- cludes Linux and OS-X), so that the two commands to be run are sepa- rated by the semicolon in the middle of the string. @@ -2434,18 +2461,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) the MS-Windows command-line processor cmd.exe. - - - - 6 November 2023 37 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES In this section are specified the variables whose values can be ad- justed to configure latexmk. (See the earlier section "Configura- @@ -2485,6 +2500,18 @@ LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES chosen name for the output file.) This use of a temporary file solves a problem that the making of + + + + 24 December 2023 38 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + these files can occupy a substantial time. If a viewer (notably gv) sees that the file has changed, it may read the new file be- fore the program writing the file has not yet finished its work, @@ -2500,18 +2527,6 @@ LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES After a run of latex (etc), always analyze .log for input files in the <...> and (...) constructions. Otherwise, only do the - - - - 6 November 2023 38 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - analysis when fls file doesn't exist or is out of date. Under normal circumstances, the data in the fls file is reli- @@ -2550,46 +2565,53 @@ LATEXMK(1) General Commands Manual LATEXMK(1) takes the aux directory to equal the output directory which is the directory to which final output files are to be written. - If neither variable is set, then the current directory when *la- - tex is invoked is used both for the aux and output directories. + If neither variable is set, then the current directory when - If the aux and output directories are distinct, then the aux di- - rectory contains all generated files with the exception of "fi- - nal output files", which are defined to be .dvi, .ps, .pdf, - .synctex, and .synctex.gz files. - See the section AUXILIARY AND OUTPUT DIRECTORIES for more de- - tails. + 24 December 2023 39 - $aux_out_dir_report [0] - For each primary .tex file processed, list the settings for aux - and output directories, after they have been normalized from the - 6 November 2023 39 +LATEXMK(1) General Commands Manual LATEXMK(1) + *latex is invoked is used both for the aux and output directo- + ries. + If the aux and output directories are distinct, then the aux di- + rectory contains all generated files with the exception of "fi- + nal output files", which are defined to be .dvi, .ps, .pdf, + .synctex, and .synctex.gz files. + See the section AUXILIARY AND OUTPUT DIRECTORIES for more de- + tails. -LATEXMK(1) General Commands Manual LATEXMK(1) - settings specified during initialization. + $aux_out_dir_report [0] + If this variable is set to 1, then prior to the processing of + each primary .tex file, list the settings for aux and output di- + rectories, after they have been normalized from the settings + specified during initialization. This report gives a reminder of where to look for generated files. - The report has to be done per primary .tex file, because of pos- - sible directory changes for each file (when the -cd option is - used). In the simplest cases, the directory names are the same - as originally specified. But in general some clean up/normal- - ization is performed; this helps performance and cleans up out- - put to the screen. + The report is done per primary .tex file, because of possible + directory changes for each file (when the -cd option is used). + In the simplest cases, the directory names are the same as orig- + inally specified. But in general some clean up/normalization is + performed; this helps performance and cleans up output to the + screen. + If this variable is set to 2, then halt after reporting the set- + tings for the aux and out directories, rather than continuing + with processing of tex files. This setting is primarily used + for debugging configuration issues. See the -dir-report-only + option. $bad_warning_is_error [0] @@ -2610,6 +2632,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $banner [0] If nonzero, the banner message is printed across each page when + + + + 24 December 2023 40 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + converting the dvi file to postscript. Without modifying the variable $banner_message, this is equivalent to specifying the -d option. @@ -2632,18 +2666,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) A decimal number that specifies how large the banner message will be printed. Experimentation is necessary to get the right scale for your message, as a rule of thumb the scale should be - - - - 6 November 2023 40 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - about equal to 1100 divided by the number of characters in the message. The Default is just right for 5 character messages. This is equivalent to the -bs option. @@ -2677,6 +2699,17 @@ LATEXMK(1) General Commands Manual LATEXMK(1) may need to set the variable @BIBINPUTS. + + + 24 December 2023 41 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + $biber ["biber %O %S"] The biber processing program. @@ -2699,17 +2732,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) find extra aux files, as produced by the \include command in TeX. - - - 6 November 2023 41 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - b. With all moderately recent versions of bibtex, bibtex may refuse to write its bbl and blg files, for security reasons, for certain cases of the path component of the filename given to it. @@ -2740,15 +2762,38 @@ LATEXMK(1) General Commands Manual LATEXMK(1) The possible values of $bibtex_use are: 0: never use bibtex or biber; never delete .bbl files in a cleanup. - 1: only use bibtex if the bib file(s) exist; never delete .bbl - files in a cleanup. - 1.5: only use bibtex if the bib files exist; conditionally - delete .bbl files in a cleanup (i.e., delete them only when the - bib files all exist). + 1: only use bibtex or biber if the bib file(s) exist; never + delete .bbl files in a cleanup. + + + + 24 December 2023 42 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + + 1.5: only use bibtex or biber if the bib files exist; + conditionally delete .bbl files in a cleanup (i.e., delete + them only when + the bib files all exist). 2: run bibtex or biber whenever it appears necessary to update the bbl file(s), without testing for the existence of the bib files; always delete .bbl files in a cleanup. + Note: When biber is being used, conditional use of biber can be + problematic. From latexmk's point of view the problem is that + because of how biber works, a full knowledge of its source files + can only be obtained after running biber. In contrast, for bib- + tex, full information on which bib files are used is obtained + from the .aux file(s) after a run of *latex. But for biber, the + corresponding information is somewhat incomplete; this the in- + formation obtained in the .bcf file that is generated by the + biblatex package during a run of *latex. + $cleanup_includes_cusdep_generated [0] If nonzero, specifies that cleanup also deletes files that are @@ -2764,18 +2809,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) generation generated files. This operation is somewhat dangerous, and can have unintended - - - - 6 November 2023 42 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - consequences, since the files to be deleted are determined from a file created by *latex, which can contain erroneous informa- tion. Therefore this variable is turned off by default, and then @@ -2796,6 +2829,19 @@ LATEXMK(1) General Commands Manual LATEXMK(1) options. But there should be no need to set this variable from an RC file. + + + + + 24 December 2023 43 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + $clean_ext [""] Extra extensions of files for latexmk to remove when any of the clean-up options (-c or -C) is selected. The value of this @@ -2830,18 +2876,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) in $out_dir instead of $aux_dir. This also handles the case of deleting any fls file, since that file is in $out_dir. - - - - 6 November 2023 43 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - The filenames specified for a clean-up operation can refer not only to regular files but also to directories. Directories are only deleted if they are empty. An example of an application is @@ -2863,6 +2897,17 @@ LATEXMK(1) General Commands Manual LATEXMK(1) tion is selected, i.e., extensions of files to remove when the .dvi, etc files are to be cleaned-up. + + + 24 December 2023 44 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + More general patterns are allowed, as for $clean_ext. The files specified by $clean_full_ext to be deleted are rela- @@ -2896,18 +2941,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) An example of a simple setting of these variables is as follows - - - - 6 November 2023 44 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - $compiling_cmd = "xdotool search --name \"%D\" set_window --name \"%D compiling\""; $success_cmd = "xdotool search --name \"%D\" set_window @@ -2928,10 +2961,22 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Other placeholders that can be used are %S, %T, and %R, with %S and %T normally being identical. These can be useful for a com- - mand changing the title of the edit window. The visual indica- - tion in a window title can useful, since the user does not have - to keep shifting attention to the (possibly hidden) compilation - window to know the status of the compilation. + mand changing the title of the edit window. The visual + + + + 24 December 2023 45 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + + indication in a window title can useful, since the user does not + have to keep shifting attention to the (possibly hidden) compi- + lation window to know the status of the compilation. More complicated situations can best be handled by defining a Perl subroutine to invoke the necessary commands, and using the @@ -2963,17 +3008,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) @default_files = ("*.tex"); - - - 6 November 2023 45 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - @default_excluded_files = ("common.tex"); If you have a variable or large number of files to be processed, @@ -2994,6 +3028,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) rent directory. This is a convenience: just run latexmk and it will process an appropriate set of files. But sometimes you want only some of these files to be processed. In this case you + + + + 24 December 2023 46 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + can list the files to be processed by setting @default_files in an initialization file (e.g., the file "latexmkrc" in the cur- rent directory). Then if no files are specified on the command @@ -3028,18 +3074,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) run. - - - - 6 November 2023 46 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - $deps_escape ["none"] This variable determines which kind of escaping of space charac- ters to use in dependency lists. The possible values are "none", @@ -3060,6 +3094,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Name of file to receive list(s) of dependencies at the end of a run, to be used if $dependents_list is set. If the filename is "-", then the dependency list is set to stdout (i.e., normally + + + + 24 December 2023 47 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + the screen). @@ -3084,29 +3130,17 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $dvilualatex = "dvilualatex --src-specials %O %S"; - To do a coordinated setting of all of $dvilualatex, $latex, - $pdflatex, $lualatex, and $xelatex, see the section "Advanced - Configuration". + To do a coordinated setting of all of $dvilualatex, $hilatex, + $latex, $pdflatex, $lualatex, and $xelatex, see the section "Ad- + vanced Configuration". $dvi_mode [See below for default] If one, generate a dvi version of the document by use of latex. Equivalent to the -dvi option. - If 2, generate a dvi version of the document by use of - - - - 6 November 2023 47 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - - dvilualatex. Equivalent to the -dvilua option. + If 2, generate a dvi version of the document by use of dviluala- + tex. Equivalent to the -dvilua option. The variable $dvi_mode defaults to 0, but if no explicit re- quests are made for other types of file (postscript, pdf), then @@ -3126,6 +3160,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $dvi_previewer ["start xdvi %O %S" under UNIX] The command to invoke a dvi-previewer. [Under MS-Windows the + + + + 24 December 2023 48 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + default is "start"; then latexmk arranges to use the MS-Windows start program, which will cause to be run whatever command the system has associated with .dvi files.] @@ -3161,17 +3207,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $dvipdf_silent_switch ["-q"] Switch(es) for dvipdf program when silent mode is on. - - - 6 November 2023 48 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - N.B. The standard dvipdf program runs silently, so adding the silent switch has no effect, but is actually innocuous. But if an alternative program is used, e.g., dvipdfmx, then the silent @@ -3192,6 +3227,17 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Switch(es) for dvips program when pdf file is to be generated from .ps file. + + + 24 December 2023 49 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + $dvips_silent_switch ["-q"] Switch(es) for dvips program when silent mode is on. @@ -3227,17 +3273,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) variable $dvi_update_method. The default value is the one ap- propriate for xdvi on a UNIX system. - - - 6 November 2023 49 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - $emulate_aux [0] Whether to emulate the use of aux directory when $aux_dir and $out_dir are different, rather than using the -aux-directory op- @@ -3256,8 +3291,20 @@ LATEXMK(1) General Commands Manual LATEXMK(1) output directory provided to *latex is set to be the desired aux directory. After that, any files that need to be in the output directory will be moved there by latexmk. (These are the files - with extensions .dvi, .ps, .pdf, .synctex, .synctex.gz, and, de- - pending on the setting of the $fls_uses_out_dir variable, also + with extensions .dvi, .ps, .pdf, .synctex, .synctex.gz, and, + + + + 24 December 2023 50 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + + depending on the setting of the $fls_uses_out_dir variable, also the .fls file.) @@ -3293,9 +3340,28 @@ LATEXMK(1) General Commands Manual LATEXMK(1) The regular expression itself is + ^Missing file\s+(.+)\s*$ + + But the corresponding string specification in the push statement + has to have the backslashes doubled. + + This regular expression matches a line that starts with 'No + file', then has one or more white space characters, then any + number of characters forming the filename, then possible white + space, and finally the end of the line. (See documentation on + Perl regular expressions for details.) - 6 November 2023 50 + $filetime_causality_threshold [5] + The use of this variable is as follows: At a number of places, + latexmk needs to determine whether a particular file has been + produced during a just-concluded run of some rule/program or is + leftover from a previous run. (An example is the production of a + .bcf file by the biblatex package during a run of *latex to + + + + 24 December 2023 51 @@ -3304,16 +3370,28 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - ^Missing file\s+(.+)\s*$ + provide bibliographic information to the biber program. If a + .bcf file is not produced during a current run of *latex, but is + leftover from a previous run, then latexmk has to conclude that + the .tex document has changed so that biber is no longer to be + used.) - But the corresponding string specification in the push statement - has to have the backslashes doubled. + Latexmk's criterion that a file has been produced during a run + is that the modification time of the file is more recent than + the system time at the beginning of the run. Bascially, if the + modification time is earlier than this, then it is a leftover + from a previous run. However, a naive use of the criterion can, + among other things, run afoul of the granularity of how file + times are stored in some file systems, which means it is possi- + ble that the filesystem's reported time for a file might be a + second or more earlier than the actual modification time, the + exact difference being quite random. - This regular expression matches a line that starts with 'No - file', then has one or more white space characters, then any - number of characters forming the filename, then possible white - space, and finally the end of the line. (See documentation on - Perl regular expressions for details.) + The variable $filetime_causality_threshold allows an appopriate + sloppiness in latexmk's use of file modification time. It can + be quite generous; it should merely be less than the time scale + on which a human user makes changes to source files for a docu- + ment (or to configuration files, etc). $fls_uses_out_dir [0] @@ -3346,31 +3424,31 @@ LATEXMK(1) General Commands Manual LATEXMK(1) 'out', 'toc', 'blg', 'ilg', 'log', 'xdv' )] This contains a list of extensions for files that are generated - during processing, and that should be deleted during a main - clean up operation, as invoked by the command line option -c. - (The use of -C or -gg gives this clean up and more.) - The default values are extensions for standard files generated - by *latex, bibtex, and the like. (Note that the clean up also - deletes the fdb_latexmk file, but that's separately coded into - latexmk, currently.) - After initialization of latexmk and the processing of its com- - mand line, the items in clean_ext are appended to @gener- - ated_exts. So these two variables have the same meaning + 24 December 2023 52 - 6 November 2023 51 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1) General Commands Manual LATEXMK(1) + during processing, and that should be deleted during a main + clean up operation, as invoked by the command line option -c. + (The use of -C or -gg gives this clean up and more.) + The default values are extensions for standard files generated + by *latex, bibtex, and the like. (Note that the clean up also + deletes the fdb_latexmk file, but that's separately coded into + latexmk, currently.) - (contrary to older versions of latexmk). + After initialization of latexmk and the processing of its com- + mand line, the items in clean_ext are appended to @gener- + ated_exts. So these two variables have the same meaning (con- + trary to older versions of latexmk). The items in @generated_exts are normally extensions of files, whose base name is the same as the main tex file. But it is @@ -3403,6 +3481,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) If nonzero, process files regardless of timestamps, and is then equivalent to the -g option. + %hash_calc_ignore_pattern !!!This variable is for experts only!!! @@ -3411,31 +3490,31 @@ LATEXMK(1) General Commands Manual LATEXMK(1) changed. But consider for example a latex package that causes an encapsulated postscript file (an "eps" file) to be made that is to be read in on the next run. The file contains a comment - line giving its creation date and time. On the next run the - time changes, latex sees that the eps file has changed, and - therefore reruns latex. This causes an infinite loop, that is - only terminated because latexmk has a limit on the number of - runs to guard against pathological situations. - But the changing line has no real effect, since it is a comment. - You can instruct latex to ignore the offending line as follows: - $hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: '; - This creates a rule for files with extension .eps about lines to - ignore. The left-hand side is a Perl idiom for setting an item + 24 December 2023 53 - 6 November 2023 52 +LATEXMK(1) General Commands Manual LATEXMK(1) + line giving its creation date and time. On the next run the + time changes, latex sees that the eps file has changed, and + therefore reruns latex. This causes an infinite loop, that is + only terminated because latexmk has a limit on the number of + runs to guard against pathological situations. -LATEXMK(1) General Commands Manual LATEXMK(1) + But the changing line has no real effect, since it is a comment. + You can instruct latex to ignore the offending line as follows: + $hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: '; + This creates a rule for files with extension .eps about lines to + ignore. The left-hand side is a Perl idiom for setting an item in a hash. Note that the file extension is specified without a period. The value, on the right-hand side, is a string contain- ing a regular expression. (See documentation on Perl for how @@ -3465,130 +3544,143 @@ LATEXMK(1) General Commands Manual LATEXMK(1) delete $hash_calc_ignore_pattern{'eps'}; + $hilatex ["hilatex %O %S"] + specifies the command line for the hilatex program. + + + $hnt_mode [0] + Whether to generate a hnt version of the document by use of hi- + latex. Can be turned on by the use of the -hnt option. + + $jobname [""] - This specifies the jobname, i.e., the basename that is used for - generated files (.aux, .log, .dvi, .ps, .pdf, etc). If this - variable is a null string, then the basename is the basename of - the main tex file. (At present, the string in $jobname should - not contain spaces.) + This specifies the jobname, i.e., the basename that is used for - The placeholder '%A' is permitted. This will be substituted by - the basename of the TeX file. The primary purpose is when a va- - riety of tex files are to be processed, and you want to use a - different jobname for each but one that is distinct for each. - Thus if you wanted to compare compilations of a set of files on - different operating systems, with distinct filenames for all the - cases, you could set - $jobname = "%A-$^O"; - in an initialization file. (Here $^O is a variable provided by - perl that contains perl's name for the operating system.) + 24 December 2023 54 - Suppose you had .tex files test1.tex and test2.tex. Then when - you run - latexmk -pdf *.tex - 6 November 2023 53 +LATEXMK(1) General Commands Manual LATEXMK(1) + generated files (.aux, .log, .dvi, .ps, .pdf, etc). If this + variable is a null string, then the basename is the basename of + the main tex file. (At present, the string in $jobname should + not contain spaces.) + The placeholder '%A' is permitted. This will be substituted by + the basename of the TeX file. The primary purpose is when a va- + riety of tex files are to be processed, and you want to use a + different jobname for each but one that is distinct for each. + Thus if you wanted to compare compilations of a set of files on + different operating systems, with distinct filenames for all the + cases, you could set + $jobname = "%A-$^O"; -LATEXMK(1) General Commands Manual LATEXMK(1) + in an initialization file. (Here $^O is a variable provided by + perl that contains perl's name for the operating system.) + + Suppose you had .tex files test1.tex and test2.tex. Then when + you run + latexmk -pdf *.tex - both files will be compiled. The .aux, .log, and .pdf files - will have basenames test1-MSWin32 ante test2-MSWin32 on a MS- + both files will be compiled. The .aux, .log, and .pdf files + will have basenames test1-MSWin32 ante test2-MSWin32 on a MS- Windows system, test1-darwin and test2-darwin on an OS-X system, and a variety of similar cases on linux systems. $kpsewhich ["kpsewhich %S"] - The program called to locate a source file when the name alone - is not sufficient. Most filenames used by latexmk have suffi- + The program called to locate a source file when the name alone + is not sufficient. Most filenames used by latexmk have suffi- cient path information to be found directly. But sometimes, no- tably when a .bib or a .bst file is found from the log file of a - bibtex or biber run, only the base name of the file is known, + bibtex or biber run, only the base name of the file is known, but not its path. The program specified by $kpsewhich is used to find it. - (For advanced users: Because of the different way in which la- + (For advanced users: Because of the different way in which la- texmk uses the command specified in $kpsewhich, some of the pos- sibilities listed in the FORMAT OF COMMAND SPECIFICATIONS do not - apply. The internal and start keywords are not available. A + apply. The internal and start keywords are not available. A simple command specification with possible options and then "%S" - is all that is guaranteed to work. Note that for other com- + is all that is guaranteed to work. Note that for other com- mands, "%S" is substituted by a single source file. In contrast, for $kpsewhich, "%S" may be substituted by a long list of space- - separated filenames, each of which is quoted. The result on + separated filenames, each of which is quoted. The result on STDOUT of running the command is then piped to latexmk.) - See also the @BIBINPUTS variable for another way that latexmk + See also the @BIBINPUTS variable for another way that latexmk also uses to try to locate files; it applies only in the case of .bib files. - $kpsewhich_show [0] - Whether to show diagnostics about invocations of kpsewhich: the - command line use to invoke it and the results. These diagnos- - tics are shown if $kpsewhich_show is non-zero or if diagnostics - mode is on. (But in the second case, lots of other diagnostics - are also shown.) Without these diagnostics there is nothing - visible in latexmk's screen output about invocations of kpse- - which. - $landscape_mode [0] - If nonzero, run in landscape mode, using the landscape mode pre- - viewers and dvi to postscript converters. Equivalent to the -l - option. Normally not needed with current previewers. - $latex ["latex %O %S"] - Specifies the command line for the LaTeX processing program. - Note that as with other programs, you can use this variable not - just to change the name of the program used, but also specify - options to the program. E.g., - $latex = "latex --src-specials %O %S"; - To do a coordinated setting of all of $dvilualatex, $latex, - $pdflatex, $lualatex, and $xelatex, see the section "Advanced + 24 December 2023 55 - 6 November 2023 54 +LATEXMK(1) General Commands Manual LATEXMK(1) + $kpsewhich_show [0] + Whether to show diagnostics about invocations of kpsewhich: the + command line use to invoke it and the results. These diagnos- + tics are shown if $kpsewhich_show is non-zero or if diagnostics + mode is on. (But in the second case, lots of other diagnostics + are also shown.) Without these diagnostics there is nothing + visible in latexmk's screen output about invocations of kpse- + which. -LATEXMK(1) General Commands Manual LATEXMK(1) + $landscape_mode [0] + If nonzero, run in landscape mode, using the landscape mode pre- + viewers and dvi to postscript converters. Equivalent to the -l + option. Normally not needed with current previewers. + + + $latex ["latex %O %S"] + Specifies the command line for the LaTeX processing program. + Note that as with other programs, you can use this variable not + just to change the name of the program used, but also specify + options to the program. E.g., + + $latex = "latex --src-specials %O %S"; - Configuration". + To do a coordinated setting of all of $dvilualatex, $hilatex, + $latex, $pdflatex, $lualatex, and $xelatex, see the section "Ad- + vanced Configuration". %latex_input_extensions - This variable specifies the extensions tried by latexmk when it - finds that a LaTeX run resulted in an error that a file has not - been found, and the file is given without an extension. This - typically happens when LaTeX commands of the form \input{file} - or \includegraphics{figure}, when the relevant source file does + This variable specifies the extensions tried by latexmk when it + finds that a LaTeX run resulted in an error that a file has not + been found, and the file is given without an extension. This + typically happens when LaTeX commands of the form \input{file} + or \includegraphics{figure}, when the relevant source file does not exist. - In this situation, latexmk searches for custom dependencies to - make the missing file(s), but restricts it to the extensions - specified by the variable %latex_input_extensions. The default + In this situation, latexmk searches for custom dependencies to + make the missing file(s), but restricts it to the extensions + specified by the variable %latex_input_extensions. The default extensions are 'tex' and 'eps'. - (For Perl experts: %latex_input_extensions is a hash whose keys - are the extensions. The values are irrelevant.) Two subrou- - tines are provided for manipulating this and the related vari- - able %pdflatex_input_extensions, add_input_ext and remove_in- - put_ext. They are used as in the following examples are possi- + (For Perl experts: %latex_input_extensions is a hash whose keys + are the extensions. The values are irrelevant.) Two subrou- + tines are provided for manipulating this and the related vari- + able %pdflatex_input_extensions, add_input_ext and remove_in- + put_ext. They are used as in the following examples are possi- ble lines in an initialization file: remove_input_ext( 'latex', 'tex' ); @@ -3597,19 +3689,30 @@ LATEXMK(1) General Commands Manual LATEXMK(1) add_input_ext( 'latex', 'asdf' ); - add the extension 'asdf to latex_input_extensions. (Naturally + + + 24 December 2023 56 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + + add the extension 'asdf to latex_input_extensions. (Naturally with such an extension, you should have made an appropriate cus- tom dependency for latexmk, and should also have done the appro- - priate programming in the LaTeX source file to enable the file - to be read. The standard extensions are handled by LaTeX and + priate programming in the LaTeX source file to enable the file + to be read. The standard extensions are handled by LaTeX and its graphics/graphicx packages.) $latex_silent_switch ["-interaction=batchmode"] - Switch(es) for the LaTeX processing program when silent mode is + Switch(es) for the LaTeX processing program when silent mode is on. - If you use MikTeX, you may prefer the results if you configure - the options to include -c-style-errors, e.g., by the following + If you use MikTeX, you may prefer the results if you configure + the options to include -c-style-errors, e.g., by the following line in an initialization file $latex_silent_switch = "-interaction=batchmode -c-style-er- @@ -3619,31 +3722,19 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $lpr ["lpr %O %S" under UNIX/Linux, "NONE lpr" under MS-Windows] The command to print postscript files. - Under MS-Windows (unlike UNIX/Linux), there is no standard pro- + Under MS-Windows (unlike UNIX/Linux), there is no standard pro- gram for printing files. But there are ways you can do it. For example, if you have gsview installed, you could use it with the - - - - 6 November 2023 55 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - option "/p": $lpr = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p'; - If gsview is installed in a different directory, you will need - to make the appropriate change. Note the combination of single - and double quotes around the name. The single quotes specify - that this is a string to be assigned to the configuration vari- - able $lpr. The double quotes are part of the string passed to - the operating system to get the command obeyed; this is neces- + If gsview is installed in a different directory, you will need + to make the appropriate change. Note the combination of single + and double quotes around the name. The single quotes specify + that this is a string to be assigned to the configuration vari- + able $lpr. The double quotes are part of the string passed to + the operating system to get the command obeyed; this is neces- sary because one part of the command name ("Program Files") con- tains a space which would otherwise be misinterpreted. @@ -3653,60 +3744,59 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $lpr_pdf ["NONE lpr_pdf"] The printing program to print pdf files. - Under MS-Windows you could set this to use gsview, if it is in- + Under MS-Windows you could set this to use gsview, if it is in- stalled, e.g., $lpr = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p'; - If gsview is installed in a different directory, you will need - to make the appropriate change. Note the double quotes around + If gsview is installed in a different directory, you will need + to make the appropriate change. Note the double quotes around the name: this is necessary because one part of the command name ("Program Files") contains a space which would otherwise be mis- interpreted. - $lualatex ["lualatex %O %S"] - Specifies the command line for the LaTeX processing program that - is to be used when the lualatex program is called for (e.g., by - the option -lualatex. - To do a coordinated setting of all of $dvilualatex, $latex, - $pdflatex, $lualatex, and $xelatex, see the section "Advanced - Configuration". + 24 December 2023 57 - %lualatex_input_extensions - This variable specifies the extensions tried by latexmk when it - finds that a lualatex run resulted in an error that a file has - not been found, and the file is given without an extension. - This typically happens when LaTeX commands of the form \in- - put{file} or \includegraphics{figure}, when the relevant source - file does not exist. - - In this situation, latexmk searches for custom dependencies to - make the missing file(s), but restricts it to the extensions - specified by the variable %pdflatex_input_extensions. The de- - fault extensions are 'tex', 'pdf', 'jpg, and 'png'. - See details of the %latex_input_extensions for other information - 6 November 2023 56 +LATEXMK(1) General Commands Manual LATEXMK(1) + $lualatex ["lualatex %O %S"] + Specifies the command line for the LaTeX processing program that + is to be used when the lualatex program is called for (e.g., by + the option -lualatex. + To do a coordinated setting of all of $dvilualatex, $hilatex, + $latex, $pdflatex, $lualatex, and $xelatex, see the section "Ad- + vanced Configuration". -LATEXMK(1) General Commands Manual LATEXMK(1) + %lualatex_input_extensions + This variable specifies the extensions tried by latexmk when it + finds that a lualatex run resulted in an error that a file has + not been found, and the file is given without an extension. + This typically happens when LaTeX commands of the form \in- + put{file} or \includegraphics{figure}, when the relevant source + file does not exist. + In this situation, latexmk searches for custom dependencies to + make the missing file(s), but restricts it to the extensions + specified by the variable %pdflatex_input_extensions. The de- + fault extensions are 'tex', 'pdf', 'jpg, and 'png'. + See details of the %latex_input_extensions for other information that equally applies to %lualatex_input_extensions. $lualatex_silent_switch ["-interaction=batchmode"] - Switch(es) for the lualatex program (specified in the variable + Switch(es) for the lualatex program (specified in the variable $lualatex) when silent mode is on. - See details of the $latex_silent_switch for other information + See details of the $latex_silent_switch for other information that equally applies to $lualatex_silent_switch. $make ["make"] @@ -3716,282 +3806,278 @@ LATEXMK(1) General Commands Manual LATEXMK(1) The index processing program. $makeindex_fudge [0] - When using makeindex, whether to change directory to $aux_dir - before running makeindex. Set to 1 if $aux_dir is not an ex- - plicit subdirectory of current directory, otherwise makeindex + When using makeindex, whether to change directory to $aux_dir + before running makeindex. Set to 1 if $aux_dir is not an ex- + plicit subdirectory of current directory, otherwise makeindex will refuse to write its output and log files, for security rea- sons. $makeindex_silent_switch ["-q"] - Switch(es) for the index processing program when silent mode is + Switch(es) for the index processing program when silent mode is on. $max_repeat [5] - The maximum number of times latexmk will run *latex before de- - ciding that there may be an infinite loop and that it needs to - bail out, rather than rerunning *latex again to resolve cross- - references, etc. The default value covers all normal cases. + The maximum number of times latexmk will run *latex before de- + ciding that there may be an infinite loop and that it needs to + bail out, rather than rerunning *latex again to resolve cross- - (Note that the "etc" covers a lot of cases where one run of *la- - tex generates files to be read in on a later run.) - $MSWin_back_slash [1] - This configuration variable only has an effect when latexmk is - running under MS-Windows. With the default value of 1 for this - variable, when a command is executed under MS-Windows, latexmk - substitutes "\" for the separator character between components - of a directory name. Internally, latexmk uses "/" for the di- - rectory separator character, which is the character used by - Unix-like systems. - For almost all programs and for almost all filenames under MS- - Windows, both "\" and "/" are acceptable as the directory sepa- - rator character, provided at least that filenames are properly - quoted. But it is possible that programs exist that only accept - "\" on the command line, since that is the standard directory - separator for MS-Windows. So for safety latexmk makes the sub- - stitution from "/" to "\", by default. + 24 December 2023 58 - However there are also programs on MS-Windows for which a back - slash "\" is interpreted differently than as a directory - 6 November 2023 57 +LATEXMK(1) General Commands Manual LATEXMK(1) + references, etc. The default value covers all normal cases. + (Note that the "etc" covers a lot of cases where one run of *la- + tex generates files to be read in on a later run.) -LATEXMK(1) General Commands Manual LATEXMK(1) + $MSWin_back_slash [1] + This configuration variable only has an effect when latexmk is + running under MS-Windows. With the default value of 1 for this + variable, when a command is executed under MS-Windows, latexmk + substitutes "\" for the separator character between components + of a directory name. Internally, latexmk uses "/" for the di- + rectory separator character, which is the character used by + Unix-like systems. + For almost all programs and for almost all filenames under MS- + Windows, both "\" and "/" are acceptable as the directory sepa- + rator character, provided at least that filenames are properly + quoted. But it is possible that programs exist that only accept + "\" on the command line, since that is the standard directory + separator for MS-Windows. So for safety latexmk makes the sub- + stitution from "/" to "\", by default. - separator; for these the directory separator should be "/". - Programs with this behavior include all the *latex programs in - the TeXLive implementation (but not the MiKTeX implementation). - Hence if you use TeXLive on MS-Windows, then $MSWin_back_slash + However there are also programs on MS-Windows for which a back + slash "\" is interpreted differently than as a directory separa- + tor; for these the directory separator should be "/". Programs + with this behavior include all the *latex programs in the + TeXLive implementation (but not the MiKTeX implementation). + Hence if you use TeXLive on MS-Windows, then $MSWin_back_slash should be set to zero. $new_viewer_always [0] - This variable applies to latexmk only in continuous-preview + This variable applies to latexmk only in continuous-preview mode. If $new_viewer_always is 0, latexmk will check for a pre- - viously running previewer on the same file, and if one is run- - ning will not start a new one. If $new_viewer_always is non- - zero, this check will be skipped, and latexmk will behave as if + viously running previewer on the same file, and if one is run- + ning will not start a new one. If $new_viewer_always is non- + zero, this check will be skipped, and latexmk will behave as if no viewer is running. $out_dir [""] If non-blank, this variable specifies the output directory. - This is the directory in which final output files are written - (dvi, ps, pdf, synctex, synctex.gz). In addition, if the aux - directory equals the output directory, as is the case by de- - fault, then other generated files are in effect written to the + This is the directory in which final output files are written + (dvi, ps, pdf, synctex, synctex.gz). In addition, if the aux + directory equals the output directory, as is the case by de- + fault, then other generated files are in effect written to the output directory. If $out_dir is blank, the output directory is the current direc- - tory at the invocation of *latex; this is equivalent to setting + tory at the invocation of *latex; this is equivalent to setting $out_dir to '.'. - See the section AUXILIARY AND OUTPUT DIRECTORIES for more de- + See the section AUXILIARY AND OUTPUT DIRECTORIES for more de- tails. + 24 December 2023 59 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + $pdf_mode [0] - If zero, do NOT generate a pdf version of the document. If - equal to 1, generate a pdf version of the document using pdfla- - tex, using the command specified by the $pdflatex variable. If - equal to 2, generate a pdf version of the document from the ps - file, by using the command specified by the $ps2pdf variable. - If equal to 3, generate a pdf version of the document from the - dvi file, by using the command specified by the $dvipdf vari- + If zero, do NOT generate a pdf version of the document. If + equal to 1, generate a pdf version of the document using pdfla- + tex, using the command specified by the $pdflatex variable. If + equal to 2, generate a pdf version of the document from the ps + file, by using the command specified by the $ps2pdf variable. + If equal to 3, generate a pdf version of the document from the + dvi file, by using the command specified by the $dvipdf vari- able. If equal to 4, generate a pdf version of the document us- ing lualatex, using the command specified by the $lualatex vari- - able. If equal to 5, generate a pdf version (and an xdv ver- - sion) of the document using xelatex, using the commands speci- + able. If equal to 5, generate a pdf version (and an xdv ver- + sion) of the document using xelatex, using the commands speci- fied by the $xelatex and xdvipdfmx variables. - In $pdf_mode=2, it is ensured that .dvi and .ps files are also - made. In $pdf_mode=3, it is ensured that a .dvi file is also + In $pdf_mode=2, it is ensured that .dvi and .ps files are also + made. In $pdf_mode=3, it is ensured that a .dvi file is also made. But this may be overridden by the document. $pdflatex ["pdflatex %O %S"] Specifies the command line for the LaTeX processing program in a version that makes a pdf file instead of a dvi file. - - - 6 November 2023 58 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - An example use of this variable is to add certain options to the command line for the program, e.g., $pdflatex = "pdflatex --shell-escape %O %S"; - (In some earlier versions of latexmk, you needed to use an as- - signment to $pdflatex to allow the use of lualatex or xelatex + (In some earlier versions of latexmk, you needed to use an as- + signment to $pdflatex to allow the use of lualatex or xelatex instead of pdflatex. There are now separate configuration vari- - ables for the use of lualatex or xelatex. See $lualatex and + ables for the use of lualatex or xelatex. See $lualatex and $xelatex.) - To do a coordinated setting of all of $dvilualatex, $latex, - $pdflatex, $lualatex, and $xelatex, see the section "Advanced - Configuration". + To do a coordinated setting of all of $dvilualatex, $hilatex, + $latex, $pdflatex, $lualatex, and $xelatex, see the section "Ad- + vanced Configuration". %pdflatex_input_extensions - This variable specifies the extensions tried by latexmk when it - finds that a pdflatex run resulted in an error that a file has - not been found, and the file is given without an extension. - This typically happens when LaTeX commands of the form \in- - put{file} or \includegraphics{figure}, when the relevant source + This variable specifies the extensions tried by latexmk when it + finds that a pdflatex run resulted in an error that a file has + not been found, and the file is given without an extension. + This typically happens when LaTeX commands of the form \in- + put{file} or \includegraphics{figure}, when the relevant source file does not exist. - In this situation, latexmk searches for custom dependencies to - make the missing file(s), but restricts it to the extensions - specified by the variable %pdflatex_input_extensions. The de- + In this situation, latexmk searches for custom dependencies to + make the missing file(s), but restricts it to the extensions + specified by the variable %pdflatex_input_extensions. The de- fault extensions are 'tex', 'pdf', 'jpg, and 'png'. See details of the %latex_input_extensions for other information that equally applies to %pdflatex_input_extensions. - $pdflatex_silent_switch ["-interaction=batchmode"] - Switch(es) for the pdflatex program (specified in the variable - $pdflatex) when silent mode is on. - See details of the $latex_silent_switch for other information - that equally applies to $pdflatex_silent_switch. - $pdf_previewer ["start acroread %O %S"] - The command to invoke a pdf-previewer. - On MS-Windows, the default is changed to "cmd /c start """; un- - der more recent versions of Windows, this will cause to be run - whatever command the system has associated with .pdf files. But - this may be undesirable if this association is to acroread -- - see the notes in the explanation of the -pvc option.] + 24 December 2023 60 - On OS-X the default is changed to "open %S", which results in - OS-X starting up (and detaching) the viewer associated with the - file. By default, for pdf files this association is to OS-X's - preview, which is quite satisfactory. - WARNING: Problem under MS-Windows: if acroread is used as the - 6 November 2023 59 +LATEXMK(1) General Commands Manual LATEXMK(1) + $pdflatex_silent_switch ["-interaction=batchmode"] + Switch(es) for the pdflatex program (specified in the variable + $pdflatex) when silent mode is on. + See details of the $latex_silent_switch for other information + that equally applies to $pdflatex_silent_switch. + $pdf_previewer ["start acroread %O %S"] + The command to invoke a pdf-previewer. -LATEXMK(1) General Commands Manual LATEXMK(1) + On MS-Windows, the default is changed to "cmd /c start """; un- + der more recent versions of Windows, this will cause to be run + whatever command the system has associated with .pdf files. But + this may be undesirable if this association is to acroread -- + see the notes in the explanation of the -pvc option.] + On OS-X the default is changed to "open %S", which results in + OS-X starting up (and detaching) the viewer associated with the + file. By default, for pdf files this association is to OS-X's + preview, which is quite satisfactory. - pdf previewer, and it is actually viewing a pdf file, the pdf - file cannot be updated. Thus makes acroread a bad choice of - previewer if you use latexmk's previous-continuous mode (option + WARNING: Problem under MS-Windows: if acroread is used as the + pdf previewer, and it is actually viewing a pdf file, the pdf + file cannot be updated. Thus makes acroread a bad choice of + previewer if you use latexmk's previous-continuous mode (option -pvc) under MS-windows. This problem does not occur if, for ex- ample, SumatraPDF or gsview is used to view pdf files. - Important note: Normally you will want to have a previewer run + Important note: Normally you will want to have a previewer run detached, so that latexmk doesn't wait for the previewer to ter- - minate before continuing its work. So normally you should pre- - fix the command by "start ", which flags to latexmk that it - should do the detaching of the previewer itself (by whatever - method is appropriate to the operating system). But sometimes + minate before continuing its work. So normally you should pre- + fix the command by "start ", which flags to latexmk that it + should do the detaching of the previewer itself (by whatever + method is appropriate to the operating system). But sometimes letting latexmk do the detaching is not appropriate (for a vari- - ety of non-trivial reasons), so you should put the "start " bit + ety of non-trivial reasons), so you should put the "start " bit in yourself, whenever it is needed. $pdf_update_command [""] - When the pdf previewer is set to be updated by running a com- - mand, this is the command that is run. See the information for + When the pdf previewer is set to be updated by running a com- + mand, this is the command that is run. See the information for the variable $pdf_update_method. $pdf_update_method [1 under UNIX, 3 under MS-Windows] - How the pdf viewer updates its display when the pdf file has - changed. See the information on the variable $dvi_update_method + How the pdf viewer updates its display when the pdf file has + changed. See the information on the variable $dvi_update_method for the codes. (Note that information needs be changed slightly - so that for the value 4, to run a command to do the update, the - command is specified by the variable $pdf_update_command, and - for the value 2, to specify update by signal, the signal is + so that for the value 4, to run a command to do the update, the + command is specified by the variable $pdf_update_command, and + for the value 2, to specify update by signal, the signal is specified by $pdf_update_signal.) Note that acroread under MS-Windows (but not UNIX) locks the pdf file, so the default value is then 3. - Arranging to use a command to get a previewer explicitly updated - requires three variables to be set. For example: - $pdf_previewer = "start xpdf -remote %R %O %S"; - $pdf_update_method = 4; - $pdf_update_command = "xpdf -remote %R -reload"; - The first setting arranges for the xpdf program to be used in - its "remote server mode", with the server name specified as the - rootname of the TeX file. The second setting arranges for up- - dating to be done in response to a command, and the third set- - ting sets the update command. + 24 December 2023 61 - $pdf_update_signal [Under UNIX: SIGHUP, which is a system-dependent - value] - The number of the signal that is sent to the pdf viewer when it - is updated by sending a signal -- see the information on the - variable $pdf_update_method. The default value is the one ap- - propriate for gv on a UNIX system. - - 6 November 2023 60 - +LATEXMK(1) General Commands Manual LATEXMK(1) + Arranging to use a command to get a previewer explicitly updated + requires three variables to be set. For example: + $pdf_previewer = "start xpdf -remote %R %O %S"; + $pdf_update_method = 4; + $pdf_update_command = "xpdf -remote %R -reload"; -LATEXMK(1) General Commands Manual LATEXMK(1) + The first setting arranges for the xpdf program to be used in + its "remote server mode", with the server name specified as the + rootname of the TeX file. The second setting arranges for up- + dating to be done in response to a command, and the third set- + ting sets the update command. + $pdf_update_signal [Under UNIX: SIGHUP, which is a system-dependent + value] + The number of the signal that is sent to the pdf viewer when it + is updated by sending a signal -- see the information on the + variable $pdf_update_method. The default value is the one ap- + propriate for gv on a UNIX system. $pid_position[1 under UNIX, -1 under MS-Windows] - The variable $pid_position is used to specify which word in - lines of the output from $pscmd corresponds to the process ID. - The first word in the line is numbered 0. The default value of + The variable $pid_position is used to specify which word in + lines of the output from $pscmd corresponds to the process ID. + The first word in the line is numbered 0. The default value of 1 (2nd word in line) is correct for Solaris 2.6, Linux, and OS-X with their default settings of $pscmd. - Setting the variable to -1 is used to indicate that $pscmd is + Setting the variable to -1 is used to indicate that $pscmd is not to be used. $postscript_mode [0] - If nonzero, generate a postscript version of the document. + If nonzero, generate a postscript version of the document. Equivalent to the -ps option. - If some other request is made for which a postscript file is + If some other request is made for which a postscript file is needed, then $postscript_mode will be set to 1. $pre_tex_code [''] - Sets TeX code to be executed before inputting the source file. - This works if the relevant one of $latex, etc contains a suit- + Sets TeX code to be executed before inputting the source file. + This works if the relevant one of $latex, etc contains a suit- able command line with a %P or %U substitution. For example you could do $latex = 'latex %O %P'; $pre_tex_code = '\AtBeginDocument{An initial message\par}'; - To set all of $latex, $pdflatex, $lualatex, and $xelatex you + To set all of $latex, $pdflatex, $lualatex, and $xelatex you could use the subroutine alt_tex_cmds: &alt_tex_cmds; @@ -3999,55 +4085,53 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - $preview_continuous_mode [0] - If nonzero, run a previewer to view the document, and continue - running latexmk to keep .dvi up-to-date. Equivalent to the -pvc - option. Which previewer is run depends on the other settings, - see the command line options -view=, and the variable $view. - - $preview_mode [0] - If nonzero, run a previewer to preview the document. Equivalent - to the -pv option. Which previewer is run depends on the other - settings, see the command line options -view=, and the variable - $view. - - $printout_mode [0] - If nonzero, print the document using the command specified in - the $lpr variable. Equivalent to the -p option. This is recom- - mended not to be set from an RC file, otherwise you could waste - lots of paper. + 24 December 2023 62 - 6 November 2023 61 +LATEXMK(1) General Commands Manual LATEXMK(1) + $preview_continuous_mode [0] + If nonzero, run a previewer to view the document, and continue + running latexmk to keep .dvi up-to-date. Equivalent to the -pvc + option. Which previewer is run depends on the other settings, + see the command line options -view=, and the variable $view. -LATEXMK(1) General Commands Manual LATEXMK(1) + $preview_mode [0] + If nonzero, run a previewer to preview the document. Equivalent + to the -pv option. Which previewer is run depends on the other + settings, see the command line options -view=, and the variable + $view. + $printout_mode [0] + If nonzero, print the document using the command specified in + the $lpr variable. Equivalent to the -p option. This is recom- + mended not to be set from an RC file, otherwise you could waste + lots of paper. $print_type = ["auto"] - Type of file to printout: possibilities are "auto", "dvi", + Type of file to printout: possibilities are "auto", "dvi", "none", "pdf", or "ps". See the option -print= for the meaning of the "auto" value. $pscmd Command used to get all the processes currently run by the user. - The -pvc option uses the command specified by the variable - $pscmd to determine if there is an already running previewer, - and to find the process ID (needed if latexmk needs to signal + The -pvc option uses the command specified by the variable + $pscmd to determine if there is an already running previewer, + and to find the process ID (needed if latexmk needs to signal the previewer about file changes). Each line of the output of this command is assumed to correspond - to one process. See the $pid_position variable for how the + to one process. See the $pid_position variable for how the process number is determined. - The default for pscmd is "NONE" under MS-Windows and cygwin - (i.e., the command is not used), "ps -ww -u $ENV{USER}" under - OS-X, and "ps -f -u $ENV{USER}" under other operating systems + The default for pscmd is "NONE" under MS-Windows and cygwin + (i.e., the command is not used), "ps -ww -u $ENV{USER}" under + OS-X, and "ps -f -u $ENV{USER}" under other operating systems (including Linux). In these specifications "$ENV{USER}" is sub- stituted by the username. @@ -4056,74 +4140,75 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $ps_filter [empty] The postscript file filter to be run on the newly produced post- - script file before other processing. Equivalent to specifying + script file before other processing. Equivalent to specifying the -pF option. $ps_previewer ["start gv %O %S", but start %O %S under MS-Windows] - The command to invoke a ps-previewer. (The default under MS- + The command to invoke a ps-previewer. (The default under MS- Windows will cause to be run whatever command the system has as- sociated with .ps files.) - Note that gv could be used with the -watch option updates its - display whenever the postscript file changes, whereas ghostview - does not. However, different versions of gv have slightly dif- - ferent ways of writing this option. You can configure this - variable appropriately. + Note that gv could be used with the -watch option updates its + display whenever the postscript file changes, whereas ghostview - WARNING: Linux systems may have installed one (or more) versions - of gv under different names, e.g., ggv, kghostview, etc, but - perhaps not one actually called gv. - Important note: Normally you will want to have a previewer run - detached, so that latexmk doesn't wait for the previewer to ter- - minate before continuing its work. So normally you should pre- - fix the command by "start ", which flags to latexmk that it - should do the detaching of the previewer itself (by whatever - method is appropriate to the operating system). But sometimes - letting latexmk do the detaching is not appropriate (for a vari- - ety of non-trivial reasons), so you should put the "start " bit - in yourself, whenever it is needed. + 24 December 2023 63 - 6 November 2023 62 +LATEXMK(1) General Commands Manual LATEXMK(1) + does not. However, different versions of gv have slightly dif- + ferent ways of writing this option. You can configure this + variable appropriately. -LATEXMK(1) General Commands Manual LATEXMK(1) + WARNING: Linux systems may have installed one (or more) versions + of gv under different names, e.g., ggv, kghostview, etc, but + perhaps not one actually called gv. + + Important note: Normally you will want to have a previewer run + detached, so that latexmk doesn't wait for the previewer to ter- + minate before continuing its work. So normally you should pre- + fix the command by "start ", which flags to latexmk that it + should do the detaching of the previewer itself (by whatever + method is appropriate to the operating system). But sometimes + letting latexmk do the detaching is not appropriate (for a vari- + ety of non-trivial reasons), so you should put the "start " bit + in yourself, whenever it is needed. - $ps_previewer_landscape ["start gv -swap %O %S", but start %O %S under + $ps_previewer_landscape ["start gv -swap %O %S", but start %O %S under MS-Windows] The command to invoke a ps-previewer in landscape mode. $ps_update_command [""] - When the postscript previewer is set to be updated by running a - command, this is the command that is run. See the information + When the postscript previewer is set to be updated by running a + command, this is the command that is run. See the information for the variable $ps_update_method. $ps_update_method [0 under UNIX, 1 under MS-Windows] - How the postscript viewer updates its display when the .ps file - has changed. See the information on the variable $dvi_up- - date_method for the codes. (Note that information needs be + How the postscript viewer updates its display when the .ps file + has changed. See the information on the variable $dvi_up- + date_method for the codes. (Note that information needs be changed slightly so that for the value 4, to run a command to do - the update, the command is specified by the variable $ps_up- - date_command, and for the value 2, to specify update by signal, + the update, the command is specified by the variable $ps_up- + date_command, and for the value 2, to specify update by signal, the signal is specified by $ps_update_signal.) - $ps_update_signal [Under UNIX: SIGHUP, which is a system-dependent + $ps_update_signal [Under UNIX: SIGHUP, which is a system-dependent value] - The number of the signal that is sent to the pdf viewer when it - is updated by sending a signal -- see $ps_update_method. The + The number of the signal that is sent to the pdf viewer when it + is updated by sending a signal -- see $ps_update_method. The default value is the one appropriate for gv on a UNIX system. $pvc_timeout [0] - If this variable is nonzero, there will be a timeout in pvc - mode after a period of inactivity. Inactivity means a period - when latexmk has detected no file changes and hence has not + If this variable is nonzero, there will be a timeout in pvc + mode after a period of inactivity. Inactivity means a period + when latexmk has detected no file changes and hence has not taken any actions like compiling the document. The period of in- activity is in the variable $pvc_timeout_mins. @@ -4132,102 +4217,102 @@ LATEXMK(1) General Commands Manual LATEXMK(1) The period of inactivity, in minutes, after which pvc mode times out. This is used if $pvc_timeout is nonzero. - $pvc_view_file_via_temporary [1] - The same as $always_view_file_via_temporary, except that it only - applies in preview-continuous mode (-pvc option). - $quote_filenames [1] - This specifies whether substitutions for placeholders in command - specifications (as in $pdflatex) are surrounded by double - quotes. If this variable is 1 (or any other value Perl regards - as true), then quoting is done. Otherwise quoting is omitted. - The quoting method used by latexmk is tested to work correctly - under UNIX systems (including Linux and Mac OS-X) and under MS- - Windows. It allows the use of filenames containing special - characters, notably spaces. (But note that many versions of - *latex cannot correctly deal with TeX files whose names contain - spaces. Latexmk's quoting only ensures that such filenames are - correctly treated by the operating system in passing arguments - to programs.) + 24 December 2023 64 - 6 November 2023 63 +LATEXMK(1) General Commands Manual LATEXMK(1) + $pvc_view_file_via_temporary [1] + The same as $always_view_file_via_temporary, except that it only + applies in preview-continuous mode (-pvc option). -LATEXMK(1) General Commands Manual LATEXMK(1) + $quote_filenames [1] + This specifies whether substitutions for placeholders in command + specifications (as in $pdflatex) are surrounded by double + quotes. If this variable is 1 (or any other value Perl regards + as true), then quoting is done. Otherwise quoting is omitted. + The quoting method used by latexmk is tested to work correctly + under UNIX systems (including Linux and Mac OS-X) and under MS- + Windows. It allows the use of filenames containing special + characters, notably spaces. (But note that many versions of + *latex cannot correctly deal with TeX files whose names contain + spaces. Latexmk's quoting only ensures that such filenames are + correctly treated by the operating system in passing arguments + to programs.) $rc_report [1] - After initialization, whether to give a list of the RC files + After initialization, whether to give a list of the RC files read. $recorder [1] - Whether to use the -recorder option to *latex. Use of this op- - tion results in a file of extension .fls containing a list of - the files that these programs have read and written. Latexmk + Whether to use the -recorder option to *latex. Use of this op- + tion results in a file of extension .fls containing a list of + the files that these programs have read and written. Latexmk will then use this file to improve its detection of source files and generated files after a run of *latex. - It is generally recommended to use this option (or to configure - the $recorder variable to be on.) But it only works if *latex - supports the -recorder option, which is true for most current + It is generally recommended to use this option (or to configure + the $recorder variable to be on.) But it only works if *latex + supports the -recorder option, which is true for most current implementations - Note about the name of the .fls file: Most implementations of - *latex produce an .fls file with the same basename as the main + Note about the name of the .fls file: Most implementations of + *latex produce an .fls file with the same basename as the main document's LaTeX, e.g., for Document.tex, the .fls file is Docu- - ment.fls. However, some implementations instead produce files + ment.fls. However, some implementations instead produce files named for the program, i.e., latex.fls or pdflatex.fls. In this - second case, latexmk copies the latex.fls or pdflatex.fls to a - file with the basename of the main LaTeX document, e.g., Docu- + second case, latexmk copies the latex.fls or pdflatex.fls to a + file with the basename of the main LaTeX document, e.g., Docu- ment.fls. $search_path_separator [See below for default] The character separating paths in the environment variables TEX- - INPUTS, BIBINPUTS, and BSTINPUTS. This variable is mainly used - by latexmk when the -outdir, -output-directory, -auxdir, and/or - -aux-directory options are used. In that case latexmk needs to + INPUTS, BIBINPUTS, and BSTINPUTS. This variable is mainly used + by latexmk when the -outdir, -output-directory, -auxdir, and/or + -aux-directory options are used. In that case latexmk needs to communicate appropriately modified search paths to bibtex, dvipdf, dvips, and *latex. - [Comment to technically savvy readers: *latex doesn't actually - need the modified search path. But, surprisingly, dvipdf and - dvips do, because sometimes graphics files get generated in the - output or aux directories.] + [Comment to technically savvy readers: *latex doesn't actually + need the modified search path. But, surprisingly, dvipdf and - The default under MSWin and Cygwin is ';' and under UNIX-like - operating systems (including Linux and OS-X) is ':'. Normally - the defaults give correct behavior. But there can be difficul- - ties if your operating system is of one kind, but some of your - software is running under an emulator for the other kind of op- - erating system; in that case you'll need to find out what is - needed, and set $search_path_separator explicitly. (The same - goes, of course, for unusual operating systems that are not in - the MSWin, Linux, OS-X, Unix collection.) - $show_time [0] - Whether to show time used, both the total and for individual - steps. - Note: On MS Windows, this is clock time. On other OSs it is the - CPU time used (by latexmk and the child processes it invokes). + 24 December 2023 65 - 6 November 2023 64 +LATEXMK(1) General Commands Manual LATEXMK(1) + dvips do, because sometimes graphics files get generated in the + output or aux directories.] -LATEXMK(1) General Commands Manual LATEXMK(1) + The default under MSWin and Cygwin is ';' and under UNIX-like + operating systems (including Linux and OS-X) is ':'. Normally + the defaults give correct behavior. But there can be difficul- + ties if your operating system is of one kind, but some of your + software is running under an emulator for the other kind of op- + erating system; in that case you'll need to find out what is + needed, and set $search_path_separator explicitly. (The same + goes, of course, for unusual operating systems that are not in + the MSWin, Linux, OS-X, Unix collection.) + $show_time [0] + Whether to show time used, both the total and for individual + steps. + Note: On MS Windows, this is clock time. On other OSs it is the + CPU time used (by latexmk and the child processes it invokes). The OS-dependence is because of a limitation of Windows. If you wish to force the use of clock instead of CPU time, you can set @@ -4236,228 +4321,248 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $silence_logfile_warnings [0] - Whether after a run of *latex to summarize warnings in the log - file about undefined citations and references. Setting $si- + Whether after a run of *latex to summarize warnings in the log + file about undefined citations and references. Setting $si- lence_logfile_warnings=0 gives the summary of warnings (provided - silent mode isn't also set), and this is useful to locate unde- - fined citations and references without searching through the - much more verbose log file or the screen output of *latex. But - the summary can also be excessively annoying. The default is - not to give these warnings. The command line options -si- - lence_logfile_warning_list and -silence_logfile_warning_list- + silent mode isn't also set), and this is useful to locate unde- + fined citations and references without searching through the + much more verbose log file or the screen output of *latex. But + the summary can also be excessively annoying. The default is + not to give these warnings. The command line options -si- + lence_logfile_warning_list and -silence_logfile_warning_list- also set this variable. - Note that multiple occurrences for the same undefined object on + Note that multiple occurrences for the same undefined object on the same page and same line will be compressed to a single warn- ing. + $silent [0] - Whether to run silently. Setting $silent to 1 has the same ef- + Whether to run silently. Setting $silent to 1 has the same ef- fect as the -quiet of -silent options on the command line. + $sleep_time [2] - The time to sleep (in seconds) between checking for source file - changes when running with the -pvc option. This is subject to a - minimum of one second delay, except that zero delay is also al- - lowed. + The time to sleep (in seconds) between checking for source-file + changes when running with the -pvc option. If non-zero, it is + subject to a minimum value give by the $min_sleep_time variable. + But a zero value is also allowed. - A value of exactly 0 gives no delay, and typically results in - 100% CPU usage, which may not be desirable. - $texfile_search [""] - This is an obsolete variable, replaced by the @default_files - variable. - For backward compatibility, if you choose to set $tex- - file_search, it is a string of space-separated filenames, and - then latexmk replaces @default_files with the filenames in $tex- - file_search to which is added "*.tex". - $success_cmd [undefined] - See the documentation for $compiling_cmd. + 24 December 2023 66 - $tmpdir [See below for default] - Directory to store temporary files that latexmk may generate - while running. - The default under MSWindows (including cygwin), is to set $tm- - pdir to the value of the first of whichever of the system - 6 November 2023 65 +LATEXMK(1) General Commands Manual LATEXMK(1) + A value of exactly 0 gives no delay between checks for source- + file changes; it typically results in 100% CPU usage, which may + not be desirable. + In old versions of latexmk, the default value of $sleep_time of + 2 wB-pvctmodegand theeamountlofcCPUrusage.beOnemodernpocomputers + in + with fast multi-core CPUs, a smaller value, e.g., 0.1 can give + good results, especially when working with small documents whose + compilation may take well under a second. -LATEXMK(1) General Commands Manual LATEXMK(1) + $texfile_search [""] + This is an obsolete variable, replaced by the @default_files + variable. + + For backward compatibility, if you choose to set $tex- + file_search, it is a string of space-separated filenames, and + then latexmk replaces @default_files with the filenames in $tex- + file_search to which is added "*.tex". + + $success_cmd [undefined] + See the documentation for $compiling_cmd. + $tmpdir [See below for default] + Directory to store temporary files that latexmk may generate + while running. - environment variables TMPDIR or TEMP exists, otherwise to the - current directory. Under other operating systems (expected to - be UNIX/Linux, including OS-X), the default is the value of the - system environment variable TMPDIR if it exists, otherwise + The default under MSWindows (including cygwin), is to set $tm- + pdir to the value of the first of whichever of the system envi- + ronment variables TMPDIR or TEMP exists, otherwise to the cur- + rent directory. Under other operating systems (expected to be + UNIX/Linux, including OS-X), the default is the value of the + system environment variable TMPDIR if it exists, otherwise "/tmp". $use_make_for_missing_files [0] Whether to use make to try and make files that are missing after - a run of *latex, and for which a custom dependency has not been - found. This is generally useful only when latexmk is used as - part of a bigger project which is built by using the make pro- + a run of *latex, and for which a custom dependency has not been + found. This is generally useful only when latexmk is used as + part of a bigger project which is built by using the make pro- gram. Note that once a missing file has been made, no further calls to - make will be made on a subsequent run of latexmk to update the - file. Handling this problem is the job of a suitably defined - Makefile. See the section "USING latexmk WITH make" for how to - do this. The intent of calling make from latexmk is merely to + make will be made on a subsequent run of latexmk to update the + file. Handling this problem is the job of a suitably defined + Makefile. See the section "USING latexmk WITH make" for how to + do this. The intent of calling make from latexmk is merely to detect dependencies. $view ["default"] - Which kind of file is to be previewed if a previewer is used. - The possible values are "default", "dvi", "ps", "pdf". The + Which kind of file is to be previewed if a previewer is used. + The possible values are "default", "dvi", "ps", "pdf". The value of "default" means that the "highest" of the kinds of file + + + + 24 December 2023 67 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + generated is to be used (among .dvi, .ps and .pdf). $warnings_as_errors [0] - Normally latexmk copies the behavior of latex in treating unde- - fined references and citations and multiply defined references - as conditions that give a warning but not an error. The vari- + Normally latexmk copies the behavior of latex in treating unde- + fined references and citations and multiply defined references + as conditions that give a warning but not an error. The vari- able $warnings_as_errors controls whether this behavior is modi- fied. - When the variable is non-zero, latexmk at the end of its run - will return a non-zero status code to the operating system if - any of the files processed gives a warning about problems with + When the variable is non-zero, latexmk at the end of its run + will return a non-zero status code to the operating system if + any of the files processed gives a warning about problems with citations or references (i.e., undefined citations or references or multiply defined references). This is after latexmk has com- - pleted all the runs it needs to try and resolve references and - citations. Thus $warnings_as_errors being nonzero causes la- + pleted all the runs it needs to try and resolve references and + citations. Thus $warnings_as_errors being nonzero causes la- texmk to treat such warnings as errors, but only when they occur on the last run of *latex and only after processing is complete. - A non-zero value $warnings_as_errors can be set by the command- + A non-zero value $warnings_as_errors can be set by the command- line option -Werror. The default behavior is normally satisfactory in the usual edit- - compile-edit cycle. But, for example, latexmk can also be used - as part of a build process for some bigger project, e.g., for - creating documentation in the build of a software application. - Then it is often sensible to treat citation and reference warn- - ings as errors that require the overall build process to be + compile-edit cycle. But, for example, latexmk can also be used + as part of a build process for some bigger project, e.g., for + creating documentation in the build of a software application. + Then it is often sensible to treat citation and reference warn- + ings as errors that require the overall build process to be aborted. Of course, since multiple runs of *latex are generally - needed to resolve references and citations, what matters is not - - - - 6 November 2023 66 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - + needed to resolve references and citations, what matters is not the warnings on the first run, but the warnings on the last run; latexmk takes this into account appropriately. - In addition, when preview-continuous mode is used, a non-zero - value for $warnings_as_errors changes the use of the commands - $failure_cmd, $warning_cmd, and $success_cmd after a complia- + In addition, when preview-continuous mode is used, a non-zero + value for $warnings_as_errors changes the use of the commands + $failure_cmd, $warning_cmd, and $success_cmd after a complia- tion. If there are citation or reference warnings, but no other - errors, the behavior is as follows. If $warning_cmd is set, it - is used. If it is not set, then then if $warnings_as_errors is - non-zero and $failure_cmd is set, then $failure_cmd. Otherwise - $success_cmd is used, if it is set. (The foregoing explanation + errors, the behavior is as follows. If $warning_cmd is set, it + is used. If it is not set, then then if $warnings_as_errors is + non-zero and $failure_cmd is set, then $failure_cmd. Otherwise + $success_cmd is used, if it is set. (The foregoing explanation is rather complicated, because latexmk has to deal with the case that one or more of the commands isn't set.) $xdv_mode [0] - If one, generate an xdv version of the document by use of xela- + If one, generate an xdv version of the document by use of xela- tex. $xdvipdfmx ["xdvipdfmx -E -o %D %O %S"] - The program to make a pdf file from an xdv file (used in con- + The program to make a pdf file from an xdv file (used in con- junction with xelatex when $pdf_mode=5). - $xdvipdfmx_silent_switch ["-q"] - Switch(es) for the xdvipdfmx program when silent mode is on. - - $xelatex ["xelatex %O %S"] - Specifies the command line for the LaTeX processing program of - when the xelatex program is called for. See the documentation - of the -xelatex option for some special properties of latexmk's - use of xelatex. - Note about xelatex: latexmk uses xelatex to make an .xdv rather - than .pdf file, with the .pdf file being created in a separate - step. This is enforced by the use of the -no-pdf option. If %O - is part of the command for invoking xelatex, then latexmk will - insert the -no-pdf option automatically, otherwise you must pro- - vide the option yourself. See the documentation for the -pdfxe - option for why latexmk makes a .xdv file rather than a .pdf file - when xelatex is used. - To do a coordinated setting of all of $dvilualatex, $latex, - $pdflatex, $lualatex, and $xelatex, see the section "Advanced - Configuration". + 24 December 2023 68 - %xelatex_input_extensions - This variable specifies the extensions tried by latexmk when it - finds that an xelatex run resulted in an error that a file has - not been found, and the file is given without an extension. - This typically happens when LaTeX commands of the form \in- - put{file} or \includegraphics{figure}, when the relevant source - 6 November 2023 67 +LATEXMK(1) General Commands Manual LATEXMK(1) + $xdvipdfmx_silent_switch ["-q"] + Switch(es) for the xdvipdfmx program when silent mode is on. + $xelatex ["xelatex %O %S"] + Specifies the command line for the LaTeX processing program of + when the xelatex program is called for. See the documentation + of the -xelatex option for some special properties of latexmk's + use of xelatex. + Note about xelatex: latexmk uses xelatex to make an .xdv rather + than .pdf file, with the .pdf file being created in a separate + step. This is enforced by the use of the -no-pdf option. If %O + is part of the command for invoking xelatex, then latexmk will + insert the -no-pdf option automatically, otherwise you must pro- + vide the option yourself. See the documentation for the -pdfxe + option for why latexmk makes a .xdv file rather than a .pdf file + when xelatex is used. -LATEXMK(1) General Commands Manual LATEXMK(1) + To do a coordinated setting of all of $dvilualatex, $hilatex, + $latex, $pdflatex, $lualatex, and $xelatex, see the section "Ad- + vanced Configuration". + %xelatex_input_extensions + This variable specifies the extensions tried by latexmk when it + finds that an xelatex run resulted in an error that a file has + not been found, and the file is given without an extension. + This typically happens when LaTeX commands of the form \in- + put{file} or \includegraphics{figure}, when the relevant source file does not exist. - In this situation, latexmk searches for custom dependencies to - make the missing file(s), but restricts it to the extensions - specified by the variable %xelatex_input_extensions. The de- + In this situation, latexmk searches for custom dependencies to + make the missing file(s), but restricts it to the extensions + specified by the variable %xelatex_input_extensions. The de- fault extensions are 'tex', 'pdf', 'jpg, and 'png'. See details of the %latex_input_extensions for other information that equally applies to %xelatex_input_extensions. $xelatex_silent_switch ["-interaction=batchmode"] - Switch(es) for the xelatex program (specified in the variable + Switch(es) for the xelatex program (specified in the variable $xelatex) when silent mode is on. - See details of the $latex_silent_switch for other information + See details of the $latex_silent_switch for other information that equally applies to $xelatex_silent_switch. CUSTOM DEPENDENCIES - In any RC file a set of custom dependencies can be set up to convert a + In any RC file a set of custom dependencies can be set up to convert a file with one extension to a file with another. An example use of this would be to allow latexmk to convert a .fig file to .eps to be included in the .tex file. + + 24 December 2023 69 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + Defining a custom dependency: The old method of configuring latexmk to use a custom dependency was to - directly manipulate the @cus_dep_list array that contains information - defining the custom dependencies. (See the section "Old Method of - Defining Custom Dependencies" for details.) This method still works, + directly manipulate the @cus_dep_list array that contains information + defining the custom dependencies. (See the section "Old Method of + Defining Custom Dependencies" for details.) This method still works, but is no longer preferred. A better method is to use the subroutines that allow convenient manipu- @@ -4470,106 +4575,94 @@ CUSTOM DEPENDENCIES The arguments are as follows: from extension: - The extension of the file we are converting from (e.g. "fig"). + The extension of the file we are converting from (e.g. "fig"). It is specified without a period. to extension: The extension of the file we are converting to (e.g. "eps"). It is specified without a period. - must: If non-zero, the file from which we are converting must exist, - if it doesn't exist latexmk will give an error message and exit + must: If non-zero, the file from which we are converting must exist, + if it doesn't exist latexmk will give an error message and exit unless the -f option is specified. If must is zero and the file + we are converting from doesn't exist, then no action is taken. + Generally, the appropriate value of must is zero. + function: + The name of the subroutine that latexmk should call to perform + the file conversion. The first argument to the subroutine is + the base name of the file to be converted without any extension. + The subroutines are declared in the syntax of Perl. The func- + tion should return 0 if it was successful and a nonzero number + if it failed. - 6 November 2023 68 + Naturally add_cus_dep adds a custom dependency with the specified from + and to extensions. If a custom dependency has been previously defined + (e.g., in an rcfile that was read earlier), then it is replaced by the + new one. + The subroutine remove_cus_dep removes the specified custom dependency. + The subroutine show_cus_dep causes a list of the currently defined cus- + tom dependencies to be sent to the screen output. + How custom dependencies are used: + An instance of a custom dependency rule is created whenever latexmk de- + tects that a run of *latex needs to read a file, like a graphics file, + whose extension is the to-extension of a custom dependency. Then la- + texmk examines whether a file exists with the same name, but with the -LATEXMK(1) General Commands Manual LATEXMK(1) + 24 December 2023 70 - we are converting from doesn't exist, then no action is taken. - Generally, the appropriate value of must is zero. - function: - The name of the subroutine that latexmk should call to perform - the file conversion. The first argument to the subroutine is - the base name of the file to be converted without any extension. - The subroutines are declared in the syntax of Perl. The func- - tion should return 0 if it was successful and a nonzero number - if it failed. - Naturally add_cus_dep adds a custom dependency with the specified from - and to extensions. If a custom dependency has been previously defined - (e.g., in an rcfile that was read earlier), then it is replaced by the - new one. - The subroutine remove_cus_dep removes the specified custom dependency. - The subroutine show_cus_dep causes a list of the currently defined cus- - tom dependencies to be sent to the screen output. +LATEXMK(1) General Commands Manual LATEXMK(1) - How custom dependencies are used: - An instance of a custom dependency rule is created whenever latexmk de- - tects that a run of *latex needs to read a file, like a graphics file, - whose extension is the to-extension of a custom dependency. Then la- - texmk examines whether a file exists with the same name, but with the - corresponding from-extension, as specified in the custom-dependency. - If it does, then a corresponding instance of the custom dependency is - created, after which the rule is invoked whenever the destination file + corresponding from-extension, as specified in the custom-dependency. + If it does, then a corresponding instance of the custom dependency is + created, after which the rule is invoked whenever the destination file (the one with the to-extension) is out-of-date with respect to the cor- responding source file. - To make the new destination file, the Perl subroutine specified in the + To make the new destination file, the Perl subroutine specified in the rule is invoked, with an argument that is the base name of the files in - question. Simple cases just involve a subroutine invoking an external - program; this can be done by following the templates below, even by - those without knowledge of the Perl programming language. Of course, + question. Simple cases just involve a subroutine invoking an external + program; this can be done by following the templates below, even by + those without knowledge of the Perl programming language. Of course, experts could do something much more elaborate. - One item in the specification of each custom-dependency rule, labeled - "must" above, specifies how the rule should be applied when the source + One item in the specification of each custom-dependency rule, labeled + "must" above, specifies how the rule should be applied when the source file fails to exist. - When latex reports that an input file (e.g., a graphics file) does not + When latex reports that an input file (e.g., a graphics file) does not exist, latexmk tries to find a source file and a custom dependency that can be used to make it. If it succeeds, then it creates an instance of - the custom dependency and invokes it to make the missing file, after + the custom dependency and invokes it to make the missing file, after which the next pass of latex etc will be able to read the newly created file. - Note for advanced usage: The operating system's environment variable + Note for advanced usage: The operating system's environment variable TEXINPUTS can be used to specify a search path for finding files by la- - tex etc. Correspondingly, when a missing file is reported, latexmk - - - - 6 November 2023 69 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - - looks in the directories specified in TEXINPUTS as well as in the cur- - rent directory, to find a source file from which an instance of a cus- + tex etc. Correspondingly, when a missing file is reported, latexmk + looks in the directories specified in TEXINPUTS as well as in the cur- + rent directory, to find a source file from which an instance of a cus- tom dependency can be used to make the missing file. Function to implement custom dependency, traditional method: - The function that implements a custom dependency gets the information + The function that implements a custom dependency gets the information on the files to be processed in two ways. The first is through its one - argument; the argument contains the base name of the source and desti- + argument; the argument contains the base name of the source and desti- nation files. The second way is described later. - A simple and typical example of code in an initialization rcfile using + A simple and typical example of code in an initialization rcfile using the first method is: add_cus_dep( 'fig', 'eps', 0, 'fig2eps' ); @@ -4577,33 +4670,45 @@ LATEXMK(1) General Commands Manual LATEXMK(1) system( "fig2dev -Leps \"$_[0].fig\" \"$_[0].eps\"" ); } - The first line adds a custom dependency that converts a file with ex- + The first line adds a custom dependency that converts a file with ex- tension "fig", as created by the xfig program, to an encapsulated post- - script file, with extension "eps". The remaining lines define a sub- - routine that carries out the conversion. If a rule for converting - "fig" to "eps" files already exists (e.g., from a previously read-in - initialization file), the latexmk will delete this rule before making + script file, with extension "eps". The remaining lines define a sub- + routine that carries out the conversion. If a rule for converting + "fig" to "eps" files already exists (e.g., from a previously read-in + initialization file), the latexmk will delete this rule before making the new one. - Suppose latexmk is using this rule to convert a file "figure.fig" to - "figure.eps". Then it will invoke the fig2eps subroutine defined in - the above code with a single argument "figure", which is the basename - of each of the files (possibly with a path component). This argument - is referred to by Perl as $_[0]. In the example above, the subroutine + + + + 24 December 2023 71 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + + Suppose latexmk is using this rule to convert a file "figure.fig" to + "figure.eps". Then it will invoke the fig2eps subroutine defined in + the above code with a single argument "figure", which is the basename + of each of the files (possibly with a path component). This argument + is referred to by Perl as $_[0]. In the example above, the subroutine uses the Perl command system to invoke the program fig2dev. The double quotes around the string are a Perl idiom that signify that each string - of the form of a variable name, $_[0] in this case, is to be substi- + of the form of a variable name, $_[0] in this case, is to be substi- tuted by its value. - If the return value of the subroutine is non-zero, then latexmk will - assume an error occurred during the execution of the subroutine. In - the above example, no explicit return value is given, and instead the - return value is the value returned by the last (and only) statement, + If the return value of the subroutine is non-zero, then latexmk will + assume an error occurred during the execution of the subroutine. In + the above example, no explicit return value is given, and instead the + return value is the value returned by the last (and only) statement, i.e., the invocation of system, which returns the value 0 on success. - If you use pdflatex, lualatex or xelatex instead of latex, then you - will probably prefer to convert your graphics files to pdf format, in - which case you would replace the above code in an initialization file + If you use pdflatex, lualatex or xelatex instead of latex, then you + will probably prefer to convert your graphics files to pdf format, in + which case you would replace the above code in an initialization file by add_cus_dep( 'fig', 'pdf, 0, 'fig2pdf' ); @@ -4611,59 +4716,60 @@ LATEXMK(1) General Commands Manual LATEXMK(1) system( "fig2dev -Lpdf \"$_[0].fig\" \"$_[0].pdf\"" ); } - Note 1: In the command lines given in the system commands in the above + Note 1: In the command lines given in the system commands in the above + examples, double quotes have been inserted around the file names (im- + plemented by '\"' in the Perl language). They immunize the running of + the program against special characters in filenames. Very often these + quotes are not necessary, i.e., they can be omitted. But it is nor- + mally safer to keep them in. Even though the rules for quoting vary + between operating systems, command shells and individual pieces of + software, the quotes in the above examples do not cause problems in the + cases I have tested. + + Note 2: One case in which the quotes are important is when the files + are in a subdirectory and your operating system is Microsoft Windows. + Then the separator character for directory components can be either a + forward slash '/' or Microsoft's more usual backward slash '\'. For- + ward slashes are generated by latexmk, to maintain its sanity from + software like MiKTeX that mixes both directory separators; but their + correct use normally requires quoted filenames. (See a log file from a + run of MiKTeX (at least in v. 2.9) for an example of the use of both + directory separators.) + Note 3: The subroutines implementing custom dependencies in the exam- + ples given just have a single line invoking an external program. + That's the usual situation. But since the subroutines are in the Perl + language, you can implement much more complicated processing if you + need it. - 6 November 2023 70 + 24 December 2023 72 -LATEXMK(1) General Commands Manual LATEXMK(1) - examples, double quotes have been inserted around the file names (im- - plemented by '\"' in the Perl language). They immunize the running of - the program against special characters in filenames. Very often these - quotes are not necessary, i.e., they can be omitted. But it is nor- - mally safer to keep them in. Even though the rules for quoting vary - between operating systems, command shells and individual pieces of - software, the quotes in the above examples do not cause problems in the - cases I have tested. - Note 2: One case in which the quotes are important is when the files - are in a subdirectory and your operating system is Microsoft Windows. - Then the separator character for directory components can be either a - forward slash '/' or Microsoft's more usual backward slash '\'. For- - ward slashes are generated by latexmk, to maintain its sanity from - software like MiKTeX that mixes both directory separators; but their - correct use normally requires quoted filenames. (See a log file from a - run of MiKTeX (at least in v. 2.9) for an example of the use of both - directory separators.) - Note 3: The subroutines implementing custom dependencies in the exam- - ples given just have a single line invoking an external program. - That's the usual situation. But since the subroutines are in the Perl - language, you can implement much more complicated processing if you - need it. +LATEXMK(1) General Commands Manual LATEXMK(1) Removing custom dependencies, and when you might need to do this: - If you have some general custom dependencies defined in the system or - user initialization file, you may find that for a particular project - they are undesirable. So you might want to delete the unneeded ones. - A situation where this would be desirable is where there are multiple - custom dependencies with the same from-extension or the same to-exten- - sion. In that case, latexmk might choose a different one from the one + If you have some general custom dependencies defined in the system or + user initialization file, you may find that for a particular project + they are undesirable. So you might want to delete the unneeded ones. + A situation where this would be desirable is where there are multiple + custom dependencies with the same from-extension or the same to-exten- + sion. In that case, latexmk might choose a different one from the one you want for a specific project. As an example, to remove any "fig" to "eps" rule you would use: remove_cus_dep( 'fig', 'eps' ); - If you have complicated sets of custom dependencies, you may want to - get a listing of the custom dependencies. This is done by using the + If you have complicated sets of custom dependencies, you may want to + get a listing of the custom dependencies. This is done by using the line show_cus_dep(); @@ -4674,41 +4780,29 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Function implementing custom dependency, alternative methods: So far the examples for functions to implement custom dependencies have used the argument of the function to specify the base name of converted - file. This method has been available since very old versions of la- + file. This method has been available since very old versions of la- texmk, and many examples can be found, e.g., on the web. - However in later versions of latexmk the internal structure of the - - - - 6 November 2023 71 + However in later versions of latexmk the internal structure of the im- + plementation of its "rules" for the steps of processing, including cus- + tom dependencies, became much more powerful. The function implementing + a custom dependency is executed within a special context where a number + of extra variables and subroutines are defined. Publicly documented + ones, intended to be long-term stable, are listed below, under the + heading "Variables and subroutines for processing a rule". - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - - implementation of its "rules" for the steps of processing, including - custom dependencies, became much more powerful. The function imple- - menting a custom dependency is executed within a special context where - a number of extra variables and subroutines are defined. Publicly doc- - umented ones, intended to be long-term stable, are listed below, under - the heading "Variables and subroutines for processing a rule". - - Examples of their use is given in the following examples, concerning + Examples of their use is given in the following examples, concerning multiple index files and glossaries. - The only index-file conversion built-in to latexmk is from an ".idx" - file written on one run of *latex to an ".ind" file to be read in on a - subsequent run. But with the index.sty package, for example, you can - create extra indexes with extensions that you configure. Latexmk does + The only index-file conversion built-in to latexmk is from an ".idx" + file written on one run of *latex to an ".ind" file to be read in on a + subsequent run. But with the index.sty package, for example, you can + create extra indexes with extensions that you configure. Latexmk does not know how to deduce the extensions from the information it has. But - you can easily write a custom dependency. For example if your latex + you can easily write a custom dependency. For example if your latex file uses the command "\newindex{special}{ndx}{nnd}{Special index}" you - will need to get latexmk to convert files with the extension .ndx to - .nnd. The most elementary method is to define a custom dependency as + will need to get latexmk to convert files with the extension .ndx to + .nnd. The most elementary method is to define a custom dependency as follows: add_cus_dep( 'ndx', 'nnd', 0, 'ndx2nnd' ); @@ -4717,14 +4811,25 @@ LATEXMK(1) General Commands Manual LATEXMK(1) } push @generated_exts, 'ndx', 'nnd'; - Notice the added line compared with earlier examples. The extra line + + + 24 December 2023 73 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + + Notice the added line compared with earlier examples. The extra line gets the extensions "ndx" and "nnd" added to the list of extensions for generated files; then the extra index files will be deleted by clean-up operations - But if you have yet more indexes with yet different extensions, e.g., - "adx" and "and", then you will need a separate function for each pair - of extensions. This is quite annoying. You can use the Run_subst + But if you have yet more indexes with yet different extensions, e.g., + "adx" and "and", then you will need a separate function for each pair + of extensions. This is quite annoying. You can use the Run_subst function to simplify the definitions to use a single function: add_cus_dep( 'ndx', 'nnd', 0, 'dx2nd' ); @@ -4743,49 +4848,48 @@ LATEXMK(1) General Commands Manual LATEXMK(1) } push @generated_exts, 'ndx', 'nnd', 'adx', 'and'; - This last example uses the command specification in $makeindex, and so - - - - 6 November 2023 72 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - - any customization you have made for the standard index also applies to + This last example uses the command specification in $makeindex, and so + any customization you have made for the standard index also applies to your extra indexes. Similar techniques can be applied for glossaries. Those of you with experience with Makefiles, may get concerned that the - .ndx file is written during a run of *latex and is always later than + .ndx file is written during a run of *latex and is always later than the .nnd last read in. Thus the .nnd appears to be perpetually out-of- - date. This situation, of circular dependencies, is endemic to latex, - and is one of the issues that latexmk is programmed to overcome. It - examines the contents of the files (by use of a checksum), and only + date. This situation, of circular dependencies, is endemic to latex, + and is one of the issues that latexmk is programmed to overcome. It + examines the contents of the files (by use of a checksum), and only does a remake when the file contents have actually changed. - Of course if you choose to write random data to the .nnd (or the .aux - file, etc) that changes on each new run, then you will have a problem. + Of course if you choose to write random data to the .nnd (or the .aux + file, etc) that changes on each new run, then you will have a problem. For real experts: See the %hash_calc_ignore_pattern if you have to deal with such problems. Old Method of Defining Custom Dependencies: - In much older versions of latexmk, the only method of defining custom - dependencies was to directly manipulate the table of custom dependen- + In much older versions of latexmk, the only method of defining custom + dependencies was to directly manipulate the table of custom dependen- cies. This is contained in the @cus_dep_list array. It is an array of - strings, and each string in the array has four items in it, each sepa- - rated by a space, the from-extension, the to-extension, the "must" - item, and the name of the subroutine for the custom dependency. These + strings, and each string in the array has four items in it, each sepa- + rated by a space, the from-extension, the to-extension, the "must" + item, and the name of the subroutine for the custom dependency. These were all defined above. + + + 24 December 2023 74 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + An example of the old method of defining custom dependencies is as fol- - lows. It is the code in an RC file to ensure automatic conversion of + lows. It is the code in an RC file to ensure automatic conversion of .fig files to .eps files: push @cus_dep_list, "fig eps 0 fig2eps"; @@ -4793,48 +4897,36 @@ LATEXMK(1) General Commands Manual LATEXMK(1) return system( "fig2dev -Lps \"$_[0].fig\" \"$_[0].eps\"" ); } - This method still works, and is almost equivalent to the code given - earlier that used the add_cus_dep subroutine. However, the old method - doesn't delete any previous custom-dependency for the same conversion. + This method still works, and is almost equivalent to the code given + earlier that used the add_cus_dep subroutine. However, the old method + doesn't delete any previous custom-dependency for the same conversion. So the new method is preferable. Advanced configuration: Some extra resources and advanced tricks - For most purposes, simple configuration for latexmk along the lines of - the examples given is sufficient. But sometimes you need something - harder. In this section, I indicate some extra possibilities. Gener- - ally to use these, you need to be fluent in the Perl language, since + For most purposes, simple configuration for latexmk along the lines of + the examples given is sufficient. But sometimes you need something + harder. In this section, I indicate some extra possibilities. Gener- + ally to use these, you need to be fluent in the Perl language, since this is what is used in the rc files. - See also the section DEALING WITH ERRORS, PROBLEMS, ETC. See also the + See also the section DEALING WITH ERRORS, PROBLEMS, ETC. See also the examples in the directory example_rcfiles in the latexmk distributions. - Even if none of the examples apply to your case, they may give you - - - - 6 November 2023 73 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - - useful ideas + Even if none of the examples apply to your case, they may give you use- + ful ideas Utility subroutines ensure_path( var, values ...) - The first parameter is the name of one of the system's environ- - ment variables for search paths. The remaining parameters are - values that should be in the variable. For each of the value - parameters, if it isn't already in the variable, then it is + The first parameter is the name of one of the system's environ- + ment variables for search paths. The remaining parameters are + values that should be in the variable. For each of the value + parameters, if it isn't already in the variable, then it is prepended to the variable; in that case the environment variable - is created if it doesn't already exist. For separating values, - the character appropriate the the operating system is used -- + is created if it doesn't already exist. For separating values, + the character appropriate the the operating system is used -- see the configuration variable $search_path_separator. Example: @@ -4842,151 +4934,160 @@ LATEXMK(1) General Commands Manual LATEXMK(1) ensure_path( 'TEXINPUTS', './custom_cls_sty_files//' ); (In this example, the trailing '//' is documented by TeX systems - to mean that *latex search for files in the specified directory + to mean that *latex search for files in the specified directory and in all subdirectories.) - Technically ensure_path works by setting Perl's variable - $ENV{var}, where var is the name of the target variable. The - changed value is then passed as an environment variable to any + Technically ensure_path works by setting Perl's variable + $ENV{var}, where var is the name of the target variable. The + changed value is then passed as an environment variable to any invoked programs. + + + 24 December 2023 75 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + Variables and subroutines for processing a rule A step in the processing is called a rule. One possibility to implement - the processing of a rule is by a Perl subroutine. This is always the - case for custom dependencies. Also, for any other rule, you can use a - subroutine by prefixing the command specification by the word "inter- + the processing of a rule is by a Perl subroutine. This is always the + case for custom dependencies. Also, for any other rule, you can use a + subroutine by prefixing the command specification by the word "inter- nal" -- see the section FORMAT OF COMMAND SPECIFICATIONS. - When you use a subroutine for processing a rule, all the possibilities + When you use a subroutine for processing a rule, all the possibilities of Perl programming are available, of course. In addition, some of la- - texmk's internal variables and subroutines are available. The ones - listed below are intended to be available to (advanced) users, and + texmk's internal variables and subroutines are available. The ones + listed below are intended to be available to (advanced) users, and their specifications will generally have stability under upgrades. Gen- - erally, the variables should be treated as read-only: Changing their - values can have bad consequences, since it is liable to mess up the + erally, the variables should be treated as read-only: Changing their + values can have bad consequences, since it is liable to mess up the consistency of what latexmk is doing. - $rule This variable has the name of the rule, as known to latexmk. - Note that the exact contents of this variable for a given rule + $rule This variable has the name of the rule, as known to latexmk. + Note that the exact contents of this variable for a given rule may be dependent on the version of latexmk $$Psource This gives the name of the primary source file. Note the double dollar signs. - - - - - 6 November 2023 74 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - $$Pdest - This gives the name of the main output file if any. Note the + This gives the name of the main output file if any. Note the double dollar signs. pushd( path ), popd() - These subroutines are used when it is needed to temporarily + These subroutines are used when it is needed to temporarily change the working directory, as in pushd( 'some_directory' ); - ... Processing done with 'some_directory' as the working + ... Processing done with 'some_directory' as the working directory popd() - They perform exactly the same function as the commands of the + They perform exactly the same function as the commands of the same names in operating system command shells like bash on Unix, and cmd.exe on the Windows. rdb_add_generated( file, ... ) This subroutine is to be used in the context of a rule, that is, - from within a subroutine that is carrying out processing of a + from within a subroutine that is carrying out processing of a rule. Such is the case for the subroutine implementing a custom - dependency, or the subroutine invoked by using the "internal" - keyword in the command specification like that in the variable + dependency, or the subroutine invoked by using the "internal" + keyword in the command specification like that in the variable $latex. - Its arguments are a sequence of filenames which are generated - during the running of the rule. The names might arise from an + Its arguments are a sequence of filenames which are generated + during the running of the rule. The names might arise from an analysis of the results of the run, e.g., in a log file, or from - knowledge of properties of the specific rule. Calling - rdb_add_generated with these filenames ensures that these files - are flagged as generated by the rule in latexmk's internal data - structures. Basically, no action is taken if the files have al- - ready been flagged as generated. - A main purpose of using this subroutine is for the situation - when a generated file is also the source file for some rule, so - that latexmk can correctly link the dependency information in - its network of rules. - Note: Unlike some other subroutines in this section, there is no - argument for a rule for rdb_add_generated. Instead, the subrou- - tine is to be invoked during the processing of a rule when la- - texmk has set up an appropriate context (i.e., appropriate vari- - ables). In contrast, subroutines with a rule argument can be - used also outside a rule context. + 24 December 2023 76 - rdb_ensure_file( $rule, file ) - This subroutine ensures that the given file is among the source - files for the specified rule. It is typically used when, during - the processing of a rule, it is known that a particular extra - file is among the dependencies that latexmk should know, but its - 6 November 2023 75 +LATEXMK(1) General Commands Manual LATEXMK(1) + knowledge of properties of the specific rule. Calling + rdb_add_generated with these filenames ensures that these files + are flagged as generated by the rule in latexmk's internal data + structures. Basically, no action is taken if the files have al- + ready been flagged as generated. + A main purpose of using this subroutine is for the situation + when a generated file is also the source file for some rule, so + that latexmk can correctly link the dependency information in + its network of rules. -LATEXMK(1) General Commands Manual LATEXMK(1) + Note: Unlike some other subroutines in this section, there is no + argument for a rule for rdb_add_generated. Instead, the subrou- + tine is to be invoked during the processing of a rule when la- + texmk has set up an appropriate context (i.e., appropriate vari- + ables). In contrast, subroutines with a rule argument can be + used also outside a rule context. - default methods don't find the dependency. Almost always the - first argument is the name of the rule currently being pro- + rdb_ensure_file( $rule, file ) + This subroutine ensures that the given file is among the source + files for the specified rule. It is typically used when, during + the processing of a rule, it is known that a particular extra + file is among the dependencies that latexmk should know, but its + default methods don't find the dependency. Almost always the + first argument is the name of the rule currently being pro- cessed, so it is then appropriate to specify it by $rule. - For examples of its use, see some of the files in the directory - example_rcfiles of latexmk's distribution. Currently the cases - that use this subroutine are bib2gls-latexmkrc, exceltex_la- - texmkrc and texinfo-latexmkrc. These illustrate typical cases - where latexmk's normal processing fails to detect certain extra + For examples of its use, see some of the files in the directory + example_rcfiles of latexmk's distribution. Currently the cases + that use this subroutine are bib2gls-latexmkrc, exceltex_la- + texmkrc and texinfo-latexmkrc. These illustrate typical cases + where latexmk's normal processing fails to detect certain extra source files. Note that rdb_ensure_file only has one filename argument, unlike other subroutines in this section. If you want to apply its ac- - tion to multiple files, you will need one call to rdb_en- + tion to multiple files, you will need one call to rdb_en- sure_file for each file. rdb_remove_files( $rule, file, ... ) - This subroutine removes one or more files from the dependency + This subroutine removes one or more files from the dependency list for the given rule. rdb_remove_generated( file, ... ) This subroutine is to be used in the context of a rule, that is, - from within a subroutine that is carrying out processing of a - rule. It performs the opposite action to rdb_add_generated. - Its effect is to ensure that the given filenames are not listed - in latexmk's internal data structures as being generated by the + from within a subroutine that is carrying out processing of a + rule. It performs the opposite action to rdb_add_generated. + Its effect is to ensure that the given filenames are not listed + in latexmk's internal data structures as being generated by the rule. + + + 24 December 2023 77 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + rdb_list_source( $rule ) - This subroutine returns the list of source files (i.e., the de- + This subroutine returns the list of source files (i.e., the de- pendency list) for the given rule. @@ -4994,9 +5095,9 @@ LATEXMK(1) General Commands Manual LATEXMK(1) rdb_set_source( $rule, @files ) - This subroutine sets the dependency list for the given rule to + This subroutine sets the dependency list for the given rule to be the specified files. Files that are already in the list have - unchanged information. Files that were not in the list are + unchanged information. Files that were not in the list are added to it. Files in the previous dependency list that are not in the newly specified list of files are removed from the depen- dency list. @@ -5004,59 +5105,58 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Run_subst( command_spec ) This subroutine runs the command specified by command_spec. The - specification is a string in the format listed in the section - "Format of Command Specifications". An important action of the + specification is a string in the format listed in the section + "Format of Command Specifications". An important action of the Run_subst is to make substitutions of placeholders, e.g., %S and - %D for source and destination files; these get substituted - - - - 6 November 2023 76 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - - before the command is run. In addition, the command after sub- - stitution is printed to the screen unless latexmk is running in + %D for source and destination files; these get substituted be- + fore the command is run. In addition, the command after substi- + tution is printed to the screen unless latexmk is running in silent mode. Coordinated Setting of Commands for *latex - To set all of $dvilualatex, $latex, $pdflatex, $lualatex, and $xelatex - to a common pattern, you can use one of the following subroutines, - std_tex_cmds, alt_tex_cmds, and set_tex_cmds. + To set all of $dvilualatex, $hilatex, $latex, $pdflatex, $lualatex, and + $xelatex to a common pattern, you can use one of the following subrou- + tines, std_tex_cmds, alt_tex_cmds, and set_tex_cmds. To get the standard commands, use &std_tex_cmds; This results in $latex = 'latex %O %S', and similarly for $dvilualatex, - $pdflatex, $lualatex, and $xelatex. Note the ampersand in the invoca- - tion; this indicates to Perl that a subroutine is being called. (The - use of this subroutine enables you to override previous redefinitions - of the $latex, etc variables, which might have occurred in an earlier- - read rc file.) + $hilatex, $pdflatex, $lualatex, and $xelatex. Note the ampersand in + the invocation; this indicates to Perl that a subroutine is being + called. (The use of this subroutine enables you to override previous + redefinitions of the $latex, etc variables, which might have occurred + in an earlier-read rc file.) - To be able to use the string provided by the -pretex option (if any), + To be able to use the string provided by the -pretex option (if any), you can use &alt_tex_cmds; - This results in $latex = 'latex %O %P', etc. Again note the ampersand - in the invocation; this indicates to Perl that a subroutine is being + This results in $latex = 'latex %O %P', etc. Again note the ampersand + in the invocation; this indicates to Perl that a subroutine is being called. A more general way of specifying the variables is using + + + 24 December 2023 78 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + set_tex_cmds( 'CMD_SPEC' ); - Here CMD_SPEC is the command line without the program name. This re- - sults in $latex = 'latex CMD_SPEC', and similarly for $pdflatex, etc. - (An ampersand preceding the subroutine name is not necessary here, + Here CMD_SPEC is the command line without the program name. This re- + sults in $latex = 'latex CMD_SPEC', and similarly for $pdflatex, etc. + (An ampersand preceding the subroutine name is not necessary here, since the parentheses show Perl that a subroutine is being invoked.) An example that provides the --interaction=batchmode option to the *la- @@ -5064,68 +5164,69 @@ LATEXMK(1) General Commands Manual LATEXMK(1) set_tex_cmds( '--interaction=batchmode %O %S' ); - This results in $latex = 'latex --interaction=batchmode %O %S ', etc. - Note that when '%O' appears after the added option, as here, options + This results in $latex = 'latex --interaction=batchmode %O %S ', etc. + Note that when '%O' appears after the added option, as here, options provided on the command line to latexmk can override the supplied one. A more general command line can be set up by using the placeholder '%C' in CMD_SPEC. The '%C' is substituted by the basic name of the command, i.e., whichever of 'latex', 'pdflatex', etc is appropriate. (More than - one occurrence of '%C' is allowed.) For example to use the develop- + one occurrence of '%C' is allowed.) For example to use the develop- ment/pre-release versions of latex, etc, which have names, 'latex-dev', 'pdflatex-dev', etc, you could use - - - 6 November 2023 77 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - set_tex_cmds( '%C-dev %O %S' ); This results in $latex = 'latex-dev %O %S', etc. (The pre-release pro- - grams latex-dev etc are provided in current distributions of TeXLive + grams latex-dev etc are provided in current distributions of TeXLive and MiKTeX.) Advanced configuration: Using latexmk with make - This section is targeted only at advanced users who use the make pro- + This section is targeted only at advanced users who use the make pro- gram for complex projects, as for software development, with the depen- dencies specified by a Makefile. - Now the basic task of latexmk is to run the appropriate programs to - make a viewable version of a LaTeX document. However, the usual make - program is not suited to this purpose for at least two reasons. First + Now the basic task of latexmk is to run the appropriate programs to + make a viewable version of a LaTeX document. However, the usual make + program is not suited to this purpose for at least two reasons. First is that the use of LaTeX involves circular dependencies (e.g., via .aux files), and these cannot be handled by the standard make program. Sec- - ond is that in a large document the set of source files can change - quite frequently, particularly with included graphics files; in this - situation keeping a Makefile manually updated is inappropriate and er- + ond is that in a large document the set of source files can change + quite frequently, particularly with included graphics files; in this + situation keeping a Makefile manually updated is inappropriate and er- ror-prone, especially when the dependencies can be determined automati- cally. Latexmk solves both of these problems robustly. - Thus for many standard LaTeX documents latexmk can be used by itself - without the make program. In a complex project it simply needs to be - suitably configured. A standard configuration would be to define cus- - tom dependencies to make graphics files from their source files (e.g., - as created by the xfig program). Custom dependencies are latexmk's + Thus for many standard LaTeX documents latexmk can be used by itself + without the make program. In a complex project it simply needs to be + suitably configured. A standard configuration would be to define cus- + tom dependencies to make graphics files from their source files (e.g., + as created by the xfig program). Custom dependencies are latexmk's equivalent of pattern rules in Makefiles. - Nevertheless there are projects for which a Makefile is appropriate, + Nevertheless there are projects for which a Makefile is appropriate, + + + + 24 December 2023 79 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + and it is useful to know how to use latexmk from a Makefile. A typical example would be to generate documentation for a software project. Po- - tentially the interaction with the rest of the rules in the Makefile + tentially the interaction with the rest of the rules in the Makefile could be quite complicated, for example if some of the source files for a LaTeX document are generated by the project's software. In this section, I give a couple of examples of how latexmk can be use- - fully invoked from a Makefile. The examples use specific features of - current versions of GNU make, which is the default on both linux and + fully invoked from a Makefile. The examples use specific features of + current versions of GNU make, which is the default on both linux and OS-X systems. They may need modifications for other versions of make. The simplest method is simply to delegate all the relevant tasks to la- @@ -5137,45 +5238,33 @@ LATEXMK(1) General Commands Manual LATEXMK(1) %.pdf : %.tex FORCE_MAKE latexmk -pdf -dvi- -ps- $< - (Note: the last line must be introduced by a tab for the Makefile to - function correctly!) Naturally, if making try.pdf from its associated - LaTeX file try.tex were the only task to be performed, a direct use of - - - - 6 November 2023 78 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - - latexmk without a Makefile would normally be better. The benefit of - using a Makefile for a LaTeX document would be in a larger project, + (Note: the last line must be introduced by a tab for the Makefile to + function correctly!) Naturally, if making try.pdf from its associated + LaTeX file try.tex were the only task to be performed, a direct use of + latexmk without a Makefile would normally be better. The benefit of + using a Makefile for a LaTeX document would be in a larger project, where lines such as the above would be only be a small part of a larger Makefile. The above example has a pattern rule for making a .pdf file from a .tex - file, and it is defined to use latexmk in the obvious way. There is a + file, and it is defined to use latexmk in the obvious way. There is a conventional default target named "all", with a prerequisite of - try.pdf. So when make is invoked, by default it makes try.pdf. The - only complication is that there may be many source files beyond + try.pdf. So when make is invoked, by default it makes try.pdf. The + only complication is that there may be many source files beyond try.tex, but these aren't specified in the Makefile, so changes in them - will not by themselves cause latexmk to be invoked. Instead, the pat- - tern rule is equipped with a "phony" prerequisite FORCE_MAKE; this has - the effect of causing the rule to be always out-of-date, so that la- - texmk is always run. It is latexmk that decides whether any action is - needed, e.g., a rerun of pdflatex. Effectively the Makefile delegates - all decisions to latexmk, while make has no knowledge of the list of + will not by themselves cause latexmk to be invoked. Instead, the pat- + tern rule is equipped with a "phony" prerequisite FORCE_MAKE; this has + the effect of causing the rule to be always out-of-date, so that la- + texmk is always run. It is latexmk that decides whether any action is + needed, e.g., a rerun of pdflatex. Effectively the Makefile delegates + all decisions to latexmk, while make has no knowledge of the list of source files except for primary LaTeX file for the document. If there are, for example, graphics files to be made, these must be made by cus- tom dependencies configured in latexmk. - But something better is needed in more complicated situations, for ex- + But something better is needed in more complicated situations, for ex- ample, when the making of graphics files needs to be specified by rules - in the Makefile. To do this, one can use a Makefile like the follow- + in the Makefile. To do this, one can use a Makefile like the follow- ing: TARGETS = document1.pdf document2.pdf @@ -5183,6 +5272,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK = latexmk -recorder -use-make -deps \ -e 'warn qq(In Makefile, turn off custom dependencies\n);' \ -e '@cus_dep_list = ();' \ + + + + 24 December 2023 80 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + -e 'show_cus_dep();' all : $(TARGETS) $(foreach file,$(TARGETS),$(eval -include $(DEPS_DIR)/$(file)P)) @@ -5194,127 +5295,128 @@ LATEXMK(1) General Commands Manual LATEXMK(1) %.pdf : %.fig fig2dev -Lpdf $< $@ - (Again, the lines containing the commands for the rules should be + (Again, the lines containing the commands for the rules should be started with tabs.) This example was inspired by how GNU automake han- dles automatic dependency tracking of C source files. - After each run of latexmk, dependency information is put in a file in - the .deps subdirectory. The Makefile causes these dependency files to + After each run of latexmk, dependency information is put in a file in + the .deps subdirectory. The Makefile causes these dependency files to be read by make, which now has the full dependency information for each - target .pdf file. To make things less trivial it is specificed that - two files document1.pdf and document2.pdf are the targets. The depen- + target .pdf file. To make things less trivial it is specificed that + two files document1.pdf and document2.pdf are the targets. The depen- dency files are .deps/document1.pdfP and .deps/document2.pdfP. - There is now no need for the phony prerequisite for the rule to make - - - - 6 November 2023 79 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - + There is now no need for the phony prerequisite for the rule to make .pdf files from .tex files. But I have added a rule to make .pdf files - from .fig files produced by the xfig program; these are commonly used - for graphics insertions in LaTeX documents. Latexmk is arranged to + from .fig files produced by the xfig program; these are commonly used + for graphics insertions in LaTeX documents. Latexmk is arranged to output a dependency file after each run. It is given the -recorder op- - tion, which improves its detection of files generated during a run of - pdflatex; such files should not be in the dependency list. The -e op- - tions are used to turn off all custom dependencies, and to document - this. Instead the -use-make is used to delegate the making of missing + tion, which improves its detection of files generated during a run of + pdflatex; such files should not be in the dependency list. The -e op- + tions are used to turn off all custom dependencies, and to document + this. Instead the -use-make is used to delegate the making of missing files to make itself. - Suppose in the LaTeX file there is a command \includegraphics{graph}, - and an xfig file "graph.fig" exists. On a first run, pdflatex reports - a missing file, named "graph". Latexmk succeeds in making "graph.pdf" + Suppose in the LaTeX file there is a command \includegraphics{graph}, + and an xfig file "graph.fig" exists. On a first run, pdflatex reports + a missing file, named "graph". Latexmk succeeds in making "graph.pdf" by calling "make graph.pdf", and after completion of its work, it lists "fig.pdf" among the dependents of the file latexmk is making. Then let - "fig.fig" be updated, and then let make be run. Make first remakes + "fig.fig" be updated, and then let make be run. Make first remakes "fig.pdf", and only then reruns latexmk. - Thus we now have a method by which all the subsidiary processing is + Thus we now have a method by which all the subsidiary processing is delegated to make. - Escaping of characters in dependency lists: There are certain special - characters that need to be escaped when names of files and directories - containing them appear in a dependency list used by a make program. + Escaping of characters in dependency lists: There are certain special + characters that need to be escaped when names of files and directories + containing them appear in a dependency list used by a make program. Generally, such special characters are best avoided. - By default, latexmk does no escaping of this kind, and the user will + By default, latexmk does no escaping of this kind, and the user will have to arrange to deal with the issue separately, if the relevant spe- - cial characters are used. Note that the rules for escaping depend on + cial characters are used. Note that the rules for escaping depend on which make program is used, and on its version. - One special case is of spaces, since those are particularly prevalent, - notably in standard choices of name for a user's home directory. So - latexmk does provide an option to escape spaces. See the option - -deps_escape=... and the variable $deps_escape for details. -NON_ASCII CHARACTERS IN FILENAMES, RC FILES, ETC - Modern operating systems and file systems allow non-ASCII characters in - the names of files and directories that encompass the full Unicode - range. Mostly, latexmk deals with these correctly. However, there are - some situations in which there are problems, notably on Microsoft Win- - dows. Prior to version 4.77, latexmk had problems with non-ASCII file- - names on Windows, even though there were no corresponding problems on - macOS and Linux. These problems are corrected in the present version. + 24 December 2023 81 - DETAILS TO BE FILLED IN -SEE ALSO - latex(1), bibtex(1), lualatex(1), pdflatex(1), xelatex(1). +LATEXMK(1) General Commands Manual LATEXMK(1) + One special case is of spaces, since those are particularly prevalent, + notably in standard choices of name for a user's home directory. So + latexmk does provide an option to escape spaces. See the option + -deps_escape=... and the variable $deps_escape for details. - 6 November 2023 80 +NON_ASCII CHARACTERS IN FILENAMES, RC FILES, ETC + Modern operating systems and file systems allow non-ASCII characters in + the names of files and directories that encompass the full Unicode + range. Mostly, latexmk deals with these correctly. However, there are + some situations in which there are problems, notably on Microsoft Win- + dows. Prior to version 4.77, latexmk had problems with non-ASCII file- + names on Windows, even though there were no corresponding problems on + macOS and Linux. These problems are corrected in the present version. + + DETAILS TO BE FILLED IN -LATEXMK(1) General Commands Manual LATEXMK(1) +SEE ALSO + latex(1), bibtex(1), lualatex(1), pdflatex(1), xelatex(1). BUGS (SELECTED) Sometimes a viewer (gv) tries to read an updated .ps or .pdf file after - its creation is started but before the file is complete. Work around: + its creation is started but before the file is complete. Work around: manually refresh (or reopen) display. Or use one of the other preview- ers and update methods. - (The following isn't really a bug, but concerns features of preview- - ers.) Preview continuous mode only works perfectly with certain pre- - viewers: Xdvi on UNIX/Linux works for dvi files. Gv on UNIX/Linux - works for both postscript and pdf. Ghostview on UNIX/Linux needs a - manual update (reopen); it views postscript and pdf. Gsview under MS- - Windows works for both postscript and pdf, but only reads the updated - file when its screen is refreshed. Acroread under UNIX/Linux views - pdf, but the file needs to be closed and reopened to view an updated - version. Under MS-Windows, acroread locks its input file and so the - pdf file cannot be updated. (Remedy: configure latexmk to use suma- + (The following isn't really a bug, but concerns features of preview- + ers.) Preview continuous mode only works perfectly with certain pre- + viewers: Xdvi on UNIX/Linux works for dvi files. Gv on UNIX/Linux + works for both postscript and pdf. Ghostview on UNIX/Linux needs a + manual update (reopen); it views postscript and pdf. Gsview under MS- + Windows works for both postscript and pdf, but only reads the updated + file when its screen is refreshed. Acroread under UNIX/Linux views + pdf, but the file needs to be closed and reopened to view an updated + version. Under MS-Windows, acroread locks its input file and so the + pdf file cannot be updated. (Remedy: configure latexmk to use suma- trapdf instead.) THANKS TO - Authors of previous versions. Many users with their feedback, and es- + Authors of previous versions. Many users with their feedback, and es- pecially David Coppit (username david at node coppit.org) who made many - useful suggestions that contributed to version 3, and Herbert Schulz. - (Please note that the e-mail addresses are not written in their stan- + useful suggestions that contributed to version 3, and Herbert Schulz. + (Please note that the e-mail addresses are not written in their stan- dard form to avoid being harvested too easily.) AUTHOR - Current version, by John Collins (Version 4.81). Report bugs etc to + Current version, by John Collins (Version 4.82). Report bugs etc to his e-mail (jcc8 at psu.edu). - Released version can be obtained from CTAN: - <http://www.ctan.org/pkg/latexmk/>, and from the author's website + Released version can be obtained from CTAN: + + + + 24 December 2023 82 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + + <http://www.ctan.org/pkg/latexmk/>, and from the author's website <https://www.cantab.net/users/johncollins/latexmk/>. Modifications and enhancements by Evan McLean (Version 2.0) Original script called "go" by David J. Musliner (RCS Version 3.2) @@ -5341,6 +5443,36 @@ AUTHOR - 6 November 2023 81 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 24 December 2023 83 |