diff options
| author | Karl Berry <karl@freefriends.org> | 2017-01-17 22:27:02 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2017-01-17 22:27:02 +0000 |
| commit | 78ef96dc26db9e148bed61c4120e21ae8b034e4b (patch) | |
| tree | 43c2e78fa86c7d94a698d1fd42b5355c01787646 /Master/texmf-dist | |
| parent | c8ec67e7148b3e55dcc223df363e08720fe43a32 (diff) | |
latexmk (17jan17)
git-svn-id: svn://tug.org/texlive/trunk@42982 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist')
22 files changed, 2195 insertions, 1853 deletions
diff --git a/Master/texmf-dist/doc/man/man1/latexmk.1 b/Master/texmf-dist/doc/man/man1/latexmk.1 index e2af193039b..e5b389b1c5b 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 1L "5 September 2016" "" +.TH LATEXMK 1 "16 January 2017" "" .SH NAME latexmk \- generate LaTeX document .SH SYNOPSIS @@ -42,7 +42,7 @@ updated figure file it can automatically generate a file in encapsulated postscript or another suitable format for reading by LaTeX. .PP -\fILatexmk\fR has two different previewing options. In the simple +\fILatexmk\fR has two different previewing options. With the simple \fB-pv\fR option, a dvi, postscript or pdf previewer is automatically run after generating the dvi, postscript or pdf version of the document. The type of file to view is selected according to @@ -53,14 +53,14 @@ The second previewing option is the powerful \fB-pvc\fR option continuously, regularly monitoring all the source files to see if any have changed. Every time a change is detected, \fIlatexmk\fR runs all the programs necessary to generate a new version of the document. A -good previewer (like \fIgv\fR) will then automatically update its +good previewer will then automatically update its display. Thus the user can simply edit a file and, when the changes are written to disk, \fIlatexmk\fR completely automates the cycle of -updating the .dvi (and possibly the .ps and .pdf) file, and refreshing +updating the .dvi (and/or the .ps and .pdf) file, and refreshing the previewer's display. It's not quite WYSIWYG, but usefully close. .PP For other previewers, the user may have to manually make the previewer -update its display, which can be (some versions of \fIxdvi\fR and +update its display, which can be (e.g., with some versions of \fIxdvi\fR and \fIgsview\fR) as simple as forcing a redraw of its display. .PP \fILatexmk\fR has the ability to print a banner in gray diagonally @@ -71,17 +71,16 @@ generated dvi and postscript files. (See the options \fB-dF\fR and \fI$ps_filter\fR configuration variables.) These capabilities are leftover from older versions of \fIlatexmk\fR. More flexibility can be obtained in current versions, since the command strings for running -latex, pdflatex, etc can now be configured to run multiple commands. -This also extends the possibility of postprocessing generated files to -pdf files. -files. +\fIlatex\fR, \fIpdflatex\fR, etc can now be configured to run multiple +commands. +This also extends the possibility of postprocessing generated files. .PP \fILatexmk\fR is highly configurable, both from the command line and in configuration files, so that it can accommodate a wide variety of user needs and system configurations. Default values are set according to the operating system, so \fIlatexmk\fR often works without special configuration on MS-Windows, cygwin, Linux, OS-X, and -other UNIX systems (notably Solaris). +other UNIX systems. .PP A very annoying complication handled very reliably by \fIlatexmk\fR, is that LaTeX is a multiple pass system. On each run, LaTeX reads in @@ -91,7 +90,7 @@ LaTeX suffices, and often the log file contains a message about the need for another pass. However, there is a wide variety of add-on macro packages to LaTeX, with a variety of behaviors. The result is to break simple-minded determinations of how many runs are needed and -of which programs. In its new version, \fIlatexmk\fR has a highly +of which programs. \fILatexmk\fR has a highly general and efficient solution to these issues. The solution involves retaining between runs information on the source files, and a symptom is that \fIlatexmk\fR generates an extra file (with extension @@ -123,19 +122,17 @@ information. \fBNote 2\fR: In this documentation, the program \fIpdflatex\fR is often referred to. Users of programs like \fIlualatex\fR and \fIxelatex\fR should know that from \fIlatexmk\fR's point of view, these other -programs behave like \fIpdflatex\fR, i.e., they make a pdf file from a +programs behave very like \fIpdflatex\fR, i.e., they make a pdf file from a tex file, etc. So whenever \fIpdflatex\fR is mentioned without mention of the other programs, the statements apply equally to \fIlualatex\fR, \fIxelatex\fR, and any other similar programs. \fILatexmk\fR can be easily configured to use whichever of these programs is needed. See the documentation for the following options: -\fB-pdflatex="COMMAND"\fR, -\fB-lualatex\fR, and -\fB-xelatex\fR, +\fB-pdflua\fR, \fB-pdfxe\fR, \fB-lualatex\fR, and \fB-xelatex\fR, and also see the documentation for the -\fI$pdflatex\fR configuration variable. -At present \fIlatexmk\fR cannot do automatic detection of which -program is to be used. +\fI$pdflatex\fR, \fI$lualatex\fR, and \fI$xelatex\fR configuration variables. +At present \fIlatexmk\fR does not do automatic detection of which +program is to be used. \fBDefinitions of options and arguments\fR @@ -402,7 +399,8 @@ requested.) .B -e <code> Execute the specified initialization code before processing. The code is \fIPerl\fR code of the same form as is used in \fIlatexmk\fR's -initialization files -- for more details, see the information on the +initialization files. For more details, +see the information on the \fB-r\fR option, and the section about "Configuration/initialization (RC) files". The code is typically a sequence of assignment statements separated by semicolons. @@ -417,11 +415,11 @@ they appear on the command line. Some care is needed to deal with proper quoting of special characters in the code on the command line. For example, suppose you want to set the latex command to use its -shell-escape option, then under -UNIX/LINUX you could use the line +UNIX/Linux you could use the line latexmk -e '$latex=q/latex %O -shell-escape %S/' file.tex -Note that the single quotes block normal UNIX/LINUX command shells +Note that the single quotes block normal UNIX/Linux command shells from treating the characters inside the quotes as special. (In this example, the q/.../ construct is a \fIPerl\fR idiom equivalent to using @@ -439,7 +437,12 @@ or latexmk -e "$latex='latex %O -shell-escape %S'" file.tex -The last two examples will NOT work with UNIX/LINUX command shells. +The last two examples will NOT work with UNIX/Linux command shells. + +(\fINote\fR: the above examples show are to show how to use the +\fB-e\fR to specify initialization code to be executed. But the +particular effect can be achieved also by the use of the \fB-latex\fR +option with less problems in dealing with quoting.) .TP .B -f @@ -517,20 +520,37 @@ operating system and the command-line shell you are using, you may need to change the single quotes to double quotes (or something else). -To set the command for running pdflatex (rather than the command for -latex) see the \fB-pdflatex\fR option. +To set the command for running \fIpdflatex\fR (rather than the command for +\fIlatex\fR) see the \fB-pdflatex\fR option. + +.TP +.B -logfilewarninglist +.B -logfilewarnings +After a run of \fI(pdf)latex\fR, give a list of warnings about +undefined citations and references (unless silent mode is on). -Note that the effect of this option can also be achieved by using -the \fB-e\fR option with a suitable line of Perl code to set the -\fI$latex\fR variable. See the explanation of the \fB-e\fR option. +See also the \fI$silence_logfile_warnings\fR configuration variable. + +.TP +.B -logfilewarninglist- +.B -logfilewarnings- +After a run of \fI(pdf)latex\fR, do not give a list of warnings about +undefined citations and references. (Default) + +See also the \fI$silence_logfile_warnings\fR configuration variable. .TP .B -lualatex -Use lualatex. That is, use lualatex to process the source file(s) to -pdf (in place of pdflatex). This option is exactly equivalent to -specifying the following sequence of options: +Use \fIlualatex\fR. That is, use \fIlualatex\fR to process the source file(s) to +pdf. The generation of dvi and postscript files is turned off. + +This option is equivalent to using the following set of options + + -pdflua -dvi- -ps- - -pdflatex="lualatex %O %S" -pdf -dvi- -ps- +(\fINote\fR: Note that the method of implementation of this option, +but not its intended effect, differ from some earlier versions of +\fIlatexmk\fR.) .TP .B -M @@ -544,10 +564,10 @@ write it to. .TP .B -MP -If a list of dependents is made, includes phony target for each source +If a list of dependents is made, 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. +work around errors the program \fImake\fR gives if you remove header +files without updating the Makefile to match. .TP .B -new-viewer @@ -567,14 +587,7 @@ an already-running previewer. .TP .B -nobibtex -Never run bibtex or biber. - -A common use for this option is when a document comes from an external -source, complete with its bbl file(s), and the user does not have the -corresponding bib files available. In this situation use of the -\fB-nobibtex\fR option will prevent \fIlatexmk\fR from trying to run -\fIbibtex\fR or \fIbiber\fR, which would result in overwriting of the -bbl files. +Never run bibtex or biber. Equivalent to the \fB-bibtex-\fR option. .TP .B -norc @@ -613,7 +626,7 @@ But you can use the can configure this in a start up file (by setting the \fI$print_type\fR variable). -However, printing is enabled by default only under UNIX/LINUX systems, +However, printing is enabled by default only under UNIX/Linux systems, where the default is to use the lpr command and only on postscript files. In general, the correct behavior for printing very much depends on your system's software. In @@ -630,7 +643,8 @@ so it turns them off. .B -pdf Generate pdf version of document using \fIpdflatex\fR. (If you wish to use \fIlualatex\fR or \fIxelatex\fR, you can use whichever of the -options \fB-lualatex\fR or \fB-xelatex\fR applies.) To configure +options \fB-pdflua\fR, \fB-pdfxe\fR, \fB-lualatex\fR or \fB-xelatex\fR +applies.) To configure \fIlatexmk\fR to have such behavior by default, see the section on "Configuration/initialization (rc) files". @@ -639,9 +653,28 @@ options \fB-lualatex\fR or \fB-xelatex\fR applies.) To configure Generate pdf version of document from the dvi file, by default using dvipdf. .TP +.B -pdflua +Generate pdf version of document using \fIlualatex\fR. + +.TP .B -pdfps Generate pdf version of document from the ps file, by default using -ps2pdf. +\fIps2pdf\fR. + +.TP +.B -pdfxe +Generate pdf version of document using \fIxelatex\fR. Note that to +optimize processing time, \fIlatexmk\fR uses \fIxelatex\fR to generate +an xdv file rather than a pdf file directly. Only after possibly +multiple runs to generate a fully up-to-date xdv does \fIlatexmk\fR +then call \fIxdvipdfmx\fR to generate the final pdf file. + +(\fINote:\fR When the document includes large graphics files, +especially png files, the last step can be quite time consuming, even +when the creation of the xdv file by \fIxelatex\fR is fast. So the +use of the intermediate xdv file can result in substantial gains in +procesing time, since the pdf file is produced once rather than on +every run of \fIxelatex\fR.) .TP .B -pdf- @@ -652,7 +685,7 @@ a pdf file.) .TP .B -pdflatex="COMMAND" -This sets the string specifying the command to run pdflatex, and is +This sets the string specifying the command to run \fIpdflatex\fR, and is typically used to add desired options. Since the string normally contains spaces, it should be quoted, e.g., @@ -664,24 +697,9 @@ operating system and the command-line shell you are using, you may need to change the single quotes to double quotes (or something else). -This option can also be used to set a program to be used instead of -the standard \fIpdflatex\fR program, e.g., - - latexmk -pdf -pdflatex="lualatex %O %S" foo.tex - -to use \fIlualatex\fR or - - latexmk -pdf -pdflatex="xelatex %O %S" foo.tex - -to use \fIxelatex\fR. - To set the command for running \fIlatex\fR (rather than the command for \fIpdflatex\fR) see the \fB-latex\fR option. -Note that the effect of this option can also be achieved by using -the \fB-e\fR option with a suitable line of Perl code to set the -\fI$pdflatex\fR variable. See the explanation of the \fB-e\fR option. - .TP .B -print=dvi, -print=ps, -print=pdf, -print=auto, Define which kind of file is printed. This option also ensures that @@ -764,11 +782,11 @@ read.) Many other previewers will need a manual update. \fBImportant note\fR: the acroread program on MS-Windows locks the pdf file, and prevents new versions being written, so it is a bad idea to use acroread to view pdf files in preview-continuous mode. -It is better to use a different viewer: SumatraPDF and gsview are -good possibilities. +It is better to use a different viewer: \fISumatraPDF\fR and +\fIgsview\fR are good possibilities. There are some other methods for arranging an update, notably useful -for many versions of xdvi and xpdf. These are best set in +for many versions of \fIxdvi\fR and \fIxpdf\fR. These are best set in \fIlatexmk\fR's configuration; see below. Note that if \fIlatexmk\fR dies or is stopped by the user, the @@ -812,19 +830,20 @@ the order they appear on the command line. .TP .B -recorder -Use the -recorder option with \fIlatex\fR and \fIpdflatex\fR. In +Give the -recorder option with \fIlatex\fR and \fIpdflatex\fR. In (most) modern versions of these programs, this results in a file of extension \fI.fls\fR containing a list of the files that these programs have read and written. \fILatexmk\fR will then use this file to improve its detection of source files and generated files after a -run of \fIlatex\fR or \fIpdflatex\fR. +run of \fIlatex\fR or \fIpdflatex\fR. This is the default setting of +\fIlatexmk\fR, unless overridden in an initialization file. For further information, see the documentation for the \fI$recorder\fR configuration variable. .TP .B -recorder- -Do not use the -recorder option with \fIlatex\fR and \fIpdflatex\fR. +Do not supply the -recorder option with \fIlatex\fR and \fIpdflatex\fR. .TP .B -rules @@ -838,9 +857,9 @@ processing. (This is the default.) .TP .B -showextraoptions Show the list of extra \fIlatex\fR and \fIpdflatex\fR options that -\fIlatexmk\fR recognizes. These are options for the \fIlatex\fR and -\fIpdflatex\fR that \fIlatexmk\fR recognizes, but simply passes -through to these programs when they are run. These options are +\fIlatexmk\fR recognizes, but that it simply passes +through to the programs \fIlatex\fR, \fIpdflatex\fR, 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 \fIlatexmk\fR but is not handled by the particular implementation of \fIlatex\fR or @@ -869,49 +888,46 @@ documentation. These options are: \fB-output-directory=DIR\fR, \fB-quiet\fR, and \fB-recorder\fR. .TP -.B -logfilewarninglist -.B -logfilewarnings -After a run of (pdf)latex, give a list of warnings about -undefined citations and references (unless silent mode is on). - -See also the $silence_logfile_warnings configuration variable. - -.TP -.B -logfilewarninglist- -.B -logfilewarnings- -After a run of (pdf)latex, do not give a list of warnings about -undefined citations and references. (Default) - -See also the $silence_logfile_warnings configuration variable. - -.TP .B -silent Run commands silently, i.e., with options that reduce the amount of diagnostics generated. For example, with the default settings, the -command "latex -interaction=batchmode" is used for latex. +command "latex -interaction=batchmode" is used for \fI(pdf)latex\fR +and friends. See also the \fB-logfilewarninglist\fR and \fB-logfilewarninglist-\fR options. Also reduce the number of informational messages that \fIlatexmk\fR -generates. +itself generates. To change the options used to make the commands run silently, you need to configure \fIlatexmk\fR with changed values of its configuration variables, the relevant ones being \fI$bibtex_silent_switch\fR, \fI$biber_silent_switch\fR, \fI$dvipdf_silent_switch\fR, -\fI$dvips_silent_switch\fR, \fI$latex_silent_switch\fR, -\fI$makeindex_silent_switch\fR, and \fI$pdflatex_silent_switch\fR. +\fI$dvips_silent_switch\fR, \fI$latex_silent_switch\fR, +\fI$lualatex_silent_switch\fR +\fI$makeindex_silent_switch\fR, \fI$pdflatex_silent_switch\fR, +and \fI$xelatex_silent_switch\fR + +.TP +.B -time +Show CPU time used. +See also the configuration variable \fI$show_time\fR. + +.TP +.B -time- +Do not show CPU time used. +See also the configuration variable \fI$show_time\fR. .TP .B -use-make When after a run of \fIlatex\fR or \fIpdflatex\fR, there are warnings about missing files (e.g., as requested by the LaTeX \\input, \\include, -and \\includgraphics), \fIlatexmk\fR tries to make them by a custom +and \\includgraphics commands), \fIlatexmk\fR 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 -\fIlatexmk\fR will try as a resort using the make program to try to -make the missing files. +source file is found, and if the \fB-use-make\fR option is set, then +as a last resort \fIlatexmk\fR will try to use the \fImake\fR program +to try to make the missing files. Note that the filename may be specified without an extension, e.g., by \\includegraphics{drawing} in a LaTeX file. In that case, @@ -938,20 +954,32 @@ Opposite of \fB-silent\fR. This is the default setting. .B -view=default, -view=dvi, -view=ps, -view=pdf, -view=none Set the kind of file used when previewing is requested (e.g., by the \fB-pv\fR or \fB-pvc\fR switches). The default is to view the "highest" -kind of requested file (in the order dvi, ps, pdf). +kind of requested file (in the low-to-high order dvi, ps, pdf). Note the possibility \fB-view=none\fR where no viewer is opened at all. One example of is use is in conjunction with the \fB-pvc\fR option, when you want \fIlatexmk\fR to do a compilation automatically -whenever source file(s) change, but do want a previewer to be opened. +whenever source file(s) change, but do not want a previewer to be opened. .TP .B -xelatex -Use xelatex. That is, use xelatex to process the source file(s) to -pdf (in place of pdflatex). This option is exactly equivalent to -specifying the following sequence of options: +Use \fIxelatex\fR. That is, use \fIxelatex\fR to process the source file(s) 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- + +[\fINote\fR: Note that the method of implementation of this option, +but not its intended primary effect, differ from some earlier versions +of \fIlatexmk\fR. \fILatexmk\fR first uses \fIxelatex\fR to make an +xdv file, and does all the extra runs needed (including those of +\fIbibtex\fR, etc). Only after that does it make the pdf file from +the xdv file, using \fIxdvipdfmx\fR. This procedure can result in +considerable savings in run time, since the xdv-to-pdf conversion is +quite time-consuming when large graphics files are used in the +document.] - -pdflatex="xelatex %O %S" -pdf -dvi- -ps- .PP \fBCompatibility between options\fR @@ -977,7 +1005,7 @@ each of these options turns the others off. uses. After any changes rerun latex the appropriate number of times and remake the postscript file. If latex - encounters an error, latexmk will + encounters an error, \fIlatexmk\fR will keep running, watching for source file changes. @@ -1015,7 +1043,7 @@ particular situations. (But there is a lot of reading!) difficult situations.\fR d. Further tricks can involve replacing the standard commands that -\fIlatexmk\fR by other commands or scripts. +\fIlatexmk\fR runs by other commands or scripts. e. For possible examples of code for use in an RC file, see the directory example_rcfiles in the distribution of \fIlatexmk\fR (e.g., @@ -1043,13 +1071,13 @@ different name, change bar.baz to the name of your file. g. See also the section \fBADVANCED CONFIGURATION: Some extra resources\fR. -g. Look on tex.stackexchange, i.e., at +h. Look on tex.stackexchange, i.e., at http://tex.stackexchange.com/questions/tagged/latexmk Someone may have already solved your problem. -h. Ask a question at tex.stackexchange.com. +i. Ask a question at tex.stackexchange.com. -i. Or ask me (the author of \fIlatexmk\fR). My e-mail is at the end +j. Or ask me (the author of \fIlatexmk\fR). My e-mail is at the end of this documentation. @@ -1064,14 +1092,15 @@ system 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 MS-Windows system it looks for "C:\\latexmk\\LatexMk". On a cygwin system (i.e., a MS-Windows system in which Perl is -that of cygwin), \fIlatexmk\fR reads for the first it finds of +that of cygwin), \fIlatexmk\fR reads the first it finds of "/cygdrive/c/latexmk/LatexMk", "/opt/local/share/latexmk/LatexMk", "/usr/local/share/latexmk/LatexMk", "/usr/local/lib/latexmk/LatexMk". - In addition, it then tries the same set of locations, but with the + +In addition, it then tries the same set of locations, but with the file name replaced "LatexMk" replaced by "latexmkrc". .PP 2) The user's RC file, if it exists. This can be in one of two @@ -1087,7 +1116,7 @@ Here $HOME is the user's home directory. [\fILatexmk\fR 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 environment +systems (including Linux and OS-X). Otherwise the environment 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 \fIlatexmk\fR does not look for an RC file in @@ -1104,7 +1133,8 @@ and \fIlatexmk\fR does not look for an RC file under it. named either "latexmkrc" or ".latexmkrc", and the first of these to be found is used, if any. .PP -4) Any RC file(s) specified on the command line with the \fB-r\fR option. +4) Any RC file(s) specified on the command line with the \fB-r\fR +option. .PP Each RC file is a sequence of \fIPerl\fR commands. Naturally, a user can use this in creative ways. But for most purposes, one simply uses a @@ -1123,7 +1153,7 @@ overridden by later options on the command line. There is also the \fI For possible examples of code for in an RC file, see the directory -example_rcfiles in the distribution of latexmk (e.g., at +example_rcfiles in the distribution of \fIlatexmk\fR (e.g., at http://mirror.ctan.org/support/latexmk/example_rcfiles). \fR @@ -1169,6 +1199,8 @@ Some of the variables set the commands that \fIlatexmk\fR 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 possibilities listed here do not apply to +the \fI$kpsewhich\fR variable; see its documentation.) \fBPlaceholders\fR: Supposed you wanted \fIlatexmk\fR to use the command elatex in place of the regular latex command, and suppose @@ -1181,8 +1213,9 @@ 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 \fIlatexmk\fR has decided -to use for this command. (E.g., if you used the -silent option it -would replace %O by "-interaction=batchmode".) +to use for this command. (E.g., if you used the \fB-silent\fR option in the +invocation of \fIlatexmk\fR, it results in the replacement of %O by +"-interaction=batchmode".) The available placeholders are: .TP @@ -1213,7 +1246,10 @@ Name of directory for auxiliary output files (see the configuration variable \fI$aux_dir\fR). A directory separation character ('/') is appended if \fI$aux_dir\fR is non-empty and does not end in a suitable character, with suitable characters being those appropriate to UNIX -and MS-Windows, i.e., ':', '/' and '\\'. +and MS-Windows, i.e., ':', '/' and '\\'. Note that if after +initialization, \fI$out_dir\fR is set, but \fI$aux_dir\fR is not set +(i.e., it is blank), then \fIlatexmk\fR sets \fI$aux_dir\fR to the +same value \fI$out_dir\fR. .TP .B %Z Name of directory for output files (see the configuration @@ -1223,17 +1259,13 @@ character, with suitable characters being those appropriate to UNIX and MS-Windows, i.e., ':', '/' and '\\'. .PP If for some reason you need a literal % character in your string not -subject to the above rules, use a pair of these characters. Thus with -the command specification $ps_previewer = 'latex -ad=%%Sfile.ad %S', -the %%S will become %S when the command is executed, but the %S will -be replaced by the source filename, which in this case would be the -name of a postscript file to be viewed. +subject to the above rules, use "%%". .PP 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 +filenames containing spaces.) In case \fIlatexmk\fR's quoting does not work correctly on your system, you can turn it off -- see the documentation for the variable \fI$quote_filenames\fR. .PP @@ -1294,14 +1326,15 @@ should be enclosed in double quotes, as in $pdf_previewer = 'start "c:/Program Files/SumatraPDF (x86)/SumatraPDF.exe" %O %S'; .PP -(Note about the above example: Forward slashes are equivalent to -backslashes in filenames under MS-Windows, provided that the filename +(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 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 strings in the Perl language.) -\fBCommand names under Cygwin\fR: If latexmk is executed by Cygwin's +\fBCommand names under Cygwin\fR: If \fIlatexmk\fR is executed by Cygwin's Perl, \fI be particularly certain that pathnames in commands have \fBforward\fI slashes\fR not the usual backslashes for the separator of pathname components. See the above examples. Backslashes often @@ -1315,7 +1348,7 @@ command 'start' by itself: .PP $dvi_previewer = 'start %S'; .PP -Under recent versions of MS-Windows, this will cause to be run +Under MS-Windows, this will cause to be run whatever program the system has associated with dvi files. (The same applies for a postscript viewer and a pdf viewer.) But note that this trick is not always suitable for the pdf previwer, if your system has @@ -1367,8 +1400,8 @@ 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 \fIlatexmk\fR 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 +commands. For example, if when running \fIpdflatex\fR to generate a pdf +file from a tex file you need to run another program after \fIpdflatex\fR to perform some extra processing, you could do something like: $pdflatex = 'pdflatex --shell-escape %O %S; pst2pdf_for_latexmk %B'; @@ -1395,13 +1428,16 @@ Default values are indicated in brackets. .B $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 operators on -dvi and ps files. It does not apply to pdflatex, unfortunately.) +\fIdvips\fR, \fIdvipdf\fR, and \fIps2pdf\fR operations, and the +filtering operators on dvi and ps files. It does not apply to +\fIpdflatex\fR, unfortunately, since \fIpdflatex\fR 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 sees that the file -has changed, it reads the new file, and this can cause havoc if the -program writing the file has not yet finished its work. +files can occupy a substantial time. If a viewer (notably \fIgv\fR) +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 \fI$pvc_view_file_via_temporary\fR variable for a setting that applies only if preview-continuous mode (-pvc option) is used. See @@ -1429,9 +1465,9 @@ which is the directory to which general output files are to be written. \fBImportant note\fR: The effect of \fI$aux_dir\fR, if different from -\fI$out_dir\fR, is achieved by giving (pdf)latex the +\fI$out_dir\fR, is achieved by giving \fI(pdf)latex\fR the \fB-aux-directory\fR. Currently (Dec. 2011 and later) this only works on the -MiKTeX version of (pdf)latex. +MiKTeX version of \fI(pdf)latex\fR. See also the documentation of \fI$out_dir\fR for some complications on what directory names are suitable. @@ -1501,27 +1537,32 @@ the kpsewhich command, you may need to set the variable \fI@BIBINPUTS\fR. The biber processing program. .TP .B $biber_silent_switch ["--onlylog"] -\fBSwitch(es)\fR for the biber processing program when silent mode is on. +Switch(es) for the biber processing program when silent mode is on. .TP .B $bibtex ["bibtex %O %S"] The BibTeX processing program. .TP .B $bibtex_silent_switch ["-terse"] -\fBSwitch(es)\fR for the BibTeX processing program when silent mode is on. +Switch(es) for the BibTeX processing program when silent mode is on. .TP .B $bibtex_use [1] -Under what conditions to run BibTeX or biber. When \fIlatexmk\fR discovers -from the log file that one (or more) BibTeX/biber-generated bibliographies -are used, it can run BibTeX or biber whenever it appears necessary to -regenerate the bbl file(s) from their source bib database file(s). +Under what conditions to run \fIbibtex\fR or \fIbiber\fR. When +\fIlatexmk\fR discovers +from the log file that one (or more) +\fIbibtex\fR/\fIbiber\fR-generated bibliographies +are used, it can run \fIbibtex\fR or \fIbiber\fR whenever 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 +In that case use of \fIbibtex\fR or \fIbiber\fR will result in incorrect overwriting of the precious bbl files. The variable \fI$bibtex_use\fR controls whether this happens. Its possible values are: 0: never use -BibTeX or biber. 1: only use BibTeX or biber if the bib files exist. -2: run BibTeX or biber whenever it appears necessary to update the bbl +BibTeX or biber. 1: only use \fIbibtex\fR or \fIbiber\fR if the bib +files exist. +2: run \fIbibtex\fR or \fIbiber\fR whenever it appears necessary to +update the bbl files, without testing for the existence of the bib files. .TP .B $cleanup_includes_cusdep_generated [0] @@ -1711,9 +1752,9 @@ is a prerequisite, then $dvi_mode will be set to 1. .TP .B $dvi_previewer ["start xdvi %O %S" under UNIX] The command to invoke a dvi-previewer. -[Default is "start" under MS-WINDOWS; under more recent versions of -Windows, this will cause to be run whatever command the system has -associated with .dvi files.] +[Under MS-Windows the default is "start"; then \fIlatexmk\fR arranges to +use the MS-Windows \fIstart\fR program, which will cause to be run +whatever command the system has associated with .dvi files.] \fBImportant note\fR: Normally you will want to have a previewer run detached, so that \fIlatexmk\fR doesn't wait for the previewer to @@ -1728,9 +1769,10 @@ yourself, whenever it is needed. .TP .B $dvi_previewer_landscape ["start xdvi %O %S"] The command to invoke a dvi-previewer in landscape mode. -[Default is "start" under MS-WINDOWS; under more recent versions of -Windows, this will cause to be run whatever command the system has -associated with .dvi files.] +[Under MS-Windows the default is "start"; then \fIlatexmk\fR arranges to +use the MS-Windows \fIstart\fR program, which will cause to be run +whatever command the system has associated with .dvi files.] + .TP .B $dvipdf ["dvipdf %O %S %D"] Command to convert dvi to pdf file. A common reconfiguration is to @@ -1742,6 +1784,7 @@ 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. + .TP .B $dvipdf_silent_switch ["-q"] Switch(es) for dvipdf program when silent mode is on. @@ -1749,24 +1792,25 @@ 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 dvipdfm and dvipdfmx. +has an effect. The default setting is correct for \fIdvipdfm\fR and +\fIdvipdfmx\fR. .TP .B $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 -- see below -- will be included in the options -substituted for "%O". +\fI$dvips_pdf_switch\fR variable -- see below -- will be included in +the options substituted for "%O". .TP .B $dvips_landscape ["dvips -tlandscape %O -o %D %S"] The program to used as a filter to convert a .dvi file to a .ps file in landscape mode. .TP .B $dvips_pdf_switch ["-P pdf"] -Switch(es) for dvips program when pdf file is to be generated from -ps file. +Switch(es) for \fIdvips\fR program when pdf file is to be generated +from ps file. .TP .B $dvips_silent_switch ["-q"] -Switch(es) for dvips program when silent mode is on. +Switch(es) for \fIdvips\fR program when silent mode is on. .TP .B $dvi_update_command [""] When the dvi previewer is set to be updated by running a command, this @@ -1784,9 +1828,9 @@ the \fI$ps_update_method\fR variables. viewer's window or may mean a more serious action. 2 => Send the signal, whose number is in the variable \fI$dvi_update_signal\fR. The default value under UNIX is -suitable for xdvi. +suitable for \fIxdvi\fR. 3 => Viewer cannot do an update, because it locks the file. (As with -acroread under MS-Windows.) +\fIacroread\fR under MS-Windows.) 4 => run a command to do the update. The command is specified by the variable \fI$dvi_update_command\fR. @@ -1797,10 +1841,10 @@ example of updating by command. 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 \fI$dvi_update_method\fR. The default value is the one appropriate -for xdvi on a UNIX system. +for \fIxdvi\fR on a UNIX system. .TP .B $failure_cmd [undefined] -See the documentation for $compiling_cmd. +See the documentation for \fI$compiling_cmd\fR. .TP .B $fdb_ext ["fdb_latexmk"] The extension of the file which \fIlatexmk\fR generates to contain a @@ -1889,8 +1933,8 @@ 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 read later. To do this, you use Perl's delete -function, e.g., +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'}; @@ -1898,11 +1942,21 @@ function, e.g., .B $kpsewhich ["kpsewhich %S"] The program called to locate a source file when the name alone is not sufficient. Most filenames used by \fIlatexmk\fR have sufficient path -information to be found directly. But sometimes, notably -when .bib files are found from the log file of a bibtex or biber run, -the name of -the file, but not its path is known. The program specified by -$kpsewhich is used to find it. +information to be found directly. But sometimes, notably when a .bib +or a .bst file is found from the log file of a \fIbibtex\fR or +\fIbiber\fR run, only the base name of the file is known, but not its +path. The program specified by \fI$kpsewhich\fR is used to find it. + +(\fIFor advanced users:\fR Because of the different way in which +\fIlatexmk\fR uses the command specified in \fI$kpsewhich\fR, some of +the possibilities listed in the FORMAT OF COMMAND SPECIFICATIONS do +not apply. The \fIinternal\fR and \fIstart\fR 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 +commands, "%S" is substituted by a single source file. In contrast, +for \fI$kpsewhich\fR, "%S" may be substituted by a long list of +space-separated filenames, each of which is quoted. The result on +STDOUT of running the command is then piped to \fIlatexmk\fR.) See also the \fI@BIBINPUTS\fR variable for another way that \fIlatexmk\fR also uses to try to locate files; it applies only in the case of .bib @@ -1921,13 +1975,13 @@ but also specify options to the program. E.g., $latex = "latex --src-specials"; .TP .B %latex_input_extensions -This variable specifies the extensions tried by latexmk when it finds +This variable specifies the extensions tried by \fIlatexmk\fR 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 +In this situation, \fIlatexmk\fR 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'. @@ -1947,7 +2001,7 @@ removes the extension 'tex' from latex_input_extensions add the extension 'asdf to latex_input_extensions. (Naturally with such an extension, you should have made an appropriate custom -dependency for latexmk, and should also have done the appropriate +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. @@ -1963,16 +2017,16 @@ initialization file $latex_silent_switch = "-interaction=batchmode -c-style-errors"; .TP -.B $lpr ["lpr %O %S" under UNIX/LINUX, \(dqNONE lpr\(dq under MS-WINDOWS] +.B $lpr ["lpr %O %S" under UNIX/Linux, \(dqNONE lpr\(dq under MS-Windows] The command to print postscript files. -Under MS-Windows (unlike UNIX/LINUX), there is no standard program for +Under MS-Windows (unlike UNIX/Linux), there is no standard program 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": +you have \fIgsview\fR 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 +If \fIgsview\fR 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 variable \fI$lpr\fR. The double @@ -1987,17 +2041,46 @@ The printing program to print dvi files. .B $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 installed, +Under MS-Windows you could set this to use \fIgsview\fR, 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 +If \fIgsview\fR 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 misinterpreted. .TP +.B $lualatex ["lualatex %O %S"] +The LaTeX processing program that is to be used when the \fIlualatex\fR +program is called for (e.g., by the option \fB-lualatex\fR. + +.TP +.B %lualatex_input_extensions +This variable specifies the extensions tried by \fIlatexmk\fR when it finds +that a \fIlualatex\fR 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, \fIlatexmk\fR 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 \fI%latex_input_extensions\fR for other information +that equally applies to \fI%lualatex_input_extensions\fR. + +.TP +.B $lualatex_silent_switch ["-interaction=batchmode"] +Switch(es) for the \fIlualatex\fR program (specified in the variable +\fI$lualatex\fR) when silent mode is on. + +See details of the \fI$latex_silent_switch\fR for other information +that equally applies to \fI$lualatex_silent_switch\fR. + +.TP .B $make ["make"] The make processing program. @@ -2027,11 +2110,12 @@ character, which is the character used by Unix-like systems. For many programs under MS-Windows, both "\\" and "/" are acceptable as the directory separator character. But some programs only accept -"\\". So for safety \fIlatexmk\fR makes a translation, by default. +"\\" on the command line. So for safety \fIlatexmk\fR 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 software is implemented using Cygwin, which provides -an Unix-like environment inside MS-Windows.) +a Unix-like environment inside MS-Windows.) .TP .B $new_viewer_always [0] @@ -2078,93 +2162,67 @@ operating system environment variable openout_any to "a" (as in .B $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 pdflatex. +If equal to 1, generate a pdf version of the document using \fIpdflatex\fR, +using the command specified by the \fI$pdflatex\fR variable. If equal to 2, generate a pdf version of the document from the ps file, by using the command specified by the \fI$ps2pdf\fR variable. If equal to 3, generate a pdf version of the document from the dvi file, by using the command specified by the \fI$dvipdf\fR variable. +If equal to 4, generate a pdf version of the document using \fIlualatex\fR, +using the command specified by the \fI$lualatex\fR variable. +If equal to 5, generate a pdf version (and an xdv version) of the +document using \fIxelatex\fR, using the commands specified by the +\fI$xelatex\fR and \fIxdvipdfmx\fR variables. + +In \fI$pdf_mode\fR=2, it is ensured that dvi and ps files are also made. +In \fI$pdf_mode\fR=3, it is ensured that a dvi file is also made. -Equivalent to the \fB-pdf-\fR, \fB-pdf\fR, \fB-pdfdvi\fR, -\fB-pdfps\fR options. .TP .B $pdflatex ["pdflatex %O %S"] The LaTeX processing program in a version that makes a pdf file instead of a dvi file. -An example of the use of this variable is to arrange for -\fIlualatex\fR, \fIxelatex\fR or some similar program -to be used instead of \fIpdflatex\fR. -Note that \fIlualatex\fR and \fIxelatex\fR only produce .pdf files -(and not .dvi), so to use them you will also need to turn on -production of .pdf files, and to turn off the production of .dvi -(and .ps) files, either by command line options or by suitable -settings in a configuration file. Thus to use \fIlualatex\fR, the -following settings are appropriate: - - $pdflatex = "lualatex %O %S"; - $pdf_mode = 1; $postscript_mode = $dvi_mode = 0; - -To use \fIxelatex\fR, the corresponding settings are: - - $pdflatex = "xelatex %O %S"; - $pdf_mode = 1; $postscript_mode = $dvi_mode = 0; - -Another use of the same variable is to add certain options to the +An example use of this variable is to add certain options to the command line for the program, e.g., $pdflatex = "pdflatex --shell-escape %O %S"; +(In some earlier versions of \fIlatexmk\fR, you needed to use an assignment +to \fI$pdflatex\fR to allow the use of \fIlualatex\fR or \fIxelatex\fR +instead of \fIpdflatex\fR. There are now separate configuration +variables for the use of \fIlualatex\fR or \fIxelatex\fR. See +\fI$lualatex\fR and \fI$xelatex\fR.) .TP .B %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, +This variable specifies the extensions tried by \fIlatexmk\fR when it finds +that a \fIpdflatex\fR 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 +In this situation, \fIlatexmk\fR 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'. -(For Perl experts: %pdflatex_input_extensions is a hash whose keys are -the extensions. The values are irrelevant.) Two subroutines are -provided for manipulating this and the related variable -%latex_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( 'pdflatex', 'tex' ); - -removes the extension 'tex' from pdflatex_input_extensions - - add_input_ext( 'pdflatex', 'asdf' ); - -add the extension 'asdf to pdflatex_input_extensions. (Naturally with -such an extension, you should have made an appropriate custom -dependency for latexmk, 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 pdflatex and its graphics/graphicx -packages.) +See details of the \fI%latex_input_extensions\fR for other information +that equally applies to \fI%pdflatex_input_extensions\fR. .TP .B $pdflatex_silent_switch ["-interaction=batchmode"] -Switch(es) for the pdflatex program (specified in the variable -\fI$pdflatex\fR when silent mode is on. +Switch(es) for the \fIpdflatex\fR program (specified in the variable +\fI$pdflatex\fR) 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 line in an -initialization file - - $latex_silent_switch = "-interaction=batchmode -c-style-errors"; +See details of the \fI$latex_silent_switch\fR for other information +that equally applies to \fI$pdflatex_silent_switch\fR. .TP .B $pdf_previewer ["start acroread %O %S"] The command to invoke a pdf-previewer. -On MS-WINDOWS, the default is changed to "cmd /c start """; under more recent versions of +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 \fIacroread\fR -- see the notes in the explanation @@ -2180,7 +2238,7 @@ 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 \fIlatexmk\fR's previous-continuous mode (option \fB-pvc\fR) under MS-windows. -This problem does not occur if, for example, SumatraPDF or gsview is +This problem does not occur if, for example, \fISumatraPDF\fR or \fIgsview\fR is used to view pdf files. \fBImportant note\fR: Normally you will want to have a previewer run @@ -2228,14 +2286,16 @@ in response to a command, and the third setting sets the update command. 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 \fI$pdf_update_method\fR. The default value is the one appropriate -for gv on a UNIX system. +for \fIgv\fR on a UNIX system. .TP .B $pid_position[1 under UNIX, -1 under MS-Windows] The variable \fI$pid_position\fR is used to specify which word in lines of the output from \fI$pscmd\fR 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 and Linux. Setting the variable to -1 is used to indicate that +2.6, Linux, and OS-X with their default settings of \fI$pscmd\fR. + +Setting the variable to -1 is used to indicate that \fI$pscmd\fR is not to be used. .TP .B $postscript_mode [0] @@ -2259,7 +2319,8 @@ Which previewer is run depends on the other settings, see the command line options \fB-view=\fR, and the variable \fI$view\fR. .TP .B $printout_mode [0] -If nonzero, print the document using \fIlpr\fR. Equivalent to the +If nonzero, print the document using the command specified in the +\fI$lpr\fR variable. Equivalent to the \fB-p\fR option. This is recommended \fBnot\fR to be set from an RC file, otherwise you could waste lots of paper. .TP @@ -2280,11 +2341,10 @@ one process. See the \fI$pid_position\fR variable for how the process number is determined. The default for \fIpscmd\fR is "NONE" under MS-Windows and cygwin -(i.e., the command is not used), "ps --width 200 -f -u $ENV{USER}" -under linux, "ps -ww -u $ENV{USER}" under darwin (Macintosh OS-X), and -"ps -f -u $ENV{USER}" under other operating systems (including other -flavors of UNIX). In these specifications "$ENV{USER}" is substituted -by the username. +(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 substituted by the username. .TP .B $ps2pdf ["ps2pdf %O %S %D"] Command to convert ps to pdf file. @@ -2294,19 +2354,19 @@ The postscript file filter to be run on the newly produced postscript file before other processing. Equivalent to specifying the \fB-pF\fR option. .TP -.B $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 +.B $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 associated with .ps files.) -Note that gv could be used with the -watch option updates its display +Note that \fIgv\fR 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 different ways of +However, different versions of \fIgv\fR have slightly different ways of writing this option. You can configure this variable appropriately. \fBWARNING\fR: Linux systems may have installed one (or more) versions -of gv under different names, e.g., ggv, kghostview, etc, but perhaps -not one called gv. +of \fIgv\fR under different names, e.g., \fIggv\fR, \fIkghostview\fR, +etc, but perhaps not one actually called \fIgv\fR. \fBImportant note\fR: Normally you will want to have a previewer run detached, so that \fIlatexmk\fR doesn't wait for the previewer to @@ -2319,7 +2379,7 @@ non-trivial reasons), so you should put the "start " bit in yourself, whenever it is needed. .TP -.B $ps_previewer_landscape ["start gv -swap %O %S", but "start %O %S" under MS-WINDOWS] +.B $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. .TP .B $ps_update_command [""] @@ -2354,11 +2414,11 @@ specifications (as in \fI$pdflatex\fR) are surrounded by double quotes. If this variable is 1 (or any other value Perl regards as true), then quoting is done. Otherwise quoting is omitted. -The quoting method used by latexmk is tested to work correctly under +The quoting method used by \fIlatexmk\fR is tested to work correctly under UNIX systems (including Linux and Mac OS-X) and under MS-Windows. It allows the use of filenames containing special characters, notably -spaces. (But note that many versions of LaTeX and PdfLaTeX cannot -correctly deal with TeX files whose names contain spaces. Latexmk's +spaces. (But note that many versions of \fIlatex\fR and \fIpdflatex\fR cannot +correctly deal with TeX files whose names contain spaces. \fILatexmk\fR's quoting only ensures that such filenames are correctly treated by the operating system in passing arguments to programs.) .TP @@ -2390,12 +2450,12 @@ BIBINPUTS, and BSTINPUTS. This variable is mainly used by \fIlatexmk\fR when the \fB-outdir\fR, \fB-output-directory\fR, \fB-auxdir\fR, and/or \fB-aux-directory\fR options are used. In that case \fIlatexmk\fR needs to communicate appropriately modified search -paths to $\fIbibtex\fR, \fIdvipdf\fR, \fIdvips\fR, and +paths to \fIbibtex\fR, \fIdvipdf\fR, \fIdvips\fR, and \fI(pdf)latex\fR. [Comment to technically savvy readers: \fI(pdf)latex\fR doesn't -actually need the modified search path, because it corrects it -internally. But, surprisingly, \fIdvipdf\fR and \fIdvips\fR do, +actually need the modified search path. But, surprisingly, +\fIdvipdf\fR and \fIdvips\fR do, because sometimes graphics files get generated in the output or aux directories.] @@ -2410,6 +2470,10 @@ for unusual operating systems that are not in the MSWin, Linux, OS-X, Unix collection.) .TP +.B $show_time [0] +Whether to show CPU time used. + +.TP .B $silence_logfile_warnings [0] Whether after a run of (pdf)latex to summarize warnings in the log file about undefined citations and references. Setting @@ -2484,6 +2548,49 @@ possible values are "default", "dvi", "ps", "pdf". The value of "default" means that the "highest" of the kinds of file generated is to be used (among dvi, ps and pdf). +.TP +.B $xdvipdfmx ["xdvipdfmx -o %D %O %S"] + +The program to make a pdf file from an xdv file (used in conjunction +with \fIxelatex\fR when \fI$pdf_mode\fR=5). + +.TP +.B $xdvipdfmx_silent_switch ["-q"] +Switch(es) for the \fIxdvipdfmx\fR program when silent mode is on. + +.TP +.B $xelatex ["xelatex %O %S"] +The LaTeX processing program of in a version that makes a pdf file instead +of a dvi file, when the \fIxelatex\fR program is called for. See the +documentation of the \fB-xelatex\fR option for some special properties +of \fIlatexmk\fR's use of \fIxelatex\fR. + +.TP +.B %xelatex_input_extensions +This variable specifies the extensions tried by \fIlatexmk\fR when it finds +that an \fIxelatex\fR 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, \fIlatexmk\fR searches for custom dependencies to make +the missing file(s), but restricts it to the extensions specified by +the variable %xelatex_input_extensions. The default extensions +are 'tex', 'pdf', 'jpg, and 'png'. + +See details of the \fI%latex_input_extensions\fR for other information +that equally applies to \fI%xelatex_input_extensions\fR. + +.TP +.B $xelatex_silent_switch ["-interaction=batchmode"] +Switch(es) for the \fIxelatex\fR program (specified in the variable +\fI$xelatex\fR) when silent mode is on. + +See details of the \fI$latex_silent_switch\fR for other information +that equally applies to \fI$xelatex_silent_switch\fR. + + + .SH CUSTOM DEPENDENCIES .PP In any RC file a set of custom dependencies can be set up to convert a @@ -2525,12 +2632,13 @@ of the file to be converted without any extension. The subroutines are declared in the syntax of \fIPerl\fR. The function should return 0 if it was successful and a nonzero number if it failed. .PP -It is invoked whenever \fIlatexmk\fR detects that a run of +A custom dependency rule is invoked whenever \fIlatexmk\fR detects +that a run of latex/pdflatex needs to read a file, like a graphics file, whose extension is the to-extension of a custom dependency. Then \fIlatexmk\fR examines whether a file exists with the same name, but with the corresponding from-extension, as specified in the -custom-dependency rule. If it does, then whenever the destination +custom-dependency rule. If it does, then the rule whenever the destination file (the one with the to-extension) is out-of-date with respect to the corresponding source file. @@ -2541,7 +2649,7 @@ external program; this can be done by following the templates below, even by those without knowledge of the \fIPerl\fR programming language. Of course, experts could do something much more elaborate. -One other item in each custom-dependency rule labeled "must" above +One other item in each custom-dependency rule, labeled "must" above, specifies how the rule should be applied when the source file fails to exist. @@ -2549,11 +2657,11 @@ A simple and typical example of code in an initialization rcfile is add_cus_dep( 'fig', 'eps', 0, 'fig2eps' ); sub fig2eps { - system( "fig2dev -Leps \\"$_[0].fig\\" \\"$_[0].eps\\"" ); + return system( "fig2dev -Leps \\"$_[0].fig\\" \\"$_[0].eps\\"" ); } The first line adds a custom dependency that converts a file with -extension "fig", as created by the xfig program, to an encapsulated +extension "fig", as created by the \fIxfig\fR 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 "fig" to "eps" files already exists (e.g., from a previously read-in @@ -2577,13 +2685,13 @@ the return value is the value returned by the last (and only) statement, i.e., the invocation of system, which returns the value 0 on success. -If you use pdflatex instead of latex, then you will probably prefer to +If you use \fIpdflatex\fR instead of latex, then you will probably prefer to convert your graphics files to pdf format, in which case you would replace the above code in an initialization file by add_cus_dep( 'fig', 'pdf, 0, 'fig2pdf' ); sub fig2pdf { - system( "fig2dev -Lpdf \\"$_[0].fig\\" \\"$_[0].pdf\\"" ); + return system( "fig2dev -Lpdf \\"$_[0].fig\\" \\"$_[0].pdf\\"" ); } \fBNote 1:\fR In the command lines given in the system commands in the @@ -2600,7 +2708,7 @@ the cases I have tested. files are in a subdirectory and your operating system is Microsoft Windows. Then the separator character for directory components can be either a forward slash '/' or Microsoft's more usual backward slash -\'\\'. Forward slashes are generated by latexmk, to maintain its +\'\\'. Forward slashes are generated by \fIlatexmk\fR, to maintain its sanity from software like MiKTeX that mixes both directory separators; but their correct use normally requires quoted filenames. (See a log file from a run of MiKTeX (at least in v. 2.9) for an @@ -2636,12 +2744,9 @@ happen: add_cus_dep('ndx', 'nnd', 0, 'makendx2nnd'); sub makendx2nnd { - system( "makeindex -o \\"$_[0].nnd\\" \\"$_[0].ndx\\"" ); + return system( "makeindex -o \\"$_[0].nnd\\" \\"$_[0].ndx\\"" ); } -(You will need to modify this code if you use filenames -with spaces in them, to provide correct quoting of the filenames.) - Those of you with experience with Makefiles, will undoubtedly be concerned that the \fI.ndx\fR file is written during a run of latex/pdflatex and is always later than the \fI.nnd\fR last read in. @@ -2652,7 +2757,7 @@ dependencies. It examines the contents of the files (by use of an md5 checksum), and only does a remake when the file contents have actually changed. -Of course if you choose to write random data to the \fI.nnd\fR (or and +Of course if you choose to write random data to the \fI.nnd\fR (or the \fI.aux\fR file, etc) that changes on each new run, then you will have a problem. For real experts: See the \fI%hash_cal_ignore_pattern\fR if you have to deal with such problems. @@ -2675,7 +2780,7 @@ of \fI.fig\fR files to \fI.eps\fR files: push @cus_dep_list, "fig eps 0 fig2eps"; sub fig2eps { - system( "fig2dev -Lps \\"$_[0].fig\\" \\"$_[0].eps\\"" ); + return system( "fig2dev -Lps \\"$_[0].fig\\" \\"$_[0].eps\\"" ); } This method still works, and is equivalent to the earlier code using @@ -2825,7 +2930,7 @@ project, where lines such as the above would be only be a small part of a larger Makefile. The above example has a pattern rule for making a .pdf file from -a .tex file, and it is defined to use latexmk in the obvious way. +a .tex file, and it is defined to use \fIlatexmk\fR in the obvious way. There is a conventional default target named "all", with a prerequisite of try.pdf. So when \fImake\fR is invoked, by default it makes try.pdf. The only complication is that there may be many source @@ -2867,7 +2972,7 @@ started with tabs.) This example was inspired by how GNU \fIautomake\fR handles automatic dependency tracking of C source files. -After each run of latexmk, dependency information is put in a file +After each run of \fIlatexmk\fR, dependency information is put in a file in the .deps subdirectory. The Makefile causes these dependency files to be read by \fImake\fR, which now has the full dependency information for each target .pdf file. To make things less trivial it @@ -2909,13 +3014,13 @@ previewers and update methods. (The following isn't really a bug, but concerns features of previewers.) Preview continuous mode only works perfectly with certain previewers: -Xdvi on UNIX/LINUX works for dvi files. -Gv on UNIX/LINUX works for both postscript and pdf. -Ghostview on UNIX/LINUX needs a manual update (reopen); it views +Xdvi on UNIX/Linux works for dvi files. +Gv on UNIX/Linux works for both postscript and pdf. +Ghostview on UNIX/Linux needs a manual update (reopen); it views postscript and pdf. Gsview under MS-Windows works for both postscript and pdf, but only reads the updated file when its screen is refreshed. -Acroread under UNIX/LINUX views pdf, but the file needs to be closed +Acroread under UNIX/Linux views pdf, but the file needs to be closed and reopened to view an updated version. Under MS-Windows, acroread locks its input file and so the pdf file cannot be updated. (Remedy: configure \fIlatexmk\fR to use @@ -2930,7 +3035,7 @@ e-mail addresses are not written in their standard form to avoid being harvested by worms and viruses.) .SH AUTHOR Current version, by John Collins (username jcc8 at node psu.edu). -(Version 4.48). +(Version 4.52). 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 01fd9cd499e..716b02f7f24 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 bc594251252..6d4af373faf 100644 --- a/Master/texmf-dist/doc/support/latexmk/CHANGES +++ b/Master/texmf-dist/doc/support/latexmk/CHANGES @@ -504,3 +504,27 @@ From v. 4.46 to 4.48 rdb_remove_files. Update webpages in documentation. +From v. 4.48 to 4.52 + Optimize number of calls to kpsewhich. This often gives a + considerable savings of run time when a document includes many + graphics files that are in a texmf tree. + Fix bug that if an .aux file is deleted and latexmk is run, the + wrong number of runs of (pdf)latex was made. + Fix related problem that latexmk sometimes does too few runs of + (pdf)latex because of the incorrect detection that a file is only + read after being written. + Implement direct support for xelatex and lualatex. Previously these + programs were used by configuring the $pdflatex so that the desired + program is run instead of pdflatex. There are now configuration + variables $xelatex and $lualatex to specify the commands used, and + extra command line options -pdfxe and -pdflua. + In the case of xelatex, considerable improvement in run time is + given for documents containing large graphics files. This is + because compilation is made first to an xdv file instead of direct + to a pdf file. Only when this file is finalized is a single + conversion to a pdf file made. (This last step can be especially + time-consuming for documents that bring in large graphics files.) + Correct detection for missing graphics files with xelatex. + Work around LuaTeX line-wrapping bug. + Update documentation. + Minor improvements in code and diagnostics. diff --git a/Master/texmf-dist/doc/support/latexmk/INSTALL b/Master/texmf-dist/doc/support/latexmk/INSTALL index 62534e80a28..f96d4362919 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.48, 5 September 2016) + (Version 4.52, 16 January 2017) John Collins Physics Department @@ -407,4 +407,4 @@ psu.edu) -- other contact details at the top. It is copyright 1998-2015 by John Collins, and the previous authors; see the copyright notice in the latexmk.pl file, which gives permission to use, copy, modify, and distribute this software and its documentation under the -terms of the GNU Public License. +terms of the GNU Public License v. 2. diff --git a/Master/texmf-dist/doc/support/latexmk/README b/Master/texmf-dist/doc/support/latexmk/README index 7826b9db450..e3287b023d6 100644 --- a/Master/texmf-dist/doc/support/latexmk/README +++ b/Master/texmf-dist/doc/support/latexmk/README @@ -1,5 +1,5 @@ -Latexmk, version 4.48, 5 September 2016 ---------------------------------------- +Latexmk, version 4.52, 16 January 2017 +-------------------------------------- Latexmk completely automates the process of generating a LaTeX document. Essentially, it is a highly specialized cousin of the @@ -25,7 +25,7 @@ A copy of the fast help that can be seen by doing "latexmk -h" is at the end of this file. Latexmk is a perl script. It is licensed under the GNU General Public -License. +License v. 2. It was modified by Evan McLean from the original script called "go" written by David J. Musliner. Now it is supported by @@ -91,7 +91,7 @@ NOTES:- John Collins ---------------------------- "latexmk -h" ---------------------------- -Latexmk 4.48: Automatic LaTeX document generation routine +Latexmk 4.52: Automatic LaTeX document generation routine Usage: latexmk [latexmk_options] [filename ...] @@ -162,6 +162,8 @@ Usage: latexmk [latexmk_options] [filename ...] -pdflatex=<program> - set program used for pdflatex. (replace '<program>' by the program name) -pdfps - generate pdf by ps2pdf + -pdflua - generate pdf by lualatex + -pdfxe - generate pdf by xelatex -pdf- - turn off pdf -ps - generate postscript -ps- - turn off postscript @@ -202,9 +204,9 @@ Usage: latexmk [latexmk_options] [filename ...] -view=ps - viewer is for ps -view=pdf - viewer is for pdf -lualatex - use lualatex for processing files to pdf - and turn pdf mode on, dvi/ps modes off + and turn dvi/ps modes off -xelatex - use xelatex for processing files to pdf - and turn pdf mode on, dvi/ps modes off + and turn dvi/ps modes off filename = the root filename of LaTeX document diff --git a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/README-latexmk-rcfiles b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/README-latexmk-rcfiles index 61aa7832dba..84a274965f4 100644 --- a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/README-latexmk-rcfiles +++ b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/README-latexmk-rcfiles @@ -15,12 +15,7 @@ NOTES: needs. So read the comments carefully, and understand how the examples are working. -3. Another source of examples is in Herb Schulz's distribution of - TexShop, at http://homepage.mac.com/herbs2, for some further - examples. (The file Latexmk321jTeXShop.zip is the one you want.) - It shows how to use glossaries, epstopdf, pdftricks and pst-pdf. - -4. I have generally arranged for filenames to be quoted on command +3. I have generally arranged for filenames to be quoted on command lines, e.g., system( "makeindex -o \"$_[0].lnd\" \"$_[0].ldx\"" ); diff --git a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/asymptote_latexmkrc b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/asymptote_latexmkrc index 1106127b87d..45f32979d0f 100644 --- a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/asymptote_latexmkrc +++ b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/asymptote_latexmkrc @@ -1,11 +1,11 @@ # This shows how to use Asymptote (http://asymptote.sourceforge.net/, -# or http://www.ctan.org/tex-archive/graphics/asymptote/) +# or http://www.ctan.org/pkg/asymptote/) # with latexmk. Asymptote is a vector graphics language with a # processing program that generates graphics files that can be used in # a LaTex file. # # A standard method of using it is with the asymptote LaTeX style file -# (http://www.ctan.org/tex-archive/graphics/asymptote/doc/asymptote.sty) +# (http://mirror.ctan.org/graphics/asymptote/doc/asymptote.sty) # The graphics drawing code is in the tex file, and applying pdflatex to # the tex file produces one or more files with a base name the same as # or related to the main tex file, but with the extension 'asy'. The diff --git a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/glossary_latexmkrc b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/glossary_latexmkrc index f43b345abd1..937df6f9e71 100644 --- a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/glossary_latexmkrc +++ b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/glossary_latexmkrc @@ -1,10 +1,8 @@ -# This shows how to use the glossary package -# (http://www.ctan.org/tex-archive/macros/latex/contrib/glossary) and -# the glossaries package -# (http://www.ctan.org/tex-archive/macros/latex/contrib/glossaries) -# with latexmk. Note that there are important differences between -# these two packages, so you should take careful note of the comments -# below. +# This shows how to use the glossary package +# (http://www.ctan.org/pkg/glossary) and the glossaries package +# (http://www.ctan.org/pkg/glossaries) with latexmk. Note that there +# are important differences between these two packages, so you should +# take careful note of the comments below. diff --git a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/lualatex_latexmkrc b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/lualatex_latexmkrc index 5a0a088c61b..dd36ddf0025 100644 --- a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/lualatex_latexmkrc +++ b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/lualatex_latexmkrc @@ -1,20 +1,11 @@ -# This shows how to use lualatex (http://en.wikipedia.org/wiki/XeTeX) -# with latexmk. Lualatex uses Unicode and "supporting modern font -# technologies such as OpenType or Apple Advanced Typography. +# This shows how to use lualatex (http://en.wikipedia.org/wiki/LuaTeX) +# with latexmk. # -# WARNING: latexmk.pl is changing, and plans to have more internal -# support for lualatex. +# WARNING: The method shown here is suitable only for ver. 4.51 and +# later of latexmk, not for earlier versions. # -# Since lualatex only produces pdf files, it is a replacement for -# pdflatex. To make it your default typesetting engine within latexmk -# you will not only need to set the $pdflatex variable to require the -# use of lualatex, but also to turn on production of pdf files and to -# turn off the production of dvi and ps files, as in the following -# code: - -$pdflatex = 'lualatex %O %S'; -$pdf_mode = 1; +$pdf_mode = 4; $postscript_mode = $dvi_mode = 0; diff --git a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/nomenclature_latexmkrc b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/nomenclature_latexmkrc index e16ee40f869..4c6817c9a84 100644 --- a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/nomenclature_latexmkrc +++ b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/nomenclature_latexmkrc @@ -1,7 +1,6 @@ # This shows how to use the nomencl package for making a nomenclature # with latexmk. -# (See http://www.ctan.org/tex-archive/macros/latex/contrib/nomencl -# for information on the nomencl package.) +# (See http://www.ctan.org/pkg/nomencl for information on the nomencl package.) add_cus_dep("nlo", "nls", 0, "nlo2nls"); diff --git a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/sagetex_latexmkrc b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/sagetex_latexmkrc index d185ac56d94..a97702a9c70 100644 --- a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/sagetex_latexmkrc +++ b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/sagetex_latexmkrc @@ -1,5 +1,5 @@ # This is to allow the use of sagetex package -# (http://www.ctan.org/tex-archive/macros/latex/contrib/sagetex) +# (http://www.ctan.org/pkg/sagetex) # with latexmk. Sagetex outputs a file with the extension .sage. # This file is to be processed by sage software (http://sagemath.org) # to make a file with extension .sout. This file is then read in by @@ -18,4 +18,4 @@ add_cus_dep( 'sage', 'sout', 0, 'makesout' ); $hash_calc_ignore_pattern{'sage'} = '^( _st_.goboom|print .SageT)'; sub makesout { system( "sage \"$_[0].sage\"" ); -}
\ No newline at end of file +} diff --git a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/Sweave_latexmkrc b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/sweave_latexmkrc index 19f046be6be..19f046be6be 100644 --- a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/Sweave_latexmkrc +++ b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/sweave_latexmkrc diff --git a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/TeX4ht-latexmkrc b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/tex4ht-latexmkrc index de486d8d8be..de486d8d8be 100644 --- a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/TeX4ht-latexmkrc +++ b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/tex4ht-latexmkrc diff --git a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/xelatex_latexmkrc b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/xelatex_latexmkrc index ddc721c00f7..4c1c8d9644b 100644 --- a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/xelatex_latexmkrc +++ b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/xelatex_latexmkrc @@ -2,19 +2,12 @@ # with latexmk. Xelatex uses Unicode and "supporting modern font # technologies such as OpenType or Apple Advanced Typography. # -# WARNING: latexmk.pl is changing, and plans to have more internal -# support for xelatex. +# WARNING: The method shown here is suitable only for ver. 4.51 and +# later of latexmk, not for earlier versions. +# # -# Since xelatex only produces pdf files, it is a replacement for -# pdflatex. To make it your default typesetting engine within latexmk -# you will not only need to set the $pdflatex variable to require the -# use of xelatex, but also to turn on production of pdf files and to -# turn off the production of dvi and ps files, as in the following -# code: - -$pdflatex = 'xelatex %O %S'; -$pdf_mode = 1; +$pdf_mode = 5; $postscript_mode = $dvi_mode = 0; diff --git a/Master/texmf-dist/doc/support/latexmk/extra-scripts/README-latexmk-scripts b/Master/texmf-dist/doc/support/latexmk/extra-scripts/README-latexmk-scripts index 0f67cb114dc..a1c35e471d1 100644 --- a/Master/texmf-dist/doc/support/latexmk/extra-scripts/README-latexmk-scripts +++ b/Master/texmf-dist/doc/support/latexmk/extra-scripts/README-latexmk-scripts @@ -1,8 +1,8 @@ Auxiliary scripts for latexmk ============================= -John Collins (collins at phys.psu.edu) -23 Jun 2010 +John Collins (jcc8 at psu.edu) +13 Oct 2016 Latexmk can be configured to use different programs than the standard ones to perform its tasks. If a user finds that the default behavior @@ -37,7 +37,7 @@ needs you to do to make the script executable. bash (command shell) acroread pdfopen and pdfclose from the xpdfopen package - (see http://www.tug.org/tex-archive/support/xpdfopen/) + (see http://www.ctan.org/pkg/xpdfopen/) To use: diff --git a/Master/texmf-dist/doc/support/latexmk/extra-scripts/dvipdfm_call.bat b/Master/texmf-dist/doc/support/latexmk/extra-scripts/dvipdfm_call.bat index a0817015fe6..104bbabe858 100755 --- a/Master/texmf-dist/doc/support/latexmk/extra-scripts/dvipdfm_call.bat +++ b/Master/texmf-dist/doc/support/latexmk/extra-scripts/dvipdfm_call.bat @@ -1,19 +1,19 @@ -@echo off -REM Run dvipdfm from dvipdf-style command-line -REM Assume no options specified -REM If this script is called from latexmk, -REM we have %1=source.dvi, %2=dest.pdf -REM But for safety, let's handle correctly a one argument call, -REM i.e., %1=source, with no %2 - -if "%2" == "" goto onearg - -:twoarg -dvipdfm -o %2 %1 -goto done - -:onearg -dvipdfm %1 - - +@echo off
+REM Run dvipdfm from dvipdf-style command-line
+REM Assume no options specified
+REM If this script is called from latexmk,
+REM we have %1=source.dvi, %2=dest.pdf
+REM But for safety, let's handle correctly a one argument call,
+REM i.e., %1=source, with no %2
+
+if "%2" == "" goto onearg
+
+:twoarg
+dvipdfm -o %2 %1
+goto done
+
+:onearg
+dvipdfm %1
+
+
:done
\ No newline at end of file diff --git a/Master/texmf-dist/doc/support/latexmk/extra-scripts/dvipdfmx_call.bat b/Master/texmf-dist/doc/support/latexmk/extra-scripts/dvipdfmx_call.bat index 0068de2196d..01a140a65fe 100755 --- a/Master/texmf-dist/doc/support/latexmk/extra-scripts/dvipdfmx_call.bat +++ b/Master/texmf-dist/doc/support/latexmk/extra-scripts/dvipdfmx_call.bat @@ -1,19 +1,19 @@ -@echo off -REM Run dvipdfmx from dvipdf-style command-line -REM Assume no options specified -REM If this script is called from latexmk, -REM we have %1=source.dvi, %2=dest.pdf -REM But for safety, let's handle correctly a one argument call, -REM i.e., %1=source, with no %2 - -if "%2" == "" goto onearg - -:twoarg -dvipdfmx -o %2 %1 -goto done - -:onearg -dvipdfmx %1 - - +@echo off
+REM Run dvipdfmx from dvipdf-style command-line
+REM Assume no options specified
+REM If this script is called from latexmk,
+REM we have %1=source.dvi, %2=dest.pdf
+REM But for safety, let's handle correctly a one argument call,
+REM i.e., %1=source, with no %2
+
+if "%2" == "" goto onearg
+
+:twoarg
+dvipdfmx -o %2 %1
+goto done
+
+:onearg
+dvipdfmx %1
+
+
:done
\ No newline at end of file diff --git a/Master/texmf-dist/doc/support/latexmk/extra-scripts/pst2pdf_for_latexmk b/Master/texmf-dist/doc/support/latexmk/extra-scripts/pst2pdf_for_latexmk index 8e74f40c6e7..8dae4d26c93 100644 --- a/Master/texmf-dist/doc/support/latexmk/extra-scripts/pst2pdf_for_latexmk +++ b/Master/texmf-dist/doc/support/latexmk/extra-scripts/pst2pdf_for_latexmk @@ -10,8 +10,6 @@ # Modified from pst2pdf distributed with pdftricks.sty to use latexmk # IT REQUIRES VERSION 3.21 OR HIGHER OF latexmk -# See http://www.phys.psu.edu/~collins/software/latexmk/versions.html -# The version on CTAN is not yet updated # For each pdf file will only be made if the tex source is out-of-date # This version of pst2pdf does not clean up generated files: they are @@ -23,6 +21,7 @@ # 2. Put a line like the following in an initialization file for latexmk: # $pdflatex = 'pdflatex %O %S; pst2pdf_for_latexmk %B'; +# 13 Oct 2016 John Collins: Remove outdated URL and version information # 1 Oct 2007 John Collins: Remove path from latexmk # 28 Sep 2007 Herb Schulz processing steprs of figure files changed for no rotation and better BoundingBox # 27 Sep 2007 John Collins diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.pdf b/Master/texmf-dist/doc/support/latexmk/latexmk.pdf Binary files differindex 9792f2ed64f..4375ed2c0b9 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 37824b618e7..876807a13a3 100644 --- a/Master/texmf-dist/doc/support/latexmk/latexmk.txt +++ b/Master/texmf-dist/doc/support/latexmk/latexmk.txt @@ -1,4 +1,9 @@ + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + NAME latexmk - generate LaTeX document @@ -39,7 +44,7 @@ DESCRIPTION in encapsulated postscript or another suitable format for reading by LaTeX. - Latexmk has two different previewing options. In the simple -pv + Latexmk has two different previewing options. With the simple -pv option, a dvi, postscript or pdf previewer is automatically run after generating the dvi, postscript or pdf version of the document. The type of file to view is selected according to configuration settings @@ -49,28 +54,28 @@ DESCRIPTION "preview continuously"). In this case, latexmk runs continuously, reg- ularly monitoring all the source files to see if any have changed. Every time a change is detected, latexmk runs all the programs neces- - sary to generate a new version of the document. A good previewer (like - gv) will then automatically update its display. Thus the user can sim- - ply edit a file and, when the changes are written to disk, latexmk com- - pletely automates the cycle of updating the .dvi (and possibly the .ps - and .pdf) file, and refreshing the previewer's display. It's not quite - WYSIWYG, but usefully close. + sary to generate a new version of the document. A good previewer will + then automatically update its display. Thus the user can simply edit a + file and, when the changes are written to disk, latexmk completely + automates the cycle of updating the .dvi (and/or the .ps and .pdf) - For other previewers, the user may have to manually make the previewer - update its display, which can be (some versions of xdvi and gsview) as + 16 January 2017 1 - 1 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1L) LATEXMK(1L) + file, and refreshing the previewer's display. It's not quite WYSIWYG, + but usefully close. - simple as forcing a redraw of its display. + For other previewers, the user may have to manually make the previewer + update its display, which can be (e.g., with some versions of xdvi and + gsview) as simple as forcing a redraw of its display. Latexmk has the ability to print a banner in gray diagonally across each page when making the postscript file. It can also, if needed, @@ -81,28 +86,27 @@ LATEXMK(1L) LATEXMK(1L) flexibility can be obtained in current versions, since the command strings for running latex, pdflatex, etc can now be configured to run multiple commands. This also extends the possibility of postprocessing - generated files to pdf files. files. + generated files. Latexmk is highly configurable, both from the command line and in con- figuration files, so that it can accommodate a wide variety of user needs and system configurations. Default values are set according to the operating system, so latexmk often works without special configura- - tion on MS-Windows, cygwin, Linux, OS-X, and other UNIX systems - (notably Solaris). + tion on MS-Windows, cygwin, Linux, OS-X, and other UNIX systems. - A very annoying complication handled very reliably by latexmk, is that - LaTeX is a multiple pass system. On each run, LaTeX reads in informa- + A very annoying complication handled very reliably by latexmk, is that + LaTeX is a multiple pass system. On each run, LaTeX reads in informa- tion generated on a previous run, for things like cross referencing and - indexing. In the simplest cases, a second run of LaTeX suffices, and - often the log file contains a message about the need for another pass. - However, there is a wide variety of add-on macro packages to LaTeX, - with a variety of behaviors. The result is to break simple-minded - determinations of how many runs are needed and of which programs. In - its new version, latexmk has a highly general and efficient solution to - these issues. The solution involves retaining between runs information - on the source files, and a symptom is that latexmk generates an extra - file (with extension .fdb_latexmk, by default) that contains the source - file information. + indexing. In the simplest cases, a second run of LaTeX suffices, and + often the log file contains a message about the need for another pass. + However, there is a wide variety of add-on macro packages to LaTeX, + with a variety of behaviors. The result is to break simple-minded + determinations of how many runs are needed and of which programs. + Latexmk has a highly general and efficient solution to these issues. + The solution involves retaining between runs information on the source + files, and a symptom is that latexmk generates an extra file (with + extension .fdb_latexmk, by default) that contains the source file + information. LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE @@ -113,40 +117,41 @@ LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE All options can be introduced by single or double "-" characters, e.g., "latexmk -help" or "latexmk --help". - Note 1: In addition to the options in the list below, latexmk recog- + Note 1: In addition to the options in the list below, latexmk recog- nizes almost all the options recognized by the latex, pdflatex programs - (and their relatives) in their current TeXLive and MiKTeX implementa- - tions. Some of the options for these programs also trigger special - action or behavior by latexmk, in which case they have specific expla- + (and their relatives) in their current TeXLive and MiKTeX implementa- + tions. Some of the options for these programs also trigger special + action or behavior by latexmk, in which case they have specific expla- nations in this document. Otherwise, they are just passed through to a - called latex or pdflatex program. Run latexmk with the -showextraop- - tions to get a list of the options that latexmk accepts and that are - simply passed through to latex or pdflatex (etc). See also the expla- - nation of the -showextraoptions option for more information. + called latex or pdflatex program. Run latexmk with the + 16 January 2017 2 - 5 September 2016 2 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1L) LATEXMK(1L) + -showextraoptions to get a list of the options that latexmk accepts and + that are simply passed through to latex or pdflatex (etc). See also + the explanation of the -showextraoptions option for more information. - Note 2: In this documentation, the program pdflatex is often referred - to. Users of programs like lualatex and xelatex should know that from - latexmk's point of view, these other programs behave like pdflatex, - i.e., they make a pdf file from a tex file, etc. So whenever pdflatex - is mentioned without mention of the other programs, the statements - apply equally to lualatex, xelatex, and any other similar programs. - Latexmk can be easily configured to use whichever of these programs is - needed. See the documentation for the following options: -pdfla- - tex="COMMAND", -lualatex, and -xelatex, and also see the documentation - for the $pdflatex configuration variable. At present latexmk cannot do - automatic detection of which program is to be used. + Note 2: In this documentation, the program pdflatex is often referred + to. Users of programs like lualatex and xelatex should know that from + latexmk's point of view, these other programs behave very like pdfla- + tex, i.e., they make a pdf file from a tex file, etc. So whenever + pdflatex is mentioned without mention of the other programs, the state- + ments apply equally to lualatex, xelatex, and any other similar pro- + grams. Latexmk can be easily configured to use whichever of these pro- + grams is needed. See the documentation for the following options: + -pdflua, -pdfxe, -lualatex, and -xelatex, and also see the documenta- + tion for the $pdflatex, $lualatex, and $xelatex configuration vari- + ables. At present latexmk does not do automatic detection of which + program is to be used. Definitions of options and arguments @@ -185,23 +190,23 @@ LATEXMK(1L) LATEXMK(1L) relative to the document directory. - -bibtex - When the source file uses bbl files for bibliography, run bibtex - or biber as needed to regenerate the bbl files. - This property can also be configured by setting the $bibtex_use + 16 January 2017 3 - 5 September 2016 3 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1L) LATEXMK(1L) + -bibtex + When the source file uses bbl files for bibliography, run bibtex + or biber as needed to regenerate the bbl files. + This property can also be configured by setting the $bibtex_use variable to 2 in a configuration file @@ -238,8 +243,8 @@ LATEXMK(1L) LATEXMK(1L) -bm <message> A banner message to print diagonally across each page when con- verting the dvi file to postscript. The message must be a sin- - gle argument on the command line so be careful with quoting - spaces and such. + gle argument on the command line so be careful with quoting spa- + ces and such. Note that if the -bm option is specified, the -ps option is assumed. @@ -251,23 +256,23 @@ LATEXMK(1L) LATEXMK(1L) is OK unless your toner cartridge is getting low. - -bs <scale> - A decimal number that specifies how large the banner message - will be printed. Experimentation is necessary to get the right - scale for your message, as a rule of thumb the scale should be - about equal to 1100 divided by the number of characters in the - 5 September 2016 4 + 16 January 2017 4 -LATEXMK(1L) LATEXMK(1L) +LATEXMK(1) General Commands Manual LATEXMK(1) + -bs <scale> + A decimal number that specifies how large the banner message + will be printed. Experimentation is necessary to get the right + scale for your message, as a rule of thumb the scale should be + about equal to 1100 divided by the number of characters in the message. The default is 220.0 which is just right for 5 charac- ter messages. @@ -318,21 +323,20 @@ LATEXMK(1L) LATEXMK(1L) for details. - -cd Change to the directory containing the main source file before - processing it. Then all the generated files (aux, log, dvi, - pdf, etc) will be relative to the source file. - + 16 January 2017 5 - 5 September 2016 5 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1L) LATEXMK(1L) + -cd Change to the directory containing the main source file before + processing it. Then all the generated files (aux, log, dvi, + pdf, etc) will be relative to the source file. This option is particularly useful when latexmk is invoked from a GUI configured to invoke latexmk with a full pathname for the @@ -384,22 +388,23 @@ LATEXMK(1L) LATEXMK(1L) Users familiar with GNU automake and gcc will find that the -deps option is very similar in its purpose and results to the -M option to gcc. (In fact, latexmk also has options -M, -MF, - and -MP options that behave like those of gcc.) - -dependents - Equivalent to -deps. + + 16 January 2017 6 - 5 September 2016 6 +LATEXMK(1) General Commands Manual LATEXMK(1) + and -MP options that behave like those of gcc.) -LATEXMK(1L) LATEXMK(1L) + -dependents + Equivalent to -deps. -deps- Do not show a list of dependent files after processing. (This @@ -449,38 +454,38 @@ LATEXMK(1L) LATEXMK(1L) -e <code> Execute the specified initialization code before processing. The code is Perl code of the same form as is used in latexmk's - initialization files -- for more details, see the information on - the -r option, and the section about "Configuration/initializa- - tion (RC) files". The code is typically a sequence of assign- - ment statements separated by semicolons. - The code is executed when the -e option is encountered during - latexmk's parsing of its command line. See the -r option for a - way of executing initialization code from a file. An error - results in latexmk stopping. Multiple instances of the -r and + 16 January 2017 7 - 5 September 2016 7 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1L) LATEXMK(1L) + initialization files. For more details, see the information on + the -r option, and the section about "Configuration/initializa- + tion (RC) files". The code is typically a sequence of assign- + ment statements separated by semicolons. + The code is executed when the -e option is encountered during + latexmk's parsing of its command line. See the -r option for a + way of executing initialization code from a file. An error + 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. Some care is needed to deal with proper quoting of special char- acters in the code on the command line. For example, suppose you want to set the latex command to use its -shell-escape - option, then under UNIX/LINUX you could use the line + option, then under UNIX/Linux you could use the line latexmk -e '$latex=q/latex %O -shell-escape %S/' file.tex - Note that the single quotes block normal UNIX/LINUX command + Note that the single quotes block normal UNIX/Linux command shells from treating the characters inside the quotes as spe- cial. (In this example, the q/.../ construct is a Perl idiom equivalent to using single quotes. This avoids the complica- @@ -498,44 +503,50 @@ LATEXMK(1L) LATEXMK(1L) latexmk -e "$latex='latex %O -shell-escape %S'" file.tex - The last two examples will NOT work with UNIX/LINUX command + The last two examples will NOT work with UNIX/Linux command shells. + (Note: the above examples show are to show how to use the -e to + specify initialization code to be executed. But the particular + effect can be achieved also by the use of the -latex option with + less problems in dealing with quoting.) + - -f Force latexmk to continue document processing despite errors. + -f Force latexmk to continue document processing despite errors. Normally, when latexmk detects that LaTeX or another program has found an error which will not be resolved by further processing, no further processing is carried out. - Note: "Further processing" means the running of other programs - or the rerunning of latex (etc) that would be done if no errors - had occurred. If instead, or additionally, you want the latex - (etc) program not to pause for user input after an error, you - should arrange this by an option that is passed to the program, - e.g., by latexmk's option -interaction=nonstopmode. + Note: "Further processing" means the running of other programs + or the rerunning of latex (etc) that would be done if no errors + had occurred. If instead, or additionally, you want the latex - -f- Turn off the forced processing-past-errors such as is set by the - -f option. This could be used to override a setting in a con- - figuration file. + 16 January 2017 8 - -g Force latexmk to process document fully, even under situations - where latexmk would normally decide that no changes in the - source files have occurred since the previous run. This option - is useful, for example, if you change some options and wish to - reprocess the files. - 5 September 2016 8 +LATEXMK(1) General Commands Manual LATEXMK(1) + (etc) program not to pause for user input after an error, you + should arrange this by an option that is passed to the program, + e.g., by latexmk's option -interaction=nonstopmode. + -f- Turn off the forced processing-past-errors such as is set by the + -f option. This could be used to override a setting in a con- + figuration file. -LATEXMK(1L) LATEXMK(1L) + + -g Force latexmk to process document fully, even under situations + where latexmk would normally decide that no changes in the + source files have occurred since the previous run. This option + is useful, for example, if you change some options and wish to + reprocess the files. -g- Turn off -g. @@ -550,17 +561,17 @@ LATEXMK(1L) LATEXMK(1L) -jobname=STRING - Set the basename of output files(s) to STRING, instead of the + Set the basename of output files(s) to STRING, instead of the default, which is the basename of the specified TeX file. - This is like the same option for current implementations of the - latex, pdflatex, etc, and the passing of this option to these + This is like the same option for current implementations of the + latex, pdflatex, etc, and the passing of this option to these programs is part of latexmk's implementation of -jobname. -l Run in landscape mode, using the landscape mode for the preview- - ers and the dvi to postscript converters. This option is not - normally needed nowadays, since current previewers normally + ers and the dvi to postscript converters. This option is not + normally needed nowadays, since current previewers normally determine this information automatically. @@ -569,41 +580,60 @@ LATEXMK(1L) LATEXMK(1L) -latex="COMMAND" This sets the string specifying the command to run latex, and is - typically used to add desired options. Since the string nor- + typically used to add desired options. Since the string nor- mally contains spaces, it should be quoted, e.g., latexmk -latex="latex --shell-escape %O %S" foo.tex - The specification of the contents of the string are the same as - for the $latex configuration variable. Depending on your oper- - ating system and the command-line shell you are using, you may - need to change the single quotes to double quotes (or something + The specification of the contents of the string are the same as + + + + 16 January 2017 9 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + + for the $latex configuration variable. Depending on your oper- + ating system and the command-line shell you are using, you may + need to change the single quotes to double quotes (or something else). To set the command for running pdflatex (rather than the command for latex) see the -pdflatex option. - Note that the effect of this option can also be achieved by - using the -e option with a suitable line of Perl code to set the - $latex variable. See the explanation of the -e option. - - -lualatex - Use lualatex. That is, use lualatex to process the source - file(s) to pdf (in place of pdflatex). This option is exactly - equivalent to specifying the following sequence of options: + -logfilewarninglist + -logfilewarnings After a run of (pdf)latex, give a list of warn- + ings about undefined citations and references (unless silent + mode is on). - -pdflatex="lualatex %O %S" -pdf -dvi- -ps- + See also the $silence_logfile_warnings configuration variable. + -logfilewarninglist- + -logfilewarnings- After a run of (pdf)latex, do not give a list + of warnings about undefined citations and references. (Default) - 5 September 2016 9 + See also the $silence_logfile_warnings configuration variable. + -lualatex + Use lualatex. That is, use lualatex to process the source + file(s) to pdf. The generation of dvi and postscript files is + turned off. + This option is equivalent to using the following set of options + -pdflua -dvi- -ps- -LATEXMK(1L) LATEXMK(1L) + (Note: Note that the method of implementation of this option, + but not its intended effect, differ from some earlier versions + of latexmk.) -M Show list of dependent files after processing. This is equiva- @@ -615,10 +645,23 @@ LATEXMK(1L) LATEXMK(1L) write it to. - -MP If a list of dependents is made, includes phony target for each + -MP If a list of dependents is made, 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. + dummy rules work around errors the program make gives if you + remove header files without updating the Makefile to match. + + + + + + + 16 January 2017 10 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) -new-viewer @@ -639,67 +682,60 @@ LATEXMK(1L) LATEXMK(1L) -nobibtex - Never run bibtex or biber. - - A common use for this option is when a document comes from an - external source, complete with its bbl file(s), and the user - does not have the corresponding bib files available. In this - situation use of the -nobibtex option will prevent latexmk from - trying to run bibtex or biber, which would result in overwriting - of the bbl files. + Never run bibtex or biber. Equivalent to the -bibtex- option. -norc Turn off the automatic reading of initialization (rc) files. - N.B. Normally the initialization files are read and obeyed, and - then command line options are obeyed in the order they are - encountered. But -norc is an exception to this rule: it is + N.B. Normally the initialization files are read and obeyed, and + then command line options are obeyed in the order they are + encountered. But -norc is an exception to this rule: it is acted on first, no matter where it occurs on the command line. -outdir=FOO or -output-directory=FOO - Sets the directory for the output files of (pdf)latex. This - achieves its effect by the -output-directory option of + Sets the directory for the output files of (pdf)latex. This + achieves its effect by the -output-directory option of (pdf)latex, which currently (Dec. 2011 and later) is implemented + on the common versions of (pdf)latex, i.e., MiKTeX and TeXLive. + It may not be present in other versions. + See also the -auxdir/-aux-directory options, and the $aux_dir, + $out_dir, and $search_path_separator configuration variables of + latexmk. In particular, see the documentation of $out_dir for + some complications on what directory names are suitable. + If you also use the -cd option, and the specified output direc- + tory is a relative path, then the path is interpreted relative + to the document directory. - 5 September 2016 10 + -p Print out the document. By default the file to be printed is + the first in the list postscript, pdf, dvi that is being made. + But you can use the -print=... option to change the type of file + to be printed, and you can configure this in a start up file (by + setting the $print_type variable). + However, printing is enabled by default only under UNIX/Linux -LATEXMK(1L) LATEXMK(1L) + 16 January 2017 11 - on the common versions of (pdf)latex, i.e., MiKTeX and TeXLive. - It may not be present in other versions. - See also the -auxdir/-aux-directory options, and the $aux_dir, - $out_dir, and $search_path_separator configuration variables of - latexmk. In particular, see the documentation of $out_dir for - some complications on what directory names are suitable. - If you also use the -cd option, and the specified output direc- - tory is a relative path, then the path is interpreted relative - to the document directory. +LATEXMK(1) General Commands Manual LATEXMK(1) - -p Print out the document. By default the file to be printed is - the first in the list postscript, pdf, dvi that is being made. - But you can use the -print=... option to change the type of file - to be printed, and you can configure this in a start up file (by - setting the $print_type variable). - However, printing is enabled by default only under UNIX/LINUX systems, where the default is to use the lpr command and only on postscript files. In general, the correct behavior for printing - very much depends on your system's software. In particular, - under MS-Windows you must have suitable program(s) available, + very much depends on your system's software. In particular, + under MS-Windows you must have suitable program(s) available, and you must have configured the print commands used by latexmk. - This can be non-trivial. See the documentation on the $lpr, + This can be non-trivial. See the documentation on the $lpr, $lpr_dvi, and $lpr_pdf configuration variables to see how to set the commands for printing. @@ -707,44 +743,63 @@ LATEXMK(1L) LATEXMK(1L) turns them off. - -pdf Generate pdf version of document using pdflatex. (If you wish + -pdf Generate pdf version of document using pdflatex. (If you wish to use lualatex or xelatex, you can use whichever of the options - -lualatex or -xelatex applies.) To configure latexmk to have - such behavior by default, see the section on "Configuration/ini- - tialization (rc) files". + -pdflua, -pdfxe, -lualatex or -xelatex applies.) To configure + latexmk to have such behavior by default, see the section on + "Configuration/initialization (rc) files". -pdfdvi - Generate pdf version of document from the dvi file, by default + Generate pdf version of document from the dvi file, by default using dvipdf. - -pdfps Generate pdf version of document from the ps file, by default + -pdflua + Generate pdf version of document using lualatex. + + + -pdfps Generate pdf version of document from the ps file, by default using ps2pdf. + -pdfxe Generate pdf version of document using xelatex. Note that to + optimize processing time, latexmk uses xelatex to generate an + xdv file rather than a pdf file directly. Only after possibly + multiple runs to generate a fully up-to-date xdv does latexmk + then call xdvipdfmx to generate the final pdf file. + + (Note: When the document includes large graphics files, espe- + cially png files, the last step can be quite time consuming, + even when the creation of the xdv file by xelatex is fast. So + the use of the intermediate xdv file can result in substantial + gains in procesing time, since the pdf file is produced once + rather than on every run of xelatex.) + + -pdf- Turn off generation of pdf version of document. (This can be used to override a setting in a configuration file. It may get overridden if some other option requires the generation of a pdf file.) - -pdflatex="COMMAND" - This sets the string specifying the command to run pdflatex, and - is typically used to add desired options. Since the string - 5 September 2016 11 + + 16 January 2017 12 -LATEXMK(1L) LATEXMK(1L) +LATEXMK(1) General Commands Manual LATEXMK(1) - normally contains spaces, it should be quoted, e.g., + -pdflatex="COMMAND" + This sets the string specifying the command to run pdflatex, and + is typically used to add desired options. Since the string nor- + mally contains spaces, it should be quoted, e.g., latexmk -pdf -pdflatex="pdflatex --shell-escape %O %S" foo.tex @@ -755,32 +810,17 @@ LATEXMK(1L) LATEXMK(1L) may need to change the single quotes to double quotes (or some- thing else). - This option can also be used to set a program to be used instead - of the standard pdflatex program, e.g., - - latexmk -pdf -pdflatex="lualatex %O %S" foo.tex - - to use lualatex or - - latexmk -pdf -pdflatex="xelatex %O %S" foo.tex - - to use xelatex. - - To set the command for running latex (rather than the command + To set the command for running latex (rather than the command for pdflatex) see the -latex option. - Note that the effect of this option can also be achieved by - using the -e option with a suitable line of Perl code to set the - $pdflatex variable. See the explanation of the -e option. - -print=dvi, -print=ps, -print=pdf, -print=auto, - Define which kind of file is printed. This option also ensures + Define which kind of file is printed. This option also ensures that the requisite file is made, and turns on printing. The (default) case -print=auto determines the kind of print file - automatically from the set of files that is being made. The - first in the list postscript, pdf, dvi that is among the files + automatically from the set of files that is being made. The + first in the list postscript, pdf, dvi that is among the files to be made is the one used for print out. @@ -788,13 +828,13 @@ LATEXMK(1L) LATEXMK(1L) -ps- Turn off generation of postscript version of document. This can - be used to override a setting in a configuration file. (It may - get overridden by some other option that requires a postscript + be used to override a setting in a configuration file. (It may + get overridden by some other option that requires a postscript file, for example a request for printing.) - -pF Postscript file filtering. The argument to this option is a - filter which will generate a filtered postscript file with the + -pF Postscript file filtering. The argument to this option is a + filter which will generate a filtered postscript file with the extension ".psF". All extra processing (e.g. preview, printing) will then be performed on this filtered postscript file. @@ -802,243 +842,236 @@ LATEXMK(1L) LATEXMK(1L) latexmk -ps -pF 'psnup -2' foo.tex + or + latexmk -ps -pF "psnup -2" foo.tex + Whether to use single or double quotes round the "psnup -2" will + depend on your command interpreter, as used by the particular + version of perl and the operating system on your computer. - 5 September 2016 12 + 16 January 2017 13 -LATEXMK(1L) LATEXMK(1L) - or - latexmk -ps -pF "psnup -2" foo.tex - - Whether to use single or double quotes round the "psnup -2" will - depend on your command interpreter, as used by the particular - version of perl and the operating system on your computer. +LATEXMK(1) General Commands Manual LATEXMK(1) - -pv Run file previewer. If the -view option is used, this will - select the kind of file to be previewed (dvi, ps or pdf). Oth- - erwise the viewer views the "highest" kind of file selected, by - the -dvi, -ps, -pdf, -pdfps options, in the order dvi, ps, pdf - (low to high). If no file type has been selected, the dvi pre- - viewer will be used. This option is incompatible with the -p + -pv Run file previewer. If the -view option is used, this will + select the kind of file to be previewed (dvi, ps or pdf). Oth- + erwise the viewer views the "highest" kind of file selected, by + the -dvi, -ps, -pdf, -pdfps options, in the order dvi, ps, pdf + (low to high). If no file type has been selected, the dvi pre- + viewer will be used. This option is incompatible with the -p and -pvc options, so it turns them off. -pv- Turn off -pv. - -pvc Run a file previewer and continually update the .dvi, .ps, + -pvc Run a file previewer and continually update the .dvi, .ps, and/or .pdf files whenever changes are made to source files (see - the Description above). Which of these files is generated and - which is viewed is governed by the other options, and is the - same as for the -pv option. 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. It is also - incompatible with the -p and -pv options, so it turns these + the Description above). Which of these files is generated and + which is viewed is governed by the other options, and is the + same as for the -pv option. 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. It is also + incompatible with the -p and -pv options, so it turns these options off. - The -pvc option also turns off force mode (-f), as is normally - best for continuous preview mode. If you really want force + The -pvc option also turns off force mode (-f), as is normally + best for continuous preview mode. If you really want force mode, use the options in the order -pvc -f. With a good previewer the display will be automatically updated. - (Under some but not all versions of UNIX/Linux "gv -watch" does - this for postscript files; this can be set by a configuration - variable. This would also work for pdf files except for an - apparent bug in gv that causes an error when the newly updated - pdf file is read.) Many other previewers will need a manual + (Under some but not all versions of UNIX/Linux "gv -watch" does + this for postscript files; this can be set by a configuration + variable. This would also work for pdf files except for an + apparent bug in gv that causes an error when the newly updated + pdf file is read.) Many other previewers will need a manual update. Important note: the acroread program on MS-Windows locks the pdf - file, and prevents new versions being written, so it is a bad - idea to use acroread to view pdf files in preview-continuous - mode. It is better to use a different viewer: SumatraPDF and + file, and prevents new versions being written, so it is a bad + idea to use acroread to view pdf files in preview-continuous + mode. It is better to use a different viewer: SumatraPDF and gsview are good possibilities. - There are some other methods for arranging an update, notably - useful for many versions of xdvi and xpdf. These are best set + There are some other methods for arranging an update, notably + useful for many versions of xdvi and xpdf. These are best set in latexmk's configuration; see below. - Note that if latexmk dies or is stopped by the user, the + Note that if latexmk dies or is stopped by the user, the "forked" previewer will continue to run. Successive invocations - with the -pvc option will not fork new previewers, but latexmk - will normally use the existing previewer. (At least this will - happen when latexmk is running under an operating system where + with the -pvc option will not fork new previewers, but latexmk + will normally use the existing previewer. (At least this will + happen when latexmk is running under an operating system where + it knows how to determine whether an existing previewer is run- + ning.) + -pvc- - 5 September 2016 13 + 16 January 2017 14 -LATEXMK(1L) LATEXMK(1L) - it knows how to determine whether an existing previewer is run- - ning.) +LATEXMK(1) General Commands Manual LATEXMK(1) - -pvc- Turn off -pvc. + Turn off -pvc. -quiet Same as -silent -r <rcfile> - Read the specified initialization file ("RC file") before pro- + 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 + -- 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 - Use 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. + 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 configuration variable. -recorder- - Do not use the -recorder option with latex and pdflatex. + Do not supply the -recorder option with latex and pdflatex. -rules Show a list of latemk's rules and dependencies after processing. -rules- - Do not show a list of latexmk's rules and dependencies after + Do not show a list of latexmk's rules and dependencies after processing. (This is the default.) + 16 January 2017 15 - 5 September 2016 14 - -LATEXMK(1L) LATEXMK(1L) +LATEXMK(1) General Commands Manual LATEXMK(1) -showextraoptions - Show the list of extra latex and pdflatex options that latexmk - recognizes. These are options for the latex and pdflatex that - latexmk recognizes, but simply passes through to these programs - 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 documenta- - tion 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 + 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. - -logfilewarninglist - -logfilewarnings After a run of (pdf)latex, give a list of warn- - ings about undefined citations and references (unless silent - mode is on). - - See also the $silence_logfile_warnings configuration variable. - - - -logfilewarninglist- - -logfilewarnings- After a run of (pdf)latex, do not give a list - of warnings about undefined citations and references. (Default) - - See also the $silence_logfile_warnings configuration variable. - - -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 - latex. + 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 - generates. + 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- + tex_silent_switch, and $xelatex_silent_switch + -time Show CPU time used. See also the configuration variable + $show_time. - 5 September 2016 15 + 16 January 2017 16 -LATEXMK(1L) LATEXMK(1L) - 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, $makein- - dex_silent_switch, and $pdflatex_silent_switch. + +LATEXMK(1) General Commands Manual LATEXMK(1) + + + -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), 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 - latexmk will try as a resort using the make program to try to - make the missing files. + 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 @@ -1066,32 +1099,45 @@ LATEXMK(1L) LATEXMK(1L) -view=default, -view=dvi, -view=ps, -view=pdf, -view=none Set the kind of file used when previewing is requested (e.g., by the -pv or -pvc switches). The default is to view the "highest" - kind of requested file (in the order dvi, ps, pdf). + 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 want a previewer to be - opened. + 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 (in place of pdflatex). This option is exactly equiva- - lent to specifying the following sequence of options: + to pdf. The generation of dvi and postscript files is turned + off. + + This option is equivalent to using the following set of options + + - -pdflatex="xelatex %O %S" -pdf -dvi- -ps- + 16 January 2017 17 - 5 September 2016 16 +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.] -LATEXMK(1L) LATEXMK(1L) Compatibility between options @@ -1133,8 +1179,20 @@ DEALING WITH ERRORS, PROBLEMS, ETC 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. + it thinks would otherwise be easy to miss in the middle of other + + + + 16 January 2017 18 + + + + + +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 @@ -1152,56 +1210,54 @@ DEALING WITH ERRORS, PROBLEMS, ETC The remainder of these notes consists of ideas for dealing with more difficult situations. - - - - 5 September 2016 17 - - - - - -LATEXMK(1L) LATEXMK(1L) - - d. Further tricks can involve replacing the standard commands that - latexmk by other commands or scripts. + 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 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. - g. 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. - h. Ask a question at tex.stackexchange.com. + i. Ask a question at tex.stackexchange.com. - i. 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. + + 16 January 2017 19 + + + + + +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: @@ -1212,142 +1268,146 @@ CONFIGURATION/INITIALIZATION (RC) FILES "/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 - of cygwin), latexmk reads for the first it finds of + 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 + of cygwin), latexmk reads the first it finds of "/cygdrive/c/latexmk/LatexMk", "/opt/local/share/latexmk/LatexMk", "/usr/local/share/latexmk/LatexMk", "/usr/local/lib/latexmk/LatexMk". - In addition, it then tries the same set of locations, but with the - file name replaced "LatexMk" replaced by "latexmkrc". - - - - - 5 September 2016 18 - - - - - -LATEXMK(1L) LATEXMK(1L) + In addition, it then tries the same set of locations, but with the file + 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. - 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). + 16 January 2017 20 -HOW TO SET VARIABLES IN INITIALIZATION FILES - The important variables that can be configured are described in the - section "List of configuration variables usable in initialization - files". Syntax for setting these variables is of the following forms: - $bibtex = 'bibtex %O %B'; - for the setting of a string variable, - $preview_mode = 1; +LATEXMK(1) General Commands Manual LATEXMK(1) + knowledge of the Perl language by using the examples in this document + as templates. Comment lines are introduced by the "#" character. - 5 September 2016 19 + 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 + files". Syntax for setting these variables is of the following forms: + $bibtex = 'bibtex %O %B'; -LATEXMK(1L) LATEXMK(1L) + for the setting of a string variable, + $preview_mode = 1; for the setting of a numeric variable, and @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. + + + + 16 January 2017 21 + + + + + +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 + 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 - for this command. (E.g., if you used the -silent option it would - replace %O by "-interaction=batchmode".) + 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=batchmode".) The available placeholders are: @@ -1362,18 +1422,6 @@ FORMAT OF COMMAND SPECIFICATIONS %R root filename. This is the base name for the main tex file. - - - - 5 September 2016 20 - - - - - -LATEXMK(1L) LATEXMK(1L) - - %S source file (e.g., the name of the dvi file when converting a dvi file to ps). @@ -1383,41 +1431,51 @@ LATEXMK(1L) LATEXMK(1L) 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 '\'. + 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 - subject to the above rules, use a pair of these characters. Thus with - the command specification $ps_previewer = 'latex -ad=%%Sfile.ad %S', - the %%S will become %S when the command is executed, but the %S will be - replaced by the source filename, which in this case would be the name - of a postscript file to be viewed. + 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 + 16 January 2017 22 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + + 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 + 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 + 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- - poses, the name %T of the primary texfile is not a useful placeholder. + 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 usable in initialization files" for what is normally the most appropri- @@ -1432,18 +1490,6 @@ LATEXMK(1L) LATEXMK(1L) 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 - - - - 5 September 2016 21 - - - - - -LATEXMK(1L) LATEXMK(1L) - - 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 command name with "start ", as in @@ -1464,6 +1510,18 @@ LATEXMK(1L) LATEXMK(1L) problem. Command names containing spaces: Under MS-Windows it is common that the + + + + 16 January 2017 23 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + 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 @@ -1476,12 +1534,12 @@ LATEXMK(1L) LATEXMK(1L) traPDF.exe" %O %S'; - (Note about the above example: Forward slashes are equivalent to back- - slashes in filenames under MS-Windows, 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 strings in the Perl lan- - guage.) + (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 + 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 + strings in the Perl language.) Command names under Cygwin: If latexmk is executed by Cygwin's Perl, be particularly certain that pathnames in commands have forward slashes @@ -1497,44 +1555,42 @@ LATEXMK(1L) LATEXMK(1L) $dvi_previewer = 'start %S'; - Under recent versions of MS-Windows, this will cause to be run whatever - program the system has associated with dvi files. (The same applies - for a postscript viewer and a pdf viewer.) But note that this trick is - not always suitable for the pdf previwer, if your system has acroread - for the default pdf viewer. As explained elsewhere, acroread under MS- + Under MS-Windows, this will cause to be run whatever program the system + has associated with dvi files. (The same applies for a postscript + viewer and a pdf viewer.) But note that this trick is not always suit- + 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. + Not using a certain command: If a command is not to be run, the command + name NONE is used, as in + $lpr = 'NONE lpr'; - 5 September 2016 22 + 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 + file: -LATEXMK(1L) LATEXMK(1L) + 16 January 2017 24 - Windows does not work well with latex and latexmk, because acroread - locks the pdf file. - Not using a certain command: If a command is not to be run, the command - name NONE is used, as in - $lpr = 'NONE lpr'; - This typically is used when an appropriate command does not exist on - your system. The string after the "NONE" is effectively a comment. +LATEXMK(1) General Commands Manual LATEXMK(1) - 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 - file: $latex = 'latex --src-specials %O %S'; - - Running a subroutine instead of an external command: Use a specifica- + Running a subroutine instead of an external command: Use a specifica- tion starting with "internal", as in $latex = 'internal mylatex %O %S'; @@ -1544,70 +1600,71 @@ LATEXMK(1L) LATEXMK(1L) 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 + $pdflatex = 'cmd /c pdflatex --shell-escape %O %S' + . '&& pst2pdf_for_latexmk %B'; + 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 MS-Windows command-line processor cmd.exe. - 5 September 2016 23 +LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES + Default values are indicated in brackets. + $always_view_file_via_temporary [0] + Whether ps and pdf files are initially to be made in a temporary + 16 January 2017 25 -LATEXMK(1L) LATEXMK(1L) - $pdflatex = 'cmd /c pdflatex --shell-escape %O %S' - . '&& pst2pdf_for_latexmk %B'; - 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 MS-Windows command-line processor cmd.exe. +LATEXMK(1) General Commands Manual LATEXMK(1) -LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES - Default values are indicated in brackets. - $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 + 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.) + 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 sees - that the file has changed, it reads the new file, and this can - cause havoc if the program writing the file has not yet finished - its work. + 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. @@ -1641,29 +1698,28 @@ LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES 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) + 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 + -d option. - 5 September 2016 24 + 16 January 2017 26 -LATEXMK(1L) LATEXMK(1L) - contains a relative path, then the path is interpreted relative - to the document directory. +LATEXMK(1) General Commands Manual LATEXMK(1) - $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 - -d option. - Note that if $banner is nonzero, the $postscript_mode is assumed and the postscript file is always generated, even if it is newer than the dvi file. @@ -1713,22 +1769,23 @@ LATEXMK(1L) LATEXMK(1L) 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 - 5 September 2016 25 + 16 January 2017 27 -LATEXMK(1L) LATEXMK(1L) - $biber ["biber %O %S"] - The biber processing program. +LATEXMK(1) General Commands Manual LATEXMK(1) + - $biber_silent_switch ["--onlylog"] - Switch(es) for the biber processing program when silent mode is on. $bibtex ["bibtex %O %S"] @@ -1739,19 +1796,19 @@ LATEXMK(1L) LATEXMK(1L) on. $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- + 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 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 + are provided. In that case use of bibtex or biber will result in incorrect overwriting of the precious bbl files. The vari- able $bibtex_use controls whether this happens. Its possible - values are: 0: never use BibTeX or biber. 1: only use BibTeX or - biber if the bib files exist. 2: run BibTeX or biber whenever + values are: 0: never use BibTeX or biber. 1: only use bibtex or + biber if the bib files exist. 2: run bibtex or biber whenever it appears necessary to update the bbl files, without testing for the existence of the bib files. @@ -1781,21 +1838,20 @@ LATEXMK(1L) LATEXMK(1L) $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 - variable is a string containing the extensions separated by + variable is a string containing the extensions separated by spa- + ces. - 5 September 2016 26 + 16 January 2017 28 -LATEXMK(1L) LATEXMK(1L) +LATEXMK(1) General Commands Manual LATEXMK(1) - spaces. - It is also possible to specify a more general pattern of file to be deleted, by using the place holder %R, as in commands, and it is also possible to use wildcards. Thus setting @@ -1820,17 +1876,17 @@ LATEXMK(1L) LATEXMK(1L) $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 + 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 + 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 @@ -1851,19 +1907,18 @@ LATEXMK(1L) LATEXMK(1L) 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 - - 5 September 2016 27 + 16 January 2017 29 -LATEXMK(1L) LATEXMK(1L) +LATEXMK(1) General Commands Manual LATEXMK(1) + Other placeholders that can be used are %S, %T, and %R, with %S and %T normally being identical. These can be useful for a com- mand changing the title of the edit window. The visual indica- tion in a window title can useful, since the user does not have @@ -1872,20 +1927,20 @@ LATEXMK(1L) LATEXMK(1L) @cus_dep_list [()] - Custom dependency list -- see section on "Custom Dependencies". + 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"); @@ -1893,11 +1948,11 @@ LATEXMK(1L) LATEXMK(1L) @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 + 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. @@ -1905,196 +1960,199 @@ LATEXMK(1L) LATEXMK(1L) @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: - @default_files = ("paper_current"); - @default_files = ("paper1", "paper2.tex"); + 16 January 2017 30 - 5 September 2016 28 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1L) LATEXMK(1L) + Three examples: + @default_files = ("paper_current"); + + @default_files = ("paper1", "paper2.tex"); @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 + 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 + 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 - will be set to 1. + 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 - $dvi_previewer ["start xdvi %O %S" under UNIX] - The command to invoke a dvi-previewer. [Default is "start" - under MS-WINDOWS; under more recent versions of Windows, this - 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 - detached, so that latexmk doesn't wait for the previewer to + 16 January 2017 31 - 5 September 2016 29 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1L) LATEXMK(1L) + 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 + system has associated with .dvi files.] - terminate before continuing its work. So normally you should - prefix 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 + 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. $dvi_previewer_landscape ["start xdvi %O %S"] - The command to invoke a dvi-previewer in landscape mode. - [Default is "start" under MS-WINDOWS; under more recent versions - of Windows, this will cause to be run whatever command the sys- - tem has associated with .dvi files.] + 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- + 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 + WARNING: The default dvipdf script generates pdf files with bitmapped fonts, which do not look good when viewed by acroread. - That script should be modified to give dvips the options "-P + That script should be modified to give dvips the options "-P pdf" to ensure that type 1 fonts are used in the pdf file. + $dvipdf_silent_switch ["-q"] Switch(es) for dvipdf program when silent mode is on. - N.B. The standard dvipdf program runs silently, so adding the - silent switch has no effect, but is actually innocuous. But if - an alternative program is used, e.g., dvipdfmx, then the silent - switch has an effect. The default setting is correct for + N.B. The standard dvipdf program runs silently, so adding the + silent switch has no effect, but is actually innocuous. But if + an alternative program is used, e.g., dvipdfmx, then the silent + switch has an effect. The default setting is correct for 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 -- 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 - file in landscape mode. + 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_pdf_switch ["-P pdf"] - 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 - the variable $dvi_update_method for further information, and see - information on the variable $pdf_update_method for an example + 16 January 2017 32 - 5 September 2016 30 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1L) LATEXMK(1L) + $dvips_landscape ["dvips -tlandscape %O -o %D %S"] + 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 + 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 + the variable $dvi_update_method for further information, and see + 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- + See information on the variable $pdf_update_method for an exam- ple of updating by command. - $dvi_update_signal [Under UNIX: SIGUSR1, which is a system-dependent + $dvi_update_signal [Under UNIX: SIGUSR1, which is a system-dependent value] The number of the signal that is sent to the dvi viewer when it is updated by sending a signal -- see the information on the @@ -2112,158 +2170,183 @@ LATEXMK(1L) LATEXMK(1L) $force_mode [0] 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 , - $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, - either directly or indirectly. - 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 - (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 - error in a source .tex file during the run. So latexmk needs to - distinguish user-generated and automatically generated files; it + 16 January 2017 33 - 5 September 2016 31 +LATEXMK(1) General Commands Manual LATEXMK(1) + -f option. -LATEXMK(1L) LATEXMK(1L) + @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, + either directly or indirectly. + 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 + (pdf)LaTeX is needed after a run that gives an error. - determines the automatically generated files as those with + (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 + 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 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 + 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. You can instruct latex to ignore the offending line as follows: + + + + 16 January 2017 34 + + + + + +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 + use Perl's delete function, e.g., + delete $hash_calc_ignore_pattern{'eps'}; - 5 September 2016 32 + $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 + 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- + 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 + STDOUT of running the command is then piped to latexmk.) + See also the @BIBINPUTS variable for another way that latexmk -LATEXMK(1L) LATEXMK(1L) + 16 January 2017 35 - 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 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 .bib files are found from the log file of a bibtex - or biber run, the name of the file, but not its path is known. - The program specified by $kpsewhich is used to find it. - - See also the @BIBINPUTS variable for another way that latexmk + +LATEXMK(1) General Commands Manual LATEXMK(1) + + also uses to try to locate files; it applies only in the case of .bib files. $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 + In this situation, latexmk searches for custom dependencies to + make the missing file(s), but restricts it to the extensions + specified by the variable %latex_input_extensions. The default extensions are 'tex' and 'eps'. - (For Perl experts: %latex_input_extensions is a hash whose keys - are the extensions. The values are irrelevant.) Two subrou- - tines are provided for manipulating this and the related vari- - able %pdflatex_input_extensions, add_input_ext and - remove_input_ext. They are used as in the following examples + (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' ); @@ -2272,42 +2355,42 @@ LATEXMK(1L) LATEXMK(1L) add_input_ext( 'latex', 'asdf' ); + 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. + $latex_silent_switch ["-interaction=batchmode"] + Switch(es) for the LaTeX processing program when silent mode is + on. - 5 September 2016 33 + If you use MikTeX, you may prefer the results if you configure + 16 January 2017 36 -LATEXMK(1L) LATEXMK(1L) - 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. +LATEXMK(1) General Commands Manual LATEXMK(1) - $latex_silent_switch ["-interaction=batchmode"] - 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 + the options to include -c-style-errors, e.g., by the following line in an initialization file $latex_silent_switch = "-interaction=batchmode -c-style- errors"; - $lpr ["lpr %O %S" under UNIX/LINUX, "NONE lpr" under MS-WINDOWS] + $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": @@ -2334,221 +2417,237 @@ LATEXMK(1L) LATEXMK(1L) $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. - $make ["make"] - The make processing program. + $lualatex ["lualatex %O %S"] + 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 + 16 January 2017 37 - 5 September 2016 34 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1L) LATEXMK(1L) + + \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'. + + 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 + $lualatex) when silent mode is on. + + See details of the $latex_silent_switch for other information + that equally applies to $lualatex_silent_switch. + + + $make ["make"] + The make processing program. $makeindex ["makeindex %O -o %D %S"] 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 + 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 + resolve cross-references, etc. The default value covers all normal cases. - (Note that the "etc" covers a lot of cases where one run of + (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 "\". 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 possi- - ble example might be when some of the software is implemented - using Cygwin, which provides an Unix-like environment inside MS- - Windows.) + 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 - $new_viewer_always [0] - 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 - no viewer is running. + 16 January 2017 38 - $out_dir [""] - 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 - 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 - the document directory. - Commonly, the directory specified for output files is a +LATEXMK(1) General Commands Manual LATEXMK(1) - 5 September 2016 35 + be changed. (A possible example might be when some of the soft- + 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 + 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 + no viewer is running. + $out_dir [""] + 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. -LATEXMK(1L) LATEXMK(1L) + 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 + the document directory. - subdirectory of the current working directory. However, if you - specify 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 + 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 + part of security measures by the whole TeX system that try to prevent malicious or errant TeX documents from incorrectly mess- ing with a user's files. If for $out_dir or $aux_dir you really - do need to specify an absolute pathname (e.g., "/tmp/foo") or a + do need to specify an absolute pathname (e.g., "/tmp/foo") or a path (e.g., "../output") that includes a higher-level directory, - and you need to use makeindex or bibtex, then you need to dis- - able the security measures (and assume any risks). One way of + and you need to use makeindex or bibtex, then you need to dis- + able the security measures (and assume any risks). One way of doing this is to temporarily set an operating system environment - variable openout_any to "a" (as in "all"), to override the + 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. If equal to 2, generate a pdf version of the document from - the ps file, by using the command specified by the $ps2pdf vari- - able. If equal to 3, generate a pdf version of the document - from the dvi file, by using the command specified by the $dvipdf - variable. - - Equivalent to the -pdf-, -pdf, -pdfdvi, -pdfps options. - - - $pdflatex ["pdflatex %O %S"] - The LaTeX processing program in a version that makes a pdf file - instead of a dvi file. + 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 - An example of the use of this variable is to arrange for luala- - tex, xelatex or some similar program to be used instead of - pdflatex. Note that lualatex and xelatex only produce .pdf - files (and not .dvi), so to use them you will also need to turn - on production of .pdf files, and to turn off the production of - .dvi (and .ps) files, either by command line options or by suit- - able settings in a configuration file. Thus to use lualatex, the - following settings are appropriate: - $pdflatex = "lualatex %O %S"; - $pdf_mode = 1; $postscript_mode = $dvi_mode = 0; - To use xelatex, the corresponding settings are: + 16 January 2017 39 - $pdflatex = "xelatex %O %S"; - $pdf_mode = 1; $postscript_mode = $dvi_mode = 0; - Another use of the same variable is to add certain options to - the command line for the program, e.g., - $pdflatex = "pdflatex --shell-escape %O %S"; +LATEXMK(1) General Commands Manual LATEXMK(1) - %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 + 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 + made. - 5 September 2016 36 + $pdflatex ["pdflatex %O %S"] + 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 + command line for the program, e.g., + $pdflatex = "pdflatex --shell-escape %O %S"; -LATEXMK(1L) LATEXMK(1L) + (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 + $xelatex.) - not been found, and the file is given without an extension. - This typically happens when LaTeX commands of the form + %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 \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'. - (For Perl experts: %pdflatex_input_extensions is a hash whose - keys are the extensions. The values are irrelevant.) Two sub- - routines are provided for manipulating this and the related - variable %latex_input_extensions, add_input_ext and - remove_input_ext. They are used as in the following examples - are possible lines in an initialization file: + See details of the %latex_input_extensions for other information + that equally applies to %pdflatex_input_extensions. - remove_input_ext( 'pdflatex', 'tex' ); - removes the extension 'tex' from pdflatex_input_extensions + $pdflatex_silent_switch ["-interaction=batchmode"] + Switch(es) for the pdflatex program (specified in the variable + $pdflatex) when silent mode is on. - add_input_ext( 'pdflatex', 'asdf' ); + See details of the $latex_silent_switch for other information + that equally applies to $pdflatex_silent_switch. - add the extension 'asdf to pdflatex_input_extensions. (Natu- - rally with such an extension, you should have made an appropri- - ate custom dependency for latexmk, 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 pdfla- - tex and its graphics/graphicx packages.) - $pdflatex_silent_switch ["-interaction=batchmode"] - Switch(es) for the pdflatex program (specified in the variable - $pdflatex when silent mode is on. + 16 January 2017 40 + + - 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- - errors"; + +LATEXMK(1) General Commands Manual LATEXMK(1) $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 -- @@ -2564,18 +2663,6 @@ LATEXMK(1L) LATEXMK(1L) 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 - - - - 5 September 2016 37 - - - - - -LATEXMK(1L) LATEXMK(1L) - - example, SumatraPDF or gsview is used to view pdf files. Important note: Normally you will want to have a previewer run @@ -2611,6 +2698,18 @@ LATEXMK(1L) LATEXMK(1L) $pdf_previewer = "start xpdf -remote %R %O %S"; $pdf_update_method = 4; + + + + 16 January 2017 41 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + $pdf_update_command = "xpdf -remote %R -reload"; The first setting arranges for the xpdf program to be used in @@ -2622,57 +2721,61 @@ LATEXMK(1L) LATEXMK(1L) $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 - 1 (2nd word in line) is correct for Solaris 2.6 and Linux. Set- - ting the variable to -1 is used to indicate that $pscmd is not - to be used. + 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 + 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. - - - 5 September 2016 38 - - - - - -LATEXMK(1L) LATEXMK(1L) - - - 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 + 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 lpr. Equivalent to the -p - option. This is recommended not to be set from an RC file, oth- - erwise you could waste lots of paper. + If nonzero, print the document using the command specified in + the $lpr variable. Equivalent to the -p option. This is recom- + mended not to be set from an RC file, otherwise you could waste + lots of paper. $print_type = ["auto"] Type of file to printout: possibilities are "auto", "dvi", "none", "pdf", or "ps". See the option -print= for the meaning + + + + 16 January 2017 42 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + of the "auto" value. $pscmd Command used to get all the processes currently run by the user. @@ -2682,64 +2785,63 @@ LATEXMK(1L) LATEXMK(1L) 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 pro- - cess number is determined. + 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 --width 200 -f -u - $ENV{USER}" under linux, "ps -ww -u $ENV{USER}" under darwin - (Macintosh OS-X), and "ps -f -u $ENV{USER}" under other operat- - ing systems (including other flavors of UNIX). In these speci- - fications "$ENV{USER}" is substituted by the username. + (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. $ps2pdf ["ps2pdf %O %S %D"] Command to convert ps to pdf file. $ps_filter [empty] - The postscript file filter to be run on the newly produced - postscript file before other processing. Equivalent to specify- - ing the -pF option. + The postscript file filter to be run on the newly produced post- + 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 + $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 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 + letting latexmk do the detaching is not appropriate (for a vari- + ety of non-trivial reasons), so you should put the "start " bit + in yourself, whenever it is needed. - 5 September 2016 39 + $ps_previewer_landscape ["start gv -swap %O %S", but start %O %S under + MS-Windows] + 16 January 2017 43 -LATEXMK(1L) LATEXMK(1L) - of gv under different names, e.g., ggv, kghostview, etc, but - perhaps not one called gv. - Important note: Normally you will want to have a previewer run - detached, so that latexmk doesn't wait for the previewer to ter- - minate before continuing its work. So normally you should pre- - fix the command by "start ", which flags to latexmk that it - should do the detaching of the previewer itself (by whatever - method is appropriate to the operating system). But sometimes - letting latexmk do the detaching is not appropriate (for a vari- - ety of non-trivial reasons), so you should put the "start " bit - in yourself, whenever it is needed. +LATEXMK(1) General Commands Manual LATEXMK(1) - $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 [""] @@ -2759,8 +2861,8 @@ LATEXMK(1L) LATEXMK(1L) $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. @@ -2772,66 +2874,65 @@ LATEXMK(1L) LATEXMK(1L) $quote_filenames [1] This specifies whether substitutions for placeholders in command specifications (as in $pdflatex) are surrounded by double - quotes. If this variable is 1 (or any other value Perl regards + quotes. If this variable is 1 (or any other value Perl regards as true), then quoting is done. Otherwise quoting is omitted. - The quoting method used by latexmk is tested to work correctly - under UNIX systems (including Linux and Mac OS-X) and under MS- - Windows. It allows the use of filenames containing special - characters, notably spaces. (But note that many versions of - LaTeX and PdfLaTeX cannot correctly deal with TeX files whose - names contain spaces. Latexmk's quoting only ensures that such + The quoting method used by latexmk is tested to work correctly + under UNIX systems (including Linux and Mac OS-X) and under MS- + Windows. It allows the use of filenames containing special + characters, notably spaces. (But note that many versions of + latex and pdflatex cannot correctly deal with TeX files whose + names contain spaces. Latexmk's quoting only ensures that such filenames are correctly treated by the operating system in pass- ing arguments to programs.) $recorder [1] - Whether to use the -recorder option to latex and pdflatex. Use - of this option results in a file of extension .fls containing a + Whether to use the -recorder option to latex and pdflatex. Use + of this option results in a file of extension .fls containing a + list of the files that these programs have read and written. + Latexmk will then use this file to improve its detection of + 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 - 5 September 2016 40 + 16 January 2017 44 -LATEXMK(1L) LATEXMK(1L) +LATEXMK(1) General Commands Manual LATEXMK(1) - 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 pdfla- - tex. - It is generally recommended to use this option (or to configure - the $recorder variable to be on.) But it only works if (pdf)latex supports the -recorder option, which is true for most current implementations - Note about the name of the .fls file: Most implementations of - (pdf)latex produce an .fls file with the same basename as the - main document's LaTeX, e.g., for Document.tex, the .fls file is - Document.fls. However, some implementations instead produce - files named for the program, i.e., latex.fls or pdflatex.fls. - In this second case, latexmk copies the latex.fls or pdfla- - tex.fls to a file with the basename of the main LaTeX document, + Note about the name of the .fls file: Most implementations of + (pdf)latex produce an .fls file with the same basename as the + main document's LaTeX, e.g., for Document.tex, the .fls file is + Document.fls. However, some implementations instead produce + files named for the program, i.e., latex.fls or pdflatex.fls. + In this second case, latexmk copies the latex.fls or pdfla- + tex.fls to a file with the basename of the main LaTeX document, e.g., Document.fls. $search_path_separator [See below for default] The character separating paths in the environment variables TEX- - INPUTS, BIBINPUTS, and BSTINPUTS. This variable is mainly used - by latexmk when the -outdir, -output-directory, -auxdir, and/or - -aux-directory options are used. In that case latexmk needs to - communicate appropriately modified search paths to $bibtex, + INPUTS, BIBINPUTS, and BSTINPUTS. This variable is mainly used + by latexmk when the -outdir, -output-directory, -auxdir, and/or + -aux-directory options are used. In that case latexmk needs to + communicate appropriately modified search paths to bibtex, dvipdf, dvips, and (pdf)latex. - [Comment to technically savvy readers: (pdf)latex doesn't actu- - ally need the modified search path, because it corrects it - internally. But, surprisingly, dvipdf and dvips do, because - sometimes graphics files get generated in the output or aux - directories.] + [Comment to technically savvy readers: (pdf)latex doesn't actu- + ally need the modified search path. But, surprisingly, dvipdf + and dvips do, because sometimes graphics files get generated in + the output or aux directories.] The default under MSWin and Cygwin is ';' and under UNIX-like operating systems (including Linux and OS-X) is ':'. Normally @@ -2844,6 +2945,10 @@ LATEXMK(1L) LATEXMK(1L) the MSWin, Linux, OS-X, Unix collection.) + $show_time [0] + Whether to show CPU time used. + + $silence_logfile_warnings [0] Whether after a run of (pdf)latex to summarize warnings in the log file about undefined citations and references. Setting @@ -2857,23 +2962,25 @@ LATEXMK(1L) LATEXMK(1L) also set this variable. Note that multiple occurrences for the same undefined object on - the same page and same line will be compressed to a single warn- - ing. - $silent [0] - Whether to run silently. Setting $silent to 1 has the same - effect as the -quiet of -silent options on the command line. + 16 January 2017 45 - 5 September 2016 41 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1L) LATEXMK(1L) + the same page and same line will be compressed to a single warn- + ing. + + + $silent [0] + Whether to run silently. Setting $silent to 1 has the same + effect as the -quiet of -silent options on the command line. $sleep_time [2] @@ -2921,6 +3028,18 @@ LATEXMK(1L) LATEXMK(1L) Note that once a missing file has been made, no further calls to make will be made on a subsequent run of latexmk to update the file. Handling this problem is the job of a suitably defined + + + + 16 January 2017 46 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + Makefile. See the section "USING latexmk WITH make" for how to do this. The intent of calling make from latexmk is merely to detect dependencies. @@ -2932,28 +3051,71 @@ LATEXMK(1L) LATEXMK(1L) generated is to be used (among dvi, ps and pdf). -CUSTOM DEPENDENCIES - In any RC file a set of custom dependencies can be set up to convert a - file with one extension to a file with another. An example use of this - would be to allow latexmk to convert a .fig file to .eps to be included - in the .tex file. + $xdvipdfmx ["xdvipdfmx -o %D %O %S"] + + The program to make a pdf file from an xdv file (used in con- + junction with xelatex when $pdf_mode=5). + + + $xdvipdfmx_silent_switch ["-q"] + Switch(es) for the xdvipdfmx program when silent mode is on. + + + $xelatex ["xelatex %O %S"] + The LaTeX processing program of in a version that makes a pdf + file instead of a dvi file, when the xelatex program is called + for. See the documentation of the -xelatex option for some spe- + cial properties of latexmk's use of xelatex. + + + %xelatex_input_extensions + This variable specifies the extensions tried by latexmk when it + finds that an xelatex run resulted in an error that a file has + not been found, and the file is given without an extension. + This typically happens when LaTeX commands of the form + \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 %xelatex_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 %xelatex_input_extensions. - The old method of configuring latexmk was to directly manipulate the - @cus_dep_list array that contains information defining the custom - dependencies. This method still works. But now there are subroutines + $xelatex_silent_switch ["-interaction=batchmode"] + Switch(es) for the xelatex program (specified in the variable + $xelatex) when silent mode is on. + See details of the $latex_silent_switch for other information + that equally applies to $xelatex_silent_switch. - 5 September 2016 42 -LATEXMK(1L) LATEXMK(1L) + 16 January 2017 47 - that allow convenient manipulations of the custom dependency list. + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + +CUSTOM DEPENDENCIES + In any RC file a set of custom dependencies can be set up to convert a + file with one extension to a file with another. An example use of this + would be to allow latexmk to convert a .fig file to .eps to be included + in the .tex file. + + The old method of configuring latexmk was to directly manipulate the + @cus_dep_list array that contains information defining the custom + dependencies. This method still works. But now there are subroutines + that allow convenient manipulations of the custom dependency list. These are add_cus_dep( fromextension, toextension, must, subroutine ) @@ -2964,42 +3126,55 @@ LATEXMK(1L) LATEXMK(1L) follow: from extension: - The extension of the file we are converting from (e.g. "fig"). + The extension of the file we are converting from (e.g. "fig"). It is specified without a period. to extension: The extension of the file we are converting to (e.g. "eps"). It is specified without a period. - must: If non-zero, the file from which we are converting must exist, - if it doesn't exist latexmk will give an error message and exit + must: If non-zero, the file from which we are converting must exist, + if it doesn't exist latexmk will give an error message and exit unless the -f option is specified. If must is zero and the file we are converting from doesn't exist, then no action is taken. function: - The name of the subroutine that latexmk should call to perform - the file conversion. The first argument to the subroutine is + The name of the subroutine that latexmk should call to perform + the file conversion. The first argument to the subroutine is the base name of the file to be converted without any extension. - The subroutines are declared in the syntax of Perl. The func- - tion should return 0 if it was successful and a nonzero number + The subroutines are declared in the syntax of Perl. The func- + tion should return 0 if it was successful and a nonzero number if it failed. - It is invoked whenever latexmk detects that a run of latex/pdflatex - needs to read a file, like a graphics file, whose extension is the to- - extension of a custom dependency. Then latexmk examines whether a file - exists with the same name, but with the corresponding from-extension, - as specified in the custom-dependency rule. If it does, then whenever - the destination file (the one with the to-extension) is out-of-date - with respect to the corresponding source file. + A custom dependency rule is invoked whenever latexmk detects that a run + of latex/pdflatex needs to read a file, like a graphics file, whose + 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. + If it does, then the rule whenever the destination file (the one with + the to-extension) is out-of-date with respect to the corresponding + source file. To make the new destination file, the Perl subroutine specified in the rule is invoked, with an argument that is the base name of the files in question. Simple cases just involve a subroutine invoking an external program; this can be done by following the templates below, even by those without knowledge of the Perl programming language. Of course, + + + + 16 January 2017 48 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + experts could do something much more elaborate. - One other item in each custom-dependency rule labeled "must" above + One other item in each custom-dependency rule, labeled "must" above, specifies how the rule should be applied when the source file fails to exist. @@ -3007,7 +3182,7 @@ LATEXMK(1L) LATEXMK(1L) add_cus_dep( 'fig', 'eps', 0, 'fig2eps' ); sub fig2eps { - system( "fig2dev -Leps \"$_[0].fig\" \"$_[0].eps\"" ); + return system( "fig2dev -Leps \"$_[0].fig\" \"$_[0].eps\"" ); } The first line adds a custom dependency that converts a file with @@ -3018,18 +3193,6 @@ LATEXMK(1L) LATEXMK(1L) initialization file), the latexmk will delete this rule before making the new one. - - - - 5 September 2016 43 - - - - - -LATEXMK(1L) LATEXMK(1L) - - Suppose latexmk is using this rule to convert a file "figure.fig" to "figure.eps". Then it will invoke the fig2eps subroutine defined in the above code with a single argument "figure", which is the basename @@ -3052,7 +3215,7 @@ LATEXMK(1L) LATEXMK(1L) add_cus_dep( 'fig', 'pdf, 0, 'fig2pdf' ); sub fig2pdf { - system( "fig2dev -Lpdf \"$_[0].fig\" \"$_[0].pdf\"" ); + return system( "fig2dev -Lpdf \"$_[0].fig\" \"$_[0].pdf\"" ); } Note 1: In the command lines given in the system commands in the above @@ -3063,6 +3226,18 @@ LATEXMK(1L) LATEXMK(1L) normally safer to keep them in. Even though the rules for quoting vary between operating systems, command shells and individual pieces of software, the quotes in the above examples do not cause problems in the + + + + 16 January 2017 49 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + cases I have tested. Note 2: One case in which the quotes are important is when the files @@ -3095,18 +3270,6 @@ LATEXMK(1L) LATEXMK(1L) in to latexmk is from an ".idx" file written on one run of latex/pdfla- tex to an ".ind" file to be read in on a subsequent run. But with the index.sty package you can create extra indexes with extensions that you - - - - 5 September 2016 44 - - - - - -LATEXMK(1L) LATEXMK(1L) - - configure. Latexmk does not know how to deduce the extensions from the information it has. But you can easily write a custom dependency. For example if your latex file uses the command "\newindex{spe- @@ -3116,24 +3279,33 @@ LATEXMK(1L) LATEXMK(1L) add_cus_dep('ndx', 'nnd', 0, 'makendx2nnd'); sub makendx2nnd { - system( "makeindex -o \"$_[0].nnd\" \"$_[0].ndx\"" ); + return system( "makeindex -o \"$_[0].nnd\" \"$_[0].ndx\"" ); } - (You will need to modify this code if you use filenames with spaces in - them, to provide correct quoting of the filenames.) - - Those of you with experience with Makefiles, will undoubtedly be con- + Those of you with experience with Makefiles, will undoubtedly be con- cerned that the .ndx file is written during a run of latex/pdflatex and - is always later than the .nnd last read in. Thus the .nnd appears to - be perpetually out-of-date. This situation, of circular dependencies, + is always later than the .nnd last read in. Thus the .nnd appears to + be perpetually out-of-date. This situation, of circular dependencies, is endemic to latex, and latexmk in its current version works correctly - with circular dependencies. It examines the contents of the files (by - use of an md5 checksum), and only does a remake when the file contents + with circular dependencies. It examines the contents of the files (by + use of an md5 checksum), and only does a remake when the file contents have actually changed. - Of course if you choose to write random data to the .nnd (or and .aux - file, etc) that changes on each new run, then you will have a problem. - For real experts: See the %hash_cal_ignore_pattern if you have to deal + Of course if you choose to write random data to the .nnd (or the .aux + + + + 16 January 2017 50 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + + file, etc) that changes on each new run, then you will have a problem. + For real experts: See the %hash_cal_ignore_pattern if you have to deal with such problems. Glossaries can be dealt with similarly. @@ -3141,73 +3313,73 @@ LATEXMK(1L) LATEXMK(1L) OLD METHOD OF DEFINING CUSTOM DEPENDENCIES - In previous versions of latexmk, the only method of defining custom - dependencies was to directly manipulate the table of custom dependen- + In previous versions of latexmk, the only method of defining custom + dependencies was to directly manipulate the table of custom dependen- cies. This is contained in the @cus_dep_list array. It is an array of - strings, and each string in the array has four items in it, each sepa- - rated by a space, the from-extension, the to-extension, the "must" - item, and the name of the subroutine for the custom dependency. These + strings, and each string in the array has four items in it, each sepa- + rated by a space, the from-extension, the to-extension, the "must" + item, and the name of the subroutine for the custom dependency. These were all defined above. An example of the old method of defining custom dependencies is as fol- - lows. It is the code in an RC file to ensure automatic conversion of + lows. It is the code in an RC file to ensure automatic conversion of .fig files to .eps files: push @cus_dep_list, "fig eps 0 fig2eps"; sub fig2eps { - system( "fig2dev -Lps \"$_[0].fig\" \"$_[0].eps\"" ); + return system( "fig2dev -Lps \"$_[0].fig\" \"$_[0].eps\"" ); } - This method still works, and is equivalent to the earlier code using - the add_cus_dep subroutine, except that it doesn't delete any previous - custom-dependency for the same conversion. So the new method is + This method still works, and is equivalent to the earlier code using + the add_cus_dep subroutine, except that it doesn't delete any previous + custom-dependency for the same conversion. So the new method is preferable. ADVANCED CONFIGURATION: Some extra resources and advanced tricks - For most purposes, simple configuration for latexmk along the lines of - the examples given is sufficient. But sometimes you need something - harder. In this section, I indicate some extra possibilities. Gener- - ally to use these, you need to be fluent in the Perl language, since + For most purposes, simple configuration for latexmk along the lines of + the examples given is sufficient. But sometimes you need something + harder. In this section, I indicate some extra possibilities. Gener- + ally to use these, you need to be fluent in the Perl language, since this is what is used in the rc files. + See also the section DEALING WITH ERRORS, PROBLEMS, ETC. See also the + examples in the directory example_rcfiles in the latexmk distributions. + Even if none of the examples apply to your case, they may give ideas + Variables and subroutines for processing a rule + A step in the processing is called a rule. One possibility to implement + the processing of a rule is by a Perl subroutine. This is always the + case for custom dependencies. Also, for any other rule, you can use a + subroutine by prefixing the command specification by the word "inter- + nal" -- see the section FORMAT OF COMMAND SPECIFICATIONS. - 5 September 2016 45 + When you use a subroutine for processing a rule, all the possibilities + of Perl programming are available, of course. In addition, some of + 16 January 2017 51 -LATEXMK(1L) LATEXMK(1L) - See also the section DEALING WITH ERRORS, PROBLEMS, ETC. See also the - examples in the directory example_rcfiles in the latexmk distributions. - Even if none of the examples apply to your case, they may give ideas +LATEXMK(1) General Commands Manual LATEXMK(1) - Variables and subroutines for processing a rule - A step in the processing is called a rule. One possibility to implement - the processing of a rule is by a Perl subroutine. This is always the - case for custom dependencies. Also, for any other rule, you can use a - subroutine by prefixing the command specification by the word "inter- - nal" -- see the section FORMAT OF COMMAND SPECIFICATIONS. - When you use a subroutine for processing a rule, all the possibilities - of Perl programming are available, of course. In addition, some of - latexmk's internal variables and subroutines are available. The ones - listed below are intended to be available to (advanced) users, and + latexmk's internal variables and subroutines are available. The ones + listed below are intended to be available to (advanced) users, and their specifications will generally have stability under upgrades. Gen- - erally, the variables should be treated as read-only: Changing their - values can have bad consequences, since it is liable to mess up the + erally, the variables should be treated as read-only: Changing their + values can have bad consequences, since it is liable to mess up the consistency of what latexmk is doing. - $rule This variable has the name of the rule, as known to latexmk. - Note that the exact contents of this variable for a given rule + $rule This variable has the name of the rule, as known to latexmk. + Note that the exact contents of this variable for a given rule may be dependent on the version of latexmk @@ -3217,92 +3389,92 @@ LATEXMK(1L) LATEXMK(1L) $$Pdest - This gives the name of the main output file if any. Note the + This gives the name of the main output file if any. Note the double dollar signs. rdb_ensure_file( $rule, file ) - This a subroutine that ensures that the given file is among the + This a subroutine that ensures that the given file is among the source files for the specified rule. It is typically used when, - during the processing of a rule, it is known that a particular - extra file is among the dependencies that latexmk should know, + during the processing of a rule, it is known that a particular + extra file is among the dependencies that latexmk should know, but its default methods don't find the dependency. Almost always - the first argument is the name of the rule currently being pro- + the first argument is the name of the rule currently being pro- cessed, so it is then appropriate to specify it by $rule. - For examples of its use, see some of the files in the directory - example_rcfiles of latexmk's distribution. Currently the cases - that use this subroutine are exceltex_latexmkrc and texinfo- - latexmkrc. These illustrate typical cases where latexmk's nor- + For examples of its use, see some of the files in the directory + example_rcfiles of latexmk's distribution. Currently the cases + that use this subroutine are exceltex_latexmkrc and texinfo- + latexmkrc. These illustrate typical cases where latexmk's nor- mal processing fails to detect certain extra source files. rdb_remove_files( $rule, file, ... ) - This subroutine removes one or more files from the dependency + This subroutine removes one or more files from the dependency list for the given rule. rdb_list_source( $rule ) - This subroutine returns the list of source files (i.e., the + This subroutine returns the list of source files (i.e., the dependency list) for the given rule. rdb_set_source( $rule, file, ... ) - rdb_set_source( $rule, @files ) This subroutine sets the depen- - dency list for the given rule to be the specified files. Files + rdb_set_source( $rule, @files ) This subroutine sets the depen- + dency list for the given rule to be the specified files. Files + that are already in the list have unchanged information. Files + that were not in the list are added to it. Files in the - 5 September 2016 46 + 16 January 2017 52 -LATEXMK(1L) LATEXMK(1L) +LATEXMK(1) General Commands Manual LATEXMK(1) - that are already in the list have unchanged information. Files - that were not in the list are added to it. Files in the previ- - ous dependency list that are not in the newly specified list of - files are removed from the dependency list. + previous dependency list that are not in the newly specified + list of files are removed from the dependency list. Advanced configuration: Using latexmk with make - This section is targeted only at advanced users who use the make pro- + This section is targeted only at advanced users who use the make pro- gram for complex projects, as for software development, with the depen- dencies specified by a Makefile. - Now the basic task of latexmk is to run the appropriate programs to - make a viewable version of a LaTeX document. However, the usual make - program is not suited to this purpose for at least two reasons. First + Now the basic task of latexmk is to run the appropriate programs to + make a viewable version of a LaTeX document. However, the usual make + program is not suited to this purpose for at least two reasons. First is that the use of LaTeX involves circular dependencies (e.g., via .aux files), and these cannot be handled by the standard make program. Sec- - ond is that in a large document the set of source files can change - quite frequently, particularly with included graphics files; in this - situation keeping a Makefile manually updated is inappropriate and - error-prone, especially when the dependencies can be determined auto- + ond is that in a large document the set of source files can change + quite frequently, particularly with included graphics files; in this + situation keeping a Makefile manually updated is inappropriate and + error-prone, especially when the dependencies can be determined auto- matically. Latexmk solves both of these problems robustly. - Thus for many standard LaTeX documents latexmk can be used by itself - without the make program. In a complex project it simply needs to be - suitably configured. A standard configuration would be to define cus- - tom dependencies to make graphics files from their source files (e.g., - as created by the xfig program). Custom dependencies are latexmk's + Thus for many standard LaTeX documents latexmk can be used by itself + without the make program. In a complex project it simply needs to be + suitably configured. A standard configuration would be to define cus- + tom dependencies to make graphics files from their source files (e.g., + as created by the xfig program). Custom dependencies are latexmk's equivalent of pattern rules in Makefiles. - Nevertheless there are projects for which a Makefile is appropriate, + Nevertheless there are projects for which a Makefile is appropriate, and it is useful to know how to use latexmk from a Makefile. A typical - example would be to generate documentation for a software project. - Potentially the interaction with the rest of the rules in the Makefile + example would be to generate documentation for a software project. + Potentially the interaction with the rest of the rules in the Makefile could be quite complicated, for example if some of the source files for a LaTeX document are generated by the project's software. In this section, I give a couple of examples of how latexmk can be use- - fully invoked from a Makefile. The examples use specific features of - current versions of GNU make, which is the default on both linux and - OS-X systems. They may need modifications for other versions of make. + fully invoked from a Makefile. The examples use specific features of + current versions of GNU make, which is the default on both linux and + OS-X systems. They may need modifications for other versions of make. The simplest method is simply to delegate all the relevant tasks to latexmk, as is suitable for a straightforward LaTeX document. For this @@ -3318,30 +3490,30 @@ LATEXMK(1L) LATEXMK(1L) LaTeX file try.tex were the only task to be performed, a direct use of latexmk without a Makefile would normally be better. The benefit of using a Makefile for a LaTeX document would be in a larger project, - where lines such as the above would be only be a small part of a larger - Makefile. - The above example has a pattern rule for making a .pdf file from a .tex - file, and it is defined to use latexmk in the obvious way. There is a - conventional default target named "all", with a prerequisite of - try.pdf. So when make is invoked, by default it makes try.pdf. The - only complication is that there may be many source files beyond - try.tex, but these aren't specified in the Makefile, so changes in them - will not by themselves cause latexmk to be invoked. Instead, the + 16 January 2017 53 - 5 September 2016 47 +LATEXMK(1) General Commands Manual LATEXMK(1) -LATEXMK(1L) LATEXMK(1L) + where lines such as the above would be only be a small part of a larger + Makefile. - 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 + The above example has a pattern rule for making a .pdf file from a .tex + file, and it is defined to use latexmk in the obvious way. There is a + conventional default target named "all", with a prerequisite of + try.pdf. So when make is invoked, by default it makes try.pdf. The + only complication is that there may be many source files beyond + try.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 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 @@ -3370,86 +3542,98 @@ LATEXMK(1L) LATEXMK(1L) %.pdf : %.fig fig2dev -Lpdf $< $@ - (Again, the lines containing the commands for the rules should be + (Again, the lines containing the commands for the rules should be started with tabs.) This example was inspired by how GNU automake han- dles automatic dependency tracking of C source files. - After each run of latexmk, dependency information is put in a file in - the .deps subdirectory. The Makefile causes these dependency files to + After each run of latexmk, dependency information is put in a file in + the .deps subdirectory. The Makefile causes these dependency files to be read by make, which now has the full dependency information for each - target .pdf file. To make things less trivial it is specificed that - two files document1.pdf and document2.pdf are the targets. The depen- + target .pdf file. To make things less trivial it is specificed that + two files document1.pdf and document2.pdf are the targets. The depen- dency files are .deps/document1.pdfP and .deps/document2.pdfP. - There is now no need for the phony prerequisite for the rule to make + There is now no need for the phony prerequisite for the rule to make .pdf files from .tex files. But I have added a rule to make .pdf files - from .fig files produced by the xfig program; these are commonly used - for graphics insertions in LaTeX documents. Latexmk is arranged to - output a dependency file after each run. It is given the -recorder - option, which improves its detection of files generated during a run of - pdflatex; such files should not be in the dependency list. The -e - options are used to turn off all custom dependencies, and to document - this. Instead the -use-make is used to delegate the making of missing - files to make itself. + from .fig files produced by the xfig program; these are commonly used - Suppose in the LaTeX file there is a command \includegraphics{graph}, - and an xfig file "graph.fig" exists. On a first run, pdflatex reports - a missing file, named "graph". Latexmk succeeds in making "graph.pdf" - by calling "make graph.pdf", and after completion of its work, it lists - "fig.pdf" among the dependents of the file latexmk is making. Then let - "fig.fig" be updated, and then let make be run. Make first remakes - "fig.pdf", and only then reruns latexmk. - Thus we now have a method by which all the subsidiary processing is - delegated to make. + 16 January 2017 54 -SEE ALSO - latex(1), bibtex(1). - 5 September 2016 48 +LATEXMK(1) General Commands Manual LATEXMK(1) + for graphics insertions in LaTeX documents. Latexmk is arranged to + output a dependency file after each run. It is given the -recorder + option, which improves its detection of files generated during a run of + pdflatex; such files should not be in the dependency list. The -e + options are used to turn off all custom dependencies, and to document + this. Instead the -use-make is used to delegate the making of missing + files to make itself. + Suppose in the LaTeX file there is a command \includegraphics{graph}, + and an xfig file "graph.fig" exists. On a first run, pdflatex reports + a missing file, named "graph". Latexmk succeeds in making "graph.pdf" + by calling "make graph.pdf", and after completion of its work, it lists + "fig.pdf" among the dependents of the file latexmk is making. Then let + "fig.fig" be updated, and then let make be run. Make first remakes + "fig.pdf", and only then reruns latexmk. + Thus we now have a method by which all the subsidiary processing is + delegated to make. -LATEXMK(1L) LATEXMK(1L) +SEE ALSO + latex(1), bibtex(1). BUGS Sometimes a viewer (gv) tries to read an updated .ps or .pdf file after - its creation is started but before the file is complete. Work around: + its creation is started but before the file is complete. Work around: manually refresh (or reopen) display. Or use one of the other preview- ers and update methods. - (The following isn't really a bug, but concerns features of preview- - ers.) Preview continuous mode only works perfectly with certain pre- - viewers: Xdvi on UNIX/LINUX works for dvi files. Gv on UNIX/LINUX - works for both postscript and pdf. Ghostview on UNIX/LINUX needs a - manual update (reopen); it views postscript and pdf. Gsview under MS- - Windows works for both postscript and pdf, but only reads the updated - file when its screen is refreshed. Acroread under UNIX/LINUX views - pdf, but the file needs to be closed and reopened to view an updated - version. Under MS-Windows, acroread locks its input file and so the - pdf file cannot be updated. (Remedy: configure latexmk to use suma- + (The following isn't really a bug, but concerns features of preview- + ers.) Preview continuous mode only works perfectly with certain pre- + viewers: Xdvi on UNIX/Linux works for dvi files. Gv on UNIX/Linux + works for both postscript and pdf. Ghostview on UNIX/Linux needs a + manual update (reopen); it views postscript and pdf. Gsview under MS- + Windows works for both postscript and pdf, but only reads the updated + file when its screen is refreshed. Acroread under UNIX/Linux views + pdf, but the file needs to be closed and reopened to view an updated + version. Under MS-Windows, acroread locks its input file and so the + pdf file cannot be updated. (Remedy: configure latexmk to use suma- trapdf instead.) THANKS TO - Authors of previous versions. Many users with their feedback, and - especially David Coppit (username david at node coppit.org) who made - many useful suggestions that contributed to version 3, and Herbert - Schulz. (Please note that the e-mail addresses are not written in + Authors of previous versions. Many users with their feedback, and + especially David Coppit (username david at node coppit.org) who made + many useful suggestions that contributed to version 3, and Herbert + Schulz. (Please note that the e-mail addresses are not written in their standard form to avoid being harvested by worms and viruses.) AUTHOR - Current version, by John Collins (username jcc8 at node psu.edu). - (Version 4.48). + Current version, by John Collins (username jcc8 at node psu.edu). + (Version 4.52). + + Released version can be obtained from CTAN: + <http://www.ctan.org/pkg/latexmk/>, and from the author's website + + + + 16 January 2017 55 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + - Released version can be obtained from CTAN: - <http://www.ctan.org/pkg/latexmk/>, and from the author's website <http://www.personal.psu.edu/jcc8/latexmk/>. Modifications and enhancements by Evan McLean (Version 2.0) Original script called "go" by David J. Musliner (RCS Version 3.2) @@ -3489,6 +3673,24 @@ AUTHOR - 5 September 2016 49 + + + + + + + + + + + + + + + + + + + 16 January 2017 56 diff --git a/Master/texmf-dist/scripts/latexmk/latexmk.pl b/Master/texmf-dist/scripts/latexmk/latexmk.pl index e4cde1fa815..4a4d623ebdb 100755 --- a/Master/texmf-dist/scripts/latexmk/latexmk.pl +++ b/Master/texmf-dist/scripts/latexmk/latexmk.pl @@ -6,6 +6,9 @@ # See # ??????? BCF +#!!!!!!!!??? Check @pwd_log + + # !!!!!!!!!! Don't forget to document $silence_logfile_warnings.!!! # N.B. !!!!!!!!!!! See 17 July 2012 comments !!!!!!!!!!!!!!!!!! @@ -118,8 +121,8 @@ use warnings; $my_name = 'latexmk'; $My_name = 'Latexmk'; -$version_num = '4.48'; -$version_details = "$My_name, John Collins, 5 Sep. 2016"; +$version_num = '4.52'; +$version_details = "$My_name, John Collins, 16 Jan. 2017"; use Config; use File::Basename; @@ -154,7 +157,7 @@ else { warn "Something wrong with the perl configuration: No signals?\n"; } -## Copyright John Collins 1998-2015 +## Copyright John Collins 1998-2016 ## (username jcc8 at node psu.edu) ## (and thanks to David Coppit (username david at node coppit.org) ## for suggestions) @@ -192,6 +195,52 @@ else { ## ## 12 Jan 2012 STILL NEED TO DOCUMENT some items below ## +## 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 @@ -202,110 +251,6 @@ else { ## when compilation was with -pdf and clear was default. ## (Correctly default set of rules in rdb_make_rule_list.) ## Ver. 4.45 -## 8 Apr 2016 John Collins Commented out delegated-source diagnostic -## 6 Apr 2016 John Collins Correct " ge " to " >= " -## 27 Mar 2016 John Collins Extra diagnostics in find_process_id -## Fix bug in find_process_id due to extra -## leading space in output of ps under OS-X -## 27 Feb 2016 John Collins Attempt at yet another fix for malformed bcf issue -## 24 Feb 2016 John Collins Further fix for malformed bcf issue -## Locate error, and create dummy bbl file. -## 18 Feb 2016 John Collins Correct use of %hash_calc_ignore_pattern -## V. 4.44 -## 9 Sep 2015 John Collins Correct diagnostic when calling internal -## subroutine for command to handle quoted -## arguments better. -## 14 Mar 2015 John Collins Remove superfluous debugging statements -## 9 Mar 2015 John Collins Correct normalization of filenames, so that -## initial "./" is always removed. This prevents -## custom dependencies being run twice on the same file. -## 5 Feb 2015 John Collins Deletion of synctex.gz file is with full clean -## (-C option), not with the small clean (-c) -## 27 Jan 2015 John Collins Comments added. -## 25,26 Jan 2015 John Collins Complete MiKTeX fix. -## 16 Jan 2015 John Collins V. 4.43 -## Try to fix issues caused -## by MiKTeX's absolute pathnames in -## .fls and .log file -## 10 Jan 2015 John Collins Fix -cd-associated bugs -## 9 Jan 2015 John Collins V. 4.42 -## Add missfont.log and synctex.gz to cleaned -## up files -## 1 Jan 2015 John Collins V. 4.41 -## 18 Dec 2014 John Collins -c also deletes $deps_file if it is used. -## 16 Dec 2014 John Collins Finish change of e-mail -## 5 Dec 2014 John Collins Quote jobname when needed. -## 5 Sep 2014 John Collins Change my e-mail -## 30 Aug 2014 John Collins Change my e-mail -## 13 Aug 2014 John Collins Try to correct error handling to avoid -## repeated runs of latex after an error. -## Revert to some code from v. 4-32. -## Do I need $retry_msg? -## 8 Aug 2014 John Collins Fix up for the making of -eps-converted-to.pdf -## 4 Aug 2014 John Collins Sort and remove redundant xxx-undefined -## warning lines from log file. -## 23 Jul 2014 John Collins Fix failure when using both -cd and -output-directory -## 22 Jul 2014 John Collins If $HOME not set, then don't read ~/.latexmkrc -## Introduce $silence_logfile_warnings -## 21 Jul 2014 John Collins In setting $pscmd, allow for non-existent -### $ENV{USER} -## 29 May 2014 John Collins Correct sub Run for internal cmd w/o arguments -## 21 Mar 2014 John Collins Experimental: Add analysis hook for aux file. -## But I need to change rdb_create_rule in someway to -## allow correct handling of: (a) rule creation if -## rule doesn't exist, (b) either no change, or rule -## update, if the rule exists. No change is a bad -## idea, because conditions may change. Such a -## change, to effectively rdb_ensure_rule, would also -## help other dependencies, e.g., if a custom -## dependency has been created on one run of latexmk, -## and then on another run the definition is changed. -## With the old method, the old cus-dep is used unless -## the dependency cache fdb_latexmk is cleared; but -## with the new method the custom dependency will be -## changed correctly. -## 5 Mar 2014 John Collins System initialization files: allow them -## to be named latexmkrc as well as LatexMk, -## for more consistency with user directory -## names. Keep both cases, to preserve -## backward compatibility. -## 30 Jan 2014 John Collins Change sign-on message. Bug report info with help. V. 4.40a -## 15 Jan 2014 John Collins Fix failure to clean up correctly when -## root filename contains [, which is -## a glob metacharacter. -## V. 4.40 -## 10 Nov 2013 John Collins Change split / /, ... to split /\s*/, ... -## so as to be immune from extra white space. -## Clean up $clean_ext and $clean_full_ext by removing -## superfluous white space. -## 8 Nov 2013 John Collins Automatic creation of necessary -## subdirectories of auxdir when -## needed for writing aux files. -## 3 Nov 2013 John Collins Correction to 1 Nov -## 1 Nov 2013 John Collins Add error diagnostics to if_source. -## Allow $print_type = 'auto', and make -## this the default. -## 30 Oct 2013 John Collins Do better fix for dealing with special -## characters in directory names used in -## regexes. Use \Q \E. There are three -## occurences of the issue. -## Fix potential problem with globbing when -## a specified (i.e., non-wildcarded) part -## of the pattern has glob metacharacters. -## Use File::Glob to give glob that doesn't -## take space character as item separator. -## 16 Oct 2013 John Collins Use make_path from File::Path instead of -## mkdir to give autocreation of intermediate -## directories. -## This gives dependency on File::Path -## 19 Jul 2013 John Collins V. 4.39. -## In output of dependencies, include pathname of -## target file(s) in the rule. -## 19 Jul 2013 John Collins V. 4.38. -## In -pvc mode, writing of deps file (caused by -## -M option) is per make not per overall run. -## %extra_rule_spec variable as hook for templates -## for new rules. ## ## 1998-2010, John Collins. Many improvements and fixes. ## See CHANGE-log.txt for full list, and CHANGES for summary @@ -313,82 +258,6 @@ else { ## Modified by Evan McLean (no longer available for support) ## Original script (RCS version 2.3) called "go" written by David J. Musliner ## -## 2.0 - Final release, no enhancements. LatexMk is no longer supported -## by the author. -## 1.9 - Fixed bug that was introduced in 1.8 with path name fix. -## - Fixed buglet in man page. -## 1.8 - Add not about announcement mailling list above. -## - Added texput.dvi and texput.aux to files deleted with -c and/or -## the -C options. -## - Added landscape mode (-l option and a bunch of RC variables). -## - Added sensing of "\epsfig{file=...}" forms in dependency generation. -## - Fixed path names when specified tex file is not in the current -## directory. -## - Fixed combined use of -pvc and -s options. -## - Fixed a bunch of speling errors in the source. :-) -## - Fixed bugs in xdvi patches in contrib directory. -## 1.7 - Fixed -pvc continuous viewing to reattach to pre-existing -## process correctly. -## - Added $pscmd to allow changing process grepping for different -## systems. -## 1.6 - Fixed buglet in help message -## - Fixed bugs in detection of input and include files. -## 1.5 - Removed test message I accidentally left in version 1.4 -## - Made dvips use -o option instead of stdout redirection as some -## people had problems with dvips not going to stdout by default. -## - Fixed bug in input and include file detection -## - Fixed dependency resolution process so it detects new .toc file -## and makeindex files properly. -## - Added dvi and postscript filtering options -dF and -pF. -## - Added -v version commmand. -## 1.4 - Fixed bug in -pvc option. -## - Made "-F" option include non-existant file in the dependency list. -## (RC variable: $force_include_mode) -## - Added .lot and .lof files to clean up list of extensions. -## - Added file "texput.log" to list of files to clean for -c. -## - LatexMk now handles file names in a similar fashion to latex. -## The ".tex" extension is no longer enforced. -## - Added $texfile_search RC variable to look for default files. -## - Fixed \input and \include so they add ".tex" extension if necessary. -## - Allow intermixing of file names and options. -## - Added "-d" and banner options (-bm, -bs, and -bi). -## (RC variables: $banner, $banner_message, $banner_scale, -## $banner_intensity, $tmpdir) -## - Fixed "-r" option to detect an command line syntax errors better. -## 1.3 - Added "-F" option, patch supplied by Patrick van der Smagt. -## 1.2 - Added "-C" option. -## - Added $clean_ext and $clean_full_ext variables for RC files. -## - Added custom dependency generation capabilities. -## - Added command line and variable to specify custom RC file. -## - Added reading of rc file in current directly. -## 1.1 - Fixed bug where Dependency file generation header is printed -## rependatively. -## - Fixed bug where TEXINPUTS path is searched for file that was -## specified with absolute an pathname. -## 1.0 - Ripped from script by David J. Musliner (RCS version 2.3) called "go" -## - Fixed a couple of file naming bugs -## e.g. when calling latex, left the ".tex" extension off the end -## of the file name which could do some interesting things -## with some file names. -## - Redirected output of dvips. My version of dvips was a filter. -## - Cleaned up the rc file mumbo jumbo and created a dependency file -## instead. Include dependencies are always searched for if a -## dependency file doesn't exist. The -i option regenerates the -## dependency file. -## Getting rid of the rc file stuff also gave the advantage of -## not being restricted to one tex file per directory. -## - Can specify multiple files on the command line or no files -## on the command line. -## - Removed lpr options stuff. I would guess that generally, -## you always use the same options in which case they can -## be set up from an rc file with the $lpr variable. -## - Removed the dviselect stuff. If I ever get time (or money :-) ) -## I might put it back in if I find myself needing it or people -## express interest in it. -## - Made it possible to view dvi or postscript file automatically -## depending on if -ps option selected. -## - Made specification of dvi file viewer seperate for -pv and -pvc -## options. ##----------------------------------------------------------------------- @@ -402,8 +271,8 @@ else { ## or retcode from called program. -#Line length in log file that indicates wrapping. -# This number EXCLUDES line-end characters, and is one-based +# Line length in log file that indicates wrapping. +# This number EXCLUDES line-end characters, and is one-based. # It is the parameter max_print_line in the TeX program. (tex.web) $log_wrap = 79; @@ -426,6 +295,7 @@ $log_wrap = 79; '^Package .* [fF]ile `([^\\\']*)\\\' not found', 'Error: pdflatex \(file ([^\)]*)\): cannot find image file', ': File (.*) not found:\s*$', + '! Unable to load picture or PDF file \\\'([^\\\']+)\\\'.', ); ## Hash mapping file extension (w/o period, e.g., 'eps') to a single regexp, @@ -468,17 +338,24 @@ $log_wrap = 79; ## Most of these variables represents the external command needed to ## perform a certain action. Some represent switches. -## Commands to invoke latex, pdflatex +## Commands to invoke latex, pdflatex, etc $latex = 'latex %O %S'; $pdflatex = 'pdflatex %O %S'; +$lualatex = 'lualatex %O %S'; +# xelatex is used to give xdv file, not pdf file +$xelatex = 'xelatex -no-pdf %O %S'; ## Default switches: $latex_default_switches = ''; $pdflatex_default_switches = ''; +$lualatex_default_switches = ''; +$xelatex_default_switches = ''; ## Switch(es) to make them silent: $latex_silent_switch = '-interaction=batchmode'; $pdflatex_silent_switch = '-interaction=batchmode'; +$lualatex_silent_switch = '-interaction=batchmode'; +$xelatex_silent_switch = '-interaction=batchmode'; # %input_extensions maps primary_rule_name to pointer to hash of file extensions # used for extensionless files specified in the source file by constructs @@ -489,6 +366,8 @@ $pdflatex_silent_switch = '-interaction=batchmode'; # Instead we'll exercise the user-friendly access routines: add_input_ext( 'latex', 'tex', 'eps' ); add_input_ext( 'pdflatex', 'tex', 'jpg', 'pdf', 'png' ); +add_input_ext( 'lualatex', 'tex', 'jpg', 'pdf', 'png' ); +add_input_ext( 'xelatex', 'tex', 'jpg', 'pdf', 'png' ); #show_input_ext( 'latex' ); show_input_ext( 'pdflatex' ); # Information about options to latex and pdflatex that latexmk will simply @@ -564,7 +443,7 @@ foreach ( "-hash-extra=n set the extra space for the hash table of control\n". " sequences", "-job-time=file set the time-stamp of all output files equal to\n". - " file'stime-stamp", + " file's time-stamp", "-main-memory=n change the total size (in memory words) of the main\n". " memory array", "-max-in-open=n set the maximum number of input files and error\n". @@ -632,6 +511,8 @@ foreach ( # is added. @extra_latex_options = (); @extra_pdflatex_options = (); +@extra_lualatex_options = (); +@extra_xelatex_options = (); ## Command to invoke biber & bibtex @@ -679,6 +560,11 @@ $dvips_silent_switch = '-q'; ## Command to convert ps file to pdf file: $ps2pdf = 'ps2pdf %O %S %D'; +## Command to convert xdv file to pdf file +$xdvipdfmx = 'xdvipdfmx -o %D %O %S'; +$xdvipdfmx_silent_switch = '-q'; + + ## Command to search for tex-related files $kpsewhich = 'kpsewhich %S'; @@ -1155,7 +1041,12 @@ $aux_dir = ''; # Directory for aux files (log, aux, etc). $recorder = 1; # Whether to use recorder option on latex/pdflatex $silent = 0; # Silence latex's messages? $silence_logfile_warnings = 0; # Do list warnings in log file +$kpsewhich_show = 0; # Show calls to and results from kpsewhich $landscape_mode = 0; # default to portrait mode +$analyze_input_log_always = 0; # 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. # The following two arrays contain lists of extensions (without # period) for files that are read in during a (pdf)LaTeX run but that @@ -1190,6 +1081,8 @@ $pdf_mode = 0; # No pdf file requested to be made by pdflatex # 1 to create pdf file by pdflatex # 2 to create pdf file by ps2pdf # 3 to create pdf file by dvipdf + # 4 to create pdf file by lualatex + # 5 to create pdf file by xelatex + xdvipdfmx $view = 'default'; # Default preview is of highest of dvi, ps, pdf $sleep_time = 2; # time to sleep b/w checks for file changes in -pvc mode $banner = 0; # Non-zero if we have a banner to insert @@ -1211,7 +1104,7 @@ $cleanup_mode = 0; # No cleanup of nonessential LaTex-related files. # $cleanup_mode = 0: no cleanup # $cleanup_mode = 1: full cleanup # $cleanup_mode = 2: cleanup except for dvi, - # dviF, pdf, ps, & psF + # dviF, pdf, ps, psF & xdv $cleanup_fdb = 0; # No removal of file for latexmk's file-database $cleanup_only = 0; # When doing cleanup, do not go on to making files $cleanup_includes_generated = 0; @@ -1389,10 +1282,12 @@ if (!$BIBINPUTS) { $BIBINPUTS = '.'; } # List of known rules. Rule types: primary, # external (calls program), internal (calls routine), cusdep. -%possible_primaries = ( 'latex' => 'primary', 'pdflatex' => 'primary' ); +%possible_primaries = ( 'latex' => 'primary', 'pdflatex' => 'primary', + 'lualatex' => 'primary', 'xelatex' => 'primary' ); %primaries = (); # Hash of rules for primary part of make. Keys are - # currently 'latex', 'pdflatex' or both. Value is - # currently irrelevant. Use hash for ease of lookup + # currently 'latex', 'pdflatex' or both; also 'lualatex' + # and 'xelatex'. Value is currently irrelevant. + # Use hash for ease of lookup # Make remove this later, if use rdb_makeB # Hashes, whose keys give names of particular kinds of rule. We use @@ -1656,6 +1551,8 @@ while ($_ = $ARGV[0]) elsif (/^-latexoption=(.*)$/) { push @extra_latex_options, $1; push @extra_pdflatex_options, $1; + push @extra_lualatex_options, $1; + push @extra_xelatex_options, $1; } elsif ( /^-logfilewarninglist$/ || /^-logfilewarnings$/ ) { $silence_logfile_warnings = 0; } @@ -1691,6 +1588,8 @@ while ($_ = $ARGV[0]) elsif (/^-pdf$/) { $pdf_mode = 1; } elsif (/^-pdf-$/) { $pdf_mode = 0; } elsif (/^-pdfdvi$/){ $pdf_mode = 3; } + elsif (/^-pdflua$/){ $pdf_mode = 4; } + elsif (/^-pdfxe$/) { $pdf_mode = 5; } # elsif (/^-pdflatex$/) { # $pdflatex = "pdflatex %O %S"; # $pdf_mode = 1; @@ -1737,7 +1636,8 @@ while ($_ = $ARGV[0]) "options known to the (pdf)latex programs that are also recognized by\n", "latexmk and trigger special behavior by latexmk. Since these options\n", "appear in the main list given by running 'latexmk --help', they do not\n", - "appear in the following list\n", + "appear in the following list\n", + "NOTE ALSO: Not all of these options are supported by all versions of (pdf)latex.\n", "\n"; foreach $option ( sort( keys %allowed_latex_options, keys %allowed_latex_options_with_arg ) ) { if (exists $allowed_latex_options{$option} ) { print " $allowed_latex_options{$option}\n"; } @@ -1761,13 +1661,11 @@ while ($_ = $ARGV[0]) elsif (/^-view=ps$/) { $view = "ps";} elsif (/^-view=pdf$/) { $view = "pdf"; } elsif (/^-lualatex$/) { - $pdflatex = "lualatex %O %S"; - $pdf_mode = 1; + $pdf_mode = 4; $dvi_mode = $postscript_mode = 0; } elsif (/^-xelatex$/) { - $pdflatex = "xelatex %O %S"; - $pdf_mode = 1; + $pdf_mode = 5; $dvi_mode = $postscript_mode = 0; } elsif (/^-e$/) { @@ -1830,6 +1728,8 @@ while ($_ = $ARGV[0]) { push @extra_latex_options, $original; push @extra_pdflatex_options, $original; + push @extra_lualatex_options, $original; + push @extra_xelatex_options, $original; } elsif (/^-/) { warn "$My_name: $_ bad option\n"; @@ -2001,9 +1901,13 @@ if ( ($jobname ne '') && ($num_files > 1) ) { # Add common options add_option( $latex_default_switches, \$latex ); add_option( $pdflatex_default_switches, \$pdflatex ); +add_option( $lualatex_default_switches, \$lualatex ); +add_option( $xelatex_default_switches, \$xelatex ); foreach (@extra_latex_options) { add_option( $_, \$latex ); } foreach (@extra_pdflatex_options) { add_option( $_, \$pdflatex ); } +foreach (@extra_lualatex_options) { add_option( $_, \$lualatex ); } +foreach (@extra_xelatex_options) { add_option( $_, \$xelatex ); } # If landscape mode, change dvips processor, and the previewers: @@ -2017,15 +1921,18 @@ if ( $landscape_mode ) if ( $silent ) { add_option( "$latex_silent_switch", \$latex ); add_option( "$pdflatex_silent_switch", \$pdflatex ); + add_option( "$lualatex_silent_switch", \$lualatex ); + add_option( "$xelatex_silent_switch", \$xelatex ); add_option( "$biber_silent_switch", \$biber ); add_option( "$bibtex_silent_switch", \$bibtex ); add_option( "$makeindex_silent_switch", \$makeindex ); add_option( "$dvipdf_silent_switch", \$dvipdf ); add_option( "$dvips_silent_switch", \$dvips ); + add_option( "$xdvipdfmx_silent_switch", \$xdvipdfmx ); } if ( $recorder ) { - add_option( "-recorder", \$latex, \$pdflatex ); + add_option( "-recorder", \$latex, \$pdflatex, \$lualatex, \$xelatex ); } # If the output and/or aux directories are specified, fix the (pdf)latex @@ -2035,13 +1942,15 @@ if ( $recorder ) { # relative to the document. if ( $out_dir ) { - add_option( "-output-directory=\"$out_dir\"", \$latex, \$pdflatex ); + add_option( "-output-directory=\"$out_dir\"", + \$latex, \$pdflatex, \$lualatex, \$xelatex ); } if ( $aux_dir && ($aux_dir ne $out_dir) ) { # N.B. If $aux_dir and $out_dir are the same, then the -output-directory # option is sufficient, especially because the -aux-directory exists # only in MiKTeX, not in TeXLive. - add_option( "-aux-directory=\"$aux_dir\"", \$latex, \$pdflatex ); + add_option( "-aux-directory=\"$aux_dir\"", + \$latex, \$pdflatex, \$lualatex, \$xelatex ); } if ( $jobname ne '' ) { @@ -2084,6 +1993,13 @@ elsif ( $pdf_mode == 3 ) { $requested_filerules{'latex'} = 1; $requested_filerules{'dvipdf'} = 1; } +elsif ( $pdf_mode == 4 ) { + $requested_filerules{'lualatex'} = 1; +} +elsif ( $pdf_mode == 5 ) { + $requested_filerules{'xelatex'} = 1; + $requested_filerules{'xdvipdfmx'} = 1; +} if ( $postscript_mode ) { $requested_filerules{'latex'} = 1; $requested_filerules{'dvips'} = 1; @@ -2233,7 +2149,7 @@ foreach $filename ( @file_list ) } ## remove extension from filename if was given. - if ( &find_basename($filename, $root_filename, $texfile_name) ) + if ( find_basename($filename, $root_filename, $texfile_name) ) { if ( $force_mode ) { warn "$My_name: Could not find file [$texfile_name]\n"; @@ -2308,6 +2224,7 @@ foreach $filename ( @file_list ) # Maps output file created and read by (pdf)latex # to source file of conversion. local $primary_out = ''; # Actual output file (dvi or pdf). Not used here. + local $fls_file_analyzed = 0; &parse_log; %other_generated = %generated_log; } @@ -2362,7 +2279,8 @@ foreach $filename ( @file_list ) &cleanup_cusdep_generated; } if ( $cleanup_mode == 1 ) { - &cleanup1( $out_dir1, 'dvi', 'dviF', 'ps', 'psF', 'pdf', 'synctex.gz', + &cleanup1( $out_dir1, 'dvi', 'dviF', 'ps', 'psF', 'pdf', + 'synctex.gz', 'xdv', split('\s+', $clean_full_ext) ); } @@ -2399,15 +2317,22 @@ foreach $filename ( @file_list ) %primaries = (); foreach (@accessible_all) { - if ( ($_ eq 'latex') || ($_ eq 'pdflatex') ) { $primaries{$_} = 1; } + if ( ($_ eq 'latex') || ($_ eq 'pdflatex') || ($_ eq 'lualatex') + || ($_ eq 'xelatex') ) + { $primaries{$_} = 1; } } $have_fdb = 0; - if ( (! -e $fdb_name) && (! -e $aux_main ) ) { - # No aux and no fdb file => set up trivial aux file + if (! -e $aux_main ) { + # No aux file => set up trivial aux file # and corresponding fdb_file. Arrange them to provoke one run # as minimum, but no more if actual aux file is trivial. # (Useful on big files without cross references.) + # If aux file doesn't exist, then any fdb file is surely + # wrong. + # Previously, I had condition for this as being both aux and + # fdb files failing to exist. But it's not obvious what to + # do if aux exists and fdb doesn't. So I won't do anything. &set_trivial_aux_fdb; } @@ -2599,6 +2524,7 @@ sub rdb_make_rule_list { local $dvi_final = "%Z%R.dvi"; local $ps_final = "%Z%R.ps"; local $pdf_final = "%Z%R.pdf"; + local $xdv_final = "%Z%R.xdv"; if ( length($dvi_filter) > 0) { $dvi_final = "%Z%R.dviF"; } @@ -2648,7 +2574,10 @@ sub rdb_make_rule_list { %rule_list = ( 'latex' => [ 'primary', "$latex", '', "%T", "%Z%B.dvi", "%R", 1, ["%Y%R.log"] ], 'pdflatex' => [ 'primary', "$pdflatex", '', "%T", "%Z%B.pdf", "%R", 1, ["%Y%R.log"] ], + 'lualatex' => [ 'primary', "$lualatex", '', "%T", "%Z%B.pdf", "%R", 1, ["%Y%R.log"] ], + 'xelatex' => [ 'primary', "$xelatex", '', "%T", "%Z%B.xdv", "%R", 1, ["%Y%R.log"] ], 'dvipdf' => [ 'external', "$dvipdf", 'do_viewfile', $dvi_final, "%B.pdf", "%Z%R", 2 ], + 'xdvipdfmx' => [ 'external', "$xdvipdfmx", 'do_viewfile', $xdv_final, "%B.pdf", "%Z%R", 2 ], 'dvips' => [ 'external', "$dvips", 'do_viewfile', $dvi_final, "%B.ps", "%Z%R", 2 ], 'dvifilter'=> [ 'external', $dvi_filter, 'do_viewfile', "%B.dvi", "%B.dviF", "%Z%R", 2 ], 'ps2pdf' => [ 'external', "$ps2pdf", 'do_viewfile', $ps_final, "%B.pdf", "%Z%R", 2 ], @@ -2660,10 +2589,12 @@ sub rdb_make_rule_list { ); # Ensure we only have one way to make pdf file, and that it is appropriate: - if ($pdf_mode == 2) { delete $rule_list{'dvipdf'}; delete $rule_list{'pdflatex'}; } - elsif ($pdf_mode == 3) { delete $rule_list{'pdflatex'}; delete $rule_list{'ps2pdf'}; } + if ($pdf_mode == 2) { delete $rule_list{'dvipdf'}; delete $rule_list{'pdflatex'}; delete $rule_list{'lualatex'}; delete $rule_list{'xelatex'}; } + elsif ($pdf_mode == 3) { delete $rule_list{'pdflatex'}; delete $rule_list{'ps2pdf'}; delete $rule_list{'lualatex'}; delete $rule_list{'xelatex'}; } + elsif ($pdf_mode == 4) { delete $rule_list{'pdflatex'}; delete $rule_list{'ps2pdf'}; delete $rule_list{'dvipdf'}; delete $rule_list{'xelatex'}; } + elsif ($pdf_mode == 5) { delete $rule_list{'pdflatex'}; delete $rule_list{'ps2pdf'}; delete $rule_list{'dvipdf'}; delete $rule_list{'lualatex'}; } else { # Default is to leave pdflatex - delete $rule_list{'dvipdf'}; delete $rule_list{'ps2pdf'}; + delete $rule_list{'dvipdf'}; delete $rule_list{'ps2pdf'}; delete $rule_list{'lualatex'}; delete $rule_list{'xelatex'}; } } # END rdb_make_rule_list @@ -2923,19 +2854,20 @@ sub if_source { #************************************************************ #************************************************************ -# Finds the basename of the root file -# Arguments: -# 1 - Filename to breakdown -# 2 - Where to place base file -# 3 - Where to place tex file -# Returns non-zero if tex file does not exist -# -# The rules for determining this depend on the implementation of TeX. -# The variable $extension_treatment determines which rules are used. +sub find_basename { + # Finds the basename of the root file + # Arguments: + # 1 - Filename to breakdown + # 2 - Where to place base file + # 3 - Where to place tex file + # Returns non-zero if tex file does not exist + # + # The rules for determining this depend on the implementation of TeX. + # The variable $extension_treatment determines which rules are used. + + # !!!!!!!! I still need to implement use of kpsewhich to match behavior + # of (pdf)latex correctly. -sub find_basename -#?? Need to use kpsewhich, if possible -{ local($given_name, $base_name, $ext, $path, $tex_name); $given_name = $_[0]; if ( "$extension_treatment" eq "miktex_old" ) { @@ -2961,17 +2893,24 @@ sub find_basename $_[2] = $tex_name; } elsif ( "$extension_treatment" eq "unix" ) { - # unix (at least web2c 7.3.1) => - # 1. If filename.tex exists, use it, - # 2. else if filename exists, use it. - # 3. The base filename is obtained by deleting the path - # component and, if an extension exists, the last - # component of the extension, even if the extension is - # null. (A name ending in "." has a null extension.) - # 4. The names of generated files (log, aux) are obtained by - # appending .log, .aux, etc to the basename. Note that - # these are all in the CURRENT directory, and the drive/path - # part of the originally given filename is ignored. + # unix (at least TeXLive 2016) => + # A. Finding of tex file: + # 1. If filename.tex exists, use it, + # 2. else if kpsewhich finds filename.tex, use it + # 3. else if filename exists, use it, + # 4. else if kpsewhich finds filename, use it. + # (Probably can unify the above by + # 1'. If kpsewhich finds filename.tex, use result. + # 2'. else if kpsewhich finds filename, use result. + # 3'. else report file not found. + # B. The base filename is obtained by deleting the path + # component and, if an extension exists, the last + # component of the extension, even if the extension is + # null. (A name ending in "." has a null extension.) + # C. The names of generated files (log, aux) are obtained by + # appending .log, .aux, etc to the basename. Note that + # these are all in the CURRENT directory, and the drive/path + # part of the originally given filename is ignored. # # Thus when the given filename is "/tmp/a.b.c", there are two # cases: @@ -2979,8 +2918,10 @@ sub find_basename # and the basename is "a.b.c". # b. /tmp/a.b.c.tex does not exist. Then the tex file is # "/tmp/a.b.c", and the basename is "a.b". + # But there are also modifications of this when a file can be + # found by kpsewhich. - if ( -e "$given_name.tex" ) { + if ( -f "$given_name.tex" ) { $tex_name = "$given_name.tex"; } else { @@ -3484,6 +3425,8 @@ sub print_help " -pdflatex=<program> - set program used for pdflatex.\n", " (replace '<program>' by the program name)\n", " -pdfps - generate pdf by ps2pdf\n", + " -pdflua - generate pdf by lualatex\n", + " -pdfxe - generate pdf by xelatex\n", " -pdf- - turn off pdf\n", " -ps - generate postscript\n", " -ps- - turn off postscript\n", @@ -3524,9 +3467,9 @@ sub print_help " -view=ps - viewer is for ps\n", " -view=pdf - viewer is for pdf\n", " -lualatex - use lualatex for processing files to pdf\n", - " and turn pdf mode on, dvi/ps modes off\n", + " and turn dvi/ps modes off\n", " -xelatex - use xelatex for processing files to pdf\n", - " and turn pdf mode on, dvi/ps modes off\n", + " and turn dvi/ps modes off\n", "\n", " filename = the root filename of LaTeX document\n", "\n", @@ -3549,6 +3492,8 @@ sub print_commands { warn "Commands used by $my_name:\n", " To run latex, I use \"$latex\"\n", " To run pdflatex, I use \"$pdflatex\"\n", + " To run lualatex, I use \"$lualatex\"\n", + " To run xelatex, I use \"$xelatex\"\n", " To run biber, I use \"$biber\"\n", " To run bibtex, I use \"$bibtex\"\n", " To run makeindex, I use \"$makeindex\"\n", @@ -3557,6 +3502,7 @@ sub print_commands { "I use \"$dvips_landscape\"\n", " To make a pdf file from a dvi file, I use \"$dvipdf\"\n", " To make a pdf file from a ps file, I use \"$ps2pdf\"\n", + " To make a pdf file from an xdv file, I use \"$xdvipdfmx\"\n", " To view a pdf file, I use \"$pdf_previewer\"\n", " To view a ps file, I use \"$ps_previewer\"\n", " To view a ps file in landscape format, ", @@ -3886,7 +3832,6 @@ sub parse_log { # Returned info: %dependents = (); - foreach (@default_includes) { $dependents{$_} = 4; } @bbl_files = (); %idx_files = (); # Maps idx_file to (ind_file, base) %generated_log = (); @@ -3904,7 +3849,7 @@ sub parse_log { # (a) internally deduced pwd from log file from sequence of lines # **file # (dir/file - # if possible + # if possible. NO THAT'S WRONG if kpsearch is done. # (b) from PWD line in fls file (if available), passed as $pwd_latex # (c) system-given cwd as interpreted by sub good_cwd. # We'll put the first two in @pwd_log @@ -3927,7 +3872,10 @@ sub parse_log { if ($log_file_binary) { binmode $log_file; } # Collect lines of log file my @lines = (); - while(<$log_file>) { + my $line = 0; + my $engine = 'pdfTeX'; # Simple default in case of problems + while(<$log_file>) { + $line++; # Could use chomp here, but that fails if there is a mismatch # between the end-of-line sequence used by latex and that # used by perl. (Notably a problem with MSWin latex and @@ -3941,12 +3889,26 @@ sub parse_log { # options open by putting the line into @lines before # and after appending the next line: my $len = length($_); - while ( ($len == $log_wrap) && !eof($log_file) ) { - push @lines, $_; - my $extra = <$log_file>; - $extra =~ s/[\n\r]*$//; - $len = length($extra); - $_ .= $extra; + if ($line == 1) { + if ( /^This is ([^,]+), / ) { + $engine = $1; + print "=== TeX engine is '$engine'\n" + if (!$silent); + } + else { + warn "$My_name: First line of .log file '$log_name' is not in standard format.\n"; + } + } + else { + # LuaTeX sometimes wraps at 80 instead of 79, so work around this + while ( ( ($len == $log_wrap) || ( ($engine eq 'LuaTeX') && ($len == $log_wrap+1) ) ) + && !eof($log_file) ) { + push @lines, $_; + my $extra = <$log_file>; + $extra =~ s/[\n\r]*$//; + $len = length($extra); + $_ .= $extra; + } } push @lines, $_; } @@ -3955,7 +3917,7 @@ sub parse_log { push @lines, ""; # Blank line to terminate. So multiline blocks # are always terminated by non-block line, rather than eof. - my $line = 0; + $line = 0; my $state = 0; # 0 => before ** line, # 1 => after **filename line, before next line (first file-reading line) # 2 => pwd_log determined. @@ -4028,12 +3990,17 @@ LINE: } elsif ( $state == 1 ) { $state = 2; - if ( m{^\("([^"]*)[/\\]\Q$source_log\E"} ) { - unshift @pwd_log, $1; + if (-e $source_log) { + # then the string preceeding $source_log on the line after the + # ** line is probably the PWD as it appears in filenames in the + # log file, except if the file appears in two locations. + if ( m{^\("([^"]*)[/\\]\Q$source_log\E"} ) { + unshift @pwd_log, $1; + } + elsif ( m{^\((.*)[/\\]\Q$source_log\E} ) { + unshift @pwd_log, $1; + } } - elsif ( m{^\((.*)[/\\]\Q$source_log\E} ) { - unshift @pwd_log, $1; - } } if ( $block_type ) { @@ -4185,6 +4152,7 @@ LINE: foreach my $pattern (@file_not_found) { if ( /$pattern/ ) { my $file = clean_filename($1); + warn "===========$My_name: Missing input file: '$file' from line\n '$_'\n"; warn "$My_name: Missing input file: '$file' from line\n '$_'\n" unless $silent; $dependents{normalize_filename($file, @pwd_log)} = 0; @@ -4203,8 +4171,14 @@ LINE: next LINE; } } - if ( /^File: (.+) Graphic file \(type / ) { + if ( (! $fls_file_analyzed) + && /^File: (.+) Graphic file \(type / ) { # First line of message from includegraphics/x + # But this does NOT include full path information + # (if exact match is not found and a non-trivial + # kpsearch was done by (pdf)latex). + # But the source-file information is in the fls file, + # if we are using it. $dependents{normalize_clean_filename($1, @pwd_log)} = 1; next LINE; } @@ -4239,6 +4213,21 @@ LINE: "----- non-existent subdir\n", } } + + if ( ($fls_file_analyzed) && (! $analyze_input_log_always) ) { + # Skip the last part, which is all about finding input + # file names which should all appear more reliably in the + # fls file. + next LINE; + } + + my @new_includes = (); + + GRAPHICS_INCLUDE_CANDIDATE: + while ( /<([^>]+)(>|$)/g ) { + if ( -f $1 ) { push @new_includes, $1; } + } # GRAPHICS_INCLUDE_CANDIDATE: + INCLUDE_CANDIDATE: while ( /\((.*$)/ ) { # Filename found by @@ -4295,7 +4284,6 @@ LINE: # Thus $_ is putative filename followed by other stuff. $_ = $1; # Array of new candidate include files; sometimes more than one. - my @new_includes = (); my $quoted = 0; if ( /^\"([^\"]+)\"/ ) { # Quoted file name, as from MikTeX @@ -4350,27 +4338,28 @@ LINE: # So leave the original candidate in the list } } - INCLUDE_NAME: - foreach my $include_name (@new_includes) { - $include_name = normalize_filename( $include_name, @pwd_log ); - my ($base, $path, $ext) = fileparseB( $include_name ); - if ( ($path eq './') || ($path eq '.\\') ) { - $include_name = $base.$ext; - } - if ( $include_name !~ m'[/|\\]' ) { - # Filename does not include a path character - # High potential for misparsed line - $dependents{$include_name} = 2; - } else { - $dependents{$include_name} = 3; - } - if ( $ext eq '.bbl' ) { - warn "$My_name: Found input bbl file '$include_name'\n" - unless $silent; - push @bbl_files, $include_name; - } - } # INCLUDE_NAME } # INCLUDE_CANDIDATE + + INCLUDE_NAME: + foreach my $include_name (@new_includes) { + $include_name = normalize_filename( $include_name, @pwd_log ); + my ($base, $path, $ext) = fileparseB( $include_name ); + if ( ($path eq './') || ($path eq '.\\') ) { + $include_name = $base.$ext; + } + if ( $include_name !~ m'[/|\\]' ) { + # Filename does not include a path character + # High potential for misparsed line + $dependents{$include_name} = 2; + } else { + $dependents{$include_name} = 3; + } + if ( $ext eq '.bbl' ) { + warn "$My_name: Found input bbl file '$include_name'\n" + unless $silent; + push @bbl_files, $include_name; + } + } # INCLUDE_NAME } # LINE # Default includes are always definitive: @@ -4382,6 +4371,8 @@ LINE: my @misparsed = (); my @missing = (); my @not_found = (); + + my %kpsearch_candidates = (); CANDIDATE: foreach my $candidate (keys %dependents) { my $code = $dependents{$candidate}; @@ -4410,15 +4401,8 @@ CANDIDATE: # We have already tested that file doesn't exist, as given. # so use kpsewhich. # If the file still is not found, assume non-existent; - my @kpse_result = kpsewhich( $candidate ); - if ($#kpse_result > -1) { - delete $dependents{$candidate}; - $dependents{$kpse_result[0]} = 4; - next CANDIDATE; - } - else { - push @not_found, $candidate; - } + $kpsearch_candidates{$candidate} = 1; + delete $dependents{$candidate}; } elsif ($code == 2) { # Candidate is from '(...' construct in log file, for input file @@ -4460,6 +4444,14 @@ CANDIDATE: push @missing, $candidate; } } + + my @kpsearch_candidates = keys %kpsearch_candidates; + if (@kpsearch_candidates) { + foreach my $result ( kpsewhich( @kpsearch_candidates ) ) { + $dependents{$result} = 4; + } + } + CANDIDATE_PAIR: foreach my $delegated_source (keys %new_conversions) { my $delegated_output = $new_conversions{$delegated_source}; @@ -5301,9 +5293,14 @@ sub rdb_set_latex_deps { # Analyze fls file first. It tells us the working directory as seen by (pdf)latex # But we'll use the results later, so that they take priority over the findings # from the log file. - my $fls_file = "$aux_dir1$root_filename.fls"; - if ($recorder && test_gen_file($fls_file) ) { - parse_fls( $fls_file, \%source_fls, \%generated_fls, \%first_read_after_write, \$pwd_latex ); + my $fls_name = "$aux_dir1$root_filename.fls"; + local $fls_file_analyzed = 0; + if ($recorder && test_gen_file($fls_name) ) { + $fls_file_analyzed = + (0== parse_fls( $fls_name, \%source_fls, \%generated_fls, \%first_read_after_write, \$pwd_latex )); + if (! $fls_file_analyzed ) { + warn "$My_name: fls file '$fls_name' appears to have been made but it couldn't be opened.\n"; + } } &parse_log; @@ -5410,7 +5407,7 @@ sub rdb_set_latex_deps { print "!!!===Creating rule '$from_rule': '$ind_file' from '$idx_file'\n" if ($diagnostics); rdb_create_rule( $from_rule, 'external', $makeindex, '', 1, - $idx_file, $ind_file, $ind_base, 1, 0, 0 ); + $idx_file, $ind_file, $ind_base, 1, 0, 0, 1, [ "$ind_base.ilg" ] ); print " ===Source file '$ind_file' for '$rule'\n" if ($diagnostics); rdb_ensure_file( $rule, $ind_file, $from_rule ); @@ -5457,17 +5454,21 @@ sub rdb_set_latex_deps { print " ===Creating rule '$from_rule'\n" if ($diagnostics); if ( $bib_program eq 'biber' ) { rdb_create_rule( $from_rule, 'external', $biber, '', 1, - "$bbl_base.bcf", $bbl_file, $bbl_base, 1, 0, 0 ); + "$bbl_base.bcf", $bbl_file, $bbl_base, 1, 0, 0, 1, [ "$bbl_base.blg" ] ); } else { rdb_create_rule( $from_rule, 'external', $bibtex, 'run_bibtex', 1, - "$bbl_base.aux", $bbl_file, $bbl_base, 1, 0, 0 ); + "$bbl_base.aux", $bbl_file, $bbl_base, 1, 0, 0, 1, [ "$bbl_base.blg" ] ); } } local %old_sources = (); rdb_one_rule( $from_rule, sub { %old_sources = %$PHsource; } ); - foreach my $source ( @new_bib_files, @new_aux_files, @new_bst_files, @biber_source ) { - print " === Source file '$source' for '$from_rule'\n" + my @new_sources = ( @new_bib_files, @new_aux_files, @new_bst_files ); + if ( $bib_program eq 'biber' ) { + push @new_sources, @biber_source; + } + foreach my $source ( @new_sources ) { + print " ===Source file '$source' for '$from_rule'\n" if ($diagnostics); rdb_ensure_file( $from_rule, $source ); delete $old_sources{$source}; @@ -5505,9 +5506,19 @@ NEW_SOURCE: foreach my $new_source (keys %dependents) { print " ===Source file for rule '$rule': '$new_source'\n" if ($diagnostics); - if ( ($dependents{$new_source} == 5) - || ($dependents{$new_source} == 6) - ) { + if ( exists $first_read_after_write{$new_source} ) { + if ( dep_at_start($new_source) ) { + #warn "--- READ ONLY AFTER WRITE OF '$new_source'\n"; + $dependents{$new_source} = 7; + } + else { + #warn "--- READ ONLY AFTER CREATE OF '$new_source'\n"; + $dependents{$new_source} = 6; + } + } + if ( ($dependents{$new_source} == 5) + || ($dependents{$new_source} == 6) + ) { # (a) File was detected in "No file..." line in log file. # Typically file was searched for early in run of # latex/pdflatex, was not found, and then was written @@ -5557,9 +5568,6 @@ NEW_SOURCE: $$Pchanged = 1; # New files can be made. Ignore error. } } - foreach (keys %first_read_after_write) { - delete $dependents{$_}; - } if ($diagnostics) { if ($num_new > 0 ) { print "$num_new new source files for rule '$rule':\n"; @@ -5608,6 +5616,17 @@ sub test_gen_file { #************************************************************ +sub dep_at_start { + # Usage: dep_at_start( filename ) + # Tests whether the file was source file and existed at start of run. + # Assumes context for primary rule. + my $time = undef; + rdb_one_file( shift, sub{ $time = $$Ptime; } ); + return (defined $time) && ($time != 0); +} + +#************************************************************ + sub rdb_find_new_files { # Call: rdb_find_new_files # Assumes rule context for primary rule. @@ -6627,11 +6646,11 @@ sub rdb_run1 { $return = &$int_cmd( @int_args ); } elsif ($$Pext_cmd) { - $return = &Run_subst(); + $return = &Run_subst() / 256; } else { warn "$My_name: Either a bug OR a configuration error:\n", - " Need to implement the command for '$rule'\n"; + " No command provided for '$rule'\n"; &traceback(); $return = -1; $$Plast_result = 2; @@ -6641,7 +6660,7 @@ sub rdb_run1 { my @biber_source = ( ); my $retcode = check_biber_log( $$Pbase, \@biber_source ); foreach my $source ( @biber_source ) { - print " === Source file '$source' for '$rule'\n" + print " ===Source file '$source' for '$rule'\n" if ($diagnostics); rdb_ensure_file( $rule, $source ); } @@ -6756,6 +6775,12 @@ sub rdb_run1 { $$Plast_result = 2; if ($$Plast_message eq '') { $$Plast_message = "Command for '$rule' gave return code $return"; + if ($rule =~ /^(pdf|lua|xe|)latex/) { + $$Plast_message .= "\n Refer to '$log_name' for details"; + } + elsif ($rule =~ /^makeindex/) { + $$Plast_message .= "\n Refer to '${aux_dir1}${root_filename}.ilg' for details"; + } } } elsif ( $$Pdest && (! -e $$Pdest) && ($return != -2) ) { @@ -8101,30 +8126,39 @@ sub kpsewhich { # Usage: kpsewhich( filespec, ...) # Returns array of files with paths as found by kpsewhich # kpsewhich( 'try.sty', 'jcc.bib' ); +# With standard use of kpsewhich (i.e., without -all option), the array +# has either 0 or 1 element. # Can also do, e.g., # kpsewhich( '-format=bib', 'trial.bib', 'file with spaces'); my $cmd = $kpsewhich; my @args = @_; + if ( ($cmd eq '') || ( $cmd =~ /^NONE($| )/ ) ) { + # Kpsewhich not set up. + warn "$My_name: Kpsewhich command needed but not set up\n"; + return (); + } foreach (@args) { if ( ! /^-/ ) { $_ = "\"$_\""; } } - foreach ($cmd) { - s/%[RBTDO]//g; - } + $cmd =~ s/%[RBTDO]//g; $cmd =~ s/%S/@args/g; my @found = (); local $fh; + if ( $kpsewhich_show || $diagnostics ) { + print "$My_name.kpsewhich: Running '$cmd'...\n"; + } open $fh, "$cmd|" or die "Cannot open pipe for \"$cmd\"\n"; while ( <$fh> ) { - s/^\s*//; - s/\s*$//; + s/(\r|\n)$//; push @found, $_; } close $fh; -# show_array( "Kpsewhich: '$cmd', '$file_list' ==>", @found ); + if ( $kpsewhich_show || $diagnostics ) { + show_array( "$My_name.kpsewhich: '$cmd' ==>", @found ); + } return @found; } @@ -8534,7 +8568,7 @@ sub Run_Detached { # Runs program detached. Returns 0 on success, 1 on failure. # Under UNIX use a trick to avoid the program being killed when the # parent process, i.e., me, gets a ctrl/C, which is undesirable for pvc -# mode. (The simplest method, system ("program arguments &"), makes the +# mode. (The simplest method, system("program arguments &"), makes the # child process respond to the ctrl/C.) # Return value is a list (pid, exitcode): # If process is spawned sucessfully, and I know the PID, diff --git a/Master/texmf-dist/source/support/latexmk/latexmk.bat b/Master/texmf-dist/source/support/latexmk/latexmk.bat index 48e01d6e5e1..f119082adac 100755 --- a/Master/texmf-dist/source/support/latexmk/latexmk.bat +++ b/Master/texmf-dist/source/support/latexmk/latexmk.bat @@ -1,5 +1,5 @@ -Rem Execute latexmk.pl, searching for it in the PATH -Rem Assume perl is in the PATH. If not, you should replace 'perl' by -Rem the full pathname of the perl executable, e.g., 'C:\perl\bin\perl.exe' - -perl -S latexmk.pl %1 %2 %3 %4 %5 %6 %7 %8 %9 +Rem Execute latexmk.pl, searching for it in the PATH
+Rem Assume perl is in the PATH. If not, you should replace 'perl' by
+Rem the full pathname of the perl executable, e.g., 'C:\perl\bin\perl.exe'
+
+perl -S latexmk.pl %1 %2 %3 %4 %5 %6 %7 %8 %9
|