diff options
Diffstat (limited to 'Master')
| -rw-r--r-- | Master/texmf-dist/doc/man/man1/latexmk.1 | 8 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/man/man1/latexmk.man1.pdf | bin | 221438 -> 221685 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/CHANGES | 5 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/INSTALL | 180 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/README | 57 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/example_rcfiles/graphviz-latexmkrc | 11 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/example_rcfiles/sagetex_latexmkrc | 3 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/latexmk.pdf | bin | 196426 -> 196484 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/latexmk.txt | 2408 | ||||
| -rwxr-xr-x | Master/texmf-dist/scripts/latexmk/latexmk.pl | 30 |
10 files changed, 1339 insertions, 1363 deletions
diff --git a/Master/texmf-dist/doc/man/man1/latexmk.1 b/Master/texmf-dist/doc/man/man1/latexmk.1 index 0c3bd60853c..70c5614d407 100644 --- a/Master/texmf-dist/doc/man/man1/latexmk.1 +++ b/Master/texmf-dist/doc/man/man1/latexmk.1 @@ -1,4 +1,4 @@ -.TH LATEXMK 1 "29 May 2021" "" +.TH LATEXMK 1 "21 September 2021" "" .SH NAME latexmk \- generate LaTeX document .SH SYNOPSIS @@ -252,7 +252,7 @@ Note that this value does \fInot\fR work properly if the document uses .TP .B -bibtex-cond1 -The same as \fB-bibtex-cond1\fR except that .bbl files are only +The same as \fB-bibtex-cond\fR except that .bbl files are only treated as precious if one or more bibfiles fails to exist. Thus if all the bib files exist, \fIbibtex\fR or \fIbiber\fR is run to @@ -1125,7 +1125,7 @@ After initialization, give a list of the RC files read. (Default) .TP .B -rc-report- -After initialization, do not give a list of the RC files read. (Default) +After initialization, do not give a list of the RC files read. .TP .B -recorder @@ -3995,7 +3995,7 @@ e-mail addresses are not written in their standard form to avoid being harvested too easily.) .SH AUTHOR Current version, by John Collins -(Version 4.74b). +(Version 4.75). Report bugs etc to his e-mail (jcc8 at psu.edu). Released version can be obtained from CTAN: diff --git a/Master/texmf-dist/doc/man/man1/latexmk.man1.pdf b/Master/texmf-dist/doc/man/man1/latexmk.man1.pdf Binary files differindex d70d3b568bb..e968f7a9121 100644 --- a/Master/texmf-dist/doc/man/man1/latexmk.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/latexmk.man1.pdf diff --git a/Master/texmf-dist/doc/support/latexmk/CHANGES b/Master/texmf-dist/doc/support/latexmk/CHANGES index fc6f77891eb..bfccc07d41d 100644 --- a/Master/texmf-dist/doc/support/latexmk/CHANGES +++ b/Master/texmf-dist/doc/support/latexmk/CHANGES @@ -778,3 +778,8 @@ From v. 4.74 to 4.74b Add .synctex and .synctex.gz to list of extensions to clear by default. Turn back on default to report rc files read. Add options -rc-report, -rc-report-, -dir_report, -dir_report-. + +From v. 4.74 to 4.74b + For biber, add any dependency on configuration file. + When -time option used, report running times for all rules + diff --git a/Master/texmf-dist/doc/support/latexmk/INSTALL b/Master/texmf-dist/doc/support/latexmk/INSTALL index dacf6919bf4..e4783d9cb8f 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.74b, 29 May 2021) + (Version 4.75, 21 Sep. 2021) John Collins Physics Department @@ -29,11 +29,11 @@ presumably be used on other systems with suitable customization. On all systems, the prequisites are -a. A working installation of Perl. (See http://www.cpan.org/ if you - don't have one. Modern UNIX-like systems, particularly linux and - OS-X, normally have perl installed by default. As for MSWindows, - the TeXLive distribution (2009 or later) includes Perl, and also - includes latexmk.) +a. A working installation of Perl. (See http://www.cpan.org/ if you don't + have one. Modern UNIX-like systems, particularly linux and OS-X, often + have perl installed by default. As for MSWindows, the TeXLive + distribution (2009 or later) includes Perl, and in the default + configuration also includes latexmk.) b. A working installation of TeX and LaTeX. (See http://www.ctan.org/ if you don't have one.) @@ -69,28 +69,27 @@ latexmk installed, the same as for any other missing package. If you are on MS-Windows and you are using TeXLive (2009, or later), this distribution also includes a distribution of Perl sufficient to run latexmk.pl, so you don't need to install Perl separately. It also -includes an executable file latexmk.exe that runs latexmk, so you -don't have to use the latexmk.bat that is part of the latexmk -distribution. +includes an executable file latexmk.exe that runs latexmk. In the case of MiKTeX, the other standard distribution for MS-Windows, the main difference from TeXLive as regards latexmk is that you may need to install a distribution of Perl. A standard default installation of Perl should enable latexmk to work. +BUT, you may need to configure latexmk to -Installing on UNIX/LINUX/OS-X -============================= -(Power users can modify these as appropriate.) +**Manual** installation on UNIX/LINUX/OS-X +========================================== + +(Power users can modify these as appropriate, of course.) NOTE: If you are using TeXLive 2009 or later, you can install latexmk simply by using the TeXLive package manager (that includes users of -MacTeX on OS-X). In fact, depending on how much of TeXLive you have -already installed, latexmk may already have been installed. In that -case you don't normally need to bother with the manual installation -explained below. Still you may need to examine the configuration -instructions. +MacTeX). In fact, depending on how much of TeXLive you have already +installed, latexmk may already have been installed. In that case you don't +normally need to bother with the manual installation explained below. +Still you may need to examine the configuration instructions see item 6. 1. Make sure you have working installations of Perl and TeX/LaTeX. @@ -104,15 +103,15 @@ instructions. 3. Rename this file to latexmk. 4. Make sure latexmk is executable, e.g., by using chmod suitably. - [Special case, which you probably don't have to be concerned - with: You may also find it necessary to change the first line - of the script so that perl can be found to execute latexmk. - Currently the first line is #!/usr/bin/env perl, which uses - the program /usr/bin/env to find perl, provided only that the - perl executable can be found in the PATH for executables. - This insulates latexmk from the fact that the Perl executable - has a system-dependent location. The program /usr/bin/env is - present on almost all modern UNIX/Linux systems.] + [Special case, which you probably don't have to be concerned with: + You **may** also find it necessary to change the first line of the + script so that perl can be found to execute latexmk. Currently the + first line is #!/usr/bin/env perl, which uses the program + /usr/bin/env to find perl, provided only that the perl executable + can be found in the PATH for executables. This insulates latexmk + from the fact that the Perl executable has a system-dependent + location. The program /usr/bin/env is present on almost all modern + UNIX-type systems, including linux and macOS.] 5. (Optional) Copy the file latexmk.1 to an appropriate directory for man pages, e.g., /usr/local/man/man1/. @@ -120,34 +119,47 @@ instructions. Alternatively, or in addition, put the file latexmk.pdf in a suitable place for pdf files for documentation. -6. Check whether the commands used by latexmk for executing latex etc - are correct. The ones you particularly have to worry about are - those for previewing files ($pdf_previewer, $ps_previewer, and - $dvi_previwer), and most importantly $pscmd, and its associated - variable $pid_position --- see below. The command $pscmd is the - least obvious: it runs the command ps and is used in - preview_continuous_mode to determine whether a previewer is - already running. The format of the output of ps is highly system - dependent. Latexmk should get it right under LINUX and OS-X. - If latexmk does not get this or another command correct, put an +6. Check whether the commands used by latexmk for executing latex etc are + correct or need changes. See below for how to do this in a + configuration file, and the documentation for further information. + + The commands you particularly have to worry about are those for + previewing files (set by the variables $pdf_previewer, $ps_previewer, + and $dvi_previwer), and most importantly $pscmd, and its associated + variable $pid_position --- see below. The command $pscmd is the least + obvious: it runs the command ps and is used in preview_continuous_mode + to determine whether a previewer is already running. The format of the + output of ps is highly system dependent. Latexmk should get it right + under LINUX and macOS. + + To know what the current settings are, run + + latexmk --commands + + from the command line. + + If latexmk does not get one of more of these commands correct, put an override in a startup file: a. For a system-wide installation, the correction should be in the - system startup file, which is any one of the files + system startup file, which on a UNIX-like operating system is any + one of + /opt/local/share/latexmk/LatexMk, /usr/local/share/latexmk/LatexMk, /usr/local/lib/latexmk/LatexMk, /opt/local/share/latexmk/latexmkrc, /usr/local/share/latexmk/latexmkrc, /usr/local/lib/latexmk/latexmkrc. + (You get to choose which, but only one. If none of these directories is appropriate you'll need to modify latexmk.pl.) - Those directories apply to Unix-like operating systems - (including linux and OS-X). On MS-Windows, the system - start-up file is one of C:\latexmk\LatexMk - C:\latexmk\latexmkrc (If you happen to use Cygwin, latexmk - combines both the MS-Windows and the Unix possibilities.) + Those directories apply to Unix-like operating systems (including + linux and macOS). On MS-Windows, the system start-up file is one + of C:\latexmk\LatexMk C:\latexmk\latexmkrc (If you happen to use + Cygwin, latexmk combines both the MS-Windows and the Unix + possibilities.) b. If you are installing latexmk as an ordinary user, the startup file is the user startup file, which is the file .latexmkrc in @@ -173,13 +185,9 @@ instructions. for the ps command. Here, $pid_position = 1 indicates that the process ID number is in the first column of the output of the - command ps. See the latexmk.pl file for some more examples. - - To determine what commands latexmk currently uses run the - following: - - latexmk --commands + command ps. + See the latexmk documentation for more details. 7. If you need any modifications on the commands for running previewers, like gv, note that prefixing a command by start, as in @@ -205,13 +213,12 @@ instructions. $postscript_mode = 0; $dvi_mode = 0; - This change is particularly useful for Mac OS-X. See step 6 for - the locations of the initialization/configuration files (under - UNIX-like systems), where you should put this lines. + See step 6 for the locations of the initialization/configuration files + where you should put these lines. -Installing on MS-Windows -======================== +**Manual** Installation on MS-Windows +===================================== (Power users can modify these as appropriate.) @@ -226,70 +233,33 @@ MiKTeX's package manager. But to allow latexmk to work, you will also need to install a distribution of Perl if you haven't done so already. 1. Make sure you have working installations of Perl and TeX/LaTeX, - complete with viewers for dvi and/or postscript files. You will + complete with viewers for dvi, postscript and/or pdf files. You will also need whatever packages your document needs. -2. If necessary, unpack the latexmk distribution. [Note: It is a - good idea to unpack the files so that they have the correct - line-end characters for MS-Windows. For example, if you use unzip - on latexmk.zip, the command unzip -a latexmk.zip should do the - job. If you don't do this conversion, it probably won't matter, - since much software, including Perl, MikTeX and emacs, handles - MS-Windows and UNIX line ends equally well.] +2. If necessary, unpack the latexmk distribution. -3. Copy the files latexmk.pl and latexmk.bat to a suitable directory - (your choice). One possibility is a directory C:\local\bin. You will - need to make sure this directory in the search path for executable - files --- see the next step. +3. **Difference compared with UNIX-type systems**: Copy the file + latexmk.pl to a suitable directory (your choice), and arrange for it to + be invoked as a command. (If you don't know how to do this, find out + about "executable extension for perl on windows", by a web search.) 4. If the directory in the previous step is NOT already in the search path for executable files, arrange for this, by adjusting the - environment variable PATH suitably. Suppose the latexmk directory - is C:\local\bin. (Warning: the exact details of the instructions - below are subject to change as new versions of MS-Windows come out, - so you may need to do some exploration to find the equivalents of - the instructions under other versions; the principles remain - unchanged.) - - a. In Windows XP, there is an item in the Control Panel to adjust - the environment: normally Control Panel -> Performance and - Maintenance -> System. The pick the tab Advanced and click on - Environment Variables. - - (i) If you are a REGULAR user, examine the User variables. If - there is already an entry for PATH, append a semicolon and - then the name of latexmk's directory (e.g., C:\local\bin). - If not, then make a new variable named PATH with the value - %PATH%;C:\local\bin - - (ii) If you are an administrator, examine the System variables, - and adjust the entry to PATH, as above. - - b. OBSOLETE: ONLY in Windows 95, 98 and ME: you will need to add a - line to the end of the C:\AUTOEXEC.BAT file. Suppose the - directory for latexmk is named C:\local\bin, then the line you - add is - - PATH %PATH%;C:\local\bin - - This change will take effect the next time you reboot. - + environment variable PATH suitably. + + In Windows, there is a Control Panel setting for this. (Should be + under Advanced system settings->Environment variables.) + 5. (Optional) Copy documentation file(s) to a suitable directory. The only requirement on the directory is your convenience: some convenient place to look up documentation. The relevant files are latexmk.txt which is a pure ASCII text file, and latexmk.pdf which is a postscript file. -6. Check whether perl is in the search path for executables. (E.g., - from the MS-Windows command-line prompt, try the command perl - --version.) If perl is not in the search path, then modify the - first line of latexmk.bat (which you installed at step 2) by - replacing the command perl by the full path name for perl, e.g., - C:\perl\bin\perl.exe. +6. You may need to reboot, or at least logoff and log back in, if you made + any changes to PATH. -7. You may need to reboot, or at least logoff and log back in, if you - made any changes to the path at step 3. Test out the installation - at the command-line prompt: +7. Test out the installation at the command-line prompt: a. First do @@ -377,7 +347,7 @@ Tricky points characters. There are some tricky problems because of mismatches between character codings as used by different software and operating systems. Latexmk tries to do its best, but problems can - arise. + arise. Often things work without trouble. 4. If you need to remake documentation files, e.g., latexmk.pdf or latexmk.txt, from the man page file latexmk.1, the following diff --git a/Master/texmf-dist/doc/support/latexmk/README b/Master/texmf-dist/doc/support/latexmk/README index 8b0c72f96c3..28d22b3f369 100644 --- a/Master/texmf-dist/doc/support/latexmk/README +++ b/Master/texmf-dist/doc/support/latexmk/README @@ -1,5 +1,5 @@ -Latexmk, version 4.74b, 29 May 2021 ----------------------------------- +Latexmk, version 4.75, 21 Sep 2021 +--------------------------------- Latexmk completely automates the process of generating a LaTeX document. Essentially, it is a highly specialized cousin of the @@ -19,10 +19,10 @@ bibliographies, the current version now supports biber as well as the traditional bibtex. Which of bibtex or biber to use is determined automatically. -Please read the man page (or the corresponding text or postscript -file) for details of what latexmk does and what all the features are. -A copy of the fast help that can be seen by doing "latexmk -h" is at -the end of this file. +Please read the man page (or the corresponding text or postscript file) for +details of what latexmk does and what all the features are. A copy of the +fast help that can be seen by running "latexmk -h" is at the end of this +file. Latexmk is a perl script. It is licensed under the GNU General Public License v. 2. @@ -47,47 +47,24 @@ NOTES:- 1) See the INSTALL file for installation instructions -2) Portability under various UNIX-type systems (including Linux): - A special hack is used at the beginning of the latexmk script to ensure - that it correctly runs without the need to adjust a #! line. All that - is necessary is that the script has execute permission. +2) The main portability/non-portability issues: The various commands to + process LaTeX files may often need to be changed for particular + installations. See the INSTALL file and the documentation for + information on customization. -3) Portability under non-UNIX systems: - Under other operating systems some other arrangement needs to be made - to run the file. For example under MS-Windows, the supplied batch file - latexmk.bat will do this. Under current TeXLive (2009 or later) - distribution, latexmk can be installed by TeXLive's package - manager, in which case an executable program is also installed to - run latexmk.pl, and an appropriate version of Perl is part of the - TeXLive system. +3) Availability: - You may also find it necessary to convert files to the correct - local format for text files. As downloaded, the files are in UNIX - format (line-ending is '\n'). On MS-Windows systems, the - conversion to MSDOS format (with line-ending '\r\n') is normally - UNnecessary, since much current software handles the UNIX format - correctly. (The known current software for which this statement - applies includes MikTeX, TeXLive, emacs.) + a. In the TeXLive and MiKTeX distributions. -4) Portability: The various commands to process LaTeX files made need to - be changed for particular installations. See the INSTALL file and the - documentation for information on customization. + b. On the CTAN tex archive --- see http://www.ctan.org/pkg/latexmk -5) Portability: Users of different UNIX-like systems may have to change - the "$pscmd" variable in their RC file if the -pvc option is to work - perfectly. Refer to $pscmd in the man page. - -6) Latexmk can be downloaded from the author's site at - http://www.personal.psu.edu/jcc8/latexmk/ - This site also includes previous versions, and sometimes newer - versions under development. - -7) Latexmk is archived 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/ + This site also includes previous versions, and sometimes newer versions + under development. John Collins ---------------------------- "latexmk -h" ---------------------------- -Latexmk 4.74b: Automatic LaTeX document generation routine +Latexmk 4.75: Automatic LaTeX document generation routine Usage: latexmk [latexmk_options] [filename ...] diff --git a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/graphviz-latexmkrc b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/graphviz-latexmkrc new file mode 100644 index 00000000000..4710a954ce8 --- /dev/null +++ b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/graphviz-latexmkrc @@ -0,0 +1,11 @@ +# For use of graphviz package. + +# Use internal latexmk variable to find the names of the pdf file(s) +# to be created by dot. +push @file_not_found, 'runsystem\(dot -Tpdf -o ([^ ]+) '; + +add_cus_dep( 'dot', 'pdf', 0, 'dottopdf' ); +sub dottopdf { + system( "dot", "-Tpdf", "-o", "$_[0].pdf", "$_[0].dot" ); +} + diff --git a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/sagetex_latexmkrc b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/sagetex_latexmkrc index a97702a9c70..1b6fc7ed31d 100644 --- a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/sagetex_latexmkrc +++ b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/sagetex_latexmkrc @@ -15,7 +15,8 @@ add_cus_dep( 'sage', 'sout', 0, 'makesout' ); -$hash_calc_ignore_pattern{'sage'} = '^( _st_.goboom|print .SageT)'; +#$hash_calc_ignore_pattern{'sage'} = '^( _st_.goboom|print .SageT)'; +$hash_calc_ignore_pattern{'sage'} = '^( _st_.goboom|print .SageT)|(_st_.current_tex_line|SageTeX paused|SageTeX unpaused)'; sub makesout { system( "sage \"$_[0].sage\"" ); } diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.pdf b/Master/texmf-dist/doc/support/latexmk/latexmk.pdf Binary files differindex 97130d51f8e..5541a10daf5 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 6d747b18617..77a3898d21e 100644 --- a/Master/texmf-dist/doc/support/latexmk/latexmk.txt +++ b/Master/texmf-dist/doc/support/latexmk/latexmk.txt @@ -61,7 +61,7 @@ DESCRIPTION - 29 May 2021 1 + 21 September 2021 1 @@ -127,7 +127,7 @@ LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE - 29 May 2021 2 + 21 September 2021 2 @@ -193,7 +193,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 3 + 21 September 2021 3 @@ -259,7 +259,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 4 + 21 September 2021 4 @@ -290,8 +290,8 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -bibtex-cond1 - The same as -bibtex-cond1 except that .bbl files are only - treated as precious if one or more bibfiles fails to exist. + 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 or biber is run to gen- erate .bbl files as needed, and then it is appropriate to delete @@ -325,7 +325,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 5 + 21 September 2021 5 @@ -391,7 +391,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 6 + 21 September 2021 6 @@ -457,7 +457,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 7 + 21 September 2021 7 @@ -523,7 +523,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 8 + 21 September 2021 8 @@ -589,7 +589,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 9 + 21 September 2021 9 @@ -655,7 +655,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 10 + 21 September 2021 10 @@ -721,7 +721,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 11 + 21 September 2021 11 @@ -787,7 +787,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 12 + 21 September 2021 12 @@ -853,7 +853,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 13 + 21 September 2021 13 @@ -919,7 +919,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 14 + 21 September 2021 14 @@ -985,7 +985,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 15 + 21 September 2021 15 @@ -1051,7 +1051,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 16 + 21 September 2021 16 @@ -1117,7 +1117,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 17 + 21 September 2021 17 @@ -1183,7 +1183,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 18 + 21 September 2021 18 @@ -1249,7 +1249,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 19 + 21 September 2021 19 @@ -1315,7 +1315,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 20 + 21 September 2021 20 @@ -1325,15 +1325,14 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -rc-report- - After initialization, do not give a list of the RC files read. - (Default) + After initialization, do not give a list of the RC files read. -recorder - Give the -recorder option with *latex. In (most) modern ver- - sions of these programs, this 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 + Give the -recorder option with *latex. In (most) modern ver- + sions of these programs, this 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. This is the default setting of latexmk, unless overrid- den in an initialization file. @@ -1350,38 +1349,39 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -rules- - Do not show a list of latexmk's rules and dependencies after + Do not show a list of latexmk's rules and dependencies after processing. (This is the default.) -showextraoptions - Show the list of extra *latex options that latexmk recognizes, - but that it simply passes through to the programs *latex when - they are run. These options are (currently) a combination of - those allowed by the TeXLive and MiKTeX implementations. (If a - particular option is given to latexmk but is not handled by the - particular implementation of *latex that is being used, that - program will probably give a warning or an error.) These op- - tions are very numerous, but are not listed in this documenta- + Show the list of extra *latex options that latexmk recognizes, + but that it simply passes through to the programs *latex when + they are run. These options are (currently) a combination of + those allowed by the TeXLive and MiKTeX implementations. (If a + particular option is given to latexmk but is not handled by the + particular implementation of *latex that is being used, that + program will probably give a warning or an error.) These op- + tions are very numerous, but are not listed in this documenta- tion because they have no effect on latexmk's actions. - There are a few options (e.g., -includedirectory=dir, -initial- - ize, -ini) that are not recognized, either because they don't - fit with latexmk's intended operations, or because they need - special processing by latexmk that isn't implemented (at least, + There are a few options (e.g., -includedirectory=dir, -initial- + ize, -ini) that are not recognized, either because they don't + fit with latexmk's intended operations, or because they need + special processing by latexmk that isn't implemented (at least, not yet). - There are certain options for *latex (e.g., -recorder) that + There are certain options for *latex (e.g., -recorder) that trigger special actions or behavior by latexmk itself. Depending - on the action, they may also be passed in some form to the + on the action, they may also be passed in some form to the called *latex program, and/or may affect other programs as well. - These options do have entries in this documentation. Among + These options do have entries in this documentation. Among these options are: -jobname=STRING, -aux-directory=dir, -output- directory=DIR, -quiet, and -recorder. - 29 May 2021 21 + + 21 September 2021 21 @@ -1390,37 +1390,37 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - There are also options that are accepted by *latex, but instead + There are also options that are accepted by *latex, but instead trigger actions purely by latexmk: -help, -version. -silent Run commands silently, i.e., with options that reduce the amount - of diagnostics generated. For example, with the default set- - tings, the command "latex -interaction=batchmode" is used for + of diagnostics generated. For example, with the default set- + tings, the command "latex -interaction=batchmode" is used for latex, and similarly for its friends. - See also the -logfilewarninglist and -logfilewarninglist- op- + See also the -logfilewarninglist and -logfilewarninglist- op- tions. - Also reduce the number of informational messages that latexmk + Also reduce the number of informational messages that latexmk itself generates. - To change the options used to make the commands run silently, + To change the options used to make the commands run silently, you need to configure latexmk with changed values of its config- - uration variables, the relevant ones being $bib- - tex_silent_switch, $biber_silent_switch, $dvipdf_silent_switch, - $dvips_silent_switch, $latex_silent_switch, $luala- - tex_silent_switch $makeindex_silent_switch, $pdfla- + uration variables, the relevant ones being $bib- + tex_silent_switch, $biber_silent_switch, $dvipdf_silent_switch, + $dvips_silent_switch, $latex_silent_switch, $luala- + tex_silent_switch $makeindex_silent_switch, $pdfla- tex_silent_switch, and $xelatex_silent_switch -stdtexcmds - Sets the commands for latex, etc, so that they are the standard + Sets the commands for latex, etc, so that they are the standard ones. This is useful to override special configurations. - The result is that $latex = 'latex %O %S', and similarly for - $pdflatex, $lualatex, and $xelatex. (The option -no-pdf needed + 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 the definition.) @@ -1429,25 +1429,25 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $show_time. - -time- Do not show CPU time used. See also the configuration variable + -time- Do not show CPU time used. See also the configuration variable $show_time. -use-make - When after a run of *latex, there are warnings about missing - files (e.g., as requested by the LaTeX \input, \include, and - \includgraphics commands), latexmk tries to make them by a cus- - tom dependency. If no relevant custom dependency with an appro- + When after a run of *latex, there are warnings about missing + files (e.g., as requested by the LaTeX \input, \include, and + \includgraphics commands), latexmk tries to make them by a cus- + tom dependency. If no relevant custom dependency with an appro- priate source file is found, and if the -use-make option is set, - then as a last resort latexmk will try to use the make program + then as a last resort latexmk will try to use the make program to try to make the missing files. - Note that the filename may be specified without an extension, - e.g., by \includegraphics{drawing} in a LaTeX file. In that + Note that the filename may be specified without an extension, + e.g., by \includegraphics{drawing} in a LaTeX file. In that - 29 May 2021 22 + 21 September 2021 22 @@ -1456,28 +1456,28 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - case, latexmk will try making drawing.ext with ext set in turn - to the possible extensions that are relevant for latex (or as + case, latexmk will try making drawing.ext with ext set in turn + to the possible extensions that are relevant for latex (or as appropriate pdflatex, lualatex, xelatex). - See also the documentation for the $use_make_for_missing_files + See also the documentation for the $use_make_for_missing_files configuration variable. -use-make- - Do not use the make program to try to make missing files. (De- + Do not use the make program to try to make missing files. (De- fault.) -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 + that is defined by the variable $pre_tex_code or that is set by the option -pretex=CODE to execute the specified TeX code before - the source file is read. This option overrides any previous + the source file is read. This option overrides any previous definition of the command lines. - The result is that $latex = 'latex %O %P', and similarly for - $pdflatex, $lualatex, and $xelatex. (The option -no-pdf needed + The result is that $latex = 'latex %O %P', and similarly for + $pdflatex, $lualatex, and $xelatex. (The option -no-pdf needed for $xelatex is provided automatically, given that %O appears in the definition.) @@ -1499,13 +1499,13 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -view=default, -view=dvi, -view=ps, -view=pdf, -view=none Set the kind of file used when previewing is requested (e.g., by the -pv or -pvc switches). The default is to view the "highest" - kind of requested file (in the low-to-high order .dvi, .ps, + kind of requested file (in the low-to-high order .dvi, .ps, .pdf). - Note the possibility -view=none where no viewer is opened at - all. One example of is use is in conjunction with the -pvc op- - tion, when you want latexmk to do a compilation automatically - whenever source file(s) change, but do not want a previewer to + Note the possibility -view=none where no viewer is opened at + all. One example of is use is in conjunction with the -pvc op- + tion, when you want latexmk to do a compilation automatically + whenever source file(s) change, but do not want a previewer to be opened. @@ -1513,7 +1513,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 23 + 21 September 2021 23 @@ -1523,53 +1523,53 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -Werror - This causes latexmk to return a non-zero status code if any of - the files processed gives a warning about problems with cita- - tions or references (i.e., undefined citations or references or - about multiply defined references). This is after latexmk has - completed all the runs it needs to try and resolve references - and citations. Thus -Werror causes latexmk to treat such warn- + This causes latexmk to return a non-zero status code if any of + the files processed gives a warning about problems with cita- + tions or references (i.e., undefined citations or references or + about multiply defined references). This is after latexmk has + completed all the runs it needs to try and resolve references + and citations. Thus -Werror causes latexmk to treat such warn- ings as errors, but only when they occur on the last run of *la- - tex and only after processing is complete. Also can be set by + tex and only after processing is complete. Also can be set by the configuration variable $warnings_as_errors. -xelatex Use xelatex. That is, use xelatex to process the source file(s) - to pdf. The generation of dvi and postscript files is turned + to pdf. The generation of dvi and postscript files is turned off. This option is equivalent to using the following set of options -pdfxe -dvi- -ps- - [Note: Note that the method of implementation of this option, - but not its intended primary effect, differ from some earlier - versions of latexmk. Latexmk first uses xelatex to make an .xdv - 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 + [Note: Note that the method of implementation of this option, + but not its intended primary effect, differ from some earlier + versions of latexmk. Latexmk first uses xelatex to make an .xdv + 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 -pdfxe for why this is done.] -xelatex="COMMAND" - This sets the string specifying the command to run xelatex. It + This sets the string specifying the command to run xelatex. It sets the variable $xelatex. Warning: It is important to ensure that the -no-pdf is used when - xelatex is invoked, since latexmk expects xelatex to produce an - .xdv file, not a .pdf file. If you provide %O in the command - specification, this will be done automatically. See the docu- - mentation for the -pdfxe option for why latexmk makes a .xdv + xelatex is invoked, since latexmk expects xelatex to produce an + .xdv file, not a .pdf file. If you provide %O in the command + specification, this will be done automatically. See the docu- + mentation for the -pdfxe option for why latexmk makes a .xdv file rather than a .pdf file when xelatex is used. An example of the use of the -pdfxelatex option: - latexmk -pdfxe -pdfxelatex="xelatex --shell-escape %O %S" + latexmk -pdfxe -pdfxelatex="xelatex --shell-escape %O %S" foo.tex - Note: This option when provided with the COMMAND argument only - sets the command for invoking lualatex; it does not turn on the + 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. @@ -1579,7 +1579,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 24 + 21 September 2021 24 @@ -1588,11 +1588,11 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - The preview-continuous option -pvc can only work with one file. So in - this case you will normally only specify one filename on the command + The preview-continuous option -pvc can only work with one file. So in + this case you will normally only specify one filename on the command line. - Options -p, -pv and -pvc are mutually exclusive. So each of these op- + Options -p, -pv and -pvc are mutually exclusive. So each of these op- tions turns the others off. @@ -1620,32 +1620,32 @@ EXAMPLES DEALING WITH ERRORS, PROBLEMS, ETC Some possibilities: - a. If you get a strange error, do look carefully at the output that is - on the screen and in log files. While there is much that is notori- + a. If you get a strange error, do look carefully at the output that is + on the screen and in log files. While there is much that is notori- ously verbose in the output of latex (and that is added to by latexmk), - the verbosity is there for a reason: to enable the user to diagnose - problems. Latexmk does repeat some messages at the end of a run that - it thinks would otherwise be easy to miss in the middle of other out- + the verbosity is there for a reason: to enable the user to diagnose + problems. Latexmk does repeat some messages at the end of a run that + it thinks would otherwise be easy to miss in the middle of other out- put. b. Generally, remember that latexmk does its work by running other pro- grams. Your first priority in dealing with errors should be to examine what went wrong with the individual programs. Then you need to correct - the causes of errors in the runs of these programs. (Often these come - from errors in the source document, but they could also be about miss- + the causes of errors in the runs of these programs. (Often these come + from errors in the source document, but they could also be about miss- ing LaTeX packages, etc.) c. If latexmk doesn't run the programs the way you would like, then you - need to look in this documentation at the list of command line options - and then at the sections on configuration/initialization files. A lot - of latexmk's behavior is configurable to deal with particular situa- + need to look in this documentation at the list of command line options + and then at the sections on configuration/initialization files. A lot + of latexmk's behavior is configurable to deal with particular situa- tions. (But there is a lot of reading!) - The remainder of these notes consists of ideas for dealing with more + The remainder of these notes consists of ideas for dealing with more - 29 May 2021 25 + 21 September 2021 25 @@ -1656,62 +1656,62 @@ LATEXMK(1) General Commands Manual LATEXMK(1) difficult situations. - d. Further tricks can involve replacing the standard commands that la- + d. Further tricks can involve replacing the standard commands that la- texmk runs by other commands or scripts. - e. For possible examples of code for use in an RC file, see the direc- - tory example_rcfiles in the distribution of latexmk (e.g., at + e. For possible examples of code for use in an RC file, see the direc- + tory example_rcfiles in the distribution of latexmk (e.g., at http://mirror.ctan.org/support/latexmk/example_rcfiles). Even if these examples don't do what you want, they may provide suitable inspiration. - 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 - 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 - no files have changed and not rerun lualatex, whereas if you had '\in- - put{bar.baz}' in the LaTeX part of the document, latexmk would notice - the change.) One solution is just to put the following somewhere in + 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 + 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 + no files have changed and not rerun lualatex, whereas if you had '\in- + put{bar.baz}' in the LaTeX part of the document, latexmk would notice + the change.) One solution is just to put the following somewhere in the LaTeX part of the document: \typeout{(bar.baz)} - This puts a line in the log file that latexmk will treat as implying - that the file bar.baz was read. (At present I don't know a way of do- - ing this automatically.) Of course, if the file has a different name, + This puts a line in the log file that latexmk will treat as implying + that the file bar.baz was read. (At present I don't know a way of do- + ing this automatically.) Of course, if the file has a different name, change bar.baz to the name of your file. g. See also the section "Advanced Configuration: Some extra resources". - h. Look on tex.stackexchange, i.e., at http://tex.stackex- - change.com/questions/tagged/latexmk Someone may have already solved + h. Look on tex.stackexchange, i.e., at http://tex.stackex- + change.com/questions/tagged/latexmk Someone may have already solved your problem. i. Ask a question at tex.stackexchange.com. - j. Or ask me (the author of latexmk). My e-mail is at the end of this + j. Or ask me (the author of latexmk). My e-mail is at the end of this documentation. ALLOWING FOR CHANGE OF OUTPUT FILE TYPE When one of the latex engines is run, the usual situation is that latex - produces a .dvi file, while pdflatex and lualatex produce a .pdf file. + produces a .dvi file, while pdflatex and lualatex produce a .pdf file. For xelatex the default is to produce a .pdf file, but to optimize pro- - cessing time latexmk runs xelatex its -no-pdf option so that it pro- - duces an .xdv file. Further processing by latexmk takes this as a + cessing time latexmk runs xelatex its -no-pdf option so that it pro- + duces an .xdv file. Further processing by latexmk takes this as a starting point. However, the actual output file may differ from the normal expectation; - 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 - override the defaults. The other is that there may be a configuration, - or misconfiguration, such that the program that latexmk invokes to + 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 + override the defaults. The other is that there may be a configuration, + or misconfiguration, such that the program that latexmk invokes to - 29 May 2021 26 + 21 September 2021 26 @@ -1720,55 +1720,55 @@ ALLOWING FOR CHANGE OF OUTPUT FILE TYPE LATEXMK(1) General Commands Manual LATEXMK(1) - compile the document is not the expected one, or is given options in- + compile the document is not the expected one, or is given options in- compatible with what latexmk initially expects. - Under latex and pdflatex, control of the output format by the document - is done by setting the \pdfoutput macro. Under lualatex, the \output- + Under latex and pdflatex, control of the output format by the document + is done by setting the \pdfoutput macro. Under lualatex, the \output- mode macro is used instead. One example of an important use-case for document control of the output - format is a document that uses the psfrag package to insert graphical + format is a document that uses the psfrag package to insert graphical elements in the output file. The psfrag package achieves its effects by inserting postscript code in the output of the compilation of the docu- - ment. This entails the use of compilation to a .dvi file, followed by - the use of conversion to a postscript file (either directly, as by - dvips or implicitly, as an intermediate step by dvipdf). Then it is - useful to force output to be of the .dvi format by inserting \pdfout- + ment. This entails the use of compilation to a .dvi file, followed by + the use of conversion to a postscript file (either directly, as by + dvips or implicitly, as an intermediate step by dvipdf). Then it is + useful to force output to be of the .dvi format by inserting \pdfout- put=0 in the preamble of the document. - 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- - lation to .dvi. In this case, it is useful to insert \pdfoutput=1 in - the preamble of the document to force compilation to .pdf output for- + 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- + lation to .dvi. In this case, it is useful to insert \pdfoutput=1 in + the preamble of the document to force compilation to .pdf output for- mat. In all of these cases, it is needed that latexmk has to adjust its pro- - cessing to deal with a mismatch between the actual output format (out - of .pdf, .dvi, .xdv) and the initially expected output, if possible. + cessing to deal with a mismatch between the actual output format (out + of .pdf, .dvi, .xdv) and the initially expected output, if possible. Latexmk does this provided the following conditions are met. The first is that latexmk's $allow_switch configuration variable is set - to a non-zero value as it is by default. If this variable is zero, a + to a non-zero value as it is by default. If this variable is zero, a mismatch of filetypes in the compilation results in an erro. - The second condition for latexmk to be able to handle a change of out- - put type is that no explicit requests for .dvi or .ps output files are - made. Explicit requests are by the -dvi and -ps, -print=dvi, - -print=ps, -view=dvi, and -view=ps options, and by corresponding set- - tings of the $dvi_mode, $postscript_mode, $print_type, and $view con- - figuration variables. The print-type and view-type restrictions only + The second condition for latexmk to be able to handle a change of out- + put type is that no explicit requests for .dvi or .ps output files are + made. Explicit requests are by the -dvi and -ps, -print=dvi, + -print=ps, -view=dvi, and -view=ps options, and by corresponding set- + tings of the $dvi_mode, $postscript_mode, $print_type, and $view con- + figuration variables. The print-type and view-type restrictions only apply when printing and viewing are explicitly requested, respectively. - For this purpose, the use of the -pdfdvi and -pdfps options (and the - corresponding setting of the $pdf_mode variable) does not count as an - explicit request for the .dvi and .ps files; they are merely regarded - as a request for making a .pdf file together with an initial proposal + For this purpose, the use of the -pdfdvi and -pdfps options (and the + corresponding setting of the $pdf_mode variable) does not count as an + explicit request for the .dvi and .ps files; they are merely regarded + as a request for making a .pdf file together with an initial proposal for the processing route to make it. Note that when accommodating a change in output file type, there is in- - volved a substantial change in the network of rules that latexmk uses - in its actions. The second condition applied to accommodate a change + volved a substantial change in the network of rules that latexmk uses + in its actions. The second condition applied to accommodate a change is to avoid situations where the change in the rule network is too rad- ical to be readily handled automatically. @@ -1777,7 +1777,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 27 + 21 September 2021 27 @@ -1787,11 +1787,11 @@ 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 - Files", "Format of Command Specifications", "List of Configuration - Variables Usable in Initialization Files", "Custom Dependencies", and - "Advanced Configuration" give details on what can be configured and + In this section is explained which configuration files are read by la- + texmk. Subsequent sections "How to Set Variables in Initialization + Files", "Format of Command Specifications", "List of Configuration + Variables Usable in Initialization Files", "Custom Dependencies", and + "Advanced Configuration" give details on what can be configured and how. Latexmk can be customized using initialization files, which are read at @@ -1804,7 +1804,7 @@ CONFIGURATION/INITIALIZATION (RC) FILES "/usr/local/share/latexmk/LatexMk", "/usr/local/lib/latexmk/LatexMk". On a MS-Windows system it looks for "C:\latexmk\LatexMk". - On a cygwin system (i.e., a MS-Windows system in which Perl is that + On a cygwin system (i.e., a MS-Windows system in which Perl is that of cygwin), latexmk reads the first it finds of "/cygdrive/c/latexmk/LatexMk", "/opt/local/share/latexmk/LatexMk", @@ -1814,36 +1814,36 @@ CONFIGURATION/INITIALIZATION (RC) FILES In addition, it then tries the same set of locations, but with the file name replaced "LatexMk" replaced by "latexmkrc". - If the environment variable LATEXMKRCSYS is set, its value is used as + If the environment variable LATEXMKRCSYS is set, its value is used as the name of the system RC file, instead of any of the above. 2) The user's RC file, if it exists. This can be in one of two places. - The traditional one is ".latexmkrc" in the user's home directory. The - other possibility is "latexmk/latexmkrc" in the user's XDG configura- - tion home directory. The actual file read is the first of "$XDG_CON- - FIG_HOME/latexmk/latexmkrc" or "$HOME/.latexmkrc" which exists. (See + The traditional one is ".latexmkrc" in the user's home directory. The + other possibility is "latexmk/latexmkrc" in the user's XDG configura- + tion home directory. The actual file read is the first of "$XDG_CON- + FIG_HOME/latexmk/latexmkrc" or "$HOME/.latexmkrc" which exists. (See https://specifications.freedesktop.org/basedir-spec/basedir-spec-lat- est.html for details on the XDG Base Directory Specification.) - Here $HOME is the user's home directory. [Latexmk determines the - user's home directory as follows: It is the value of the environment - variable HOME, if this variable exists, which normally is the case on - UNIX-like systems (including Linux and OS-X). Otherwise the environ- - ment variable USERPROFILE is used, if it exists, which normally is the + Here $HOME is the user's home directory. [Latexmk determines the + user's home directory as follows: It is the value of the environment + variable HOME, if this variable exists, which normally is the case on + UNIX-like systems (including Linux and OS-X). Otherwise the environ- + ment variable USERPROFILE is used, if it exists, which normally is the case on MS-Windows systems. Otherwise a blank string is used instead of $HOME, in which case latexmk does not look for an RC file in it.] - $XDG_CONFIG_HOME is the value of the environment variable XDG_CON- - FIG_HOME if it exists. If this environment variable does not exist, - but $HOME is non-blank, then $XDG_CONFIG_HOME is set to the default - value of $HOME/.config. Otherwise $XDG_CONFIG_HOME is blank, and la- + $XDG_CONFIG_HOME is the value of the environment variable XDG_CON- + FIG_HOME if it exists. If this environment variable does not exist, + but $HOME is non-blank, then $XDG_CONFIG_HOME is set to the default + value of $HOME/.config. Otherwise $XDG_CONFIG_HOME is blank, and la- texmk does not look for an RC file under it. - 29 May 2021 28 + 21 September 2021 28 @@ -1852,35 +1852,35 @@ CONFIGURATION/INITIALIZATION (RC) FILES 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 + 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. 4) Any RC file(s) specified on the command line with the -r option. Each RC file is a sequence of Perl commands. Naturally, a user can use - this in creative ways. But for most purposes, one simply uses a se- + this in creative ways. But for most purposes, one simply uses a se- quence of assignment statements that override some of the built-in set- - tings of Latexmk. Straightforward cases can be handled without knowl- - edge of the Perl language by using the examples in this document as + tings of Latexmk. Straightforward cases can be handled without knowl- + edge of the Perl language by using the examples in this document as templates. Comment lines are introduced by the "#" character. - Note that command line options are obeyed in the order in which they + 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 - option can override previous options but can be itself overridden by - later options on the command line. There is also the -e option, which + 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. For possible examples of code for in an RC file, see the directory ex- - ample_rcfiles in the distribution of latexmk (e.g., at http://mir- + ample_rcfiles in the distribution of latexmk (e.g., at http://mir- ror.ctan.org/support/latexmk/example_rcfiles). HOW TO SET VARIABLES IN INITIALIZATION FILES - The important variables that can be configured are described in the - section "List of configuration variables usable in initialization - files". (See the earlier section "Configuration/Initialization (rc) - Files" for the files where the configurations are done.) Syntax for + The important variables that can be configured are described in the + section "List of configuration variables usable in initialization + files". (See the earlier section "Configuration/Initialization (rc) + Files" for the files where the configurations are done.) Syntax for setting these variables is of the following forms: $bibtex = 'bibtex %O %S'; @@ -1893,23 +1893,23 @@ HOW TO SET VARIABLES IN INITIALIZATION FILES @default_files = ('paper', 'paper1'); - for the setting of an array of strings. It is possible to append an + for the setting of an array of strings. It is possible to append an item to an array variable as follows: push @default_files, 'paper2'; - Note that simple "scalar" variables have names that begin with a $ + Note that simple "scalar" variables have names that begin with a $ character and array variables have names that begin with a @ character. Each statement ends with a semicolon. - Strings should be enclosed in single quotes. (You could use double - 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 + Strings should be enclosed in single quotes. (You could use double + 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 - 29 May 2021 29 + 21 September 2021 29 @@ -1920,33 +1920,33 @@ LATEXMK(1) General Commands Manual LATEXMK(1) these complications.) - You can do much more complicated things, but for this you will need to + You can do much more complicated things, but for this you will need to consult a manual for the Perl programming language. FORMAT OF COMMAND SPECIFICATIONS - Some of the variables set the commands that latexmk uses for carrying - out its work, for example to generate a .dvi file from a .tex file or - to view a postscript file. This section describes some important fea- + Some of the variables set the commands that latexmk uses for carrying + out its work, for example to generate a .dvi file from a .tex file or + to view a postscript file. This section describes some important fea- tures of how the commands are specified. (Note that some of the possi- - bilities listed here do not apply to the $kpsewhich variable; see its + bilities listed here do not apply to the $kpsewhich variable; see its documentation.) 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 + place of the regular latex command, and suppose moreover that you + wanted to give it the option "--shell-escape". You could do this by the following setting: $latex = 'elatex --shell-escape %O %S'; - The two items starting with the % character are placeholders. These - are substituted by appropriate values before the command is run. Thus - %S will be replaced by the source file that elatex will be applied to, - and %O will be replaced by any options that latexmk has decided to use + The two items starting with the % character are placeholders. These + are substituted by appropriate values before the command is run. Thus + %S will be replaced by the source file that elatex will be applied to, + and %O will be replaced by any options that latexmk has decided to use for this command. (E.g., if you used the -silent option in the invoca- - tion of latexmk, it results in the replacement of %O by "-interac- + tion of latexmk, it results in the replacement of %O by "-interac- tion=batchmode".) The available placeholders are: @@ -1955,27 +1955,27 @@ FORMAT OF COMMAND SPECIFICATIONS the setting of a jobname by the -jobname option or the $jobname configuration value. - %B base of filename for current command. E.g., if a postscript - file document.ps is being made from the dvi file document.dvi, + %B base of filename for current command. E.g., if a postscript + file document.ps is being made from the dvi file document.dvi, then the basename is document. - %D destination file (e.g., the name of the postscript file when + %D destination file (e.g., the name of the postscript file when converting a dvi file to postscript). %O options - %P If the variable $pre_tex_code is non-empty, then %P is substi- - tuted by the contents of $pre_tex_code followed by \in- - put{SOURCE}, where SOURCE stands for the name of the source + %P If the variable $pre_tex_code is non-empty, then %P is substi- + tuted by the contents of $pre_tex_code followed by \in- + put{SOURCE}, where SOURCE stands for the name of the source file. Appropriate quoting is done. This enables TeX code to be - passed to one of the *latex engines to be executed before the + passed to one of the *latex engines to be executed before the source file is read. - If the variable $pre_tex_code is the empty string, then %P is + If the variable $pre_tex_code is the empty string, then %P is - 29 May 2021 30 + 21 September 2021 30 @@ -1988,60 +1988,60 @@ LATEXMK(1) General Commands Manual LATEXMK(1) %R root filename. This is the base name for the main tex file. - By default this is the basename of the main tex file. However - the value can be changed by the use of the -jobname option or + By default this is the basename of the main tex file. However + the value can be changed by the use of the -jobname option or the $jobname configuration variable. - %S source file (e.g., the name of the dvi file when converting a + %S source file (e.g., the name of the dvi file when converting a .dvi file to ps). %T The name of the primary tex file. - %U If the variable $pre_tex_code is non-empty, then its value is - substituted for %U (appropriately quoted). Otherwise it is re- + %U If the variable $pre_tex_code is non-empty, then its value is + substituted for %U (appropriately quoted). Otherwise it is re- placed by a null string. %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- able character, with suitable characters being those appropriate - to UNIX and MS-Windows, i.e., ':', '/' and '\'. Note that if - after initialization, $out_dir is set, but $aux_dir is not set - (i.e., it is blank), then latexmk sets $aux_dir to the same + to UNIX and MS-Windows, i.e., ':', '/' and '\'. Note that if + after initialization, $out_dir is set, but $aux_dir is not set + (i.e., it is blank), then latexmk sets $aux_dir to the same value $out_dir. - %Z Name of directory for output files (see the configuration vari- - able $out_dir). A directory separation character ('/') is ap- - pended if $out_dir is non-empty and does not end in a suitable - character, with suitable characters being those appropriate to + %Z Name of directory for output files (see the configuration vari- + able $out_dir). A directory separation character ('/') is ap- + pended if $out_dir is non-empty and does not end in a suitable + character, with suitable characters being those appropriate to UNIX and MS-Windows, i.e., ':', '/' and '\'. - If for some reason you need a literal % character in your string not + If for some reason you need a literal % character in your string not subject to the above rules, use "%%". - Appropriate quoting will be applied to the filename substitutions, so - you mustn't supply them yourself even if the names of your files have + Appropriate quoting will be applied to the filename substitutions, so + you mustn't supply them yourself even if the names of your files have spaces in them. (But if your TeX filenames have spaces in them, beware - that some older versions of the TeX program cannot correctly handle - filenames containing spaces.) In case latexmk's quoting does not work - correctly on your system, you can turn it off -- see the documentation + that some older versions of the TeX program cannot correctly handle + filenames containing spaces.) In case latexmk's quoting does not work + correctly on your system, you can turn it off -- see the documentation for the variable $quote_filenames. - See the default values in the section "List of configuration variables + See the default values in the section "List of configuration variables usable in initialization files" for what is normally the most appropri- ate usage. If you omit to supply any placeholders whatever in the specification of - a command, latexmk will supply what its author thinks are appropriate + a command, latexmk will supply what its author thinks are appropriate defaults. This gives compatibility with configuration files for previ- ous versions of latexmk, which didn't use placeholders. - "Detaching" a command: Normally when latexmk runs a command, it waits + "Detaching" a command: Normally when latexmk runs a command, it waits for the command to run to completion. This is appropriate for commands - 29 May 2021 31 + 21 September 2021 31 @@ -2051,24 +2051,24 @@ 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 - achieve this effect of detaching a command, you need to precede the + 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 + achieve this effect of detaching a command, you need to precede the command name with "start ", as in $dvi_previewer = 'start xdvi %O %S'; - This will be translated to whatever is appropriate for your operating + This will be translated to whatever is appropriate for your operating system. Notes: (1) In some circumstances, latexmk will always run a command de- - tached. This is the case for a previewer in preview continuous mode, - since otherwise previewing continuously makes no sense. (2) This pre- - 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 - complications happen, since cygwin amounts to a complicated merging of - UNIX and MS-Windows. See the source code for how I've handled the + tached. This is the case for a previewer in preview continuous mode, + since otherwise previewing continuously makes no sense. (2) This pre- + 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 + 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. Command names containing spaces: Under MS-Windows it is common that the @@ -2080,26 +2080,26 @@ LATEXMK(1) General Commands Manual LATEXMK(1) %S'; $pdf_previewer = 'start "c:/Program Files/SumatraPDF/Suma- traPDF.exe" %O %S'; - $pdf_previewer = 'start "c:/Program Files/SumatraPDF (x86)/Suma- + $pdf_previewer = 'start "c:/Program Files/SumatraPDF (x86)/Suma- traPDF.exe" %O %S'; - (Note about the above example: Under MS-Windows forward slashes are + (Note about the above example: Under MS-Windows forward slashes are equivalent to backslashes in a filename under almost all circumstances, - provided that the filename is inside double quotes. It is easier to + provided that the filename is inside double quotes. It is easier to use forward slashes in examples like the one above, since then one does - not have to worry about the rules for dealing with forward slashes in + not have to worry about the rules for dealing with forward slashes in strings in the Perl language.) - Command names under Cygwin: If latexmk is executed by Cygwin's Perl, + Command names under Cygwin: If latexmk is executed by Cygwin's Perl, be particularly certain that pathnames in commands have forward slashes - not the usual backslashes for the separator of pathname components. - See the above examples. Backslashes often get misinterpreted by the + not the usual backslashes for the separator of pathname components. + See the above examples. Backslashes often get misinterpreted by the Unix shell used by Cygwin's Perl to execute external commands. Forward slashes don't suffer from this problem, and (when quoted, as above) are equally acceptable to MS-Windows. - Using MS-Windows file associations: A useful trick under modern ver- + Using MS-Windows file associations: A useful trick under modern ver- sions of MS-Windows (e.g., WinXP) is to use just the command 'start' by itself: @@ -2107,7 +2107,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 32 + 21 September 2021 32 @@ -2117,9 +2117,9 @@ 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 + 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- - able for the pdf previwer, if your system has acroread for the default + able for the pdf previwer, if your system has acroread for the default pdf viewer. As explained elsewhere, acroread under MS-Windows does not work well with latex and latexmk, because acroread locks the pdf file. @@ -2128,18 +2128,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $lpr = 'NONE lpr'; - This typically is used when an appropriate command does not exist on + This typically is used when an appropriate command does not exist on 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 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 + command. Suppose you want latexmk to use latex with source specials + enabled. Then you might use the following line in an initialization file: $latex = 'latex --src-specials %O %S'; - Running a subroutine instead of an external command: Use a specifica- + Running a subroutine instead of an external command: Use a specifica- tion starting with "internal", as in $latex = 'internal mylatex %O %S'; @@ -2149,31 +2149,31 @@ LATEXMK(1) General Commands Manual LATEXMK(1) return system 'latex', @args; } - For some of the more exotic possibilities that then become available, - see the section "ADVANCED CONFIGURATION: Some extra resources and ad- - vanced tricks". Also see some of the examples in the directory exam- + For some of the more exotic possibilities that then become available, + see the section "ADVANCED CONFIGURATION: Some extra resources and ad- + vanced tricks". Also see some of the examples in the directory exam- ple_rcfiles in the latexmk distribution. - Advanced tricks: Normally one specifies a single command for the com- - mands invoked by latexmk. Naturally, if there is some complicated ad- - ditional processing you need to do in your special situation, you can + Advanced tricks: Normally one specifies a single command for the com- + mands invoked by latexmk. Naturally, if there is some complicated ad- + ditional processing you need to do in your special situation, you can write a script (or batch file) to do the processing, and then configure latexmk to use your script in place of the standard program. - You can also use a Perl subroutine instead of a script -- see above. + You can also use a Perl subroutine instead of a script -- see above. This is generally the most flexible and portable solution. It is also possible to configure latexmk to run multiple commands. For - example, if when running pdflatex to generate a pdf file from a tex + example, if when running pdflatex to generate a pdf file from a tex file you need to run another program after pdflatex to perform some ex- tra processing, you could do something like: - $pdflatex = 'pdflatex --shell-escape %O %S; pst2pdf_for_latexmk + $pdflatex = 'pdflatex --shell-escape %O %S; pst2pdf_for_latexmk %B'; - 29 May 2021 33 + 21 September 2021 33 @@ -2182,8 +2182,8 @@ LATEXMK(1) General Commands Manual LATEXMK(1) 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- + 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. If you are using MS-Windows, you would replace the above line by @@ -2191,36 +2191,36 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $pdflatex = 'cmd /c pdflatex --shell-escape %O %S' . '&& pst2pdf_for_latexmk %B'; - Here, the UNIX command separator ; is replaced by &&. In addition, + Here, the UNIX command separator ; is replaced by &&. In addition, there is a problem that some versions of Perl on MS-Windows do not obey - the command separator; this problem is overcome by explicitly invoking + the command separator; this problem is overcome by explicitly invoking the MS-Windows command-line processor cmd.exe. 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- - tion/Initialization (rc) Files" for the files where the configurations + In this section are specified the variables whose values can be ad- + justed to configure latexmk. (See the earlier section "Configura- + tion/Initialization (rc) Files" for the files where the configurations are done.) Default values are indicated in brackets. Note that for variables that - are boolean in character, concerning whether latexmk does or does not - behave in a certain way, a non-zero value, normally 1, indicates true, - i.e., the behavior occurs, while a zero value indicates a false value, + are boolean in character, concerning whether latexmk does or does not + behave in a certain way, a non-zero value, normally 1, indicates true, + i.e., the behavior occurs, while a zero value indicates a false value, i.e., the behavior does not occur. $allow_switch [1] - This controls what happens when the output extension of latex, - pdflatex, lualatex or xelatex differs from what is expected. + This controls what happens when the output extension of latex, + pdflatex, lualatex or xelatex differs from what is expected. (The possible extensions are .dvi, .pdf, .xdv.) This can happen - with the use of the \pdfoutput macro in a document compiled un- - der latex or pdflatex, or with the use of the \outputmode macro + with the use of the \pdfoutput macro in a document compiled un- + der latex or pdflatex, or with the use of the \outputmode macro under lualatex. It can also happen with certain kinds of incor- rect configuration. - In such a case, latexmk can appropriately adjust its network of + In such a case, latexmk can appropriately adjust its network of rules. The adjustment is made if $allow_switch is on, and if no request for a dvi or ps file has been made. @@ -2228,18 +2228,18 @@ LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES $always_view_file_via_temporary [0] - Whether .ps and .pdf files are initially to be made in a tempo- - rary directory and then moved to the final location. (This ap- + Whether .ps and .pdf files are initially to be made in a tempo- + rary directory and then moved to the final location. (This ap- plies to dvips, dvipdf, and ps2pdf operations, and the filtering operators on .dvi and .ps files. It does not apply to pdflatex, - unfortunately, since pdflatex provides no way of specifying a + unfortunately, since pdflatex provides no way of specifying a chosen name for the output file.) This use of a temporary file solves a problem that the making of - 29 May 2021 34 + 21 September 2021 34 @@ -2254,58 +2254,58 @@ LATEXMK(1) General Commands Manual LATEXMK(1) which can cause havoc. See the $pvc_view_file_via_temporary variable for a setting that - applies only if preview-continuous mode (-pvc option) is used. + applies only if preview-continuous mode (-pvc option) is used. See $tmpdir for the setting of the directory where the temporary file is created. $analyze_input_log_always [1] - After a run of latex (etc), always analyze .log for input files - in the <...> and (...) constructions. Otherwise, only do the + After a run of latex (etc), always analyze .log for input files + in the <...> and (...) constructions. Otherwise, only do the analysis when fls file doesn't exist or is out of date. - Under normal circumstances, the data in the fls file is reli- + Under normal circumstances, the data in the fls file is reli- able, and the test of the log file gets lots of false positives; - usually $analyze_input_log_always is best set to zero. But the - test of the log file is needed at least in the following situa- - tion: When a user needs to persuade latexmk that a certain file - is a source file, and latexmk doesn't otherwise find it. Then - the user can write code that causes a line with (...) to be - written to log file. One important case is for lualatex, which - doesn't always generate lines in the .fls file for input lua - files. (The situation with lualatex is HIGHLY version depen- - dent, e.g., there was a big change between TeXLive 2016 and + usually $analyze_input_log_always is best set to zero. But the + test of the log file is needed at least in the following situa- + tion: When a user needs to persuade latexmk that a certain file + is a source file, and latexmk doesn't otherwise find it. Then + the user can write code that causes a line with (...) to be + written to log file. One important case is for lualatex, which + doesn't always generate lines in the .fls file for input lua + files. (The situation with lualatex is HIGHLY version depen- + dent, e.g., there was a big change between TeXLive 2016 and TeXLive 2017.) - To keep backward compatibility with older versions of latexmk, + To keep backward compatibility with older versions of latexmk, the default is to set $analyze_input_log_always to 1. $auto_rc_use [1] - Whether to automatically read the standard initialization (rc) + Whether to automatically read the standard initialization (rc) files, which are the system RC file, the user's RC file, and the RC file in the current directory. The command line option -norc - can be used to turn this setting off. Each RC file could also - turn this setting off, i.e., it could set $auto_rc_use to zero + can be used to turn this setting off. Each RC file could also + turn this setting off, i.e., it could set $auto_rc_use to zero to prevent automatic reading of the later RC files. - This variable does not affect the reading of RC files specified + This variable does not affect the reading of RC files specified on the command line by the -r option. $aux_dir [""] The directory in which auxiliary files (aux, log, etc) are to be - written by a run of *latex. If this variable is not set, but - $out_dir is set, then $aux_dir is set to $out_dir, which is the + written by a run of *latex. If this variable is not set, but + $out_dir is set, then $aux_dir is set to $out_dir, which is the directory to which general output files are to be written. - Important note: The effect of $aux_dir, if different from + Important note: The effect of $aux_dir, if different from $out_dir, is achieved by giving *latex the -aux-directory. Cur- - rently (Dec. 2011 and later) this only works on the MiKTeX + rently (Dec. 2011 and later) this only works on the MiKTeX - 29 May 2021 35 + 21 September 2021 35 @@ -2319,33 +2319,33 @@ LATEXMK(1) General Commands Manual LATEXMK(1) See also the documentation of $out_dir for some complications on what directory names are suitable. - If you also use the -cd option, and $out_dir (or $aux_dir) con- - tains a relative path, then the path is interpreted relative to + If you also use the -cd option, and $out_dir (or $aux_dir) con- + tains a relative path, then the path is interpreted relative to the document directory. $aux_out_dir_report [0] - For each .tex file processed, list the settings for aux and out - directories, after they have been normalized from the settings + For each .tex file processed, list the settings for aux and out + directories, after they have been normalized from the settings specified during initialization. This report gives a reminder of where to look for output. - The report has to be done per file, because of possible direc- - tory changes for each file. In the simplest cases, the result - is the same as originally specified. In general, e.g., with an - absolute directory specified, the normalization helps perfor- - mance and cleans up output to the screen. It also avoids situa- - tions where a file in the current directory is refered to by + The report has to be done per file, because of possible direc- + tory changes for each file. In the simplest cases, the result + is the same as originally specified. In general, e.g., with an + absolute directory specified, the normalization helps perfor- + mance and cleans up output to the screen. It also avoids situa- + tions where a file in the current directory is refered to by different names, e.g., "file.aux" and "./file.aux", which can be annoying. $banner [0] - If nonzero, the banner message is printed across each page when - converting the dvi file to postscript. Without modifying the - variable $banner_message, this is equivalent to specifying the + If nonzero, the banner message is printed across each page when + converting the dvi file to postscript. Without modifying the + variable $banner_message, this is equivalent to specifying the -d option. Note that if $banner is nonzero, the $postscript_mode is assumed @@ -2354,7 +2354,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $banner_intensity [0.95] Equivalent to the -bi option, this is a decimal number between 0 - and 1 that specifies how dark to print the banner message. 0 is + and 1 that specifies how dark to print the banner message. 0 is black, 1 is white. The default is just right if your toner car- tridge isn't running too low. @@ -2363,15 +2363,15 @@ LATEXMK(1) General Commands Manual LATEXMK(1) dvi file to postscript. This is equivalent to the -bm option. $banner_scale [220.0] - 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 just right for 5 character messages. + 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 just right for 5 character messages. - 29 May 2021 36 + 21 September 2021 36 @@ -2383,11 +2383,11 @@ LATEXMK(1) General Commands Manual LATEXMK(1) This is equivalent to the -bs option. @BIBINPUTS - This is an array variable, now mostly obsolete, that specifies - directories where latexmk should look for .bib files. By de- - fault it is set from the BIBINPUTS environment variable of the - operating system. If that environment variable is not set, a - single element list consisting of the current directory is set. + This is an array variable, now mostly obsolete, that specifies + directories where latexmk should look for .bib files. By de- + fault it is set from the BIBINPUTS environment variable of the + operating system. If that environment variable is not set, a + single element list consisting of the current directory is set. The format of the directory names depends on your operating sys- tem, of course. Examples for setting this variable are: @@ -2397,47 +2397,47 @@ LATEXMK(1) General Commands Manual LATEXMK(1) @BIBINPUTS = ( ".", "//server/bibfiles" ); @BIBINPUTS = ( ".", "/usr/local/texmf/bibtex/bib" ); - Note that under MS Windows, either a forward slash "/" or a - backward slash "\" can be used to separate pathname components, - so the first two and the second two examples are equivalent. - Each backward slash should be doubled to avoid running afoul of + Note that under MS Windows, either a forward slash "/" or a + backward slash "\" can be used to separate pathname components, + so the first two and the second two examples are equivalent. + Each backward slash should be doubled to avoid running afoul of Perl's rules for writing strings. Important note: This variable is now mostly obsolete in the cur- rent version of latexmk, since it has a better method of search- - ing for files using the kpsewhich command. However, if your - system is an unusual one without the kpsewhich command, you may + ing for files using the kpsewhich command. However, if your + system is an unusual one without the kpsewhich command, you may need to set the variable @BIBINPUTS. $biber ["biber %O %S"] The biber processing program. $biber_silent_switch ["--onlylog"] - Switch(es) for the biber processing program when silent mode is + Switch(es) for the biber processing program when silent mode is on. $bibtex ["bibtex %O %S"] The BibTeX processing program. $bibtex_fudge [1] - When using bibtex, whether to change directory to $aux_dir be- + When using bibtex, whether to change directory to $aux_dir be- fore running bibtex. The need arises as follows: - a. With bibtex before about 2019, if the filename given to it + a. With bibtex before about 2019, if the filename given to it contains a path component, there was a bug that bibtex would not - find extra aux files, as produced by the \include command in + find extra aux files, as produced by the \include command in TeX. - b. With all moderately recent versions of bibtex, bibtex may + 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. - 29 May 2021 37 + 21 September 2021 37 @@ -2446,8 +2446,8 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - However, there are also rare cases where the change-directory - method prevents bibtex from finding certain bib or bst files. + However, there are also rare cases where the change-directory + method prevents bibtex from finding certain bib or bst files. Then $bibtex_fudge needs to be set to 0. @@ -2457,53 +2457,53 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $bibtex_use [1] Under what conditions to run bibtex or biber. When latexmk dis- - covers from the log file that one (or more) bibtex/biber-gener- - ated bibliographies are used, it can run bibtex or biber when- - ever it appears necessary to regenerate the bbl file(s) from - their source bib database file(s). But sometimes, the bib + covers from the log file that one (or more) bibtex/biber-gener- + ated bibliographies are used, it can run bibtex or biber when- + ever it appears necessary to regenerate the bbl file(s) from + their source bib database file(s). But sometimes, the bib file(s) are not available (e.g., for a document obtained from an external archive), but the bbl files are provided. In that case - use of bibtex or biber will result in incorrect overwriting of - the precious bbl files. The variable $bibtex_use controls - whether this happens, and also controls whether or not .bbl + use of bibtex or biber will result in incorrect overwriting of + the precious bbl files. The variable $bibtex_use controls + whether this happens, and also controls whether or not .bbl files are deleted in a cleanup operation. The possible values of $bibtex_use are: - 0: never use BibTeX or biber; never delete .bbl files in a + 0: never use BibTeX or biber; never delete .bbl files in a cleanup. - 1: only use bibtex or biber if the bib files exist; never + 1: only use bibtex or biber if the bib files exist; never delete .bbl files in a cleanup. - 1.5: only use bibtex or biber if the bib files exist; condi- - tionally delete .bbl files in a cleanup (i.e., delete them only + 1.5: only use bibtex or biber if the bib files exist; condi- + tionally 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 files, without testing for the existence of the bib + the bbl files, without testing for the existence of the bib files; always delete .bbl files in a cleanup. - Note that the value 1.5 does not work properly if the document + Note that the value 1.5 does not work properly if the document uses biber instead of bibtex. (There's a long story why not.) $cleanup_includes_cusdep_generated [0] - If nonzero, specifies that cleanup also deletes files that are + If nonzero, specifies that cleanup also deletes files that are generated by custom dependencies. (When doing a clean up, e.g., by use of the -C option, custom dependencies are those listed in the .fdb_latexmk file from a previous run.) $cleanup_includes_generated [0] - If nonzero, specifies that cleanup also deletes files that are + If nonzero, specifies that cleanup also deletes files that are detected in the fls file (or failing that, in log file) as being - generated. It will also include files made from these first + generated. It will also include files made from these first generation generated files. - This operation is somewhat dangerous, and can have unintended - consequences, since the files to be deleted are determined from - a file created by *latex, which can contain erroneous informa- + This operation is somewhat dangerous, and can have unintended + 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 - 29 May 2021 38 + 21 September 2021 38 @@ -2512,26 +2512,26 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - files to be deleted are restricted to those explictly specified - by patterns configured in the variables clean_ext, - clean_full_ext, and @generated_exts, together with those very - standard cases that are hardwired into latexmk (e.g., .log + files to be deleted are restricted to those explictly specified + by patterns configured in the variables clean_ext, + clean_full_ext, and @generated_exts, together with those very + standard cases that are hardwired into latexmk (e.g., .log files). $cleanup_mode [0] - If nonzero, specifies cleanup mode: 1 for full cleanup, 2 for - cleanup except for .dvi, .ps and .pdf files, 3 for cleanup ex- - cept for dep and aux files. (There is also extra cleaning as + If nonzero, specifies cleanup mode: 1 for full cleanup, 2 for + cleanup except for .dvi, .ps and .pdf files, 3 for cleanup ex- + cept for dep and aux files. (There is also extra cleaning as specified by the $clean_ext, $clean_full_ext and @generated_exts variables.) - This variable is equivalent to specifying one of the -c or -C - options. But there should be no need to set this variable from + This variable is equivalent to specifying one of the -c or -C + options. But there should be no need to set this variable from an RC file. $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 + Extra extensions of files for latexmk to remove when any of the + clean-up options (-c or -C) is selected. The value of this variable is a string containing the extensions separated by spa- ces. @@ -2543,23 +2543,23 @@ LATEXMK(1) General Commands Manual LATEXMK(1) files-%R/*"; in an initialization file will imply that when a clean-up opera- - tion is specified, not only is the standard set of files - deleted, but also files of the form FOO.out, FOO-blx.bib, FOO- - figures*.log, and pythontex-files-FOO/*, where FOO stands for + tion is specified, not only is the standard set of files + deleted, but also files of the form FOO.out, FOO-blx.bib, FOO- + figures*.log, and pythontex-files-FOO/*, where FOO stands for the basename of the file being processed (as in FOO.tex). - The files to be deleted are relative to the directory specified - by $aux_dir. (Note that if $out_dir but not $aux_dir is set, - then in its initialization, latexmk sets $aux_dir equal to - $out_dir. A normal situation is therefore that $aux_dir equals - $out_dir, which is the only case supported by TeXLive, unlike + The files to be deleted are relative to the directory specified + by $aux_dir. (Note that if $out_dir but not $aux_dir is set, + then in its initialization, latexmk sets $aux_dir equal to + $out_dir. A normal situation is therefore that $aux_dir equals + $out_dir, which is the only case supported by TeXLive, unlike MiKTeX.) - The filenames specfied for a clean-up operation can refer not - only to regular files but also to directories. Directories are + The filenames specfied 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 - to pythontex, which creates files in a particular directory. - You can arrange to remove both the files and the directory by + to pythontex, which creates files in a particular directory. + You can arrange to remove both the files and the directory by setting $clean_ext = "pythontex-files-%R pythontex-files-%R"; @@ -2569,7 +2569,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 39 + 21 September 2021 39 @@ -2579,63 +2579,63 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $clean_full_ext [""] - Extra extensions of files for latexmk to remove when the -C op- - tion is selected, i.e., extensions of files to remove when the + Extra extensions of files for latexmk to remove when the -C op- + tion is selected, i.e., extensions of files to remove when the .dvi, etc files are to be cleaned-up. More general patterns are allowed, as for $clean_ext. - The files specified by $clean_full_ext to be deleted are rela- + The files specified by $clean_full_ext to be deleted are rela- tive to the directory specified by $out_dir. $compiling_cmd [""], $failure_cmd [""], $warning_cmd [""], $success_cmd [""] - These variables specify commands that are executed at certain - points of compilations. One motivation for their existance is - to allow very useful convenient visual indications of compila- - tion status even when the window receiving the screen output of - the compilation is hidden. This is particularly useful in pre- + These variables specify commands that are executed at certain + points of compilations. One motivation for their existance is + to allow very useful convenient visual indications of compila- + tion status even when the window receiving the screen output of + the compilation is hidden. This is particularly useful in pre- view-continuous mode. - The commands are executed at the following points: $compil- - ing_cmd at the start of compilation, $success_cmd at the end of - a completely successful compilation, $failure_cmd at the end of + The commands are executed at the following points: $compil- + ing_cmd at the start of compilation, $success_cmd at the end of + a completely successful compilation, $failure_cmd at the end of an unsuccessful compilation, $warning_cmd at the of an otherwise successful compilation that gives warnings about undefined cita- tions or references or about multiply defined references. If any - of above variables is undefined or blank (the default situa- + of above variables is undefined or blank (the default situa- tion), then the corresponding command is not executed. - However, when $warning_cmd is not set, then in the case of a - compilation with warnings about references or citations, but - with no other error, one or other of $success_cmd or $fail- - ure_cmd is used (if it is set) according to the setting of + However, when $warning_cmd is not set, then in the case of a + compilation with warnings about references or citations, but + with no other error, one or other of $success_cmd or $fail- + ure_cmd is used (if it is set) according to the setting of $warnings_as_errors. An example of a simple setting of these variables is as follows - $compiling_cmd = "xdotool search --name \"%D\" set_window + $compiling_cmd = "xdotool search --name \"%D\" set_window --name \"%D compiling\""; - $success_cmd = "xdotool search --name \"%D\" set_window + $success_cmd = "xdotool search --name \"%D\" set_window --name \"%D OK\""; $warning_cmd = "xdotool search --name \"%D\" ". "set_window --name \"%D CITE/REF ISSUE\""; - $failure_cmd = "xdotool search --name \"%D\" set_window + $failure_cmd = "xdotool search --name \"%D\" set_window --name \"%D FAILURE\""; - These assume that the program xdotool is installed, that the - previewer is using an X-Window system for display, and that the - title of the window contains the name of the displayed file, as - it normally does. When the commands are executed, the place- - holder string %D is replaced by the name of the destination + These assume that the program xdotool is installed, that the + previewer is using an X-Window system for display, and that the + title of the window contains the name of the displayed file, as + it normally does. When the commands are executed, the place- + holder string %D is replaced by the name of the destination file, which is the previewed file. The above commands result in - an appropriate string being appended to the filename in the + an appropriate string being appended to the filename in the - 29 May 2021 40 + 21 September 2021 40 @@ -2646,21 +2646,21 @@ LATEXMK(1) General Commands Manual LATEXMK(1) window title: " compiling", " OK", or " FAILURE". - 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 + 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. - More complicated situations can best be handled by defining a - Perl subroutine to invoke the necessary commands, and using the - "internal" keyword in the definitions to get the subroutine to + More complicated situations can best be handled by defining a + Perl subroutine to invoke the necessary commands, and using the + "internal" keyword in the definitions to get the subroutine to be invoked. (See the section "Format of Command Specifications" for how to do this.) - Naturally, the above settings that invoke the xdotool program - are only applicable when the X-Window system is used for the + Naturally, the above settings that invoke the xdotool program + are only applicable when the X-Window system is used for the relevant window(s). For other cases, you will have to find what software solutions are available. @@ -2669,15 +2669,15 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Custom dependency list -- see section on "Custom Dependencies". @default_excluded_files [()] - When latexmk is invoked with no files specified on the command + When latexmk is invoked with no files specified on the command line, then, by default, it will process all files in the current directory with the extension .tex. (In general, it will process the files specified in the @default_files variable.) But sometimes you want to exclude particular files from this de- - fault list. In that case you can specify the excluded files in + fault list. In that case you can specify the excluded files in the array @default_excluded_files. For example if you wanted to - process all .tex files with the exception of common.tex, which + process all .tex files with the exception of common.tex, which is a not a standard alone LaTeX file but a file input by some or all of the others, you could do @@ -2687,21 +2687,21 @@ LATEXMK(1) General Commands Manual LATEXMK(1) If you have a variable or large number of files to be processed, this method saves you from having to list them in detail in @de- - fault_files and having to update the list every time you change + fault_files and having to update the list every time you change the set of files to be processed. - Notes: 1. This variable has no effect except when no files are + Notes: 1. This variable has no effect except when no files are specified on the latexmk command line. 2. Wildcards are allowed in @default_excluded_files. @default_files [("*.tex")] Default list of files to be processed. - If no filenames are specified on the command line, latexmk + If no filenames are specified on the command line, latexmk - 29 May 2021 41 + 21 September 2021 41 @@ -2710,15 +2710,15 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - processes all tex files specified in the @default_files vari- - able, which by default is set to all tex files ("*.tex") in the - current directory. This is a convenience: just run latexmk and - it will process an appropriate set of files. But sometimes you + processes all tex files specified in the @default_files vari- + able, which by default is set to all tex files ("*.tex") in the + current 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 - 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 - line then the files you specify by setting @default_files are + 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 + line then the files you specify by setting @default_files are processed. Three examples: @@ -2729,45 +2729,45 @@ LATEXMK(1) General Commands Manual LATEXMK(1) @default_files = ("*.tex", "*.dtx"); - Note that more than file may be given, and that the default ex- + Note that more than file may be given, and that the default ex- tension is ".tex". Wild cards are allowed. The parentheses are because @default_files is an array variable, i.e., a sequence of filename specifications is possible. - If you want latexmk to process all .tex files with a few excep- + If you want latexmk to process all .tex files with a few excep- tions, see the @default_excluded_files array variable. $dependents_phony [0] - If a list of dependencies is output, this variable determines - whether to include a phony target for each source file. If you - use the dependents list in a Makefile, the dummy rules work - around errors make gives if you remove header files without up- + If a list of dependencies is output, this variable determines + whether to include a phony target for each source file. If you + use the dependents list in a Makefile, the dummy rules work + around errors make gives if you remove header files without up- dating the Makefile to match. $dependents_list [0] - Whether to display a list(s) of dependencies at the end of a + Whether to display a list(s) of dependencies at the end of a run. $deps_file ["-"] - Name of file to receive list(s) of dependencies at the end of a - run, to be used if $dependesnt_list is set. If the filename is - "-", then the dependency list is set to stdout (i.e., normally + Name of file to receive list(s) of dependencies at the end of a + run, to be used if $dependesnt_list is set. If the filename is + "-", then the dependency list is set to stdout (i.e., normally the screen). $do_cd [0] - Whether to change working directory to the directory specified - for the main source file before processing it. The default be- - havior is not to do this, which is the same as the behavior of - *latex programs. This variable is set by the -cd and -cd- op- + Whether to change working directory to the directory specified + for the main source file before processing it. The default be- + havior is not to do this, which is the same as the behavior of + *latex programs. This variable is set by the -cd and -cd- op- tions on latexmk's command line. $dvi_filter [empty] - The dvi file filter to be run on the newly produced dvi file + The dvi file filter to be run on the newly produced dvi file - 29 May 2021 42 + 21 September 2021 42 @@ -2776,64 +2776,64 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - before other processing. Equivalent to specifying the -dF op- + before other processing. Equivalent to specifying the -dF op- tion. $dvi_mode [See below for default] - If nonzero, generate a dvi version of the document. Equivalent + If nonzero, generate a dvi version of the document. Equivalent to the -dvi option. - The variable $dvi_mode defaults to 0, but if no explicit re- - quests are made for other types of file (postscript, pdf), then - $dvi_mode will be set to 1. In addition, if a request for a - file for which a .dvi file is a prerequisite, then $dvi_mode + The variable $dvi_mode defaults to 0, but if no explicit re- + quests are made for other types of file (postscript, pdf), then + $dvi_mode will be set to 1. In addition, if a request for a + file for which a .dvi file is a prerequisite, then $dvi_mode will be set to 1. $dvi_previewer ["start xdvi %O %S" under UNIX] - The command to invoke a dvi-previewer. [Under MS-Windows the - default is "start"; then latexmk arranges to use the MS-Windows - start program, which will cause to be run whatever command the + The command to invoke a dvi-previewer. [Under MS-Windows the + 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.] - 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. $dvi_previewer_landscape ["start xdvi %O %S"] The command to invoke a dvi-previewer in landscape mode. [Under - MS-Windows the default is "start"; then latexmk arranges to use - the MS-Windows start program, which will cause to be run what- + MS-Windows the default is "start"; then latexmk arranges to use + the MS-Windows start program, which will cause to be run what- ever command the system has associated with .dvi files.] $dvipdf ["dvipdf -dALLOWPSTRANSPARENCY %O %S %D"] - Command to convert .dvi to .pdf file. A common reconfiguration - is to use the dvipdfm command, which needs its arguments in a + Command to convert .dvi to .pdf file. A common reconfiguration + is to use the dvipdfm command, which needs its arguments in a different order: $dvipdf = "dvipdfm %O -o %D %S"; - WARNING: The default dvipdf script generates pdf files with + WARNING: The default dvipdf script generates pdf files with bitmapped fonts, which do not look good when viewed by acroread. - That script should be modified to give dvips the options "-P + That script should be modified to give dvips the options "-P pdf" to ensure that type 1 fonts are used in the pdf file. $dvipdf_silent_switch ["-q"] Switch(es) for dvipdf program when silent mode is on. - 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 - switch has an effect. The default setting is correct for + 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 + switch has an effect. The default setting is correct for - 29 May 2021 43 + 21 September 2021 43 @@ -2845,61 +2845,61 @@ LATEXMK(1) General Commands Manual LATEXMK(1) dvipdfm and dvipdfmx. $dvips ["dvips %O -o %D %S"] - The program to used as a filter to convert a .dvi file to a .ps - file. If pdf is going to be generated from pdf, then the value - of the $dvips_pdf_switch variable -- see below -- will be in- + The program to used as a filter to convert a .dvi file to a .ps + file. If pdf is going to be generated from pdf, then the value + of the $dvips_pdf_switch variable -- see below -- will be in- cluded in the options substituted for "%O". $dvips_landscape ["dvips -tlandscape %O -o %D %S"] - The program to used as a filter to convert a .dvi file to a .ps + The program to used as a filter to convert a .dvi file to a .ps file in landscape mode. $dvips_pdf_switch ["-P pdf"] - Switch(es) for dvips program when pdf file is to be generated + Switch(es) for dvips program when pdf file is to be generated from .ps file. $dvips_silent_switch ["-q"] Switch(es) for dvips program when silent mode is on. $dvi_update_command [""] - When the dvi previewer is set to be updated by running a com- - mand, this is the command that is run. See the information for + When the dvi previewer is set to be updated by running a com- + mand, this is the command that is run. See the information for the variable $dvi_update_method for further information, and see - information on the variable $pdf_update_method for an example + information on the variable $pdf_update_method for an example for the analogous case of a pdf previewer. $dvi_update_method [2 under UNIX, 1 under MS-Windows] - How the dvi viewer updates its display when the dvi file has - changed. The values here apply equally to the $pdf_up- + How the dvi viewer updates its display when the dvi file has + changed. The values here apply equally to the $pdf_up- date_method and to the $ps_update_method variables. 0 => update is automatic, 1=> manual update by user, which may only mean a mouse click on the viewer's window or may mean a more serious action. - 2 => Send the signal, whose number is in the variable - $dvi_update_signal. The default value under UNIX is suitable + 2 => Send the signal, whose number is in the variable + $dvi_update_signal. The default value under UNIX is suitable for xdvi. - 3 => Viewer cannot do an update, because it locks the file. + 3 => Viewer cannot do an update, because it locks the file. (As with acroread under MS-Windows.) - 4 => run a command to do the update. The command is speci- + 4 => run a command to do the update. The command is speci- fied by the variable $dvi_update_command. - See information on the variable $pdf_update_method for an exam- + See information on the variable $pdf_update_method for an exam- ple of updating by command. - $dvi_update_signal [Under UNIX: SIGUSR1, which is a system-dependent + $dvi_update_signal [Under UNIX: SIGUSR1, which is a system-dependent value] - The number of the signal that is sent to the dvi viewer when it - is updated by sending a signal -- see the information on the - variable $dvi_update_method. The default value is the one ap- + The number of the signal that is sent to the dvi viewer when it + is updated by sending a signal -- see the information on the + variable $dvi_update_method. The default value is the one ap- propriate for xdvi on a UNIX system. $emulate_aux [0] Whether to emulate the use of aux_dir when $aux_dir and $out_dir - are different, rather than using the -aux-directory option for + are different, rather than using the -aux-directory option for - 29 May 2021 44 + 21 September 2021 44 @@ -2911,15 +2911,15 @@ LATEXMK(1) General Commands Manual LATEXMK(1) the *latex programs. (MiKTeX supports -aux-directory, but TeXLive doesn't.) - If you use a version of *latex that doesn't support -aux-direc- - tory, e.g., TeXLive, latexmk will automatically switch aux_dir + If you use a version of *latex that doesn't support -aux-direc- + tory, e.g., TeXLive, latexmk will automatically switch aux_dir emulation on after the first run of *latex, because it will find the .log file in the wrong place. - Aux_directory emulation means that when *latex is invoked, the - output directory provided to *latex is set to be the aux_dir. - After that, any files that need to be in the output directory - will be moved there. (These are the files with extensions .dvi, + Aux_directory emulation means that when *latex is invoked, the + output directory provided to *latex is set to be the aux_dir. + After that, any files that need to be in the output directory + will be moved there. (These are the files with extensions .dvi, .ps, .pdf, .fls, .synctex, .synctex.gz.) @@ -2927,45 +2927,45 @@ LATEXMK(1) General Commands Manual LATEXMK(1) See the documentation for $compiling_cmd. $fdb_ext ["fdb_latexmk"] - The extension of the file which latexmk generates to contain a - database of information on source files. You will not normally + The extension of the file which latexmk generates to contain a + database of information on source files. You will not normally need to change this. - $filetime_causality_threshold [5]; $filetime_offset_report_threshold + $filetime_causality_threshold [5]; $filetime_offset_report_threshold [30]. (Units of seconds.) These variables control how latexmk deals with the following is- - sue, which can affect the use of files that are on a remote + sue, which can affect the use of files that are on a remote filesystem (network share) instead of being on a file system lo- cal to the computer running latexmk. Almost users will not have - to worry about these settings, and can ignore the following ex- + to worry about these settings, and can ignore the following ex- planation. - In almost all situations, latexmk does not need to use the time - stamps of the files it works with. However, there are a couple - of situations when it needs to know whether a certain file was - created in the current run of a program (e.g., *latex) or is a + In almost all situations, latexmk does not need to use the time + stamps of the files it works with. However, there are a couple + of situations when it needs to know whether a certain file was + created in the current run of a program (e.g., *latex) or is a leftover file from a previous run. It does this by comparing the - modification time of the file with the system time just before - the program was started. If the modification time is earlier - than when the program was started, the file is a leftover file, + modification time of the file with the system time just before + the program was started. If the modification time is earlier + than when the program was started, the file is a leftover file, which latexmk treats as if it were not created. If the filetime - is at least the program start time, then it can be assumed that + is at least the program start time, then it can be assumed that the file was created in the current run. - Unfortunately, this test can fail if the file is on a remote - system, since its system time is not necessarily synchronized - with that of the local system; the timestamps on the remote - files are set by the remote system, not the local system. Gen- - erally, modern operating systems regularly synchronize their - time with a server, so the non-synchronization is mostly small + Unfortunately, this test can fail if the file is on a remote + system, since its system time is not necessarily synchronized + with that of the local system; the timestamps on the remote + files are set by the remote system, not the local system. Gen- + erally, modern operating systems regularly synchronize their + time with a server, so the non-synchronization is mostly small (a second or so, or a few seconds). But even a small difference can mess up latexmk's test. - 29 May 2021 45 + 21 September 2021 45 @@ -2975,63 +2975,63 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Latexmk measures the time difference between the time on the two - systems and compensates for this. But the measurement (in a + systems and compensates for this. But the measurement (in a system-independent way) is only accurate to a second or two. So - latexmk allows for a threshold on the difference between file - and system time before it concludes that a file is a leftover - file from a previous run. The configuration variable $file- - time_causality_theshhold, which in units of seconds, specifies + latexmk allows for a threshold on the difference between file + and system time before it concludes that a file is a leftover + file from a previous run. The configuration variable $file- + time_causality_theshhold, which in units of seconds, specifies this threshold. Luckily high precision is not needed. The pre- - vious run is normally the previous run in a human run-edit-run - cycle, and is at least many seconds back. A few seconds is - therefore appropriate for the threshold, $filetime_causal- - ity_theshhold; it should be non-negative always, and should be + vious run is normally the previous run in a human run-edit-run + cycle, and is at least many seconds back. A few seconds is + therefore appropriate for the threshold, $filetime_causal- + ity_theshhold; it should be non-negative always, and should be bigger than 2 if a remote filesystem or network share is used. - If the difference in system times on the two systems is large, - it normally indicates that at least one of the systems is mis- - configured. The variable $filetime_offset_report_threshold - specifies the smallest size of the difference (or offset) in - seconds between the times of the local and remote system beyond - which the offset is reported. This is reported at the point in - the latexmk's progress that it measures the offset. The report + If the difference in system times on the two systems is large, + it normally indicates that at least one of the systems is mis- + configured. The variable $filetime_offset_report_threshold + specifies the smallest size of the difference (or offset) in + seconds between the times of the local and remote system beyond + which the offset is reported. This is reported at the point in + the latexmk's progress that it measures the offset. The report is made if silent mode is used and diagnostic mode is not on. $force_mode [0] - If nonzero, continue processing past minor latex errors includ- + If nonzero, continue processing past minor latex errors includ- ing unrecognized cross references. Equivalent to specifying the -f option. - @generated_exts [( aux , bbl , idx , ind , lof , lot , out , toc , + @generated_exts [( aux , bbl , idx , ind , lof , lot , out , toc , $fdb_ext )] - This contains a list of extensions for files that are generated - during a LaTeX run and that are read in by LaTeX in later runs, + This contains a list of extensions for files that are generated + during a LaTeX run and that are read in by LaTeX in later runs, either directly or indirectly. - This list specifies files known to be generated by *latex. It - is used in two ways: (a) The specified files are deleted in a - cleanup operation (with the -c, -C, -CA, -g and -gg options), - and (b) It affects the determination of whether a rerun of *la- + This list specifies files known to be generated by *latex. It + is used in two ways: (a) The specified files are deleted in a + cleanup operation (with the -c, -C, -CA, -g and -gg options), + and (b) It affects the determination of whether a rerun of *la- tex is needed after a run that gives an error. (Concerning item (b): Normally, a change of a source file during a run should provoke a rerun. This includes a file generated by - LaTeX, e.g., an aux file, that is read in on subsequent runs. - But after a run that results in an error, a new run should not - occur until the user has made a change in the files. But the - user may have corrected an error in a source .tex file during + LaTeX, e.g., an aux file, that is read in on subsequent runs. + But after a run that results in an error, a new run should not + occur until the user has made a change in the files. But the + user may have corrected an error in a source .tex file during the run. So latexmk needs to distinguish user-generated and au- - tomatically generated files; it determines the automatically - generated files as those with extensions in the list in @gener- + tomatically generated files; it determines the automatically + generated files as those with extensions in the list in @gener- ated_exts.) - A convenient way to add an extra extension to the list, without - losing the already defined ones is to use a push command in the + A convenient way to add an extra extension to the list, without + losing the already defined ones is to use a push command in the - 29 May 2021 46 + 21 September 2021 46 @@ -3045,25 +3045,25 @@ LATEXMK(1) General Commands Manual LATEXMK(1) push @generated_exts, "end"; adds the extension "end" to the list of predefined generated ex- - tensions. (This extension is used by the RevTeX package, for + tensions. (This extension is used by the RevTeX package, for example.) $go_mode [0] - If nonzero, process files regardless of timestamps, and is then + 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!!! - The general rule latexmk uses for determining when an extra run - of some program is needed is that one of the source files has - 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 + The general rule latexmk uses for determining when an extra run + of some program is needed is that one of the source files has + 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. @@ -3072,23 +3072,23 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $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 + 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 expresssion. (See documentation on Perl for how - they are to be specified in general.) This particular regular - expression specifies that lines beginning with "%%CreationDate: - " are to be ignored in deciding whether a file of the given ex- + ing a regular expresssion. (See documentation on Perl for how + they are to be specified in general.) This particular regular + expression specifies that lines beginning with "%%CreationDate: + " are to be ignored in deciding whether a file of the given ex- tension .eps has changed. - There is only one regular expression available for each exten- - sion. If you need more one pattern to specify lines to ignore, - then you need to combine the patterns into a single regular ex- - pression. The simplest method is separate the different simple - patterns by a vertical bar character (indicating "alternation" + There is only one regular expression available for each exten- + sion. If you need more one pattern to specify lines to ignore, + then you need to combine the patterns into a single regular ex- + pression. The simplest method is separate the different simple + patterns by a vertical bar character (indicating "alternation" in the jargon of regular expressions). For example, - $hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: |^%%Ti- + $hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: |^%%Ti- tle: '; causes lines starting with either "^%%CreationDate: " or "^%%Ti- @@ -3097,7 +3097,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 47 + 21 September 2021 47 @@ -3106,9 +3106,9 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - It may happen that a pattern to be ignored is specified in, for - example, in a system or user initialization file, and you wish - to remove this in a file that is read later. To do this, you + It may happen that a pattern to be ignored is specified in, for + example, in a system or user initialization file, and you wish + to remove this in a file that is read later. To do this, you use Perl's delete function, e.g., delete $hash_calc_ignore_pattern{'eps'}; @@ -3116,54 +3116,54 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $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 + 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.) - The placeholder '%A' is permitted. This will be substituted by + 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 + 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 + 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 + 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" - 29 May 2021 48 + 21 September 2021 48 @@ -3172,34 +3172,34 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - 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- + 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 + 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 + 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"; @@ -3209,27 +3209,27 @@ LATEXMK(1) General Commands Manual LATEXMK(1) %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 + (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 - 29 May 2021 49 + 21 September 2021 49 @@ -3246,19 +3246,19 @@ LATEXMK(1) General Commands Manual LATEXMK(1) add_input_ext( 'latex', 'asdf' ); - add the extension 'asdf to latex_input_extensions. (Naturally + 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- @@ -3268,19 +3268,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 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. @@ -3290,12 +3290,12 @@ 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., - 29 May 2021 50 + 21 September 2021 50 @@ -3306,15 +3306,15 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $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 + 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 $latex, $pdflatex, $luala- @@ -3322,26 +3322,26 @@ 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 + 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- + 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"] @@ -3351,9 +3351,9 @@ 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. @@ -3361,7 +3361,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 51 + 21 September 2021 51 @@ -3371,63 +3371,63 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $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- + 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. (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 + 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 + 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- + "\" 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. - However there are also programs on MS-Windows for which a back + 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 + 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 directory in which + If non-blank, this variable specifies the directory in which output files are to be written by a run of *latex. See also the variable $aux_dir. - The effect of this variable (when non-blank) is achieved by us- - ing the -output-directory option of *latex. This exists in the + The effect of this variable (when non-blank) is achieved by us- + ing the -output-directory option of *latex. This exists in the - 29 May 2021 52 + 21 September 2021 52 @@ -3436,49 +3436,49 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - usual current (Dec. 2011 and later) implementations of TeX, - i.e., MiKTeX and TeXLive. But it may not be present in other + usual current (Dec. 2011 and later) implementations of TeX, + i.e., MiKTeX and TeXLive. But it may not be present in other versions. - If you also use the -cd option, and $out_dir (or $aux_dir) con- - tains a relative path, then the path is interpreted relative to + If you also use the -cd option, and $out_dir (or $aux_dir) con- + tains a relative path, then the path is interpreted relative to the document directory. - Commonly, the directory specified for output files is a subdi- + Commonly, the directory specified for output files is a subdi- rectory of the current working directory. However, if you spec- - ify some other directory, e.g., "/tmp/foo" or "../output", be - aware that this could cause problems, e.g., with makeindex or - bibtex. This is because modern versions of these 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 + ify some other directory, e.g., "/tmp/foo" or "../output", be + aware that this could cause problems, e.g., with makeindex or + bibtex. This is because modern versions of these 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 current working directory or one of its subdirectories. This is - part of security measures by the whole TeX system that try to + part of security measures by the whole TeX system that try to prevent malicious or errant TeX documents from incorrectly mess- ing with a user's files. If for $out_dir or $aux_dir you really - do need to specify an absolute pathname (e.g., "/tmp/foo") or a + do need to specify an absolute pathname (e.g., "/tmp/foo") or a path (e.g., "../output") that includes a higher-level directory, - and you need to use makeindex or bibtex, then you need to dis- - able the security measures (and assume any risks). One way of + and you need to use makeindex or bibtex, then you need to dis- + able the security measures (and assume any risks). One way of doing this is to temporarily set an operating system environment - variable openout_any to "a" (as in "all"), to override the de- + variable openout_any to "a" (as in "all"), to override the de- fault "paranoid" setting. $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"] @@ -3493,7 +3493,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 53 + 21 September 2021 53 @@ -3502,64 +3502,64 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - (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 $latex, $pdflatex, $luala- tex, and $xelatex, see the section "Advanced 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 + 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 + 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 + 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 -- + 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 + 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 - 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 - 29 May 2021 54 + 21 September 2021 54 @@ -3569,26 +3569,26 @@ LATEXMK(1) General Commands Manual LATEXMK(1) 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 @@ -3601,31 +3601,31 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $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- + 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 + $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- + 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 - 29 May 2021 55 + 21 September 2021 55 @@ -3637,23 +3637,23 @@ LATEXMK(1) General Commands Manual LATEXMK(1) 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; @@ -3662,36 +3662,36 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $preview_continuous_mode [0] - If nonzero, run a previewer to view the document, and continue + 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, + 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 + 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 + 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 + 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 - 29 May 2021 56 + 21 September 2021 56 @@ -3703,12 +3703,12 @@ LATEXMK(1) General Commands Manual LATEXMK(1) 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. @@ -3717,47 +3717,47 @@ 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 + 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. WARNING: Linux systems may have installed one (or more) versions - of gv under different names, e.g., ggv, kghostview, etc, but + 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 + 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. - $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. - 29 May 2021 57 + 21 September 2021 57 @@ -3767,24 +3767,24 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $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. @@ -3800,30 +3800,30 @@ 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 + 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 + 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 option - results in a file of extension .fls containing a list of the - files that these programs have read and written. Latexmk will + results in a file of extension .fls containing a list of the + files that these programs have read and written. Latexmk will - 29 May 2021 58 + 21 September 2021 58 @@ -3832,64 +3832,64 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - then use this file to improve its detection of source files and + 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 + [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.] - 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 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 CPU time used. $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. - 29 May 2021 59 + 21 September 2021 59 @@ -3898,29 +3898,29 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - 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 + 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- + minimum of one second delay, except that zero delay is also al- lowed. - A value of exactly 0 gives no delay, and typically results in + 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 + 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 + 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". @@ -3928,34 +3928,34 @@ LATEXMK(1) General Commands Manual LATEXMK(1) See the documentation for $compiling_cmd. $tmpdir [See below for default] - Directory to store temporary files that latexmk may generate + 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 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 + 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. - 29 May 2021 60 + 21 September 2021 60 @@ -3965,63 +3965,63 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $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 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 + 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.) $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). - 29 May 2021 61 + 21 September 2021 61 @@ -4034,17 +4034,17 @@ LATEXMK(1) General Commands Manual LATEXMK(1) 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 + 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 + 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 + 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 + 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. @@ -4053,33 +4053,33 @@ LATEXMK(1) General Commands Manual LATEXMK(1) %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 + 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. @@ -4087,7 +4087,7 @@ CUSTOM DEPENDENCIES - 29 May 2021 62 + 21 September 2021 62 @@ -4098,9 +4098,9 @@ 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- @@ -4113,47 +4113,47 @@ LATEXMK(1) General Commands Manual LATEXMK(1) 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. + 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 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 + 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 + 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 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 + 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 - 29 May 2021 63 + 21 September 2021 63 @@ -4162,45 +4162,45 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - 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 - 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' ); @@ -4208,18 +4208,18 @@ 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. - 29 May 2021 64 + 21 September 2021 64 @@ -4228,25 +4228,25 @@ LATEXMK(1) General Commands Manual LATEXMK(1) 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 + 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' ); @@ -4254,30 +4254,30 @@ 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 - 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 + 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 + 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 + 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 + 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. @@ -4285,7 +4285,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 65 + 21 September 2021 65 @@ -4295,19 +4295,19 @@ 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(); @@ -4318,29 +4318,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 im- + 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 + 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". - 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' ); @@ -4351,7 +4351,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 66 + 21 September 2021 66 @@ -4360,14 +4360,14 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - Notice the added line compared with earlier examples. The extra line + 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' ); @@ -4386,38 +4386,38 @@ 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 - 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. - 29 May 2021 67 + 21 September 2021 67 @@ -4427,7 +4427,7 @@ 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"; @@ -4435,21 +4435,21 @@ 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 use- ful ideas @@ -4458,13 +4458,13 @@ ADVANCED CONFIGURATION: Some extra resources and advanced tricks 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: @@ -4472,18 +4472,18 @@ ADVANCED CONFIGURATION: Some extra resources and advanced tricks 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. - 29 May 2021 68 + 21 September 2021 68 @@ -4494,22 +4494,22 @@ 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 @@ -4517,31 +4517,31 @@ LATEXMK(1) General Commands Manual LATEXMK(1) dollar signs. $$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. rdb_ensure_file( $rule, file ) - This a subroutine that ensures that the given file is among the + This a subroutine that 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, + 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- + 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. 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_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. rdb_set_source( $rule, file, ... ) @@ -4549,7 +4549,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 69 + 21 September 2021 69 @@ -4559,63 +4559,63 @@ 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. 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 be- + %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 + tution is printed to the screen unless latexmk is running in silent mode. Coordinated Setting of Commands for *latex - To set all of $latex, $pdflatex, $lualatex, and $xelatex to a common - pattern, you can use one of the following subroutines, std_tex_cmds, + To set all of $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. They work as follows &std_tex_cmds; - This results in $latex = 'latex %O %S', and similarly for $pdflatex, - $lualatex, and $xelatex. Note the ampersand in the invocation; this + This results in $latex = 'latex %O %S', and similarly for $pdflatex, + $lualatex, and $xelatex. Note the ampersand in the invocation; this indicates to Perl that a subroutine is being called. &alt_tex_cmds; - This results in $latex = 'latex %O %P', and similarly for $pdflatex, - $lualatex, and $xelatex. Note the ampersand in the invocation; this + This results in $latex = 'latex %O %P', and similarly for $pdflatex, + $lualatex, and $xelatex. Note the ampersand in the invocation; this indicates to Perl that a subroutine is being called. set_tex_cmds( CMD_SPEC ); - Here CMD_SPEC is the command line without the program name. This re- - sults in $latex = 'CMD_SPEC', and similarly for $pdflatex, $lualatex, + Here CMD_SPEC is the command line without the program name. This re- + sults in $latex = 'CMD_SPEC', and similarly for $pdflatex, $lualatex, and $xelatex. An example would be set_tex_cmds( '--interaction=batchmode %O %S' ); 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 + 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 - 29 May 2021 70 + 21 September 2021 70 @@ -4624,32 +4624,32 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - program is not suited to this purpose for at least two reasons. First + 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, 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- @@ -4661,27 +4661,27 @@ 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 - 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 + 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 - 29 May 2021 71 + 21 September 2021 71 @@ -4690,16 +4690,16 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - latexmk is always run. It is latexmk that decides whether any action - is needed, e.g., a rerun of pdflatex. Effectively the Makefile dele- + latexmk is always run. It is latexmk that decides whether any action + is needed, e.g., a rerun of pdflatex. Effectively the Makefile dele- gates 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 + 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 custom 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 @@ -4718,36 +4718,36 @@ 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 + 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 - 29 May 2021 72 + 21 September 2021 72 @@ -4757,10 +4757,10 @@ LATEXMK(1) General Commands Manual LATEXMK(1) "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. @@ -4769,35 +4769,35 @@ SEE ALSO BUGS 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.74b). Report bugs etc to + Current version, by John Collins (Version 4.75). 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: + <http://www.ctan.org/pkg/latexmk/>, and from the author's website <http://www.personal.psu.edu/jcc8/latexmk/>. Modifications and enhancements by Evan McLean (Version 2.0) Original script called "go" by David J. Musliner (RCS Version 3.2) @@ -4813,7 +4813,7 @@ AUTHOR - 29 May 2021 73 + 21 September 2021 73 @@ -4879,6 +4879,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 29 May 2021 74 + 21 September 2021 74 diff --git a/Master/texmf-dist/scripts/latexmk/latexmk.pl b/Master/texmf-dist/scripts/latexmk/latexmk.pl index 55ecc54b840..b00aeba4a04 100755 --- a/Master/texmf-dist/scripts/latexmk/latexmk.pl +++ b/Master/texmf-dist/scripts/latexmk/latexmk.pl @@ -29,6 +29,11 @@ use warnings; ## ## Modification log from 14 Apr 2021 onwards in detail ## +## 23 Sep 2021 John Collins Option -time: times for all rules reported now +## 18 Sep 2021 John Collins For biber: parse blg file for config file use +## V. 4.75. +## 27 Aug 2021 John Collins Modified "missing file" message (when parsing +# log file). ## 29 May 2021 John Collins When emulating aux_dir, put .synctex.gz .synctex ## files in out_dir (as done by MiKTeX, and needed ## for their use). @@ -94,8 +99,8 @@ use warnings; $my_name = 'latexmk'; $My_name = 'Latexmk'; -$version_num = '4.74b'; -$version_details = "$My_name, John Collins, 29 May 2021"; +$version_num = '4.75'; +$version_details = "$My_name, John Collins, 21 September 2021"; use Config; use File::Basename; @@ -4189,7 +4194,8 @@ sub check_biber_log { elsif ( /> INFO - Found .* '([^']+)'\s*$/ || /> INFO - Found '([^']+)'\s*$/ || /> INFO - Reading '([^']+)'\s*$/ - || /> INFO - Processing .* file '([^']+)' .*$/ + || /> INFO - Processing .* file '([^']+)'.*$/ + || /> INFO - Config file is '([^']+)'.*$/ ) { my $file = $1; my ( $base, $path, $ext ) = fileparseA( $file ); @@ -4901,7 +4907,7 @@ LINE: foreach my $pattern (@file_not_found) { if ( /$pattern/ ) { my $file = clean_filename($1); - warn "$My_name: Missing input file: '$file' from following:\n '$_'\n" + warn "$My_name: Missing input file '$file' (or dependence on it) from following:\n '$_'\n" unless $silent; $dependents{normalize_filename($file, @pwd_log)} = 0; my $file1 = $file; @@ -7821,6 +7827,9 @@ sub rdb_run1 { foreach (@int_args_for_printing) { if ( ! defined $_ ) { $_ = 'undef'; } } + + # The actual execution of the command: + my $time = processing_time(); if ($int_cmd) { print "For rule '$rule', use internal command '\&$int_cmd( @int_args_for_printing )' ...\n" if $diagnostics; @@ -7837,6 +7846,9 @@ sub rdb_run1 { $$Plast_result = 2; $$Plast_message = "Bug or configuration error; incorrect command type"; } + $time = processing_time() - $time; + push @timings, "'$_[0]': time = $time\n"; + if ( $rule =~ /^biber/ ) { my @biber_source = ( ); my $retcode = check_biber_log( $$Pbase, \@biber_source ); @@ -9884,18 +9896,18 @@ sub Run_msg { #================== -sub Run { - # This is wrapper around Run_no_time to capture timing information +sub Run_time { + # This is wrapper around Run to capture timing information my $time1 = processing_time(); - my ($pid, $return) = Run_no_time($_[0]); + my ($pid, $return) = Run($_[0]); my $time = processing_time() - $time1; push @timings, "'$_[0]': time = $time\n"; return ($pid, $return); -} #END Run_msg +} #END Run_time #================== -sub Run_no_time { +sub Run { # Usage: Run_no_time ("command string"); # or Run_no_time ("one-or-more keywords command string"); # Possible keywords: internal, NONE, start, nostart. |