summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/latexmk
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2017-01-30 23:32:40 +0000
committerKarl Berry <karl@freefriends.org>2017-01-30 23:32:40 +0000
commit5776f6c9b6cf24e5a9b8c6bbd88d2b4bfb5c0234 (patch)
tree92b155c112ae5314c5b3d9eaad9ea805735ce10f /Master/texmf-dist/doc/support/latexmk
parenta9b7bc30b28ec77ad1e0de52a2193de4225ad780 (diff)
latexmk (30jan17)
git-svn-id: svn://tug.org/texlive/trunk@43099 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support/latexmk')
-rw-r--r--Master/texmf-dist/doc/support/latexmk/CHANGES4
-rw-r--r--Master/texmf-dist/doc/support/latexmk/INSTALL2
-rw-r--r--Master/texmf-dist/doc/support/latexmk/README4
-rwxr-xr-xMaster/texmf-dist/doc/support/latexmk/extra-scripts/dvipdfm_call.bat36
-rwxr-xr-xMaster/texmf-dist/doc/support/latexmk/extra-scripts/dvipdfmx_call.bat36
-rw-r--r--Master/texmf-dist/doc/support/latexmk/latexmk.pdfbin174414 -> 174974 bytes
-rw-r--r--Master/texmf-dist/doc/support/latexmk/latexmk.txt560
7 files changed, 322 insertions, 320 deletions
diff --git a/Master/texmf-dist/doc/support/latexmk/CHANGES b/Master/texmf-dist/doc/support/latexmk/CHANGES
index 662942e7ad5..54801480ce4 100644
--- a/Master/texmf-dist/doc/support/latexmk/CHANGES
+++ b/Master/texmf-dist/doc/support/latexmk/CHANGES
@@ -530,7 +530,9 @@ From v. 4.48 to 4.52
Minor improvements in code and diagnostics.
From v. 4.52 to 4.52b
-
Fix bug introduced in 4.52 that use of bibtex wasn't always detected
when recorder mode is on.
+From v. 4.52b to 4.52c
+ Document $kpsewhich_show variable.
+ Make -jobname work with -pdfxe and -pdflua
diff --git a/Master/texmf-dist/doc/support/latexmk/INSTALL b/Master/texmf-dist/doc/support/latexmk/INSTALL
index c1d563e46ff..4feea9dd7e3 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.52b, 17 January 2017)
+ (Version 4.52c, 19 January 2017)
John Collins
Physics Department
diff --git a/Master/texmf-dist/doc/support/latexmk/README b/Master/texmf-dist/doc/support/latexmk/README
index ffd7bcd3ed6..96ff552e517 100644
--- a/Master/texmf-dist/doc/support/latexmk/README
+++ b/Master/texmf-dist/doc/support/latexmk/README
@@ -1,4 +1,4 @@
-Latexmk, version 4.52b, 17 January 2017
+Latexmk, version 4.52c, 19 January 2017
---------------------------------------
Latexmk completely automates the process of generating a LaTeX
@@ -91,7 +91,7 @@ NOTES:-
John Collins
---------------------------- "latexmk -h" ----------------------------
-Latexmk 4.52b: Automatic LaTeX document generation routine
+Latexmk 4.52c: Automatic LaTeX document generation routine
Usage: latexmk [latexmk_options] [filename ...]
diff --git a/Master/texmf-dist/doc/support/latexmk/extra-scripts/dvipdfm_call.bat b/Master/texmf-dist/doc/support/latexmk/extra-scripts/dvipdfm_call.bat
index 104bbabe858..a0817015fe6 100755
--- a/Master/texmf-dist/doc/support/latexmk/extra-scripts/dvipdfm_call.bat
+++ b/Master/texmf-dist/doc/support/latexmk/extra-scripts/dvipdfm_call.bat
@@ -1,19 +1,19 @@
-@echo off
-REM Run dvipdfm from dvipdf-style command-line
-REM Assume no options specified
-REM If this script is called from latexmk,
-REM we have %1=source.dvi, %2=dest.pdf
-REM But for safety, let's handle correctly a one argument call,
-REM i.e., %1=source, with no %2
-
-if "%2" == "" goto onearg
-
-:twoarg
-dvipdfm -o %2 %1
-goto done
-
-:onearg
-dvipdfm %1
-
-
+@echo off
+REM Run dvipdfm from dvipdf-style command-line
+REM Assume no options specified
+REM If this script is called from latexmk,
+REM we have %1=source.dvi, %2=dest.pdf
+REM But for safety, let's handle correctly a one argument call,
+REM i.e., %1=source, with no %2
+
+if "%2" == "" goto onearg
+
+:twoarg
+dvipdfm -o %2 %1
+goto done
+
+:onearg
+dvipdfm %1
+
+
:done \ No newline at end of file
diff --git a/Master/texmf-dist/doc/support/latexmk/extra-scripts/dvipdfmx_call.bat b/Master/texmf-dist/doc/support/latexmk/extra-scripts/dvipdfmx_call.bat
index 01a140a65fe..0068de2196d 100755
--- a/Master/texmf-dist/doc/support/latexmk/extra-scripts/dvipdfmx_call.bat
+++ b/Master/texmf-dist/doc/support/latexmk/extra-scripts/dvipdfmx_call.bat
@@ -1,19 +1,19 @@
-@echo off
-REM Run dvipdfmx from dvipdf-style command-line
-REM Assume no options specified
-REM If this script is called from latexmk,
-REM we have %1=source.dvi, %2=dest.pdf
-REM But for safety, let's handle correctly a one argument call,
-REM i.e., %1=source, with no %2
-
-if "%2" == "" goto onearg
-
-:twoarg
-dvipdfmx -o %2 %1
-goto done
-
-:onearg
-dvipdfmx %1
-
-
+@echo off
+REM Run dvipdfmx from dvipdf-style command-line
+REM Assume no options specified
+REM If this script is called from latexmk,
+REM we have %1=source.dvi, %2=dest.pdf
+REM But for safety, let's handle correctly a one argument call,
+REM i.e., %1=source, with no %2
+
+if "%2" == "" goto onearg
+
+:twoarg
+dvipdfmx -o %2 %1
+goto done
+
+:onearg
+dvipdfmx %1
+
+
:done \ No newline at end of file
diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.pdf b/Master/texmf-dist/doc/support/latexmk/latexmk.pdf
index 54d2e5fdadf..a696b51e863 100644
--- a/Master/texmf-dist/doc/support/latexmk/latexmk.pdf
+++ b/Master/texmf-dist/doc/support/latexmk/latexmk.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.txt b/Master/texmf-dist/doc/support/latexmk/latexmk.txt
index f8d7119c618..e5aa3d13745 100644
--- a/Master/texmf-dist/doc/support/latexmk/latexmk.txt
+++ b/Master/texmf-dist/doc/support/latexmk/latexmk.txt
@@ -61,7 +61,7 @@ DESCRIPTION
- 17 January 2017 1
+ 19 January 2017 1
@@ -127,7 +127,7 @@ LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE
- 17 January 2017 2
+ 19 January 2017 2
@@ -193,7 +193,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 3
+ 19 January 2017 3
@@ -259,7 +259,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 4
+ 19 January 2017 4
@@ -325,7 +325,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 5
+ 19 January 2017 5
@@ -391,7 +391,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 6
+ 19 January 2017 6
@@ -457,7 +457,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 7
+ 19 January 2017 7
@@ -523,7 +523,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 8
+ 19 January 2017 8
@@ -589,7 +589,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 9
+ 19 January 2017 9
@@ -655,7 +655,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 10
+ 19 January 2017 10
@@ -721,7 +721,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 11
+ 19 January 2017 11
@@ -787,7 +787,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 12
+ 19 January 2017 12
@@ -853,7 +853,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 13
+ 19 January 2017 13
@@ -919,7 +919,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 14
+ 19 January 2017 14
@@ -985,7 +985,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 15
+ 19 January 2017 15
@@ -1051,7 +1051,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 16
+ 19 January 2017 16
@@ -1117,7 +1117,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 17
+ 19 January 2017 17
@@ -1183,7 +1183,7 @@ DEALING WITH ERRORS, PROBLEMS, ETC
- 17 January 2017 18
+ 19 January 2017 18
@@ -1249,7 +1249,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 19
+ 19 January 2017 19
@@ -1315,7 +1315,7 @@ CONFIGURATION/INITIALIZATION (RC) FILES
- 17 January 2017 20
+ 19 January 2017 20
@@ -1381,7 +1381,7 @@ FORMAT OF COMMAND SPECIFICATIONS
- 17 January 2017 21
+ 19 January 2017 21
@@ -1447,7 +1447,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 22
+ 19 January 2017 22
@@ -1513,7 +1513,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 23
+ 19 January 2017 23
@@ -1579,7 +1579,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 24
+ 19 January 2017 24
@@ -1645,7 +1645,7 @@ LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES
- 17 January 2017 25
+ 19 January 2017 25
@@ -1711,7 +1711,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 26
+ 19 January 2017 26
@@ -1777,7 +1777,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 27
+ 19 January 2017 27
@@ -1843,7 +1843,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 28
+ 19 January 2017 28
@@ -1909,7 +1909,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 29
+ 19 January 2017 29
@@ -1975,7 +1975,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 30
+ 19 January 2017 30
@@ -2041,7 +2041,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 31
+ 19 January 2017 31
@@ -2107,7 +2107,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 32
+ 19 January 2017 32
@@ -2173,7 +2173,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 33
+ 19 January 2017 33
@@ -2239,7 +2239,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 34
+ 19 January 2017 34
@@ -2305,7 +2305,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 35
+ 19 January 2017 35
@@ -2317,6 +2317,17 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
also uses to try to locate files; it applies only in the case of
.bib files.
+
+ $kpsewhich_show [0]
+ Whether to show diagnostics about invocations of kpsewhich: the
+ command line use to invoke it and the results. These diagnos-
+ tics are shown if $kpsewhich_show is non-zero or if diagnostics
+ mode is on. (But in the second case, lots of other diagnostics
+ are also shown.) Without these diagnostics there is nothing
+ visible in latexmk's screen output about invocations of kpse-
+ which.
+
+
$landscape_mode [0]
If nonzero, run in landscape mode, using the landscape mode pre-
viewers and dvi to postscript converters. Equivalent to the -l
@@ -2356,30 +2367,30 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
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.
+ with such an extension, you should have made an appropriate
- $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
+ 19 January 2017 36
- 17 January 2017 36
+LATEXMK(1) General Commands Manual LATEXMK(1)
+ custom dependency for latexmk, and should also have done the
+ appropriate programming in the LaTeX source file to enable the
+ file to be read. The standard extensions are handled by LaTeX
+ and its graphics/graphicx packages.
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ $latex_silent_switch ["-interaction=batchmode"]
+ Switch(es) for the LaTeX processing program when silent mode is
+ on.
+ If you use MikTeX, you may prefer the results if you configure
the options to include -c-style-errors, e.g., by the following
line in an initialization file
@@ -2424,28 +2435,27 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
interpreted.
- $lualatex ["lualatex %O %S"]
- The LaTeX processing program that is to be used when the luala-
- tex program is called for (e.g., by the option -lualatex.
- %lualatex_input_extensions
- This variable specifies the extensions tried by latexmk when it
- finds that a lualatex run resulted in an error that a file has
- not been found, and the file is given without an extension.
- This typically happens when LaTeX commands of the form
+ 19 January 2017 37
- 17 January 2017 37
-
+LATEXMK(1) General Commands Manual LATEXMK(1)
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ $lualatex ["lualatex %O %S"]
+ The LaTeX processing program that is to be used when the luala-
+ tex program is called for (e.g., by the option -lualatex.
+ %lualatex_input_extensions
+ This variable specifies the extensions tried by latexmk when it
+ finds that a lualatex run resulted in an error that a file has
+ not been found, and the file is given without an extension.
+ This typically happens when LaTeX commands of the form
\input{file} or \includegraphics{figure}, when the relevant
source file does not exist.
@@ -2490,20 +2500,10 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
$MSWin_back_slash [1]
This configuration variable only has an effect when latexmk is
running under MS-Windows. It determines whether, when a command
- is executed under MS-Windows, there should be substituted "\"
- for the separator character between components of a directory
- name. Internally, latexmk uses "/" for the directory separator
- character, which is the character used by Unix-like systems.
-
- For many programs under MS-Windows, both "\" and "/" are accept-
- able as the directory separator character. But some programs
- only accept "\" on the command line. So for safety latexmk
- makes a translation, by default. It is conceivable that under
- certain situations this is undesirable, so the configuration can
- 17 January 2017 38
+ 19 January 2017 38
@@ -2512,6 +2512,16 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
LATEXMK(1) General Commands Manual LATEXMK(1)
+ is executed under MS-Windows, there should be substituted "\"
+ for the separator character between components of a directory
+ name. Internally, latexmk uses "/" for the directory separator
+ character, which is the character used by Unix-like systems.
+
+ For many programs under MS-Windows, both "\" and "/" are accept-
+ able as the directory separator character. But some programs
+ only accept "\" on the command line. So for safety latexmk
+ makes a translation, by default. It is conceivable that under
+ certain situations this is undesirable, so the configuration can
be changed. (A possible example might be when some of the soft-
ware is implemented using Cygwin, which provides a Unix-like
environment inside MS-Windows.)
@@ -2556,28 +2566,28 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
path (e.g., "../output") that includes a higher-level directory,
and you need to use makeindex or bibtex, then you need to dis-
able the security measures (and assume any risks). One way of
- doing this is to temporarily set an operating system 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-
- tex, using the command specified by the $pdflatex variable. If
- equal to 2, generate a pdf version of the document from the ps
+ 19 January 2017 39
- 17 January 2017 39
+LATEXMK(1) General Commands Manual LATEXMK(1)
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ doing this is to temporarily set an operating system 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-
+ tex, using the command specified by the $pdflatex variable. If
+ equal to 2, generate a pdf version of the document from the ps
file, by using the command specified by the $ps2pdf variable.
If equal to 3, generate a pdf version of the document from the
dvi file, by using the command specified by the $dvipdf vari-
@@ -2622,26 +2632,28 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
specified by the variable %pdflatex_input_extensions. The
default extensions are 'tex', 'pdf', 'jpg, and 'png'.
- See details of the %latex_input_extensions for other information
- that equally applies to %pdflatex_input_extensions.
- $pdflatex_silent_switch ["-interaction=batchmode"]
- Switch(es) for the pdflatex program (specified in the variable
- $pdflatex) when silent mode is on.
- See details of the $latex_silent_switch for other information
- that equally applies to $pdflatex_silent_switch.
+ 19 January 2017 40
+
+
- 17 January 2017 40
+LATEXMK(1) General Commands Manual LATEXMK(1)
+ See details of the %latex_input_extensions for other information
+ that equally applies to %pdflatex_input_extensions.
+ $pdflatex_silent_switch ["-interaction=batchmode"]
+ Switch(es) for the pdflatex program (specified in the variable
+ $pdflatex) when silent mode is on.
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ See details of the $latex_silent_switch for other information
+ that equally applies to $pdflatex_silent_switch.
$pdf_previewer ["start acroread %O %S"]
@@ -2686,30 +2698,30 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
changed. See the information on the variable $dvi_update_method
for the codes. (Note that information needs be changed slightly
so that for the value 4, to run a command to do the update, the
- command is specified by the variable $pdf_update_command, and
- for the value 2, to specify update by signal, the signal is
- specified by $pdf_update_signal.)
- Note that acroread under MS-Windows (but not UNIX) locks the pdf
- file, so the default value is then 3.
- Arranging to use a command to get a previewer explicitly updated
- requires three variables to be set. For example:
- $pdf_previewer = "start xpdf -remote %R %O %S";
- $pdf_update_method = 4;
+ 19 January 2017 41
- 17 January 2017 41
+LATEXMK(1) General Commands Manual LATEXMK(1)
+ command is specified by the variable $pdf_update_command, and
+ for the value 2, to specify update by signal, the signal is
+ specified by $pdf_update_signal.)
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ Note that acroread under MS-Windows (but not UNIX) locks the pdf
+ file, so the default value is then 3.
+ Arranging to use a command to get a previewer explicitly updated
+ requires three variables to be set. For example:
+ $pdf_previewer = "start xpdf -remote %R %O %S";
+ $pdf_update_method = 4;
$pdf_update_command = "xpdf -remote %R -reload";
The first setting arranges for the xpdf program to be used in
@@ -2752,30 +2764,30 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
$preview_mode [0]
If nonzero, run a previewer to preview the document. Equivalent
to the -pv option. Which previewer is run depends on the other
- settings, see the command line options -view=, and the variable
- $view.
- $printout_mode [0]
- If nonzero, print the document using the command specified in
- the $lpr variable. Equivalent to the -p option. This is recom-
- mended not to be set from an RC file, otherwise you could waste
- lots of paper.
- $print_type = ["auto"]
- Type of file to printout: possibilities are "auto", "dvi",
- "none", "pdf", or "ps". See the option -print= for the meaning
+ 19 January 2017 42
- 17 January 2017 42
+LATEXMK(1) General Commands Manual LATEXMK(1)
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ settings, see the command line options -view=, and the variable
+ $view.
+ $printout_mode [0]
+ If nonzero, print the document using the command specified in
+ the $lpr variable. Equivalent to the -p option. This is recom-
+ mended not to be set from an RC file, otherwise you could waste
+ lots of paper.
+ $print_type = ["auto"]
+ Type of file to printout: possibilities are "auto", "dvi",
+ "none", "pdf", or "ps". See the option -print= for the meaning
of the "auto" value.
$pscmd Command used to get all the processes currently run by the user.
@@ -2818,30 +2830,30 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
perhaps not one actually called gv.
Important note: Normally you will want to have a previewer run
- detached, so that latexmk doesn't wait for the previewer to ter-
- minate before continuing its work. So normally you should pre-
- fix the command by "start ", which flags to latexmk that it
- should do the detaching of the previewer itself (by whatever
- method is appropriate to the operating system). But sometimes
- letting latexmk do the detaching is not appropriate (for a vari-
- ety of non-trivial reasons), so you should put the "start " bit
- in yourself, whenever it is needed.
- $ps_previewer_landscape ["start gv -swap %O %S", but start %O %S under
- MS-Windows]
+ 19 January 2017 43
- 17 January 2017 43
+LATEXMK(1) General Commands Manual LATEXMK(1)
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ detached, so that latexmk doesn't wait for the previewer to ter-
+ minate before continuing its work. So normally you should pre-
+ fix the command by "start ", which flags to latexmk that it
+ should do the detaching of the previewer itself (by whatever
+ method is appropriate to the operating system). But sometimes
+ 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.
$ps_update_command [""]
@@ -2883,31 +2895,31 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
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.)
+ filenames are correctly treated by the operating system in
- $recorder [1]
- Whether to use the -recorder option to latex and pdflatex. Use
- of this option results in a file of extension .fls containing a
- list of the files that these programs have read and written.
- Latexmk will then use this file to improve its detection of
- source files and generated files after a run of latex or pdfla-
- tex.
- It is generally recommended to use this option (or to configure
- the $recorder variable to be on.) But it only works if
+ 19 January 2017 44
- 17 January 2017 44
+LATEXMK(1) General Commands Manual LATEXMK(1)
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ passing arguments to programs.)
+ $recorder [1]
+ Whether to use the -recorder option to latex and pdflatex. Use
+ of this option results in a file of extension .fls containing a
+ list of the files that these programs have read and written.
+ Latexmk will then use this file to improve its detection of
+ source files and generated files after a run of latex or pdfla-
+ tex.
+ It is generally recommended to use this option (or to configure
+ the $recorder variable to be on.) But it only works if
(pdf)latex supports the -recorder option, which is true for most
current implementations
@@ -2949,6 +2961,19 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
Whether to show CPU time used.
+
+
+
+
+ 19 January 2017 45
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
$silence_logfile_warnings [0]
Whether after a run of (pdf)latex to summarize warnings in the
log file about undefined citations and references. Setting
@@ -2962,18 +2987,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
also set this variable.
Note that multiple occurrences for the same undefined object on
-
-
-
- 17 January 2017 45
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
the same page and same line will be compressed to a single warn-
ing.
@@ -3015,6 +3028,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
environment variables TMPDIR or TEMP exists, otherwise to the
current directory. Under other operating systems (expected to
be UNIX/Linux, including OS-X), the default is the value of the
+
+
+
+ 19 January 2017 46
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
system environment variable TMPDIR if it exists, otherwise
"/tmp".
@@ -3028,18 +3053,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
Note that once a missing file has been made, no further calls to
make will be made on a subsequent run of latexmk to update the
file. Handling this problem is the job of a suitably defined
-
-
-
- 17 January 2017 46
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
Makefile. See the section "USING latexmk WITH make" for how to
do this. The intent of calling make from latexmk is merely to
detect dependencies.
@@ -3081,29 +3094,30 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
specified by the variable %xelatex_input_extensions. The
default extensions are 'tex', 'pdf', 'jpg, and 'png'.
- See details of the %latex_input_extensions for other information
- that equally applies to %xelatex_input_extensions.
- $xelatex_silent_switch ["-interaction=batchmode"]
- Switch(es) for the xelatex program (specified in the variable
- $xelatex) when silent mode is on.
- See details of the $latex_silent_switch for other information
- that equally applies to $xelatex_silent_switch.
+ 19 January 2017 47
+LATEXMK(1) General Commands Manual LATEXMK(1)
- 17 January 2017 47
+ See details of the %latex_input_extensions for other information
+ that equally applies to %xelatex_input_extensions.
+ $xelatex_silent_switch ["-interaction=batchmode"]
+ Switch(es) for the xelatex program (specified in the variable
+ $xelatex) when silent mode is on.
+
+ See details of the $latex_silent_switch for other information
+ that equally applies to $xelatex_silent_switch.
-LATEXMK(1) General Commands Manual LATEXMK(1)
CUSTOM DEPENDENCIES
@@ -3146,6 +3160,18 @@ CUSTOM DEPENDENCIES
tion should return 0 if it was successful and a nonzero number
if it failed.
+
+
+
+ 19 January 2017 48
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
A custom dependency rule is invoked whenever latexmk detects that a run
of latex/pdflatex needs to read a file, like a graphics file, whose
extension is the to-extension of a custom dependency. Then latexmk
@@ -3160,18 +3186,6 @@ CUSTOM DEPENDENCIES
question. Simple cases just involve a subroutine invoking an external
program; this can be done by following the templates below, even by
those without knowledge of the Perl programming language. Of course,
-
-
-
- 17 January 2017 48
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
experts could do something much more elaborate.
One other item in each custom-dependency rule, labeled "must" above,
@@ -3213,6 +3227,17 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
convert your graphics files to pdf format, in which case you would
replace the above code in an initialization file by
+
+
+ 19 January 2017 49
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
add_cus_dep( 'fig', 'pdf, 0, 'fig2pdf' );
sub fig2pdf {
return system( "fig2dev -Lpdf \"$_[0].fig\" \"$_[0].pdf\"" );
@@ -3226,18 +3251,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
normally safer to keep them in. Even though the rules for quoting vary
between operating systems, command shells and individual pieces of
software, the quotes in the above examples do not cause problems in the
-
-
-
- 17 January 2017 49
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
cases I have tested.
Note 2: One case in which the quotes are important is when the files
@@ -3279,6 +3292,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
add_cus_dep('ndx', 'nnd', 0, 'makendx2nnd');
sub makendx2nnd {
+
+
+
+ 19 January 2017 50
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
return system( "makeindex -o \"$_[0].nnd\" \"$_[0].ndx\"" );
}
@@ -3292,18 +3317,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
have actually changed.
Of course if you choose to write random data to the .nnd (or the .aux
-
-
-
- 17 January 2017 50
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
file, etc) that changes on each new run, then you will have a problem.
For real experts: See the %hash_cal_ignore_pattern if you have to deal
with such problems.
@@ -3345,31 +3358,31 @@ ADVANCED CONFIGURATION: Some extra resources and advanced tricks
this is what is used in the rc files.
See also the section DEALING WITH ERRORS, PROBLEMS, ETC. See also the
- examples in the directory example_rcfiles in the latexmk distributions.
- Even if none of the examples apply to your case, they may give ideas
- Variables and subroutines for processing a rule
- A step in the processing is called a rule. One possibility to implement
- the processing of a rule is by a Perl subroutine. This is always the
- case for custom dependencies. Also, for any other rule, you can use a
- subroutine by prefixing the command specification by the word "inter-
- nal" -- see the section FORMAT OF COMMAND SPECIFICATIONS.
- When you use a subroutine for processing a rule, all the possibilities
- of Perl programming are available, of course. In addition, some of
+ 19 January 2017 51
- 17 January 2017 51
+LATEXMK(1) General Commands Manual LATEXMK(1)
+ examples in the directory example_rcfiles in the latexmk distributions.
+ Even if none of the examples apply to your case, they may give ideas
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ Variables and subroutines for processing a rule
+ A step in the processing is called a rule. One possibility to implement
+ the processing of a rule is by a Perl subroutine. This is always the
+ case for custom dependencies. Also, for any other rule, you can use a
+ subroutine by prefixing the command specification by the word "inter-
+ nal" -- see the section FORMAT OF COMMAND SPECIFICATIONS.
+ When you use a subroutine for processing a rule, all the possibilities
+ of Perl programming are available, of course. In addition, some of
latexmk's internal variables and subroutines are available. The ones
listed below are intended to be available to (advanced) users, and
their specifications will generally have stability under upgrades. Gen-
@@ -3411,33 +3424,33 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
rdb_remove_files( $rule, file, ... )
This subroutine removes one or more files from the dependency
- list for the given rule.
- rdb_list_source( $rule )
- This subroutine returns the list of source files (i.e., the
- dependency list) for the given rule.
+ 19 January 2017 52
- rdb_set_source( $rule, file, ... )
- rdb_set_source( $rule, @files ) This subroutine sets the depen-
- dency list for the given rule to be the specified files. Files
- that are already in the list have unchanged information. Files
- that were not in the list are added to it. Files in the
- 17 January 2017 52
+LATEXMK(1) General Commands Manual LATEXMK(1)
+ list for the given rule.
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ rdb_list_source( $rule )
+ This subroutine returns the list of source files (i.e., the
+ dependency list) for the given rule.
- previous dependency list that are not in the newly specified
- list of files are removed from the dependency list.
+ rdb_set_source( $rule, file, ... )
+ rdb_set_source( $rule, @files ) This subroutine sets the depen-
+ dency list for the given rule to be the specified files. Files
+ that are already in the list have unchanged information. Files
+ that were not in the list are added to it. Files in the previ-
+ ous dependency list that are not in the newly specified list of
+ files are removed from the dependency list.
@@ -3477,6 +3490,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
OS-X systems. They may need modifications for other versions of make.
The simplest method is simply to delegate all the relevant tasks to
+
+
+
+ 19 January 2017 53
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
latexmk, as is suitable for a straightforward LaTeX document. For this
a suitable Makefile is like
@@ -3490,18 +3515,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
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,
-
-
-
- 17 January 2017 53
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
where lines such as the above would be only be a small part of a larger
Makefile.
@@ -3543,6 +3556,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
fig2dev -Lpdf $< $@
(Again, the lines containing the commands for the rules should be
+
+
+
+ 19 January 2017 54
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
started with tabs.) This example was inspired by how GNU automake han-
dles automatic dependency tracking of C source files.
@@ -3556,18 +3581,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
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
-
-
-
- 17 January 2017 54
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
for graphics insertions in LaTeX documents. Latexmk is arranged to
output a dependency file after each run. It is given the -recorder
option, which improves its detection of files generated during a run of
@@ -3609,31 +3622,31 @@ BUGS
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
- their standard form to avoid being harvested by worms and viruses.)
-AUTHOR
- Current version, by John Collins (username jcc8 at node psu.edu).
- (Version 4.52b).
- Released version can be obtained from CTAN:
- <http://www.ctan.org/pkg/latexmk/>, and from the author's website
+ 19 January 2017 55
- 17 January 2017 55
+LATEXMK(1) General Commands Manual LATEXMK(1)
-LATEXMK(1) General Commands Manual LATEXMK(1)
+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
+ their standard form to avoid being harvested by worms and viruses.)
+AUTHOR
+ Current version, by John Collins (username jcc8 at node psu.edu).
+ (Version 4.52c).
+ Released version can be obtained from CTAN:
+ <http://www.ctan.org/pkg/latexmk/>, and from the author's website
<http://www.personal.psu.edu/jcc8/latexmk/>.
Modifications and enhancements by Evan McLean (Version 2.0)
Original script called "go" by David J. Musliner (RCS Version 3.2)
@@ -3678,19 +3691,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
-
-
-
-
-
-
-
-
-
-
-
- 17 January 2017 56
+ 19 January 2017 56