diff options
| author | Karl Berry <karl@freefriends.org> | 2012-04-04 22:43:24 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2012-04-04 22:43:24 +0000 |
| commit | 5f3950815dfad0d88a06e78f9137feba0ae4b298 (patch) | |
| tree | 134f753c1288f377a0b115f63625559dc5c312a6 /Master/texmf-dist/doc/support/latexmk | |
| parent | 4b1003ab17656e2084d2a2cc6e3d84d265494202 (diff) | |
latexmk 4.31 (4apr12)
git-svn-id: svn://tug.org/texlive/trunk@25851 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support/latexmk')
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/CHANGES | 42 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/INSTALL | 2 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/README | 19 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/example_rcfiles/Sweave_latexmkrc | 57 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/example_rcfiles/xelatex_latexmkrc | 17 | ||||
| -rwxr-xr-x | Master/texmf-dist/doc/support/latexmk/latexmk.bat | 5 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/latexmk.pdf | bin | 104938 -> 117848 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/latexmk.txt | 1745 |
8 files changed, 1141 insertions, 746 deletions
diff --git a/Master/texmf-dist/doc/support/latexmk/CHANGES b/Master/texmf-dist/doc/support/latexmk/CHANGES index 5d8952a7e71..a10034a4616 100644 --- a/Master/texmf-dist/doc/support/latexmk/CHANGES +++ b/Master/texmf-dist/doc/support/latexmk/CHANGES @@ -313,3 +313,45 @@ From v. 4.29a to 4.30a -aux-directory options should work on MSWin systems. Documentation of $search_path_separator variable. +From v. 4.30a to 4.31 + Add -M -MP and -MF options, like gcc. + Recorder option is now on by default. + Add options reproducing most options of (pdf)latex (list from both + TeXLive and MikTeX versions). + Options NOT implemented by latexmk at all: + -ini and -initialize since they refer to operations + not supported by latexmk + -includedirectory=dir its support needs extra code in + latexmk, not currently written + Options differently processed by latexmk: + -help + -version + -quiet + Options that are passed to (pdf)latex but that also have special + processing by latexmk + -aux-directory=dir + -output-directory=dir + -recorder + Add -latexoption=... option to latexmk + Add -xelatex option for use of xelatex + Change OS-X default for pdf previewer command to open + Command specification string can start with "include routine" to + invoke a Perl subroutine instead of an external cmd. + Viewers are detached by default. (The start keyword is now normally + superfluous in command specifications.) + Keyword nostart added in command specification. + Add configuration variables $compiling_cmd, $success_cmd, + $failure_cmd. These specify external commands (if any) to be + executed during latexmk's continuous preview mode at the + following points: $compiling_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. They + can be used, for example, to show the progress of compilation by + setting the titles of editor and/or previewer windows. + If aux and/or output directories are specified but don't exist, + make them. + Remove excessive repetition of tests for changes of source files + (improves performance of latexmk in some situations). + Documentation improvements. + Minor bug corrections. + diff --git a/Master/texmf-dist/doc/support/latexmk/INSTALL b/Master/texmf-dist/doc/support/latexmk/INSTALL index ab2a0147194..57590715fa6 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.30, 9 December 2011) + (Version 4.31, 30 March 2012) John Collins Physics Department diff --git a/Master/texmf-dist/doc/support/latexmk/README b/Master/texmf-dist/doc/support/latexmk/README index 7c538ad51ff..f019652da8d 100644 --- a/Master/texmf-dist/doc/support/latexmk/README +++ b/Master/texmf-dist/doc/support/latexmk/README @@ -1,5 +1,5 @@ -Latexmk, version 4.30, 9 December 2011 --------------------------------------- +Latexmk, version 4.31, 30 March 2012 +------------------------------------ Latexmk completely automates the process of generating a LaTeX document. Essentially, it is a highly specialized cousin of the @@ -92,7 +92,8 @@ NOTES:- John Collins ---------------------------- "latexmk -h" ---------------------------- -Latexmk 4.30a: Automatic LaTeX document generation routine +===========I am /usr/local/lib/latexmk/LatexMk +Latexmk 4.31: Automatic LaTeX document generation routine Usage: latexmk [latexmk_options] [filename ...] @@ -143,6 +144,10 @@ Usage: latexmk [latexmk_options] [filename ...] -l- - turn off -l -latex=<program> - set program used for latex. (replace '<program>' by the program name) + -latexoption=<option> - add the given option to the (pdf)latex command + -M - Show list of dependent files after processing + -MF file - Specifies name of file to receives list dependent files + -MP - List of dependent files includes phony target for each source file. -new-viewer - in -pvc mode, always start a new viewer -new-viewer- - in -pvc mode, start a new viewer only if needed -nobibtex - never use bibtex @@ -179,6 +184,8 @@ Usage: latexmk [latexmk_options] [filename ...] -recorder- - Do not use -recorder option for (pdf)latex -rules - Show list of rules after processing -rules- - Do not show list of rules after processing + -showextraoptions - Show other allowed options that are simply passed + as is to latex and pdflatex -silent - silence progress messages from called programs -time - show CPU time used -time- - don't show CPU time used @@ -192,9 +199,15 @@ Usage: latexmk [latexmk_options] [filename ...] -view=none - no viewer is used -view=ps - viewer is for ps -view=pdf - viewer is for pdf + -xelatex - use xelatex for processing files to pdf + filename = the root filename of LaTeX document -p, -pv and -pvc are mutually exclusive -h, -c and -C override all other options. -pv and -pvc require one and only one filename specified All options can be introduced by '-' or '--'. (E.g., --help or -help.) + +In addition, latexmk recognizes many other options that are passed to +latex and/or pdflatex without interpretation by latexmk. Run latexmk +with the option -showextraoptions to see a list of these diff --git a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/Sweave_latexmkrc b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/Sweave_latexmkrc new file mode 100644 index 00000000000..19f046be6be --- /dev/null +++ b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/Sweave_latexmkrc @@ -0,0 +1,57 @@ +# This is to allow the use of Sweave with latexmk, and in addition to +# make synctex work properly with it. +# SEE THE IMPORTANT NOTES below. +# +# Sweave (http://www.stat.uni-muenchen.de/~leisch/Sweave/) is a tool +# that allows to embed the R code for complete data analyses in latex +# documents. The user edits a file with an extension like .Rnw, and +# the .tex file is generated from this. +# +# Four problems are solved by the code below: +# 1. Generate the .tex file automatically. +# 2. Arrange not to re-run unmodified chunks of R code. (A pure +# optimization.) +# 3. Fix the execution environment for (pdf)latex. +# 4. Deal with synctex: If the user wants to use synctex +# (www.tug.org/TUGboat/tb29-3/tb93laurens.pdf) to synchronize the +# pdf file with the source file, by default synctex does the +# synchronization with the generated .tex file, not the original +# source file. Postprocessing of the .synctex.gz file is necessary +# to fix this. +# +# The following version was worked out and tested by a user (thanks +# to Brian Beitzel) on MSWindows. It will need at least one change to +# work on UNIX-like operating systems (which include Linux and OS-X). + +# N.B. ===> IMPORTANT NOTES <=== +# +# 1. The patchDVI package for R needs to be installed from R-Forge, as +# follows: +# +# install.packages("patchDVI", repos="http://R-Forge.R-project.org") +# +# 2. In all Sweave (.Rnw) documents, the following lines must be included: +# +# \usepackage{Sweave} +# \SweaveOpts{concordance=TRUE} + + +# Fix the pdflatex command to run Sweave first, and to postprocess the +# .synctex.gz file: +# !!!!! THIS IS THE VERSION FOR MS-WINDOWS, with && as a command +# separator +$pdflatex = "cmd /c " + . "Rscript -e \"library(cacheSweave); setCacheDir(getwd()); " + . "Sweave('%S', driver=cacheSweaveDriver)\"" + . " && R CMD pdflatex -interaction=nonstopmode -synctex=1 %O %B.tex" + . " && Rscript -e " + . "\"library('patchDVI');patchSynctex('%B.synctex.gz')\""; +# +# !!!TO FIX THIS FOR Linux/OS-X/UNIX, try uncommenting the following: +# (this version hasn't been tested). +#$pdflatex = "Rscript -e \"library(cacheSweave); setCacheDir(getwd()); " +# . "Sweave('%S', driver=cacheSweaveDriver)\"" +# . " ; R CMD pdflatex -interaction=nonstopmode -synctex=1 %O %B.tex" +# . " ; Rscript -e " +# . "\"library('patchDVI');patchSynctex('%B.synctex.gz')\""; + diff --git a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/xelatex_latexmkrc b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/xelatex_latexmkrc new file mode 100644 index 00000000000..c9f3a7fc8bd --- /dev/null +++ b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/xelatex_latexmkrc @@ -0,0 +1,17 @@ +# This shows how to use xelatex (http://en.wikipedia.org/wiki/XeTeX) +# with latexmk. Xelatex uses Unicode and "supporting modern font +# technologies such as OpenType or Apple Advanced Typography. +# +# Since xelatex only produces pdf files, it is a replacement for +# pdflatex. To make it your default typesetting engine within latexmk +# you will not only need to set the $pdflatex variable to require the +# use of xelatex, but also to turn on production of pdf files and to +# turn off the production of dvi and ps files, as in the following +# code: + + +$pdflatex = 'xelatex %O %S'; +$pdf_mode = 1; +$postscript_mode = $dvi_mode = 0; + + diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.bat b/Master/texmf-dist/doc/support/latexmk/latexmk.bat deleted file mode 100755 index 48e01d6e5e1..00000000000 --- a/Master/texmf-dist/doc/support/latexmk/latexmk.bat +++ /dev/null @@ -1,5 +0,0 @@ -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 diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.pdf b/Master/texmf-dist/doc/support/latexmk/latexmk.pdf Binary files differindex 577b9f417b2..f400ae5a157 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 921658628de..3e57500efa6 100644 --- a/Master/texmf-dist/doc/support/latexmk/latexmk.txt +++ b/Master/texmf-dist/doc/support/latexmk/latexmk.txt @@ -1,4 +1,9 @@ + + +LATEXMK(1L) LATEXMK(1L) + + NAME latexmk - generate LaTeX document @@ -53,15 +58,10 @@ DESCRIPTION ply edit a file and, when the changes are written to disk, latexmk com- pletely automates the cycle of updating the .dvi (and possibly the .ps and .pdf) file, and refreshing the previewer's display. It's not quite - WYSIWYG, but usefully close. - For other previewers, the user may have to manually make the previewer - update its display, which can be (some versions of xdvi and gsview) as - simple as forcing a redraw of its display. - - 1 + 30 March 2012 1 @@ -70,10 +70,22 @@ DESCRIPTION LATEXMK(1L) LATEXMK(1L) + WYSIWYG, but usefully close. + + For other previewers, the user may have to manually make the previewer + update its display, which can be (some versions of xdvi and gsview) as + simple as forcing a redraw of its display. + Latexmk has the ability to print a banner in gray diagonally across each page when making the postscript file. It can also, if needed, - call an external program to do other postprocessing on the generated - files. + call an external program to do other postprocessing on generated dvi + and postscript files. (See the options -dF and -pF, and the documenta- + tion for the $dvi_filter and $ps_filter configuration variables.) + These capabilities are leftover from older versions of latexmk. More + flexibility can be obtained in current versions, since the command + strings for running latex, pdflatex, etc can now be configured to run + multiple commands. This also extends the possibility of postprocessing + generated files to pdf files. files. Latexmk is highly configurable, both from the command line and in con- figuration files, so that it can accommodate a wide variety of user @@ -113,31 +125,32 @@ LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE latexmk foo - then latexmk will operate on the file "foo.tex". - -auxdir=FOO or -aux-directory=FOO + 30 March 2012 2 - 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 - 9 December 2011 2 +LATEXMK(1L) LATEXMK(1L) + then latexmk will operate on the file "foo.tex". -LATEXMK(1L) LATEXMK(1L) + -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 + on the MiKTeX version of (pdf)latex. + See also the -outdir/-output-directory options, and the $aux_dir, $out_dir, and $search_path_separator configuration - variables of latexmk. + variables of latexmk. In particular, see the documentation of + $out_dir for some complications on what directory names are + suitable. @@ -176,31 +189,32 @@ LATEXMK(1L) LATEXMK(1L) 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 - spaces and such. - 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 - 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. + 30 March 2012 3 + - 9 December 2011 3 +LATEXMK(1L) LATEXMK(1L) + -bm <message> + A banner message to print diagonally across each page when con- + verting the dvi file to postscript. The message must be a sin- + gle argument on the command line so be careful with quoting spa- + ces and such. -LATEXMK(1L) LATEXMK(1L) + 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 + 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 @@ -242,6 +256,18 @@ LATEXMK(1L) LATEXMK(1L) 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- + + + + 30 March 2012 4 + + + + + +LATEXMK(1L) LATEXMK(1L) + + regeneratable. If $cleanup_includes_cusdep_generated is nonzero, regeneratable @@ -257,18 +283,6 @@ LATEXMK(1L) LATEXMK(1L) -d Set draft mode. This prints the banner message "DRAFT" across your page when converting the dvi file to postscript. Size and - - - - 9 December 2011 4 - - - - - -LATEXMK(1L) LATEXMK(1L) - - intensity can be modified with the -bs and -bi options. The -bm option will override this option as this is really just a short way of specifying: @@ -294,128 +308,129 @@ LATEXMK(1L) LATEXMK(1L) Users familiar with GNU automake and gcc will find that the -deps option is very similar in its purpose and results to the - -M option to gcc. + -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 + -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 - the output is sent to stdout. + Set the filename to which the list of dependent files is - 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 - file. - Example usage: To use dviselect to select only the even pages of - the dvi file: + 30 March 2012 5 - latexmk -dF 'dviselect even' foo.tex - 9 December 2011 5 +LATEXMK(1L) LATEXMK(1L) + 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. + -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. -LATEXMK(1L) LATEXMK(1L) + Example usage: To use dviselect to select only the even pages of + the dvi file: + latexmk -dF 'dviselect even' foo.tex -diagnostics - Print detailed diagnostics during a run. This may help for + 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. - -dvi- Turn off generation of dvi version of document. (This may get - overridden, if some other file is made (e.g., a .ps file) that - is generated from the dvi file, or if no generated file at all + -dvi- Turn off generation of dvi version of document. (This may get + overridden, if some other file is made (e.g., a .ps file) that + is generated from the dvi file, or if no generated file at all is requested.) -e <code> - Execute the specified initialization code before processing. - The code is Perl code of the same form as is used in latexmk's + 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- + 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 + The code is executed when the -e option is encountered during + latexmk's parsing of its command line. See the -r option for a + way of executing initialization code from a file. An error + results in latexmk stopping. Multiple instances of the -r and + -e options can be used, and they are executed in the order they appear on the command line. Some care is needed to deal with proper quoting of special char- - acters in the code on the command line. For example, suppose - you want to set the latex command to use its -shell-escape + 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 - operating-system.) + 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 - 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 - or + 30 March 2012 6 - latexmk -e "$latex='latex %O -shell-escape %S'" file.tex - The last two examples will NOT work with UNIX/LINUX command - shells. +LATEXMK(1L) LATEXMK(1L) - 9 December 2011 6 + 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 + command shells you could use + latexmk -e "$latex=q/latex %O -shell-escape %S/" file.tex + or -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 + 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. -f- Turn off the forced processing-past-errors such as is set by the - -f option. This could be used to override a setting in a con- + -f option. This could be used to override a setting in a con- figuration file. - -g Force latexmk to process document fully, even under situations - where latexmk would normally decide that no changes in the - source files have occurred since the previous run. This option - is useful, for example, if you change some options and wish to + -g Force latexmk to process document fully, even under situations + where latexmk would normally decide that no changes in the + source files have occurred since the previous run. This option + is useful, for example, if you change some options and wish to reprocess the files. -g- Turn off -g. @@ -427,49 +442,60 @@ LATEXMK(1L) LATEXMK(1L) Print help information. -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., latex -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 - else). - To set the command for running pdflatex (rather than the command - for latex) see the -pdflatex option. - Note that the effect of this option can also be achieved by - using the -e option with a suitable line of Perl code to set the - $latex variable. See the explanation of the -e option. + 30 March 2012 7 - -new-viewer - When in continuous-preview mode, always start a new viewer to - view the generated file. By default, latexmk will, in continu- - ous-preview mode, test for a previously running previewer for - the same file and not start a new one if a previous previewer is - 9 December 2011 7 +LATEXMK(1L) LATEXMK(1L) + 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. -LATEXMK(1L) LATEXMK(1L) + 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. + + -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 + 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 + 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 + 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 @@ -494,6 +520,18 @@ LATEXMK(1L) LATEXMK(1L) N.B. Normally the initialization files are read and obeyed, and then command line options are obeyed in the order they are + + + + 30 March 2012 8 + + + + + +LATEXMK(1L) LATEXMK(1L) + + encountered. Then -norc is an exception to this rule: it is acted on first, no matter where is occurs on the command line. @@ -508,42 +546,32 @@ LATEXMK(1L) LATEXMK(1L) See also the -auxdir/-aux-directory options, and the $aux_dir, $out_dir, and $search_path_separator configuration variables of - latexmk. + latexmk. In particular, see the documentation of $out_dir for + some complications on what directory names are suitable. - -p Print out the document. By default it is the generated - postscript file that is printed. But you can use the -print=... - option to print the dvi or pdf files instead, and you can con- + -p Print out the document. By default it is the generated post- + script file that is printed. But you can use the -print=... + option to print the dvi or pdf files instead, and you can con- figure this in a start up file (by setting the $print_type vari- able). - However, printing is enabled by default only under UNIX/LINUX - systems, where the default is to use the lpr command. In gen- - eral, 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, and you must have con- - figured the print commands used by latexmk. This can be non- - trivial. See the documentation on the $lpr, $lpr_dvi, and - - - - 9 December 2011 8 - - - - - -LATEXMK(1L) LATEXMK(1L) - - - $lpr_pdf configuration variables to see how to set the commands + However, printing is enabled by default only under UNIX/LINUX + systems, where the default is to use the lpr command. In gen- + eral, 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, and you must have con- + figured the print commands used by latexmk. 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. This option is incompatible with the -pv and -pvc options, so it turns them off. - -pdf Generate pdf version of document using pdflatex. + -pdf Generate pdf version of document using pdflatex. (See the + -xelatex if you wish to use xelatex to make your pdf file(s).) -pdfdvi Generate pdf version of document from the dvi file, by default @@ -557,6 +585,19 @@ LATEXMK(1L) LATEXMK(1L) overridden if some other option requires the generation of a pdf file.) + + + + + 30 March 2012 9 + + + + + +LATEXMK(1L) LATEXMK(1L) + + -pdflatex='command' This sets the string specifying the command to run pdflatex, and is typically used to add desired options. Since the string nor- @@ -592,18 +633,6 @@ LATEXMK(1L) LATEXMK(1L) -pF Postscript file filtering. The argument to this option is a filter which will generate a filtered postscript file with the - - - - 9 December 2011 9 - - - - - -LATEXMK(1L) LATEXMK(1L) - - extension ".psF". All extra processing (e.g. preview, printing) will then be performed on this filtered postscript file. @@ -623,6 +652,18 @@ LATEXMK(1L) LATEXMK(1L) 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 + + + + 30 March 2012 10 + + + + + +LATEXMK(1L) LATEXMK(1L) + + (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. @@ -659,18 +700,6 @@ LATEXMK(1L) LATEXMK(1L) There are some other methods for arranging an update, notably useful for many versions of xdvi and xpdf. These are best set - - - - 9 December 2011 10 - - - - - -LATEXMK(1L) LATEXMK(1L) - - in latexmk's configuration; see below. Note that if latexmk dies or is stopped by the user, the @@ -689,6 +718,18 @@ LATEXMK(1L) LATEXMK(1L) Read the specified initialization file ("RC file") before pro- cessing. + + + + 30 March 2012 11 + + + + + +LATEXMK(1L) LATEXMK(1L) + + 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 @@ -725,55 +766,56 @@ LATEXMK(1L) LATEXMK(1L) -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.) + -silent + Run commands silently, i.e., with options that reduce the amount + of diagnostics generated. For example, with the default set- + tings, the command "latex -interaction=batchmode" is used for + latex. + Also reduce the number of informational messages that latexmk + generates. - 9 December 2011 11 + To change the options used to make the commands run silently, + you need to configure latexmk with changed values of its config- + uration variables, the relevant ones being $bib- + tex_silent_switch, $biber_silent_switch, $dvips_silent_switch, + $latex_silent_switch, and $pdflatex_silent_switch. + 30 March 2012 12 -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 - latex. - Also reduce the number of informational messages that latexmk - generates. - To change the options used to make the commands run silently, - you need to configure latexmk with changed values of its config- - uration variables, the relevant ones being $bib- - tex_silent_switch, $biber_silent_switch, $dvips_silent_switch, - $latex_silent_switch, and $pdflatex_silent_switch. +LATEXMK(1L) LATEXMK(1L) + -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.) -v, -version @@ -787,18 +829,31 @@ LATEXMK(1L) LATEXMK(1L) the -pv or -pvc switches). The default is to view the "highest" kind of requested file (in the order dvi, ps, pdf). - 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 + -xelatex + Use xelatex. That is, use xelatex to process the source file(s) + to pdf (in place of pdflatex). This option is exactly equiva- + lent to specifying the following sequence of options: + + -pdflatex="xelatex %O %S" -pdf -dvi- -ps + + + 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. +EXAMPLES + % latexmk thesis # run latex enough times to resolve + cross-references + + % latexmk -pvc -ps thesis# run latex enough times to resolve - 9 December 2011 12 + 30 March 2012 13 @@ -807,11 +862,6 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) -EXAMPLES - % latexmk thesis # run latex enough times to resolve - cross-references - - % latexmk -pvc -ps thesis# run latex enough times to resolve cross-references, make a postscript file, start a previewer. Then watch for changes in the source @@ -839,34 +889,37 @@ 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 of cygwin), latexmk reads for the first it finds of + 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". 2) The user's RC file, "$HOME/.latexmkrc", if it exists. Here $HOME is - the value of the environment variable HOME. On UNIX and clones - (including LINUX), this variable is set by the system; on MS-Windows, - the user may choose to set 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 + 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 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. - 9 December 2011 13 + 30 March 2012 14 @@ -875,20 +928,20 @@ CONFIGURATION/INITIALIZATION (RC) FILES LATEXMK(1L) LATEXMK(1L) - 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 + For possible examples of code for in an RC file, see the directory + example_rcfiles in the distribution of latexmk (e.g., at http://ctan.tug.org/tex-archive/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'; @@ -901,40 +954,38 @@ HOW TO SET VARIABLES IN INITIALIZATION FILES @default_files = ('paper', 'paper1'); - for the setting of an array of strings. It is possible to append an + for the setting of an array of strings. It is possible to append an item to an array variable as follows: push @default_files, 'paper2'; - Note that simple "scalar" variables have names that begin with a $ + Note that simple "scalar" variables have names that begin with a $ character and array variables have names that begin with a @ character. Each statement ends with a semicolon. - Strings should be enclosed in single quotes. (You could use double - quotes, as in many programming languages. But then the Perl program- - ming language brings into play some special rules for interpolating - variables into strings. People not fluent in Perl will want to avoid + Strings should be enclosed in single quotes. (You could use double + quotes, as in many programming languages. But then the Perl program- + ming language brings into play some special rules for interpolating + variables into strings. People not fluent in Perl will want to avoid these complications.) - You can do much more complicated things, but for this you will need to + You can do much more complicated things, but for this you will need to consult a manual for the Perl programming language. FORMAT OF COMMAND SPECIFICATIONS - Some of the variables set the commands that latexmk uses for carrying - out its work, for example to generate a dvi file from a tex file or to + Some of the variables set the commands that latexmk uses for carrying + out its work, for example to generate a dvi file from a tex file or to view a postscript file. This section describes some important features of how the commands are specified. 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 - 9 December 2011 14 + 30 March 2012 15 @@ -943,66 +994,64 @@ FORMAT OF COMMAND SPECIFICATIONS LATEXMK(1L) LATEXMK(1L) + 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 %R root filename. This is the base name for the main tex file. - %S source file (e.g., the name of the dvi file when converting a + %S source file (e.g., the name of the dvi file when converting a dvi file to ps). %T The name of the primary tex file. %Y Name of directory for aux- - iliary output files (see the configuration variable $aux_dir). - A directory separation character ('/') is appended if $aux_dir - is non-empty and does not end in a suitable character, with - suitable characters being those appropriate to UNIX and MS-Win- - dows, i.e., ':', '/' and '\'. %Z Name of directory for output - files (see the configuration variable $out_dir). A directory - separation character ('/') is appended if $out_dir is non-empty - and does not end in a suitable character, with suitable charac- - ters being those appropriate to UNIX and MS-Windows, i.e., ':', + iliary output files (see the configuration variable $aux_dir). + A directory separation character ('/') is appended if $aux_dir + is non-empty and does not end in a suitable character, with + suitable characters being those appropriate to UNIX and MS-Win- + dows, i.e., ':', '/' and '\'. %Z Name of directory for output + files (see the configuration variable $out_dir). A directory + separation character ('/') is appended if $out_dir is non-empty + and does not end in a suitable character, with suitable charac- + ters 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 you the names of your 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 - variable $quote_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 - 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 - - 9 December 2011 15 + 30 March 2012 16 @@ -1011,16 +1060,20 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) + variable $quote_filenames. + + The distinction between %B and %R needs a bit of care, since they are + often the same, but not always. For example on a simple document, the basename of a bibtex run is the same as for the texfile. But in a doc- - ument with several bibliographies, the bibliography files will have a - variety of names. Since bibtex is invoked with the basename of the - bibliography file, the setting for the bibtex command should therefore + ument with several bibliographies, the bibliography files will have a + variety of names. Since bibtex is invoked with the basename of the + bibliography file, the setting for the bibtex command should therefore be $bibtex = 'bibtex %O %B'; - Generally, you should use %B rather than %R. Similarly for most pur- - poses, the name %T of the primary texfile is not a useful placeholder. + Generally, you should use %B rather than %R. Similarly for most pur- + poses, the name %T of the primary texfile is not a useful placeholder. See the default values in the section "List of configuration variables usable in initialization files" for what is normally the most appropri- @@ -1061,22 +1114,22 @@ LATEXMK(1L) LATEXMK(1L) $lpr_pdf = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p %S'; - $pdf_previewer = 'start "c:/Program Files/SumatraPDF/Suma- - traPDF.exe" %O %S'; - $pdf_previewer = 'start "c:/Program Files/SumatraPDF (x86)/Suma- - traPDF.exe" %O %S'; + 30 March 2012 17 - 9 December 2011 16 +LATEXMK(1L) LATEXMK(1L) -LATEXMK(1L) LATEXMK(1L) + $pdf_previewer = 'start "c:/Program Files/SumatraPDF/Suma- + traPDF.exe" %O %S'; + $pdf_previewer = 'start "c:/Program Files/SumatraPDF (x86)/Suma- + traPDF.exe" %O %S'; (Note about the above example: Forward slashes are equivalent to back- @@ -1124,21 +1177,13 @@ LATEXMK(1L) LATEXMK(1L) $latex = 'latex --src-specials %O %S'; + Running a subroutine instead of an external command: Use a specifica- + tion starting with "internal", as in - 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. - - 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 - extra processing, you could do something like: - 9 December 2011 17 + 30 March 2012 18 @@ -1147,13 +1192,40 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - $pdflatex = 'pdflatex --shell-escape %O %S; pst2pdf_for_latexmk + $latex = 'internal mylatex %O %S'; + sub mylatex { + my @args = @_; + # Possible preprocessing here + return system 'latex', @args; + } + + 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. + + 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 + extra processing, you could do something like: + + $pdflatex = 'pdflatex --shell-escape %O %S; pst2pdf_for_latexmk %B'; - This definition assumes you are using a UNIX-like system, so that the - two commands to be run are separated by the semicolon in the middle of - the string. + This definition assumes you are using a UNIX-like system (which + includes Linux and OS-X), so that the two commands to be run are sepa- + rated by the semicolon in the middle of the string. + + If you are using MS-Windows, you would replace the above line by + + $pdflatex = 'cmd /c pdflatex --shell-escape %O %S' + . '&& pst2pdf_for_latexmk %B'; + Here, the UNIX command separator ; is replaced by &&. In addition, + there is a problem that some versions of Perl on MS-Windows do not obey + the command separator; this problem is overcome by explicitly invoking + the MS-Windows command-line processor cmd.exe. LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES @@ -1174,6 +1246,18 @@ LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES See the $pvc_view_file_via_temporary variable for a setting that applies only if preview-continuous mode (-pvc option) is used. + + + + 30 March 2012 19 + + + + + +LATEXMK(1L) LATEXMK(1L) + + See $tmpdir for the setting of the directory where the temporary file is created. @@ -1196,28 +1280,19 @@ LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES 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 given (pdf)latex the -aux-directory. + Important note: The effect of $aux_dir, if different from + $out_dir, is achieved by giving (pdf)latex the -aux-directory. Currently (Dec. 2011) this only works on the MiKTeX version of (pdf)latex. - - $banner [0] - If nonzero, the banner message is printed across each page when - converting the dvi file to postscript. Without modifying the - - - - 9 December 2011 18 - - - - - -LATEXMK(1L) LATEXMK(1L) + See also the documentation of $out_dir for some complications on + what directory names are suitable. - variable $banner_message, this is equivalent to specifying the + $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 @@ -1226,7 +1301,7 @@ LATEXMK(1L) LATEXMK(1L) $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. @@ -1235,19 +1310,31 @@ 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 + + + + 30 March 2012 20 + + + + + +LATEXMK(1L) LATEXMK(1L) + + + 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: @@ -1257,87 +1344,89 @@ 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 current - version of latexmk, since it has a better method of searching 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 @BIBIN- - PUTS. + 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 + need to set the variable @BIBINPUTS. $biber ["biber %O %S"] The biber processing program. $biber_silent_switch ["--onlylog"] - Switch(es) for the biber processing program when silent mode is + Switch(es) for the biber processing program when silent mode is on. + $bibtex ["bibtex %O %S"] + The BibTeX processing program. + $bibtex_silent_switch ["-terse"] + Switch(es) for the BibTeX processing program when silent mode is + on. - 9 December 2011 19 + $bibtex_use [1] + Under what conditions to run BibTeX or biber. When latexmk dis- + covers from the log file that one (or more) BibTeX/biber-gener- + ated bibliographies are used, it can run BibTeX or biber when- + ever it appears necessary to regenerate the bbl file(s) from + their source bib database file(s). + But sometimes, the bib file(s) are not available (e.g., for a + 30 March 2012 21 -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 - their source bib database file(s). +LATEXMK(1L) LATEXMK(1L) - 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 + + 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 an RC file. + 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. + variable is a string containing the extensions separated by spa- + ces. It is also possible to specify a more general pattern of file to be deleted, by using the place holder %R, as in commands. Thus @@ -1345,36 +1434,94 @@ LATEXMK(1L) LATEXMK(1L) $clean_ext = "out %R-blx.bib"; + 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 and FOO-blx.bib, + 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 - 9 December 2011 20 + 30 March 2012 22 -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 and FOO-blx.bib, - where FOO stands for the basename of the file being processed - (as in FOO.tex). +LATEXMK(1L) LATEXMK(1L) - $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 + [undefined] + + These variables specify commands that are executed at certain + points of compilations during preview-continuous mode. One + motivation for their existance is to allow convenient visual + indications of compilation status even when the window receiving + the screen output of the compilation is hidden. + + The commands are executed at the following points: $compil- + ing_cmd at the start of compilation, $success_cmd at the end of + a successful compilation, and $failure_cmd at the end of an + 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 + --name \"%D compiling\""; + $success_cmd = "xdotool search --name \"%D\" set_window + --name \"%D OK\""; + $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 + 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. + + @cus_dep_list [()] - Custom dependency list -- see section on "Custom Dependencies". + Custom dependency list -- see section on "Custom Dependencies". + @default_files [("*.tex")] Default list of files to be processed. + + + + 30 March 2012 23 + + + + + +LATEXMK(1L) LATEXMK(1L) + + Normally, if no filenames are specified on the command line, latexmk processes all tex files specified in the @default_files variable, which by default is set to all tex files ("*.tex") in @@ -1399,6 +1546,13 @@ LATEXMK(1L) LATEXMK(1L) are because @default_files is an array variable, i.e., a sequence of filename specifications is possible. + $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. @@ -1412,83 +1566,86 @@ LATEXMK(1L) LATEXMK(1L) 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 + 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 - 9 December 2011 21 + 30 March 2012 24 -LATEXMK(1L) LATEXMK(1L) +LATEXMK(1L) LATEXMK(1L) - 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 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 + letting latexmk do the detaching is not appropriate (for a vari- + ety of non-trivial reasons), so you should put the "start " bit + in yourself, whenever it is needed. + + $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. $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 for the analogous case of a pdf previewer. - $dvi_update_method [2 under UNIX, 1 under MS-Windows] - How the dvi viewer updates its display when the dvi file has - changed. The values here apply equally to the - $pdf_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 - - 9 December 2011 22 + 30 March 2012 25 @@ -1497,23 +1654,34 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - $dvi_update_signal. The default value under UNIX is suitable + $dvi_update_method [2 under UNIX, 1 under MS-Windows] + How the dvi viewer updates its display when the dvi file has + changed. The values here apply equally to the + $pdf_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 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 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 @@ -1526,63 +1694,63 @@ LATEXMK(1L) LATEXMK(1L) @generated_exts [( aux , bbl , idx , ind , lof , lot , out , toc , $fdb_ext )] - This contains a list of extensions for files that are generated - during a LaTeX run and that are read in by LaTeX in later runs, + 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 - error in a source .tex file during the run. So latexmk needs to - distinguish user-generated and automatically generated files; it - determines the automatically generated files as those with - extensions in the list in @generated_exts.) + a 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 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 - example.) + 30 March 2012 26 - 9 December 2011 23 +LATEXMK(1L) LATEXMK(1L) + error in a source .tex file during the run. So latexmk needs to + distinguish user-generated and automatically generated files; it + determines the automatically generated files as those with + extensions in the list in @generated_exts.) + A convenient way to add an extra extension to the list, without + losing the already defined ones is to use a push command in the + line in an RC file. E.g., -LATEXMK(1L) LATEXMK(1L) + push @generated_exts, "end"; + 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 becaues 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 becaues 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. @@ -1591,124 +1759,123 @@ 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 + ignore. The left-hand side is a Perl idiom for setting an item + in a hash. Note that the file extension is specified without a period. The value, on the right-hand side, is a string contain- - ing a regular expresssion. (See documentation on Perl for how - they are to be specified in general.) This particular regular - expression specifies that lines beginning with "%%CreationDate: - " are to be ignored in deciding whether a file of the given + ing a regular expresssion. (See documentation on Perl for how + they are to be specified in general.) This particular regular + expression specifies that lines beginning with "%%CreationDate: + " are to be ignored in deciding whether a file of the given extension .eps has changed. - There is only one regular expression available for each exten- - sion. If you need more one pattern to specify lines to ignore, - then you need to combine the patterns into a single regular - expression. The simplest method is separate the different sim- - ple patterns by a vertical bar character (indicating "alterna- + There is only one regular expression available for each exten- + sion. If you need more one pattern to specify lines to ignore, + then you need to combine the patterns into a single regular + expression. The simplest method is separate the different sim- + ple patterns by a vertical bar character (indicating "alterna- tion" in the jargon of regular expressions). For example, - $hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: - |^%%Title: '; - causes lines starting with either "^%%CreationDate: " or - "^%%Title: " to be ignored. - It may happen that a pattern to be ignored is specified in, for - example, in a system or user initialization file, and you wish - to remove this in a file read later. To do this, you use perl's - delete function, e.g., + 30 March 2012 27 - delete $hash_calc_ignore_pattern{'eps'}; - $kpsewhich ["kpsewhich %S"] - The program called to locate a source file when the name alone - is not sufficient. Most filenames used by latexmk have suffi- - cient path information to be found directly. But sometimes, - - 9 December 2011 24 +LATEXMK(1L) LATEXMK(1L) + $hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: + |^%%Title: '; + causes lines starting with either "^%%CreationDate: " or + "^%%Title: " to be ignored. + It may happen that a pattern to be ignored is specified in, for + example, in a system or user initialization file, and you wish + to remove this in a file read later. To do this, you use perl's + delete function, e.g., -LATEXMK(1L) LATEXMK(1L) + delete $hash_calc_ignore_pattern{'eps'}; - 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. + $kpsewhich ["kpsewhich %S"] + The program called to locate a source file when the name alone + is not sufficient. Most filenames used by latexmk have suffi- + cient path information to be found directly. But sometimes, + notably when .bib files are found from the log file of a bibtex + or biber run, the name of the file, but not its path is known. The program specified by $kpsewhich is used to find it. - See also the @BIBINPUTS variable for another way that latexmk + 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: + (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 - remove_input_ext( 'latex', 'tex' ); - removes the extension 'tex' from latex_input_extensions - add_input_ext( 'latex', 'asdf' ); + 30 March 2012 28 - add the extension 'asdf to latex_input_extensions. (Naturally - with such an extension, you should have made an appropriate cus- - tom dependency for latexmk, and should also have done the appro- - priate programming in the LaTeX source file to enable the file - to be read. The standard extensions are handled by LaTeX and - its graphics/graphicx packages. - $latex_silent_switch ["-interaction=batchmode"] - Switch(es) for the LaTeX processing program when silent mode is - on. +LATEXMK(1L) LATEXMK(1L) - 9 December 2011 25 + variable %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' ); + add the extension 'asdf to latex_input_extensions. (Naturally + with such an extension, you should have made an appropriate cus- + tom dependency for latexmk, and should also have done the appro- + priate programming in the LaTeX source file to enable the file + to be read. The standard extensions are handled by LaTeX and + its graphics/graphicx packages. -LATEXMK(1L) LATEXMK(1L) + $latex_silent_switch ["-interaction=batchmode"] + Switch(es) for the LaTeX processing program when silent mode is + on. - If you use MikTeX, you may prefer the results if you configure - the options to include -c-style-errors, e.g., by the following + 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- @@ -1718,7 +1885,7 @@ 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": @@ -1740,13 +1907,24 @@ LATEXMK(1L) LATEXMK(1L) $lpr_pdf ["NONE lpr_pdf"] The printing program to print pdf files. + + + 30 March 2012 29 + + + + + +LATEXMK(1L) LATEXMK(1L) + + Under MS-Windows you could set this to use gsview, if it is installed, e.g., $lpr = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p'; - If gsview is installed in a different directory, you will need - to make the appropriate change. Note the double quotes around + If gsview is installed in a different directory, you will need + to make the appropriate change. Note the double quotes around the name: this is necessary because one part of the command name ("Program Files") contains a space which would otherwise be mis- interpreted. @@ -1760,61 +1938,95 @@ LATEXMK(1L) LATEXMK(1L) The index processing program. $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 + latex/pdflatex generates files to be read in on a later run.) + $new_viewer_always [0] + This variable applies to latexmk only in continuous-preview + mode. If $new_viewer_always is 0, latexmk will check for a pre- + viously running previewer on the same file, and if one is run- + ning will not start a new one. If $new_viewer_always is non- + zero, this check will be skipped, and latexmk will behave as if + no viewer is running. - 9 December 2011 26 + $out_dir [""] + 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) implementations of TeX, i.e., + MiKTeX and TeXLive. But it may not be present in other versions. + 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 -LATEXMK(1L) LATEXMK(1L) + 30 March 2012 30 - (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.) - $new_viewer_always [0] - This variable applies to latexmk only in continuous-preview - mode. If $new_viewer_always is 0, latexmk will check for a pre- - viously running previewer on the same file, and if one is run- - ning will not start a new one. If $new_viewer_always is non- - zero, this check will be skipped, and latexmk will behave as if - no viewer is running. - $out_dir [""] - 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 is achieved by using the -output- - directory option of (pdf)latex. This exists in the usual cur- - rent (Dec. 2011) implementations, i.e., MiKTeX and TeXLive. But - it may not be present in other versions. +LATEXMK(1L) LATEXMK(1L) + + current working directory or one of its subdirectories. This is + part of security measures by the whole TeX system that try to + prevent malicious or errant TeX documents from incorrectly mess- + ing with a user's files. If for $out_dir or $aux_dir you really + do need to specify an absolute pathname (e.g., "/tmp/foo") or a + path (e.g., "../output") that includes a higher-level directory, + then you need to disable the security measures (and assume any + risks). This can be done by temporarily setting the operating + system's environment 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. Equivalent to the -pdf-, -pdf, -pdfdvi, -pdfps options. + $pdflatex ["pdflatex %O %S"] - The LaTeX processing program in the version that makes a pdf + The LaTeX processing program in the version that makes a pdf file instead of a dvi file. + An example of the use of this variable is to arrange for xelatex + to be used instead of pdflatex, when you could set + + $pdflatex = "xelatex %O %S"; + + Note that xelatex only produces .pdf files (and not .dvi), so to + use it 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 the following settings in an ini- + tialization file + + $pdf_mode = 1; $postscript_mode = $dvi_mode = 0; + + + %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 @@ -1826,26 +2038,26 @@ LATEXMK(1L) LATEXMK(1L) In this situation, latexmk searches for custom dependencies to make the missing file(s), but restricts it to the extensions specified by the variable %pdflatex_input_extensions. The - default extensions are 'tex', 'pdf', 'jpg, and 'png'. - (For Perl experts: %pdflatex_input_extensions is a hash whose - keys are the extensions. The values are irrelevant.) Two sub- - routines are provided for manipulating this and the related - variable %latex_input_extensions, add_input_ext and - remove_input_ext. They are used as in the following examples - are possible lines in an initialization file: + 30 March 2012 31 - 9 December 2011 27 +LATEXMK(1L) LATEXMK(1L) -LATEXMK(1L) LATEXMK(1L) + default extensions are 'tex', 'pdf', 'jpg, and 'png'. + (For Perl experts: %pdflatex_input_extensions is a hash whose + keys are the extensions. The values are irrelevant.) Two sub- + routines are provided for manipulating this and the related + variable %latex_input_extensions, add_input_ext and + remove_input_ext. They are used as in the following examples + are possible lines in an initialization file: remove_input_ext( 'pdflatex', 'tex' ); @@ -1874,18 +2086,49 @@ LATEXMK(1L) LATEXMK(1L) $pdf_previewer ["start acroread %O %S"] - The command to invoke a pdf-previewer. [Default is changed to - "start" on MS-WINDOWS; under more recent versions of Windows, - this will cause to be run whatever command the system has asso- - ciated with .pdf files.] + The command to invoke a pdf-previewer. + + 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 -- + see the notes in the explanation of the -pvc option.] + + On OS-X the default is changed to "open %S", which results in + OS-X starting up (and detaching) the viewer associated with the + file. By default, for pdf files this association is to OS-X's + preview, which is quite satisfactory. WARNING: Potential 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 + + + + 30 March 2012 32 + + + + + +LATEXMK(1L) LATEXMK(1L) + + ghostview, gv or gsview is used to view pdf 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 + letting latexmk do the detaching is not appropriate (for a vari- + ety of non-trivial reasons), so you should put the "start " bit + in yourself, whenever it is needed. + + $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 @@ -1906,17 +2149,6 @@ LATEXMK(1L) LATEXMK(1L) Arranging to use a command to get a previewer explicitly updated requires three variables to be set. For example: - - - 9 December 2011 28 - - - - - -LATEXMK(1L) LATEXMK(1L) - - $pdf_previewer = "start xpdf -remote %R %O %S"; $pdf_update_method = 4; $pdf_update_command = "xpdf -remote %R -reload"; @@ -1930,100 +2162,124 @@ LATEXMK(1L) LATEXMK(1L) $pdf_update_signal [Under UNIX: SIGHUP, which is a system-dependent value] - The number of the signal that is sent to the pdf viewer when it - is updated by sending a signal -- see the information on the - variable $pdf_update_method. The default value is the one + The number of the signal that is sent to the pdf viewer when it + is updated by sending a signal -- see the information on the + variable $pdf_update_method. The default value is the one appropriate for gv on a UNIX system. $pid_position[1 under UNIX, -1 under MS-Windows] - The variable $pid_position is used to specify which word in - lines of the output from $pscmd corresponds to the process ID. - The first word in the line is numbered 0. The default value of + The variable $pid_position is used to specify which word in + lines of the output from $pscmd corresponds to the process ID. + + + + 30 March 2012 33 + + + + + +LATEXMK(1L) LATEXMK(1L) + + + 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. + 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 needed, - then $postscript_mode will be set to 1. + 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 = ["ps"] - Type of file to printout: possibilities are "dvi", "none", + Type of file to printout: possibilities are "dvi", "none", "pdf", or "ps". $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 + process number is determined. + The default for pscmd is "NONE" under MS-Windows and cygwin + (i.e., the command is not used), "ps --width 200 -f -u + $ENV{USER}" under linux, "ps -ww -u $ENV{USER}" under darwin + (Macintosh OS-X), and "ps -f -u $ENV{USER}" under other operat- + ing systems (including other flavors of UNIX). In these speci- + fications "$ENV{USER}" is substituted by the username. - 9 December 2011 29 + $ps2pdf ["ps2pdf %O %S %D"] + Command to convert ps to pdf file. -LATEXMK(1L) LATEXMK(1L) + 30 March 2012 34 - 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 - (i.e., the command is not used), "ps --width 200 -f -u - $ENV{USER}" under linux, "ps -ww -u $ENV{USER}" under darwin - (Macintosh OS-X), and "ps -f -u $ENV{USER}" under other operat- - ing systems (including other flavors of UNIX). In these speci- - fications "$ENV{USER}" is substituted by the username. - $ps2pdf ["ps2pdf %O %S %D"] - Command to convert ps to pdf file. +LATEXMK(1L) LATEXMK(1L) + $ps_filter [empty] - The postscript file filter to be run on the newly produced - postscript file before other processing. Equivalent to specify- - ing the -pF option. + The postscript file filter to be run on the newly produced post- + script file before other processing. Equivalent to specifying + the -pF option. $ps_previewer ["start gv %O %S", but "start %O %S" under MS-WINDOWS] - The command to invoke a ps-previewer. (The default under MS- - WINDOWS will cause to be run whatever command the system has + 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 apppropriately. 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. - $ps_previewer_landscape ["start gv -swap %O %S", but "start %O %S" + Important note: Normally you will want to have a previewer run + detached, so that latexmk doesn't wait for the previewer to ter- + minate before continuing its work. So normally you should pre- + fix the command by "start ", which flags to latexmk that it + should do the detaching of the previewer itself (by whatever + method is appropriate to the operating system). But sometimes + letting latexmk do the detaching is not appropriate (for a vari- + ety of non-trivial reasons), so you should put the "start " bit + in yourself, whenever it is needed. + + + $ps_previewer_landscape ["start gv -swap %O %S", but "start %O %S" under MS-WINDOWS] The command to invoke a ps-previewer in landscape mode. @@ -2044,11 +2300,12 @@ LATEXMK(1L) LATEXMK(1L) $ps_update_signal [Under UNIX: SIGHUP, which is a system-dependent value] - The number of the signal that is sent to the pdf viewer when it + 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 - 9 December 2011 30 + 30 March 2012 35 @@ -2057,7 +2314,6 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - is updated by sending a signal -- see $ps_update_method. The default value is the one appropriate for gv on a UNIX system. @@ -2069,16 +2325,17 @@ 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 cor- - rectly deal with TeX files whose names contain spaces. Latexmk's quot- - ing only ensures that such filenames are correctly treated by the oper- - ating system in passing arguments to programs.) + 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 [0] Whether to use the -recorder option to latex and pdflatex. Use @@ -2111,14 +2368,10 @@ LATEXMK(1L) LATEXMK(1L) 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 - 9 December 2011 31 + 30 March 2012 36 @@ -2127,6 +2380,10 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) + [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 @@ -2158,6 +2415,11 @@ LATEXMK(1L) LATEXMK(1L) then latexmk replaces @default_files with the filenames in $tex- file_search to which is added "*.tex". + + $success_cmd [undefined] + See the documentation for $compiling_cmd. + + $tmpdir [See below for default] Directory to store temporary files that latexmk may generate while running. @@ -2172,6 +2434,18 @@ LATEXMK(1L) LATEXMK(1L) $use_make_for_missing_files [0] Whether to use make to try and make files that are missing after + + + + 30 March 2012 37 + + + + + +LATEXMK(1L) LATEXMK(1L) + + 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 @@ -2187,18 +2461,6 @@ LATEXMK(1L) LATEXMK(1L) $view ["default"] Which kind of file is to be previewed if a previewer is used. The possible values are "default", "dvi", "ps", "pdf". The - - - - 9 December 2011 32 - - - - - -LATEXMK(1L) LATEXMK(1L) - - value of "default" means that the "highest" of the kinds of file generated is to be used (among dvi, ps and pdf). @@ -2238,6 +2500,18 @@ CUSTOM DEPENDENCIES function: The name of the subroutine that latexmk should call to perform the file conversion. The first argument to the subroutine is + + + + 30 March 2012 38 + + + + + +LATEXMK(1L) LATEXMK(1L) + + 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 @@ -2259,18 +2533,6 @@ CUSTOM DEPENDENCIES experts could do something much more elaborate. One other item in each custom-dependency rule labelled "must" above - - - - 9 December 2011 33 - - - - - -LATEXMK(1L) LATEXMK(1L) - - specifies how the rule should be applied when the source file fails to exist. @@ -2305,6 +2567,17 @@ LATEXMK(1L) LATEXMK(1L) 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. + + + 30 March 2012 39 + + + + + +LATEXMK(1L) LATEXMK(1L) + + If you use filenames with spaces in them, and if your LaTeX system and all other relevant software correctly handle such filenames, then you could put single quotes around filenames in the command line that is @@ -2317,10 +2590,10 @@ LATEXMK(1L) LATEXMK(1L) This causes the invocation of the fig2dev program to have quoted file- names; it should therefore work with filenames containing spaces. How- - ever, not all software deals correctly with filenames that contain - spaces. Moreover, the rules, if any, for quoting filenames vary - between operating systems, command shells and individual pieces of - software, so this code may not always work. + ever, not all software deals correctly with filenames that contain spa- + ces. Moreover, the rules, if any, for quoting filenames vary between + operating systems, command shells and individual pieces of software, so + this code may not always work. 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 @@ -2331,18 +2604,6 @@ LATEXMK(1L) LATEXMK(1L) system("fig2dev -Lpdf $_[0].fig $_[0].pdf"); } - - - - 9 December 2011 34 - - - - - -LATEXMK(1L) LATEXMK(1L) - - 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. @@ -2371,6 +2632,18 @@ LATEXMK(1L) LATEXMK(1L) file will cause this to happen: add_cus_dep('ndx', 'nnd', 0, 'makendx2nnd'); + + + + 30 March 2012 40 + + + + + +LATEXMK(1L) LATEXMK(1L) + + sub makendx2nnd { system("makeindex -o $_[0].nnd $_[0].ndx"); } @@ -2404,17 +2677,6 @@ OLD METHOD OF DEFINING CUSTOM DEPENDENCIES item, and the name of the subroutine for the custom dependency. These were all defined above. - - - 9 December 2011 35 - - - - - -LATEXMK(1L) LATEXMK(1L) - - An example of the old method of defining custom dependencies is as fol- lows. It is the code in an RC file to ensure automatic conversion of .fig files to .eps files: @@ -2437,6 +2699,17 @@ USING latexmk WITH make gram for complex projects, as for software development, with the depen- dencies specified by a Makefile. + + + 30 March 2012 41 + + + + + +LATEXMK(1L) LATEXMK(1L) + + 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 @@ -2465,9 +2738,9 @@ USING latexmk WITH make 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. + 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 @@ -2476,9 +2749,25 @@ USING latexmk WITH make %.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, + where lines such as the above would be only be a small part of a larger + Makefile. + + The above example has a pattern rule for making a .pdf file from a .tex + file, and it is defined to use latexmk in the obvious way. There is a + conventional default target named "all", with a prerequisite of + try.pdf. So when make is invoked, by default it makes try.pdf. The + only complication is that there may be many source files beyond + try.tex, but these aren't specified in the Makefile, so changes in them + will not by themselves cause latexmk to be invoked. Instead, the - 9 December 2011 36 + + 30 March 2012 42 @@ -2487,33 +2776,18 @@ USING latexmk WITH make LATEXMK(1L) LATEXMK(1L) - (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 - conventional default target named "all", with a prerequisite of - try.pdf. So when make is invoked, by default it makes try.pdf. The - only complication is that there may be many source files beyond - try.tex, but these aren't specified in the Makefile, so changes in them - will not by themselves cause latexmk to be invoked. Instead, the pat- - tern rule is equipped with a "phony" prerequisite FORCE_MAKE; this has - the effect of causing the rule to be always out-of-date, so that - latexmk is always run. It is latexmk that decides whether any action - is needed, e.g., a rerun of pdflatex. Effectively the Makefile dele- + 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 + 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 @@ -2532,49 +2806,49 @@ 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 + from .fig files produced by the xfig program; these are commonly used + for graphics insertions in LaTeX documents. Latexmk is arranged to + output a dependency file after each run. It is given the -recorder + option, which improves its detection of files generated during a run of + pdflatex; such files should not be in the dependency list. The -e + options are used to turn off all custom dependencies, and to document + this. Instead the -use-make is used to delegate the making of missing + files to make itself. + Suppose in the LaTeX file there is a command \includegraphics{graph}, + and an xfig file "graph.fig" exists. On a first run, pdflatex reports - 9 December 2011 37 + 30 March 2012 43 -LATEXMK(1L) LATEXMK(1L) +LATEXMK(1L) LATEXMK(1L) - output a dependency file after each run. It is given the -recorder - option, which improves its detection of files generated during a run of - pdflatex; such files should not be in the dependency list. The -e - options are used to turn off all custom dependencies, and to document - this. Instead the -use-make is used to delegate the making of missing - files to make itself. - Suppose in the LaTeX file there is a command \includegraphics{graph}, - and an xfig file "graph.fig" exists. On a first run, pdflatex reports - a missing file, named "graph". Latexmk succeeds in making "graph.pdf" + 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. @@ -2583,35 +2857,35 @@ SEE ALSO BUGS Sometimes a viewer (gv) tries to read an updated .ps or .pdf file after - its creation is started but before the file is complete. Work around: + its creation is started but before the file is complete. Work around: manually refresh (or reopen) display. Or use one of the other preview- ers and update methods. - (The following isn't really a bug, but concerns features of preview- - ers.) Preview continuous mode only works perfectly with certain pre- - viewers: Xdvi on UNIX/LINUX works for dvi files. Gv on UNIX/LINUX - works for both postscript and pdf. Ghostview on UNIX/LINUX needs a - manual update (reopen); it views postscript and pdf. Gsview under MS- - Windows works for both postscript and pdf, but only reads the updated - file when its screen is refreshed. Acroread under UNIX/LINUX views - pdf, but the file needs to be closed and reopened to view an updated - version. Under MS-Windows, acroread locks its input file and so the - pdf file cannot be updated. (Remedy: configure latexmk to use gsview - instead.) + (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 collins at node - phys.psu.edu). (Version 4.30). + Current version, by John Collins (username collins at node + phys.psu.edu). (Version 4.31). - Released version can be obtained from CTAN: <http://www.tug.org/tex- - archive/support/latexmk/>, and from the author's website + Released version can be obtained from CTAN: <http://www.tug.org/tex-ar- + chive/support/latexmk/>, and from the author's website <http://www.phys.psu.edu/~collins/software/latexmk/>. Modifications and enhancements by Evan McLean (Version 2.0) Original script called "go" by David J. Musliner (RCS Version 3.2) @@ -2622,19 +2896,16 @@ AUTHOR - 9 December 2011 38 - - -LATEXMK(1L) LATEXMK(1L) - + 30 March 2012 44 +LATEXMK(1L) LATEXMK(1L) @@ -2694,6 +2965,6 @@ LATEXMK(1L) LATEXMK(1L) - 9 December 2011 39 + 30 March 2012 45 |