diff options
| -rwxr-xr-x | Build/source/texk/texlive/linked_scripts/latexmk/latexmk.pl | 140 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/man/man1/latexmk.1 | 115 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/man/man1/latexmk.man1.pdf | bin | 215634 -> 218127 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/CHANGES | 12 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/INSTALL | 2 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/README | 5 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/example_rcfiles/glossary_latexmkrc | 9 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/latexmk.pdf | bin | 189317 -> 190703 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/latexmk.txt | 2006 | ||||
| -rwxr-xr-x | Master/texmf-dist/scripts/latexmk/latexmk.pl | 140 |
10 files changed, 1352 insertions, 1077 deletions
diff --git a/Build/source/texk/texlive/linked_scripts/latexmk/latexmk.pl b/Build/source/texk/texlive/linked_scripts/latexmk/latexmk.pl index 7dd5dc35e39..ca0c8c3aa4b 100755 --- a/Build/source/texk/texlive/linked_scripts/latexmk/latexmk.pl +++ b/Build/source/texk/texlive/linked_scripts/latexmk/latexmk.pl @@ -162,6 +162,27 @@ use warnings; ## ## 12 Jan 2012 STILL NEED TO DOCUMENT some items below ## +## 26 Dec 2019 John Collins Change place of setting of $view_file +## Make fully consistent set of options for engines: +## -latex, -latex=..., +## preserving backward compatibility, and avoiding suprises. +## 11 Dec 2019 John Collins Change rules for wrapping in log file: This deals +## with xelatex wrapping at > standard number of +## bytes in presence of non-ASCII Unicode characters. +## 4 Dec 2019 John Collins If there were missing subdirectories in output/aux +## directories, and these were successfully created, +## then ignore error from *latex, since rerun may +## succeed. +## 14 Nov 2019 John Collins Add comment. +## 12 Nov 2019 John Collins Use $compiling_cmd, $warning_cmd, $success_cmd +# on normal make, rather than just in -pvc mode. +## 5 Aug 2019 John Collins The changing of '\' to '/' in filenames is now +## done for msys as well as MSWin32. +## 8 Jul 2019 John Collins Allow addition of hook for processing lists of +## missing source files, used after run of *latex. +## 2 Jul 2019 John Collins Silence message about disallowing change of output +## file type. +## V. 4.66 ## 28 Jun 2019 John Collins Try to deal with log file parsing problems ## V. 4.65 ## 21 May 2019 John Collins Fix incorrect listings by -rules and by -deps @@ -233,8 +254,8 @@ use warnings; $my_name = 'latexmk'; $My_name = 'Latexmk'; -$version_num = '4.65'; -$version_details = "$My_name, John Collins, 18 June 2019"; +$version_num = '4.67'; +$version_details = "$My_name, John Collins, 26 Dec. 2019"; use Config; use File::Basename; @@ -359,7 +380,7 @@ $illegal_in_texname = "\x00\t\f\n\r\$%\\~\x7F"; # Hooks for customized extra processing on aux files. The following -# variable is an array of references to function. Each function is +# variable is an array of references to functions. Each function is # invoked in turn when a line of an aux file is processed (if none # of the built-in actions have been done). On entry to the function, # the following variables are set: @@ -367,6 +388,15 @@ $illegal_in_texname = "\x00\t\f\n\r\$%\\~\x7F"; # $rule = name of rule during the invocation of which, the aux file # was supposed to have been generated. @aux_hooks = (); +# Hooks for customized processing on lists of source and missing files. +# The following variable is an array of references to functions. Each +# function is invoked in turn after a run of latex (or pdflatex etc) and +# latexmk has analyzed the .log and .fls files for dependency information. +# On entry to each called function, the following variables are set: +# $rule = name of *latex rule +# %dependents: maps source files and possible source files to a status. +# See begining of sub parse_log for possible values. +@latex_file_hooks = (); ######################################################################### ## Default document processing programs, and related settings, @@ -1739,6 +1769,11 @@ while ($_ = $ARGV[0]) } elsif (/^-l$/) { $landscape_mode = 1; } elsif (/^-l-$/) { $landscape_mode = 0; } + elsif ( /^-latex$/ ) { + $pdf_mode = 0; + $postscript_mode = 0; + $dvi_mode = 1; + } elsif (/^-latex=(.*)$/) { $latex = $1; } @@ -1752,6 +1787,11 @@ while ($_ = $ARGV[0]) { $silence_logfile_warnings = 0; } elsif ( /^-logfilewarninglist-$/ || /^-logfilewarnings-$/ ) { $silence_logfile_warnings = 1; } + elsif ( /^-lualatex$/ || /^-pdflualatex$/ ) { + $pdf_mode = 4; + $dvi_mode = $postscript_mode = 0; + } +# See below for -lualatex=... # See above for -M elsif (/^-MF$/) { if ( $ARGV[0] eq '' ) { @@ -1785,18 +1825,18 @@ while ($_ = $ARGV[0]) elsif (/^-pdflua$/){ $pdf_mode = 4; } elsif (/^-pdfps$/) { $pdf_mode = 2; } elsif (/^-pdfxe$/) { $pdf_mode = 5; } -# elsif (/^-pdflatex$/) { -# $pdflatex = "pdflatex %O %S"; -# $pdf_mode = 1; -# $dvi_mode = $postscript_mode = 0; -# } + elsif (/^-pdflatex$/) { + $pdflatex = "pdflatex %O %S"; + $pdf_mode = 1; + $dvi_mode = $postscript_mode = 0; + } elsif (/^-pdflatex=(.*)$/) { $pdflatex = $1; } - elsif (/^-pdflualatex=(.*)$/) { + elsif ( /^-pdflualatex=(.*)$/ || /^-lualatex=(.*)$/ ) { $lualatex = $1; } - elsif (/^-pdfxelatex=(.*)$/) { + elsif ( /^-pdfxelatex=(.*)$/ || /^-xelatex=(.*)$/ ) { $xelatex = $1; } elsif (/^-pretex=(.*)$/) { @@ -1873,14 +1913,11 @@ while ($_ = $ARGV[0]) elsif (/^-view=ps$/) { $view = "ps";} elsif (/^-view=pdf$/) { $view = "pdf"; } elsif (/^-Werror$/){ $warnings_as_errors = 1; } - elsif (/^-lualatex$/) { - $pdf_mode = 4; - $dvi_mode = $postscript_mode = 0; - } - elsif (/^-xelatex$/) { + elsif ( /^-xelatex$/ || /^-pdfxelatex$/ ) { $pdf_mode = 5; $dvi_mode = $postscript_mode = 0; } +# See above for -xelatex=... elsif (/^-e$/) { if ( $#ARGV < 0 ) { &exit_help( "No code to execute specified after -e switch"); @@ -2267,8 +2304,10 @@ if ( $dvi_mode || $postscript_mode # the only destinations. So if ps or dvi files needed, we cannot # allow switching. (There will then be an error condition if a TeX # engine fails to produce the correct type of output file.) - warn "$My_name: Disallowing switch of output file as incompatible\n", - " with file requests.\n"; + if ($diagnostics) { + warn "$My_name: Disallowing switch of output file as incompatible\n", + " with file requests.\n"; + } $can_switch = 0; } @@ -2417,7 +2456,9 @@ foreach $filename ( @file_list ) # but %rule_db is needed in the continue block, which is not in the # scope of a local declaration here. &rdb_initialize_rules; - + $view_file = ''; + rdb_one_rule( 'view', sub{ $view_file = $$Psource; } ); + if ( $cleanup_mode > 0 ) { # ?? MAY NEED TO FIX THE FOLLOWING IF $aux_dir or $out_dir IS SET. my %other_generated = (); @@ -2645,6 +2686,7 @@ foreach $filename ( @file_list ) #Initialize failure flags now. $failure = 0; $failure_msg = ''; + if ($compiling_cmd) { Run_subst( $compiling_cmd ); } $failure = &rdb_make; if ( ( $failure <= 0 ) || $force_mode ) { rdb_for_some( [keys %one_time], \&rdb_run1 ); @@ -2656,7 +2698,13 @@ foreach $filename ( @file_list ) $failure_msg = "Warning(s) from latex (or c.) for '$filename'; treated as error"; } } - if ($failure > 0) { next FILE; } + + if ($failure > 0) { + if ($failure_cmd) { Run_subst( $failure_cmd ); } + next FILE; + } else { + if ($success_cmd) { Run_subst( $success_cmd ); } + } } # end FILE continue { if ($deps_handle) { deps_list($deps_handle); } @@ -2755,7 +2803,7 @@ sub test_fix_texnames { my $unbalanced_quote = 0; my $balanced_quote = 0; foreach (@_) { - if ( $^O eq "MSWin32" ) { + if ( ($^O eq "MSWin32") || ($^O eq "msys") ) { # On MS-Win, change directory separator '\' to '/', as needed # by the TeX engines, for which '\' introduces a macro name. # Remember that '/' is a valid directory separator in MS-Win. @@ -3461,9 +3509,6 @@ sub make_preview_continuous { $quell_uptodate_msgs = 1; - local $view_file = ''; - rdb_one_rule( 'view', sub{ $view_file = $$Psource; } ); - if ( ($view eq 'dvi') || ($view eq 'pdf') || ($view eq 'ps') ) { warn "Viewing $view\n"; } @@ -3528,8 +3573,6 @@ CHANGE: } $failure = &rdb_make; -## warn "=========Viewer PID = $$Pviewer_process; updated=$updated\n"; - if ( $MSWin_fudge_break && ($^O eq "MSWin32") ) { $SIG{BREAK} = $SIG{INT} = 'DEFAULT'; } @@ -4538,8 +4581,12 @@ sub parse_log { } } else { - # LuaTeX sometimes wraps at 80 instead of 79, so work around this - while ( ( ($len == $log_wrap) || ( ($engine eq 'LuaTeX') && ($len == $log_wrap+1) ) ) + # Xetex and luatex sometimes wrap at longer line lengths: + # LuaTeX sometimes at 80. Xetex 80 or longer with non-ascii characters. + while ( ( ($len == $log_wrap) + || ( ($engine eq 'LuaTeX') && ($len == $log_wrap+1) ) + || ( ($engine eq 'XeTeX') && ($len >= $log_wrap+1) ) + ) && !eof($log_file) ) { push @lines, $_; my $extra = <$log_file>; @@ -5893,9 +5940,10 @@ sub rdb_read_set_rule { warn " ===== CHANGING output type from '$newext' to '$oldext' in '$rule'\n"; my $switch_error = switch_output( $oldext, $newext ); if ($switch_error) { - warn " I could not accommodate the changed output extension\n", - " (either because the configuration does not allow it\n", - " or because there is a conflict with requested filetypes).\n", + warn " I could not accommodate the changed output extension.\n", + " That is either because the configuration does not allow it\n", + " or because there is a conflict with implicit or explicit requested filetypes.\n", + " (Typically that is about .dvi and/or .ps filetypes.)\n", "===> There may be subsequent warnings, which may or may not be ignorable.\n", "===> If necessary, clean out generated files and try again\n"; } @@ -6124,7 +6172,7 @@ sub rdb_set_latex_deps { } &parse_log; - $missing_dirs = 'none'; # Status of missing directories + my $missing_dirs = 'none'; # Status of missing directories if (@missing_subdirs) { $missing_dirs = 'success'; if ($allow_subdir_creation) { @@ -6424,6 +6472,10 @@ NEW_SOURCE: } } + foreach my $Psub (@latex_file_hooks) { + &$Psub; + } + # Some packages (e.g., bibtopic) generate a dummy error-message-providing # bbl file when a bbl file does not exist. Then the fls and log files # show the bbl file as created by the primary run and hence as a @@ -6470,6 +6522,8 @@ NEW_SOURCE: } rdb_remove_files( $rule, @files_not_needed ); + return ($missing_dirs, [@missing_subdirs] ); + } # END rdb_set_latex_deps #************************************************************ @@ -7949,7 +8003,7 @@ sub rdb_primary_run { } # Find current set of source files: - &rdb_set_latex_deps; + my ($missing_dirs, $PA_missing_subdirs) = &rdb_set_latex_deps; # For each file of the kind made by epstopdf.sty during a run, # if the file has changed during a run, then the new version of @@ -7981,6 +8035,12 @@ sub rdb_primary_run { if (! $silent); $return = 0; } + if ($return_latex && ($missing_dirs ne 'none') ) { + print "Error in (pdf)LaTeX, but needed subdirectories in output directory\n", + " were missing and successfully created, so try again.\n" + if (! $silent); + $return = 0; + } # Summarize issues that may have escaped notice: @primary_warning_summary = (); if ($bad_reference) { @@ -9363,6 +9423,22 @@ sub add_aux_hook { #################################################### +sub add_latex_file_hook { + # Usage: add_latex_file_hook( sub_name ) + # Add the name subroutine to the array of hooks for + # processing list of possible dependency files after a run of *latex. + # The argument is either a string naming the subroutine, e.g. + # add_latex_file_hook( 'subname' ); + # or a Perl reference to the subroutine, e.g., + # add_latex_file_hook( \&subname ); + # It is also possible to use an anonymous subroutine, e.g., + # add_latex_file_hook( sub{ code of subroutine... } ); + my ($sub_name) = @_; + push @latex_file_hooks, $sub_name; +} + +#################################################### + sub set_input_ext { # Usage: set_input_ext( rule, ext, ... ) # Set list of extension(s) (specified without a leading period) diff --git a/Master/texmf-dist/doc/man/man1/latexmk.1 b/Master/texmf-dist/doc/man/man1/latexmk.1 index 5c00bafa438..5c8ff04439e 100644 --- a/Master/texmf-dist/doc/man/man1/latexmk.1 +++ b/Master/texmf-dist/doc/man/man1/latexmk.1 @@ -1,4 +1,4 @@ -.TH LATEXMK 1 "18 June 2019" "" +.TH LATEXMK 1 "26 December 2019" "" .SH NAME latexmk \- generate LaTeX document .SH SYNOPSIS @@ -609,6 +609,14 @@ automatically. Turn off \fB-l\fR. .TP +.B -latex +This sets the generation of dvi files by \fIlatex\fR, and turns off the +generation of pdf and ps files. + +\fINote: to set the \fRcommand\fI used when latex is specified, see the +\fB-latex="COMMAND"\fI option.\fR + +.TP .B -latex="COMMAND" This sets the string specifying the command to run latex, and is typically used to add desired options. Since the string normally @@ -622,6 +630,10 @@ operating system and the command-line shell you are using, you may need to change the single quotes to double quotes (or something else). +\fINote: This option when provided with the COMMAND argument only sets the +command for invoking latex; it does not turn on the use of +latex. That is done by other options or in an initialization file.\fR + To set the command for running \fIpdflatex\fR (rather than the command for \fIlatex\fR) see the \fB-pdflatex\fR option. @@ -655,6 +667,16 @@ but not its intended effect, differ from some earlier versions of \fIlatexmk\fR.) .TP +.B -lualatex="COMMAND" +This sets the string specifying the command to run \fIlualatex\fR. It +behaves like the \fB-pdflatex\fR option, but sets the variable +\fI$lualatex\fR. + +\fINote: This option when provided with the COMMAND argument only sets the +command for invoking lualatex; it does not turn on the use of +lualatex. That is done by other options or in an initialization file.\fR + +.TP .B -M Show list of dependent files after processing. This is equivalent to the \fB-deps\fR option. @@ -771,13 +793,14 @@ an .xdv file rather than a pdf file directly. Only after possibly multiple runs to generate a fully up-to-date .xdv file does \fIlatexmk\fR then call \fIxdvipdfmx\fR to generate the final .pdf file. -(\fINote:\fR When the document includes large graphics files, -especially .png files, the last step can be quite time consuming, even -when the creation of the .xdv file by \fIxelatex\fR is fast. So the -use of the intermediate .xdv file can result in substantial gains in -procesing time, since the .pdf file is produced once rather than on -every run of \fIxelatex\fR. See the documentation on the \fB-pdfxe\fR -option for why an .xdv file is used. +(\fINote:\fR The reason why \fIlatexmk\fR arranges for \fIxelatex\fR to +make an .xdv file instead of the \fIxelatex\fR's default of a .pdf file is +as follows: When the document includes large graphics files, +especially .png files, the production of a .pdf file can be quite time +consuming, even when the creation of the .xdv file by \fIxelatex\fR is +fast. So the use of the intermediate .xdv file can result in substantial +gains in procesing time, since the .pdf file is produced once rather than +on every run of \fIxelatex\fR.) .TP .B -pdf- @@ -793,6 +816,14 @@ precisely, whatever program is configured to be used in the \fI$latex\fR configuration variable). .TP +.B -pdflatex +This sets the generation of pdf files by \fIpdflatex\fR, and turns off the +generation of dvi and ps files. + +\fINote: to set the \fRcommand\fI used when pdflatex is specified, see the +\fB-pdflatex="COMMAND"\fI option.\fR + +.TP .B -pdflatex="COMMAND" This sets the string specifying the command to run \fIpdflatex\fR, and is typically used to add desired options. Since the string normally @@ -808,30 +839,20 @@ operating system and the command-line shell you are using, you may need to change the single quotes to double quotes (or something else). +\fINote: This option when provided with the COMMAND argument only sets the +command for invoking pdflatex; it does not turn on the use of +pdflatex. That is done by other options or in an initialization file.\fR + To set the command for running \fIlatex\fR (rather than the command for \fIpdflatex\fR) see the \fB-latex\fR option. .TP .B -pdflualatex="COMMAND" -This sets the string specifying the command to run \fIlualatex\fR. It -behaves like the \fB-pdflatex\fR option, but sets the variable -\fI$lualatex\fR. +Equivalent to \fB-lualatex="COMMAND"\fR. .TP .B -pdfxelatex="COMMAND" -This sets the string specifying the command to run \fIxelatex\fR. It -behaves like the \fB-pdflatex\fR option, but sets the variable -\fI$xelatex\fR. - -\fIWarning\fR: It is important to ensure that the -no-pdf is used when -\fIxelatex\fR is invoked; see the explanation for the variable -\fI$xelatex\fR for why this is necessary. If you provide %O in the -command specification, this will be done automatically. - -An example of the use of the \fB-pdfxelatex\fR option: - - latexmk -pdfxe -pdfxelatex="xelatex --shell-escape %O %S" foo.tex - +Equivalent to \fB-xelatex="COMMAND"\fR. .TP .B -pretex=CODE @@ -1188,11 +1209,28 @@ but not its intended primary effect, differ from some earlier versions of \fIlatexmk\fR. \fILatexmk\fR first uses \fIxelatex\fR to make an .xdv file, and does all the extra runs needed (including those of \fIbibtex\fR, etc). Only after that does it make the pdf file from -the .xdv file, using \fIxdvipdfmx\fR. This procedure can result in -considerable savings in run time, since the xdv-to-pdf conversion is -quite time-consuming when large graphics files are used in the -document.] +the .xdv file, using \fIxdvipdfmx\fR. See the documentation for the +\fB-pdfxe\fR for why this is done.] + +.TP +.B -xelatex="COMMAND" +This sets the string specifying the command to run \fIxelatex\fR. It sets +the variable \fI$xelatex\fR. + +\fIWarning\fR: It is important to ensure that the \fB-no-pdf\fR is used +when \fIxelatex\fR is invoked, since \fIlatexmk\fR expects \fIxelatex\fR to +produce an .xdv file, not a .pdf file. If you provide %O in the command +specification, this will be done automatically. See the documentation for +the \fB-pdfxe\fR option for why \fIlatexmk\fR makes a .xdv file rather than +a .pdf file when \fIxelatex\fR is used. + +An example of the use of the \fB-pdfxelatex\fR option: + + latexmk -pdfxe -pdfxelatex="xelatex --shell-escape %O %S" foo.tex +\fINote: This option when provided with the COMMAND argument only sets the +command for invoking lualatex; it does not turn on the use of +lualatex. That is done by other options or in an initialization file.\fR .PP \fBCompatibility between options\fR @@ -2041,10 +2079,11 @@ relative to the directory specified by \fI$out_dir\fR. .B $compiling_cmd [""], $failure_cmd [""], $warning_cmd [""], $success_cmd [""] These variables specify commands that are executed at certain points -of compilations during preview-continuous mode. One motivation for +of compilations. One motivation for their existance is to allow very useful convenient visual indications of compilation status even when the window receiving the screen output of -the compilation is hidden. +the compilation is hidden. This is particularly useful in +preview-continuous mode. The commands are executed at the following points: \fI$compiling_cmd\fR at the start of compilation, \fI$success_cmd\fR @@ -3157,12 +3196,14 @@ when the \fIxelatex\fR program is called for. See the documentation of the \fB-xelatex\fR option for some special properties of \fIlatexmk\fR's use of \fIxelatex\fR. -\fINote about xelatex\fR: Now \fIlatexmk\fR uses \fIxelatex\fR to make -an .xdv rather than .pdf file, with the .pdf file being created in a -separate step. This is enforced by the use of the \fB-no-pdf\fR -option. If %O is part of the command for invoking \fIxelatex\fR, then -\fIlatexmk\fR will insert the \fB-no-pdf\fR option automatically, -otherwise you must provide the option yourself +\fINote about xelatex\fR: \fIlatexmk\fR uses \fIxelatex\fR to make an .xdv +rather than .pdf file, with the .pdf file being created in a separate step. +This is enforced by the use of the \fB-no-pdf\fR option. If %O is part of +the command for invoking \fIxelatex\fR, then \fIlatexmk\fR will insert the +\fB-no-pdf\fR option automatically, otherwise you must provide the option +yourself. See the documentation for the \fB-pdfxe\fR option for why +\fIlatexmk\fR makes a .xdv file rather than a .pdf file when \fIxelatex\fR +is used. To do a coordinated setting of all of \fI$latex\fR, \fI$pdflatex\fR, \fI$lualatex\fR, and \fI$xelatex\fR, see the section "Advanced @@ -3801,7 +3842,7 @@ e-mail addresses are not written in their standard form to avoid being harvested too easily.) .SH AUTHOR Current version, by John Collins (username jcc8 at node psu.edu). -(Version 4.65). +(Version 4.67). Released version can be obtained from CTAN: <http://www.ctan.org/pkg/latexmk/>, and from the diff --git a/Master/texmf-dist/doc/man/man1/latexmk.man1.pdf b/Master/texmf-dist/doc/man/man1/latexmk.man1.pdf Binary files differindex 7fa2ff5d5a5..dfbebf8e086 100644 --- a/Master/texmf-dist/doc/man/man1/latexmk.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/latexmk.man1.pdf diff --git a/Master/texmf-dist/doc/support/latexmk/CHANGES b/Master/texmf-dist/doc/support/latexmk/CHANGES index b3ef76ac63e..e725708982d 100644 --- a/Master/texmf-dist/doc/support/latexmk/CHANGES +++ b/Master/texmf-dist/doc/support/latexmk/CHANGES @@ -690,3 +690,15 @@ From v. 4.64 to 4.64a From v. 4.64a to 4.65 Fix incorrect parsing of long quoted filenames in log file that sometimes prevented latexmk from running. + +From v. 4.65 to 4.67 + Improve parsing of long lines in log file, especially with UTF-8 filenames + and xelatex. + Minor diagnostic improvements + Allow addition of hook for processing lists of missing source files. + Changing of '\' to '/' in filenames is done for msys as well as MSWin32. + Use $compiling_cmd, $warning_cmd, $success_cmd on normal make, rather + than just in -pvc mode. + If there were missing subdirectories in output/aux directories, and these + were successfully created, then ignore error from *latex, since rerun + may succeed. diff --git a/Master/texmf-dist/doc/support/latexmk/INSTALL b/Master/texmf-dist/doc/support/latexmk/INSTALL index 9cb537bfccd..d22e5155d72 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.65, 18 June 2019) + (Version 4.67, 26 December 2019) John Collins Physics Department diff --git a/Master/texmf-dist/doc/support/latexmk/README b/Master/texmf-dist/doc/support/latexmk/README index 3353af467f6..b2293796aaf 100644 --- a/Master/texmf-dist/doc/support/latexmk/README +++ b/Master/texmf-dist/doc/support/latexmk/README @@ -1,4 +1,4 @@ -Latexmk, version 4.65, 18 June 2019 +Latexmk, version 4.67, 26 December 2019 ----------------------------------- Latexmk completely automates the process of generating a LaTeX @@ -87,7 +87,8 @@ NOTES:- John Collins ---------------------------- "latexmk -h" ---------------------------- -Latexmk 4.65: Automatic LaTeX document generation routine +===== Set bibtex_fudge = 0 === +Latexmk 4.67: Automatic LaTeX document generation routine Usage: latexmk [latexmk_options] [filename ...] diff --git a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/glossary_latexmkrc b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/glossary_latexmkrc index 2c15e9aac67..5c757f5b43c 100644 --- a/Master/texmf-dist/doc/support/latexmk/example_rcfiles/glossary_latexmkrc +++ b/Master/texmf-dist/doc/support/latexmk/example_rcfiles/glossary_latexmkrc @@ -13,9 +13,12 @@ add_cus_dep( 'glo', 'gls', 0, 'makeglossaries' ); $clean_ext .= " acr acn alg glo gls glg"; sub makeglossaries { - my ($name, $path) = fileparse( $$Psource ); - return system "makeglossaries -d '$path' '$name'"; - } + my ($base_name, $path) = fileparse( $_[0] ); + pushd $path; + my $return = system "makeglossaries", $base_name; + popd; + return $return; + } # 2. If you use the OBSOLETE glossary package, then you can do diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.pdf b/Master/texmf-dist/doc/support/latexmk/latexmk.pdf Binary files differindex 92acf17b3b3..ba3c93215ea 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 6f625423802..562501fb4fc 100644 --- a/Master/texmf-dist/doc/support/latexmk/latexmk.txt +++ b/Master/texmf-dist/doc/support/latexmk/latexmk.txt @@ -61,7 +61,7 @@ DESCRIPTION - 18 June 2019 1 + 26 December 2019 1 @@ -127,7 +127,7 @@ LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE - 18 June 2019 2 + 26 December 2019 2 @@ -193,7 +193,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 3 + 26 December 2019 3 @@ -259,7 +259,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 4 + 26 December 2019 4 @@ -325,7 +325,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 5 + 26 December 2019 5 @@ -391,7 +391,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 6 + 26 December 2019 6 @@ -457,7 +457,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 7 + 26 December 2019 7 @@ -523,7 +523,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 8 + 26 December 2019 8 @@ -589,7 +589,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 9 + 26 December 2019 9 @@ -655,7 +655,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 10 + 26 December 2019 10 @@ -703,6 +703,13 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -l- Turn off -l. + -latex This sets the generation of dvi files by latex, and turns off + the generation of pdf and ps files. + + Note: to set the command used when latex is specified, see the + -latex="COMMAND" option. + + -latex="COMMAND" This sets the string specifying the command to run latex, and is typically used to add desired options. Since the string nor- @@ -711,17 +718,10 @@ LATEXMK(1) General Commands Manual LATEXMK(1) latexmk -latex="latex --shell-escape %O %S" foo.tex The specification of the contents of the string are the same as - for the $latex configuration variable. Depending on your oper- - ating system and the command-line shell you are using, you may - need to change the single quotes to double quotes (or something - else). - - To set the command for running pdflatex (rather than the command - for latex) see the -pdflatex option. - 18 June 2019 11 + 26 December 2019 11 @@ -730,35 +730,72 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) + for the $latex configuration variable. Depending on your oper- + ating system and the command-line shell you are using, you may + need to change the single quotes to double quotes (or something + else). + + Note: This option when provided with the COMMAND argument only + sets the command for invoking latex; it does not turn on the use + of latex. That is done by other options or in an initialization + file. + + To set the command for running pdflatex (rather than the command + for latex) see the -pdflatex option. + + -logfilewarninglist -logfilewarnings After a run of (pdf)latex, give a list of warn- - ings about undefined citations and references (unless silent + ings about undefined citations and references (unless silent mode is on). See also the $silence_logfile_warnings configuration variable. -logfilewarninglist- - -logfilewarnings- After a run of (pdf)latex, do not give a list + -logfilewarnings- After a run of (pdf)latex, do not give a list of warnings about undefined citations and references. (Default) See also the $silence_logfile_warnings configuration variable. -lualatex - Use lualatex. That is, use lualatex to process the source - file(s) to pdf. The generation of dvi and postscript files is + Use lualatex. That is, use lualatex to process the source + file(s) to pdf. The generation of dvi and postscript files is turned off. This option is equivalent to using the following set of options -pdflua -dvi- -ps- - (Note: Note that the method of implementation of this option, - but not its intended effect, differ from some earlier versions + (Note: Note that the method of implementation of this option, + but not its intended effect, differ from some earlier versions of latexmk.) + -lualatex="COMMAND" + This sets the string specifying the command to run lualatex. It + behaves like the -pdflatex option, but sets the variable $luala- + tex. + + Note: This option when provided with the COMMAND argument only + sets the command for invoking lualatex; it does not turn on the + use of lualatex. That is done by other options or in an initial- + ization file. + + + + + + 26 December 2019 12 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + -M Show list of dependent files after processing. This is equiva- lent to the -deps option. @@ -785,17 +822,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) option turns off the default behavior. - - - 18 June 2019 12 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - -new-viewer- The inverse of the -new-viewer option. It puts latexmk in its normal behavior that in preview-continuous mode it checks for an @@ -824,6 +850,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) See also the -auxdir/-aux-directory options, and the $aux_dir, $out_dir, and $search_path_separator configuration variables of + + + + 26 December 2019 13 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + latexmk. In particular, see the documentation of $out_dir for some complications on what directory names are suitable. @@ -852,16 +890,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) turns them off. - - 18 June 2019 13 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - -pdf Generate pdf version of document using pdflatex. (If you wish to use lualatex or xelatex, you can use whichever of the options -pdflua, -pdfxe, -lualatex or -xelatex applies.) To configure @@ -888,27 +916,48 @@ LATEXMK(1) General Commands Manual LATEXMK(1) multiple runs to generate a fully up-to-date .xdv file does la- texmk then call xdvipdfmx to generate the final .pdf file. - (Note: When the document includes large graphics files, espe- - cially .png files, the last step can be quite time consuming, - even when the creation of the .xdv file by xelatex is fast. So - the use of the intermediate .xdv file can result in substantial - gains in procesing time, since the .pdf file is produced once - rather than on every run of xelatex. See the documentation on - the -pdfxe option for why an .xdv file is used. - -pdf- Turn off generation of pdf version of document. (This can be - used to override a setting in a configuration file. It may get + + 26 December 2019 14 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + + (Note: The reason why latexmk arranges for xelatex to make an + .xdv file instead of the xelatex's default of a .pdf file is as + follows: When the document includes large graphics files, espe- + cially .png files, the production of a .pdf file can be quite + time consuming, even when the creation of the .xdv file by xela- + tex is fast. So the use of the intermediate .xdv file can re- + sult in substantial gains in procesing time, since the .pdf file + is produced once rather than on every run of xelatex.) + + + -pdf- Turn off generation of pdf version of document. (This can be + used to override a setting in a configuration file. It may get overridden if some other option requires the generation of a pdf file.) - If after all options have been processed, pdf generation is - still turned off, then generation of a dvi file will be turned + If after all options have been processed, pdf generation is + still turned off, then generation of a dvi file will be turned on, and then the program used to compiled a document will be la- - tex (or, more precisely, whatever program is configured to be + tex (or, more precisely, whatever program is configured to be used in the $latex configuration variable). + -pdflatex + This sets the generation of pdf files by pdflatex, and turns off + the generation of dvi and ps files. + + Note: to set the command used when pdflatex is specified, see + the -pdflatex="COMMAND" option. + + -pdflatex="COMMAND" This sets the string specifying the command to run pdflatex, and is typically used to add desired options. Since the string nor- @@ -917,49 +966,40 @@ LATEXMK(1) General Commands Manual LATEXMK(1) latexmk -pdf -pdflatex="pdflatex --shell-escape %O %S" foo.tex + The specification of the contents of the string are the same as + for the $pdflatex configuration variable. (The option -pdflatex + in fact sets the variable $pdflatex.) Depending on your operat- + ing system and the command-line shell you are using, you may + need to change the single quotes to double quotes (or something + else). + Note: This option when provided with the COMMAND argument only + sets the command for invoking pdflatex; it does not turn on the + use of pdflatex. That is done by other options or in an initial- + ization file. - 18 June 2019 14 - - + To set the command for running latex (rather than the command + for pdflatex) see the -latex option. -LATEXMK(1) General Commands Manual LATEXMK(1) - The specification of the contents of the string are the same as - for the $pdflatex configuration variable. (The option -pdflatex - in fact sets the variable $pdflatex.) Depending on your operat- - ing system and the command-line shell you are using, you may - need to change the single quotes to double quotes (or something - else). + 26 December 2019 15 - To set the command for running latex (rather than the command - for pdflatex) see the -latex option. - -pdflualatex="COMMAND" - This sets the string specifying the command to run lualatex. It - behaves like the -pdflatex option, but sets the variable $luala- - tex. - -pdfxelatex="COMMAND" - This sets the string specifying the command to run xelatex. It - behaves like the -pdflatex option, but sets the variable $xela- - tex. +LATEXMK(1) General Commands Manual LATEXMK(1) - Warning: It is important to ensure that the -no-pdf is used when - xelatex is invoked; see the explanation for the variable $xela- - tex for why this is necessary. If you provide %O in the command - specification, this will be done automatically. - An example of the use of the -pdfxelatex option: + -pdflualatex="COMMAND" + Equivalent to -lualatex="COMMAND". - latexmk -pdfxe -pdfxelatex="xelatex --shell-escape %O %S" - foo.tex + -pdfxelatex="COMMAND" + Equivalent to -xelatex="COMMAND". -pretex=CODE @@ -982,18 +1022,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) latexmk -usepretex='\AtBeginDocument{Message\par}' foo.tex - - - - 18 June 2019 15 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - If you already have a suitable command configured, you only need latexmk -pretex='\AtBeginDocument{Message\par}' foo.tex @@ -1020,6 +1048,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -pF Postscript file filtering. The argument to this option is a filter which will generate a filtered postscript file with the + + + + 26 December 2019 16 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + extension ".psF". All extra processing (e.g. preview, printing) will then be performed on this filtered postscript file. @@ -1048,18 +1088,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -pv- Turn off -pv. - - - - 18 June 2019 16 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - -pvc Run a file previewer and continually update the .dvi, .ps, and/or .pdf files whenever changes are made to source files (see the Description above). Which of these files is generated and @@ -1087,6 +1115,17 @@ LATEXMK(1) General Commands Manual LATEXMK(1) mode. It is better to use a different viewer: SumatraPDF and gsview are good possibilities. + + + 26 December 2019 17 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + There are some other methods for arranging an update, notably useful for many versions of xdvi and xpdf. These are best set in latexmk's configuration; see below. @@ -1114,18 +1153,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Don't do timeout in pvc mode after inactivity. - - - - 18 June 2019 17 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - -pvctimeoutmins=<time> Set period of inactivity in minutes for pvc timeout. @@ -1153,6 +1180,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) during latexmk's parsing of its command line. See the -e option for a way of giving initialization code directly on latexmk's command line. An error results in latexmk stopping. Multiple + + + + 26 December 2019 18 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + instances of the -r and -e options can be used, and they are ex- ecuted in the order they appear on the command line. @@ -1182,16 +1221,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) processing. (This is the default.) - - 18 June 2019 18 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - -showextraoptions Show the list of extra latex and pdflatex options that latexmk recognizes, but that it simply passes through to the programs @@ -1217,6 +1246,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -recorder) that trigger special actions or behavior by latexmk itself as well as being passed in some form to the called latex and pdflatex program, or that affect other programs as well. + + + + 26 December 2019 19 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + These options do have entries in this documentation. These op- tions are: -jobname=STRING, -aux-directory=dir, -output-direc- tory=DIR, -quiet, and -recorder. @@ -1247,17 +1288,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Sets the commands for latex, etc, so that they are the standard ones. This is useful to override special configurations. - - - 18 June 2019 19 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - The result is that $latex = 'latex %O %S', and similarly for $pdflatex, $lualatex, and $xelatex. (The option -no-pdf needed for $xelatex is provided automatically, given that %O appears in @@ -1282,6 +1312,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) gram to try to make the missing files. Note that the filename may be specified without an extension, + + + + 26 December 2019 20 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + 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 @@ -1312,18 +1354,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -usepretex=CODE Equivalent to -pretex=CODE -usepretex. Example - - - - 18 June 2019 20 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - latexmk -usepretex='\AtBeginDocument{Message\par}' foo.tex @@ -1348,6 +1378,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) be opened. + + + + 26 December 2019 21 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + -Werror This causes latexmk to return a non-zero status code if any of the files processed gives a warning about problems with cita- @@ -1374,23 +1416,45 @@ LATEXMK(1) General Commands Manual LATEXMK(1) versions of latexmk. Latexmk first uses xelatex to make an .xdv file, and does all the extra runs needed (including those of bibtex, etc). Only after that does it make the pdf file from - the .xdv file, using xdvipdfmx. This procedure can result in - considerable savings in run time, since the xdv-to-pdf conver- - sion is quite time-consuming when large graphics files are used - in the document.] + the .xdv file, using xdvipdfmx. See the documentation for the + -pdfxe for why this is done.] + -xelatex="COMMAND" + This sets the string specifying the command to run xelatex. It + sets the variable $xelatex. - 18 June 2019 21 + Warning: It is important to ensure that the -no-pdf is used when + xelatex is invoked, since latexmk expects xelatex to produce an + .xdv file, not a .pdf file. If you provide %O in the command + specification, this will be done automatically. See the docu- + mentation for the -pdfxe option for why latexmk makes a .xdv + file rather than a .pdf file when xelatex is used. + An example of the use of the -pdfxelatex option: + latexmk -pdfxe -pdfxelatex="xelatex --shell-escape %O %S" + foo.tex + Note: This option when provided with the COMMAND argument only + sets the command for invoking lualatex; it does not turn on the + use of lualatex. That is done by other options or in an initial- + ization file. + + + Compatibility between options + + + + + 26 December 2019 22 -LATEXMK(1) General Commands Manual LATEXMK(1) - Compatibility between options + +LATEXMK(1) General Commands Manual LATEXMK(1) + 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 @@ -1445,9 +1509,11 @@ DEALING WITH ERRORS, PROBLEMS, ETC of latexmk's behavior is configurable to deal with particular situa- tions. (But there is a lot of reading!) + The remainder of these notes consists of ideas for dealing with more + - 18 June 2019 22 + 26 December 2019 23 @@ -1456,7 +1522,6 @@ DEALING WITH ERRORS, PROBLEMS, ETC LATEXMK(1) General Commands Manual LATEXMK(1) - The remainder of these notes consists of ideas for dealing with more difficult situations. d. Further tricks can involve replacing the standard commands that la- @@ -1510,10 +1575,11 @@ ALLOWING FOR CHANGE OF OUTPUT FILE TYPE tion. The difference in output file type can happen for two reasons: One is that for latex, pdflatex and lualatex the document itself can override the defaults. The other is that there may be a configuration, + or misconfiguration, such that the program that latexmk invokes to - 18 June 2019 23 + 26 December 2019 24 @@ -1522,10 +1588,9 @@ ALLOWING FOR CHANGE OF OUTPUT FILE TYPE LATEXMK(1) General Commands Manual LATEXMK(1) - or misconfiguration, such that the program that latexmk invokes to com- - pile the document is not the expected one, or is given options incom- - patible with what latexmk initially expects. (E.g., the -output-for- - mat=... option could be used with lualatex, or xelatex gets invoked + compile the document is not the expected one, or is given options in- + compatible with what latexmk initially expects. (E.g., the -output- + format=... option could be used with lualatex, or xelatex gets invoked without the -no-pdf option.) Under latex and pdflatex, control of the output format by the document @@ -1579,7 +1644,8 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 24 + + 26 December 2019 25 @@ -1645,7 +1711,7 @@ CONFIGURATION/INITIALIZATION (RC) FILES - 18 June 2019 25 + 26 December 2019 26 @@ -1711,7 +1777,7 @@ HOW TO SET VARIABLES IN INITIALIZATION FILES - 18 June 2019 26 + 26 December 2019 27 @@ -1777,7 +1843,7 @@ FORMAT OF COMMAND SPECIFICATIONS - 18 June 2019 27 + 26 December 2019 28 @@ -1843,7 +1909,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 28 + 26 December 2019 29 @@ -1909,7 +1975,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 29 + 26 December 2019 30 @@ -1975,7 +2041,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 30 + 26 December 2019 31 @@ -2041,7 +2107,7 @@ LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES - 18 June 2019 31 + 26 December 2019 32 @@ -2107,7 +2173,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 32 + 26 December 2019 33 @@ -2173,7 +2239,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 33 + 26 December 2019 34 @@ -2239,7 +2305,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 34 + 26 December 2019 35 @@ -2305,7 +2371,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 35 + 26 December 2019 36 @@ -2366,12 +2432,12 @@ LATEXMK(1) General Commands Manual LATEXMK(1) [""] These variables specify commands that are executed at certain - points of compilations during preview-continuous mode. One mo- - tivation for their existance is to allow very useful convenient + points of compilations. One motivation for their existance is + to allow very useful convenient visual indications of - 18 June 2019 36 + 26 December 2019 37 @@ -2380,64 +2446,64 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - visual indications of compilation status even when the window - receiving the screen output of the compilation is hidden. + compilation status even when the window receiving the screen + output of the compilation is hidden. This is particularly use- + ful in preview-continuous mode. - The commands are executed at the following points: $compil- - ing_cmd at the start of compilation, $success_cmd at the end of - a completely successful compilation, $failure_cmd at the end of + The commands are executed at the following points: $compil- + ing_cmd at the start of compilation, $success_cmd at the end of + a completely successful compilation, $failure_cmd at the end of an unsuccessful compilation, $warning_cmd at the of an otherwise successful compilation that gives warnings about undefined cita- tions or references or about multiply defined references. If any - of above variables is undefined or blank (the default situa- + of above variables is undefined or blank (the default situa- tion), then the corresponding command is not executed. - However, when $warning_cmd is not set, then in the case of a - compilation with warnings about references or citations, but - with no other error, one or other of $success_cmd or $fail- - ure_cmd is used (if it is set) according to the setting of + However, when $warning_cmd is not set, then in the case of a + compilation with warnings about references or citations, but + with no other error, one or other of $success_cmd or $fail- + ure_cmd is used (if it is set) according to the setting of $warnings_as_errors. An example of a simple setting of these variables is as follows - $compiling_cmd = "xdotool search --name \"%D\" set_window + $compiling_cmd = "xdotool search --name \"%D\" set_window --name \"%D compiling\""; - $success_cmd = "xdotool search --name \"%D\" set_window + $success_cmd = "xdotool search --name \"%D\" set_window --name \"%D OK\""; $warning_cmd = "xdotool search --name \"%D\" ". "set_window --name \"%D CITE/REF ISSUE\""; - $failure_cmd = "xdotool search --name \"%D\" set_window + $failure_cmd = "xdotool search --name \"%D\" set_window --name \"%D FAILURE\""; - These assume that the program xdotool is installed, that the - previewer is using an X-Window system for display, and that the - title of the window contains the name of the displayed file, as - it normally does. When the commands are executed, the place- - holder string %D is replaced by the name of the destination + These assume that the program xdotool is installed, that the + previewer is using an X-Window system for display, and that the + title of the window contains the name of the displayed file, as + it normally does. When the commands are executed, the place- + holder string %D is replaced by the name of the destination file, which is the previewed file. The above commands result in an appropriate string being appended to the filename in the win- dow title: " compiling", " OK", or " FAILURE". - Other placeholders that can be used are %S, %T, and %R, with %S - and %T normally being identical. These can be useful for a com- - mand changing the title of the edit window. The visual indica- - tion in a window title can useful, since the user does not have - to keep shifting attention to the (possibly hidden) compilation + Other placeholders that can be used are %S, %T, and %R, with %S + and %T normally being identical. These can be useful for a com- + mand changing the title of the edit window. The visual indica- + tion in a window title can useful, since the user does not have + to keep shifting attention to the (possibly hidden) compilation window to know the status of the compilation. - More complicated situations can best be handled by defining a - Perl subroutine to invoke the necessary commands, and using the - "internal" keyword in the definitions to get the subroutine to + More complicated situations can best be handled by defining a + Perl subroutine to invoke the necessary commands, and using the + "internal" keyword in the definitions to get the subroutine to be invoked. (See the section "Format of Command Specifications" for how to do this.) - Naturally, the above settings that invoke the xdotool program - are only applicable when the X-Window system is used for the - relevant window(s). For other cases, you will have to find what + Naturally, the above settings that invoke the xdotool program + are only applicable when the X-Window system is used for the - 18 June 2019 37 + 26 December 2019 38 @@ -2446,6 +2512,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) + relevant window(s). For other cases, you will have to find what software solutions are available. @@ -2453,15 +2520,15 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Custom dependency list -- see section on "Custom Dependencies". @default_excluded_files [()] - When latexmk is invoked with no files specified on the command + When latexmk is invoked with no files specified on the command line, then, by default, it will process all files in the current directory with the extension .tex. (In general, it will process the files specified in the @default_files variable.) But sometimes you want to exclude particular files from this de- - fault list. In that case you can specify the excluded files in + fault list. In that case you can specify the excluded files in the array @default_excluded_files. For example if you wanted to - process all .tex files with the exception of common.tex, which + process all .tex files with the exception of common.tex, which is a not a standard alone LaTeX file but a file input by some or all of the others, you could do @@ -2471,26 +2538,26 @@ LATEXMK(1) General Commands Manual LATEXMK(1) If you have a variable or large number of files to be processed, this method saves you from having to list them in detail in @de- - fault_files and having to update the list every time you change + fault_files and having to update the list every time you change the set of files to be processed. - Notes: 1. This variable has no effect except when no files are + Notes: 1. This variable has no effect except when no files are specified on the latexmk command line. 2. Wildcards are allowed in @default_excluded_files. @default_files [("*.tex")] Default list of files to be processed. - If no filenames are specified on the command line, latexmk pro- - cesses all tex files specified in the @default_files variable, - which by default is set to all tex files ("*.tex") in the cur- - rent directory. This is a convenience: just run latexmk and it - will process an appropriate set of files. But sometimes you + If no filenames are specified on the command line, latexmk pro- + cesses all tex files specified in the @default_files variable, + which by default is set to all tex files ("*.tex") in the cur- + rent directory. This is a convenience: just run latexmk and it + will process an appropriate set of files. But sometimes you want only some of these files to be processed. In this case you - can list the files to be processed by setting @default_files in - an initialization file (e.g., the file "latexmkrc" in the cur- - rent directory). Then if no files are specified on the command - line then the files you specify by setting @default_files are + can list the files to be processed by setting @default_files in + an initialization file (e.g., the file "latexmkrc" in the cur- + rent directory). Then if no files are specified on the command + line then the files you specify by setting @default_files are processed. Three examples: @@ -2499,11 +2566,10 @@ LATEXMK(1) General Commands Manual LATEXMK(1) @default_files = ("paper1", "paper2.tex"); - @default_files = ("*.tex", "*.dtx"); - 18 June 2019 38 + 26 December 2019 39 @@ -2512,36 +2578,38 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - Note that more than file may be given, and that the default ex- + @default_files = ("*.tex", "*.dtx"); + + Note that more than file may be given, and that the default ex- tension is ".tex". Wild cards are allowed. The parentheses are because @default_files is an array variable, i.e., a sequence of filename specifications is possible. - If you want latexmk to process all .tex files with a few excep- + If you want latexmk to process all .tex files with a few excep- tions, see the @default_excluded_files array variable. $dependents_phony [0] - If a list of dependencies is output, this variable determines - whether to include a phony target for each source file. If you - use the dependents list in a Makefile, the dummy rules work - around errors make gives if you remove header files without up- + 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 up- dating the Makefile to match. $dependents_list [0] - Whether to display a list(s) of dependencies at the end of a + Whether to display a list(s) of dependencies at the end of a run. $deps_file ["-"] - Name of file to receive list(s) of dependencies at the end of a - run, to be used if $dependesnt_list is set. If the filename is - "-", then the dependency list is set to stdout (i.e., normally + Name of file to receive list(s) of dependencies at the end of a + run, to be used if $dependesnt_list is set. If the filename is + "-", then the dependency list is set to stdout (i.e., normally the screen). $do_cd [0] - Whether to change working directory to the directory specified - for the main source file before processing it. The default be- - havior is not to do this, which is the same as the behavior of - latex and pdflatex programs. This variable is set by the -cd + Whether to change working directory to the directory specified + for the main source file before processing it. The default be- + havior is not to do this, which is the same as the behavior of + latex and pdflatex programs. This variable is set by the -cd and -cd- options on latexmk's command line. $dvi_filter [empty] @@ -2549,27 +2617,25 @@ LATEXMK(1) General Commands Manual LATEXMK(1) fore other processing. Equivalent to specifying the -dF option. $dvi_mode [See below for default] - If nonzero, generate a dvi version of the document. Equivalent + If nonzero, generate a dvi version of the document. Equivalent to the -dvi option. - The variable $dvi_mode defaults to 0, but if no explicit re- - quests are made for other types of file (postscript, pdf), then - $dvi_mode will be set to 1. In addition, if a request for a - file for which a .dvi file is a prerequisite, then $dvi_mode + The variable $dvi_mode defaults to 0, but if no explicit re- + quests are made for other types of file (postscript, pdf), then + $dvi_mode will be set to 1. In addition, if a request for a + file for which a .dvi file is a prerequisite, then $dvi_mode will be set to 1. $dvi_previewer ["start xdvi %O %S" under UNIX] - The command to invoke a dvi-previewer. [Under MS-Windows the - default is "start"; then latexmk arranges to use the MS-Windows - start program, which will cause to be run whatever command the + The command to invoke a dvi-previewer. [Under MS-Windows the + default is "start"; then latexmk arranges to use the MS-Windows + start program, which will cause to be run whatever command the system has associated with .dvi files.] - Important note: Normally you will want to have a previewer run - detached, so that latexmk doesn't wait for the previewer to - 18 June 2019 39 + 26 December 2019 40 @@ -2578,64 +2644,64 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - terminate before continuing its work. So normally you should - prefix the command by "start ", which flags to latexmk that it - should do the detaching of the previewer itself (by whatever - method is appropriate to the operating system). But sometimes + Important note: Normally you will want to have a previewer run + detached, so that latexmk doesn't wait for the previewer to ter- + minate before continuing its work. So normally you should pre- + fix the command by "start ", which flags to latexmk that it + should do the detaching of the previewer itself (by whatever + method is appropriate to the operating system). But sometimes letting latexmk do the detaching is not appropriate (for a vari- - ety of non-trivial reasons), so you should put the "start " bit + ety of non-trivial reasons), so you should put the "start " bit in yourself, whenever it is needed. $dvi_previewer_landscape ["start xdvi %O %S"] The command to invoke a dvi-previewer in landscape mode. [Under - MS-Windows the default is "start"; then latexmk arranges to use - the MS-Windows start program, which will cause to be run what- + MS-Windows the default is "start"; then latexmk arranges to use + the MS-Windows start program, which will cause to be run what- ever command the system has associated with .dvi files.] $dvipdf ["dvipdf %O %S %D"] - Command to convert .dvi to .pdf file. A common reconfiguration - is to use the dvipdfm command, which needs its arguments in a + Command to convert .dvi to .pdf file. A common reconfiguration + is to use the dvipdfm command, which needs its arguments in a different order: $dvipdf = "dvipdfm %O -o %D %S"; - WARNING: The default dvipdf script generates pdf files with + WARNING: The default dvipdf script generates pdf files with bitmapped fonts, which do not look good when viewed by acroread. - That script should be modified to give dvips the options "-P + That script should be modified to give dvips the options "-P pdf" to ensure that type 1 fonts are used in the pdf file. $dvipdf_silent_switch ["-q"] Switch(es) for dvipdf program when silent mode is on. - N.B. The standard dvipdf program runs silently, so adding the - silent switch has no effect, but is actually innocuous. But if - an alternative program is used, e.g., dvipdfmx, then the silent - switch has an effect. The default setting is correct for + N.B. The standard dvipdf program runs silently, so adding the + silent switch has no effect, but is actually innocuous. But if + an alternative program is used, e.g., dvipdfmx, then the silent + switch has an effect. The default setting is correct for dvipdfm and dvipdfmx. $dvips ["dvips %O -o %D %S"] - The program to used as a filter to convert a .dvi file to a .ps - file. If pdf is going to be generated from pdf, then the value - of the $dvips_pdf_switch variable -- see below -- will be in- + The program to used as a filter to convert a .dvi file to a .ps + file. If pdf is going to be generated from pdf, then the value + of the $dvips_pdf_switch variable -- see below -- will be in- cluded 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 - 18 June 2019 40 + 26 December 2019 41 @@ -2644,64 +2710,64 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - command, 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 exam- - ple for the analogous case of a pdf previewer. + $dvi_update_command [""] + When the dvi previewer is set to be updated by running a com- + mand, this is the command that is run. See the information for + the variable $dvi_update_method for further information, and see + information on the variable $pdf_update_method for an example + for the analogous case of a pdf previewer. $dvi_update_method [2 under UNIX, 1 under MS-Windows] - How the dvi viewer updates its display when the dvi file has - changed. The values here apply equally to the $pdf_up- + How the dvi viewer updates its display when the dvi file has + changed. The values here apply equally to the $pdf_up- date_method and to the $ps_update_method variables. 0 => update is automatic, 1=> manual update by user, which may only mean a mouse click on the viewer's window or may mean a more serious action. - 2 => Send the signal, whose number is in the variable - $dvi_update_signal. The default value under UNIX is suitable + 2 => Send the signal, whose number is in the variable + $dvi_update_signal. The default value under UNIX is suitable for xdvi. - 3 => Viewer cannot do an update, because it locks the file. + 3 => Viewer cannot do an update, because it locks the file. (As with acroread under MS-Windows.) - 4 => run a command to do the update. The command is speci- + 4 => run a command to do the update. The command is speci- fied by the variable $dvi_update_command. - See information on the variable $pdf_update_method for an exam- + See information on the variable $pdf_update_method for an exam- ple of updating by command. - $dvi_update_signal [Under UNIX: SIGUSR1, which is a system-dependent + $dvi_update_signal [Under UNIX: SIGUSR1, which is a system-dependent value] - The number of the signal that is sent to the dvi viewer when it - is updated by sending a signal -- see the information on the - variable $dvi_update_method. The default value is the one ap- + 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 ap- propriate for xdvi on a UNIX system. $failure_cmd [undefined] See the documentation for $compiling_cmd. $fdb_ext ["fdb_latexmk"] - The extension of the file which latexmk generates to contain a - database of information on source files. You will not normally + The extension of the file which latexmk generates to contain a + database of information on source files. You will not normally need to change this. - $filetime_causality_threshold [5]; $filetime_offset_report_threshold + $filetime_causality_threshold [5]; $filetime_offset_report_threshold [30]. (Units of seconds.) These variables control how latexmk deals with the following is- - sue, which can affect the use of files that are on a remote + sue, which can affect the use of files that are on a remote filesystem (network share) instead of being on a file system lo- cal to the computer running latexmk. Almost users will not have - to worry about these settings, and can ignore the following ex- + to worry about these settings, and can ignore the following ex- planation. - In almost all situations, latexmk does not need to use the time - stamps of the files it works with. However, there are a couple - of situations when it needs to know whether a certain file was + In almost all situations, latexmk does not need to use the time + stamps of the files it works with. However, there are a couple + of situations when it needs to know whether a certain file was created in the current run of a program (e.g., (pdf)latex) or is - a leftover file from a previous run. It does this by comparing - the modification time of the file with the system time just - 18 June 2019 41 + 26 December 2019 42 @@ -2710,64 +2776,64 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - before the program was started. If the modification time is ear- - lier than when the program was started, the file is a leftover - file, which latexmk treats as if it were not created. If the - filetime is at least the program start time, then it can be as- + a leftover file from a previous run. It does this by comparing + the modification time of the file with the system time just be- + fore the program was started. If the modification time is ear- + lier than when the program was started, the file is a leftover + file, which latexmk treats as if it were not created. If the + filetime is at least the program start time, then it can be as- sumed that the file was created in the current run. - Unfortunately, this test can fail if the file is on a remote - system, since its system time is not necessarily synchronized - with that of the local system; the timestamps on the remote - files are set by the remote system, not the local system. Gen- - erally, modern operating systems regularly synchronize their - time with a server, so the non-synchronization is mostly small + Unfortunately, this test can fail if the file is on a remote + system, since its system time is not necessarily synchronized + with that of the local system; the timestamps on the remote + files are set by the remote system, not the local system. Gen- + erally, modern operating systems regularly synchronize their + time with a server, so the non-synchronization is mostly small (a second or so, or a few seconds). But even a small difference can mess up latexmk's test. Latexmk measures the time difference between the time on the two - systems and compensates for this. But the measurement (in a + systems and compensates for this. But the measurement (in a system-independent way) is only accurate to a second or two. So - latexmk allows for a threshold on the difference between file - and system time before it concludes that a file is a leftover - file from a previous run. The configuration variable $file- - time_causality_theshhold, which in units of seconds, specifies + latexmk allows for a threshold on the difference between file + and system time before it concludes that a file is a leftover + file from a previous run. The configuration variable $file- + time_causality_theshhold, which in units of seconds, specifies this threshold. Luckily high precision is not needed. The pre- - vious run is normally the previous run in a human run-edit-run - cycle, and is at least many seconds back. A few seconds is - therefore appropriate for the threshold, $filetime_causal- - ity_theshhold; it should be non-negative always, and should be + vious run is normally the previous run in a human run-edit-run + cycle, and is at least many seconds back. A few seconds is + therefore appropriate for the threshold, $filetime_causal- + ity_theshhold; it should be non-negative always, and should be bigger than 2 if a remote filesystem or network share is used. - If the difference in system times on the two systems is large, - it normally indicates that at least one of the systems is mis- - configured. The variable $filetime_offset_report_threshold - specifies the smallest size of the difference (or offset) in - seconds between the times of the local and remote system beyond - which the offset is reported. This is reported at the point in - the latexmk's progress that it measures the offset. The report + If the difference in system times on the two systems is large, + it normally indicates that at least one of the systems is mis- + configured. The variable $filetime_offset_report_threshold + specifies the smallest size of the difference (or offset) in + seconds between the times of the local and remote system beyond + which the offset is reported. This is reported at the point in + the latexmk's progress that it measures the offset. The report is made if silent mode is used and diagnostic mode is not on. $force_mode [0] - If nonzero, continue processing past minor latex errors includ- + If nonzero, continue processing past minor latex errors includ- ing unrecognized cross references. Equivalent to specifying the -f option. - @generated_exts [( aux , bbl , idx , ind , lof , lot , out , toc , + @generated_exts [( aux , bbl , idx , ind , lof , lot , out , toc , $fdb_ext )] - This contains a list of extensions for files that are generated - during a LaTeX run and that are read in by LaTeX in later runs, + This contains a list of extensions for files that are generated + during a LaTeX run and that are read in by LaTeX in later runs, either directly or indirectly. - This list specifies files known to be generated by latex (and + This list specifies files known to be generated by latex (and pdflatex, etc). It is used in two ways: (a) The specified files - are deleted in a cleanup operation (with the -c, -C, -CA, -g and - -gg options), and (b) It affects the determination of whether a - 18 June 2019 42 + 26 December 2019 43 @@ -2776,45 +2842,47 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) + are deleted in a cleanup operation (with the -c, -C, -CA, -g and + -gg options), and (b) It affects the determination of whether a rerun of (pdf)LaTeX is needed after a run that gives an error. (Concerning item (b): 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 not - 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 + 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 not + 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 au- - tomatically generated files; it determines the automatically - generated files as those with extensions in the list in @gener- + tomatically generated files; it determines the automatically + generated files as those with extensions in the list in @gener- ated_exts.) - A convenient way to add an extra extension to the list, without - losing the already defined ones is to use a push command in the + A convenient way to add an extra extension to the list, without + losing the already defined ones is to use a push command in the line in an RC file. E.g., push @generated_exts, "end"; adds the extension "end" to the list of predefined generated ex- - tensions. (This extension is used by the RevTeX package, for + tensions. (This extension is used by the RevTeX package, for example.) $go_mode [0] - If nonzero, process files regardless of timestamps, and is then + If nonzero, process files regardless of timestamps, and is then equivalent to the -g option. %hash_calc_ignore_pattern !!!This variable is for experts only!!! - The general rule latexmk uses for determining when an extra run - of some program is needed is that one of the source files has - changed. But consider for example a latex package that causes - an encapsulated postscript file (an "eps" file) to be made that - is to be read in on the next run. The file contains a comment - line giving its creation date and time. On the next run the - time changes, latex sees that the eps file has changed, and - therefore reruns latex. This causes an infinite loop, that is - only terminated because latexmk has a limit on the number of + The general rule latexmk uses for determining when an extra run + of some program is needed is that one of the source files has + changed. But consider for example a latex package that causes + an encapsulated postscript file (an "eps" file) to be made that + is to be read in on the next run. The file contains a comment + line giving its creation date and time. On the next run the + time changes, latex sees that the eps file has changed, and + therefore reruns latex. This causes an infinite loop, that is + only terminated because latexmk has a limit on the number of runs to guard against pathological situations. But the changing line has no real effect, since it is a comment. @@ -2823,17 +2891,15 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: '; This creates a rule for files with extension .eps about lines to - ignore. The left-hand side is a Perl idiom for setting an item - in a hash. Note that the file extension is specified without a + ignore. The left-hand side is a Perl idiom for setting an item + in a hash. Note that the file extension is specified without a period. The value, on the right-hand side, is a string contain- - ing a regular expresssion. (See documentation on Perl for how - they are to be specified in general.) This particular regular - expression specifies that lines beginning with "%%CreationDate: - " are to be ignored in deciding whether a file of the given + ing a regular expresssion. (See documentation on Perl for how + they are to be specified in general.) This particular regular - 18 June 2019 43 + 26 December 2019 44 @@ -2842,24 +2908,26 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - extension .eps has changed. + expression specifies that lines beginning with "%%CreationDate: + " are to be ignored in deciding whether a file of the given ex- + tension .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 ex- - pression. The simplest method is separate the different simple - patterns by a vertical bar character (indicating "alternation" + 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 ex- + pression. The simplest method is separate the different simple + patterns by a vertical bar character (indicating "alternation" in the jargon of regular expressions). For example, - $hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: |^%%Ti- + $hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: |^%%Ti- tle: '; causes lines starting with either "^%%CreationDate: " or "^%%Ti- tle: " to be ignored. - It may happen that a pattern to be ignored is specified in, for - example, in a system or user initialization file, and you wish - to remove this in a file that is read later. To do this, you + It may happen that a pattern to be ignored is specified in, for + example, in a system or user initialization file, and you wish + to remove this in a file that is read later. To do this, you use Perl's delete function, e.g., delete $hash_calc_ignore_pattern{'eps'}; @@ -2867,39 +2935,37 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $jobname [""] - This specifies the jobname, i.e., the basename that is used for - generated files (.aux, .log, .dvi, .ps, .pdf, etc). If this - variable is a null string, then the basename is the basename of - the main tex file. (At present, the string in $jobname should + This specifies the jobname, i.e., the basename that is used for + generated files (.aux, .log, .dvi, .ps, .pdf, etc). If this + variable is a null string, then the basename is the basename of + the main tex file. (At present, the string in $jobname should not contain spaces.) - The placeholder '%A' is permitted. This will be substituted by + The placeholder '%A' is permitted. This will be substituted by the basename of the TeX file. The primary purpose is when a va- - riety of tex files are to be processed, and you want to use a - different jobname for each but one that is distinct for each. - Thus if you wanted to compare compilations of a set of files on + riety of tex files are to be processed, and you want to use a + different jobname for each but one that is distinct for each. + Thus if you wanted to compare compilations of a set of files on different operating systems, with distinct filenames for all the cases, you could set $jobname = "%A-$^O"; - in an initialization file. (Here $^O is a variable provided by + in an initialization file. (Here $^O is a variable provided by perl that contains perl's name for the operating system.) - Suppose you had .tex files test1.tex and test2.tex. Then when + Suppose you had .tex files test1.tex and test2.tex. Then when you run latexmk -pdf *.tex - both files will be compiled. The .aux, .log, and .pdf files - will have basenames test1-MSWin32 ante test2-MSWin32 on a MS- + both files will be compiled. The .aux, .log, and .pdf files + will have basenames test1-MSWin32 ante test2-MSWin32 on a MS- Windows system, test1-darwin and test2-darwin on an OS-X system, - and a variety of similar cases on linux systems. - - 18 June 2019 44 + 26 December 2019 45 @@ -2908,48 +2974,51 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) + and a variety of similar cases on linux systems. + + $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- + 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, no- tably when a .bib or a .bst file is found from the log file of a - bibtex or biber run, only the base name of the file is known, + bibtex or biber run, only the base name of the file is known, but not its path. The program specified by $kpsewhich is used to find it. - (For advanced users: Because of the different way in which la- + (For advanced users: Because of the different way in which la- texmk uses the command specified in $kpsewhich, some of the pos- sibilities listed in the FORMAT OF COMMAND SPECIFICATIONS do not - apply. The internal and start keywords are not available. A + apply. The internal and start keywords are not available. A simple command specification with possible options and then "%S" - is all that is guaranteed to work. Note that for other com- + is all that is guaranteed to work. Note that for other com- mands, "%S" is substituted by a single source file. In contrast, for $kpsewhich, "%S" may be substituted by a long list of space- - separated filenames, each of which is quoted. The result on + separated filenames, each of which is quoted. The result on STDOUT of running the command is then piped to latexmk.) - See also the @BIBINPUTS variable for another way that latexmk + See also the @BIBINPUTS variable for another way that latexmk also uses to try to locate files; it applies only in the case of .bib files. $kpsewhich_show [0] - Whether to show diagnostics about invocations of kpsewhich: the - command line use to invoke it and the results. These diagnos- - tics are shown if $kpsewhich_show is non-zero or if diagnostics - mode is on. (But in the second case, lots of other diagnostics - are also shown.) Without these diagnostics there is nothing - visible in latexmk's screen output about invocations of kpse- + Whether to show diagnostics about invocations of kpsewhich: the + command line use to invoke it and the results. These diagnos- + tics are shown if $kpsewhich_show is non-zero or if diagnostics + mode is on. (But in the second case, lots of other diagnostics + are also shown.) Without these diagnostics there is nothing + visible in latexmk's screen output about invocations of kpse- which. $landscape_mode [0] If nonzero, run in landscape mode, using the landscape mode pre- - viewers and dvi to postscript converters. Equivalent to the -l + viewers and dvi to postscript converters. Equivalent to the -l option. Normally not needed with current previewers. $latex ["latex %O %S"] - Specifies the command line for the LaTeX processing program. - Note that as with other programs, you can use this variable not - just to change the name of the program used, but also specify + Specifies the command line for the LaTeX processing program. + Note that as with other programs, 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 %O %S"; @@ -2958,14 +3027,11 @@ LATEXMK(1) General Commands Manual LATEXMK(1) tex, and $xelatex, see the section "Advanced Configuration". - %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 - 18 June 2019 45 + + 26 December 2019 46 @@ -2974,20 +3040,24 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - typically happens when LaTeX commands of the form \input{file} - or \includegraphics{figure}, when the relevant source file does + %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 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_in- - put_ext. They are used as in the following examples are possi- + (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_in- + put_ext. They are used as in the following examples are possi- ble lines in an initialization file: remove_input_ext( 'latex', 'tex' ); @@ -2996,19 +3066,19 @@ LATEXMK(1) General Commands Manual LATEXMK(1) add_input_ext( 'latex', 'asdf' ); - add the extension 'asdf to latex_input_extensions. (Naturally + add the extension 'asdf to latex_input_extensions. (Naturally with such an extension, you should have made an appropriate cus- tom dependency for latexmk, and should also have done the appro- - priate programming in the LaTeX source file to enable the file - to be read. The standard extensions are handled by LaTeX and + priate programming in the LaTeX source file to enable the file + to be read. The standard extensions are handled by LaTeX and its graphics/graphicx packages.) $latex_silent_switch ["-interaction=batchmode"] - Switch(es) for the LaTeX processing program when silent mode is + Switch(es) for the LaTeX processing program when silent mode is on. - If you use MikTeX, you may prefer the results if you configure - the options to include -c-style-errors, e.g., by the following + If you use MikTeX, you may prefer the results if you configure + the options to include -c-style-errors, e.g., by the following line in an initialization file $latex_silent_switch = "-interaction=batchmode -c-style-er- @@ -3018,20 +3088,16 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $lpr ["lpr %O %S" under UNIX/Linux, "NONE lpr" under MS-Windows] The command to print postscript files. - Under MS-Windows (unlike UNIX/Linux), there is no standard pro- + Under MS-Windows (unlike UNIX/Linux), there is no standard pro- gram for printing files. But there are ways you can do it. For example, if you have gsview installed, you could use it with the option "/p": $lpr = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p'; - If gsview is installed in a different directory, you will need - to make the appropriate change. Note the combination of single - and double quotes around the name. The single quotes specify - - 18 June 2019 46 + 26 December 2019 47 @@ -3040,9 +3106,12 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - that this is a string to be assigned to the configuration vari- - able $lpr. The double quotes are part of the string passed to - the operating system to get the command obeyed; this is neces- + If gsview is installed in a different directory, you will need + to make the appropriate change. Note the combination of single + and double quotes around the name. The single quotes specify + that this is a string to be assigned to the configuration vari- + able $lpr. The double quotes are part of the string passed to + the operating system to get the command obeyed; this is neces- sary because one part of the command name ("Program Files") con- tains a space which would otherwise be misinterpreted. @@ -3052,20 +3121,20 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $lpr_pdf ["NONE lpr_pdf"] The printing program to print pdf files. - Under MS-Windows you could set this to use gsview, if it is in- + Under MS-Windows you could set this to use gsview, if it is in- stalled, e.g., $lpr = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p'; - If gsview is installed in a different directory, you will need - to make the appropriate change. Note the double quotes around + If gsview is installed in a different directory, you will need + to make the appropriate change. Note the double quotes around the name: this is necessary because one part of the command name ("Program Files") contains a space which would otherwise be mis- interpreted. $lualatex ["lualatex %O %S"] Specifies the command line for the LaTeX processing program that - is to be used when the lualatex program is called for (e.g., by + is to be used when the lualatex program is called for (e.g., by the option -lualatex. To do a coordinated setting of all of $latex, $pdflatex, $luala- @@ -3073,31 +3142,28 @@ LATEXMK(1) General Commands Manual LATEXMK(1) %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 \in- - put{file} or \includegraphics{figure}, when the relevant source + 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 \in- + put{file} or \includegraphics{figure}, when the relevant source file does not exist. - In this situation, latexmk searches for custom dependencies to - make the missing file(s), but restricts it to the extensions - specified by the variable %pdflatex_input_extensions. The de- + 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 de- fault extensions are 'tex', 'pdf', 'jpg, and 'png'. See details of the %latex_input_extensions for other information that equally applies to %lualatex_input_extensions. $lualatex_silent_switch ["-interaction=batchmode"] - Switch(es) for the lualatex program (specified in the variable + Switch(es) for the lualatex program (specified in the variable $lualatex) when silent mode is on. - See details of the $latex_silent_switch for other information - that equally applies to $lualatex_silent_switch. - - 18 June 2019 47 + 26 December 2019 48 @@ -3106,6 +3172,9 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) + See details of the $latex_silent_switch for other information + that equally applies to $lualatex_silent_switch. + $make ["make"] The make processing program. @@ -3113,57 +3182,54 @@ LATEXMK(1) General Commands Manual LATEXMK(1) The index processing program. $makeindex_silent_switch ["-q"] - Switch(es) for the index processing program when silent mode is + Switch(es) for the index processing program when silent mode is on. $max_repeat [5] - The maximum number of times latexmk will run latex/pdflatex be- - fore deciding that there may be an infinite loop and that it + The maximum number of times latexmk will run latex/pdflatex be- + fore 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 la- + (Note that the "etc" covers a lot of cases where one run of la- tex/pdflatex generates files to be read in on a later run.) $MSWin_back_slash [1] - This configuration variable only has an effect when latexmk is + This configuration variable only has an effect when latexmk is running under MS-Windows. It determines whether, when a command - is executed under MS-Windows, there should be substituted "\" - for the separator character between components of a directory - name. Internally, latexmk uses "/" for the directory separator + is executed under MS-Windows, there should be substituted "\" + for the separator character between components of a directory + name. Internally, latexmk uses "/" for the directory separator character, which is the character used by Unix-like systems. For many programs under MS-Windows, both "\" and "/" are accept- - able as the directory separator character. But some programs - only accept "\" on the command line. So for safety latexmk - makes a translation, by default. It is conceivable that under + able as the directory separator character. But some programs + only accept "\" on the command line. So for safety latexmk + makes a translation, by default. It is conceivable that under certain situations this is undesirable, so the configuration can be changed. (A possible example might be when some of the soft- ware is implemented using Cygwin, which provides a Unix-like en- vironment inside MS-Windows.) $new_viewer_always [0] - This variable applies to latexmk only in continuous-preview + This variable applies to latexmk only in continuous-preview mode. If $new_viewer_always is 0, latexmk will check for a pre- - viously running previewer on the same file, and if one is run- - ning will not start a new one. If $new_viewer_always is non- - zero, this check will be skipped, and latexmk will behave as if + viously running previewer on the same file, and if one is run- + ning will not start a new one. If $new_viewer_always is non- + zero, this check will be skipped, and latexmk will behave as if no viewer is running. $out_dir [""] - If non-blank, this variable specifies the directory in which + If non-blank, this variable specifies the directory in which output files are to be written by a run of (pdf)latex. See also the variable $aux_dir. - The effect of this variable (when non-blank) is achieved by us- - ing the -output-directory option of (pdf)latex. This exists in - the usual current (Dec. 2011 and later) implementations of TeX, - i.e., MiKTeX and TeXLive. But it may not be present in other + The effect of this variable (when non-blank) is achieved by - 18 June 2019 48 + 26 December 2019 49 @@ -3172,47 +3238,50 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - versions. + using the -output-directory option of (pdf)latex. This exists + in the usual current (Dec. 2011 and later) implementations of + TeX, i.e., MiKTeX and TeXLive. But it may not be present in + other versions. - If you also use the -cd option, and $out_dir (or $aux_dir) con- - tains a relative path, then the path is interpreted relative to + If you also use the -cd option, and $out_dir (or $aux_dir) con- + tains a relative path, then the path is interpreted relative to the document directory. - Commonly, the directory specified for output files is a subdi- + Commonly, the directory specified for output files is a subdi- rectory of the current working directory. However, if you spec- - ify some other directory, e.g., "/tmp/foo" or "../output", be - aware that this could cause problems, e.g., with makeindex or - bibtex. This is because modern versions of these programs, by - default, will refuse to work when they find that they are asked - to write to a file in a directory that appears not to be the + ify some other directory, e.g., "/tmp/foo" or "../output", be + aware that this could cause problems, e.g., with makeindex or + bibtex. This is because modern versions of these programs, by + default, will refuse to work when they find that they are asked + to write to a file in a directory that appears not to be the current working directory or one of its subdirectories. This is - part of security measures by the whole TeX system that try to + part of security measures by the whole TeX system that try to prevent malicious or errant TeX documents from incorrectly mess- ing with a user's files. If for $out_dir or $aux_dir you really - do need to specify an absolute pathname (e.g., "/tmp/foo") or a + do need to specify an absolute pathname (e.g., "/tmp/foo") or a path (e.g., "../output") that includes a higher-level directory, - and you need to use makeindex or bibtex, then you need to dis- - able the security measures (and assume any risks). One way of + and you need to use makeindex or bibtex, then you need to dis- + able the security measures (and assume any risks). One way of doing this is to temporarily set an operating system environment - variable openout_any to "a" (as in "all"), to override the de- + variable openout_any to "a" (as in "all"), to override the de- fault "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- + If zero, do NOT generate a pdf version of the document. If + equal to 1, generate a pdf version of the document using pdfla- + tex, using the command specified by the $pdflatex variable. If + equal to 2, generate a pdf version of the document from the ps + file, by using the command specified by the $ps2pdf variable. + If equal to 3, generate a pdf version of the document from the + dvi file, by using the command specified by the $dvipdf vari- able. If equal to 4, generate a pdf version of the document us- ing lualatex, using the command specified by the $lualatex vari- - able. If equal to 5, generate a pdf version (and an xdv ver- - sion) of the document using xelatex, using the commands speci- + able. If equal to 5, generate a pdf version (and an xdv ver- + sion) of the document using xelatex, using the commands speci- fied by the $xelatex and xdvipdfmx variables. - In $pdf_mode=2, it is ensured that .dvi and .ps files are also - made. In $pdf_mode=3, it is ensured that a .dvi file is also + In $pdf_mode=2, it is ensured that .dvi and .ps files are also + made. In $pdf_mode=3, it is ensured that a .dvi file is also made. But this may be overridden by the document. $pdflatex ["pdflatex %O %S"] @@ -3224,12 +3293,9 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $pdflatex = "pdflatex --shell-escape %O %S"; - (In some earlier versions of latexmk, you needed to use an as- - signment to $pdflatex to allow the use of lualatex or xelatex - - 18 June 2019 49 + 26 December 2019 50 @@ -3238,64 +3304,64 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) + (In some earlier versions of latexmk, you needed to use an as- + signment to $pdflatex to allow the use of lualatex or xelatex instead of pdflatex. There are now separate configuration vari- - ables for the use of lualatex or xelatex. See $lualatex and + ables for the use of lualatex or xelatex. See $lualatex and $xelatex.) To do a coordinated setting of all of $latex, $pdflatex, $luala- tex, and $xelatex, see the section "Advanced Configuration". %pdflatex_input_extensions - This variable specifies the extensions tried by latexmk when it - finds that a pdflatex run resulted in an error that a file has - not been found, and the file is given without an extension. - This typically happens when LaTeX commands of the form \in- - put{file} or \includegraphics{figure}, when the relevant source + This variable specifies the extensions tried by latexmk when it + finds that a pdflatex run resulted in an error that a file has + not been found, and the file is given without an extension. + This typically happens when LaTeX commands of the form \in- + put{file} or \includegraphics{figure}, when the relevant source file does not exist. - In this situation, latexmk searches for custom dependencies to - make the missing file(s), but restricts it to the extensions - specified by the variable %pdflatex_input_extensions. The de- + 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 de- fault extensions are 'tex', 'pdf', 'jpg, and 'png'. See details of the %latex_input_extensions for other information that equally applies to %pdflatex_input_extensions. $pdflatex_silent_switch ["-interaction=batchmode"] - Switch(es) for the pdflatex program (specified in the variable + Switch(es) for the pdflatex program (specified in the variable $pdflatex) when silent mode is on. - See details of the $latex_silent_switch for other information + See details of the $latex_silent_switch for other information that equally applies to $pdflatex_silent_switch. $pdf_previewer ["start acroread %O %S"] The command to invoke a pdf-previewer. - On MS-Windows, the default is changed to "cmd /c start """; un- - der more recent versions of Windows, this will cause to be run + On MS-Windows, the default is changed to "cmd /c start """; un- + der more recent versions of Windows, this will cause to be run whatever command the system has associated with .pdf files. But - this may be undesirable if this association is to acroread -- + this may be undesirable if this association is to acroread -- see the notes in the explanation of the -pvc option.] - On OS-X the default is changed to "open %S", which results in - OS-X starting up (and detaching) the viewer associated with the - file. By default, for pdf files this association is to OS-X's + On OS-X the default is changed to "open %S", which results in + OS-X starting up (and detaching) the viewer associated with the + file. By default, for pdf files this association is to OS-X's preview, which is quite satisfactory. - WARNING: Problem under MS-Windows: if acroread is used as the - pdf previewer, and it is actually viewing a pdf file, the pdf - file cannot be updated. Thus makes acroread a bad choice of - previewer if you use latexmk's previous-continuous mode (option + WARNING: Problem under MS-Windows: if acroread is used as the + pdf previewer, and it is actually viewing a pdf file, the pdf + file cannot be updated. Thus makes acroread a bad choice of + previewer if you use latexmk's previous-continuous mode (option -pvc) under MS-windows. This problem does not occur if, for ex- ample, SumatraPDF 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 + Important note: Normally you will want to have a previewer run - 18 June 2019 50 + 26 December 2019 51 @@ -3304,25 +3370,27 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - prefix the command by "start ", which flags to latexmk that it - should do the detaching of the previewer itself (by whatever - method is appropriate to the operating system). But sometimes + detached, so that latexmk doesn't wait for the previewer to ter- + minate before continuing its work. So normally you should pre- + fix the command by "start ", which flags to latexmk that it + should do the detaching of the previewer itself (by whatever + method is appropriate to the operating system). But sometimes letting latexmk do the detaching is not appropriate (for a vari- - ety of non-trivial reasons), so you should put the "start " bit + ety of non-trivial reasons), so you should put the "start " bit in yourself, whenever it is needed. $pdf_update_command [""] - When the pdf previewer is set to be updated by running a com- - mand, this is the command that is run. See the information for + When the pdf previewer is set to be updated by running a com- + mand, this is the command that is run. See the information for the variable $pdf_update_method. $pdf_update_method [1 under UNIX, 3 under MS-Windows] - How the pdf viewer updates its display when the pdf file has - changed. See the information on the variable $dvi_update_method + How the pdf viewer updates its display when the pdf file has + changed. See the information on the variable $dvi_update_method for the codes. (Note that information needs be changed slightly - so that for the value 4, to run a command to do the update, the - command is specified by the variable $pdf_update_command, and - for the value 2, to specify update by signal, the signal is + so that for the value 4, to run a command to do the update, the + command is specified by the variable $pdf_update_command, and + for the value 2, to specify update by signal, the signal is specified by $pdf_update_signal.) Note that acroread under MS-Windows (but not UNIX) locks the pdf @@ -3335,33 +3403,31 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $pdf_update_method = 4; $pdf_update_command = "xpdf -remote %R -reload"; - The first setting arranges for the xpdf program to be used in - its "remote server mode", with the server name specified as the - rootname of the TeX file. The second setting arranges for up- - dating to be done in response to a command, and the third set- + The first setting arranges for the xpdf program to be used in + its "remote server mode", with the server name specified as the + rootname of the TeX file. The second setting arranges for up- + dating to be done in response to a command, and the third set- ting sets the update command. - $pdf_update_signal [Under UNIX: SIGHUP, which is a system-dependent + $pdf_update_signal [Under UNIX: SIGHUP, which is a system-dependent value] - The number of the signal that is sent to the pdf viewer when it - is updated by sending a signal -- see the information on the - variable $pdf_update_method. The default value is the one ap- + 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 ap- propriate for gv on a UNIX system. $pid_position[1 under UNIX, -1 under MS-Windows] - The variable $pid_position is used to specify which word in - lines of the output from $pscmd corresponds to the process ID. - The first word in the line is numbered 0. The default value of + The variable $pid_position is used to specify which word in + lines of the output from $pscmd corresponds to the process ID. + The first word in the line is numbered 0. The default value of 1 (2nd word in line) is correct for Solaris 2.6, Linux, and OS-X with their default settings of $pscmd. - Setting the variable to -1 is used to indicate that $pscmd is - not to be used. + Setting the variable to -1 is used to indicate that $pscmd is - - 18 June 2019 51 + 26 December 2019 52 @@ -3370,24 +3436,26 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) + not to be used. + $postscript_mode [0] - If nonzero, generate a postscript version of the document. + If nonzero, generate a postscript version of the document. Equivalent to the -ps option. - If some other request is made for which a postscript file is + If some other request is made for which a postscript file is needed, then $postscript_mode will be set to 1. $pre_tex_code [''] - Sets TeX code to be executed before inputting the source file. - This works if the relevant one of $latex, etc contains a suit- + Sets TeX code to be executed before inputting the source file. + This works if the relevant one of $latex, etc contains a suit- able command line with a %P or %U substitution. For example you could do $latex = 'latex %O %P'; $pre_tex_code = '\AtBeginDocument{An initial message\par}'; - To set all of $latex, $pdflatex, $lualatex, and $xelatex you + To set all of $latex, $pdflatex, $lualatex, and $xelatex you could use the subroutine alt_tex_cmds: &alt_tex_cmds; @@ -3396,38 +3464,36 @@ LATEXMK(1) General Commands Manual LATEXMK(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 the command specified in + If nonzero, print the document using the command specified in the $lpr variable. Equivalent to the -p option. This is recom- - mended not to be set from an RC file, otherwise you could waste + mended not to be set from an RC file, otherwise you could waste lots of paper. $print_type = ["auto"] - Type of file to printout: possibilities are "auto", "dvi", + Type of file to printout: possibilities are "auto", "dvi", "none", "pdf", or "ps". See the option -print= for the meaning of the "auto" value. $pscmd Command used to get all the processes currently run by the user. - The -pvc option uses the command specified by the variable - $pscmd to determine if there is an already running previewer, - and to find the process ID (needed if latexmk needs to signal - the previewer about file changes). - + 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 - 18 June 2019 52 + 26 December 2019 53 @@ -3436,13 +3502,15 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) + the previewer about file changes). + Each line of the output of this command is assumed to correspond - to one process. See the $pid_position variable for how the + to one process. See the $pid_position variable for how the process number is determined. - The default for pscmd is "NONE" under MS-Windows and cygwin - (i.e., the command is not used), "ps -ww -u $ENV{USER}" under - OS-X, and "ps -f -u $ENV{USER}" under other operating systems + The default for pscmd is "NONE" under MS-Windows and cygwin + (i.e., the command is not used), "ps -ww -u $ENV{USER}" under + OS-X, and "ps -f -u $ENV{USER}" under other operating systems (including Linux). In these specifications "$ENV{USER}" is sub- stituted by the username. @@ -3451,49 +3519,47 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $ps_filter [empty] The postscript file filter to be run on the newly produced post- - script file before other processing. Equivalent to specifying + script file before other processing. Equivalent to specifying the -pF option. $ps_previewer ["start gv %O %S", but start %O %S under MS-Windows] - The command to invoke a ps-previewer. (The default under MS- + The command to invoke a ps-previewer. (The default under MS- Windows will cause to be run whatever command the system has as- sociated with .ps files.) - Note that gv could be used with the -watch option updates its - display whenever the postscript file changes, whereas ghostview - does not. However, different versions of gv have slightly dif- - ferent ways of writing this option. You can configure this + Note that gv could be used with the -watch option updates its + display whenever the postscript file changes, whereas ghostview + does not. However, different versions of gv have slightly dif- + ferent ways of writing this option. You can configure this variable appropriately. WARNING: Linux systems may have installed one (or more) versions - of gv under different names, e.g., ggv, kghostview, etc, but + of gv under different names, e.g., ggv, kghostview, etc, but perhaps not one actually called gv. - Important note: Normally you will want to have a previewer run + Important note: Normally you will want to have a previewer run detached, so that latexmk doesn't wait for the previewer to ter- - minate before continuing its work. So normally you should pre- - fix the command by "start ", which flags to latexmk that it - should do the detaching of the previewer itself (by whatever - method is appropriate to the operating system). But sometimes + minate before continuing its work. So normally you should pre- + fix the command by "start ", which flags to latexmk that it + should do the detaching of the previewer itself (by whatever + method is appropriate to the operating system). But sometimes letting latexmk do the detaching is not appropriate (for a vari- - ety of non-trivial reasons), so you should put the "start " bit + ety of non-trivial reasons), so you should put the "start " bit in yourself, whenever it is needed. - $ps_previewer_landscape ["start gv -swap %O %S", but start %O %S under + $ps_previewer_landscape ["start gv -swap %O %S", but start %O %S under MS-Windows] The command to invoke a ps-previewer in landscape mode. $ps_update_command [""] - When the postscript previewer is set to be updated by running a - command, this is the command that is run. See the information + When the postscript previewer is set to be updated by running a + command, this is the command that is run. See the information for the variable $ps_update_method. - - - 18 June 2019 53 + 26 December 2019 54 @@ -3503,24 +3569,24 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $ps_update_method [0 under UNIX, 1 under MS-Windows] - How the postscript viewer updates its display when the .ps file - has changed. See the information on the variable $dvi_up- - date_method for the codes. (Note that information needs be + How the postscript viewer updates its display when the .ps file + has changed. See the information on the variable $dvi_up- + date_method for the codes. (Note that information needs be changed slightly so that for the value 4, to run a command to do - the update, the command is specified by the variable $ps_up- - date_command, and for the value 2, to specify update by signal, + the update, the command is specified by the variable $ps_up- + date_command, and for the value 2, to specify update by signal, the signal is specified by $ps_update_signal.) - $ps_update_signal [Under UNIX: SIGHUP, which is a system-dependent + $ps_update_signal [Under UNIX: SIGHUP, which is a system-dependent value] - The number of the signal that is sent to the pdf viewer when it - is updated by sending a signal -- see $ps_update_method. The + The number of the signal that is sent to the pdf viewer when it + is updated by sending a signal -- see $ps_update_method. The default value is the one appropriate for gv on a UNIX system. $pvc_timeout [0] - If this variable is nonzero, there will be a timeout in pvc - mode after a period of inactivity. Inactivity means a period - when latexmk has detected no file changes and hence has not + If this variable is nonzero, there will be a timeout in pvc + mode after a period of inactivity. Inactivity means a period + when latexmk has detected no file changes and hence has not taken any actions like compiling the document. The period of in- activity is in the variable $pvc_timeout_mins. @@ -3536,30 +3602,30 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $quote_filenames [1] This specifies whether substitutions for placeholders in command specifications (as in $pdflatex) are surrounded by double - 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 + 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 la- - tex and pdflatex cannot correctly deal with TeX files whose - names contain spaces. Latexmk's quoting only ensures that such + tex and pdflatex cannot correctly deal with TeX files whose + names contain spaces. Latexmk's quoting only ensures that such filenames are correctly treated by the operating system in pass- ing arguments to programs.) $recorder [1] - Whether to use the -recorder option to latex and pdflatex. Use - of this option results in a file of extension .fls containing a - 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- + 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. - 18 June 2019 54 + 26 December 2019 55 @@ -3568,64 +3634,64 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - It is generally recommended to use this option (or to configure + It is generally recommended to use this option (or to configure the $recorder variable to be on.) But it only works if (pdf)la- - tex supports the -recorder option, which is true for most cur- + tex supports the -recorder option, which is true for most cur- rent implementations - Note about the name of the .fls file: Most implementations of - (pdf)latex produce an .fls file with the same basename as the - main document's LaTeX, e.g., for Document.tex, the .fls file is - Document.fls. However, some implementations instead produce - files named for the program, i.e., latex.fls or pdflatex.fls. - In this second case, latexmk copies the latex.fls or pdfla- - tex.fls to a file with the basename of the main LaTeX document, + Note about the name of the .fls file: Most implementations of + (pdf)latex produce an .fls file with the same basename as the + main document's LaTeX, e.g., for Document.tex, the .fls file is + Document.fls. However, some implementations instead produce + files named for the program, i.e., latex.fls or pdflatex.fls. + In this second case, latexmk copies the latex.fls or pdfla- + tex.fls to a file with the basename of the main LaTeX document, e.g., Document.fls. $search_path_separator [See below for default] The character separating paths in the environment variables TEX- - INPUTS, BIBINPUTS, and BSTINPUTS. This variable is mainly used - by latexmk when the -outdir, -output-directory, -auxdir, and/or - -aux-directory options are used. In that case latexmk needs to + INPUTS, BIBINPUTS, and BSTINPUTS. This variable is mainly used + by latexmk when the -outdir, -output-directory, -auxdir, and/or + -aux-directory options are used. In that case latexmk needs to communicate appropriately modified search paths to bibtex, dvipdf, dvips, and (pdf)latex. - [Comment to technically savvy readers: (pdf)latex doesn't actu- - ally need the modified search path. But, surprisingly, dvipdf - and dvips do, because sometimes graphics files get generated in + [Comment to technically savvy readers: (pdf)latex doesn't actu- + ally need the modified search path. But, surprisingly, dvipdf + and dvips do, because sometimes graphics files get generated in the output or aux directories.] - The default under MSWin and Cygwin is ';' and under UNIX-like - operating systems (including Linux and OS-X) is ':'. Normally - the defaults give correct behavior. But there can be difficul- - ties if your operating system is of one kind, but some of your - software is running under an emulator for the other kind of op- - erating system; in that case you'll need to find out what is - needed, and set $search_path_separator explicitly. (The same - goes, of course, for unusual operating systems that are not in + The default under MSWin and Cygwin is ';' and under UNIX-like + operating systems (including Linux and OS-X) is ':'. Normally + the defaults give correct behavior. But there can be difficul- + ties if your operating system is of one kind, but some of your + software is running under an emulator for the other kind of op- + erating system; in that case you'll need to find out what is + needed, and set $search_path_separator explicitly. (The same + goes, of course, for unusual operating systems that are not in the MSWin, Linux, OS-X, Unix collection.) $show_time [0] Whether to show CPU time used. $silence_logfile_warnings [0] - Whether after a run of (pdf)latex to summarize warnings in the + Whether after a run of (pdf)latex to summarize warnings in the log file about undefined citations and references. Setting $si- lence_logfile_warnings=0 gives the summary of warnings (provided - silent mode isn't also set), and this is useful to locate unde- - fined citations and references without searching through the - much more verbose log file or the screen output of (pdf)latex. - But the summary can also be excessively annoying. The default - is not to give these warnings. The command line options -si- - lence_logfile_warning_list and -silence_logfile_warning_list- + silent mode isn't also set), and this is useful to locate unde- + fined citations and references without searching through the + much more verbose log file or the screen output of (pdf)latex. + But the summary can also be excessively annoying. The default + is not to give these warnings. The command line options -si- + lence_logfile_warning_list and -silence_logfile_warning_list- also set this variable. - Note that multiple occurrences for the same undefined object on - the same page and same line will be compressed to a single + Note that multiple occurrences for the same undefined object on + the same page and same line will be compressed to a single - 18 June 2019 55 + 26 December 2019 56 @@ -3637,24 +3703,24 @@ LATEXMK(1) General Commands Manual LATEXMK(1) warning. $silent [0] - Whether to run silently. Setting $silent to 1 has the same ef- + Whether to run silently. Setting $silent to 1 has the same ef- fect as the -quiet of -silent options on the command line. $sleep_time [2] - The time to sleep (in seconds) between checking for source file + The time to sleep (in seconds) between checking for source file changes when running with the -pvc option. This is subject to a - minimum of one second delay, except that zero delay is also al- + minimum of one second delay, except that zero delay is also al- lowed. - A value of exactly 0 gives no delay, and typically results in + A value of exactly 0 gives no delay, and typically results in 100% CPU usage, which may not be desirable. $texfile_search [""] - This is an obsolete variable, replaced by the @default_files + This is an obsolete variable, replaced by the @default_files variable. - For backward compatibility, if you choose to set $tex- - file_search, it is a string of space-separated filenames, and + For backward compatibility, if you choose to set $tex- + file_search, it is a string of space-separated filenames, and then latexmk replaces @default_files with the filenames in $tex- file_search to which is added "*.tex". @@ -3662,36 +3728,36 @@ LATEXMK(1) General Commands Manual LATEXMK(1) See the documentation for $compiling_cmd. $tmpdir [See below for default] - Directory to store temporary files that latexmk may generate + Directory to store temporary files that latexmk may generate while running. - The default under MSWindows (including cygwin), is to set $tm- - pdir to the value of the first of whichever of the system envi- - ronment variables TMPDIR or TEMP exists, otherwise to the cur- - rent directory. Under other operating systems (expected to be - UNIX/Linux, including OS-X), the default is the value of the - system environment variable TMPDIR if it exists, otherwise + The default under MSWindows (including cygwin), is to set $tm- + pdir to the value of the first of whichever of the system envi- + ronment variables TMPDIR or TEMP exists, otherwise to the cur- + rent directory. Under other operating systems (expected to be + UNIX/Linux, including OS-X), the default is the value of the + system environment variable TMPDIR if it exists, otherwise "/tmp". $use_make_for_missing_files [0] Whether to use make to try and make files that are missing after - a run of latex or pdflatex, and for which a custom dependency - has not been found. This is generally useful only when latexmk - is used as part of a bigger project which is built by using the + a run of latex or pdflatex, and for which a custom dependency + has not been found. This is generally useful only when latexmk + is used as part of a bigger project which is built by using the make program. Note that once a missing file has been made, no further calls to - make will be made on a subsequent run of latexmk to update the - file. Handling this problem is the job of a suitably defined - Makefile. See the section "USING latexmk WITH make" for how to - do this. The intent of calling make from latexmk is merely to + make will be made on a subsequent run of latexmk to update the + file. Handling this problem is the job of a suitably defined + Makefile. See the section "USING latexmk WITH make" for how to + do this. The intent of calling make from latexmk is merely to detect dependencies. - 18 June 2019 56 + 26 December 2019 57 @@ -3701,63 +3767,63 @@ LATEXMK(1) General Commands Manual LATEXMK(1) $view ["default"] - Which kind of file is to be previewed if a previewer is used. - The possible values are "default", "dvi", "ps", "pdf". The + Which kind of file is to be previewed if a previewer is used. + The possible values are "default", "dvi", "ps", "pdf". The value of "default" means that the "highest" of the kinds of file generated is to be used (among .dvi, .ps and .pdf). $warnings_as_errors [0] - Normally latexmk copies the behavior of latex in treating unde- - fined references and citations and multiply defined references - as conditions that give a warning but not an error. The vari- + Normally latexmk copies the behavior of latex in treating unde- + fined references and citations and multiply defined references + as conditions that give a warning but not an error. The vari- able $warnings_as_errors controls whether this behavior is modi- fied. - When the variable is non-zero, latexmk at the end of its run - will return a non-zero status code to the operating system if - any of the files processed gives a warning about problems with + When the variable is non-zero, latexmk at the end of its run + will return a non-zero status code to the operating system if + any of the files processed gives a warning about problems with citations or references (i.e., undefined citations or references or multiply defined references). This is after latexmk has com- - pleted all the runs it needs to try and resolve references and - citations. Thus $warnings_as_errors being nonzero causes la- + pleted all the runs it needs to try and resolve references and + citations. Thus $warnings_as_errors being nonzero causes la- texmk to treat such warnings as errors, but only when they occur - on the last run of (pdf)latex and only after processing is com- - plete. A non-zero value $warnings_as_errors can be set by the + on the last run of (pdf)latex and only after processing is com- + plete. A non-zero value $warnings_as_errors can be set by the command-line option -Werror. The default behavior is normally satisfactory in the usual edit- - compile-edit cycle. But, for example, latexmk can also be used - as part of a build process for some bigger project, e.g., for - creating documentation in the build of a software application. - Then it is often sensible to treat citation and reference warn- - ings as errors that require the overall build process to be - aborted. Of course, since multiple runs of (pdf)latex are gen- - erally needed to resolve references and citations, what matters - is not the warnings on the first run, but the warnings on the + compile-edit cycle. But, for example, latexmk can also be used + as part of a build process for some bigger project, e.g., for + creating documentation in the build of a software application. + Then it is often sensible to treat citation and reference warn- + ings as errors that require the overall build process to be + aborted. Of course, since multiple runs of (pdf)latex are gen- + erally needed to resolve references and citations, what matters + is not the warnings on the first run, but the warnings on the last run; latexmk takes this into account appropriately. - In addition, when preview-continuous mode is used, a non-zero - value for $warnings_as_errors changes the use of the commands - $failure_cmd, $warning_cmd, and $success_cmd after a complia- + In addition, when preview-continuous mode is used, a non-zero + value for $warnings_as_errors changes the use of the commands + $failure_cmd, $warning_cmd, and $success_cmd after a complia- tion. If there are citation or reference warnings, but no other - errors, the behavior is as follows. If $warning_cmd is set, it - is used. If it is not set, then then if $warnings_as_errors is - non-zero and $failure_cmd is set, then $failure_cmd. Otherwise - $success_cmd is used, if it is set. (The foregoing explanation + errors, the behavior is as follows. If $warning_cmd is set, it + is used. If it is not set, then then if $warnings_as_errors is + non-zero and $failure_cmd is set, then $failure_cmd. Otherwise + $success_cmd is used, if it is set. (The foregoing explanation is rather complicated, because latexmk has to deal with the case that one or more of the commands isn't set.) $xdvipdfmx ["xdvipdfmx -o %D %O %S"] - The program to make a pdf file from an xdv file (used in con- + The program to make a pdf file from an xdv file (used in con- junction with xelatex when $pdf_mode=5). - 18 June 2019 57 + 26 December 2019 58 @@ -3770,50 +3836,52 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Switch(es) for the xdvipdfmx program when silent mode is on. $xelatex ["xelatex %O %S"] - Specifies the command line for the LaTeX processing program of - when the xelatex program is called for. See the documentation - of the -xelatex option for some special properties of latexmk's + Specifies the command line for the LaTeX processing program of + when the xelatex program is called for. See the documentation + of the -xelatex option for some special properties of latexmk's use of xelatex. - Note about xelatex: Now latexmk uses xelatex to make an .xdv - rather than .pdf file, with the .pdf file being created in a - separate step. This is enforced by the use of the -no-pdf op- - tion. If %O is part of the command for invoking xelatex, then - latexmk will insert the -no-pdf option automatically, otherwise - you must provide the option yourself + Note about xelatex: latexmk uses xelatex to make an .xdv rather + than .pdf file, with the .pdf file being created in a separate + step. This is enforced by the use of the -no-pdf option. If %O + is part of the command for invoking xelatex, then latexmk will + insert the -no-pdf option automatically, otherwise you must pro- + vide the option yourself. See the documentation for the -pdfxe + option for why latexmk makes a .xdv file rather than a .pdf file + when xelatex is used. To do a coordinated setting of all of $latex, $pdflatex, $luala- tex, and $xelatex, see the section "Advanced Configuration". %xelatex_input_extensions - This variable specifies the extensions tried by latexmk when it - finds that an xelatex run resulted in an error that a file has - not been found, and the file is given without an extension. - This typically happens when LaTeX commands of the form \in- - put{file} or \includegraphics{figure}, when the relevant source + This variable specifies the extensions tried by latexmk when it + finds that an xelatex run resulted in an error that a file has + not been found, and the file is given without an extension. + This typically happens when LaTeX commands of the form \in- + put{file} or \includegraphics{figure}, when the relevant source file does not exist. - In this situation, latexmk searches for custom dependencies to - make the missing file(s), but restricts it to the extensions - specified by the variable %xelatex_input_extensions. The de- + In this situation, latexmk searches for custom dependencies to + make the missing file(s), but restricts it to the extensions + specified by the variable %xelatex_input_extensions. The de- fault 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 + 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 + See details of the $latex_silent_switch for other information that equally applies to $xelatex_silent_switch. CUSTOM DEPENDENCIES - In any RC file a set of custom dependencies can be set up to convert a + In any RC file a set of custom dependencies can be set up to convert a file with one extension to a file with another. An example use of this would be to allow latexmk to convert a .fig file to .eps to be included in the .tex file. @@ -3821,9 +3889,7 @@ CUSTOM DEPENDENCIES - - - 18 June 2019 58 + 26 December 2019 59 @@ -3834,9 +3900,9 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Defining a custom dependency: The old method of configuring latexmk to use a custom dependency was to - directly manipulate the @cus_dep_list array that contains information - defining the custom dependencies. (See the section "Old Method of - Defining Custom Dependencies" for details.) This method still works, + directly manipulate the @cus_dep_list array that contains information + defining the custom dependencies. (See the section "Old Method of + Defining Custom Dependencies" for details.) This method still works, but is no longer preferred. A better method is to use the subroutines that allow convenient manipu- @@ -3849,47 +3915,47 @@ LATEXMK(1) General Commands Manual LATEXMK(1) The arguments are as follows: from extension: - The extension of the file we are converting from (e.g. "fig"). + The extension of the file we are converting from (e.g. "fig"). It is specified without a period. to extension: The extension of the file we are converting to (e.g. "eps"). It is specified without a period. - must: If non-zero, the file from which we are converting must exist, - if it doesn't exist latexmk will give an error message and exit + must: If non-zero, the file from which we are converting must exist, + if it doesn't exist latexmk will give an error message and exit unless the -f option is specified. If must is zero and the file - we are converting from doesn't exist, then no action is taken. + we are converting from doesn't exist, then no action is taken. Generally, the appropriate value of must is zero. function: - The name of the subroutine that latexmk should call to perform - the file conversion. The first argument to the subroutine is + The name of the subroutine that latexmk should call to perform + the file conversion. The first argument to the subroutine is the base name of the file to be converted without any extension. - The subroutines are declared in the syntax of Perl. The func- - tion should return 0 if it was successful and a nonzero number + The subroutines are declared in the syntax of Perl. The func- + tion should return 0 if it was successful and a nonzero number if it failed. - Naturally add_cus_dep adds a custom dependency with the specified from - and to extensions. If a custom dependency has been previously defined - (e.g., in an rcfile that was read earlier), then it is replaced by the + Naturally add_cus_dep adds a custom dependency with the specified from + and to extensions. If a custom dependency has been previously defined + (e.g., in an rcfile that was read earlier), then it is replaced by the new one. - The subroutine remove_cus_dep removes the specified custom dependency. + The subroutine remove_cus_dep removes the specified custom dependency. The subroutine show_cus_dep causes a list of the currently defined cus- tom dependencies to be sent to the screen output. How custom dependencies are used: An instance of a custom dependency rule is created whenever latexmk de- - tects that a run of latex/pdflatex needs to read a file, like a graph- - ics file, whose extension is the to-extension of a custom dependency. - Then latexmk examines whether a file exists with the same name, but + tects that a run of latex/pdflatex needs to read a file, like a graph- + ics file, whose extension is the to-extension of a custom dependency. + Then latexmk examines whether a file exists with the same name, but - 18 June 2019 59 + 26 December 2019 60 @@ -3898,45 +3964,45 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - with the corresponding from-extension, as specified in the custom-de- - pendency. If it does, then a corresponding instance of the custom de- - pendency is created, after which the rule is invoked whenever the des- - tination file (the one with the to-extension) is out-of-date with re- + with the corresponding from-extension, as specified in the custom-de- + pendency. If it does, then a corresponding instance of the custom de- + pendency is created, after which the rule is invoked whenever the des- + tination file (the one with the to-extension) is out-of-date with re- spect to the corresponding source file. - To make the new destination file, the Perl subroutine specified in the + To make the new destination file, the Perl subroutine specified in the rule is invoked, with an argument that is the base name of the files in - question. Simple cases just involve a subroutine invoking an external - program; this can be done by following the templates below, even by - those without knowledge of the Perl programming language. Of course, + question. Simple cases just involve a subroutine invoking an external + program; this can be done by following the templates below, even by + those without knowledge of the Perl programming language. Of course, experts could do something much more elaborate. - One item in the specification of each custom-dependency rule, labeled - "must" above, specifies how the rule should be applied when the source + One item in the specification of each custom-dependency rule, labeled + "must" above, specifies how the rule should be applied when the source file fails to exist. - When latex reports that an input file (e.g., a graphics file) does not + When latex reports that an input file (e.g., a graphics file) does not exist, latexmk tries to find a source file and a custom dependency that can be used to make it. If it succeeds, then it creates an instance of - the custom dependency and invokes it to make the missing file, after + the custom dependency and invokes it to make the missing file, after which the next pass of latex etc will be able to read the newly created file. - Note for advanced usage: The operating system's environment variable + Note for advanced usage: The operating system's environment variable TEXINPUTS can be used to specify a search path for finding files by la- - tex etc. Correspondingly, when a missing file is reported, latexmk - looks in the directories specified in TEXINPUTS as well as in the cur- - rent directory, to find a source file from which an instance of a cus- + tex etc. Correspondingly, when a missing file is reported, latexmk + looks in the directories specified in TEXINPUTS as well as in the cur- + rent directory, to find a source file from which an instance of a cus- tom dependency can be used to make the missing file. Function to implement custom dependency, traditional method: - The function that implements a custom dependency gets the information + The function that implements a custom dependency gets the information on the files to be processed in two ways. The first is through its one - argument; the argument contains the base name of the source and desti- + argument; the argument contains the base name of the source and desti- nation files. The second way is described later. - A simple and typical example of code in an initialization rcfile using + A simple and typical example of code in an initialization rcfile using the first method is: add_cus_dep( 'fig', 'eps', 0, 'fig2eps' ); @@ -3944,18 +4010,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) system( "fig2dev -Leps \"$_[0].fig\" \"$_[0].eps\"" ); } - The first line adds a custom dependency that converts a file with ex- + The first line adds a custom dependency that converts a file with ex- tension "fig", as created by the xfig program, to an encapsulated post- - script file, with extension "eps". The remaining lines define a sub- - routine that carries out the conversion. If a rule for converting - "fig" to "eps" files already exists (e.g., from a previously read-in - initialization file), the latexmk will delete this rule before making + script file, with extension "eps". The remaining lines define a sub- + routine that carries out the conversion. If a rule for converting + "fig" to "eps" files already exists (e.g., from a previously read-in + initialization file), the latexmk will delete this rule before making the new one. - 18 June 2019 60 + 26 December 2019 61 @@ -3964,24 +4030,24 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - Suppose latexmk is using this rule to convert a file "figure.fig" to - "figure.eps". Then it will invoke the fig2eps subroutine defined in - the above code with a single argument "figure", which is the basename - of each of the files (possibly with a path component). This argument - is referred to by Perl as $_[0]. In the example above, the subroutine + Suppose latexmk is using this rule to convert a file "figure.fig" to + "figure.eps". Then it will invoke the fig2eps subroutine defined in + the above code with a single argument "figure", which is the basename + of each of the files (possibly with a path component). This argument + is referred to by Perl as $_[0]. In the example above, the subroutine uses the Perl command system to invoke the program fig2dev. The double quotes around the string are a Perl idiom that signify that each string - of the form of a variable name, $_[0] in this case, is to be substi- + of the form of a variable name, $_[0] in this case, is to be substi- tuted by its value. - If the return value of the subroutine is non-zero, then latexmk will - assume an error occurred during the execution of the subroutine. In - the above example, no explicit return value is given, and instead the - return value is the value returned by the last (and only) statement, + If the return value of the subroutine is non-zero, then latexmk will + assume an error occurred during the execution of the subroutine. In + the above example, no explicit return value is given, and instead the + return value is the value returned by the last (and only) statement, i.e., the invocation of system, which returns the value 0 on success. - If you use pdflatex instead of latex, then you will probably prefer to - convert your graphics files to pdf format, in which case you would re- + 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 re- place the above code in an initialization file by add_cus_dep( 'fig', 'pdf, 0, 'fig2pdf' ); @@ -3989,39 +4055,39 @@ LATEXMK(1) General Commands Manual LATEXMK(1) system( "fig2dev -Lpdf \"$_[0].fig\" \"$_[0].pdf\"" ); } - Note 1: In the command lines given in the system commands in the above - examples, double quotes have been inserted around the file names (im- - plemented by '\"' in the Perl language). They immunize the running of - the program against special characters in filenames. Very often these - quotes are not necessary, i.e., they can be omitted. But it is nor- - mally safer to keep them in. Even though the rules for quoting vary - between operating systems, command shells and individual pieces of + Note 1: In the command lines given in the system commands in the above + examples, double quotes have been inserted around the file names (im- + plemented by '\"' in the Perl language). They immunize the running of + the program against special characters in filenames. Very often these + quotes are not necessary, i.e., they can be omitted. But it is nor- + mally 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 cases I have tested. - Note 2: One case in which the quotes are important is when the files - are in a subdirectory and your operating system is Microsoft Windows. - Then the separator character for directory components can be either a - forward slash '/' or Microsoft's more usual backward slash '\'. For- - ward slashes are generated by latexmk, to maintain its sanity from - software like MiKTeX that mixes both directory separators; but their + Note 2: One case in which the quotes are important is when the files + are in a subdirectory and your operating system is Microsoft Windows. + Then the separator character for directory components can be either a + forward slash '/' or Microsoft's more usual backward slash '\'. For- + ward slashes are generated by latexmk, to maintain its sanity from + software like MiKTeX that mixes both directory separators; but their correct use normally requires quoted filenames. (See a log file from a - run of MiKTeX (at least in v. 2.9) for an example of the use of both + run of MiKTeX (at least in v. 2.9) for an example of the use of both directory separators.) - Note 3: The subroutines implementing custom dependencies in the exam- - ples given just have a single line invoking an external program. - That's the usual situation. But since the subroutines are in the Perl - language, you can implement much more complicated processing if you + Note 3: The subroutines implementing custom dependencies in the exam- + ples given just have a single line invoking an external program. + That's the usual situation. But since the subroutines are in the Perl + language, you can implement much more complicated processing if you need it. Removing custom dependencies, and when you might need to do this: - If you have some general custom dependencies defined in the system or + If you have some general custom dependencies defined in the system or - 18 June 2019 61 + 26 December 2019 62 @@ -4030,18 +4096,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - user initialization file, you may find that for a particular project - they are undesirable. So you might want to delete the unneeded ones. - A situation where this would be desirable is where there are multiple - custom dependencies with the same from-extension or the same to-exten- - sion. In that case, latexmk might choose a different one from the one + user initialization file, you may find that for a particular project + they are undesirable. So you might want to delete the unneeded ones. + A situation where this would be desirable is where there are multiple + custom dependencies with the same from-extension or the same to-exten- + sion. In that case, latexmk might choose a different one from the one you want for a specific project. As an example, to remove any "fig" to "eps" rule you would use: remove_cus_dep( 'fig', 'eps' ); - If you have complicated sets of custom dependencies, you may want to - get a listing of the custom dependencies. This is done by using the + If you have complicated sets of custom dependencies, you may want to + get a listing of the custom dependencies. This is done by using the line show_cus_dep(); @@ -4052,29 +4118,29 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Function implementing custom dependency, alternative methods: So far the examples for functions to implement custom dependencies have used the argument of the function to specify the base name of converted - file. This method has been available since very old versions of la- + file. This method has been available since very old versions of la- texmk, and many examples can be found, e.g., on the web. - However in later versions of latexmk the internal structure of the im- + However in later versions of latexmk the internal structure of the im- plementation of its "rules" for the steps of processing, including cus- tom dependencies, became much more powerful. The function implementing a custom dependency is executed within a special context where a number - of extra variables and subroutines are defined. Publicly documented - ones, intended to be long-term stable, are listed below, under the + of extra variables and subroutines are defined. Publicly documented + ones, intended to be long-term stable, are listed below, under the heading "Variables and subroutines for processing a rule". - Examples of their use is given in the following examples, concerning + Examples of their use is given in the following examples, concerning multiple index files and glossaries. - The only index-file conversion built-in to latexmk is from an ".idx" - file written on one run of latex/pdflatex to an ".ind" file to be read - in on a subsequent run. But with the index.sty package, for example, - you can create extra indexes with extensions that you configure. La- - texmk does not know how to deduce the extensions from the information - it has. But you can easily write a custom dependency. For example if - your latex file uses the command "\newindex{special}{ndx}{nnd}{Special - index}" you will need to get latexmk to convert files with the exten- - sion .ndx to .nnd. The most elementary method is to define a custom + The only index-file conversion built-in to latexmk is from an ".idx" + file written on one run of latex/pdflatex to an ".ind" file to be read + in on a subsequent run. But with the index.sty package, for example, + you can create extra indexes with extensions that you configure. La- + texmk does not know how to deduce the extensions from the information + it has. But you can easily write a custom dependency. For example if + your latex file uses the command "\newindex{special}{ndx}{nnd}{Special + index}" you will need to get latexmk to convert files with the exten- + sion .ndx to .nnd. The most elementary method is to define a custom dependency as follows: add_cus_dep( 'ndx', 'nnd', 0, 'ndx2nnd' ); @@ -4083,11 +4149,11 @@ LATEXMK(1) General Commands Manual LATEXMK(1) } push @generated_exts, 'ndx', 'nnd'; - Notice the added line compared with earlier examples. The extra line + Notice the added line compared with earlier examples. The extra line - 18 June 2019 62 + 26 December 2019 63 @@ -4100,9 +4166,9 @@ LATEXMK(1) General Commands Manual LATEXMK(1) generated files; then the extra index files will be deleted by clean-up operations - But if you have yet more indexes with yet different extensions, e.g., - "adx" and "and", then you will need a separate function for each pair - of extensions. This is quite annoying. You can use the Run_subst + But if you have yet more indexes with yet different extensions, e.g., + "adx" and "and", then you will need a separate function for each pair + of extensions. This is quite annoying. You can use the Run_subst function to simplify the definitions to use a single function: add_cus_dep( 'ndx', 'nnd', 0, 'dx2nd' ); @@ -4121,39 +4187,39 @@ LATEXMK(1) General Commands Manual LATEXMK(1) } push @generated_exts, 'ndx', 'nnd', 'adx', 'and'; - This last example uses the command specification in $makeindex, and so - any customization you have made for the standard index also applies to + This last example uses the command specification in $makeindex, and so + any customization you have made for the standard index also applies to your extra indexes. Similar techniques can be applied for glossaries. Those of you with experience with Makefiles, may get concerned that the .ndx file is written during a run of latex/pdflatex and is always later - than the .nnd last read in. Thus the .nnd appears to be perpetually - out-of-date. This situation, of circular dependencies, is endemic to + than the .nnd last read in. Thus the .nnd appears to be perpetually + out-of-date. This situation, of circular dependencies, is endemic to latex, and is one of the issues that latexmk is programmed to overcome. - It examines the contents of the files (by use of a checksum), and only + It examines the contents of the files (by use of a checksum), and only does a remake when the file contents have actually changed. - Of course if you choose to write random data to the .nnd (or the .aux - file, etc) that changes on each new run, then you will have a problem. - For real experts: See the %hash_cal_ignore_pattern if you have to deal + Of course if you choose to write random data to the .nnd (or the .aux + 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. Old Method of Defining Custom Dependencies: - In much older versions of latexmk, the only method of defining custom - dependencies was to directly manipulate the table of custom dependen- + In much older versions of latexmk, the only method of defining custom + dependencies was to directly manipulate the table of custom dependen- cies. This is contained in the @cus_dep_list array. It is an array of - strings, and each string in the array has four items in it, each sepa- - rated by a space, the from-extension, the to-extension, the "must" - item, and the name of the subroutine for the custom dependency. These + strings, and each string in the array has four items in it, each sepa- + rated by a space, the from-extension, the to-extension, the "must" + item, and the name of the subroutine for the custom dependency. These were all defined above. - 18 June 2019 63 + 26 December 2019 64 @@ -4163,7 +4229,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) An example of the old method of defining custom dependencies is as fol- - lows. It is the code in an RC file to ensure automatic conversion of + lows. It is the code in an RC file to ensure automatic conversion of .fig files to .eps files: push @cus_dep_list, "fig eps 0 fig2eps"; @@ -4171,21 +4237,21 @@ LATEXMK(1) General Commands Manual LATEXMK(1) return system( "fig2dev -Lps \"$_[0].fig\" \"$_[0].eps\"" ); } - This method still works, and is almost equivalent to the code given - earlier that used the add_cus_dep subroutine. However, the old method - doesn't delete any previous custom-dependency for the same conversion. + This method still works, and is almost equivalent to the code given + earlier that used the add_cus_dep subroutine. However, the old method + doesn't delete any previous custom-dependency for the same conversion. So the new method is preferable. ADVANCED CONFIGURATION: Some extra resources and advanced tricks - For most purposes, simple configuration for latexmk along the lines of - the examples given is sufficient. But sometimes you need something - harder. In this section, I indicate some extra possibilities. Gener- - ally to use these, you need to be fluent in the Perl language, since + For most purposes, simple configuration for latexmk along the lines of + the examples given is sufficient. But sometimes you need something + harder. In this section, I indicate some extra possibilities. Gener- + ally to use these, you need to be fluent in the Perl language, since this is what is used in the rc files. - See also the section DEALING WITH ERRORS, PROBLEMS, ETC. See also the + 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 you use- ful ideas @@ -4194,13 +4260,13 @@ ADVANCED CONFIGURATION: Some extra resources and advanced tricks Utility subroutines ensure_path( var, values ...) - The first parameter is the name of one of the system's environ- - ment variables for search paths. The remaining parameters are - values that should be in the variable. For each of the value - parameters, if it isn't already in the variable, then it is + The first parameter is the name of one of the system's environ- + ment variables for search paths. The remaining parameters are + values that should be in the variable. For each of the value + parameters, if it isn't already in the variable, then it is prepended to the variable; in that case the environment variable - is created if it doesn't already exist. For separating values, - the character appropriate the the operating system is used -- + is created if it doesn't already exist. For separating values, + the character appropriate the the operating system is used -- see the configuration variable $search_path_separator. Example: @@ -4211,15 +4277,15 @@ ADVANCED CONFIGURATION: Some extra resources and advanced tricks to mean that latex, pdflatex, etc search for files in the speci- fied directory and in all subdirectories.) - Technically ensure_path works by setting Perl's variable - $ENV{var}, where var is the name of the target variable. The - changed value is then passed as an environment variable to any + Technically ensure_path works by setting Perl's variable + $ENV{var}, where var is the name of the target variable. The + changed value is then passed as an environment variable to any invoked programs. - 18 June 2019 64 + 26 December 2019 65 @@ -4230,22 +4296,22 @@ 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- + 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 + When you use a subroutine for processing a rule, all the possibilities of Perl programming are available, of course. In addition, some of la- - texmk's internal variables and subroutines are available. The ones - listed below are intended to be available to (advanced) users, and + texmk's internal variables and subroutines are available. The ones + listed below are intended to be available to (advanced) users, and their specifications will generally have stability under upgrades. Gen- - erally, the variables should be treated as read-only: Changing their - values can have bad consequences, since it is liable to mess up the + erally, the variables should be treated as read-only: Changing their + values can have bad consequences, since it is liable to mess up the consistency of what latexmk is doing. - $rule This variable has the name of the rule, as known to latexmk. - Note that the exact contents of this variable for a given rule + $rule This variable has the name of the rule, as known to latexmk. + Note that the exact contents of this variable for a given rule may be dependent on the version of latexmk $$Psource @@ -4253,31 +4319,31 @@ LATEXMK(1) General Commands Manual LATEXMK(1) dollar signs. $$Pdest - This gives the name of the main output file if any. Note the + This gives the name of the main output file if any. Note the double dollar signs. rdb_ensure_file( $rule, file ) - This a subroutine that ensures that the given file is among the + This a subroutine that ensures that the given file is among the source files for the specified rule. It is typically used when, - during the processing of a rule, it is known that a particular - extra file is among the dependencies that latexmk should know, + during the processing of a rule, it is known that a particular + extra file is among the dependencies that latexmk should know, but its default methods don't find the dependency. Almost always - the first argument is the name of the rule currently being pro- + the first argument is the name of the rule currently being pro- cessed, so it is then appropriate to specify it by $rule. - For examples of its use, see some of the files in the directory - example_rcfiles of latexmk's distribution. Currently the cases - that use this subroutine are bib2gls-latexmkrc, exceltex_la- - texmkrc and texinfo-latexmkrc. These illustrate typical cases - where latexmk's normal processing fails to detect certain extra + For examples of its use, see some of the files in the directory + example_rcfiles of latexmk's distribution. Currently the cases + that use this subroutine are bib2gls-latexmkrc, exceltex_la- + texmkrc and texinfo-latexmkrc. These illustrate typical cases + where latexmk's normal processing fails to detect certain extra source files. rdb_remove_files( $rule, file, ... ) - This subroutine removes one or more files from the dependency + This subroutine removes one or more files from the dependency list for the given rule. rdb_list_source( $rule ) - This subroutine returns the list of source files (i.e., the de- + This subroutine returns the list of source files (i.e., the de- pendency list) for the given rule. rdb_set_source( $rule, file, ... ) @@ -4285,7 +4351,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 65 + 26 December 2019 66 @@ -4295,63 +4361,63 @@ LATEXMK(1) General Commands Manual LATEXMK(1) rdb_set_source( $rule, @files ) - This subroutine sets the dependency list for the given rule to + This subroutine sets the dependency list for the given rule to be the specified files. Files that are already in the list have - unchanged information. Files that were not in the list are + unchanged information. Files that were not in the list are added to it. Files in the previous dependency list that are not in the newly specified list of files are removed from the depen- dency list. Run_subst( command_spec ) This subroutine runs the command specified by command_spec. The - specification is a string in the format listed in the section - "Format of Command Specifications". An important action of the + specification is a string in the format listed in the section + "Format of Command Specifications". An important action of the Run_subst is to make substitutions of placeholders, e.g., %S and - %D for source and destination files; these get substituted be- + %D for source and destination files; these get substituted be- fore the command is run. In addition, the command after substi- - tution is printed to the screen unless latexmk is running in + tution is printed to the screen unless latexmk is running in silent mode. Coordinated Setting of Commands for *latex - To set all of $latex, $pdflatex, $lualatex, and $xelatex to a common - pattern, you can use one of the following subroutines, std_tex_cmds, + To set all of $latex, $pdflatex, $lualatex, and $xelatex to a common + pattern, you can use one of the following subroutines, std_tex_cmds, alt_tex_cmds, and set_tex_cmds. They work as follows &std_tex_cmds; - This results in $latex = 'latex %O %S', and similarly for $pdflatex, - $lualatex, and $xelatex. Note the ampersand in the invocation; this + This results in $latex = 'latex %O %S', and similarly for $pdflatex, + $lualatex, and $xelatex. Note the ampersand in the invocation; this indicates to Perl that a subroutine is being called. &alt_tex_cmds; - This results in $latex = 'latex %O %P', and similarly for $pdflatex, - $lualatex, and $xelatex. Note the ampersand in the invocation; this + This results in $latex = 'latex %O %P', and similarly for $pdflatex, + $lualatex, and $xelatex. Note the ampersand in the invocation; this indicates to Perl that a subroutine is being called. set_tex_cmds( CMD_SPEC ); - Here CMD_SPEC is the command line without the program name. This re- - sults in $latex = 'CMD_SPEC', and similarly for $pdflatex, $lualatex, + Here CMD_SPEC is the command line without the program name. This re- + sults in $latex = 'CMD_SPEC', and similarly for $pdflatex, $lualatex, and $xelatex. An example would be set_tex_cmds( '--interaction=batchmode %O %S' ); Advanced configuration: Using latexmk with make - This section is targeted only at advanced users who use the make pro- + This section is targeted only at advanced users who use the make pro- gram for complex projects, as for software development, with the depen- dencies specified by a Makefile. - Now the basic task of latexmk is to run the appropriate programs to - make a viewable version of a LaTeX document. However, the usual make + 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 - 18 June 2019 66 + 26 December 2019 67 @@ -4360,32 +4426,32 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - program is not suited to this purpose for at least two reasons. First + program is not suited to this purpose for at least two reasons. First is that the use of LaTeX involves circular dependencies (e.g., via .aux files), and these cannot be handled by the standard make program. Sec- - ond is that in a large document the set of source files can change - quite frequently, particularly with included graphics files; in this - situation keeping a Makefile manually updated is inappropriate and er- + ond is that in a large document the set of source files can change + quite frequently, particularly with included graphics files; in this + situation keeping a Makefile manually updated is inappropriate and er- ror-prone, especially when the dependencies can be determined automati- cally. Latexmk solves both of these problems robustly. - Thus for many standard LaTeX documents latexmk can be used by itself - without the make program. In a complex project it simply needs to be - suitably configured. A standard configuration would be to define cus- - tom dependencies to make graphics files from their source files (e.g., - as created by the xfig program). Custom dependencies are latexmk's + Thus for many standard LaTeX documents latexmk can be used by itself + without the make program. In a complex project it simply needs to be + suitably configured. A standard configuration would be to define cus- + tom dependencies to make graphics files from their source files (e.g., + as created by the xfig program). Custom dependencies are latexmk's equivalent of pattern rules in Makefiles. - Nevertheless there are projects for which a Makefile is appropriate, + Nevertheless there are projects for which a Makefile is appropriate, and it is useful to know how to use latexmk from a Makefile. A typical example would be to generate documentation for a software project. Po- - tentially the interaction with the rest of the rules in the Makefile + tentially the interaction with the rest of the rules in the Makefile could be quite complicated, for example if some of the source files for a LaTeX document are generated by the project's software. In this section, I give a couple of examples of how latexmk can be use- - fully invoked from a Makefile. The examples use specific features of - current versions of GNU make, which is the default on both linux and + fully invoked from a Makefile. The examples use specific features of + current versions of GNU make, which is the default on both linux and OS-X systems. They may need modifications for other versions of make. The simplest method is simply to delegate all the relevant tasks to la- @@ -4397,27 +4463,27 @@ LATEXMK(1) General Commands Manual LATEXMK(1) %.pdf : %.tex FORCE_MAKE latexmk -pdf -dvi- -ps- $< - (Note: the last line must be introduced by a tab for the Makefile to - function correctly!) Naturally, if making try.pdf from its associated - LaTeX file try.tex were the only task to be performed, a direct use of - latexmk without a Makefile would normally be better. The benefit of - using a Makefile for a LaTeX document would be in a larger project, + (Note: the last line must be introduced by a tab for the Makefile to + function correctly!) Naturally, if making try.pdf from its associated + LaTeX file try.tex were the only task to be performed, a direct use of + latexmk without a Makefile would normally be better. The benefit of + using a Makefile for a LaTeX document would be in a larger project, where lines such as the above would be only be a small part of a larger Makefile. The above example has a pattern rule for making a .pdf file from a .tex - file, and it is defined to use latexmk in the obvious way. There is a + file, and it is defined to use latexmk in the obvious way. There is a conventional default target named "all", with a prerequisite of - try.pdf. So when make is invoked, by default it makes try.pdf. The - only complication is that there may be many source files beyond + try.pdf. So when make is invoked, by default it makes try.pdf. The + only complication is that there may be many source files beyond try.tex, but these aren't specified in the Makefile, so changes in them - will not by themselves cause latexmk to be invoked. Instead, the pat- - tern rule is equipped with a "phony" prerequisite FORCE_MAKE; this has - the effect of causing the rule to be always out-of-date, so that + 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 - 18 June 2019 67 + 26 December 2019 68 @@ -4426,16 +4492,16 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) - latexmk is always run. It is latexmk that decides whether any action - is needed, e.g., a rerun of pdflatex. Effectively the Makefile dele- + 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 ex- + But something better is needed in more complicated situations, for ex- ample, 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 follow- + in the Makefile. To do this, one can use a Makefile like the follow- ing: TARGETS = document1.pdf document2.pdf @@ -4454,36 +4520,36 @@ LATEXMK(1) General Commands Manual LATEXMK(1) %.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 op- - tion, which improves its detection of files generated during a run of - pdflatex; such files should not be in the dependency list. The -e op- - tions are used to turn off all custom dependencies, and to document - this. Instead the -use-make is used to delegate the making of missing + tion, which improves its detection of files generated during a run of + pdflatex; such files should not be in the dependency list. The -e op- + tions are used to turn off all custom dependencies, and to document + this. Instead the -use-make is used to delegate the making of missing files to make itself. - Suppose in the LaTeX file there is a command \includegraphics{graph}, - and an xfig file "graph.fig" exists. On a first run, pdflatex reports - a missing file, named "graph". Latexmk succeeds in making "graph.pdf" + Suppose in the LaTeX file there is a command \includegraphics{graph}, + and an xfig file "graph.fig" exists. On a first run, pdflatex reports + a missing file, named "graph". Latexmk succeeds in making "graph.pdf" by calling "make graph.pdf", and after completion of its work, it lists - 18 June 2019 68 + 26 December 2019 69 @@ -4493,10 +4559,10 @@ LATEXMK(1) General Commands Manual LATEXMK(1) "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. @@ -4505,35 +4571,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 suma- + (The following isn't really a bug, but concerns features of preview- + ers.) Preview continuous mode only works perfectly with certain pre- + viewers: Xdvi on UNIX/Linux works for dvi files. Gv on UNIX/Linux + works for both postscript and pdf. Ghostview on UNIX/Linux needs a + manual update (reopen); it views postscript and pdf. Gsview under MS- + Windows works for both postscript and pdf, but only reads the updated + file when its screen is refreshed. Acroread under UNIX/Linux views + pdf, but the file needs to be closed and reopened to view an updated + version. Under MS-Windows, acroread locks its input file and so the + pdf file cannot be updated. (Remedy: configure latexmk to use suma- trapdf instead.) THANKS TO - Authors of previous versions. Many users with their feedback, and es- + Authors of previous versions. Many users with their feedback, and es- pecially 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 stan- + useful suggestions that contributed to version 3, and Herbert Schulz. + (Please note that the e-mail addresses are not written in their stan- dard form to avoid being harvested too easily.) AUTHOR - Current version, by John Collins (username jcc8 at node psu.edu). - (Version 4.65). + Current version, by John Collins (username jcc8 at node psu.edu). + (Version 4.67). - Released version can be obtained from CTAN: - <http://www.ctan.org/pkg/latexmk/>, and from the author's website + 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) @@ -4549,7 +4615,7 @@ AUTHOR - 18 June 2019 69 + 26 December 2019 70 @@ -4615,6 +4681,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 70 + 26 December 2019 71 diff --git a/Master/texmf-dist/scripts/latexmk/latexmk.pl b/Master/texmf-dist/scripts/latexmk/latexmk.pl index 7dd5dc35e39..ca0c8c3aa4b 100755 --- a/Master/texmf-dist/scripts/latexmk/latexmk.pl +++ b/Master/texmf-dist/scripts/latexmk/latexmk.pl @@ -162,6 +162,27 @@ use warnings; ## ## 12 Jan 2012 STILL NEED TO DOCUMENT some items below ## +## 26 Dec 2019 John Collins Change place of setting of $view_file +## Make fully consistent set of options for engines: +## -latex, -latex=..., +## preserving backward compatibility, and avoiding suprises. +## 11 Dec 2019 John Collins Change rules for wrapping in log file: This deals +## with xelatex wrapping at > standard number of +## bytes in presence of non-ASCII Unicode characters. +## 4 Dec 2019 John Collins If there were missing subdirectories in output/aux +## directories, and these were successfully created, +## then ignore error from *latex, since rerun may +## succeed. +## 14 Nov 2019 John Collins Add comment. +## 12 Nov 2019 John Collins Use $compiling_cmd, $warning_cmd, $success_cmd +# on normal make, rather than just in -pvc mode. +## 5 Aug 2019 John Collins The changing of '\' to '/' in filenames is now +## done for msys as well as MSWin32. +## 8 Jul 2019 John Collins Allow addition of hook for processing lists of +## missing source files, used after run of *latex. +## 2 Jul 2019 John Collins Silence message about disallowing change of output +## file type. +## V. 4.66 ## 28 Jun 2019 John Collins Try to deal with log file parsing problems ## V. 4.65 ## 21 May 2019 John Collins Fix incorrect listings by -rules and by -deps @@ -233,8 +254,8 @@ use warnings; $my_name = 'latexmk'; $My_name = 'Latexmk'; -$version_num = '4.65'; -$version_details = "$My_name, John Collins, 18 June 2019"; +$version_num = '4.67'; +$version_details = "$My_name, John Collins, 26 Dec. 2019"; use Config; use File::Basename; @@ -359,7 +380,7 @@ $illegal_in_texname = "\x00\t\f\n\r\$%\\~\x7F"; # Hooks for customized extra processing on aux files. The following -# variable is an array of references to function. Each function is +# variable is an array of references to functions. Each function is # invoked in turn when a line of an aux file is processed (if none # of the built-in actions have been done). On entry to the function, # the following variables are set: @@ -367,6 +388,15 @@ $illegal_in_texname = "\x00\t\f\n\r\$%\\~\x7F"; # $rule = name of rule during the invocation of which, the aux file # was supposed to have been generated. @aux_hooks = (); +# Hooks for customized processing on lists of source and missing files. +# The following variable is an array of references to functions. Each +# function is invoked in turn after a run of latex (or pdflatex etc) and +# latexmk has analyzed the .log and .fls files for dependency information. +# On entry to each called function, the following variables are set: +# $rule = name of *latex rule +# %dependents: maps source files and possible source files to a status. +# See begining of sub parse_log for possible values. +@latex_file_hooks = (); ######################################################################### ## Default document processing programs, and related settings, @@ -1739,6 +1769,11 @@ while ($_ = $ARGV[0]) } elsif (/^-l$/) { $landscape_mode = 1; } elsif (/^-l-$/) { $landscape_mode = 0; } + elsif ( /^-latex$/ ) { + $pdf_mode = 0; + $postscript_mode = 0; + $dvi_mode = 1; + } elsif (/^-latex=(.*)$/) { $latex = $1; } @@ -1752,6 +1787,11 @@ while ($_ = $ARGV[0]) { $silence_logfile_warnings = 0; } elsif ( /^-logfilewarninglist-$/ || /^-logfilewarnings-$/ ) { $silence_logfile_warnings = 1; } + elsif ( /^-lualatex$/ || /^-pdflualatex$/ ) { + $pdf_mode = 4; + $dvi_mode = $postscript_mode = 0; + } +# See below for -lualatex=... # See above for -M elsif (/^-MF$/) { if ( $ARGV[0] eq '' ) { @@ -1785,18 +1825,18 @@ while ($_ = $ARGV[0]) elsif (/^-pdflua$/){ $pdf_mode = 4; } elsif (/^-pdfps$/) { $pdf_mode = 2; } elsif (/^-pdfxe$/) { $pdf_mode = 5; } -# elsif (/^-pdflatex$/) { -# $pdflatex = "pdflatex %O %S"; -# $pdf_mode = 1; -# $dvi_mode = $postscript_mode = 0; -# } + elsif (/^-pdflatex$/) { + $pdflatex = "pdflatex %O %S"; + $pdf_mode = 1; + $dvi_mode = $postscript_mode = 0; + } elsif (/^-pdflatex=(.*)$/) { $pdflatex = $1; } - elsif (/^-pdflualatex=(.*)$/) { + elsif ( /^-pdflualatex=(.*)$/ || /^-lualatex=(.*)$/ ) { $lualatex = $1; } - elsif (/^-pdfxelatex=(.*)$/) { + elsif ( /^-pdfxelatex=(.*)$/ || /^-xelatex=(.*)$/ ) { $xelatex = $1; } elsif (/^-pretex=(.*)$/) { @@ -1873,14 +1913,11 @@ while ($_ = $ARGV[0]) elsif (/^-view=ps$/) { $view = "ps";} elsif (/^-view=pdf$/) { $view = "pdf"; } elsif (/^-Werror$/){ $warnings_as_errors = 1; } - elsif (/^-lualatex$/) { - $pdf_mode = 4; - $dvi_mode = $postscript_mode = 0; - } - elsif (/^-xelatex$/) { + elsif ( /^-xelatex$/ || /^-pdfxelatex$/ ) { $pdf_mode = 5; $dvi_mode = $postscript_mode = 0; } +# See above for -xelatex=... elsif (/^-e$/) { if ( $#ARGV < 0 ) { &exit_help( "No code to execute specified after -e switch"); @@ -2267,8 +2304,10 @@ if ( $dvi_mode || $postscript_mode # the only destinations. So if ps or dvi files needed, we cannot # allow switching. (There will then be an error condition if a TeX # engine fails to produce the correct type of output file.) - warn "$My_name: Disallowing switch of output file as incompatible\n", - " with file requests.\n"; + if ($diagnostics) { + warn "$My_name: Disallowing switch of output file as incompatible\n", + " with file requests.\n"; + } $can_switch = 0; } @@ -2417,7 +2456,9 @@ foreach $filename ( @file_list ) # but %rule_db is needed in the continue block, which is not in the # scope of a local declaration here. &rdb_initialize_rules; - + $view_file = ''; + rdb_one_rule( 'view', sub{ $view_file = $$Psource; } ); + if ( $cleanup_mode > 0 ) { # ?? MAY NEED TO FIX THE FOLLOWING IF $aux_dir or $out_dir IS SET. my %other_generated = (); @@ -2645,6 +2686,7 @@ foreach $filename ( @file_list ) #Initialize failure flags now. $failure = 0; $failure_msg = ''; + if ($compiling_cmd) { Run_subst( $compiling_cmd ); } $failure = &rdb_make; if ( ( $failure <= 0 ) || $force_mode ) { rdb_for_some( [keys %one_time], \&rdb_run1 ); @@ -2656,7 +2698,13 @@ foreach $filename ( @file_list ) $failure_msg = "Warning(s) from latex (or c.) for '$filename'; treated as error"; } } - if ($failure > 0) { next FILE; } + + if ($failure > 0) { + if ($failure_cmd) { Run_subst( $failure_cmd ); } + next FILE; + } else { + if ($success_cmd) { Run_subst( $success_cmd ); } + } } # end FILE continue { if ($deps_handle) { deps_list($deps_handle); } @@ -2755,7 +2803,7 @@ sub test_fix_texnames { my $unbalanced_quote = 0; my $balanced_quote = 0; foreach (@_) { - if ( $^O eq "MSWin32" ) { + if ( ($^O eq "MSWin32") || ($^O eq "msys") ) { # On MS-Win, change directory separator '\' to '/', as needed # by the TeX engines, for which '\' introduces a macro name. # Remember that '/' is a valid directory separator in MS-Win. @@ -3461,9 +3509,6 @@ sub make_preview_continuous { $quell_uptodate_msgs = 1; - local $view_file = ''; - rdb_one_rule( 'view', sub{ $view_file = $$Psource; } ); - if ( ($view eq 'dvi') || ($view eq 'pdf') || ($view eq 'ps') ) { warn "Viewing $view\n"; } @@ -3528,8 +3573,6 @@ CHANGE: } $failure = &rdb_make; -## warn "=========Viewer PID = $$Pviewer_process; updated=$updated\n"; - if ( $MSWin_fudge_break && ($^O eq "MSWin32") ) { $SIG{BREAK} = $SIG{INT} = 'DEFAULT'; } @@ -4538,8 +4581,12 @@ sub parse_log { } } else { - # LuaTeX sometimes wraps at 80 instead of 79, so work around this - while ( ( ($len == $log_wrap) || ( ($engine eq 'LuaTeX') && ($len == $log_wrap+1) ) ) + # Xetex and luatex sometimes wrap at longer line lengths: + # LuaTeX sometimes at 80. Xetex 80 or longer with non-ascii characters. + while ( ( ($len == $log_wrap) + || ( ($engine eq 'LuaTeX') && ($len == $log_wrap+1) ) + || ( ($engine eq 'XeTeX') && ($len >= $log_wrap+1) ) + ) && !eof($log_file) ) { push @lines, $_; my $extra = <$log_file>; @@ -5893,9 +5940,10 @@ sub rdb_read_set_rule { warn " ===== CHANGING output type from '$newext' to '$oldext' in '$rule'\n"; my $switch_error = switch_output( $oldext, $newext ); if ($switch_error) { - warn " I could not accommodate the changed output extension\n", - " (either because the configuration does not allow it\n", - " or because there is a conflict with requested filetypes).\n", + warn " I could not accommodate the changed output extension.\n", + " That is either because the configuration does not allow it\n", + " or because there is a conflict with implicit or explicit requested filetypes.\n", + " (Typically that is about .dvi and/or .ps filetypes.)\n", "===> There may be subsequent warnings, which may or may not be ignorable.\n", "===> If necessary, clean out generated files and try again\n"; } @@ -6124,7 +6172,7 @@ sub rdb_set_latex_deps { } &parse_log; - $missing_dirs = 'none'; # Status of missing directories + my $missing_dirs = 'none'; # Status of missing directories if (@missing_subdirs) { $missing_dirs = 'success'; if ($allow_subdir_creation) { @@ -6424,6 +6472,10 @@ NEW_SOURCE: } } + foreach my $Psub (@latex_file_hooks) { + &$Psub; + } + # Some packages (e.g., bibtopic) generate a dummy error-message-providing # bbl file when a bbl file does not exist. Then the fls and log files # show the bbl file as created by the primary run and hence as a @@ -6470,6 +6522,8 @@ NEW_SOURCE: } rdb_remove_files( $rule, @files_not_needed ); + return ($missing_dirs, [@missing_subdirs] ); + } # END rdb_set_latex_deps #************************************************************ @@ -7949,7 +8003,7 @@ sub rdb_primary_run { } # Find current set of source files: - &rdb_set_latex_deps; + my ($missing_dirs, $PA_missing_subdirs) = &rdb_set_latex_deps; # For each file of the kind made by epstopdf.sty during a run, # if the file has changed during a run, then the new version of @@ -7981,6 +8035,12 @@ sub rdb_primary_run { if (! $silent); $return = 0; } + if ($return_latex && ($missing_dirs ne 'none') ) { + print "Error in (pdf)LaTeX, but needed subdirectories in output directory\n", + " were missing and successfully created, so try again.\n" + if (! $silent); + $return = 0; + } # Summarize issues that may have escaped notice: @primary_warning_summary = (); if ($bad_reference) { @@ -9363,6 +9423,22 @@ sub add_aux_hook { #################################################### +sub add_latex_file_hook { + # Usage: add_latex_file_hook( sub_name ) + # Add the name subroutine to the array of hooks for + # processing list of possible dependency files after a run of *latex. + # The argument is either a string naming the subroutine, e.g. + # add_latex_file_hook( 'subname' ); + # or a Perl reference to the subroutine, e.g., + # add_latex_file_hook( \&subname ); + # It is also possible to use an anonymous subroutine, e.g., + # add_latex_file_hook( sub{ code of subroutine... } ); + my ($sub_name) = @_; + push @latex_file_hooks, $sub_name; +} + +#################################################### + sub set_input_ext { # Usage: set_input_ext( rule, ext, ... ) # Set list of extension(s) (specified without a leading period) |