diff options
| author | Karl Berry <karl@freefriends.org> | 2018-01-18 23:25:58 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2018-01-18 23:25:58 +0000 |
| commit | ec3a66bfdc270c6ec6c872ad560be774cf46d617 (patch) | |
| tree | e0a9d4ddf710c818312c95f483709e8d582ded49 /Master | |
| parent | ab1f1f27607fc9dfce015d503843e67a46df1acd (diff) | |
latexmk (18jan18)
git-svn-id: svn://tug.org/texlive/trunk@46378 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master')
| -rw-r--r-- | Master/texmf-dist/doc/man/man1/latexmk.1 | 96 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/man/man1/latexmk.man1.pdf | bin | 182287 -> 186720 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/CHANGES | 15 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/INSTALL | 2 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/README | 9 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/latexmk.pdf | bin | 182408 -> 186643 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/latexmk.txt | 2056 | ||||
| -rwxr-xr-x | Master/texmf-dist/scripts/latexmk/latexmk.pl | 331 |
8 files changed, 1374 insertions, 1135 deletions
diff --git a/Master/texmf-dist/doc/man/man1/latexmk.1 b/Master/texmf-dist/doc/man/man1/latexmk.1 index 33b5fcd2120..0334565101f 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 "12 December 2017" "" +.TH LATEXMK 1 "17 January 2018" "" .SH NAME latexmk \- generate LaTeX document .SH SYNOPSIS @@ -847,6 +847,21 @@ how to determine whether an existing previewer is running.) Turn off \fB-pvc\fR. .TP +.B -pvctimeout +Do timeout in pvc mode after period of inactivity, which is 30 min. by +default. Inactivity means a period when \fIlatexmk\fR has detected no +file changes and hence has not taken any actions like compiling the +document. + +.TP +.B -pvctimeout- +Don't do timeout in pvc mode after inactivity. + +.TP +.B -pvctimeoutmins=<time> +Set period of inactivity in \fIminutes\fR for pvc timeout. + +.TP .B -quiet Same as -silent @@ -1550,7 +1565,7 @@ converting the dvi file to postscript. Without modifying the variable \fI$banner_message\fR, this is equivalent to specifying the \fB-d\fR option. -Note that if \fB$banner\fR is nonzero, the \fB$postscript_mode\fR is +Note that if \fI$banner\fR is nonzero, the \fI$postscript_mode\fR is assumed and the postscript file is always generated, even if it is newer than the dvi file. .TP @@ -1918,6 +1933,59 @@ The extension of the file which \fIlatexmk\fR generates to contain a database of information on source files. You will not normally need to change this. .TP +.B $filetime_causality_threshold [5]; $filetime_offset_report_threshold [30]. \fR(Units of seconds.) + +These variables control how \fIlatexmk\fR deals with the following +issue, which can affect the use of files that are on a remote +filesystem (network share) instead of being on a file system local to +the computer running \fIlatexmk\fR. Almost users will not have to +worry about these settings, and can ignore the following explanation. + +In almost all situations, \fIlatexmk\fR 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., \fI(pdf)latex\fR) 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, which \fIlatexmk\fR treats as if +it were not created. If the filetime 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. Generally, 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 \fIlatexmk\fR's +test. + +\fILatexmk\fR measures the time difference between the time on the two +systems and compensates for this. But the measurement (in a +system-independent way) is only accurate to a second or two. So +\fIlatexmk\fR 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 +\fI$filetime_causality_theshhold\fR, which in units of seconds, +specifies this threshold. Luckily high precision is not needed. The +previous 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, \fI$filetime_causality_theshhold\fR; 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 misconfigured. +The variable \fI$filetime_offset_report_threshold\fR 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 \fIlatexmk\fR's +progress that it measures the offset. The report is made if silent +mode is used and diagnostic mode is not on. + +.TP .B $force_mode [0] If nonzero, continue processing past minor \fIlatex\fR errors including unrecognized cross references. Equivalent to specifying the @@ -2079,7 +2147,7 @@ such an extension, you should have made an appropriate custom dependency for \fIlatexmk\fR, and should also have done the appropriate 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. +packages.) .TP .B $latex_silent_switch ["-interaction=batchmode"] Switch(es) for the LaTeX processing program when silent mode is on. @@ -2460,6 +2528,18 @@ The number of the signal that is sent to the pdf viewer when it is updated by sending a signal -- see \fI$ps_update_method\fR. The default value is the one appropriate for gv on a UNIX system. .TP +.B $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 +\fIlatexmk\fR has detected no file changes and hence has not taken any +actions like compiling the document. The period of inactivity is in +the variable $pvc_timeout_mins. + +.TP +.B $pvc_timeout_mins [30] +The period of inactivity, in minutes, after which pvc mode times out. +This is used if \fI$pvc_timeout\fR is nonzero. +.TP .B $pvc_view_file_via_temporary [1] The same as \fI$always_view_file_via_temporary\fR, except that it only applies in preview-continuous mode (-pvc option). @@ -2644,7 +2724,7 @@ would be to allow \fIlatexmk\fR to convert a \fI.fig\fR file to .SS Defining a custom dependency: The old method of configuring \fIlatexmk\fR to use a custom dependency -was to directly manipulate the \fB@cus_dep_list\fR array that contains +was to directly manipulate the \fI@cus_dep_list\fR 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. @@ -2874,7 +2954,7 @@ You could also instead use } push @generated_exts, 'ndx', 'nnd', 'adx', 'and'; -This last example uses the command specification in \fB$makeindex\fR, +This last example uses the command specification in \fI$makeindex\fR, and so any customization you have made for the standard index also applies to your extra indexes. @@ -2897,7 +2977,7 @@ if you have to deal with such problems. .SS Old Method of Defining Custom Dependencies: In much older versions of \fIlatexmk\fR, the only method of defining custom dependencies was to directly manipulate the table of custom -dependencies. This is contained in the \fB@cus_dep_list\fR array. It +dependencies. This is contained in the \fI@cus_dep_list\fR array. It is an array of strings, and each string in the array has four items in it, each separated by a space, the from-extension, the to-extension, the "must" item, and the name of the subroutine for the custom @@ -2968,7 +3048,7 @@ processing of a rule, it is known that a particular extra file is among the dependencies that \fIlatexmk\fR should know, but its default methods don't find the dependency. Almost always the first argument is the name of the rule currently being processed, so it is then -appropriate to specify it by \fB$rule\fR. +appropriate to specify it by \fI$rule\fR. For examples of its use, see some of the files in the directory \fIexample_rcfiles\fR of \fIlatexmk\fR's distribution. Currently the @@ -3169,7 +3249,7 @@ e-mail addresses are not written in their standard form to avoid being harvested too easily.) .SH AUTHOR Current version, by John Collins (username jcc8 at node psu.edu). -(Version 4.54c). +(Version 4.55). Released version can be obtained from CTAN: <http://www.ctan.org/pkg/latexmk/>, and from the 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 129af15c0e4..3bfcfb00a27 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 9ddf73a316a..7e7deb47667 100644 --- a/Master/texmf-dist/doc/support/latexmk/CHANGES +++ b/Master/texmf-dist/doc/support/latexmk/CHANGES @@ -576,3 +576,18 @@ From v. 4.54 to 4.54c Work-around for when bsd_glob is not available on old installations of Perl. (Note that with these old installations, clean-up operations may not work when file or directory names contain spaces.) + +From v. 4.54c to 4.55 + Correct bug that $search_path_separator wasn't defined under msys. + Ensure that all configuration variables do have sensible default + definitions (which wasn't always the case previously). + Allow optional timeout in pvc mode after a period of inactivity. + (See documentation for -pvctimeout option.) + Compensate for problems caused by time offset between system time on + system running latexmk and file times on remote file system. + (It caused wrong behavior when a document uses biber, MiKTeX + is used, the aux_dir is on a remote file system, and the system + time on the host of the file system differs from the system time on + the system running latexmk.) + + diff --git a/Master/texmf-dist/doc/support/latexmk/INSTALL b/Master/texmf-dist/doc/support/latexmk/INSTALL index 590b5d839b8..a90fee4600c 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.54c, 12 December 2017) + (Version 4.55, 17 January 2018) John Collins Physics Department diff --git a/Master/texmf-dist/doc/support/latexmk/README b/Master/texmf-dist/doc/support/latexmk/README index 2026d356a8e..dea4aba12de 100644 --- a/Master/texmf-dist/doc/support/latexmk/README +++ b/Master/texmf-dist/doc/support/latexmk/README @@ -1,5 +1,5 @@ -Latexmk, version 4.54c, 12 December 2017 ----------------------------------------- +Latexmk, version 4.55, 17 January 2018 +-------------------------------------- Latexmk completely automates the process of generating a LaTeX document. Essentially, it is a highly specialized cousin of the @@ -91,7 +91,7 @@ NOTES:- John Collins ---------------------------- "latexmk -h" ---------------------------- -Latexmk 4.54c: Automatic LaTeX document generation routine +Latexmk 4.55: Automatic LaTeX document generation routine Usage: latexmk [latexmk_options] [filename ...] @@ -183,6 +183,9 @@ Usage: latexmk [latexmk_options] [filename ...] on force mode, so errors do not cause latexmk to stop.) (Side effect: turn off ordinary preview mode.) -pvc- - turn off -pvc + -pvctimeout - timeout in pvc mode after period of inactivity + -pvctimeout- - don't timeout in pvc mode after inactivity + -pvctimeoutmins=<time> - set period of inactivity (minutes) for pvc timeout -quiet - silence progress messages from called programs -r <file> - Read custom RC file (N.B. This file could override options specified earlier diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.pdf b/Master/texmf-dist/doc/support/latexmk/latexmk.pdf Binary files differindex 232ba57b024..d39a263bc4b 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 122f58ad994..772e2924ab0 100644 --- a/Master/texmf-dist/doc/support/latexmk/latexmk.txt +++ b/Master/texmf-dist/doc/support/latexmk/latexmk.txt @@ -61,7 +61,7 @@ DESCRIPTION - 12 December 2017 1 + 17 January 2018 1 @@ -127,7 +127,7 @@ LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE - 12 December 2017 2 + 17 January 2018 2 @@ -193,7 +193,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 12 December 2017 3 + 17 January 2018 3 @@ -259,7 +259,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 12 December 2017 4 + 17 January 2018 4 @@ -325,7 +325,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 12 December 2017 5 + 17 January 2018 5 @@ -391,7 +391,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 12 December 2017 6 + 17 January 2018 6 @@ -457,7 +457,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 12 December 2017 7 + 17 January 2018 7 @@ -523,7 +523,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 12 December 2017 8 + 17 January 2018 8 @@ -589,7 +589,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 12 December 2017 9 + 17 January 2018 9 @@ -655,7 +655,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 12 December 2017 10 + 17 January 2018 10 @@ -721,7 +721,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 12 December 2017 11 + 17 January 2018 11 @@ -787,7 +787,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 12 December 2017 12 + 17 January 2018 12 @@ -853,7 +853,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 12 December 2017 13 + 17 January 2018 13 @@ -919,7 +919,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 12 December 2017 14 + 17 January 2018 14 @@ -972,20 +972,20 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -pvc- Turn off -pvc. - -quiet Same as -silent + -pvctimeout + Do timeout in pvc mode after period of inactivity, which is 30 + min. by default. Inactivity means a period when latexmk has + detected no file changes and hence has not taken any actions + like compiling the document. - -r <rcfile> - Read the specified initialization file ("RC file") before pro- - cessing. + -pvctimeout- + Don't do timeout in pvc mode after inactivity. - Be careful about the ordering: (1) Standard initialization files - -- see the section below on "Configuration/initialization (RC) - files" -- are read first. (2) Then the options on the command - 12 December 2017 15 + 17 January 2018 15 @@ -994,30 +994,44 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - line are acted on in the order they are given. Therefore if an - initialization file is specified by the -r option, it is read - during this second step. Thus an initialization file specified + -pvctimeoutmins=<time> + Set period of inactivity in minutes for pvc timeout. + + + -quiet Same as -silent + + + -r <rcfile> + Read the specified initialization file ("RC file") before pro- + cessing. + + Be careful about the ordering: (1) Standard initialization files + -- see the section below on "Configuration/initialization (RC) + files" -- are read first. (2) Then the options on the command + line are acted on in the order they are given. Therefore if an + initialization file is specified by the -r option, it is read + during this second step. Thus an initialization file specified with the -r option can override both the standard initialization files and previously specified options. But all of these can be overridden by later options. The contents of the RC file just comprise a piece of code in the - Perl programming language (typically a sequence of assignment + Perl programming language (typically a sequence of assignment statements); they are executed when the -r option is encountered during latexmk's parsing of its command line. See the -e option - for a way of giving initialization code directly on latexmk's - command line. An error results in latexmk stopping. Multiple - instances of the -r and -e options can be used, and they are + for a way of giving initialization code directly on latexmk's + command line. An error results in latexmk stopping. Multiple + instances of the -r and -e options can be used, and they are executed in the order they appear on the command line. -recorder - Give the -recorder option with latex and pdflatex. In (most) - modern versions of these programs, this results in a file of - extension .fls containing a list of the files that these pro- + Give the -recorder option with latex and pdflatex. In (most) + modern versions of these programs, this results in a file of + extension .fls containing a list of the files that these pro- grams 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 or pdflatex. This is the default setting of + improve its detection of source files and generated files after + a run of latex or pdflatex. This is the default setting of latexmk, unless overridden in an initialization file. For further information, see the documentation for the $recorder @@ -1032,26 +1046,12 @@ 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 and pdflatex options that latexmk - recognizes, but that it simply passes through to the programs - latex, pdflatex, etc 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 or pdflatex that is being used, that program will probably - give an error message.) These options are very numerous, but - are not listed in this documentation because they have no effect - on latexmk's actions. - - - - 12 December 2017 16 + 17 January 2018 16 @@ -1060,42 +1060,54 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - There are a few options (-includedirectory=dir, -initialize, - -ini) that are not recognized, either because they don't fit + -showextraoptions + Show the list of extra latex and pdflatex options that latexmk + recognizes, but that it simply passes through to the programs + latex, pdflatex, etc 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 or pdflatex that is being used, that program will probably + give an error message.) These options are very numerous, but + are not listed in this documentation because they have no effect + on latexmk's actions. + + There are a few options (-includedirectory=dir, -initialize, + -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 + processing by latexmk that isn't implemented (at least, not yet). - There are also options that are accepted by latex etc, but + There are also options that are accepted by latex etc, but instead trigger actions by latexmk: -help, -version. Finally, there are certain options for latex and pdflatex (e.g., - -recorder) that trigger special actions or behavior by latexmk - itself as well as being passed in some form to the called latex - and pdflatex program, or that affect other programs as well. - These options do have entries in this documentation. These + -recorder) that trigger special actions or behavior by latexmk + itself as well as being passed in some form to the called latex + and pdflatex program, or that affect other programs as well. + These options do have entries in this documentation. These options are: -jobname=STRING, -aux-directory=dir, -output-direc- tory=DIR, -quiet, and -recorder. -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 (pdf)latex and friends. - See also the -logfilewarninglist and -logfilewarninglist- + See also the -logfilewarninglist and -logfilewarninglist- options. - 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 @@ -1103,43 +1115,42 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $show_time. - -time- Do not show CPU time used. See also the configuration variable - $show_time. - -use-make - When after a run of latex or pdflatex, 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 - custom dependency. If no relevant custom dependency with an - appropriate source file is found, and if the -use-make option is - set, then as a last resort latexmk will try to use the make - + 17 January 2018 17 - 12 December 2017 17 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1) General Commands Manual LATEXMK(1) + -time- Do not show CPU time used. See also the configuration variable + $show_time. - program to try to make the missing files. + -use-make + When after a run of latex or pdflatex, 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 + custom dependency. If no relevant custom dependency with an + appropriate source file is found, and if the -use-make option is + set, then as a last resort latexmk will try to use the make pro- + gram 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 - case, latexmk will try making drawing.ext with ext set in turn - to the possible extensions that are relevant for latex (or as + Note that the filename may be specified without an extension, + e.g., by \includegraphics{drawing} in a LaTeX file. In that + 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). - 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. + Do not use the make program to try to make missing files. (Default.) @@ -1156,34 +1167,23 @@ LATEXMK(1) General Commands Manual LATEXMK(1) the -pv or -pvc switches). The default is to view the "highest" 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 - option, 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 + option, when you want latexmk to do a compilation automatically + whenever source file(s) change, but do not want a previewer to be opened. -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. This procedure can result in - considerable savings in run time, since the xdv-to-pdf conver- - sion is quite time-consuming when large graphics files are used - - 12 December 2017 18 + 17 January 2018 18 @@ -1192,17 +1192,27 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) + -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. This procedure can result in + considerable savings in run time, since the xdv-to-pdf conver- + sion is quite time-consuming when large graphics files are used in the document.] Compatibility between options - 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 + Options -p, -pv and -pvc are mutually exclusive. So each of these options turns the others off. @@ -1230,92 +1240,82 @@ 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- - put. + 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 - 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- - ing LaTeX packages, etc.) - c. If latexmk doesn't run the programs the way you would like, then you + 17 January 2018 19 - 12 December 2017 19 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1) General Commands Manual LATEXMK(1) + output. + 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- + ing LaTeX packages, etc.) - 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- + 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- 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 difficult situations. - d. Further tricks can involve replacing the standard commands that + d. Further tricks can involve replacing the standard commands that latexmk 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 - instead 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 - '\input{bar.baz}' in the LaTeX part of the document, latexmk would - notice the change.) One solution is just to put the following some- + f. There's a useful trick that can be used when you use lualatex + instead 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 + '\input{bar.baz}' in the LaTeX part of the document, latexmk would + notice the change.) One solution is just to put the following some- where 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 - doing this automatically.) Of course, if the file has a different + 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 + doing 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. -CONFIGURATION/INITIALIZATION (RC) FILES - Latexmk can be customized using initialization files, which are read at - startup in the following order: - - 1) The system RC file, if it exists. - On a UNIX system, latexmk searches for following places for its sys- - tem RC file, in the following order, and reads the first it finds: - "/opt/local/share/latexmk/LatexMk", - - - 12 December 2017 20 + 17 January 2018 20 @@ -1324,10 +1324,18 @@ CONFIGURATION/INITIALIZATION (RC) FILES LATEXMK(1) General Commands Manual LATEXMK(1) +CONFIGURATION/INITIALIZATION (RC) FILES + Latexmk can be customized using initialization files, which are read at + startup in the following order: + + 1) The system RC file, if it exists. + On a UNIX system, latexmk searches for following places for its sys- + tem RC file, in the following order, and reads the first it finds: + "/opt/local/share/latexmk/LatexMk", "/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", @@ -1338,50 +1346,42 @@ LATEXMK(1) General Commands Manual LATEXMK(1) name replaced "LatexMk" replaced by "latexmkrc". 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 + $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 latexmk does not look for an RC file under it. - 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 - sequence of assignment statements that override some of the built-in - settings of Latexmk. Straightforward cases can be handled without - knowledge of the Perl language by using the examples in this document - as templates. Comment lines are introduced by the "#" character. + this in creative ways. But for most purposes, one simply uses a + sequence of assignment statements that override some of the built-in + settings of Latexmk. Straightforward cases can be handled without - 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 - allows initialization code to be specified in latexmk's command line. - - 12 December 2017 21 + 17 January 2018 21 @@ -1390,14 +1390,23 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - For possible examples of code for in an RC file, see the directory - example_rcfiles in the distribution of latexmk (e.g., at http://mir- + knowledge 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 + 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 + allows initialization code to be specified in latexmk's command line. + + For possible examples of code for in an RC file, see the directory + example_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 + The important variables that can be configured are described in the + section "List of configuration variables usable in initialization files". Syntax for setting these variables is of the following forms: $bibtex = 'bibtex %O %B'; @@ -1410,76 +1419,76 @@ 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 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 + 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 features - of how the commands are specified. (Note that some of the possibili- - ties listed here do not apply to the $kpsewhich variable; see its docu- - mentation.) - 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 - the following setting: + 17 January 2018 22 - 12 December 2017 22 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1) General Commands Manual LATEXMK(1) + of how the commands are specified. (Note that some of the possibili- + ties listed here do not apply to the $kpsewhich variable; see its docu- + mentation.) + 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 + 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: - %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 %R root filename. This is the base name for the main tex file. - %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. @@ -1488,32 +1497,23 @@ LATEXMK(1) General Commands Manual LATEXMK(1) 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 + %Z Name of directory for output files (see the configuration vari- + able $out_dir). A directory separation character ('/') is appended if $out_dir is non-empty and does not end in a suitable - character, with suitable characters being those appropriate to + 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 - spaces in them. (But if your TeX filenames have spaces in them, beware - that many 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. - - - 12 December 2017 23 + 17 January 2018 23 @@ -1522,64 +1522,64 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - The distinction between %B and %R needs a bit of care, since they are - often the same, but not always. For example on a simple document, the + 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 many 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. + + The distinction between %B and %R needs a bit of care, since they are + often the same, but not always. For example on a simple document, the basename of a bibtex run is the same as for the texfile. But in a doc- - ument with several bibliographies, the bibliography files will have a - variety of names. Since bibtex is invoked with the basename of the - bibliography file, the setting for the bibtex command should therefore + ument with several bibliographies, the bibliography files will have a + variety of names. Since bibtex is invoked with the basename of the + bibliography file, the setting for the bibtex command should therefore be $bibtex = 'bibtex %O %B'; - Generally, you should use %B rather than %R. Similarly for most pur- + Generally, you should use %B rather than %R. Similarly for most pur- poses, the name %T of the primary texfile is not a useful placeholder. - 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 like latex, of course. But for previewers, the command should normally - run detached, so that latexmk gets the previewer running and then + run detached, so that latexmk gets the previewer running and then returns 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 + 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 + Notes: (1) In some circumstances, latexmk will always run a command detached. 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 + 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 - name of a command includes spaces, since software is often installed in - a subdirectory of "C:\Program Files". Such command names should be - enclosed in double quotes, as in - - $lpr_pdf = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p - %S'; - $pdf_previewer = 'start "c:/Program Files/SumatraPDF/Suma- - traPDF.exe" %O %S'; - 12 December 2017 24 + 17 January 2018 24 @@ -1588,35 +1588,43 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - $pdf_previewer = 'start "c:/Program Files/SumatraPDF (x86)/Suma- + name of a command includes spaces, since software is often installed in + a subdirectory of "C:\Program Files". Such command names should be + enclosed in double quotes, as in + + $lpr_pdf = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p + %S'; + $pdf_previewer = 'start "c:/Program Files/SumatraPDF/Suma- + traPDF.exe" %O %S'; + $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: $dvi_previewer = 'start %S'; 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. @@ -1625,63 +1633,63 @@ 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- - tion starting with "internal", as in - $latex = 'internal mylatex %O %S'; - sub mylatex { - my @args = @_; + 17 January 2018 25 - 12 December 2017 25 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1) General Commands Manual LATEXMK(1) + $latex = 'latex --src-specials %O %S'; + Running a subroutine instead of an external command: Use a specifica- + tion starting with "internal", as in + $latex = 'internal mylatex %O %S'; + sub mylatex { + my @args = @_; # Possible preprocessing here return system 'latex', @args; } - For some of the more exotic possibilities that then become available, - see the section "ADVANCED CONFIGURATION: Some extra resources and - advanced 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 + advanced 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 + Advanced tricks: Normally one specifies a single command for the com- + mands invoked by latexmk. Naturally, if there is some complicated additional 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 - file you need to run another program after pdflatex to perform some + 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 extra 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'; - This definition assumes you are using a UNIX-like system (which - includes 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 + includes 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 @@ -1689,9 +1697,9 @@ 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. @@ -1700,18 +1708,10 @@ 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 temporary - directory and then moved to the final location. (This applies - to dvips, dvipdf, and ps2pdf operations, and the filtering oper- - ators on dvi and ps files. It does not apply to pdflatex, - 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 - these files can occupy a substantial time. If a viewer (notably - 12 December 2017 26 + 17 January 2018 26 @@ -1720,64 +1720,64 @@ LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES LATEXMK(1) General Commands Manual LATEXMK(1) - gv) sees that the file has changed, it may read the new file - before the program writing the file has not yet finished its + directory and then moved to the final location. (This applies + to dvips, dvipdf, and ps2pdf operations, and the filtering oper- + ators on dvi and ps files. It does not apply to pdflatex, + 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 + these files can occupy a substantial time. If a viewer (notably + gv) sees that the file has changed, it may read the new file + before the program writing the file has not yet finished its work, 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 (pdf)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 - $out_dir, is achieved by giving (pdf)latex the -aux-directory. - Currently (Dec. 2011 and later) this only works on the MiKTeX - version of (pdf)latex. - - 12 December 2017 27 + 17 January 2018 27 @@ -1786,17 +1786,26 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) + written by a run of (pdf)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 + $out_dir, is achieved by giving (pdf)latex the -aux-directory. + Currently (Dec. 2011 and later) this only works on the MiKTeX + version of (pdf)latex. + 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. $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 @@ -1805,7 +1814,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. @@ -1814,36 +1823,27 @@ 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. 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 + This is an array variable, now mostly obsolete, that specifies + directories where latexmk should look for .bib files. By default 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. + 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: @BIBINPUTS = ( ".", "C:\\bibfiles" ); - @BIBINPUTS = ( ".", "\\server\bibfiles" ); - @BIBINPUTS = ( ".", "C:/bibfiles" ); - @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 - - 12 December 2017 28 + 17 January 2018 28 @@ -1852,19 +1852,28 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) + @BIBINPUTS = ( ".", "\\server\bibfiles" ); + @BIBINPUTS = ( ".", "C:/bibfiles" ); + @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 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"] @@ -1876,68 +1885,68 @@ 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 - files; always delete .bbl files in a cleanup. + the bbl files, without testing for the existence of the bib - $cleanup_includes_cusdep_generated [0] - 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.) + 17 January 2018 29 - 12 December 2017 29 +LATEXMK(1) General Commands Manual LATEXMK(1) + files; always delete .bbl files in a cleanup. -LATEXMK(1) General Commands Manual LATEXMK(1) + $cleanup_includes_cusdep_generated [0] + 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 - detected in log file as being generated (see the \openout lines - in the log file). It will also include files made from these + If nonzero, specifies that cleanup also deletes files that are + detected in log file as being generated (see the \openout lines + in the log file). It will also include files made from these first generation generated 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 except - for dep and aux files. (There is also extra cleaning as speci- - fied by the $clean_ext, $clean_full_ext and @generated_exts + If nonzero, specifies cleanup mode: 1 for full cleanup, 2 for + cleanup except for dvi, ps and pdf files, 3 for cleanup except + for dep and aux files. (There is also extra cleaning as speci- + fied 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. @@ -1948,34 +1957,25 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $clean_ext = "out %R-blx.bib %R-figures*.log"; 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, and - %R-figures*.log, where FOO stands for the basename of the file + tion is specified, not only is the standard set of files + deleted, but also files of the form FOO.out, FOO-blx.bib, and + %R-figures*.log, where FOO stands for the basename of the file being processed (as in FOO.tex). $clean_full_ext [""] - Extra extensions of files for latexmk to remove when the -C + Extra extensions of files for latexmk to remove when the -C option 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. - $compiling_cmd [undefined], $failure_cmd [undefined], $success_cmd + $compiling_cmd [undefined], $failure_cmd [undefined], $success_cmd [undefined] - These variables specify commands that are executed at certain - points of compilations during preview-continuous mode. One - motivation for their existance is to allow convenient visual - indications of compilation status even when the window receiving - the screen output of the compilation is hidden. - - The commands are executed at the following points: $compil- - ing_cmd at the start of compilation, $success_cmd at the end of - a successful compilation, and $failure_cmd at the end of an - 12 December 2017 30 + 17 January 2018 30 @@ -1984,89 +1984,98 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - unsuccessful compilation. If any of above variables is unde- - fined (the default situation) or blank, then the corresponding + These variables specify commands that are executed at certain + points of compilations during preview-continuous mode. One + motivation for their existance is to allow convenient visual + indications of compilation status even when the window receiving + the screen output of the compilation is hidden. + + The commands are executed at the following points: $compil- + ing_cmd at the start of compilation, $success_cmd at the end of + a successful compilation, and $failure_cmd at the end of an + unsuccessful compilation. If any of above variables is unde- + fined (the default situation) or blank, then the corresponding command is not executed. An example of a typical 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\""; - $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 win- dow 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. @cus_dep_list [()] 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 - default list. In that case you can specify the excluded files + But sometimes you want to exclude particular files from this + default 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 is a not a standard alone LaTeX file but a file input by + to 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 - @default_files = ("*.tex"); - @default_excluded_files = ("common.tex"); - 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 - @default_files and having to update the list every time you - change the set of files to be processed. + 17 January 2018 31 - 12 December 2017 31 +LATEXMK(1) General Commands Manual LATEXMK(1) + @default_files = ("*.tex"); -LATEXMK(1) General Commands Manual LATEXMK(1) + @default_excluded_files = ("common.tex"); + If you have a variable or large number of files to be processed, + this method saves you from having to list them in detail in + @default_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 pro- - cesses all tex files specified in the @default_files variable, - which by default is set to all tex files ("*.tex") in the cur- - rent directory. This is a convenience: just run latexmk and it - will process an appropriate set of files. But sometimes you + If no filenames are specified on the command line, latexmk pro- + cesses all tex files specified in the @default_files variable, + which by default is set to all tex files ("*.tex") in the cur- + rent directory. This is a convenience: just run latexmk and it + will process an appropriate set of files. But sometimes you want only some of these files to be processed. In this case you - 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: @@ -2077,37 +2086,28 @@ LATEXMK(1) General Commands Manual LATEXMK(1) @default_files = ("*.tex", "*.dtx"); - Note that more than file may be given, and that the default - extension is ".tex". Wild cards are allowed. The parentheses + Note that more than file may be given, and that the default + extension 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 + 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 updating 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 - the screen). - - $do_cd [0] - Whether to change working directory to the directory specified - - 12 December 2017 32 + 17 January 2018 32 @@ -2116,130 +2116,130 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - for the main source file before processing it. The default + $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 + the screen). + + $do_cd [0] + Whether to change working directory to the directory specified + for the main source file before processing it. The default behavior is not to do this, which is the same as the behavior of - latex and pdflatex programs. This variable is set by the -cd + latex and pdflatex programs. This variable is set by the -cd and -cd- options on latexmk's command line. $dvi_filter [empty] - The dvi file filter to be run on the newly produced dvi file - before other processing. Equivalent to specifying the -dF + The dvi file filter to be run on the newly produced dvi file + before other processing. Equivalent to specifying the -dF option. $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 - requests 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 + requests 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 %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 dif- + to use the dvipdfm command, which needs its arguments in a dif- ferent order: - $dvipdf = "dvipdfm %O -o %D %S"; - - 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 - pdf" to ensure that type 1 fonts are used in the pdf file. + 17 January 2018 33 - 12 December 2017 33 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1) General Commands Manual LATEXMK(1) + $dvipdf = "dvipdfm %O -o %D %S"; + 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 + 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 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 + 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 included 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 + How the dvi viewer updates its display when the dvi file has + changed. The values here apply equally to the $pdf_update_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- - ple of updating by command. - - $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 - - 12 December 2017 34 + 17 January 2018 34 @@ -2248,81 +2248,154 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - is updated by sending a signal -- see the information on the - variable $dvi_update_method. The default value is the one + 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 + 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 appropriate for xdvi on a UNIX system. $failure_cmd [undefined] 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 + [30]. (Units of seconds.) + + These variables control how latexmk deals with the following + issue, which can affect the use of files that are on a remote + filesystem (network share) instead of being on a file system + local to the computer running latexmk. Almost users will not + have to worry about these settings, and can ignore the following + explanation. + + 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., (pdf)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 ear- + lier 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 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 + (a second or so, or a few seconds). But even a small difference + can mess up latexmk's test. + + Latexmk measures the time difference between the time on the two + 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 + + + + 17 January 2018 35 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + + 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 + 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 + 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 has two uses: (a) to set the kinds of file to be + This list has two uses: (a) to set the kinds of file to be deleted in a cleanup operation (with the -c, -C, -CA, -g and -gg - options), and (b) in the determination of whether a rerun of + options), and (b) in the determination of whether a rerun of (pdf)LaTeX is needed after a run that gives an error. (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 occur until the user has - made a change in the files. But the user may have corrected an + 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 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 automatically generated files; it - determines the automatically generated files as those with + determines the automatically generated files as those with extensions in the list in @generated_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 line in an RC file. E.g., push @generated_exts, "end"; - adds the extension "end" to the list of predefined generated - extensions. (This extension is used by the RevTeX package, for + adds the extension "end" to the list of predefined generated + extensions. (This extension is used by the RevTeX package, for example.) - $go_mode [0] - 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!!! + 17 January 2018 36 - 12 December 2017 35 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1) General Commands Manual LATEXMK(1) + $go_mode [0] + 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. @@ -2331,47 +2404,40 @@ 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 + 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 extension .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 - expression. The simplest method is separate the different sim- - ple patterns by a vertical bar character (indicating "alterna- + 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 + expression. The simplest method is separate the different sim- + ple patterns by a vertical bar character (indicating "alterna- tion" in the jargon of regular expressions). For example, - $hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: + $hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: |^%%Title: '; - causes lines starting with either "^%%CreationDate: " or + causes lines starting with either "^%%CreationDate: " or "^%%Title: " to be ignored. - 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'}; - $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- - cient path information to be found directly. But sometimes, - notably 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, - but not its path. The program specified by $kpsewhich is used to - 12 December 2017 36 + 17 January 2018 37 @@ -2380,64 +2446,64 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) + $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- + cient path information to be found directly. But sometimes, + notably 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, + but not its path. The program specified by $kpsewhich is used to find it. - (For advanced users: Because of the different way in which - latexmk uses the command specified in $kpsewhich, some of the - possibilities listed in the FORMAT OF COMMAND SPECIFICATIONS do + (For advanced users: Because of the different way in which + latexmk uses the command specified in $kpsewhich, some of the + possibilities listed in the FORMAT OF COMMAND SPECIFICATIONS do not apply. The internal and start keywords are not available. A simple command specification with possible options and then "%S" - is all that is guaranteed to work. Note that for other com- + is all that is guaranteed to work. Note that for other com- mands, "%S" is substituted by a single source file. In contrast, for $kpsewhich, "%S" may be substituted by a long list of space- - separated filenames, each of which is quoted. The result on + separated filenames, each of which is quoted. The result on STDOUT of running the command is then piped to latexmk.) - See also the @BIBINPUTS variable for another way that latexmk + See also the @BIBINPUTS variable for another way that latexmk also uses to try to locate files; it applies only in the case of .bib files. $kpsewhich_show [0] - Whether to show diagnostics about invocations of kpsewhich: the - command line use to invoke it and the results. These diagnos- - tics are shown if $kpsewhich_show is non-zero or if diagnostics - mode is on. (But in the second case, lots of other diagnostics - are also shown.) Without these diagnostics there is nothing - visible in latexmk's screen output about invocations of kpse- + 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"] The LaTeX processing program. Note that as with other programs, - you can use this variable not just to change the name of the + 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"; %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 - 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 + In this situation, latexmk searches for custom dependencies to - 12 December 2017 37 + 17 January 2018 38 @@ -2446,8 +2512,15 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - variable %pdflatex_input_extensions, add_input_ext and - remove_input_ext. They are used as in the following examples + 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_input_ext. They are used as in the following examples are possible lines in an initialization file: remove_input_ext( 'latex', 'tex' ); @@ -2456,19 +2529,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 - its graphics/graphicx packages. + 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- @@ -2478,76 +2551,75 @@ 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. - $lpr_dvi ["NONE lpr_dvi"] - The printing program to print dvi files. - - $lpr_pdf ["NONE lpr_pdf"] - The printing program to print pdf files. + 17 January 2018 39 - 12 December 2017 38 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1) General Commands Manual LATEXMK(1) + $lpr_dvi ["NONE lpr_dvi"] + The printing program to print dvi files. + $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 + Under MS-Windows you could set this to use gsview, if it is installed, e.g., $lpr = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p'; - If gsview is installed in a different directory, you will need - to make the appropriate change. Note the double quotes around + If gsview is installed in a different directory, you will need + to make the appropriate change. Note the double quotes around the name: this is necessary because one part of the command name ("Program Files") contains a space which would otherwise be mis- interpreted. $lualatex ["lualatex %O %S"] - The LaTeX processing program that is to be used when the luala- + The LaTeX processing program that is to be used when the luala- tex program is called for (e.g., by the option -lualatex. %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 + 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 \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 %pdflatex_input_extensions. The + 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 default 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"] @@ -2557,19 +2629,13 @@ LATEXMK(1) General Commands Manual LATEXMK(1) The index processing program. $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/pdflatex - before deciding that there may be an infinite loop and that it - needs to bail out, rather than rerunning latex/pdflatex again to - resolve cross-references, etc. The default value covers all - normal cases. - 12 December 2017 39 + 17 January 2018 40 @@ -2578,64 +2644,64 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - (Note that the "etc" covers a lot of cases where one run of + $max_repeat [5] + The maximum number of times latexmk will run latex/pdflatex + before deciding that there may be an infinite loop and that it + needs to bail out, rather than rerunning latex/pdflatex 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 latex/pdflatex generates files to be read in on a later run.) $MSWin_back_slash [1] - This configuration variable only has an effect when latexmk is + This configuration variable only has an effect when latexmk is running under MS-Windows. It determines whether, when a command - is executed under MS-Windows, there should be substituted "\" - for the separator character between components of a directory - name. Internally, latexmk uses "/" for the directory separator + is executed under MS-Windows, there should be substituted "\" + for the separator character between components of a directory + name. Internally, latexmk uses "/" for the directory separator character, which is the character used by Unix-like systems. For many programs under MS-Windows, both "\" and "/" are accept- - able as the directory separator character. But some programs - only accept "\" on the command line. So for safety latexmk - makes a translation, by default. It is conceivable that under + able as the directory separator character. But some programs + only accept "\" on the command line. So for safety latexmk + makes a translation, by default. It is conceivable that under certain situations this is undesirable, so the configuration can be changed. (A possible example might be when some of the soft- - ware is implemented using Cygwin, which provides a Unix-like + ware is implemented using Cygwin, which provides a Unix-like environment inside MS-Windows.) $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 (pdf)latex. See also the variable $aux_dir. - The effect of this variable (when non-blank) is achieved by - using the -output-directory option of (pdf)latex. This exists - in the usual current (Dec. 2011 and later) implementations of - TeX, i.e., MiKTeX and TeXLive. But it may not be present in + The effect of this variable (when non-blank) is achieved by + using the -output-directory option of (pdf)latex. This exists + in the 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 - current working directory or one of its subdirectories. This is - 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 + ify some other directory, e.g., "/tmp/foo" or "../output", be + aware that this could cause problems, e.g., with makeindex or - 12 December 2017 40 + 17 January 2018 41 @@ -2644,34 +2710,41 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - do need to specify an absolute pathname (e.g., "/tmp/foo") or a + 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 + 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 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 + variable openout_any to "a" (as in "all"), to override the default "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- - able. If equal to 4, generate a pdf version of the document - using lualatex, using the command specified by the $lualatex - variable. If equal to 5, generate a pdf version (and an xdv + 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 + using lualatex, using the command specified by the $lualatex + variable. If equal to 5, generate a pdf version (and an xdv version) of the document using xelatex, using the commands spec- ified 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. $pdflatex ["pdflatex %O %S"] - The LaTeX processing program in a version that makes a pdf file + The LaTeX processing program in a version that makes a pdf file instead of a dvi file. An example use of this variable is to add certain options to the @@ -2679,95 +2752,88 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $pdflatex = "pdflatex --shell-escape %O %S"; - (In some earlier versions of latexmk, you needed to use an - assignment to $pdflatex to allow the use of lualatex or xelatex + (In some earlier versions of latexmk, you needed to use an + assignment 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.) %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 + 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 \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 %pdflatex_input_extensions. The - default extensions are 'tex', 'pdf', 'jpg, and 'png'. + 17 January 2018 42 - 12 December 2017 41 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1) General Commands Manual LATEXMK(1) + 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 + default 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 """; + On MS-Windows, the default is changed to "cmd /c start """; under 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 - -pvc) under MS-windows. This problem does not occur if, for + 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 example, SumatraPDF or gsview is used to view pdf files. - Important note: Normally you will want to have a previewer run + Important note: Normally you will want to have a previewer run detached, so that latexmk doesn't wait for the previewer to ter- - minate before continuing its work. So normally you should pre- - fix the command by "start ", which flags to latexmk that it - should do the detaching of the previewer itself (by whatever - method is appropriate to the operating system). But sometimes + minate before continuing its work. So normally you should pre- + fix the command by "start ", which flags to latexmk that it + should do the detaching of the previewer itself (by whatever + method is appropriate to the operating system). But sometimes letting latexmk do the detaching is not appropriate (for a vari- - ety of non-trivial reasons), so you should put the "start " bit + ety of non-trivial reasons), so you should put the "start " bit in yourself, whenever it is needed. $pdf_update_command [""] - When the pdf previewer is set to be updated by running a com- - mand, this is the command that is run. See the information for + When the pdf previewer is set to be updated by running a com- + mand, this is the command that is run. See the information for the variable $pdf_update_method. - $pdf_update_method [1 under UNIX, 3 under MS-Windows] - How the pdf viewer updates its display when the pdf file has - changed. See the information on the variable $dvi_update_method - 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 - specified by $pdf_update_signal.) - 12 December 2017 42 + + 17 January 2018 43 @@ -2776,6 +2842,15 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) + $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 + 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 + specified by $pdf_update_signal.) + Note that acroread under MS-Windows (but not UNIX) locks the pdf file, so the default value is then 3. @@ -2786,54 +2861,45 @@ 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 + 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 updating 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 + 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 appropriate for gv on a UNIX system. $pid_position[1 under UNIX, -1 under MS-Windows] - The variable $pid_position is used to specify which word in - lines of the output from $pscmd corresponds to the process ID. - The first word in the line is numbered 0. The default value of + The variable $pid_position is used to specify which word in + lines of the output from $pscmd corresponds to the process ID. + The first word in the line is numbered 0. The default value of 1 (2nd word in line) is correct for Solaris 2.6, Linux, and OS-X with their default settings of $pscmd. - Setting the variable to -1 is used to indicate that $pscmd is + Setting the variable to -1 is used to indicate that $pscmd is not to be used. $postscript_mode [0] - If nonzero, generate a postscript version of the document. + If nonzero, generate a postscript version of the document. Equivalent to the -ps option. - If some other request is made for which a postscript file is + If some other request is made for which a postscript file is needed, then $postscript_mode will be set to 1. $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 - $view. - - $printout_mode [0] - If nonzero, print the document using the command specified in - - 12 December 2017 43 + 17 January 2018 44 @@ -2842,28 +2908,36 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) + $preview_mode [0] + If nonzero, run a previewer to preview the document. Equivalent + to the -pv option. Which previewer is run depends on the other + settings, see the command line options -view=, and the variable + $view. + + $printout_mode [0] + If nonzero, print the document using the command specified in the $lpr variable. Equivalent to the -p option. This is recom- - mended not to be set from an RC file, otherwise you could waste + mended not to be set from an RC file, otherwise you could waste lots of paper. $print_type = ["auto"] - Type of file to printout: possibilities are "auto", "dvi", + Type of file to printout: possibilities are "auto", "dvi", "none", "pdf", or "ps". See the option -print= for the meaning of the "auto" value. $pscmd Command used to get all the processes currently run by the user. - The -pvc option uses the command specified by the variable - $pscmd to determine if there is an already running previewer, - and to find the process ID (needed if latexmk needs to signal + The -pvc option uses the command specified by the variable + $pscmd to determine if there is an already running previewer, + and to find the process ID (needed if latexmk needs to signal the previewer about file changes). Each line of the output of this command is assumed to correspond - to one process. See the $pid_position variable for how the + to one process. See the $pid_position variable for how the process number is determined. - The default for pscmd is "NONE" under MS-Windows and cygwin - (i.e., the command is not used), "ps -ww -u $ENV{USER}" under - OS-X, and "ps -f -u $ENV{USER}" under other operating systems + The default for pscmd is "NONE" under MS-Windows and cygwin + (i.e., the command is not used), "ps -ww -u $ENV{USER}" under + OS-X, and "ps -f -u $ENV{USER}" under other operating systems (including Linux). In these specifications "$ENV{USER}" is sub- stituted by the username. @@ -2872,34 +2946,26 @@ 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- - Windows will cause to be run whatever command the system has + The command to invoke a ps-previewer. (The default under MS- + Windows will cause to be run whatever command the system has associated 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 - perhaps not one actually called gv. - - Important note: Normally you will want to have a previewer run - detached, so that latexmk doesn't wait for the previewer to ter- - minate before continuing its work. So normally you should pre- - fix the command by "start ", which flags to latexmk that it - should do the detaching of the previewer itself (by whatever - method is appropriate to the operating system). But sometimes + of gv under different names, e.g., ggv, kghostview, etc, but - 12 December 2017 44 + 17 January 2018 45 @@ -2908,39 +2974,72 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) + perhaps not one actually called gv. + + Important note: Normally you will want to have a previewer run + detached, so that latexmk doesn't wait for the previewer to ter- + minate before continuing its work. So normally you should pre- + fix the command by "start ", which flags to latexmk that it + should do the detaching of the previewer itself (by whatever + method is appropriate to the operating system). But sometimes letting latexmk do the detaching is not appropriate (for a vari- - ety of non-trivial reasons), so you should put the "start " bit + ety of non-trivial reasons), so you should put the "start " bit in yourself, whenever it is needed. - $ps_previewer_landscape ["start gv -swap %O %S", but start %O %S under + $ps_previewer_landscape ["start gv -swap %O %S", but start %O %S under MS-Windows] The command to invoke a ps-previewer in landscape mode. $ps_update_command [""] - When the postscript previewer is set to be updated by running a - command, this is the command that is run. See the information + When the postscript previewer is set to be updated by running a + command, this is the command that is run. See the information for the variable $ps_update_method. $ps_update_method [0 under UNIX, 1 under MS-Windows] - How the postscript viewer updates its display when the ps file - has changed. See the information on the variable - $dvi_update_method for the codes. (Note that information needs + How the postscript viewer updates its display when the ps 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 - $ps_update_command, and for the value 2, to specify update by + $ps_update_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 + taken any actions like compiling the document. The period of + inactivity is in the variable $pvc_timeout_mins. + + + $pvc_timeout_mins [30] + The period of inactivity, in minutes, after which pvc mode times + out. This is used if $pvc_timeout is nonzero. + $pvc_view_file_via_temporary [1] The same as $always_view_file_via_temporary, except that it only applies in preview-continuous mode (-pvc option). + + + + + 17 January 2018 46 + + + + + +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 @@ -2961,20 +3060,8 @@ LATEXMK(1) General Commands Manual LATEXMK(1) 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 then use this file to improve its detection of - source files and generated files after a run of latex or - - - - 12 December 2017 45 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - - pdflatex. + source files and generated files after a run of latex or pdfla- + tex. It is generally recommended to use this option (or to configure the $recorder variable to be on.) But it only works if @@ -3007,6 +3094,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) 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 + + + + 17 January 2018 47 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + software is running under an emulator for the other kind of operating system; in that case you'll need to find out what is needed, and set $search_path_separator explicitly. (The same @@ -3028,18 +3127,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -silence_logfile_warning_list and -silence_logfile_warning_list- also set this variable. - - - - 12 December 2017 46 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - Note that multiple occurrences for the same undefined object on the same page and same line will be compressed to a single warn- ing. @@ -3073,6 +3160,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Directory to store temporary files that latexmk may generate while running. + + + + 17 January 2018 48 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + The default under MSWindows (including cygwin), is to set $tmpdir to the value of the first of whichever of the system environment variables TMPDIR or TEMP exists, otherwise to the @@ -3095,17 +3194,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) do this. The intent of calling make from latexmk is merely to detect dependencies. - - - 12 December 2017 47 - - - - - -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 @@ -3139,6 +3227,17 @@ LATEXMK(1) General Commands Manual LATEXMK(1) specified by the variable %xelatex_input_extensions. The default extensions are 'tex', 'pdf', 'jpg, and 'png'. + + + 17 January 2018 49 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + See details of the %latex_input_extensions for other information that equally applies to %xelatex_input_extensions. @@ -3159,19 +3258,6 @@ CUSTOM DEPENDENCIES in the .tex file. - - - - - 12 December 2017 48 - - - - - -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 @@ -3205,9 +3291,21 @@ LATEXMK(1) General Commands Manual LATEXMK(1) The name of the subroutine that latexmk should call to perform the file conversion. The first argument to the subroutine is the base name of the file to be converted without any extension. - The subroutines are declared in the syntax of Perl. The func- - tion should return 0 if it was successful and a nonzero number - if it failed. + The subroutines are declared in the syntax of Perl. The + + + + 17 January 2018 50 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + + function should return 0 if it was successful and a nonzero num- + ber if it failed. Naturally add_cus_dep adds a custom dependency with the specified from @@ -3226,18 +3324,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) extension is the to-extension of a custom dependency. Then latexmk examines whether a file exists with the same name, but with the corre- sponding from-extension, as specified in the custom-dependency rule. - - - - 12 December 2017 49 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - If it does, then the rule is invoked whenever the destination file (the one with the to-extension) is out-of-date with respect to the corre- sponding source file. @@ -3272,6 +3358,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) extension "fig", as created by the xfig program, to an encapsulated postscript file, with extension "eps". The remaining lines define a subroutine that carries out the conversion. If a rule for converting + + + + 17 January 2018 51 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + "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. @@ -3292,18 +3390,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) 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. - - - - 12 December 2017 50 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - If you use pdflatex 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 @@ -3340,6 +3426,16 @@ LATEXMK(1) General Commands Manual LATEXMK(1) need it. + + 17 January 2018 52 + + + + + +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 @@ -3358,18 +3454,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) show_cus_dep(); - - - - 12 December 2017 51 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - in an initialization file. @@ -3407,6 +3491,17 @@ LATEXMK(1) General Commands Manual LATEXMK(1) } push @generated_exts, 'ndx', 'nnd'; + + + 17 January 2018 53 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + Notice the added line compared with earlier examples. The extra line gets the extensions "ndx" and "nnd" added to the list of extensions for generated files; then the extra index files will be deleted by clean-up @@ -3424,18 +3519,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) } push @generated_exts, 'ndx', 'nnd', 'adx', 'and'; - - - - 12 December 2017 52 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - You could also instead use add_cus_dep( 'ndx', 'nnd', 0, 'dx2nd' ); @@ -3474,6 +3557,17 @@ LATEXMK(1) General Commands Manual LATEXMK(1) item, and the name of the subroutine for the custom dependency. These were all defined above. + + + 17 January 2018 54 + + + + + +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 .fig files to .eps files: @@ -3490,18 +3584,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - - - - 12 December 2017 53 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - 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 @@ -3539,6 +3621,19 @@ ADVANCED CONFIGURATION: Some extra resources and advanced tricks This gives the name of the primary source file. Note the double dollar signs. + + + + + 17 January 2018 55 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + $$Pdest This gives the name of the main output file if any. Note the double dollar signs. @@ -3556,18 +3651,6 @@ ADVANCED CONFIGURATION: Some extra resources and advanced tricks example_rcfiles of latexmk's distribution. Currently the cases that use this subroutine are bib2gls-latexmkrc, excel- tex_latexmkrc and texinfo-latexmkrc. These illustrate typical - - - - 12 December 2017 54 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - cases where latexmk's normal processing fails to detect certain extra source files. @@ -3605,6 +3688,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) gram for complex projects, as for software development, with the depen- dencies specified by a Makefile. + + + + 17 January 2018 56 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + Now the basic task of latexmk is to run the appropriate programs to make a viewable version of a LaTeX document. However, the usual make program is not suited to this purpose for at least two reasons. First @@ -3623,17 +3718,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) as created by the xfig program). Custom dependencies are latexmk's equivalent of pattern rules in Makefiles. - - - 12 December 2017 55 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - 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. @@ -3669,9 +3753,21 @@ LATEXMK(1) General Commands Manual LATEXMK(1) 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 + + + + 17 January 2018 57 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + + pattern 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 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 @@ -3688,18 +3784,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) DEPS_DIR = .deps LATEXMK = latexmk -recorder -use-make -deps \ -e 'warn qq(In Makefile, turn off custom dependencies\n);' \ - - - - 12 December 2017 56 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - -e '@cus_dep_list = ();' \ -e 'show_cus_dep();' all : $(TARGETS) @@ -3736,6 +3820,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Suppose in the LaTeX file there is a command \includegraphics{graph}, and an xfig file "graph.fig" exists. On a first run, pdflatex reports + + + + 17 January 2018 58 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + a missing file, named "graph". Latexmk succeeds in making "graph.pdf" by calling "make graph.pdf", and after completion of its work, it lists "fig.pdf" among the dependents of the file latexmk is making. Then let @@ -3755,17 +3851,6 @@ BUGS manually refresh (or reopen) display. Or use one of the other preview- ers and update methods. - - - 12 December 2017 57 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - (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 @@ -3787,7 +3872,7 @@ THANKS TO AUTHOR Current version, by John Collins (username jcc8 at node psu.edu). - (Version 4.54c). + (Version 4.55). Released version can be obtained from CTAN: <http://www.ctan.org/pkg/latexmk/>, and from the author's website @@ -3804,6 +3889,53 @@ AUTHOR + 17 January 2018 59 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + @@ -3823,6 +3955,6 @@ AUTHOR - 12 December 2017 58 + 17 January 2018 60 diff --git a/Master/texmf-dist/scripts/latexmk/latexmk.pl b/Master/texmf-dist/scripts/latexmk/latexmk.pl index 9bc55d134b7..d83a2440ce8 100755 --- a/Master/texmf-dist/scripts/latexmk/latexmk.pl +++ b/Master/texmf-dist/scripts/latexmk/latexmk.pl @@ -121,8 +121,8 @@ use warnings; $my_name = 'latexmk'; $My_name = 'Latexmk'; -$version_num = '4.54c'; -$version_details = "$My_name, John Collins, 12 Dec. 2017"; +$version_num = '4.55'; +$version_details = "$My_name, John Collins, 17 Jan. 2018"; use Config; use File::Basename; @@ -183,7 +183,7 @@ else { warn "Something wrong with the perl configuration: No signals?\n"; } -## Copyright John Collins 1998-2017 +## Copyright John Collins 1998-2018 ## (username jcc8 at node psu.edu) ## (and thanks to David Coppit (username david at node coppit.org) ## for suggestions) @@ -221,107 +221,21 @@ else { ## ## 12 Jan 2012 STILL NEED TO DOCUMENT some items below ## +## 17 Jan 2018 John Collins Version number to 4.55. Ready for release. +## 15, 16 Jan 2018 John Collins Correct bug in measuring filetime offset. +## 14 Jan 2018 John Collins Correct issue with possible filetime offset +## on remote file system. +## Define defaults for configuration variables +## that didn't have defaults. +## 12 Jan 2018 John Collins Implement pvc timeout +## 10 Jan 2018 John Collins Ensure $search_path_separator is defined. +## Set it to MS-Win value for msys. ## 12 Dec 2017 John Collins Further correct bsd_glob fudge (to be in subroutine my_glob) ## 8 Dec 2017 John Collins Correct bsd_glob fudge ## 2 Dec 2017 John Collins Fudge on bsd_glob if it doesn't exist ## 20 Nov 2017 John Collins Ver. 4.54 -## 18 Nov 2017 John Collins Add item to @file_not_found for generic -## package warning about "No file", as produced -## by glossaries-extra. -## In run_bibtex, make change in environment -## be local, not global. -## 4 Sep 2017 John Collins Restore default of $analyze_input_log_always -## to 1. This restores the default detection -## of certain constructs for dependencies for -## input files in the .log file. See the -## comments on this variable. This corrects -## a problem caused by a change in the -## behavior of lualatex in TeXLive 2017. -## 2 Sep 2017 John Collins Remove insertion of name of deps file in -## list of targets in deps file. -## Don't print deps info in deps mode (unless -## diagnostics on). -## 1 Sep 2017 John Collins Customized default previewers for MSys -## 14 Jul 2017 John Collins Correct collection of timing information so -## that it works even in silent mode -## 14 Jun 2017 John Collins Extra value for $bibtex_use -## 12 Jun 2017 John Collins Change glob to bsd_glob, since -## File::Glob's glob is now deprecated. -## Remove unused glob_list. -## 16 May 2017 John Collins Optimize away current directory string in -## $out_dir and $aux_dir. -## 15 May 2017 John Collins Fix incorrect deletion of non-generated -## aux files. -## 13 May 2017 John Collins Correct ordering of list of options given -## by -help -## 6 Apr 2017 John Collins In deps_list, correct bug in identifying -## generated files. Otherwise, generated files -## may be identified as true source files. -## 19 Jan 2017 John Collins Make -jobname work with -pdfxe and -pdflua -## 18 Jan 2017 John Collins Update to v. 4.53. -## 17 Jan 2017 John Collins Update to v. 4.52b (official release). -## Fix bbl file detection bug. -## Bbl files were previously only identified -## from occurrence as input files in log -## file rather than from fls as well. -## 16 Jan 2017 John Collins Clean up -## Add extra item to @file_not_found for -## xelatex's characteristic message. -## 14 Jan 2017 John Collins Fix some diagnostics. -## Detect graphics candidates in log file from -## <...> constructs. -## Don't look in log file for input files in the -## (...) and <...> constructs unless forced to -## by lack of up-to-date fls file. -## 13 Jan 2017 John Collins Kpsewhich diagnostics: also if not -## silent, or when $kpsewhich_show set. -## Optimize calls to kpsewhich to find files -## given by lines put in log file by -## graphics package. -## Work around LuaTeX line-wrapping bug. (LuaTeX 0.95.0) -## 12 Jan 2017 John Collins Improve error reporting on failed run. -## 11 Jan 2017 John Collins With -diagnositcs, include invocation -## and results for kpsewhich. -## 4, 10 Jan 2017 John Collins Finish fix for read-after-write files -## 29-31 Dec 2016 John Collins V. 4.51 -## For biber and bibtex rules, included .blg -## file as extra generated file. -## Similarly for makeindex rule -## 3 Nov 2016 John Collins Start to fix problem reported by jfbu -## that with deleted aux file, latexmk -## does too few runs. -## Problems: -## 1. latexmk doesn't create initial -## dummy aux or fdb when only one -## fails to exist, but only when -## both fail to exist. -## 2. latexmk detects the aux file as -## only read after write, and -## hence not a true dependent. -## That is the initial attempt to -## read, giving a No file message, -## is not recorded in the fls -## file. -## First fix: missing aux file => make -## dummy. -## Need better: if source file in fdb -## doesn't exist initially, then it -## should be counted as initially -## read, so not read after write. -## 18 Oct 2016 John Collins xelatex support via xdv file for speed. -## lualatex -## 5 Sep 2016 John Collins Add routines: rdb_list_source, rdb_set_source -## 17 Aug 2016 John Collins Add XDG Base Directory compatibility -## for per-user rc file -## 1 May 2016 John Collins Correct creation of output and aux directories -## to correctly handle relative paths when -cd -## is used. -## 22 Apr 2016 John Collins Fix problem of -C not always working correctly -## when compilation was with -pdf and clear was default. -## (Correctly default set of rules in rdb_make_rule_list.) -## Ver. 4.45 ## -## 1998-2010, John Collins. Many improvements and fixes. +## 1998-2017, John Collins. Many improvements and fixes. ## See CHANGE-log.txt for full list, and CHANGES for summary ## ## Modified by Evan McLean (no longer available for support) @@ -664,9 +578,8 @@ $print_type = 'auto'; # When printing, print the postscript file. ## Current tex's treat extensions like UNIX teTeX: $extension_treatment = 'unix'; -## Substitute backslashes in file and directory names for -## MSWin command line -$MSWin_back_slash = 1; +# Viewers. These are system dependent, so default to none: +$pdf_previewer = $ps_previewer = $ps_previewer_landscape = $dvi_previewer = $dvi_previewer_landscape = "NONE"; $dvi_update_signal = undef; $ps_update_signal = undef; @@ -682,6 +595,23 @@ $new_viewer_always = 0; # If 1, always open a new viewer in pvc mode. # If 0, only open a new viewer if no previous # viewer for the same file is detected. +# Commands for printing are highly system dependent, so default to NONE: +$lpr = 'NONE $lpr variable is not configured to allow printing of ps files'; +$lpr_dvi = 'NONE $lpr_dvi variable is not configured to allow printing of dvi files'; +$lpr_pdf = 'NONE $lpr_pdf variable is not configured to allow printing of pdf files'; + + +# The $pscmd below holds a **system-dependent** command to list running +# processes. It is used to find the process ID of the viewer looking at +# the current output file. The output of the command must include the +# process number and the command line of the processes, since the +# relevant process is identified by the name of file to be viewed. +# Its use is not essential. +$pscmd = 'NONE $pscmd variable is not configured to detect running processes'; +$pid_position = -1; # offset of PID in output of pscmd. + # Negative means I cannot use ps + + $quote_filenames = 1; # Quote filenames in external commands $del_dir = ''; # Directory into which cleaned up files are to be put. @@ -729,6 +659,55 @@ $MSWin_fudge_break = 1; # Give special treatment to ctrl/C and ctrl/break # back to a command prompt, while latexmk # keeps running in the background! +## Substitute backslashes in file and directory names for +## MSWin command line +$MSWin_back_slash = 1; + +## Separator of elements in search_path. Default is unix value +$search_path_separator = ':'; + + +# Directory for temporary files. Default to current directory. +$tmpdir = "."; + + +# When the aux_dir is on a network share (or the like), its system +# time may differ from the system time on which latexmk is running. +# This complicates the tests of whether particular files have been +# made in a current run of a program or are left over from a previous +# run. One test, which is needed under some situations, is that a +# file was made on a previous run when the files modification time is +# less than the system time when the program is started. (See +# subroutine test_gen_file; this is only needed in a couple of +# situations.) The comparison between file and system times must be +# corrected if there is an offset between system times on the computer +# running latexmk and the computer hosting the file system containing +# aux_dir. The offset is measured in subroutine get_filetime_offset +# by writing a temporary file; the test only needs to be done once. +# +# The following variables are used. Since the system-independent +# values of system and file time are only accurate to a second (or 2 +# seconds for FAT file systems), the offset is also accurate only to a +# second or two. So thresholds are needed below which differences +# are insignificant. +# +# Note that the making or not making of a file is controlled by the +# state of the document being compiled and by latexmk's configuration. +# So a file that is left over from a previous run and not overwritten +# on the current run will have a file time at least many seconds less +# than the current time, corresponding to the time scale for a human +# run-edit-run cycle. +# +$filetime_offset_measured = 0; # Measurement not yet done. +$filetime_offset = 0; # Filetime relative to system time. +$filetime_causality_threshold = 5; # Threshold for detection of left-over file. + # Should be non-negative always, and should + # be bigger than 2 secs if a remote + # filesystem or network share is used. +$filetime_offset_report_threshold = 30; # Threshold beyond which filetime offsets + # are reported; large offsets indicate + # incorrect system time on at least one system. + ################################################################ @@ -778,23 +757,6 @@ if ( $^O eq "MSWin32" ) { $dvi_update_method = 1; $ps_update_method = 1; $pdf_update_method = 3; # acroread locks the pdf file - # Use NONE as flag that I am not implementing some commands: - $lpr = - 'NONE $lpr variable is not configured to allow printing of ps files'; - $lpr_dvi = - 'NONE $lpr_dvi variable is not configured to allow printing of dvi files'; - $lpr_pdf = - 'NONE $lpr_pdf variable is not configured to allow printing of pdf files'; - # The $pscmd below holds a command to list running processes. It - # is used to find the process ID of the viewer looking at the - # current output file. The output of the command must include the - # process number and the command line of the processes, since the - # relevant process is identified by the name of file to be viewed. - # Its use is not essential. - $pscmd = - 'NONE $pscmd variable is not configured to detect running processes'; - $pid_position = -1; # offset of PID in output of pscmd. - # Negative means I cannot use ps } elsif ( $^O eq "cygwin" ) { # The problem is a mixed MSWin32 and UNIX environment. @@ -893,34 +855,11 @@ elsif ( $^O eq "cygwin" ) { $dvi_update_method = 1; $ps_update_method = 1; $pdf_update_method = 3; # acroread locks the pdf file - # Use NONE as flag that I am not implementing some commands: - $lpr = - 'NONE $lpr variable is not configured to allow printing of ps files'; - $lpr_dvi = - 'NONE $lpr_dvi variable is not configured to allow printing of dvi files'; - $lpr_pdf = - 'NONE $lpr_pdf variable is not configured to allow printing of pdf files'; - # The $pscmd below holds a command to list running processes. It - # is used to find the process ID of the viewer looking at the - # current output file. The output of the command must include the - # process number and the command line of the processes, since the - # relevant process is identified by the name of file to be viewed. - # Its use is not essential. - # When the OS is detected as cygwin, there are two possibilities: - # a. Latexmk was run from an NT prompt, but cygwin is in the - # path. Then the cygwin ps command will not see commands - # started from latexmk. So we cannot use it. - # b. Latexmk was started within a cygwin environment. Then - # the ps command works as we need. - # Only the user, not latemk knows which, so we default to not - # using the ps command. The user can override this in a - # configuration file. - $pscmd = - 'NONE $pscmd variable is not configured to detect running processes'; - $pid_position = -1; # offset of PID in output of pscmd. - # Negative means I cannot use ps } elsif ( $^O eq "msys" ) { + $search_path_separator = ';'; # Separator of elements in search_path + # I think MS-Win value is OK, since + # msys is running under MS-Win $pdf_previewer = q[sh -c 'start %S']; $ps_previewer = q[sh -c 'start %S']; $dvi_previewer = q[sh -c 'start %S']; @@ -929,9 +868,7 @@ elsif ( $^O eq "msys" ) { } else { # Assume anything else is UNIX or clone - - ## Configuration parameters: - + # Do special cases (e.g., linux, darwin (i.e., OS-X)) inside this block. ## Use first existing case for $tmpdir: $tmpdir = $ENV{TMPDIR} || '/tmp'; @@ -1227,6 +1164,10 @@ $preview_mode = 0; $preview_continuous_mode = 0; $printout_mode = 0; # Don't print the file +## Control pvc inactivity timeout: +$pvc_timeout = 0; +$pvc_timeout_mins = 30; + $show_time = 0; @timings = (); $processing_time1 = processing_time(); @@ -1726,6 +1667,9 @@ while ($_ = $ARGV[0]) $printout_mode = 0; } elsif (/^-pvc-$/) { $preview_continuous_mode = 0; } + elsif (/^-pvctimeout$/) { $pvc_timeout = 1; } + elsif (/^-pvctimeout-$/) { $pvc_timeout = 0; } + elsif (/^-pvctimeoutmins=(.*)$/) { $pvc_timeout_mins = $1; } elsif (/^-recorder$/ ){ $recorder = 1; } elsif (/^-recorder-$/ ){ $recorder = 0; } elsif (/^-rules$/ ) { $rules_list = 1; } @@ -2134,6 +2078,13 @@ if ( $pdf_mode == 2 ) { add_option( "$dvips_pdf_switch", \$dvips ); } +# Restrict variables to allowed values: + +if ($filetime_causality_threshold < 0) { + warn "$My_name: Correcting negative value of \$filetime_causality_threshold to zero.\n"; + $filetime_causality_threshold = 0; +} + # Note sleep has granularity of 1 second. # Sleep periods 0 < $sleep_time < 1 give zero delay, # which is probably not what the user intended. @@ -3143,6 +3094,8 @@ sub make_preview_continuous { # Loop forever, rebuilding .dvi and .ps as necessary. # Set $first_time to flag first run (to save unnecessary diagnostics) + my $last_action_time = time(); + my $timed_out = 0; CHANGE: for (my $first_time = 1; 1; $first_time = 0 ) { my %rules_to_watch = %requested_filerules; @@ -3258,6 +3211,7 @@ CHANGE: # latexmk -pvc foo; cleanup; &catch_break; $have_break = 0; + $last_action_time = time(); WAIT: while (1) { sleep( $sleep_time ); if ($have_break) { last WAIT; } @@ -3278,12 +3232,20 @@ CHANGE: last WAIT; } if ($have_break) { last WAIT; } + if ($pvc_timeout && ( time() > $last_action_time+60*$pvc_timeout_mins ) ) { + $timed_out = 1; + last WAIT; + } } # end WAIT: &default_break; if ($have_break) { print "$My_name: User typed ctrl/C or ctrl/break. I'll finish.\n"; return; } + if ($timed_out) { + print "$My_name: More than $pvc_timeout_mins mins of inactivity. I'll finish.\n"; + return; + } $waiting = 0; if ($diagnostics) { warn "NOT WAITING\n"; } } #end infinite_loop CHANGE: } #END sub make_preview_continuous @@ -3585,6 +3547,9 @@ sub print_help " on force mode, so errors do not cause $my_name to stop.)\n", " (Side effect: turn off ordinary preview mode.)\n", " -pvc- - turn off -pvc\n", + " -pvctimeout - timeout in pvc mode after period of inactivity\n", + " -pvctimeout- - don't timeout in pvc mode after inactivity\n", + " -pvctimeoutmins=<time> - set period of inactivity (minutes) for pvc timeout\n", " -quiet - silence progress messages from called programs\n", " -r <file> - Read custom RC file\n", " (N.B. This file could override options specified earlier\n", @@ -5750,17 +5715,21 @@ NEW_SOURCE: sub test_gen_file { # Usage: test_gen_file( filename ) # Tests whether the file was generated during a run of (pdf)latex. - # Used by rdb_set_latex_deps. - # Assumes context for primary rule, and that %generated_log is set. - # The generated_log test works with TeXLive's tex, because it puts - # \openout lines in log file. - # But it doesn't work with MikTeX, which does NOT put \openout lines - # in log file. - # So we have a back up test: bcf file exists and is at least as new as - # the run time (so it should have been generated on the current run). + # Assumes context for primary rule. + # Two kinds of test are used: + # a. From %generated_log, which works after the log file has been parsed, + # but only for certain files and for those TeX engines (not MiKTeX) + # that put \openout lines in log file. + # b. By the file existing and being at least as new as the system + # time at the start of the run. But we allow for a measured + # offset between filetime and system time, which could be + # nonzero if the file is on a different, remote system than the + # one running latexmk. We must also allow a threshold in the + # comparisons of filetimes to allow for the inaccuracy of the + # offset measurement. my $file = shift; return exists $generated_log{$file} - || ( -e $file && ( get_mtime( $file ) >= $$Prun_time )); + || ( -e $file && ( get_mtime( $file ) >= $$Prun_time + $filetime_offset - $filetime_causality_threshold)); } #************************************************************ @@ -6785,7 +6754,7 @@ sub rdb_run1 { # Source file data, by definition, correspond to the file state just # before the latest run, and the run_time to the time just before the run: &rdb_update_files; - $$Prun_time = time; + $$Prun_time = time(); $$Pchanged = 0; # No special changes in files $$Plast_result = 0; $$Plast_message = ''; @@ -6959,7 +6928,7 @@ sub rdb_dummy_run1 { # Source file data, by definition, correspond to the file state just before # the latest run, and the run_time to the time just before the run: &rdb_update_files; - $$Prun_time = time; + $$Prun_time = time(); $$Pchanged = 0; # No special changes in files $$Plast_result = 0; $$Plast_message = ''; @@ -7056,6 +7025,17 @@ sub rdb_primary_run { # and then parses log file etc. my $return = 0; + if ( ! $filetime_offset_measured ) { + $filetime_offset = get_filetime_offset( $aux_dir1."tmp" ); + if ( (abs($filetime_offset) > $filetime_offset_report_threshold) + && ($diagnostics || ! $silent) ) + { + warn "$My_name: I am working around an offset relative to my system time by\n", + " $filetime_offset secs for file times in directory '$aux_dir1'.\n"; + } + $filetime_offset_measured = 1; + } + my $return_latex = &rdb_run1; if (-e $$Pdest) { $missing_dvi_pdf = '';} @@ -7186,7 +7166,7 @@ sub rdb_flag_changes_here { local $ignore_run_time = $_[0]; if ( ! defined $ignore_run_time ) { $ignore_run_time = 0; } - $$Pcheck_time = time; + $$Pcheck_time = time(); local $dest_mtime = 0; $dest_mtime = get_mtime($$Pdest) if ($$Pdest); @@ -8566,10 +8546,39 @@ sub split_search_path ################################# +sub get_filetime_offset { + # Usage: get_filetime_offset( prefix, [suffix] ) + # Measures offset between filetime in a directory and system time + # Makes a temporary file of a unique name, and deletes in. + # Filename is of form concatenation of prefix, an integer, suffix. + # Prefix is normally of form dir/ or dir/tmp. + # Default default suffix ".tmp". + my $prefix = $_[0]; + my $suffix = $_[1] || '.tmp'; + my $tmp_file_count = 0; + while (1==1) { + # Find a new temporary file, and make it. + $tmp_file_count++; + my $tmp_file = "${prefix}${tmp_file_count}${suffix}"; + if ( ! -e $tmp_file ) { + open( TMP, ">$tmp_file" ) + or die "$My_name.get_filetime_offset: In measuring filetime offset, couldn't write to\n", + " temporary file '$tmp_file'\n"; + my $time = time(); + close(TMP); + my $offset = get_mtime($tmp_file) - $time; + unlink $tmp_file; + return $offset; + } + } + die "$My_name.get_filetime_offset: BUG TO ARRIVE HERE\n"; +} + +################################# sub tempfile1 { # Makes a temporary file of a unique name. I could use file::temp, - # but it is not present in all versions of perl + # but it is not present in all versions of perl. # Filename is of form $tmpdir/$_[0]nnn$suffix, where nnn is an integer my $tmp_file_count = 0; my $prefix = $_[0]; |