diff options
| author | Karl Berry <karl@freefriends.org> | 2016-10-15 22:55:38 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2016-10-15 22:55:38 +0000 |
| commit | c3861279bf2a89f2e1b13a1608f8a2f2f376ab67 (patch) | |
| tree | 47fc395f819b02f7af0d6f27ba83056ff8955194 /Master/texmf-dist | |
| parent | 058b77a3ba0ce417a9dea9433252df4d95e86f98 (diff) | |
latexmk (13oct16)
git-svn-id: svn://tug.org/texlive/trunk@42272 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist')
14 files changed, 1768 insertions, 1404 deletions
diff --git a/Master/texmf-dist/doc/man/man1/latexmk.1 b/Master/texmf-dist/doc/man/man1/latexmk.1 index 30f027fa75c..e2af193039b 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 "22 April 2016" "" +.TH LATEXMK 1L "5 September 2016" "" .SH NAME latexmk \- generate LaTeX document .SH SYNOPSIS @@ -148,17 +148,16 @@ with a ".tex" extension. This behavior can be changed: see the description concerning the \fI@default_files\fR variable in the section "List of configuration variables usable in initialization files". -.PP + If a file is specified without an extension, then the ".tex" extension is automatically added, just as LaTeX does. Thus, if you specify: latexmk foo then \fIlatexmk\fR will operate on the file "foo.tex". -.TP +.TP .B -auxdir=FOO or -aux-directory=FOO - Sets the directory for auxiliary output files of (pdf)latex (.aux, .log etc). This achieves its effect by the \fB-aux-directory\fR option of (pdf)latex, @@ -171,14 +170,18 @@ configuration variables of \fIlatexmk\fR. In particular, see the documentation of \fI$out_dir\fR for some complications on what directory names are suitable. -.TP +If you also use the \fB-cd\fR option, and the specified auxiliary output +directory is a relative path, then the path is interpreted relative to +the document directory. +.TP .B -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 \fI$bibtex_use\fR variable to 2 in a configuration file + .TP .B -bibtex- Never run bibtex or biber. @@ -189,6 +192,7 @@ corresponding bib files available. In this situation use of the \fB-bibtex-\fR option will prevent \fIlatexmk\fR from trying to run \fIbibtex\fR or \fIbiber\fR, which would result in overwriting of the bbl files. + .TP .B -bibtex-cond When the source file uses bbl file(s) for the bibliography, run @@ -210,6 +214,7 @@ problem should not arise, since \fIlatexmk\fR uses the \fIkpsewhich\fR program to do the search, and \fIkpsewhich\fR should use the same search path as \fIbibtex\fR and \fIbiber\fR. If this problem arises, use the \fB-bibtex\fR option when invoking \fIlatexmk\fR.) + .TP .B -bm <message> A banner message to print diagonally across each page when converting @@ -218,11 +223,13 @@ the command line so be careful with quoting spaces and such. Note that if the \fB-bm\fR option is specified, the \fB-ps\fR option is assumed. + .TP .B -bi <intensity> How dark to print the banner message. A decimal number between 0 and 1. 0 is black and 1 is white. The default is 0.95, which is OK unless your toner cartridge is getting low. + .TP .B -bs <scale> A decimal number that specifies how large the banner message will be @@ -230,10 +237,12 @@ 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 character messages. + .TP .B -commands List the commands used by \fIlatexmk\fR for processing files, and then exit. + .TP .B -c Clean up (remove) all regeneratable files generated by \fIlatex\fR and @@ -254,6 +263,7 @@ non-regeneratable. If \fI$cleanup_includes_cusdep_generated\fR is nonzero, regeneratable files are considered as including those generated by custom dependencies and are also deleted. Otherwise these files are not deleted. + .TP .B -C Clean up (remove) all regeneratable files generated by \fIlatex\fR and @@ -270,10 +280,12 @@ non-regeneratable. If \fI$cleanup_includes_cusdep_generated\fR is nonzero, regeneratable files are considered as including those generated by custom dependencies and are also deleted. Otherwise these files are not deleted. + .TP .B -CA (Obsolete). Now equivalent to the \fB-C\fR option. See that option for details. + .TP .B -cd Change to the directory containing the main source file before processing @@ -283,6 +295,7 @@ relative to the source file. This option is particularly useful when \fIlatexmk\fR is invoked from a GUI configured to invoke \fIlatexmk\fR with a full pathname for the source file. + .TP .B -cd- Do NOT change to the directory containing the main source file before processing @@ -294,10 +307,12 @@ This is the default behavior and corresponds to the behavior of the behavior when \fIlatexmk\fR is invoked by a GUI configured to invoke \fIlatexmk\fR with a full pathname for the source file. See the \fB-cd\fR option. + .TP .B -CF Remove the file containing the database of source file information, before doing the other actions requested. + .TP .B -d Set draft mode. This prints the banner message "DRAFT" across your @@ -310,8 +325,9 @@ specifying: Note that if the \fB-d\fR option is specified, the \fB-ps\fR option is assumed. + .TP -.B -deps +.B -deps Show a list of dependent files after processing. This is in the form of a dependency list of the form used by the \fImake\fR program, and it is therefore suitable for use in a Makefile. It gives an overall @@ -331,24 +347,29 @@ the \fB-deps\fR option is very similar in its purpose and results to the \fB-M\fR option to \fIgcc\fR. (In fact, \fIlatexmk\fR also has options \fB-M\fR, \fB-MF\fR, and \fB-MP\fR options that behave like those of \fIgcc\fR.) + .TP -.B -dependents +.B -dependents Equivalent to \fB-deps\fR. + .TP -.B -deps- +.B -deps- Do not show a list of dependent files after processing. (This is the default.) + .TP -.B -dependents- +.B -dependents- Equivalent to \fB-deps-\fR. + .TP -.B -deps-out=FILENAME +.B -deps-out=FILENAME Set the filename to which the list of dependent files is written. If the FILENAME argument is omitted or set to "-", then the output is sent to stdout. Use of this option also turns on the output of the list of dependent files after processing. + .TP .B -dF Dvi file filtering. The argument to this option is a filter which will @@ -359,20 +380,24 @@ be performed on this filtered dvi file. Example usage: To use dviselect to select only the even pages of the dvi file: latexmk -dF "dviselect even" foo.tex + .TP .B -diagnostics Print detailed diagnostics during a run. This may help for debugging problems or to understand \fIlatexmk\fR's behavior in difficult situations. + .TP .B -dvi Generate dvi version of document. + .TP .B -dvi- Turn off generation of dvi version of document. (This may get overridden, if some other file is made (e.g., a .ps file) that is generated from the dvi file, or if no generated file at all is requested.) + .TP .B -e <code> Execute the specified initialization code before processing. The code @@ -415,6 +440,7 @@ or latexmk -e "$latex='latex %O -shell-escape %S'" file.tex The last two examples will NOT work with UNIX/LINUX command shells. + .TP .B -f Force \fIlatexmk\fR to continue document processing despite errors. @@ -434,6 +460,7 @@ this by an option that is passed to the program, e.g., by Turn off the forced processing-past-errors such as is set by the \fB-f\fR option. This could be used to override a setting in a configuration file. + .TP .B -g Force \fIlatexmk\fR to process document fully, even under situations @@ -441,16 +468,20 @@ where \fIlatexmk\fR 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. + .TP .B -g- Turn off \fB-g\fR. + .TP .B -gg "Super go mode" or "clean make": clean out generated files as if \fB-C\fR had been given, and then do a regular make. + .TP .B -h, -help Print help information. + .TP .B -jobname=STRING Set the basename of output files(s) to STRING, instead of the default, @@ -467,9 +498,11 @@ Run in landscape mode, using the landscape mode for the previewers and the dvi to postscript converters. This option is not normally needed nowadays, since current previewers normally determine this information automatically. + .TP .B -l- Turn off \fB-l\fR. + .TP .B -latex="COMMAND" This sets the string specifying the command to run latex, and is @@ -490,6 +523,7 @@ latex) see the \fB-pdflatex\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$latex\fR variable. See the explanation of the \fB-e\fR option. + .TP .B -lualatex Use lualatex. That is, use lualatex to process the source file(s) to @@ -502,16 +536,19 @@ specifying the following sequence of options: .B -M Show list of dependent files after processing. This is equivalent to the \fB-deps\fR option. + .TP .B -MF file If a list of dependents is made, the \fB-MF\fR specifies the file to write it to. + .TP .B -MP If a list of dependents is made, includes 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. + .TP .B -new-viewer When in continuous-preview mode, always start a new viewer to view the @@ -521,11 +558,13 @@ not start a new one if a previous previewer is running. However, its test sometimes fails (notably if there is an already-running previewer that is viewing a file of the same name as the current file, but in a different directory). This option turns off the default behavior. + .TP .B -new-viewer- The inverse of the \fB-new-viewer\fR option. It puts \fIlatexmk\fR in its normal behavior that in preview-continuous mode it checks for an already-running previewer. + .TP .B -nobibtex Never run bibtex or biber. @@ -536,6 +575,7 @@ 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. + .TP .B -norc Turn off the automatic reading of initialization (rc) files. @@ -544,8 +584,8 @@ N.B. Normally the initialization files are read and obeyed, and then command line options are obeyed in the order they are encountered. But \fB-norc\fR is an exception to this rule: it is acted on first, no matter where it occurs on the command line. -.TP +.TP .B -outdir=FOO or -output-directory=FOO Sets the directory for the output files of (pdf)latex. This achieves @@ -560,8 +600,11 @@ configuration variables of \fIlatexmk\fR. In particular, see the documentation of \fI$out_dir\fR for some complications on what directory names are suitable. -.TP +If you also use the \fB-cd\fR option, and the specified output +directory is a relative path, then the path is interpreted relative to +the document directory. +.TP .B -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. @@ -582,8 +625,8 @@ to see how to set the commands for printing. This option is incompatible with the \fB-pv\fR and \fB-pvc\fR options, so it turns them off. -.TP +.TP .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 @@ -594,16 +637,19 @@ options \fB-lualatex\fR or \fB-xelatex\fR applies.) To configure .TP .B -pdfdvi Generate pdf version of document from the dvi file, by default using dvipdf. + .TP .B -pdfps Generate pdf version of document from the ps file, by default using ps2pdf. + .TP .B -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.) + .TP .B -pdflatex="COMMAND" This sets the string specifying the command to run pdflatex, and is @@ -635,6 +681,7 @@ 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 @@ -645,15 +692,18 @@ The (default) case 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. + .TP .B -ps Generate postscript version of document. + .TP .B -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 file, for example a request for printing.) + .TP .B -pF Postscript file filtering. The argument to this option is a filter @@ -672,6 +722,7 @@ or 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. + .TP .B -pv Run file previewer. If the \fB-view\fR option is used, this will select @@ -682,9 +733,11 @@ order dvi, ps, pdf (low to high). If no file type has been selected, the dvi previewer will be used. This option is incompatible with the \fB-p\fR and \fB-pvc\fR options, so it turns them off. + .TP .B -pv- Turn off \fB-pv\fR. + .TP .B -pvc Run a file previewer and continually update the .dvi, .ps, and/or .pdf @@ -724,12 +777,15 @@ the \fB-pvc\fR option will not fork new previewers, but \fIlatexmk\fR will normally use the existing previewer. (At least this will happen when \fIlatexmk\fR is running under an operating system where it knows how to determine whether an existing previewer is running.) + .TP .B -pvc- Turn off \fB-pvc\fR. + .TP .B -quiet Same as -silent + .TP .B -r <rcfile> Read the specified initialization file ("RC file") before processing. @@ -753,8 +809,9 @@ initialization code directly on \fIlatexmk\fR's command line. An error results in \fIlatexmk\fR stopping. Multiple instances of the \fB-r\fR and \fB-e\fR options can be used, and they are executed in the order they appear on the command line. + .TP -.B -recorder +.B -recorder Use 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 @@ -764,16 +821,20 @@ run of \fIlatex\fR or \fIpdflatex\fR. For further information, see the documentation for the \fI$recorder\fR configuration variable. + .TP -.B -recorder- +.B -recorder- Do not use the -recorder option with \fIlatex\fR and \fIpdflatex\fR. + .TP -.B -rules +.B -rules Show a list of \fIlatemk\fR's rules and dependencies after processing. + .TP -.B -rules- +.B -rules- Do not show a list of \fIlatexmk\fR's rules and dependencies after processing. (This is the default.) + .TP .B -showextraoptions Show the list of extra \fIlatex\fR and \fIpdflatex\fR options that @@ -841,6 +902,7 @@ 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. + .TP .B -use-make When after a run of \fIlatex\fR or \fIpdflatex\fR, there are warnings @@ -859,15 +921,19 @@ appropriate \fIpdflatex\fR). See also the documentation for the \fI$use_make_for_missing_files\fR configuration variable. + .TP .B -use-make- Do not use the make program to try to make missing files. (Default.) + .TP .B -v, -version Print version number of \fIlatexmk\fR. + .TP .B -verbose Opposite of \fB-silent\fR. This is the default setting. + .TP .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 @@ -878,8 +944,8 @@ 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. -.TP +.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 @@ -953,7 +1019,7 @@ d. Further tricks can involve replacing the standard commands that 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., -at http://www.ctan.org/tex-archive/support/latexmk/example_rcfiles). +at http://mirror.ctan.org/support/latexmk/example_rcfiles). Even if these examples don't do what you want, they may provide suitable inspiration. @@ -1008,13 +1074,31 @@ that of cygwin), \fIlatexmk\fR reads for the first it finds of 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, "$HOME/.latexmkrc", if it exists. Here $HOME +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 configuration home directory. The actual file read is the first +of "$XDG_CONFIG_HOME/latexmk/latexmkrc" or "$HOME/.latexmkrc" which +exists. (See +https://specifications.freedesktop.org/basedir-spec/basedir-spec-latest.html +for details on the XDG Base Directory Specification.) + +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 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.] +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 +it.] + +$XDG_CONFIG_HOME is the value of the environment variable +XDG_CONFIG_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 \fIlatexmk\fR does not look for an RC file under it. + .PP 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 @@ -1040,7 +1124,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 -http://www.ctan.org/tex-archive/support/latexmk/example_rcfiles). +http://mirror.ctan.org/support/latexmk/example_rcfiles). \fR .SH HOW TO SET VARIABLES IN INITIALIZATION FILES @@ -1352,6 +1436,10 @@ MiKTeX version of (pdf)latex. See also the documentation of \fI$out_dir\fR for some complications on what directory names are suitable. +If you also use the \fB-cd\fR option, and \fI$out_dir\fR (or \fI$aux_dir\fR) contains a +relative path, then the path is interpreted relative to the document +directory. + .TP .B $banner [0] If nonzero, the banner message is printed across each page when @@ -2274,7 +2362,7 @@ correctly deal with TeX files whose names contain spaces. Latexmk's quoting only ensures that such filenames are correctly treated by the operating system in passing arguments to programs.) .TP -.B $recorder [0] +.B $recorder [1] Whether to use the \fB-recorder\fR option to \fIlatex\fR and \fIpdflatex\fR. Use of this option results in a file of extension \fI.fls\fR containing a list of the files that these programs have @@ -2664,6 +2752,20 @@ files. This subroutine removes one or more files from the dependency list for the given rule. +.TP +.B rdb_list_source( $rule ) +This subroutine returns the list of source files (i.e., the dependency +list) for the given rule. + +.TP +.B rdb_set_source( $rule, file, ... ) +.B rdb_set_source( $rule, @files ) +This subroutine sets the dependency list for the given rule to be the +specified files. Files that are already in the list have unchanged +information. Files that were not in the list are added to it. Files +in the previous dependency list that are not in the newly specified +list of files are removed from the dependency list. + .SS Advanced configuration: Using \fIlatexmk\fB with \fImake\fR @@ -2828,11 +2930,11 @@ 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.45). +(Version 4.48). Released version can be obtained from CTAN: -<http://www.ctan.org/tex-archive/support/latexmk/>, and from the -author's website <http://www.phys.psu.edu/~collins/software/latexmk/>. +<http://www.ctan.org/pkg/latexmk/>, and from the +author's website <http://www.personal.psu.edu/jcc8/latexmk/>. .br Modifications and enhancements by Evan McLean (Version 2.0) .br 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 b137535f4f3..01fd9cd499e 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 d75786bbb1a..bc594251252 100644 --- a/Master/texmf-dist/doc/support/latexmk/CHANGES +++ b/Master/texmf-dist/doc/support/latexmk/CHANGES @@ -491,3 +491,16 @@ From v. 4.44 to 4.45 Fix bug in limiting number of passes when $max_repeat >= 10 Fix bug in finding id of viewer process id under OS-X +From v. 4.45 to 4.46 + Correct creation of output and aux directories to correctly handle + relative paths when -cd is used. + Minor documentation corrections. + +From v. 4.46 to 4.48 + Correct documention: default value of $recorder is 1 + Add routines rdb_list_source, rdb_set_source for manipulating + dependency lists of a rule. Add these to the documentated + interface, in addition to the already documented rdb_ensure_file, + rdb_remove_files. + Update webpages in documentation. + diff --git a/Master/texmf-dist/doc/support/latexmk/INSTALL b/Master/texmf-dist/doc/support/latexmk/INSTALL index e41cc5004fb..62534e80a28 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.45, 22 April 2016) + (Version 4.48, 5 September 2016) John Collins Physics Department @@ -9,8 +9,8 @@ University Park PA 16802 U.S.A. - http://www.phys.psu.edu/~collins/ - http://www.phys.psu.edu/~collins/latexmk/ + http://www.personal.psu.edu/jcc8/ + http://www.personal.psu.edu/jcc8/latexmk/ username jcc8 at node psu.edu Latexmk is a "make" tool for building latex documents. It runs latex diff --git a/Master/texmf-dist/doc/support/latexmk/README b/Master/texmf-dist/doc/support/latexmk/README index 93e625a38ae..7826b9db450 100644 --- a/Master/texmf-dist/doc/support/latexmk/README +++ b/Master/texmf-dist/doc/support/latexmk/README @@ -1,5 +1,5 @@ -Latexmk, version 4.45, 22 April 2016 ------------------------------------- +Latexmk, version 4.48, 5 September 2016 +--------------------------------------- Latexmk completely automates the process of generating a LaTeX document. Essentially, it is a highly specialized cousin of the @@ -37,7 +37,7 @@ written by David J. Musliner. Now it is supported by University Park PA 16802 U.S.A. - http://www.phys.psu.edu/~collins/ + http://www.personal.psu.edu/jcc8/ username jcc8 at node psu.edu The start of the script file has copyright notices and disclaimers. It @@ -78,7 +78,7 @@ NOTES:- perfectly. Refer to $pscmd in the man page. 6) Latexmk can be downloaded from the author's site at - http://www.phys.psu.edu/~collins/software/latexmk/ + http://www.personal.psu.edu/jcc8/latexmk/ This site also includes previous versions, and sometimes newer versions under development. @@ -91,7 +91,7 @@ NOTES:- John Collins ---------------------------- "latexmk -h" ---------------------------- -Latexmk 4.45: Automatic LaTeX document generation routine +Latexmk 4.48: Automatic LaTeX document generation routine Usage: latexmk [latexmk_options] [filename ...] diff --git a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/README-rcfiles b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/README-latexmk-rcfiles index 61aa7832dba..61aa7832dba 100644 --- a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/README-rcfiles +++ b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/README-latexmk-rcfiles 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 53e2aa4a786..1106127b87d 100644 --- a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/asymptote_latexmkrc +++ b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/asymptote_latexmkrc @@ -19,9 +19,58 @@ # is to be put in one of latexmk's rc files, e.g., ~/.latexmkrc.) # -# The following lines are taken from the documentation for V. 2.03 of -# asymptote: -sub asy {return system("asy \"$_[0]\"");} -add_cus_dep("asy","eps",0,"asy"); -add_cus_dep("asy","pdf",0,"asy"); -add_cus_dep("asy","tex",0,"asy"); +## OLD simple method (taken from the documentation for V. 2.03 of +## asymptote). These definitions are simple, but they may not always +## give the desired type of output file, and they do not ensure that +## latexmk has dependency information about files imported from the +## asy file. +#OLD sub asy {return system("asy \"$_[0]\"");} +#OLD add_cus_dep("asy","eps",0,"asy"); +#OLD add_cus_dep("asy","pdf",0,"asy"); +#OLD add_cus_dep("asy","tex",0,"asy"); + + +# The following definitions arrange to run asy with the correct output +# file type. They run asy in a verbose mode so that dependency +# information on imported files can be extracted. To avoid adding a +# lot of extra printout on the screen of unimportant messages, the +# output is sent to a log file. Since this includes error messages, +# which the user should see, latexmk types out error messages and the +# like. These definitions need latexmk 4.48 or later. + +add_cus_dep("asy","eps",0,"asy2eps"); +add_cus_dep("asy","pdf",0,"asy2pdf"); +add_cus_dep("asy","tex",0,"asy2tex"); + +sub asy2eps { return asy2x( $_[0], 'eps' ); } +sub asy2pdf { return asy2x( $_[0], 'pdf' ); } +sub asy2tex { return asy2x( $_[0], 'tex' ); } + +sub asy2x { + my $ret = system("asy -vv -f '$_[1]' '$_[0]' >& '$_[0].log'"); + my $FH = new FileHandle; + open $FH, "$_[0].log"; + %imp = (); + + while (<$FH>) { + if (/^(Including|Loading) .* from (.*)\s*$/) { + my $import = $2; + $imp{$import} = 1; + } + elsif ( /^error/ || /^.*\.asy: \d/ ) { + warn "==Message from asy: $_"; + $ret = 1; + } + elsif ( /^kpsewhich / || /^Processing / || /^Using / + || /^Welcome / || /^Wrote /|| /^cd /|| /^gs / + ) { + } + else { + warn "==Message from asy: $_"; + } + } + close $FH; +# For latexmk 4.48 + rdb_set_source( $rule, keys %imp ); + return $ret; +} diff --git a/Master/texmf-dist/doc/support/latexmk/extra-scripts/README-scripts b/Master/texmf-dist/doc/support/latexmk/extra-scripts/README-latexmk-scripts index 0f67cb114dc..0f67cb114dc 100644 --- a/Master/texmf-dist/doc/support/latexmk/extra-scripts/README-scripts +++ b/Master/texmf-dist/doc/support/latexmk/extra-scripts/README-latexmk-scripts 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 104bbabe858..a0817015fe6 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 01a140a65fe..0068de2196d 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/latexmk.pdf b/Master/texmf-dist/doc/support/latexmk/latexmk.pdf Binary files differindex f42e2ed8a4a..9792f2ed64f 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 7520751c137..37824b618e7 100644 --- a/Master/texmf-dist/doc/support/latexmk/latexmk.txt +++ b/Master/texmf-dist/doc/support/latexmk/latexmk.txt @@ -127,7 +127,7 @@ LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE - 22 April 2016 2 + 5 September 2016 2 @@ -159,237 +159,270 @@ LATEXMK(1L) LATEXMK(1L) able in the section "List of configuration variables usable in initialization files". - If a file is specified without an extension, then the ".tex" extension - is automatically added, just as LaTeX does. Thus, if you specify: + If a file is specified without an extension, then the ".tex" + extension is automatically added, just as LaTeX does. Thus, if + you specify: - latexmk foo + latexmk foo - then latexmk will operate on the file "foo.tex". + then latexmk will operate on the file "foo.tex". -auxdir=FOO or -aux-directory=FOO - - Sets the directory for auxiliary output files of (pdf)latex - (.aux, .log etc). This achieves its effect by the -aux-direc- - tory option of (pdf)latex, which currently is only implemented + Sets the directory for auxiliary output files of (pdf)latex + (.aux, .log etc). This achieves its effect by the -aux-direc- + tory option of (pdf)latex, which currently is only implemented on the MiKTeX version of (pdf)latex. - See also the -outdir/-output-directory options, and the + See also the -outdir/-output-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 + 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 auxiliary out- + put directory is a relative path, then the path is interpreted + 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 - variable to 2 in a configuration file + This property can also be configured by setting the $bibtex_use + - -bibtex- - Never run bibtex or biber. + 5 September 2016 3 - 22 April 2016 3 +LATEXMK(1L) LATEXMK(1L) + variable to 2 in a configuration file -LATEXMK(1L) LATEXMK(1L) + -bibtex- + 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 -bibtex- option will prevent latexmk from + 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 -bibtex- option will prevent latexmk from trying to run bibtex or biber, which would result in overwriting of the bbl files. + -bibtex-cond - When the source file uses bbl file(s) for the bibliography, run - bibtex or biber as needed to regenerate the bbl files, but only - if the relevant bib file(s) exist. Thus when the bib files are - not available, bibtex or biber is not run, thereby avoiding + When the source file uses bbl file(s) for the bibliography, run + bibtex or biber as needed to regenerate the bbl files, but only + if the relevant bib file(s) exist. Thus when the bib files are + not available, bibtex or biber is not run, thereby avoiding overwriting of the bbl file(s). This is the default setting. - (Note that it is possible for latexmk to decide that the bib - file does not exist, even though the bib file does exist and - bibtex or biber finds it. The problem is that the bib file may - not be in the current directory but in some search path; the + (Note that it is possible for latexmk to decide that the bib + file does not exist, even though the bib file does exist and + bibtex or biber finds it. The problem is that the bib file may + not be in the current directory but in some search path; the places latexmk and bibtex or biber cause to be searched need not - be identical. On modern installations of TeX and related pro- - grams this problem should not arise, since latexmk uses the + be identical. On modern installations of TeX and related pro- + grams this problem should not arise, since latexmk uses the kpsewhich program to do the search, and kpsewhich should use the - same search path as bibtex and biber. If this problem arises, + same search path as bibtex and biber. If this problem arises, use the -bibtex option when invoking latexmk.) + -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 + 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. - Note that if the -bm option is specified, the -ps option is + Note that if the -bm option is specified, the -ps option is assumed. + -bi <intensity> - How dark to print the banner message. A decimal number between + How dark to print the banner message. A decimal number between 0 and 1. 0 is black and 1 is white. The default is 0.95, which is OK unless your toner cartridge is getting low. + -bs <scale> - A decimal number that specifies how large the banner message - will be printed. Experimentation is necessary to get the right - scale for your message, as a rule of thumb the scale should be - about equal to 1100 divided by the number of characters in the - message. The default is 220.0 which is just right for 5 charac- - ter messages. + A decimal number that specifies how large the banner message + will be printed. Experimentation is necessary to get the right + scale for your message, as a rule of thumb the scale should be + about equal to 1100 divided by the number of characters in the - -commands - List the commands used by latexmk for processing files, and then - exit. - -c Clean up (remove) all regeneratable files generated by latex and - bibtex or biber except dvi, postscript and pdf. These files are - a combination of log files, aux files, latexmk's database file - of source file information, and those with extensions specified - in the @generated_exts configuration variable. In addition, + 5 September 2016 4 - 22 April 2016 4 +LATEXMK(1L) LATEXMK(1L) -LATEXMK(1L) LATEXMK(1L) + message. The default is 220.0 which is just right for 5 charac- + ter messages. + + + -commands + List the commands used by latexmk for processing files, and then + exit. - files specified by the $clean_ext configuration variable are + -c Clean up (remove) all regeneratable files generated by latex and + bibtex or biber except dvi, postscript and pdf. These files are + a combination of log files, aux files, latexmk's database file + of source file information, and those with extensions specified + in the @generated_exts configuration variable. In addition, + files specified by the $clean_ext configuration variable are removed. - This cleanup is instead of a regular make. See the -gg option + This cleanup is instead of a regular make. See the -gg option if you want to do a cleanup then a make. - If $bibtex_use is set to 0 or 1, bbl files are counted as non- + If $bibtex_use is set to 0 or 1, bbl files are counted as non- regeneratable. - If $cleanup_includes_cusdep_generated is nonzero, regeneratable - files are considered as including those generated by custom - dependencies and are also deleted. Otherwise these files are + If $cleanup_includes_cusdep_generated is nonzero, regeneratable + files are considered as including those generated by custom + dependencies and are also deleted. Otherwise these files are not deleted. + -C Clean up (remove) all regeneratable files generated by latex and - bibtex or biber. This is the same as the -c option with the - addition of dvi, postscript and pdf files, and those specified + bibtex or biber. This is the same as the -c option with the + addition of dvi, postscript and pdf files, and those specified in the $clean_full_ext configuration variable. - This cleanup is instead of a regular make. See the -gg option + This cleanup is instead of a regular make. See the -gg option if you want to do a cleanup than a make. - If $bibtex_use is set to 0 or 1, bbl files are counted as non- + If $bibtex_use is set to 0 or 1, bbl files are counted as non- regeneratable. - If $cleanup_includes_cusdep_generated is nonzero, regeneratable - files are considered as including those generated by custom - dependencies and are also deleted. Otherwise these files are + If $cleanup_includes_cusdep_generated is nonzero, regeneratable + files are considered as including those generated by custom + dependencies and are also deleted. Otherwise these files are not deleted. - -CA (Obsolete). Now equivalent to the -C option. See that option + + -CA (Obsolete). Now equivalent to the -C option. See that option for details. - -cd Change to the directory containing the main source file before - processing it. Then all the generated files (aux, log, dvi, + + -cd Change to the directory containing the main source file before + processing it. Then all the generated files (aux, log, dvi, pdf, etc) will be relative to the source file. - This option is particularly useful when latexmk is invoked from - a GUI configured to invoke latexmk with a full pathname for the - source file. - -cd- Do NOT change to the directory containing the main source file - before processing it. Then all the generated files (aux, log, - dvi, pdf, etc) will be relative to the current directory rather - than the source file. - This is the default behavior and corresponds to the behavior of - the latex and pdflatex programs. However, it is not desirable - behavior when latexmk is invoked by a GUI configured to invoke - latexmk with a full pathname for the source file. See the -cd - option. - -CF Remove the file containing the database of source file informa- - tion, before doing the other actions requested. + 5 September 2016 5 - -d Set draft mode. This prints the banner message "DRAFT" across - your page when converting the dvi file to postscript. Size and - 22 April 2016 5 +LATEXMK(1L) LATEXMK(1L) + This option is particularly useful when latexmk is invoked from + a GUI configured to invoke latexmk with a full pathname for the + source file. -LATEXMK(1L) LATEXMK(1L) + -cd- Do NOT change to the directory containing the main source file + before processing it. Then all the generated files (aux, log, + dvi, pdf, etc) will be relative to the current directory rather + than the source file. + + This is the default behavior and corresponds to the behavior of + the latex and pdflatex programs. However, it is not desirable + behavior when latexmk is invoked by a GUI configured to invoke + latexmk with a full pathname for the source file. See the -cd + option. + -CF Remove the file containing the database of source file informa- + tion, before doing the other actions requested. + + + -d Set draft mode. This prints the banner message "DRAFT" across + your page when converting the dvi file to postscript. Size and intensity can be modified with the -bs and -bi options. The -bm - option will override this option as this is really just a short + option will override this option as this is really just a short way of specifying: latexmk -bm DRAFT - Note that if the -d option is specified, the -ps option is + Note that if the -d option is specified, the -ps option is assumed. + -deps Show a list of dependent files after processing. This is in the - form of a dependency list of the form used by the make program, + form of a dependency list of the form used by the make program, and it is therefore suitable for use in a Makefile. It gives an overall view of the files without listing intermediate files, as well as latexmk can determine them. - By default the list of dependent files is sent to stdout (i.e., - normally to the screen unless you've redirected latexmk's out- + By default the list of dependent files is sent to stdout (i.e., + normally to the screen unless you've redirected latexmk's out- put). But you can set the filename where the list is sent by the -deps-out= option. - See the section "USING latexmk WITH make" for an example of how + See the section "USING latexmk WITH make" for an example of how to use a dependency list with make. - Users familiar with GNU automake and gcc will find that the - -deps option is very similar in its purpose and results to the - -M option to gcc. (In fact, latexmk also has options -M, -MF, + Users familiar with GNU automake and gcc will find that the + -deps option is very similar in its purpose and results to the + -M option to gcc. (In fact, latexmk also has options -M, -MF, and -MP options that behave like those of gcc.) + -dependents Equivalent to -deps. - -deps- Do not show a list of dependent files after processing. (This + + + + 5 September 2016 6 + + + + + +LATEXMK(1L) LATEXMK(1L) + + + -deps- Do not show a list of dependent files after processing. (This is the default.) + -dependents- Equivalent to -deps-. + -deps-out=FILENAME - Set the filename to which the list of dependent files is writ- - ten. If the FILENAME argument is omitted or set to "-", then + Set the filename to which the list of dependent files is writ- + ten. If the FILENAME argument is omitted or set to "-", then the output is sent to stdout. - Use of this option also turns on the output of the list of + Use of this option also turns on the output of the list of dependent files after processing. - -dF Dvi file filtering. The argument to this option is a filter - which will generate a filtered dvi file with the extension - ".dviF". All extra processing (e.g. conversion to postscript, - preview, printing) will then be performed on this filtered dvi + + -dF Dvi file filtering. The argument to this option is a filter + which will generate a filtered dvi file with the extension + ".dviF". All extra processing (e.g. conversion to postscript, + preview, printing) will then be performed on this filtered dvi file. Example usage: To use dviselect to select only the even pages of @@ -397,62 +430,66 @@ LATEXMK(1L) LATEXMK(1L) latexmk -dF "dviselect even" foo.tex + -diagnostics - Print detailed diagnostics during a run. This may help for - debugging problems or to understand latexmk's behavior in + Print detailed diagnostics during a run. This may help for + debugging problems or to understand latexmk's behavior in diffi- + cult situations. + -dvi Generate dvi version of document. - 22 April 2016 6 + -dvi- Turn off generation of dvi version of document. (This may get + overridden, if some other file is made (e.g., a .ps file) that + is generated from the dvi file, or if no generated file at all + is requested.) + -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 -LATEXMK(1L) LATEXMK(1L) - difficult situations. + 5 September 2016 7 + - -dvi Generate dvi version of document. - -dvi- Turn off generation of dvi version of document. (This may get - overridden, if some other file is made (e.g., a .ps file) that - is generated from the dvi file, or if no generated file at all - is requested.) - -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 - -e options can be used, and they are executed in the order they +LATEXMK(1L) LATEXMK(1L) + + + -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 + 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 latexmk -e '$latex=q/latex %O -shell-escape %S/' file.tex - Note that the single quotes block normal UNIX/LINUX command - shells from treating the characters inside the quotes as spe- - cial. (In this example, the q/.../ construct is a Perl idiom - equivalent to using single quotes. This avoids the complica- - tions of getting a quote character inside an already quoted - string in a way that is independent of both the shell and the + Note that the single quotes block normal UNIX/LINUX command + shells from treating the characters inside the quotes as spe- + cial. (In this example, the q/.../ construct is a Perl idiom + equivalent to using single quotes. This avoids the complica- + tions of getting a quote character inside an already quoted + string in a way that is independent of both the shell and the operating-system.) - The above command line will NOT work under MS-Windows with - cmd.exe or command.com or 4nt.exe. For MS-Windows with these + The above command line will NOT work under MS-Windows with + cmd.exe or command.com or 4nt.exe. For MS-Windows with these command shells you could use latexmk -e "$latex=q/latex %O -shell-escape %S/" file.tex @@ -461,162 +498,174 @@ 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. - -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 + 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. + -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. - 22 April 2016 7 + -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. -LATEXMK(1L) LATEXMK(1L) + 5 September 2016 8 - 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. - -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. - -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. +LATEXMK(1L) LATEXMK(1L) + -g- Turn off -g. + -gg "Super go mode" or "clean make": clean out generated files as if -C had been given, and then do a regular make. + -h, -help Print help information. + -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. + -l- Turn off -l. + -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 + 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 + 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: - 22 April 2016 8 + -pdflatex="lualatex %O %S" -pdf -dvi- -ps- + 5 September 2016 9 -LATEXMK(1L) LATEXMK(1L) - -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: - -pdflatex="lualatex %O %S" -pdf -dvi- -ps- +LATEXMK(1L) LATEXMK(1L) - -M Show list of dependent files after processing. This is equiva- + -M Show list of dependent files after processing. This is equiva- lent to the -deps option. + -MF file - If a list of dependents is made, the -MF specifies the file to + If a list of dependents is made, the -MF specifies the file to write it to. - -MP If a list of dependents is made, includes 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 + + -MP If a list of dependents is made, includes 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. + -new-viewer - When in continuous-preview mode, always start a new viewer to - view the generated file. By default, latexmk will, in continu- - ous-preview mode, test for a previously running previewer for + When in continuous-preview mode, always start a new viewer to + view the generated file. By default, latexmk will, in continu- + ous-preview mode, test for a previously running previewer for the same file and not start a new one if a previous previewer is running. However, its test sometimes fails (notably if there is - an already-running previewer that is viewing a file of the same - name as the current file, but in a different directory). This + an already-running previewer that is viewing a file of the same + name as the current file, but in a different directory). This option turns off the default behavior. + -new-viewer- - The inverse of the -new-viewer option. It puts latexmk in its + The inverse of the -new-viewer option. It puts latexmk in its normal behavior that in preview-continuous mode it checks for an already-running previewer. + -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 + 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. + -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. - 22 April 2016 9 + 5 September 2016 10 @@ -625,28 +674,32 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) + 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 + 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. - -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. + -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 + 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. @@ -654,49 +707,52 @@ 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 + -lualatex or -xelatex applies.) To configure latexmk to have such behavior by default, see the section on "Configuration/ini- tialization (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 + + -pdfps Generate pdf version of document from the ps file, by default using ps2pdf. - -pdf- Turn off generation of pdf version of document. (This can be - used to override a setting in a configuration file. It may get + + -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 nor- - mally contains spaces, it should be quoted, e.g., + is typically used to add desired options. Since the string - latexmk -pdf -pdflatex="pdflatex --shell-escape %O %S" - foo.tex - The specification of the contents of the string are the same as - for the $pdflatex configuration variable. Depending on your - operating system and the command-line shell you are using, you + 5 September 2016 11 - 22 April 2016 10 +LATEXMK(1L) LATEXMK(1L) -LATEXMK(1L) LATEXMK(1L) + normally contains spaces, it should be quoted, e.g., + latexmk -pdf -pdflatex="pdflatex --shell-escape %O %S" + foo.tex - may need to change the single quotes to double quotes (or some- + The specification of the contents of the string are the same as + for the $pdflatex configuration variable. Depending on your + operating system and the command-line shell you are using, you + 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 @@ -710,31 +766,35 @@ LATEXMK(1L) LATEXMK(1L) 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 + 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. + -ps Generate postscript version of document. + -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. @@ -742,187 +802,198 @@ 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. - -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 + 5 September 2016 12 - 22 April 2016 11 +LATEXMK(1L) LATEXMK(1L) + or -LATEXMK(1L) LATEXMK(1L) + 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. - previewer 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 - it knows how to determine whether an existing previewer is run- - ning.) + 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 - -pvc- Turn off -pvc. - -quiet Same as -silent - -r <rcfile> - Read the specified initialization file ("RC file") before pro- - cessing. + 5 September 2016 13 - 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 - 22 April 2016 12 +LATEXMK(1L) LATEXMK(1L) + it knows how to determine whether an existing previewer is run- + ning.) -LATEXMK(1L) LATEXMK(1L) + -pvc- Turn off -pvc. + + -quiet Same as -silent + + -r <rcfile> + Read the specified initialization file ("RC file") before pro- + cessing. + + Be careful about the ordering: (1) Standard initialization files + -- see the section below on "Configuration/initialization (RC) + files" -- are read first. (2) Then the options on the command + line are acted on in the order they are given. Therefore if an + initialization file is specified by the -r option, it is read + during this second step. Thus an initialization file specified with the -r option can override both the standard initialization files and previously specified options. But all of these can be overridden by later options. The contents of the RC file just comprise a piece of code in the - Perl programming language (typically a sequence of assignment + Perl programming language (typically a sequence of assignment statements); they are executed when the -r option is encountered during latexmk's parsing of its command line. See the -e option - for a way of giving initialization code directly on latexmk's - command line. An error results in latexmk stopping. Multiple - instances of the -r and -e options can be used, and they are + for a way of giving initialization code directly on latexmk's + command line. An error results in latexmk stopping. Multiple + instances of the -r and -e options can be used, and they are executed in the order they appear on the command line. + -recorder - 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- + 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- grams have read and written. Latexmk will then use this file to - improve its detection of source files and generated files after + improve its detection of source files and generated files after a run of latex or pdflatex. For further information, see the documentation for the $recorder configuration variable. + -recorder- Do not use 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.) - -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 - with latexmk's intended operations, or because they need special - processing by latexmk that isn't implemented (at least, not - yet). - 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 + 5 September 2016 14 - 22 April 2016 13 +LATEXMK(1L) LATEXMK(1L) -LATEXMK(1L) LATEXMK(1L) + -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 + with latexmk's intended operations, or because they need special + processing by latexmk that isn't implemented (at least, not + yet). + 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 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 + 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 + -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. @@ -930,89 +1001,106 @@ LATEXMK(1L) LATEXMK(1L) -silent Run commands silently, i.e., with options that reduce the amount - of diagnostics generated. For example, with the default set- - tings, the command "latex -interaction=batchmode" is used for + of diagnostics generated. For example, with the default set- + tings, the command "latex -interaction=batchmode" is used for latex. - See also the -logfilewarninglist and -logfilewarninglist- + See also the -logfilewarninglist and -logfilewarninglist- options. - Also reduce the number of informational messages that latexmk + Also reduce the number of informational messages that latexmk generates. - To change the options used to make the commands run silently, + To change the options used to make the commands run silently, + + + + 5 September 2016 15 + + + + + +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, + 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. + -use-make - When after a run of latex or pdflatex, there are warnings about + 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 + 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 + 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. - Note that the filename may be specified without an extension, - e.g., by \includegraphics{drawing} in a LaTeX file. In that - case, latexmk will try making drawing.ext with ext set in turn - to the possible extensions that are relevant for latex (or as + Note that the filename may be specified without an extension, + e.g., by \includegraphics{drawing} in a LaTeX file. In that + case, latexmk will try making drawing.ext with ext set in turn + to the possible extensions that are relevant for latex (or as appropriate pdflatex). - See also the documentation for the $use_make_for_missing_files + See also the documentation for the $use_make_for_missing_files configuration variable. + -use-make- - Do not use the make program to try to make missing files. + Do not use the make program to try to make missing files. (Default.) - - 22 April 2016 14 - - - - - -LATEXMK(1L) LATEXMK(1L) - - -v, -version Print version number of latexmk. + -verbose Opposite of -silent. This is the default setting. + -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). - 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 + 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. -xelatex Use xelatex. That is, use xelatex to process the source file(s) - to pdf (in place of pdflatex). This option is exactly equiva- + to pdf (in place of pdflatex). This option is exactly equiva- lent to specifying the following sequence of options: -pdflatex="xelatex %O %S" -pdf -dvi- -ps- + + + 5 September 2016 16 + + + + + +LATEXMK(1L) LATEXMK(1L) + + Compatibility between options - The preview-continuous option -pvc can only work with one file. So in - this case you will normally only specify one filename on the command + The preview-continuous option -pvc can only work with one file. So in + this case you will normally only specify one filename on the command line. - Options -p, -pv and -pvc are mutually exclusive. So each of these + Options -p, -pv and -pvc are mutually exclusive. So each of these options turns the others off. @@ -1040,90 +1128,80 @@ EXAMPLES DEALING WITH ERRORS, PROBLEMS, ETC Some possibilities: + a. If you get a strange error, do look carefully at the output that is + on the screen and in log files. While there is much that is notori- + 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. + b. Generally, remember that latexmk does its work by running other pro- + grams. Your first priority in dealing with errors should be to examine + what went wrong with the individual programs. Then you need to correct + the causes of errors in the runs of these programs. (Often these come + from errors in the source document, but they could also be about miss- + ing LaTeX packages, etc.) + c. If latexmk doesn't run the programs the way you would like, then you + need to look in this documentation at the list of command line options + and then at the sections on configuration/initialization files. A lot + of latexmk's behavior is configurable to deal with particular situa- + tions. (But there is a lot of reading!) - 22 April 2016 15 + The remainder of these notes consists of ideas for dealing with more + difficult situations. + 5 September 2016 17 -LATEXMK(1L) LATEXMK(1L) - a. If you get a strange error, do look carefully at the output that is - on the screen and in log files. While there is much that is notori- - ously verbose in the output of latex (and that is added to by latexmk), - the verbosity is there for a reason: to enable the user to diagnose - problems. Latexmk does repeat some messages at the end of a run that - it thinks would otherwise be easy to miss in the middle of other out- - put. - b. Generally, remember that latexmk does its work by running other pro- - grams. Your first priority in dealing with errors should be to examine - what went wrong with the individual programs. Then you need to correct - the causes of errors in the runs of these programs. (Often these come - from errors in the source document, but they could also be about miss- - ing LaTeX packages, etc.) - c. If latexmk doesn't run the programs the way you would like, then you - need to look in this documentation at the list of command line options - and then at the sections on configuration/initialization files. A lot - of latexmk's behavior is configurable to deal with particular situa- - tions. (But there is a lot of reading!) +LATEXMK(1L) LATEXMK(1L) - The remainder of these notes consists of ideas for dealing with more - difficult situations. - d. Further tricks can involve replacing the standard commands that + d. Further tricks can involve replacing the standard commands that latexmk 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://www.ctan.org/tex-archive/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- + 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- 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 + g. 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. Or ask me (the author of latexmk). My e-mail is at the end of this + i. Or ask me (the author of latexmk). My e-mail is at the end of this documentation. - 22 April 2016 16 - - - - - -LATEXMK(1L) LATEXMK(1L) - - CONFIGURATION/INITIALIZATION (RC) FILES Latexmk can be customized using initialization files, which are read at startup in the following order: @@ -1135,121 +1213,149 @@ CONFIGURATION/INITIALIZATION (RC) FILES "/usr/local/share/latexmk/LatexMk", "/usr/local/lib/latexmk/LatexMk". On a MS-WINDOWS system it looks for "C:\latexmk\LatexMk". - On a cygwin system (i.e., a MS-Windows system in which Perl is that + On a cygwin system (i.e., a MS-Windows system in which Perl is that of cygwin), latexmk reads for 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". - 2) The user's RC file, "$HOME/.latexmkrc", if it exists. Here $HOME is - the user's home directory. [Latexmk determines the user's home direc- - tory 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 variable USER- - PROFILE is used, if it exists, which normally is the case on MS-Windows - systems. Otherwise a blank string is used instead of $HOME.] - 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 + + + 5 September 2016 18 + + + + + +LATEXMK(1L) LATEXMK(1L) + + + 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 + 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 + 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 + 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 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 + 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. - Note that command line options are obeyed in the order in which they + Note that command line options are obeyed in the order in which they are written; thus any RC file specified on the command line with the -r - option can override previous options but can be itself overridden by - later options on the command line. There is also the -e option, which + option can override previous options but can be itself overridden by + later options on the command line. There is also the -e option, which allows initialization code to be specified in latexmk's command line. - For possible examples of code for in an RC file, see the directory - example_rcfiles in the distribution of latexmk (e.g., at - http://www.ctan.org/tex-archive/support/latexmk/example_rcfiles). + For possible examples of code for in an RC file, see the directory + example_rcfiles in the distribution of latexmk (e.g., at http://mir- + ror.ctan.org/support/latexmk/example_rcfiles). HOW TO SET VARIABLES IN INITIALIZATION FILES - The important variables that can be configured are described in the - section "List of configuration variables usable in initialization + The important variables that can be configured are described in the + section "List of configuration variables usable in initialization files". Syntax for setting these variables is of the following forms: $bibtex = 'bibtex %O %B'; for the setting of a string variable, + $preview_mode = 1; - 22 April 2016 17 + 5 September 2016 19 -LATEXMK(1L) LATEXMK(1L) - $preview_mode = 1; +LATEXMK(1L) LATEXMK(1L) + 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. 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 + 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 available placeholders are: - %B base of filename for current command. E.g., if a postscript - file document.ps is being made from the dvi file document.dvi, + %B base of filename for current command. E.g., if a postscript + file document.ps is being made from the dvi file document.dvi, then the basename is document. - %D destination file (e.g., the name of the postscript file when + %D destination file (e.g., the name of the postscript file when converting a dvi file to postscript). %O options @@ -1259,7 +1365,7 @@ FORMAT OF COMMAND SPECIFICATIONS - 22 April 2016 18 + 5 September 2016 20 @@ -1268,7 +1374,7 @@ FORMAT OF COMMAND SPECIFICATIONS LATEXMK(1L) LATEXMK(1L) - %S source file (e.g., the name of the dvi file when converting a + %S source file (e.g., the name of the dvi file when converting a dvi file to ps). %T The name of the primary tex file. @@ -1279,59 +1385,57 @@ LATEXMK(1L) LATEXMK(1L) able character, with suitable characters being those appropriate to UNIX and MS-Windows, i.e., ':', '/' and '\'. - %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', + 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 + replaced by the source filename, which in this case would be the name of a postscript file to be viewed. - Appropriate quoting will be applied to the filename substitutions, so - you mustn't supply them yourself even if the names of your files have + Appropriate quoting will be applied to the filename substitutions, so + you mustn't supply them yourself even if the names of your files have spaces in them. (But if your TeX filenames have spaces in them, beware that 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 + See the default values in the section "List of configuration variables usable in initialization files" for what is normally the most appropri- ate usage. If you omit to supply any placeholders whatever in the specification of - a command, latexmk will supply what its author thinks are appropriate + a command, latexmk will supply what its author thinks are appropriate defaults. This gives compatibility with configuration files for previ- ous versions of latexmk, which didn't use placeholders. - "Detaching" a command: Normally when latexmk runs a command, it waits + "Detaching" a command: Normally when latexmk runs a command, it waits for the command to run to completion. This is appropriate for commands like latex, of course. But for previewers, the command should normally - run detached, so that latexmk gets the previewer running and then - 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 + run detached, so that latexmk gets the previewer running and then - 22 April 2016 19 + 5 September 2016 21 @@ -1340,70 +1444,68 @@ LATEXMK(1L) LATEXMK(1L) 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 $dvi_previewer = 'start xdvi %O %S'; - This will be translated to whatever is appropriate for your operating + This will be translated to whatever is appropriate for your operating system. - Notes: (1) In some circumstances, latexmk will always run a command + Notes: (1) In some circumstances, latexmk will always run a command detached. This is the case for a previewer in preview continuous mode, - since otherwise previewing continuously makes no sense. (2) This pre- - cludes the possibility of running a command named start. (3) If the - word start occurs more than once at the beginning of the command - string, that is equivalent to having just one. (4) Under cygwin, some - complications happen, since cygwin amounts to a complicated merging of - UNIX and MS-Windows. See the source code for how I've handled the + since otherwise previewing continuously makes no sense. (2) This pre- + cludes the possibility of running a command named start. (3) If the + word start occurs more than once at the beginning of the command + string, that is equivalent to having just one. (4) Under cygwin, some + complications happen, since cygwin amounts to a complicated merging of + UNIX and MS-Windows. See the source code for how I've handled the problem. Command names containing spaces: Under MS-Windows it is common that the name of a command includes spaces, since software is often installed in - a subdirectory of "C:\Program Files". Such command names should be + a subdirectory of "C:\Program Files". Such command names should be enclosed in double quotes, as in $lpr_pdf = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p %S'; $pdf_previewer = 'start "c:/Program Files/SumatraPDF/Suma- traPDF.exe" %O %S'; - $pdf_previewer = 'start "c:/Program Files/SumatraPDF (x86)/Suma- + $pdf_previewer = 'start "c:/Program Files/SumatraPDF (x86)/Suma- 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- + (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.) - Command names under Cygwin: If latexmk is executed by Cygwin's Perl, + Command names under Cygwin: If latexmk is executed by Cygwin's Perl, be particularly certain that pathnames in commands have forward slashes - not the usual backslashes for the separator of pathname components. - See the above examples. Backslashes often get misinterpreted by the + not the usual backslashes for the separator of pathname components. + See the above examples. Backslashes often get misinterpreted by the Unix shell used by Cygwin's Perl to execute external commands. Forward slashes don't suffer from this problem, and (when quoted, as above) are equally acceptable to MS-Windows. - Using MS-Windows file associations: A useful trick under modern ver- + Using MS-Windows file associations: A useful trick under modern ver- sions of MS-Windows (e.g., WinXP) is to use just the command 'start' by itself: $dvi_previewer = 'start %S'; Under recent versions of MS-Windows, this will cause to be run whatever - program the system has associated with dvi files. (The same applies + 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 + not always suitable 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 - 22 April 2016 20 + 5 September 2016 22 @@ -1412,23 +1514,27 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) + 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 + This typically is used when an appropriate command does not exist on your system. The string after the "NONE" is effectively a comment. Options to commands: Setting the name of a command can be used not only for changing the name of the command called, but also to add options to - command. Suppose you want latexmk to use latex with source specials - enabled. Then you might use the following line in an initialization + command. Suppose you want latexmk to use latex with source specials + enabled. Then you might use the following line in an initialization file: $latex = 'latex --src-specials %O %S'; - Running a subroutine instead of an external command: Use a specifica- + Running a subroutine instead of an external command: Use a specifica- tion starting with "internal", as in $latex = 'internal mylatex %O %S'; @@ -1438,44 +1544,38 @@ 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 - 22 April 2016 21 + 5 September 2016 23 @@ -1484,6 +1584,12 @@ LATEXMK(1L) LATEXMK(1L) 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. @@ -1492,75 +1598,79 @@ LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES $always_view_file_via_temporary [0] Whether ps and pdf files are initially to be made in a temporary - directory and then moved to the final location. (This applies + 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, + ators on dvi and ps files. It does not apply to pdflatex, unfortunately.) 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 + 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. See the $pvc_view_file_via_temporary variable for a setting that - applies only if preview-continuous mode (-pvc option) is used. + applies only if preview-continuous mode (-pvc option) is used. See $tmpdir for the setting of the directory where the temporary file is created. $auto_rc_use [1] - Whether to automatically read the standard initialization (rc) + Whether to automatically read the standard initialization (rc) files, which are the system RC file, the user's RC file, and the RC file in the current directory. The command line option -norc - can be used to turn this setting off. Each RC file could also - turn this setting off, i.e., it could set $auto_rc_use to zero + can be used to turn this setting off. Each RC file could also + turn this setting off, i.e., it could set $auto_rc_use to zero to prevent automatic reading of the later RC files. - This variable does not affect the reading of RC files specified + This variable does not affect the reading of RC files specified on the command line by the -r option. $aux_dir [""] The directory in which auxiliary files (aux, log, etc) are to be - written by a run of (pdf)latex. If this variable is not set, - but $out_dir is set, then $aux_dir is set to $out_dir, which is + written by a run of (pdf)latex. If this variable is not set, + but $out_dir is set, then $aux_dir is set to $out_dir, which is the directory to which general output files are to be written. - Important note: The effect of $aux_dir, if different from - $out_dir, is achieved by giving (pdf)latex the -aux-directory. - Currently (Dec. 2011 and later) this only works on the MiKTeX + Important note: The effect of $aux_dir, if different from + $out_dir, is achieved by giving (pdf)latex the -aux-directory. + Currently (Dec. 2011 and later) this only works on the MiKTeX version of (pdf)latex. See also the documentation of $out_dir for some complications on what directory names are suitable. + If you also use the -cd option, and $out_dir (or $aux_dir) - $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 + 5 September 2016 24 - 22 April 2016 22 +LATEXMK(1L) LATEXMK(1L) -LATEXMK(1L) LATEXMK(1L) + contains 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. + 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. $banner_intensity [0.95] Equivalent to the -bi option, this is a decimal number between 0 - and 1 that specifies how dark to print the banner message. 0 is + and 1 that specifies how dark to print the banner message. 0 is black, 1 is white. The default is just right if your toner car- tridge isn't running too low. @@ -1569,19 +1679,19 @@ LATEXMK(1L) LATEXMK(1L) dvi file to postscript. This is equivalent to the -bm option. $banner_scale [220.0] - A decimal number that specifies how large the banner message - will be printed. Experimentation is necessary to get the right - scale for your message, as a rule of thumb the scale should be - about equal to 1100 divided by the number of characters in the - message. The Default is just right for 5 character messages. + A decimal number that specifies how large the banner message + will be printed. Experimentation is necessary to get the right + scale for your message, as a rule of thumb the scale should be + about equal to 1100 divided by the number of characters in the + message. The Default is just right for 5 character messages. This is equivalent to the -bs option. @BIBINPUTS - This is an array variable, now mostly obsolete, that specifies - directories where latexmk should look for .bib files. By + This is an array variable, now mostly obsolete, that specifies + directories where latexmk should look for .bib files. By default it is set from the BIBINPUTS environment variable of the - operating system. If that environment variable is not set, a - single element list consisting of the current directory is set. + operating system. If that environment variable is not set, a + single element list consisting of the current directory is set. The format of the directory names depends on your operating sys- tem, of course. Examples for setting this variable are: @@ -1591,191 +1701,191 @@ LATEXMK(1L) LATEXMK(1L) @BIBINPUTS = ( ".", "//server/bibfiles" ); @BIBINPUTS = ( ".", "/usr/local/texmf/bibtex/bib" ); - Note that under MS Windows, either a forward slash "/" or a - backward slash "\" can be used to separate pathname components, - so the first two and the second two examples are equivalent. - Each backward slash should be doubled to avoid running afoul of + Note that under MS Windows, either a forward slash "/" or a + backward slash "\" can be used to separate pathname components, + so the first two and the second two examples are equivalent. + Each backward slash should be doubled to avoid running afoul of Perl's rules for writing strings. Important note: This variable is now mostly obsolete in the cur- rent version of latexmk, since it has a better method of search- - ing for files using the kpsewhich command. However, if your - system is an unusual one without the kpsewhich command, you may + ing for files using the kpsewhich command. However, if your + system is an unusual one without the kpsewhich command, you may need to set the variable @BIBINPUTS. - $biber ["biber %O %S"] - The biber processing program. - $biber_silent_switch ["--onlylog"] - Switch(es) for the biber processing program when silent mode is - on. - $bibtex ["bibtex %O %S"] - The BibTeX processing program. + 5 September 2016 25 - $bibtex_silent_switch ["-terse"] - Switch(es) for the BibTeX processing program when silent mode is - on. - 22 April 2016 23 +LATEXMK(1L) LATEXMK(1L) + $biber ["biber %O %S"] + The biber processing program. + $biber_silent_switch ["--onlylog"] + Switch(es) for the biber processing program when silent mode is + on. -LATEXMK(1L) LATEXMK(1L) + $bibtex ["bibtex %O %S"] + The BibTeX processing program. + $bibtex_silent_switch ["-terse"] + Switch(es) for the BibTeX processing program when silent mode is + 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- - ever it appears necessary to regenerate the bbl file(s) from + covers from the log file that one (or more) BibTeX/biber-gener- + ated bibliographies are used, it can run BibTeX or biber when- + ever it appears necessary to regenerate the bbl file(s) from their source bib database file(s). - But sometimes, the bib file(s) are not available (e.g., for a - document obtained from an external archive), but the bbl files - are provided. In that case use of BibTeX or biber will result - in incorrect overwriting of the precious bbl files. The vari- - able $bibtex_use controls whether this happens. Its possible + But sometimes, the bib file(s) are not available (e.g., for a + document obtained from an external archive), but the bbl files + are provided. In that case use of BibTeX or biber will result + in incorrect overwriting of the precious bbl files. The 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 - it appears necessary to update the bbl files, without testing + 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. $cleanup_includes_cusdep_generated [0] - If nonzero, specifies that cleanup also deletes files that are + If nonzero, specifies that cleanup also deletes files that are generated by custom dependencies. (When doing a clean up, e.g., by use of the -C option, custom dependencies are those listed in the .fdb_latexmk file from a previous run.) $cleanup_includes_generated [0] - If nonzero, specifies that cleanup also deletes files that are - detected in log file as being generated (see the \openout lines - in the log file). It will also include files made from these + If nonzero, specifies that cleanup also deletes files that are + detected in log file as being generated (see the \openout lines + in the log file). It will also include files made from these first generation generated files. $cleanup_mode [0] - If nonzero, specifies cleanup mode: 1 for full cleanup, 2 for - cleanup except for dvi, ps and pdf files, 3 for cleanup except - for dep and aux files. (There is also extra cleaning as speci- - fied by the $clean_ext, $clean_full_ext and @generated_exts + If nonzero, specifies cleanup mode: 1 for full cleanup, 2 for + cleanup except for dvi, ps and pdf files, 3 for cleanup except + for dep and aux files. (There is also extra cleaning as speci- + fied by the $clean_ext, $clean_full_ext and @generated_exts variables.) - This variable is equivalent to specifying one of the -c or -C - options. But there should be no need to set this variable from + This variable is equivalent to specifying one of the -c or -C + options. But there should be no need to set this variable from an RC file. $clean_ext [""] - Extra extensions of files for latexmk to remove when any of the - clean-up options (-c or -C) is selected. The value of this - variable is a string containing the extensions separated by - spaces. + 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 - 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 - $clean_ext = "out %R-blx.bib %R-figures*.log"; - in an initialization file will imply that when a clean-up opera- - tion is specified, not only is the standard set of files - deleted, but also files of the form FOO.out, FOO-blx.bib, and - %R-figures*.log, where FOO stands for the basename of the file - being processed (as in FOO.tex). + 5 September 2016 26 - $clean_full_ext [""] - Extra extensions of files for latexmk to remove when the -C - option is selected, i.e., extensions of files to remove when the - 22 April 2016 24 +LATEXMK(1L) LATEXMK(1L) + 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 + $clean_ext = "out %R-blx.bib %R-figures*.log"; -LATEXMK(1L) LATEXMK(1L) + in an initialization file will imply that when a clean-up opera- + tion is specified, not only is the standard set of files + deleted, but also files of the form FOO.out, FOO-blx.bib, and + %R-figures*.log, where FOO stands for the basename of the file + being processed (as in FOO.tex). + $clean_full_ext [""] + Extra extensions of files for latexmk to remove when the -C + option is selected, i.e., extensions of files to remove when the .dvi, etc files are to be cleaned-up. More general patterns are allowed, as for $clean_ext. - $compiling_cmd [undefined], $failure_cmd [undefined], $success_cmd + $compiling_cmd [undefined], $failure_cmd [undefined], $success_cmd [undefined] - These variables specify commands that are executed at certain - points of compilations during preview-continuous mode. One - motivation for their existance is to allow convenient visual + 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 - $compiling_cmd = "xdotool search --name \"%D\" set_window + $compiling_cmd = "xdotool search --name \"%D\" set_window --name \"%D compiling\""; - $success_cmd = "xdotool search --name \"%D\" set_window + $success_cmd = "xdotool search --name \"%D\" set_window --name \"%D OK\""; - $failure_cmd = "xdotool search --name \"%D\" set_window + $failure_cmd = "xdotool search --name \"%D\" set_window --name \"%D FAILURE\""; - These assume that the program xdotool is installed, that the - previewer is using an X-Window system for display, and that the - title of the window contains the name of the displayed file, as - it normally does. When the commands are executed, the place- - holder string %D is replaced by the name of the destination + These assume that the program xdotool is installed, that the + previewer is using an X-Window system for display, and that the + title of the window contains the name of the displayed file, as + it normally does. When the commands are executed, the place- + holder string %D is replaced by the name of the destination file, which is the previewed file. The above commands result in an appropriate string being appended to the filename in the win- dow title: " compiling", " OK", or " FAILURE". - Other placeholders that can be used are %S, %T, and %R, with %S - and %T normally being identical. These can be useful for a com- - mand changing the title of the edit window. The visual indica- - tion in a window title can useful, since the user does not have - to keep shifting attention to the (possibly hidden) compilation - window to know the status of the compilation. + Other placeholders that can be used are %S, %T, and %R, with %S - @cus_dep_list [()] - Custom dependency list -- see section on "Custom Dependencies". + 5 September 2016 27 - @default_excluded_files [()] - 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 - 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 - 22 April 2016 25 +LATEXMK(1L) LATEXMK(1L) + and %T normally being identical. These can be useful for a com- + mand changing the title of the edit window. The visual indica- + tion in a window title can useful, since the user does not have + to keep shifting attention to the (possibly hidden) compilation + window to know the status of the compilation. + @cus_dep_list [()] + Custom dependency list -- see section on "Custom Dependencies". -LATEXMK(1L) LATEXMK(1L) + @default_excluded_files [()] + 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 + 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 some or all of the others, you could do @default_files = ("*.tex"); @@ -1783,11 +1893,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. @@ -1795,16 +1905,16 @@ 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: @@ -1813,245 +1923,256 @@ LATEXMK(1L) LATEXMK(1L) @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 - 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- - tions, see the @default_excluded_files array variable. + 5 September 2016 28 - $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 - updating the Makefile to match. - $dependents_list [0] - 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 +LATEXMK(1L) LATEXMK(1L) - 22 April 2016 26 + @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 + 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- + tions, see the @default_excluded_files array variable. -LATEXMK(1L) LATEXMK(1L) + $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 + updating the Makefile to match. + $dependents_list [0] + Whether to display a list(s) of dependencies at the end of a + run. - "-", then the dependency list is set to stdout (i.e., normally + $deps_file ["-"] + Name of file to receive list(s) of dependencies at the end of a + run, to be used if $dependesnt_list is set. If the filename is + "-", then the dependency list is set to stdout (i.e., normally the screen). $do_cd [0] - Whether to change working directory to the directory specified - for the main source file before processing it. The default + Whether to change working directory to the directory specified + for the main source file before processing it. The default behavior is not to do this, which is the same as the behavior of - latex and pdflatex programs. This variable is set by the -cd + latex and pdflatex programs. This variable is set by the -cd and -cd- options on latexmk's command line. $dvi_filter [empty] - The dvi file filter to be run on the newly produced dvi file - before other processing. Equivalent to specifying the -dF + The dvi file filter to be run on the newly produced dvi file + before other processing. Equivalent to specifying the -dF option. $dvi_mode [See below for default] - If nonzero, generate a dvi version of the document. Equivalent + If nonzero, generate a dvi version of the document. Equivalent to the -dvi option. - The variable $dvi_mode defaults to 0, but if no explicit - requests are made for other types of file (postscript, pdf), - then $dvi_mode will be set to 1. In addition, if a request for - a file for which a .dvi file is a prerequisite, then $dvi_mode + The variable $dvi_mode defaults to 0, but if no explicit + requests are made for other types of file (postscript, pdf), + then $dvi_mode will be set to 1. In addition, if a request for + a file for which a .dvi file is a prerequisite, then $dvi_mode will be set to 1. $dvi_previewer ["start xdvi %O %S" under UNIX] - The command to invoke a dvi-previewer. [Default is "start" - under MS-WINDOWS; under more recent versions of Windows, this - will cause to be run whatever command the system has associated + 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 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 + Important note: Normally you will want to have a previewer run + detached, so that latexmk doesn't wait for the previewer to + + + + 5 September 2016 29 + + + + + +LATEXMK(1L) LATEXMK(1L) + + + 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 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- + of Windows, this will cause to be run whatever command the sys- tem 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. - - - - 22 April 2016 27 - - - - - -LATEXMK(1L) LATEXMK(1L) - - - 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 + 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 + The program to used as a filter to convert a .dvi file to a .ps file in landscape mode. $dvips_pdf_switch ["-P pdf"] - Switch(es) for dvips program when pdf file is to be generated + Switch(es) for dvips program when pdf file is to be generated from ps file. $dvips_silent_switch ["-q"] Switch(es) for dvips program when silent mode is on. $dvi_update_command [""] - When the dvi previewer is set to be updated by running a com- - mand, this is the command that is run. See the information for + When the dvi previewer is set to be updated by running a com- + mand, this is the command that is run. See the information for the variable $dvi_update_method for further information, and see - information on the variable $pdf_update_method for an example + information on the variable $pdf_update_method for an example + + + + 5 September 2016 30 + + + + + +LATEXMK(1L) LATEXMK(1L) + + 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 - variable $dvi_update_method. The default value is the one + The number of the signal that is sent to the dvi viewer when it + is updated by sending a signal -- see the information on the + variable $dvi_update_method. The default value is the one appropriate for xdvi on a UNIX system. $failure_cmd [undefined] See the documentation for $compiling_cmd. $fdb_ext ["fdb_latexmk"] - The extension of the file which latexmk generates to contain a - database of information on source files. You will not normally + The extension of the file which latexmk generates to contain a + database of information on source files. You will not normally need to change this. - - - - 22 April 2016 28 - - - - - -LATEXMK(1L) LATEXMK(1L) - - $force_mode [0] - If nonzero, continue processing past minor latex errors includ- + If nonzero, continue processing past minor latex errors includ- ing unrecognized cross references. Equivalent to specifying the -f option. - @generated_exts [( aux , bbl , idx , ind , lof , lot , out , toc , + @generated_exts [( aux , bbl , idx , ind , lof , lot , out , toc , $fdb_ext )] - This contains a list of extensions for files that are generated - during a LaTeX run and that are read in by LaTeX in later runs, + This contains a list of extensions for files that are generated + during a LaTeX run and that are read in by LaTeX in later runs, either directly or indirectly. - This list has two uses: (a) to set the kinds of file to be + This list has two uses: (a) to set the kinds of file to be deleted in a cleanup operation (with the -c, -C, -CA, -g and -gg - options), and (b) in the determination of whether a rerun of + options), and (b) in the determination of whether a rerun of (pdf)LaTeX is needed after a run that gives an error. (Normally, a change of a source file during a run should provoke - a rerun. This includes a file generated by LaTeX, e.g., an aux - file, that is read in on subsequent runs. But after a run that - results in an error, a new run should occur until the user has - made a change in the files. But the user may have corrected an + a rerun. This includes a file generated by LaTeX, e.g., an aux + file, that is read in on subsequent runs. But after a run that + results in an error, a new run should occur until the user has + made a change in the files. But the user may have corrected an error in a source .tex file during the run. So latexmk needs to distinguish user-generated and automatically generated files; it - determines the automatically generated files as those with + + + + 5 September 2016 31 + + + + + +LATEXMK(1L) LATEXMK(1L) + + + 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. @@ -2060,42 +2181,41 @@ LATEXMK(1L) LATEXMK(1L) $hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: '; This creates a rule for files with extension .eps about lines to - ignore. The left-hand side is a Perl idiom for setting an item - in a hash. Note that the file extension is specified without a - period. The value, on the right-hand side, is a string - - + 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 + 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- + tion" in the jargon of regular expressions). For example, - 22 April 2016 29 + $hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: + |^%%Title: '; + causes lines starting with either "^%%CreationDate: " or + "^%%Title: " to be ignored. + 5 September 2016 32 -LATEXMK(1L) LATEXMK(1L) - containing 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 "%%Cre- - ationDate: " 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- - tion" in the jargon of regular expressions). For example, - $hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: - |^%%Title: '; +LATEXMK(1L) LATEXMK(1L) - 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 + 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., @@ -2103,80 +2223,81 @@ LATEXMK(1L) LATEXMK(1L) $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 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 + See also the @BIBINPUTS variable for another way that latexmk also uses to try to locate files; it applies only in the case of .bib files. $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 + are possible lines in an initialization file: + remove_input_ext( 'latex', 'tex' ); - 22 April 2016 30 + removes the extension 'tex' from latex_input_extensions + add_input_ext( 'latex', 'asdf' ); -LATEXMK(1L) LATEXMK(1L) + 5 September 2016 33 - (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' ); - removes the extension 'tex' from latex_input_extensions - add_input_ext( 'latex', 'asdf' ); +LATEXMK(1L) LATEXMK(1L) + - add the extension 'asdf to latex_input_extensions. (Naturally + add the extension 'asdf to latex_input_extensions. (Naturally with such an extension, you should have made an appropriate cus- tom dependency for latexmk, and should also have done the appro- - priate programming in the LaTeX source file to enable the file - to be read. The standard extensions are handled by LaTeX and + priate programming in the LaTeX source file to enable the file + to be read. The standard extensions are handled by LaTeX and its graphics/graphicx packages. $latex_silent_switch ["-interaction=batchmode"] - Switch(es) for the LaTeX processing program when silent mode is + Switch(es) for the LaTeX processing program when silent mode is on. - If you use MikTeX, you may prefer the results if you configure - the options to include -c-style-errors, e.g., by the following + If you use MikTeX, you may prefer the results if you configure + the options to include -c-style-errors, e.g., by the following line in an initialization file $latex_silent_switch = "-interaction=batchmode -c-style- @@ -2186,19 +2307,19 @@ LATEXMK(1L) LATEXMK(1L) $lpr ["lpr %O %S" under UNIX/LINUX, "NONE lpr" under MS-WINDOWS] The command to print postscript files. - Under MS-Windows (unlike UNIX/LINUX), there is no standard pro- + Under MS-Windows (unlike UNIX/LINUX), there is no standard pro- gram for printing files. But there are ways you can do it. For example, if you have gsview installed, you could use it with the option "/p": $lpr = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p'; - If gsview is installed in a different directory, you will need - to make the appropriate change. Note the combination of single - and double quotes around the name. The single quotes specify - that this is a string to be assigned to the configuration vari- - able $lpr. The double quotes are part of the string passed to - the operating system to get the command obeyed; this is neces- + If gsview is installed in a different directory, you will need + to make the appropriate change. Note the combination of single + and double quotes around the name. The single quotes specify + that this is a string to be assigned to the configuration vari- + able $lpr. The double quotes are part of the string passed to + the operating system to get the command obeyed; this is neces- sary because one part of the command name ("Program Files") con- tains a space which would otherwise be misinterpreted. @@ -2208,131 +2329,130 @@ LATEXMK(1L) LATEXMK(1L) $lpr_pdf ["NONE lpr_pdf"] The printing program to print pdf files. - Under MS-Windows you could set this to use gsview, if it is + Under MS-Windows you could set this to use gsview, if it is installed, e.g., $lpr = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p'; + If gsview is installed in a different directory, you will need + to make the appropriate change. Note the double quotes around + the name: this is necessary because one part of the command name + ("Program Files") contains a space which would otherwise be mis- + interpreted. - - 22 April 2016 31 + $make ["make"] + The make processing program. + 5 September 2016 34 -LATEXMK(1L) LATEXMK(1L) - 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. +LATEXMK(1L) LATEXMK(1L) $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 + 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.) $new_viewer_always [0] - This variable applies to latexmk only in continuous-preview + This variable applies to latexmk only in continuous-preview mode. If $new_viewer_always is 0, latexmk will check for a pre- - viously running previewer on the same file, and if one is run- - ning will not start a new one. If $new_viewer_always is non- - zero, this check will be skipped, and latexmk will behave as if + viously running previewer on the same file, and if one is run- + ning will not start a new one. If $new_viewer_always is non- + zero, this check will be skipped, and latexmk will behave as if no viewer is running. $out_dir [""] - If non-blank, this variable specifies the directory in which + If non-blank, this variable specifies the directory in which output files are to be written by a run of (pdf)latex. See also the variable $aux_dir. - The effect of this variable (when non-blank) is achieved by - using the -output-directory option of (pdf)latex. This exists - in the usual current (Dec. 2011 and later) implementations of + 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 - 22 April 2016 32 + 5 September 2016 35 -LATEXMK(1L) LATEXMK(1L) - TeX, i.e., MiKTeX and TeXLive. But it may not be present in - other versions. +LATEXMK(1L) LATEXMK(1L) - If you also use the -cd option, and $out_dir (or $aux_dir) con- - tains a relative path, then the path is interpreted relative to - the document directory. - Commonly, the directory specified for output files is a subdi- - 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 + 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 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- + 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 + 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. @@ -2340,14 +2460,14 @@ LATEXMK(1L) LATEXMK(1L) $pdflatex ["pdflatex %O %S"] - The LaTeX processing program in a version that makes a pdf file + The LaTeX processing program in a version that makes a pdf file instead of a dvi file. - An example 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 + 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: @@ -2360,43 +2480,43 @@ LATEXMK(1L) LATEXMK(1L) $pdflatex = "xelatex %O %S"; $pdf_mode = 1; $postscript_mode = $dvi_mode = 0; - Another use of the same variable is to add certain options to + 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"; - 22 April 2016 33 + %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 + 5 September 2016 36 -LATEXMK(1L) LATEXMK(1L) - $pdflatex = "pdflatex --shell-escape %O %S"; +LATEXMK(1L) LATEXMK(1L) - %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 + 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 + (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: remove_input_ext( 'pdflatex', 'tex' ); @@ -2405,20 +2525,20 @@ LATEXMK(1L) LATEXMK(1L) add_input_ext( 'pdflatex', 'asdf' ); - add the extension 'asdf to pdflatex_input_extensions. (Natu- - rally with such an extension, you should have made an appropri- + 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- + 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 + Switch(es) for the pdflatex program (specified in the variable $pdflatex when silent mode is on. - If you use MikTeX, you may prefer the results if you configure - the options to include -c-style-errors, e.g., by the following + If you use MikTeX, you may prefer the results if you configure + the options to include -c-style-errors, e.g., by the following line in an initialization file $latex_silent_switch = "-interaction=batchmode -c-style- @@ -2428,20 +2548,26 @@ LATEXMK(1L) LATEXMK(1L) $pdf_previewer ["start acroread %O %S"] The command to invoke a pdf-previewer. - On MS-WINDOWS, the default is changed to "cmd /c start """; + On MS-WINDOWS, the default is changed to "cmd /c start """; under more recent versions of Windows, this will cause to be run whatever command the system has associated with .pdf files. But - this may be undesirable if this association is to acroread -- + this may be undesirable if this association is to acroread -- see the notes in the explanation of the -pvc option.] - On OS-X the default is changed to "open %S", which results in - OS-X starting up (and detaching) the viewer associated with the - file. By default, for pdf files this association is to OS-X's + On OS-X the default is changed to "open %S", which results in + OS-X starting up (and detaching) the viewer associated with the + file. By default, for pdf files this association is to OS-X's preview, which is quite satisfactory. + WARNING: Problem under MS-Windows: if acroread is used as the + pdf previewer, and it is actually viewing a pdf file, the pdf + file cannot be updated. Thus makes acroread a bad choice of + previewer if you use latexmk's previous-continuous mode (option + -pvc) under MS-windows. This problem does not occur if, for + - 22 April 2016 34 + 5 September 2016 37 @@ -2450,36 +2576,31 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - WARNING: Problem under MS-Windows: if acroread is used as the - pdf previewer, and it is actually viewing a pdf file, the pdf - file cannot be updated. Thus makes acroread a bad choice of - previewer if you use latexmk's previous-continuous mode (option - -pvc) under MS-windows. This problem does not occur if, for example, SumatraPDF or gsview is used to view pdf files. - Important note: Normally you will want to have a previewer run + Important note: Normally you will want to have a previewer run detached, so that latexmk doesn't wait for the previewer to ter- - minate before continuing its work. So normally you should pre- - fix the command by "start ", which flags to latexmk that it - should do the detaching of the previewer itself (by whatever - method is appropriate to the operating system). But sometimes + minate before continuing its work. So normally you should pre- + fix the command by "start ", which flags to latexmk that it + should do the detaching of the previewer itself (by whatever + method is appropriate to the operating system). But sometimes letting latexmk do the detaching is not appropriate (for a vari- - ety of non-trivial reasons), so you should put the "start " bit + ety of non-trivial reasons), so you should put the "start " bit in yourself, whenever it is needed. $pdf_update_command [""] - When the pdf previewer is set to be updated by running a com- - mand, this is the command that is run. See the information for + When the pdf previewer is set to be updated by running a com- + mand, this is the command that is run. See the information for the variable $pdf_update_method. $pdf_update_method [1 under UNIX, 3 under MS-Windows] - How the pdf viewer updates its display when the pdf file has - changed. See the information on the variable $dvi_update_method + How the pdf viewer updates its display when the pdf file has + changed. See the information on the variable $dvi_update_method for the codes. (Note that information needs be changed slightly - so that for the value 4, to run a command to do the update, the - command is specified by the variable $pdf_update_command, and - for the value 2, to specify update by signal, the signal is + so that for the value 4, to run a command to do the update, the + command is specified by the variable $pdf_update_command, and + for the value 2, to specify update by signal, the signal is specified by $pdf_update_signal.) Note that acroread under MS-Windows (but not UNIX) locks the pdf @@ -2492,31 +2613,35 @@ LATEXMK(1L) LATEXMK(1L) $pdf_update_method = 4; $pdf_update_command = "xpdf -remote %R -reload"; - The first setting arranges for the xpdf program to be used in - its "remote server mode", with the server name specified as the - rootname of the TeX file. The second setting arranges for + The first setting arranges for the xpdf program to be used in + its "remote server mode", with the server name specified as the + rootname of the TeX file. The second setting arranges for updating to be done in response to a command, and the third set- ting sets the update command. - $pdf_update_signal [Under UNIX: SIGHUP, which is a system-dependent + $pdf_update_signal [Under UNIX: SIGHUP, which is a system-dependent value] - The number of the signal that is sent to the pdf viewer when it - is updated by sending a signal -- see the information on the - variable $pdf_update_method. The default value is the one + The number of the signal that is sent to the pdf viewer when it + is updated by sending a signal -- see the information on the + variable $pdf_update_method. The default value is the one appropriate for gv on a UNIX system. $pid_position[1 under UNIX, -1 under MS-Windows] - The variable $pid_position is used to specify which word in - lines of the output from $pscmd corresponds to the process ID. - The first word in the line is numbered 0. The default value of + The variable $pid_position is used to specify which word in + lines of the output from $pscmd corresponds to the process ID. + The first word in the line is numbered 0. The default value of 1 (2nd word in line) is correct for Solaris 2.6 and Linux. Set- - ting the variable to -1 is used to indicate that $pscmd is not + ting 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. + Equivalent to the -ps option. + - 22 April 2016 35 + 5 September 2016 38 @@ -2525,73 +2650,72 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - $postscript_mode [0] - If nonzero, generate a postscript version of the document. - Equivalent to the -ps option. - - If some other request is made for which a postscript file is + If some other request is made for which a postscript file is needed, then $postscript_mode will be set to 1. $preview_continuous_mode [0] - If nonzero, run a previewer to view the document, and continue + If nonzero, run a previewer to view the document, and continue running latexmk to keep .dvi up-to-date. Equivalent to the -pvc - option. Which previewer is run depends on the other settings, + option. Which previewer is run depends on the other settings, see the command line options -view=, and the variable $view. $preview_mode [0] If nonzero, run a previewer to preview the document. Equivalent - to the -pv option. Which previewer is run depends on the other - settings, see the command line options -view=, and the variable + 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 + 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. $print_type = ["auto"] - Type of file to printout: possibilities are "auto", "dvi", + Type of file to printout: possibilities are "auto", "dvi", "none", "pdf", or "ps". See the option -print= for the meaning of the "auto" value. $pscmd Command used to get all the processes currently run by the user. - The -pvc option uses the command specified by the variable - $pscmd to determine if there is an already running previewer, - and to find the process ID (needed if latexmk needs to signal + The -pvc option uses the command specified by the variable + $pscmd to determine if there is an already running previewer, + and to find the process ID (needed if latexmk needs to signal the previewer about file changes). Each line of the output of this command is assumed to correspond to one process. See the $pid_position variable for how the pro- cess number is determined. - The default for pscmd is "NONE" under MS-Windows and cygwin + 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- + $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. $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 + The postscript file filter to be run on the newly produced postscript file before other processing. Equivalent to specify- ing the -pF option. $ps_previewer ["start gv %O %S", but start %O %S under MS-WINDOWS] - The command to invoke a ps-previewer. (The default under MS- - WINDOWS will cause to be run whatever command the system has + The command to invoke a ps-previewer. (The default under MS- + WINDOWS will cause to be run whatever command the system has associated with .ps files.) - Note that gv could be used with the -watch option updates its - display whenever the postscript file changes, whereas ghostview - does not. However, different versions of gv have slightly dif- - ferent ways of writing this option. You can configure this + Note that gv could be used with the -watch option updates its + display whenever the postscript file changes, whereas ghostview + does not. However, different versions of gv have slightly dif- + ferent ways of writing this option. You can configure this + variable appropriately. + + WARNING: Linux systems may have installed one (or more) versions - 22 April 2016 36 + 5 September 2016 39 @@ -2600,46 +2724,43 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - variable appropriately. - - WARNING: Linux systems may have installed one (or more) versions - of gv under different names, e.g., ggv, kghostview, etc, but + of gv under different names, e.g., ggv, kghostview, etc, but perhaps not one called gv. - Important note: Normally you will want to have a previewer run + Important note: Normally you will want to have a previewer run detached, so that latexmk doesn't wait for the previewer to ter- - minate before continuing its work. So normally you should pre- - fix the command by "start ", which flags to latexmk that it - should do the detaching of the previewer itself (by whatever - method is appropriate to the operating system). But sometimes + minate before continuing its work. So normally you should pre- + fix the command by "start ", which flags to latexmk that it + should do the detaching of the previewer itself (by whatever + method is appropriate to the operating system). But sometimes letting latexmk do the detaching is not appropriate (for a vari- - ety of non-trivial reasons), so you should put the "start " bit + ety of non-trivial reasons), so you should put the "start " bit in yourself, whenever it is needed. - $ps_previewer_landscape ["start gv -swap %O %S", but start %O %S under + $ps_previewer_landscape ["start gv -swap %O %S", but start %O %S under MS-WINDOWS] The command to invoke a ps-previewer in landscape mode. $ps_update_command [""] - When the postscript previewer is set to be updated by running a - command, this is the command that is run. See the information + When the postscript previewer is set to be updated by running a + command, this is the command that is run. See the information for the variable $ps_update_method. $ps_update_method [0 under UNIX, 1 under MS-Windows] - How the postscript viewer updates its display when the ps file - has changed. See the information on the variable - $dvi_update_method for the codes. (Note that information needs + How the postscript viewer updates its display when the ps file + has changed. See the information on the variable + $dvi_update_method for the codes. (Note that information needs be changed slightly so that for the value 4, to run a command to do the update, the command is specified by the variable - $ps_update_command, and for the value 2, to specify update by + $ps_update_command, and for the value 2, to specify update by signal, the signal is specified by $ps_update_signal.) - $ps_update_signal [Under UNIX: SIGHUP, which is a system-dependent + $ps_update_signal [Under UNIX: SIGHUP, which is a system-dependent value] - The number of the signal that is sent to the pdf viewer when it - is updated by sending a signal -- see $ps_update_method. The + The number of the signal that is sent to the pdf viewer when it + is updated by sending a signal -- see $ps_update_method. The default value is the one appropriate for gv on a UNIX system. @@ -2651,22 +2772,25 @@ 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 - 22 April 2016 37 + 5 September 2016 40 @@ -2675,101 +2799,98 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - $recorder [0] - 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- + 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 + 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 + [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.] - The default under MSWin and Cygwin is ';' and under UNIX-like - operating systems (including Linux and OS-X) is ':'. Normally - the defaults give correct behavior. But there can be difficul- - ties if your operating system is of one kind, but some of your - software is running under an emulator for the other kind of - operating system; in that case you'll need to find out what is - needed, and set $search_path_separator explicitly. (The same - goes, of course, for unusual operating systems that are not in + The default under MSWin and Cygwin is ';' and under UNIX-like + operating systems (including Linux and OS-X) is ':'. Normally + the defaults give correct behavior. But there can be difficul- + ties if your operating system is of one kind, but some of your + software is running under an emulator for the other kind of + operating system; in that case you'll need to find out what is + needed, and set $search_path_separator explicitly. (The same + goes, of course, for unusual operating systems that are not in the MSWin, Linux, OS-X, Unix collection.) $silence_logfile_warnings [0] - Whether after a run of (pdf)latex to summarize warnings in the - log file about undefined citations and references. Setting - $silence_logfile_warnings=0 gives the summary of warnings (pro- - vided silent mode isn't also set), and this is useful to locate + Whether after a run of (pdf)latex to summarize warnings in the + log file about undefined citations and references. Setting + $silence_logfile_warnings=0 gives the summary of warnings (pro- + vided silent mode isn't also set), and this is useful to locate undefined citations and references without searching through the - much more verbose log file or the screen output of (pdf)latex. - But the summary can also be excessively annoying. The default - is not to give these warnings. The command line options + much more verbose log file or the screen output of (pdf)latex. + But the summary can also be excessively annoying. The default + is not to give these warnings. The command line options -silence_logfile_warning_list and -silence_logfile_warning_list- also set this variable. - Note that multiple occurrences for the same undefined object on + Note that multiple occurrences for the same undefined object on the same page and same line will be compressed to a single warn- ing. + $silent [0] + Whether to run silently. Setting $silent to 1 has the same + effect as the -quiet of -silent options on the command line. - 22 April 2016 38 + 5 September 2016 41 -LATEXMK(1L) LATEXMK(1L) - $silent [0] - Whether to run silently. Setting $silent to 1 has the same - effect as the -quiet of -silent options on the command line. +LATEXMK(1L) LATEXMK(1L) $sleep_time [2] - The time to sleep (in seconds) between checking for source file + The time to sleep (in seconds) between checking for source file changes when running with the -pvc option. This is subject to a - minimum of one second delay, except that zero delay is also + minimum of one second delay, except that zero delay is also allowed. - A value of exactly 0 gives no delay, and typically results in + A value of exactly 0 gives no delay, and typically results in 100% CPU usage, which may not be desirable. $texfile_search [""] - This is an obsolete variable, replaced by the @default_files + This is an obsolete variable, replaced by the @default_files variable. - For backward compatibility, if you choose to set $tex- - file_search, it is a string of space-separated filenames, and + For backward compatibility, if you choose to set $tex- + file_search, it is a string of space-separated filenames, and then latexmk replaces @default_files with the filenames in $tex- file_search to which is added "*.tex". @@ -2779,45 +2900,51 @@ LATEXMK(1L) LATEXMK(1L) $tmpdir [See below for default] - Directory to store temporary files that latexmk may generate + Directory to store temporary files that latexmk may generate while running. - The default under MSWindows (including cygwin), is to set - $tmpdir to the value of the first of whichever of the system - environment variables TMPDIR or TEMP exists, otherwise to the - current directory. Under other operating systems (expected to - be UNIX/Linux, including OS-X), the default is the value of the - system environment variable TMPDIR if it exists, otherwise + The default under MSWindows (including cygwin), is to set + $tmpdir to the value of the first of whichever of the system + environment variables TMPDIR or TEMP exists, otherwise to the + current directory. Under other operating systems (expected to + be UNIX/Linux, including OS-X), the default is the value of the + system environment variable TMPDIR if it exists, otherwise "/tmp". $use_make_for_missing_files [0] Whether to use make to try and make files that are missing after - a run of latex or pdflatex, and for which a custom dependency - has not been found. This is generally useful only when latexmk - is used as part of a bigger project which is built by using the + a run of latex or pdflatex, and for which a custom dependency + has not been found. This is generally useful only when latexmk + is used as part of a bigger project which is built by using the make program. Note that once a missing file has been made, no further calls to - make will be made on a subsequent run of latexmk to update the - file. Handling this problem is the job of a suitably defined - Makefile. See the section "USING latexmk WITH make" for how to - do this. The intent of calling make from latexmk is merely to + make will be made on a subsequent run of latexmk to update the + file. Handling this problem is the job of a suitably defined + Makefile. See the section "USING latexmk WITH make" for how to + do this. The intent of calling make from latexmk is merely to detect dependencies. $view ["default"] - Which kind of file is to be previewed if a previewer is used. - The possible values are "default", "dvi", "ps", "pdf". The + Which kind of file is to be previewed if a previewer is used. + The possible values are "default", "dvi", "ps", "pdf". The value of "default" means that the "highest" of the kinds of file 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 + 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 - 22 April 2016 39 + + 5 September 2016 42 @@ -2826,13 +2953,7 @@ CUSTOM DEPENDENCIES LATEXMK(1L) LATEXMK(1L) - 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. + that allow convenient manipulations of the custom dependency list. These are add_cus_dep( fromextension, toextension, must, subroutine ) @@ -2843,43 +2964,43 @@ 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- + 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 + 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. - To make the new destination file, the Perl subroutine specified in the + To make the new destination file, the Perl subroutine specified in the rule is invoked, with an argument that is the base name of the files in - question. Simple cases just involve a subroutine invoking an external - program; this can be done by following the templates below, even by - those without knowledge of the Perl programming language. Of course, + question. Simple cases just involve a subroutine invoking an external + program; this can be done by following the templates below, even by + those without knowledge of the Perl programming language. Of course, experts could do something much more elaborate. - One other item in each custom-dependency rule labeled "must" above - specifies how the rule should be applied when the source file fails to + 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. A simple and typical example of code in an initialization rcfile is @@ -2889,11 +3010,18 @@ LATEXMK(1L) LATEXMK(1L) system( "fig2dev -Leps \"$_[0].fig\" \"$_[0].eps\"" ); } - The first line adds a custom dependency that converts a file with + The first line adds a custom dependency that converts a file with + extension "fig", as created by the xfig program, to an encapsulated + postscript file, with extension "eps". The remaining lines define a + subroutine that carries out the conversion. If a rule for converting + "fig" to "eps" files already exists (e.g., from a previously read-in + initialization file), the latexmk will delete this rule before making + the new one. + - 22 April 2016 40 + 5 September 2016 43 @@ -2902,31 +3030,24 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - extension "fig", as created by the xfig program, to an encapsulated - postscript file, with extension "eps". The remaining lines define a - subroutine that carries out the conversion. If a rule for converting - "fig" to "eps" files already exists (e.g., from a previously read-in - initialization file), the latexmk will delete this rule before making - the new one. - - Suppose latexmk is using this rule to convert a file "figure.fig" to - "figure.eps". Then it will invoke the fig2eps subroutine defined in - the above code with a single argument "figure", which is the basename - of each of the files (possibly with a path component). This argument - is referred to by Perl as $_[0]. In the example above, the subroutine + Suppose latexmk is using this rule to convert a file "figure.fig" to + "figure.eps". Then it will invoke the fig2eps subroutine defined in + the above code with a single argument "figure", which is the basename + of each of the files (possibly with a path component). This argument + is referred to by Perl as $_[0]. In the example above, the subroutine uses the Perl command system to invoke the program fig2dev. The double quotes around the string are a Perl idiom that signify that each string - of the form of a variable name, $_[0] in this case, is to be substi- + of the form of a variable name, $_[0] in this case, is to be substi- tuted by its value. - If the return value of the subroutine is non-zero, then latexmk will - assume an error occurred during the execution of the subroutine. In - the above example, no explicit return value is given, and instead the - return value is the value returned by the last (and only) statement, + If the return value of the subroutine is non-zero, then latexmk will + assume an error occurred during the execution of the subroutine. In + the above example, no explicit return value is given, and instead the + return value is the value returned by the last (and only) statement, i.e., the invocation of system, which returns the value 0 on success. - If you use pdflatex instead of latex, then you will probably prefer to - convert your graphics files to pdf format, in which case you would + If you use pdflatex instead of latex, then you will probably prefer to + convert your graphics files to pdf format, in which case you would replace the above code in an initialization file by add_cus_dep( 'fig', 'pdf, 0, 'fig2pdf' ); @@ -2934,62 +3055,63 @@ LATEXMK(1L) LATEXMK(1L) system( "fig2dev -Lpdf \"$_[0].fig\" \"$_[0].pdf\"" ); } - Note 1: In the command lines given in the system commands in the above - examples, double quotes have been inserted around the file names - (implemented by '\"' in the Perl language). They immunize the running - of the program against special characters in filenames. Very often - these quotes are not necessary, i.e., they can be omitted. But it is + Note 1: In the command lines given in the system commands in the above + examples, double quotes have been inserted around the file names + (implemented by '\"' in the Perl language). They immunize the running + of the program against special characters in filenames. Very often + these quotes are not necessary, i.e., they can be omitted. But it is normally safer to keep them in. Even though the rules for quoting vary - between operating systems, command shells and individual pieces of + between operating systems, command shells and individual pieces of software, the quotes in the above examples do not cause problems in the cases I have tested. - Note 2: One case in which the quotes are important is when the files - are in a subdirectory and your operating system is Microsoft Windows. - Then the separator character for directory components can be either a - forward slash '/' or Microsoft's more usual backward slash '\'. For- - ward slashes are generated by latexmk, to maintain its sanity from - software like MiKTeX that mixes both directory separators; but their + Note 2: One case in which the quotes are important is when the files + are in a subdirectory and your operating system is Microsoft Windows. + Then the separator character for directory components can be either a + forward slash '/' or Microsoft's more usual backward slash '\'. For- + ward slashes are generated by latexmk, to maintain its sanity from + software like MiKTeX that mixes both directory separators; but their correct use normally requires quoted filenames. (See a log file from a - run of MiKTeX (at least in v. 2.9) for an example of the use of both + run of MiKTeX (at least in v. 2.9) for an example of the use of both directory separators.) - If you have some general custom dependencies defined in the system or - user initialization file, you may find that for a particular project - they are undesirable. So you might want to delete the unneeded ones. + If you have some general custom dependencies defined in the system or + user initialization file, you may find that for a particular project + they are undesirable. So you might want to delete the unneeded ones. For example, you remove any "fig" to "eps" rule by the line remove_cus_dep( 'fig', 'eps' ); - If you have complicated sets of custom dependencies, you may want to - get a listing of the custom dependencies. This is done by using the + If you have complicated sets of custom dependencies, you may want to + get a listing of the custom dependencies. This is done by using the line show_cus_dep(); + in an initialization file. + Another example of a custom dependency overcomes a limitation of + latexmk concerning index files. The only index-file conversion built- + 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 - 22 April 2016 41 + 5 September 2016 44 -LATEXMK(1L) LATEXMK(1L) - in an initialization file. +LATEXMK(1L) LATEXMK(1L) + - Another example of a custom dependency overcomes a limitation of - latexmk concerning index files. The only index-file conversion built- - 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 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- + example if your latex file uses the command "\newindex{spe- cial}{ndx}{nnd}{Special index}" you will need to convert files with the - extension .ndx to .nnd. The following lines in an initialization RC + extension .ndx to .nnd. The following lines in an initialization RC file will cause this to happen: add_cus_dep('ndx', 'nnd', 0, 'makendx2nnd'); @@ -2997,21 +3119,21 @@ LATEXMK(1L) LATEXMK(1L) system( "makeindex -o \"$_[0].nnd\" \"$_[0].ndx\"" ); } - (You will need to modify this code if you use filenames with spaces in + (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 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 with such problems. Glossaries can be dealt with similarly. @@ -3019,16 +3141,16 @@ 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"; @@ -3036,55 +3158,56 @@ OLD METHOD OF DEFINING CUSTOM DEPENDENCIES 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 + this is what is used in the rc files. - 22 April 2016 42 + 5 September 2016 45 -LATEXMK(1L) LATEXMK(1L) -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 - this is what is used in the rc files. +LATEXMK(1L) LATEXMK(1L) + - See also the section DEALING WITH ERRORS, PROBLEMS, ETC. See also the + See also the section DEALING WITH ERRORS, PROBLEMS, ETC. See also the examples in the directory example_rcfiles in the latexmk distributions. Even if none of the examples apply to your case, they may give 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- + 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 + 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 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 @@ -3094,34 +3217,43 @@ ADVANCED CONFIGURATION: Some extra resources and advanced tricks $$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 + dependency list) for the given rule. - 22 April 2016 43 + 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 + + + + 5 September 2016 46 @@ -3130,42 +3262,49 @@ ADVANCED CONFIGURATION: Some extra resources and advanced tricks LATEXMK(1L) LATEXMK(1L) + 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. + + + 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 + The simplest method is simply to delegate all the relevant tasks to latexmk, as is suitable for a straightforward LaTeX document. For this a suitable Makefile is like @@ -3174,30 +3313,25 @@ LATEXMK(1L) LATEXMK(1L) %.pdf : %.tex FORCE_MAKE latexmk -pdf -dvi- -ps- $< - (Note: the last line must be introduced by a tab for the Makefile to - function correctly!) Naturally, if making try.pdf from its associated - LaTeX file try.tex were the only task to be performed, a direct use of - latexmk without a Makefile would normally be better. The benefit of - using a Makefile for a LaTeX document would be in a larger project, + (Note: the last line must be introduced by a tab for the Makefile to + function correctly!) Naturally, if making try.pdf from its associated + LaTeX file try.tex were the only task to be performed, a direct use of + latexmk without a Makefile would normally be better. The benefit of + using a Makefile for a LaTeX document would be in a larger project, where lines such as the above would be only be a small part of a larger Makefile. The above example has a pattern rule for making a .pdf file from a .tex - file, and it is defined to use latexmk in the obvious way. There is a + file, and it is defined to use latexmk in the obvious way. There is a conventional default target named "all", with a prerequisite of - try.pdf. So when make is invoked, by default it makes try.pdf. The - only complication is that there may be many source files beyond + try.pdf. So when make is invoked, by default it makes try.pdf. The + only complication is that there may be many source files beyond try.tex, but these aren't specified in the Makefile, so changes in them - will not by themselves cause latexmk to be invoked. Instead, the pat- - tern rule is equipped with a "phony" prerequisite FORCE_MAKE; this has - the effect of causing the rule to be always out-of-date, so that - 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 + will not by themselves cause latexmk to be invoked. Instead, the - 22 April 2016 44 + 5 September 2016 47 @@ -3206,13 +3340,18 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - of source files except for primary LaTeX file for the document. If - there are, for example, graphics files to be made, these must be made + pattern rule is equipped with a "phony" prerequisite FORCE_MAKE; this + has the effect of causing the rule to be always out-of-date, so that + latexmk is always run. It is latexmk that decides whether any action + is needed, e.g., a rerun of pdflatex. Effectively the Makefile dele- + gates all decisions to latexmk, while make has no knowledge of the list + of source files except for primary LaTeX file for the document. If + there are, for example, graphics files to be made, these must be made by custom dependencies configured in latexmk. - But something better is needed in more complicated situations, for - example, when the making of graphics files needs to be specified by - rules in the Makefile. To do this, one can use a Makefile like the + But something better is needed in more complicated situations, for + example, when the making of graphics files needs to be specified by + rules in the Makefile. To do this, one can use a Makefile like the following: TARGETS = document1.pdf document2.pdf @@ -3231,50 +3370,47 @@ 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 + 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 + 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" + Suppose in the LaTeX file there is a command \includegraphics{graph}, + and an xfig file "graph.fig" exists. On a first run, pdflatex reports + a missing file, named "graph". Latexmk succeeds in making "graph.pdf" by calling "make graph.pdf", and after completion of its work, it lists "fig.pdf" among the dependents of the file latexmk is making. Then let - "fig.fig" be updated, and then let make be run. Make first remakes + "fig.fig" be updated, and then let make be run. Make first remakes "fig.pdf", and only then reruns latexmk. - Thus we now have a method by which all the subsidiary processing is + Thus we now have a method by which all the subsidiary processing is delegated to make. 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: - 22 April 2016 45 + 5 September 2016 48 @@ -3283,35 +3419,38 @@ BUGS LATEXMK(1L) LATEXMK(1L) +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: 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.45). + Current version, by John Collins (username jcc8 at node psu.edu). + (Version 4.48). - Released version can be obtained from CTAN: <http://www.ctan.org/tex- - archive/support/latexmk/>, and from the author's website - <http://www.phys.psu.edu/~collins/software/latexmk/>. + 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) @@ -3350,7 +3489,6 @@ AUTHOR - - 22 April 2016 46 + 5 September 2016 49 diff --git a/Master/texmf-dist/scripts/latexmk/latexmk.pl b/Master/texmf-dist/scripts/latexmk/latexmk.pl index 5a9dcea8f4c..e4cde1fa815 100755 --- a/Master/texmf-dist/scripts/latexmk/latexmk.pl +++ b/Master/texmf-dist/scripts/latexmk/latexmk.pl @@ -118,8 +118,8 @@ use warnings; $my_name = 'latexmk'; $My_name = 'Latexmk'; -$version_num = '4.45'; -$version_details = "$My_name, John Collins, 22 April 2016"; +$version_num = '4.48'; +$version_details = "$My_name, John Collins, 5 Sep. 2016"; use Config; use File::Basename; @@ -192,6 +192,12 @@ else { ## ## 12 Jan 2012 STILL NEED TO DOCUMENT some items below ## +## 5 Sep 2016 John Collins Add routines: rdb_list_source, rdb_set_source +## 17 Aug 2016 John Collins Add XDG Base Directory compatibility +## for per-user rc file +## 1 May 2016 John Collins Correct creation of output and aux directories +## to correctly handle relative paths when -cd +## is used. ## 22 Apr 2016 John Collins Fix problem of -C not always working correctly ## when compilation was with -pdf and clear was default. ## (Correctly default set of rules in rdb_make_rule_list.) @@ -1529,6 +1535,16 @@ if (exists $ENV{'HOME'} ) { elsif (exists $ENV{'USERPROFILE'} ) { $HOME = $ENV{'USERPROFILE'}; } +# XDG configuration home +$XDG_CONFIG_HOME = ''; +if (exists $ENV{'XDG_CONFIG_HOME'} ) { + $XDG_CONFIG_HOME = $ENV{'XDG_CONFIG_HOME'}; +} +elsif ($HOME ne '') { + if ( -d "$HOME/.config") { + $XDG_CONFIG_HOME = "$HOME/.config"; + } +} #================================================== @@ -1569,11 +1585,18 @@ if ( $auto_rc_use ) { # System rc file: read_first_rc_file_in_list( @rc_system_files ); } -if ( $auto_rc_use && ($HOME ne "" ) ) { +if ( $auto_rc_use && ($HOME ne "" ) ) { # User rc file: + @user_rc = (); + if ( $XDG_CONFIG_HOME ) { + push @user_rc, "$XDG_CONFIG_HOME/latexmk/latexmkrc"; + } # N.B. $HOME equals "" if latexmk couldn't determine a home directory. # In that case, we shouldn't look for an rc file there. - read_first_rc_file_in_list( "$HOME/.latexmkrc" ); + if ( $HOME ) { + push @user_rc, "$HOME/.latexmkrc"; + } + read_first_rc_file_in_list( @user_rc ); } if ( $auto_rc_use ) { # Rc file in current directory: @@ -2005,40 +2028,20 @@ if ( $recorder ) { add_option( "-recorder", \$latex, \$pdflatex ); } -# If the output and/or aux directories are specified: Fix the (pdf)latex -# commands to use them, and ensure that the directories exist. -# N.B. We are immune against cd'ing to directory of TeX file, because in -# that case we have forced the directories to be absolute. +# If the output and/or aux directories are specified, fix the (pdf)latex +# commands to use them. +# N.B. We'll ensure that the directories actually exist only after a +# possible cd to the document directory, since the directories can be +# relative to the document. if ( $out_dir ) { add_option( "-output-directory=\"$out_dir\"", \$latex, \$pdflatex ); - if ( ! -e $out_dir ) { - warn "$My_name: making output directory '$out_dir'\n" - if ! $silent; - make_path $out_dir; - } - elsif ( ! -d $out_dir ) { - warn "$My_name: you requested output directory '$out_dir',\n", - " but an ordinary file of the same name exists, which will\n", - " probably give an error later\n"; - } } - 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 ); - if ( ! -e $aux_dir ) { - warn "$My_name: making auxiliary directory '$aux_dir'\n" - if ! $silent; - make_path $aux_dir; - } - elsif ( ! -d $aux_dir ) { - warn "$My_name: you requested aux directory '$aux_dir',\n", - " but an ordinary file of the same name exists, which will\n", - " probably give an error later\n"; - } } if ( $jobname ne '' ) { @@ -2199,6 +2202,35 @@ foreach $filename ( @file_list ) $path = ''; } + # Ensure the output/auxiliary directories exist, if need be + if ( $out_dir ) { + if ( ! -e $out_dir ) { + warn "$My_name: making output directory '$out_dir'\n" + if ! $silent; + make_path $out_dir; + } + elsif ( ! -d $out_dir ) { + warn "$My_name: you requested output directory '$out_dir',\n", + " but an ordinary file of the same name exists, which will\n", + " probably give an error later\n"; + } + } + + 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. + if ( ! -e $aux_dir ) { + warn "$My_name: making auxiliary directory '$aux_dir'\n" + if ! $silent; + make_path $aux_dir; + } + elsif ( ! -d $aux_dir ) { + warn "$My_name: you requested aux directory '$aux_dir',\n", + " but an ordinary file of the same name exists, which will\n", + " probably give an error later\n"; + } + } ## remove extension from filename if was given. if ( &find_basename($filename, $root_filename, $texfile_name) ) @@ -7503,7 +7535,7 @@ sub rdb_ensure_file { #************************************************************ sub rdb_remove_files { - # rdb_remove_file( rule, file,... ) + # rdb_remove_file( rule, file, ... ) # Removes file(s) for the rule. my $rule = shift; if (!$rule) { return; } @@ -7515,6 +7547,36 @@ sub rdb_remove_files { #************************************************************ +sub rdb_list_source { + # rdb_list_source( rule ) + # Return array of source files for rule. + my $rule = shift; + my @files = (); + rdb_one_rule( $rule, + sub{ @files = keys %$PHsource; } + ); + return @files; +} #END rdb_list_source + +#************************************************************ + +sub rdb_set_source { + # rdb_set_source( rule, file, ... ) + my $rule = shift; + if (!$rule) { return; } + my %files = (); + foreach (@_) { + rdb_ensure_file( $rule, $_ ); + $files{$_} = 1; + } + foreach ( rdb_list_source($rule) ) { + if ( ! exists $files{$_} ) { rdb_remove_files( $rule, $_ ); } + } + return; +} #END rdb_list_source + +#************************************************************ + sub rdb_rule_exists { # Call rdb_rule_exists($rule): Returns whether rule exists. my $rule = shift; diff --git a/Master/texmf-dist/source/support/latexmk/latexmk.bat b/Master/texmf-dist/source/support/latexmk/latexmk.bat index f119082adac..48e01d6e5e1 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 |