texlive[70835] trunk: latexmk reversion (2apr24)
commits+karl at tug.org
commits+karl at tug.org
Tue Apr 2 23:31:27 CEST 2024
Revision: 70835
https://tug.org/svn/texlive?view=revision&revision=70835
Author: karl
Date: 2024-04-02 23:31:27 +0200 (Tue, 02 Apr 2024)
Log Message:
-----------
latexmk reversion (2apr24)
Modified Paths:
--------------
trunk/Build/source/texk/texlive/linked_scripts/latexmk/latexmk.pl
trunk/Master/texmf-dist/doc/man/man1/latexmk.1
trunk/Master/texmf-dist/doc/support/latexmk/CHANGES
trunk/Master/texmf-dist/doc/support/latexmk/INSTALL
trunk/Master/texmf-dist/doc/support/latexmk/README
trunk/Master/texmf-dist/doc/support/latexmk/example_rcfiles/asymptote_latexmkrc
trunk/Master/texmf-dist/doc/support/latexmk/example_rcfiles/bib2gls_latexmkrc
trunk/Master/texmf-dist/doc/support/latexmk/latexmk.pdf
trunk/Master/texmf-dist/doc/support/latexmk/latexmk.txt
trunk/Master/texmf-dist/scripts/latexmk/latexmk.pl
Added Paths:
-----------
trunk/Master/texmf-dist/doc/support/latexmk/example_rcfiles/splitindex.latexmkrc
Modified: trunk/Build/source/texk/texlive/linked_scripts/latexmk/latexmk.pl
===================================================================
--- trunk/Build/source/texk/texlive/linked_scripts/latexmk/latexmk.pl 2024-04-01 23:43:48 UTC (rev 70834)
+++ trunk/Build/source/texk/texlive/linked_scripts/latexmk/latexmk.pl 2024-04-02 21:31:27 UTC (rev 70835)
@@ -2,8 +2,6 @@
use warnings;
use strict;
-
-
## Copyright John Collins 1998-2024
## (username jcc8 at node psu.edu)
## (and thanks to David Coppit (username david at node coppit.org)
@@ -49,8 +47,8 @@
# blocks.
$my_name = 'latexmk';
$My_name = 'Latexmk';
- $version_num = '4.84';
- $version_details = "$My_name, John Collins, 29 Mar. 2024. Version $version_num";
+ $version_num = '4.83';
+ $version_details = "$My_name, John Collins, 31 Jan. 2024. Version $version_num";
}
use Config;
@@ -367,8 +365,7 @@
#
# Single hash for various stacks of hooks:
our %hooks = ();
-for ( 'before_xlatex', 'after_xlatex', 'after_xlatex_analysis', 'after_main_pdf',
- 'cleanup', 'cleanup_extra_full' ) {
+for ( 'before_xlatex', 'after_xlatex', 'after_xlatex_analysis' ) {
$hooks{$_} = [];
}
$hooks{aux_hooks} = \@aux_hooks;
@@ -418,11 +415,7 @@
our $xelatex_silent_switch = '-interaction=batchmode';
# Whether to emulate -aux-directory, so we can use it on system(s) (TeXLive)
-# that don't support it.
-# Possible values: 0: I don't do any emulation, and use -aux-directory &
-# -out-directory options to *latex.
-# 1: Emulate MiKTeX behavior: Use -output-directory=<aux dir>
-# in call to *latex. Then move pdf (etc) files after run.
+# that don't support it:
our $emulate_aux = 1;
# Whether emulate_aux had to be switched on during a run:
our $emulate_aux_switched = 0;
@@ -749,7 +742,7 @@
# The following variables are assigned once and then used in symbolic
# references, so we need to avoid warnings 'name used only once':
-our ( $aux_dir_requested, $out_dir_requested, $out2_dir_requested );
+our ( $aux_dir_requested, $out_dir_requested );
our $dvi_update_signal = undef;
our $ps_update_signal = undef;
@@ -774,11 +767,6 @@
our $ps_update_method = 1;
our $pdf_update_method = 1;
-# Whether to allow latexmk to create subdirectories of aux_dir when there's
-# a report in the log file that *latex "can't write on file ...".
-# Values: 0: no subdir creation,
-# 1: only for aux files (occurs with \include{chapters/chap} etc
-# 2: generally
our $allow_subdir_creation = 1;
our $new_viewer_always = 0; # If 1, always open a new viewer in pvc mode.
@@ -1271,7 +1259,7 @@
# This variable is obsolete, and only in here for
# backward compatibility.
-our $jobname = ''; # Jobname: as with current tex, etc indicates
+our $jobname = ''; # Jobname: as with current tex, etc indicates
# basename of generated files. Defined so
# that --jobname=STRING on latexmk's command
# line has same effect as with current tex,
@@ -1284,7 +1272,6 @@
# dependent on name of main TeX file; this is
# useful when a jobname is used and latexmk is
# invoked on multiple files.
-our $out2_dir = ''; # Directory for final output files.
our $out_dir = ''; # Directory for output files.
# Cf. --output-directory of current *latex
# Blank means default, i.e., cwd.
@@ -1296,13 +1283,7 @@
# Corresponding forms that can be concatenated (e.g., when $aux_dir is '.', $aux_dir1 is './').
our $aux_dir1 = '';
our $out_dir1 = '';
-our $out2_dir1 = '';
-# Extensions for files to be copied to $out2_dir.
-# Specify as for @generated_exts: I.e., extension w/o period
-# or string including %R to be substituted by basename.
-our @out2_exts = ( 'hnt', 'pdf', 'ps', 'synctex', 'synctex.gz' );
-
## default flag settings.
our $recorder = 1; # Whether to use recorder option on latex/pdflatex
our $silent = 0; # Whether fo silence latex's messages (and others)
@@ -1660,7 +1641,6 @@
# %R for base of primary tex file, %T for
# texfile name, %O for options,
# %V=$aux_dir, %W=$out_dir,
- # %X for $out2_dir1
# %Y for $aux_dir1, and %Z for $out_dir1
# int_cmd specifies any internal command to be
# used to implement the application of the
@@ -1885,7 +1865,7 @@
$Plast_message, $Plast_result, $Plast_result_info,
$Pno_history, $Pout_of_date, $Pout_of_date_user, $Prun_time, $Psource,
$file, $PAfile_data, $Ptime, $Psize, $Pmd5, $DUMMY, $Pcorrect_after_primary
- );
+);
# User's home directory
our $HOME = '';
@@ -1990,6 +1970,8 @@
read_first_rc_file_in_list( ".latexmkrc", "latexmkrc" );
}
+
+
## Process command line args.
our @command_line_file_list = ();
our $bad_options = 0;
@@ -2126,9 +2108,6 @@
elsif ( /^-output-directory=(.*)$/ ||/^-outdir=(.*)$/ ) {
$out_dir = $1;
}
- elsif ( /^-out2dir=(.*)$/ ) {
- $out2_dir = $1;
- }
elsif ( /^-output-format=(.*)$/ ) {
my $format = $1;
if ($format eq 'dvi' ) {
@@ -2355,12 +2334,9 @@
# Default to cwd
$out_dir = '.';
}
-if ($out2_dir eq '' ){
- # Default to cwd
- $out2_dir = $out_dir;
-}
if ( $aux_dir eq '' ){
# Default to out_dir
+ # ?? This is different than MiKTeX
$aux_dir = $out_dir;
}
# Save original values for use in diagnositics.
@@ -2368,7 +2344,6 @@
# of results of misconfiguration.
$aux_dir_requested = $aux_dir;
$out_dir_requested = $out_dir;
-$out2_dir_requested = $out2_dir;
if ($bibtex_use > 1) {
push @generated_exts, 'bbl';
@@ -2767,18 +2742,10 @@
$dvi_name, $dviF_name, $hnt_name, $ps_name, $psF_name, $pdf_name,
$xdv_name,
$dvi_final, $hnt_final, $ps_final, $pdf_final, $xdv_final,
- $dvi_final2, $hnt_final2, $ps_final2, $pdf_final2,
$view_file,
%rule_list,
$missing_dvi_pdf, $switched_primary_output
- );
-# Defaults for when rule-using subroutines are used outside a rule:
-$rule = '';
-$Pbase = \$root_filename;
-$Psource = \$texfile_name;
-my $start_time = time();
-$Prun_time = \$start_time;
-
+);
FILE:
foreach $filename ( @file_list )
{
@@ -2809,7 +2776,6 @@
# Use of $do_cd, which can affect how $aux_dir and $out_dir get normalized.
local $aux_dir = $aux_dir;
local $out_dir = $out_dir;
- local $out2_dir = $out2_dir;
local $dvilualatex = $dvilualatex;
local $hilatex = $hilatex;
@@ -3283,19 +3249,15 @@
# Ensure the output/auxiliary directories exist, if need be, **with error checking**.
my $ret1 = 0;
my $ret2 = 0;
- my $ret3 = 0;
eval {
if ( $out_dir ) {
$ret1 = make_path_mod( $out_dir, 'output' );
}
- if ( $out_dir ) {
- $ret2 = make_path_mod( $out2_dir, 'final output' );
- }
if ( $aux_dir && ($aux_dir ne $out_dir) ) {
- $ret3 = make_path_mod( $aux_dir, 'auxiliary' );
+ $ret2 = make_path_mod( $aux_dir, 'auxiliary' );
}
};
- if ($ret1 || $ret2 || $ret3 || $@ ) {
+ if ($ret1 || $ret2 || $@ ) {
if ($@) { print "Error message:\n $@"; }
die "$My_name: Since there was trouble making the output (and aux) dirs, I'll stop\n"
}
@@ -3305,8 +3267,7 @@
}
$aux_dir1 = $aux_dir;
$out_dir1 = $out_dir;
- $out2_dir1 = $out2_dir;
- foreach ( $aux_dir1, $out_dir1, $out2_dir1 ) {
+ foreach ( $aux_dir1, $out_dir1 ) {
if ($_ eq '.') {$_ = '';}
if ( ($_ ne '') && ! m([\\/\:]$) ) {
# Add a trailing '/' if necessary to give a string that can be
@@ -3356,9 +3317,8 @@
if ($diagnostics || $aux_out_dir_report ) {
print "$My_name: Cwd: '", good_cwd(), "'\n";
- print "$My_name: Normalized aux dir and out dirs:\n",
- " '$aux_dir', '$out_dir', '$out2_dir'\n";
- print "$My_name: and combining forms: '$aux_dir1', '$out_dir1', '$out2_dir1'\n";
+ print "$My_name: Normalized aux dir and out dir: '$aux_dir', '$out_dir'\n";
+ print "$My_name: and combining forms: '$aux_dir1', '$out_dir1'\n";
if ($aux_out_dir_report == 2) {
exit 0;
}
@@ -3489,7 +3449,6 @@
# until run time, in case of changes.
foreach ($base, $source, $dest, @$PA_extra_gen, @$PA_extra_source ) {
s/%R/$root_filename/g;
- s/%X/$out2_dir1/;
s/%Y/$aux_dir1/;
s/%Z/$out_dir1/;
}
@@ -3545,7 +3504,6 @@
# Set up specifications for standard rules, adjusted to current conditions
# Substitutions: %S = source, %D = dest, %B = this rule's base
# %T = texfile, %R = root = base for latex.
-# %X for $out2_dir1,
# %Y for $aux_dir1, %Z for $out_dir1
@@ -3552,15 +3510,15 @@
my $print_file = '';
my $print_cmd = 'NONE';
if ( $print_type eq 'dvi' ) {
- $print_file = $dvi_final2;
+ $print_file = $dvi_final;
$print_cmd = $lpr_dvi;
}
elsif ( $print_type eq 'pdf' ) {
- $print_file = $pdf_final2;
+ $print_file = $pdf_final;
$print_cmd = $lpr_pdf;
}
elsif ( $print_type eq 'ps' ) {
- $print_file = $ps_final2;
+ $print_file = $ps_final;
$print_cmd = $lpr;
}
elsif ( $print_type eq 'none' ) {
@@ -3575,7 +3533,7 @@
if ( ($view eq 'dvi') || ($view eq 'hnt') || ($view eq 'pdf') || ($view eq 'ps') ) {
no strict "refs";
- $view_file = ${$view.'_final2'};
+ $view_file = ${$view.'_final'};
$viewer = ${$view.'_previewer'};
$viewer_update_method = ${$view.'_update_method'};
$viewer_update_signal = ${$view.'_update_signal'};
@@ -3586,8 +3544,6 @@
# Specification of internal command for viewer update:
my $PA_update = ['do_update_view', $viewer_update_method, $viewer_update_signal, 0, 1];
- # Base name is to be without path for *latex-type rules
- # With path for others.
%rule_list = (
'dvilualatex' => [ 'primary', "$dvilualatex", '', "%T", $dvi_name, "%R", 1, [$aux_main, $log_name], [$aux_main] ],
'hilatex' => [ 'primary', "$hilatex", '', "%T", $hnt_name, "%R", 1, [$aux_main, $log_name], [$aux_main] ],
@@ -3595,7 +3551,6 @@
'lualatex' => [ 'primary', "$lualatex", '', "%T", $pdf_name, "%R", 1, [$aux_main, $log_name], [$aux_main] ],
'pdflatex' => [ 'primary', "$pdflatex", '', "%T", $pdf_name, "%R", 1, [$aux_main, $log_name], [$aux_main] ],
'xelatex' => [ 'primary', "$xelatex", '', "%T", $xdv_name, "%R", 1, [$aux_main, $log_name], [$aux_main] ],
-
'dvipdf' => [ 'external', "$dvipdf", 'do_viewfile', $dvi_final, $pdf_name, "%Z%R", 1 ],
'xdvipdfmx' => [ 'external', "$xdvipdfmx", 'do_viewfile', $xdv_final, $pdf_name, "%Z%R", 1 ],
'dvips' => [ 'external', "$dvips", 'do_viewfile', $dvi_final, $ps_name, "%Z%R", 1 ],
@@ -3602,7 +3557,6 @@
'dvifilter' => [ 'external', $dvi_filter, 'do_viewfile', $dvi_name, $dviF_name, "%Z%R", 1 ],
'ps2pdf' => [ 'external', "$ps2pdf", 'do_viewfile', $ps_final, $pdf_name, "%Z%R", 1 ],
'psfilter' => [ 'external', $ps_filter, 'do_viewfile', $ps_name, $psF_name, "%Z%R", 1 ],
-
'print' => [ 'external', "$print_cmd", 'if_source', $print_file, "", "", 1 ],
'update_view' => [ 'external', $viewer_update_command, $PA_update,
$view_file, "", "", 2 ],
@@ -3809,12 +3763,7 @@
# 2. Write a corresponding fdb file
# 3. Provoke a run of *latex (actually of all primaries).
- # Use raw mode for writing aux file, so that line endings are \n.
- # Otherwise on Windows, the aux file file will have \r\n line endings.
- # Since both TeXLive and MiKTeX write \n rather than \r\n, latexmk will
- # unnecessarily detect a change in the aux file because of the changed
- # line endings, and thereby provoke a superfluous extra *latex run.
- open( my $aux_file, '> :raw', $aux_main )
+ open( my $aux_file, '>', $aux_main )
or die "Cannot write file '$aux_main'\n";
fprint8( $aux_file, "\\relax \n" );
# The following is added by recent versions of latex for a
@@ -3839,9 +3788,8 @@
my $kind = $_[0];
if (! $kind ) { return; }
my @files_to_delete = ();
- my %dirs = ();
- foreach ($aux_dir1, $out_dir1, $out2_dir1) { $dirs{$_} = 1; }
- my @dirs = keys %dirs;
+ my @dirs = ($aux_dir1);
+ if ($out_dir1 ne $aux_dir1) { push @dirs, $out_dir1; }
push @files_to_delete, &get_small_cleanup;
if ($kind == 1) {
@@ -3849,25 +3797,19 @@
push @files_to_delete, cleanup_get1( $dir1, @final_output_exts );
}
}
+ # show_array( "Files to delete", sort @files_to_delete );
- # Run the hooks first, since to determine what custom deletions they
- # are to make, the hook subroutines may need access to files that
- # cleanup later deletes (log, aux, ...).
- run_hooks( 'cleanup' );
- if ($kind == 1) { run_hooks( 'cleanup_extra_full' ); }
-
- # Names of contents of directory are longer than the name of the
- # directory, but contain the directory name as an initial segment.
- # Therefore deleting files and directories in the order given by
- # reverse sort deletes contents of directory before attempting to
- # delete the directory:
+ # Names of contents of directory are longer than the name of the directory,
+ # but contain the directory name as an initial segment.
+ # Therefore deleting files and directories in the order given by reverse
+ # sort deletes contents of directory before attempting to delete the
+ # directory:
unlink_or_move( reverse sort @files_to_delete );
- # If the fdb file (or log, fls and/or aux files) exist, it/they will
- # have been used to make a changed rule database. But a cleanup
- # implies that we need a virgin rule database, corresponding to
- # current state of files (after cleanup) so we reset the rule
- # database and rule net:
+ # If the fdb file (or log, fls and/or aux files) exist, it/they will have
+ # been used to make a changed rule database. But a cleanup implies
+ # that we need a virgin rule database, corresponding to current state
+ # of files (after cleanup) so we reset the rule database and rule net:
&rdb_initialize_rules;
}
@@ -4818,8 +4760,6 @@
" -norc - omit automatic reading of system, user and project rc files\n",
" -output-directory=dir or -outdir=dir\n",
" - set name of directory for output files\n",
- " -out2dir=dir\n",
- " - set name of directory for final output files\n",
" -output-format=FORMAT\n",
" - if FORMAT is dvi, turn on dvi output, turn off others\n",
" - if FORMAT is pdf, turn on pdf output, turn off others\n",
@@ -5483,10 +5423,6 @@
$ps_name = "%Z%R.ps";
$psF_name = "%Z%R.psF";
$pdf_name = "%Z%R.pdf";
- $dvi_final2 = "%X%R.pdf";
- $hnt_final2 = "%X%R.pdf";
- $pdf_final2 = "%X%R.pdf";
- $ps_final2 = "%X%R.pdf";
## It would be logical for a .xdv file to be put in the out_dir,
## just like a .dvi file. But the only program, MiKTeX, that
## currently implements aux_dir, and hence allows aux_dir ne out_dir,
@@ -5494,12 +5430,8 @@
$xdv_name = "%Y%R.xdv";
foreach ( $aux_main, $log_name, $fdb_name, $fls_name, $fls_name_alt,
- $dvi_name, $hnt_name, $ps_name, $pdf_name, $xdv_name,
- $dviF_name, $psF_name,
- $dvi_final2, $hnt_final2, $pdf_final2, $ps_final2,
- ) {
+ $dvi_name, $hnt_name, $ps_name, $pdf_name, $xdv_name, $dviF_name, $psF_name ) {
s/%R/$root_filename/g;
- s/%X/$out2_dir1/;
s/%Y/$aux_dir1/;
s/%Z/$out_dir1/;
}
@@ -5520,53 +5452,6 @@
#**************************************************
-sub do_moves_aux_to_out {
- # do_moves_aux_to_out( source, dest )
- # Moves appropriate output files from source dir (e.g., $aux_dir1) to
- # dest dir (e.g., $out_dir1).
- # Veto move of file if it wasn't generated on current compilation.
- # Special treatment of .fls file
- # Assume rule context, which may be global context.
- # Directory names should end in /, so that concatenation OK.
- my ($source1, $dest1) = @_;
- foreach my $ext ( 'fls', 'dvi', 'hnt', 'pdf', 'ps', 'synctex', 'synctex.gz' ) {
- if ( ($ext eq 'fls') && ! $fls_uses_out_dir ) {next;}
- my $from = "$source1$$Pbase.$ext";
- my $to = "$dest1$$Pbase.$ext" ;
- if ( test_gen_file_time( $from ) ) {
- if (! $silent) { print "$My_name: Moving '$from' to '$to'\n"; }
- my $ret = move( $from, $to );
- if ( ! $ret ) { die " That failed, with message '$!'\n";}
- }
- }
-}
-
-#*************************************************************************
-
-sub do_copies_out_to_out2 {
- # do_copies_out_to_out2( source, dest )
- # Copies final output files from source dir (e.g., $out_dir1) to
- # dest dir (e.g., $out2_dir1).
- # Note copy, not move, otherwise rules complain about non-existent
- # destination pdf file (etc).
- # Assume rule context, which is normally global context.
- # Directory names should end in /, so that concatenation OK.
- my ($source1, $dest1) = @_;
- foreach ( @out2_exts ) {
- my $name = ( /%R/ ? $_ : "%R.$_" );
- $name =~ s/%R/$$Pbase/;
- my $from = "$source1$name";
- my $to = "$dest1$name" ;
- if ( test_gen_file_time( $from ) ) {
- if (! $silent) { print "$My_name: Copying '$from' to '$to'\n"; }
- my $ret = copy( $from, $to );
- if ( ! $ret ) { die " That failed, with message '$!'\n";}
- }
- }
-}
-
-#*************************************************************************
-
sub correct_locations {
# Deal with situations after a *latex run where files are in different
# directories than expected (specifically aux v. output directory).
@@ -5582,15 +5467,26 @@
# Assumes rule context.
my $where_log = &find_set_log;
-
if ( $emulate_aux && ($aux_dir ne $out_dir) ) {
- do_moves_aux_to_out( $aux_dir1, $out_dir1 );
+ # Move output files from aux_dir to out_dir
+ # Move fls file also, if the configuration is for fls in out_dir.
+ # Omit 'xdv', that goes to aux_dir (as with MiKTeX). It's not final output.
+ foreach my $ext ( 'fls', 'dvi', 'hnt', 'pdf', 'ps', 'synctex', 'synctex.gz' ) {
+ if ( ($ext eq 'fls') && ! $fls_uses_out_dir ) {next;}
+ my $from = "$aux_dir1$$Pbase.$ext";
+ my $to = "$out_dir1$$Pbase.$ext" ;
+ if ( test_gen_file_time( $from ) ) {
+ if (! $silent) { print "$My_name: Moving '$from' to '$to'\n"; }
+ my $ret = move( $from, $to );
+ if ( ! $ret ) { die " That failed, with message '$!'\n";}
+ }
+ }
}
# Fix ups on fls file:
if ($recorder) {
# Deal with following special cases:
- # 1. Some implementations of *latex give fls files of name latex.fls
+ # 1. Some implemenations of *latex give fls files of name latex.fls
# or pdflatex.fls instead of $$Pbase.fls.
# 2. In some implementations, the writing of the fls file (memory
# of old implementations) may not respect the -output-directory
@@ -6122,9 +6018,8 @@
$idx_file = $1;
}
else {
- warn "$My_name: A message suggests an index file may have been written\n",
- " but it is not of a form I understand. This is probably innocuous.\n",
- " The message is\n",
+ warn "$My_name: Message indicates index file was written\n",
+ " ==> but I do not know how to understand it: <==\n",
" '$_'\n";
next LINE;
}
@@ -6222,9 +6117,7 @@
my $dir = $1;
my $file = $2;
my $full_dir = $aux_dir1.$dir;
- if ( ($aux_dir ne '') && (! -e $full_dir)
- && ( ($file =~ /\.aux$/) || ($allow_subdir_creation == 2) )
- ) {
+ if ( ($aux_dir ne '') && (! -e $full_dir) && ( $file =~ /\.aux$/) ) {
warn "$My_name: === There were problems writing to '$file' in '$full_dir'\n",
" I'll try to make the subdirectory later.\n"
if $diagnostics;
@@ -6233,9 +6126,9 @@
else {
warn "$My_name: ====== There were problems writing to",
"----- '$file' in '$full_dir'.\n",
- "----- But this is not the standard situation of file to subdir of output\n",
- "----- directory, with non-existent subdir, and either file is aux file or\n",
- "----- or \$allow_subdir_creation is set to 2.\n";
+ "----- But this is not the standard situation of\n",
+ "----- aux file to subdir of output directory, with\n",
+ "----- non-existent subdir\n",
}
}
@@ -7738,7 +7631,6 @@
}
close $in_handle;
# Get state of dependencies, including creating cus deps if needed
- # !!!??? This doesn't match definition of rdb_set_dependents
&rdb_set_dependents( keys %rule_db );
&rdb_set_rule_net;
@@ -8196,12 +8088,6 @@
}
}
- foreach my $file ( keys %generated_fls ) {
- if ( $file =~ /^(.*)\.idx$/ ) {
- $idx_files{$file} = [ "$1.ind", $1 ];
- print "Have index file '$file', @{$idx_files{$file}}\n";
- }
- }
IDX_FILE:
foreach my $idx_file ( keys %idx_files ) {
my ($ind_file, $ind_base) = @{$idx_files{$idx_file}};
@@ -8424,7 +8310,7 @@
my @more_sources = &rdb_set_dependents( $rule );
my $num_new = $#more_sources + 1;
- foreach (@more_sources) {
+ foreach (@more_sources) {
$dependents{$_} = 4;
if ( ! -e $_ ) {
# Failure was non-existence of makable file
@@ -8686,8 +8572,7 @@
}
if ( exists $ENV{TEXINPUTS} ) {
foreach my $searchpath (split $search_path_separator, $ENV{TEXINPUTS}) {
- my $file = catfileA($searchpath,$_[0]);
- if ( $file =~ /\\/ ) { print "====== '$file'\n"; die; }
+ my $file = catfile($searchpath,$_[0]);
my $test = "$file.$_[1]";
if ( -e $test ) {
return $file;
@@ -8704,7 +8589,7 @@
# Assume file (and rule) context for DESTINATION file.
# Only look for dependency if $rule is primary rule (i.e., latex
- # or pdflatex) or is a custom dependency: ???WHY???!!!
+ # or pdflatex) or is a custom dependency:
if ( (! exists $possible_primaries{$rule}) && ($rule !~ /^cusdep/) ) {
return;
}
@@ -8775,7 +8660,7 @@
&& (! -e $file )
&& (! -e "$base_name.$proptoext" )
&& exists $$Pinput_extensions{$proptoext}
- ) {
+ ) {
# Empty extension and non-existent destination
# This normally results from \includegraphics{A}
# without graphics extension for file, when file does
@@ -9353,11 +9238,6 @@
}
rdb_for_some( [@unusual_one_time], \&rdb_make1 );
- if ( $out_dir ne $out2_dir ) {
- print "================='$out_dir', '$out2_dir' '$out_dir1', '$out2_dir1'\n";
- do_copies_out_to_out2( $out_dir1, $out2_dir1 );
- }
-
#---------------------------------------
# All of make done. Finish book-keeping:
@@ -9752,13 +9632,7 @@
else {
# No special analysis for other rules
}
- if ($$Pdest eq $pdf_final) {
- if ( run_hooks( 'after_main_pdf' ) ) {
- warn "$My_name: ======Some hook failed.\n";
- $return = -1;
- }
- }
-
+
# General
$updated = 1;
if ( ($$Plast_result == 0) && ($return != 0) && ($return != -2) ) {
@@ -10698,7 +10572,6 @@
foreach ( $PAextra_gen, $PAextra_source ) {
if (! defined $_) { $_ = []; }
}
-
my $last_result = -1;
my $last_result_info = '';
my $no_history = ($run_time <= 0);
@@ -11632,7 +11505,6 @@
warn "In add_hook, request to add hook to non-existent stack '$stack'.\n";
return 0;
}
- print "============== ADDING HOOK to $stack\n";
my $ref;
if ( ref $routine ) {
@@ -11658,36 +11530,23 @@
# a. If arguments follow the stackname in the call to run_hooks, these
# are given to the called subroutines.
# b. Otherwise a hash of information is given to the called subroutines.
- # Each has a return value, which like from system, is 0 for success.
- # Return 0 for success, non-zero for failure.
+ # Return 1 for success, 0 for failure.
my $name = shift;
my $Pstack = $hooks{$name};
my @args = @_;
if (!@args) { @args = &info_make; }
else { print "Have args\n"; }
-
- if ( ! defined $Pstack ) {
- warn "run_hooks: No stack named '$name'\n";
- # But I'll not treat this as an error. Is that appropriate?
- return 0;
- }
- elsif (! @$Pstack) {
- # Nothing to do
- return 0;
- }
- else {
- print "$My_name: Running hooks in stack $name\n";
- my $fail = 0;
+ if (defined $Pstack) {
# Do NOT use default $_, as in "for (...) {...}":
# The called subroutine may change $_, which is a global variable
# (although localized to the for loop and called subroutines).
- for my $Psub ( @$Pstack) {
- if ( &$Psub(@args) ) {
- $fail = 1;
- }
- }
- return $fail;
+ for my $Psub ( @$Pstack) { &$Psub(@args); }
+ return 1;
}
+ else {
+ warn "run_hooks: No stack named '$name'\n";
+ return 0;
+ }
}
#-------------------------------------
@@ -11864,15 +11723,6 @@
#************************************************************
-sub catfileA {
- # Like catfile, but change \ to / in result.
- my $file = catfile(@_);
- $file =~ s[\\][/]g;
- return $file;
-}
-
-#************************************************************
-
sub fileparseA {
# Like fileparse but replace $path for current dir ('./' or '.\') by ''
# Also default second argument to get normal extension.
@@ -12450,7 +12300,7 @@
# -outdir=... option, are already in the system CS, because that is
# how strings are passed on the command line.
# So we just need to do a conversion for strings with utf8 flag on:
- foreach ( $out_dir, $out2_dir, $aux_dir, @default_files, @default_excluded_files ) {
+ foreach ( $out_dir, $aux_dir, @default_files, @default_excluded_files ) {
if (utf8::is_utf8($_)) { $_ = encode( $CS_system, $_ ); }
}
} #END config_to_mine
Modified: trunk/Master/texmf-dist/doc/man/man1/latexmk.1
===================================================================
--- trunk/Master/texmf-dist/doc/man/man1/latexmk.1 2024-04-01 23:43:48 UTC (rev 70834)
+++ trunk/Master/texmf-dist/doc/man/man1/latexmk.1 2024-04-02 21:31:27 UTC (rev 70835)
@@ -1,4 +1,4 @@
-.TH LATEXMK 1 "29 March 2024" ""
+.TH LATEXMK 1 "31 January 2024" ""
.SH NAME
latexmk \- generate LaTeX document
.SH SYNOPSIS
@@ -175,8 +175,8 @@
Sets the directory for auxiliary output files of *latex (.aux, .log etc).
These are all the generated files, with the exception of final output files
(.dvi, .ps, .pdf, .synctex.gz, .synctex). See the
-\fB-outdir\fR/\fB-output-directory\fR option for directories for the main
-output files, and the \fB-out2dir\fR option for the final output files.
+\fB-outdir\fR/\fB-output-directory\fR option for directories for the final
+output files.
If the directory specified for the \fB-aux\fR/\fB-aux-directory\fR option
is blank, then the default is used, which is to be the same as the output
@@ -845,7 +845,7 @@
then all output files of *latex are sent to the output directory.
If the aux directory is set, e.g., by the option \fB-auxdir\fR, and is not
-equal to the output directory, then only the primary output files
+equal to the output directory, then only final output files
(.dvi, .ps, .pdf, .synctex, .synctex.gz) are sent to the output
directory. Other generated files are sent to the aux directory.
@@ -852,30 +852,6 @@
See the section AUXILIARY AND OUTPUT DIRECTORIES for more details.
.TP
-.B -out2dir=FOO
-
-(\fIExperimental new feature.\fR)
-
-Sets the directory for the final output files of a whole round of
-compilations.
-
-The use of this directory solves, among other things, the problem that when
-multiple runs of *latex and other programs are needed, files like the main
-pdf file from pdflatex, etc will be changed multiple times. A viewer like
-SumatraPDF that reloads the file whenever it detects changes will show a
-distracting sequence of intermediate states of the pdf file, rather than
-just the final version after all the repeated runs of *latex etc have been
-done. Instead, when a distinct final-output directory is set, by the
-\fB-out2dir\fR option or the equivalent \fI$out2_dir\fR variable is set,
-the viewer will only see a changed pdf (etc) file after full sequence of
-repeated runs of *latex etc has finished.
-
-By default the final output directory is the same as the output directory
-(as specified by the \fB-outdir\fR option or the setting of the variable
-\fI$out_dir\fR configuration variable).
-
-
-.TP
.B -output-format=FORMAT
This option is one that is allowed for \fIlatex\fR, \fIlualatex\fR, and
\fIpdflatex\fR. But it is not passed to these programs. Instead
@@ -1931,13 +1907,11 @@
equivalent to %S.
.TP
.B %R
-root filename.
+root filename. This is the base name for the main tex file.
By default this is the basename of the main tex file. However the
value can be changed by the use of the \fI-jobname\fR option or the
-\fI$jobname\fR configuration variable. This is then the basename for files
-like the .aux and .log files produced by running *latex, as well for the
-main .dvi, .pdf, .ps and/or .xdvi files.
+\fI$jobname\fR configuration variable.
.TP
.B %S
source file (e.g., the name of the dvi file when converting a .dvi file
@@ -2132,21 +2106,6 @@
indicates a false value, i.e., the behavior does not occur.
.TP
-.B $allow_subdir_creation [1]
-
-Specify action to take when message(s) in the .log file indicate a failure
-of an attempt by a *latex compilation to write a file to a subdirectory of
-the output directory because the subdirectory didn't exist.
-
-If the value if \fI$allow_subdir_creation\fR is 0, no action is taken. If
-it is 1, then the appropriate subdirectory is created and a rerun of *latex
-is triggered, but only if the file being written is an .aux file. (This
-happens, for example, if the document includes a file from a subdirectory
-of the document directory, by the \\include command. If the value of
-\fI$allow_subdir_creation\fR is 2, then the subdirectory creation is done
-independently of which type of file is in question.
-
-.TP
.B $allow_switch [1]
This controls what happens when the output extension of latex,
@@ -2211,7 +2170,7 @@
Whether to automatically read the standard initialization (rc) files,
which are the system RC file, the user's RC file, and the RC file in
the current directory. The command line option \fB-norc\fR can be
-used to turn this setting off. Each RC file could also turn this
+used to turn this setting off. Each RC file co2uld also turn this
setting off, i.e., it could set \fI$auto_rc_use\fR to zero to prevent
automatic reading of the later RC files.
@@ -2779,7 +2738,7 @@
\fI$dvi_update_method\fR. The default value is the one appropriate
for \fIxdvi\fR on a UNIX system.
.TP
-.B $emulate_aux [1]
+.B $emulate_aux [0]
Whether to emulate the use of aux directory when $aux_dir and $out_dir are
different, rather than using the \fB-aux-directory\fR option for the *latex
programs. (MiKTeX supports \fB-aux-directory\fR, but TeXLive doesn't.)
@@ -3237,12 +3196,11 @@
same file, and if one is running will not start a new one. If
\fI$new_viewer_always\fR is non-zero, this check will be skipped, and
\fIlatexmk\fR will behave as if no viewer is running.
-
.TP
.B $out_dir [""]
If non-blank, this variable specifies the output directory.
-This is the directory in which the main output files are written (dvi, ps,
+This is the directory in which final output files are written (dvi, ps,
pdf, synctex, synctex.gz). In addition, if the aux directory equals the
output directory, as is the case by default, then other generated files are
in effect written to the output directory.
@@ -3255,37 +3213,6 @@
.TP
-.B $out2_dir [""]
-(\fIExperimental new feature.\fR)
-
-If non-blank, this variable specifies the final-output directory, i.e., the
-directory for the final output files. If this variable is blank (its
-default value), the final-output directory is the same as the output
-directory.
-
-See the description of the option \fB-out2dir\fR for an explanation of the
-rationale for the idea of separate output and final-output directories.
-
-If the final-output directory is different from the output directory, then
-after a full round of compilations of the document, the relevant set of
-files is copied here from the output directory. The files copied are
-specified by the \fI at out2_exts\fR variable, and by default are those with
-extensions 'hnt', 'pdf', 'ps', 'synctex', 'synctex.gz', and a basename the
-same as for the main *latex compilation.
-
-.TP
-.B @out2_exts [( 'hnt', 'pdf', 'ps', 'synctex', 'synctex.gz' )]
-
-This variable lists the extensions of the files to be copied to the
-final-output directory. The basename of the files is that for the main
-*latex compilation (corresponding to the value specified by the placeholder
-%R). More general names may be specified in the same way as for the
-\fI at generated_exts\fR variable, by inclusion of %R in a pattern, e.g.,
-
- push @out2_exts, '%R-2up.pdf';
-
-
-.TP
.B $pdf_mode [0]
If zero, do NOT generate a pdf version of the document.
If equal to 1, generate a pdf version of the document using \fIpdflatex\fR,
@@ -4114,27 +4041,46 @@
conversion. So the new method is preferable.
-.SH ADVANCED CONFIGURATION: SOME EXTRA RESOURCES AND ADVANCED TRICKS
+.SH Advanced configuration: Some extra resources and advanced tricks
-For most purposes, simple configuration for \fIlatexmk\fR along the lines
-of the examples given is sufficient. But sometimes you need something
-harder. In this section, I indicate some extra possibilities. Generally
-to use these, you need to be fluent in the Perl language, since this is
-what is used in the rc files.
+For most purposes, simple configuration for \fIlatexmk\fR along the
+lines of the examples given is sufficient. But sometimes you need
+something harder. In this section, I indicate some extra
+possibilities. Generally to use these, you need to be fluent in the
+Perl language, since this is what is used in the rc files.
-In this section, I include first, a description of a number of variables
-and subroutines that provide, among other things, access to latexmk's
-internal data structures for handling dependencies. Then I describe the
-hook mechanism whereby at certain points in the processing, latexmk can
-call user-defined subroutines.
-
See also the section DEALING WITH ERRORS, PROBLEMS, ETC. See
also the examples in the directory \fIexample_rcfiles\fR in the
\fIlatexmk\fR distributions. Even if none of the examples apply to
your case, they may give you useful ideas
+.SS Utility subroutines
+.TP
+.B ensure_path( var, values ...)
+The first parameter is the name of one of the system's environment
+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 -- see the configuration variable
+\fI$search_path_separator\fR.
+
+Example:
+
+ ensure_path( 'TEXINPUTS', './custom_cls_sty_files//' );
+
+(In this example, the trailing '//' is documented by TeX systems to
+mean that \fI*latex\fR search for files in the specified
+directory and in all subdirectories.)
+
+Technically \fIensure_path\fR works by setting Perl's variable
+\fI$ENV{var}\fR, where \fIvar\fR is the name of the target variable.
+The changed value is then passed as an environment variable to any
+invoked programs.
+
.SS Variables and subroutines for processing a rule
A step in the processing is called a rule. One possibility to
@@ -4157,31 +4103,9 @@
\fIlatexmk\fR. Note that the exact contents of this variable for a
given rule may be dependent on the version of \fIlatexmk\fR
.TP
-.B $$Pbase
-This gives the basename for the rule. Generally, it determines the names
-of generated files. E.g., for a run of *latex, the name of the .log file
-is the aux directory concatenated with the basename and then `.log'.
-
-For a *latex rule, the basename is without a directory component. For
-other rules, it includes the directory component (if any is used).
-
-This (annoying) difference is associated with the different ways in which
-the commands invoked by latexmk work when the command line includes a name
-for a source file that includes a directory component. For the *latex
-commands, the directory of the source file is irrelevant to the directory
-component the generated files, which instead is determined by the values in
-the -aux-directory and/or -output-directory options.
-
-In contrast, many other programs (e.g., biber, bibtex) put their generated
-files in the same directory as the source file, merely with a changed extension.
-
-Note the double dollar signs: In Perl terms, the variable \fI$Pbase\fR is a
-\fIreference\fR to a variable that contains the basename. The second
-dollar sign derefences the reference to give the actual value. (A
-reference is is used rather like a pointer, and the `P' (for `pointer') at
-the start of the variable name is a convention used in latexmk to indicate
-that the variable is a reference variable.)
-
+.B $$Psource
+This gives the name of the primary source file. Note the double
+dollar signs.
.TP
.B $$Pdest
This gives the name of the main output file if any. Note the double
@@ -4188,66 +4112,6 @@
dollar signs.
.TP
-.B $$Psource
-This gives the name of the primary source file. Note the double
-dollar signs.
-
-.TP
-.B add_hook( <stack_name>, <subroutine> )
-See the section `Hooks' for more details.
-
-This adds the subroutine specified in the second argument to latexmk's
-stack of hooks specified by the stack name. It returns 1 on sucess, and
-zero otherwise (e.g., if the specified hook stack doesn't exist).
-
-The subroutine can be specified by a reference to the subroutine, as in
-
- add_hook( 'after_xlatex_analysis', \&mmz_analyze )
-
-Given that the subroutine mmz_analyze has been defined in the rc file.
-
-The subroutine can be specified by a string whose value is the name of the
-subroutine, e.g.,
-
- add_hook( 'after_xlatex_analysis', 'mmz_analyze' )
-
-In simple cases, the subroutine can be an anonymous subroutine defined in
-the call to add_hooks,
-
- add_hook( 'after_main_pdf', sub{ print \"TEST\\n\"; return 0; } );
-
-Observe that on success, the subroutine should return 0 (like a call to
-Perl's system subroutine), so normally this should be coded explicitly. If
-a hook subroutine returns a non-zero value, latexmk treats that as an error
-condition.
-
-
-.TP
-.B ensure_path( var, values ...)
-
-The first parameter is the name of one of the system's environment
-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 -- see the configuration variable
-\fI$search_path_separator\fR.
-
-Example:
-
- ensure_path( 'TEXINPUTS', './custom_cls_sty_files//' );
-
-(In this example, the trailing '//' is documented by TeX systems to
-mean that \fI*latex\fR search for files in the specified
-directory and in all subdirectories.)
-
-Technically \fIensure_path\fR works by setting Perl's variable
-\fI$ENV{var}\fR, where \fIvar\fR is the name of the target variable.
-The changed value is then passed as an environment variable to any
-invoked programs.
-
-.TP
.B pushd( path ), popd()
These subroutines are used when it is needed to temporarily change the
working directory, as in
@@ -4309,12 +4173,6 @@
file.\fR
.TP
-.B rdb_ensure_files_here( file, ... )
-Like subroutine \fIrdb_ensure_files\fR, except that (a) it assumes the
-context is of a rule, and the files are to be added to the source list for
-that rule; (b) multiple files are allowed.
-
-.TP
.B rdb_remove_files( $rule, file, ... )
This subroutine removes one or more files from the dependency list for
the given rule.
@@ -4353,29 +4211,9 @@
command is run. In addition, the command after substitution is
printed to the screen unless \fIlatexmk\fR is running in silent mode.
-.TP
-.B test_gen_file_time ( <file> )
-This subroutine is used in the context of a rule. It returns true or
-false according to whether or not a file of the given name both exists
-and was generated in the latest run of the rule. If the subroutine returns
-false, but the file exists, then the file is a leftover from a previous
-run.
+.PP
-The test for a file being generated on the current run is whether the
-modification time of the file is at least as recent as the time that the
-run of the rule was started. An allowance for the granularity of the
-values of modification time on file systems is made. See the description
-of the variable \fB$filetime_causality_threshold\fR for details.
-In addition, latexmk makes allowance for the possiblity that files are
-hosted on a different computer than that running latexmk and that the
-system clock times on the two computers are mismatched. Latexmk
-automatically detects (and reports) any significant mismatch and corrects
-for it.
-
-
-.PP
-
.SS Coordinated Setting of Commands for *latex
To set all of \fI$dvilualatex\fR, \fI$hilatex\fR, \fI$latex\fR,
@@ -4438,93 +4276,6 @@
.PP
-.SS Hooks
-
-Latexmk provides a way to arrange for user-defined subroutines to be called
-at certain points in the processing. These can be used to configure
-appropriate behavior and actions beyond latexmk's normal behavior. For a
-good example of how they can be used to accommodate latexmk's behavior to
-particular packages, see the file memoize_latexmkrc in the example_rcfiles
-subdirectory of the latexmk distribution. (In a standard TeXLive
-installation, that subdirectory is to be found in
-texmf-dist/doc/support/latexmk/)
-
-The hook mechanism is complementary to the method of redefining command
-strings like \fB$pdflatex\fR etc. The two methods have overlapping domains
-of usefulness.
-
-Note that the hook mechanism is newly made public in v. 4.84 of latexmk.
-It is subject to change and improvement as experience is gained.
-
-The hooks are arranged in named hook stacks, and a hook subroutine is added
-to a given stack by latexmk's add_hook subroutine (documented above). The
-currently available stacks are as follows, listed in the approximate order
-in which they are encountered in processing a document:
-
-.TP 2
- before_xlatex
- The subroutines in this hook stack are called just before a
- *latex programs is run.
-
-.TP 2
- after_xlatex
- The subroutines in this hook stack are called after a *latex programs is
- run. Before the subroutines are called, latexmk has done some immediate
- postprocessing, e.g., to move the generated pdf file from the aux
- directory to the output directory when \fB$emulate_aux\fR is set to 1.
-
-.TP 2
- after_xlatex_analysis
- The subroutines in this hook stack are called after latexmk has done its
- dependency analysis after a *latex programs is run. Subroutines in this
- stack provide a useful way of adding items to the dependency information
- associated with particular packages and that latexmk doesn't
- automatically deal with.
-
-.TP 2
- after_main_pdf
- The subroutines in this hook stack are called after one of the rules that
- creates the document's pdf file. (This covers any of pdflatex, lualatex,
- dvipdf, ps2pdf, xdvipdfmx.)
-
-.TP 2
- cleanup
- The subroutines in this hook stack are called whenever latexmk is about
- to do a cleanup operation. They can be used, for example, to tailor the
- deleted files to the pecularities of particular packages when latexmk's
- general mechanisms for specifying files to be deleted are too inflexible.
-
- These subroutines are called before latexmk does any of its own file
- deletion; thus the hook subroutines have access to all the generated
- files that give package-specific information.
-
-.TP 2
- cleanup_extra_full
- The subroutines in this hook stack are called in addition to the ones in
- the cleanup stack, whenever a full cleanup operation is to be done (i.e.,
- one that includes the pdf, ps etc files). They are called immediately
- after those in the cleanup stack, but still before latexmk does any of
- its own file deletion.
-
-.PP
-
-(Any other stacks defined in latexmk.pl but not listed above are to be
-regarded as experimental and subject to change.)
-
-Each subroutine should return 0 on success and a non-zero value on failure.
-This matches the convention used for running programs, e.g., by Perl's
-system subroutine, and the matching convention used for subroutines for
-custom dependencies in latexmk.
-
-For most of the hook stacks, the subroutines are called in the context of a
-rule, with variables like \fB$rule\fR defined. However, some hook stacks,
-like the cleanup ones, are called from outside any rule; and latexmk
-adjusts the relevant variables to refer to the overall task (i.e., of
-processing a particular main .tex file).
-
-
-.PP
-
.SS Advanced configuration: Using \fIlatexmk\fB with \fImake\fR
This section is targeted only at advanced users who use the \fImake\fR
@@ -4718,7 +4469,7 @@
harvested too easily.)
.SH AUTHOR
Current version, by John Collins
-(Version 4.84).
+(Version 4.83).
Report bugs etc to his e-mail (jcc8 at psu.edu).
Released version can be obtained from CTAN:
Modified: trunk/Master/texmf-dist/doc/support/latexmk/CHANGES
===================================================================
--- trunk/Master/texmf-dist/doc/support/latexmk/CHANGES 2024-04-01 23:43:48 UTC (rev 70834)
+++ trunk/Master/texmf-dist/doc/support/latexmk/CHANGES 2024-04-02 21:31:27 UTC (rev 70835)
@@ -906,17 +906,3 @@
Restrict warning diagnostics about ^^ constructs in aux file to those
involving non-trivial Unicode characters, as against things like ^^M.
-From v. 4.83 to 4.84
- Update example_rcfiles/bib2gls_latexmkrc to deal with situation where
- .glstex file has basename of .bib file rather than that of main .tex
- file.
- Update example_rcfiles/asymptote_latexmkrc.
- Update example_rcfiles/splitindex_latexmkrc.
- Add example_rcfiles/memoize_latexmkrc.
- Improve detection of need to run makeindex (solves non-detection when
- imakeidx package is used with splitindex option).
- Implement final-output directory, with option -out2dir, variables
- $out2_dir, @out2_exts.
- Document hook mechanism.
- Document $allow_subdir_creation variable.
-
Modified: trunk/Master/texmf-dist/doc/support/latexmk/INSTALL
===================================================================
--- trunk/Master/texmf-dist/doc/support/latexmk/INSTALL 2024-04-01 23:43:48 UTC (rev 70834)
+++ trunk/Master/texmf-dist/doc/support/latexmk/INSTALL 2024-04-02 21:31:27 UTC (rev 70835)
@@ -1,6 +1,6 @@
INSTALLING latexmk
==================
- (Version 4.84, 29 Mar. 2024)
+ (Version 4.83, 31 Jan. 2024)
John Collins
Physics Department
Modified: trunk/Master/texmf-dist/doc/support/latexmk/README
===================================================================
--- trunk/Master/texmf-dist/doc/support/latexmk/README 2024-04-01 23:43:48 UTC (rev 70834)
+++ trunk/Master/texmf-dist/doc/support/latexmk/README 2024-04-02 21:31:27 UTC (rev 70835)
@@ -1,4 +1,4 @@
-Latexmk, version 4.84, 29 Mar 2024
+Latexmk, version 4.83, 31 Jan 2024
----------------------------------
Latexmk completely automates the process of generating a LaTeX
Modified: trunk/Master/texmf-dist/doc/support/latexmk/example_rcfiles/asymptote_latexmkrc
===================================================================
--- trunk/Master/texmf-dist/doc/support/latexmk/example_rcfiles/asymptote_latexmkrc 2024-04-01 23:43:48 UTC (rev 70834)
+++ trunk/Master/texmf-dist/doc/support/latexmk/example_rcfiles/asymptote_latexmkrc 2024-04-02 21:31:27 UTC (rev 70835)
@@ -2,15 +2,34 @@
# or http://www.ctan.org/pkg/asymptote/)
# with latexmk. Asymptote is a vector graphics language with a
# processing program that generates graphics files that can be used in
-# a LaTex file.
+# a LaTex file.
#
-# The definitions in this file enable automatic compilation of .asy files
-# containing asymptote code to be compiled to graphics files. The .asy files
-# may be created as stand-alone files or may be created during a *latex
-# run by the use of the asymptote package with a document that contains
-# sections of asymptote code.
+# A standard method of using it is with the asymptote LaTeX style file
+# (http://mirror.ctan.org/graphics/asymptote/doc/asymptote.sty)
+# The graphics drawing code is in the tex file, and applying pdflatex to
+# the tex file produces one or more files with a base name the same as
+# or related to the main tex file, but with the extension 'asy'. The
+# .asy is processed by the program asy (part of the asymptote
+# software) to produce graphics files (which may be eps, tex, or pdf
+# files) that are used the next time pdflatex is run on the main tex
+# file.
+#
+# Latexmk can be arranged to run asymptote (i.e., the program asy)
+# when needed, by defining the following custom dependency. (The code
+# is to be put in one of latexmk's rc files, e.g., ~/.latexmkrc.)
+#
+## OLD simple method (taken from the documentation for V. 2.03 of
+## asymptote). These definitions are simple, but they may not always
+## give the desired type of output file, and they do not ensure that
+## latexmk has dependency information about files imported from the
+## asy file.
+#OLD sub asy {return system("asy \"$_[0]\"");}
+#OLD add_cus_dep("asy","eps",0,"asy");
+#OLD add_cus_dep("asy","pdf",0,"asy");
+#OLD add_cus_dep("asy","tex",0,"asy");
+
# The following definitions arrange to run asy with the correct output
# file type. They run asy in a verbose mode so that dependency
# information on imported files can be extracted. To avoid adding a
@@ -28,28 +47,17 @@
sub asy2tex { return asy2x( $_[0], 'tex' ); }
sub asy2x {
- my ($base, $fmt ) = @_;
- my $log_file = "$base.log";
- my $cmd = "asy -vv -noV -f \"$fmt\" -o \"$base.$fmt\" \"$base\" > '$log_file' 2>&1";
- print "asy2x: Running '$cmd'\n";
- my $ret = system($cmd);
- my $FH = undef;
- if (! open( $FH, "<", $log_file ) ) {
- warn "asy2x: Couldn't read log file '$log_file':\n $!";
- return $ret;
- }
-
- my %imports = ("$base.asy" => 1);
+ my $ret = system("asy -vv -f '$_[1]' '$_[0]' >& '$_[0].log'");
+ open( my $FH, "<", "$_[0].log" );
+ %imp = ();
+
while (<$FH>) {
- s/\s*$//;
- if (/^(Including|Loading) .* from (.*)$/) {
+ if (/^(Including|Loading) .* from (.*)\s*$/) {
my $import = $2;
- # Convert MSWin directory separator to /
- $import =~ s(\\)(/)g;
- $imports{$import} = 1;
+ $imp{$import} = 1;
}
elsif ( /^error/ || /^.*\.asy: \d/ ) {
- warn "==Message from asy: $_\n";
+ warn "==Message from asy: $_";
$ret = 1;
}
elsif ( /^kpsewhich / || /^Processing / || /^Using /
@@ -57,11 +65,11 @@
) {
}
else {
-# warn "==Message from asy: $_\n";
+ warn "==Message from asy: $_";
}
}
close $FH;
- show_hash( '', \%imports );
- rdb_set_source( $rule, keys %imports );
+# For latexmk 4.48
+ rdb_set_source( $rule, keys %imp );
return $ret;
}
Modified: trunk/Master/texmf-dist/doc/support/latexmk/example_rcfiles/bib2gls_latexmkrc
===================================================================
--- trunk/Master/texmf-dist/doc/support/latexmk/example_rcfiles/bib2gls_latexmkrc 2024-04-01 23:43:48 UTC (rev 70834)
+++ trunk/Master/texmf-dist/doc/support/latexmk/example_rcfiles/bib2gls_latexmkrc 2024-04-02 21:31:27 UTC (rev 70835)
@@ -1,56 +1,35 @@
-# Implements use of bib2gls with glossaries-extra.
-# Version of 4 Feb 2024.
-# Thanks to Marcel Ilg for a suggestion.
+# Implementing glossary with bib2gls and glossaries-extra, with the
+# log file (.glg) analyzed to get dependence on a .bib file.
# !!! ONLY WORKS WITH VERSION 4.54 or higher of latexmk
push @generated_exts, 'glstex', 'glg';
-# For case that \GlsXtrLoadResources is used and so glstex file (first one)
-# has same name as .aux file.
add_cus_dep('aux', 'glstex', 0, 'run_bib2gls');
-# For case that \glsxtrresourcefile is used and so glstex file (first one)
-# has same name as .bib file.
-add_cus_dep('bib', 'glstex', 0, 'run_bib2gls_alt');
-
sub run_bib2gls {
- my $ret = 0;
if ( $silent ) {
- $ret = system "bib2gls --silent --group '$_[0]'";
+ my $ret = system "bib2gls --silent --group '$_[0]'";
} else {
- $ret = system "bib2gls --group '$_[0]'";
+ my $ret = system "bib2gls --group '$_[0]'";
};
-
- # bib2gls puts output files in current directory.
- # At least put main glstex in same directory as aux file to satisfy
- # definition of custom dependency.
+
my ($base, $path) = fileparse( $_[0] );
if ($path && -e "$base.glstex") {
rename "$base.glstex", "$path$base.glstex";
}
- if ($ret) {
- warn "Run_bib2gls: Error, so I won't analyze .glg file\n";
- return $ret;
- }
# Analyze log file.
- my $log = "$_[0].glg";
- if ( open( my $log_fh, '<', $log) ) {
- while (<$log_fh>) {
- s/\s*$//;
- if (/^Reading\s+(.+)$/) { rdb_ensure_file( $rule, $1 ); }
- if (/^Writing\s+(.+)$/) { rdb_add_generated( $1 ); }
- }
- close $log_fh;
+ local *LOG;
+ $LOG = "$_[0].glg";
+ if (!$ret && -e $LOG) {
+ open LOG, "<$LOG";
+ while (<LOG>) {
+ if (/^Reading (.*\.bib)\s$/) {
+ rdb_ensure_file( $rule, $1 );
+ }
+ }
+ close LOG;
}
- else {
- warn "Run_bib2gls: Cannot read log file '$log': $!\n";
- }
return $ret;
}
-
-sub run_bib2gls_alt {
- return Run_subst( 'internal run_bib2gls %Y%R' );
-}
-
Added: trunk/Master/texmf-dist/doc/support/latexmk/example_rcfiles/splitindex.latexmkrc
===================================================================
--- trunk/Master/texmf-dist/doc/support/latexmk/example_rcfiles/splitindex.latexmkrc (rev 0)
+++ trunk/Master/texmf-dist/doc/support/latexmk/example_rcfiles/splitindex.latexmkrc 2024-04-02 21:31:27 UTC (rev 70835)
@@ -0,0 +1,29 @@
+$clean_ext .= " %R-*.ind %R-*.idx %R-*.ilg %R-*.ind";
+
+$makeindex = 'internal splitindex';
+
+sub splitindex {
+ # Use splitindex instead of makeindex.
+ # The splitindex programe starts from an .idx file, makes a set of
+ # other .idx files for separate indexes, and then runs makeindex to
+ # make corresponding .ind files.
+ # However, it is possible that the document uses the splitindex
+ # package, but in a way compatible with the standard methods
+ # compatible with makeindex, i.e., with a single index and with the
+ # use of the \printindex command.
+ # Then we need to invoke makeindex.
+ # In addition, latexmk assumes that makeindex or its replacement makes
+ # an .ind file from an .idx file, and latexmk gives an error if it
+ # doesn't exist, we need to make an .ind file.
+ # Both problems are solved by running makeindex and then splitindex.
+ # Note: errors are returned by makeindex and splitindex for things
+ # like a missing input file. No error is returned for lines in an
+ # input file that are in an incorrect format; they are simply
+ # ignored. So no problem is caused by lines in the .idx file
+ # that are generated by splitindex in a format incompatible with
+ # makeindex.
+ my $ret1 = system( "makeindex", $$Psource );
+ my $ret2 = system( "splitindex", $$Psource );
+ return $ret1 || $ret2;
+}
+
Modified: trunk/Master/texmf-dist/doc/support/latexmk/latexmk.pdf
===================================================================
(Binary files differ)
Modified: trunk/Master/texmf-dist/doc/support/latexmk/latexmk.txt
===================================================================
--- trunk/Master/texmf-dist/doc/support/latexmk/latexmk.txt 2024-04-01 23:43:48 UTC (rev 70834)
+++ trunk/Master/texmf-dist/doc/support/latexmk/latexmk.txt 2024-04-02 21:31:27 UTC (rev 70835)
@@ -61,7 +61,7 @@
- 29 March 2024 1
+ 31 January 2024 1
@@ -127,7 +127,7 @@
- 29 March 2024 2
+ 31 January 2024 2
@@ -193,7 +193,7 @@
- 29 March 2024 3
+ 31 January 2024 3
@@ -207,8 +207,7 @@
.log etc). These are all the generated files, with the excep-
tion of final output files (.dvi, .ps, .pdf, .synctex.gz, .sync-
tex). See the -outdir/-output-directory option for directories
- for the main output files, and the -out2dir option for the final
- output files.
+ for the final output files.
If the directory specified for the -aux/-aux-directory option is
blank, then the default is used, which is to be the same as the
@@ -259,12 +258,13 @@
- 29 March 2024 4
+ 31 January 2024 4
+
LATEXMK(1) General Commands Manual LATEXMK(1)
@@ -325,7 +325,7 @@
- 29 March 2024 5
+ 31 January 2024 5
@@ -391,7 +391,7 @@
- 29 March 2024 6
+ 31 January 2024 6
@@ -457,7 +457,7 @@
- 29 March 2024 7
+ 31 January 2024 7
@@ -523,7 +523,7 @@
- 29 March 2024 8
+ 31 January 2024 8
@@ -589,7 +589,7 @@
- 29 March 2024 9
+ 31 January 2024 9
@@ -655,7 +655,7 @@
- 29 March 2024 10
+ 31 January 2024 10
@@ -721,7 +721,7 @@
- 29 March 2024 11
+ 31 January 2024 11
@@ -787,7 +787,7 @@
- 29 March 2024 12
+ 31 January 2024 12
@@ -853,7 +853,7 @@
- 29 March 2024 13
+ 31 January 2024 13
@@ -919,7 +919,7 @@
- 29 March 2024 14
+ 31 January 2024 14
@@ -985,7 +985,7 @@
- 29 March 2024 15
+ 31 January 2024 15
@@ -1001,81 +1001,44 @@
directory.
If the aux directory is set, e.g., by the option -auxdir, and is
- not equal to the output directory, then only the primary output
- files (.dvi, .ps, .pdf, .synctex, .synctex.gz) are sent to the
- output directory. Other generated files are sent to the aux di-
- rectory.
+ not equal to the output directory, then only final output files
+ (.dvi, .ps, .pdf, .synctex, .synctex.gz) are sent to the output
+ directory. Other generated files are sent to the aux directory.
- See the section AUXILIARY AND OUTPUT DIRECTORIES for more de-
+ See the section AUXILIARY AND OUTPUT DIRECTORIES for more de-
tails.
- -out2dir=FOO
-
- (Experimental new feature.)
-
- Sets the directory for the final output files of a whole round
- of compilations.
-
- The use of this directory solves, among other things, the prob-
- lem that when multiple runs of *latex and other programs are
- needed, files like the main pdf file from pdflatex, etc will be
- changed multiple times. A viewer like SumatraPDF that reloads
- the file whenever it detects changes will show a distracting se-
- quence of intermediate states of the pdf file, rather than just
- the final version after all the repeated runs of *latex etc have
- been done. Instead, when a distinct final-output directory is
- set, by the -out2dir option or the equivalent $out2_dir variable
- is set, the viewer will only see a changed pdf (etc) file after
- full sequence of repeated runs of *latex etc has finished.
-
- By default the final output directory is the same as the output
- directory (as specified by the -outdir option or the setting of
- the variable $out_dir configuration variable).
-
-
-
-output-format=FORMAT
- This option is one that is allowed for latex, lualatex, and
- pdflatex. But it is not passed to these programs. Instead la-
- texmk emulates it in a way suitable for the context of latexmk
+ This option is one that is allowed for latex, lualatex, and
+ pdflatex. But it is not passed to these programs. Instead la-
+ texmk emulates it in a way suitable for the context of latexmk
and its workflows.
- If FORMAT is dvi, then dvi output is turned on, and postscript
- and pdf output are turned off. This is equivalent to using the
+ If FORMAT is dvi, then dvi output is turned on, and postscript
+ and pdf output are turned off. This is equivalent to using the
options -dvi -ps- -pdf-.
- If FORMAT is pdf, then pdf output is turned on, and dvi and
- postscript output are turned off. This is equivalent to using
+ If FORMAT is pdf, then pdf output is turned on, and dvi and
+ postscript output are turned off. This is equivalent to using
the options -pdf -ps- -dvi-.
-
-
- 29 March 2024 16
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
If FORMAT is anything else, latexmk gives an error.
- -p Print out the document. By default the file to be printed is
- the first in the list postscript, pdf, dvi that is being made.
+ -p Print out the document. By default the file to be printed is
+ the first in the list postscript, pdf, dvi that is being made.
But you can use the -print=... option to change the type of file
to be printed, and you can configure this in a start up file (by
setting the $print_type variable).
- However, printing is enabled by default only under UNIX/Linux
+ However, printing is enabled by default only under UNIX/Linux
systems, where the default is to use the lpr command and only on
postscript files. In general, the correct behavior for printing
very much depends on your system's software. In particular, un-
- der MS-Windows you must have suitable program(s) available, and
- you must have configured the print commands used by latexmk.
- This can be non-trivial. See the documentation on the $lpr,
+ der MS-Windows you must have suitable program(s) available, and
+ you must have configured the print commands used by latexmk.
+ This can be non-trivial. See the documentation on the $lpr,
$lpr_dvi, and $lpr_pdf configuration variables to see how to set
the commands for printing.
@@ -1083,19 +1046,31 @@
turns them off.
- -pdf Generate pdf version of document using pdflatex. (If you wish
+ -pdf Generate pdf version of document using pdflatex. (If you wish
to use lualatex or xelatex, you can use whichever of the options
- -pdflua, -pdfxe, -lualatex or -xelatex applies.) To configure
- latexmk to have such behavior by default, see the section on
+
+
+
+ 31 January 2024 16
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
+ -pdflua, -pdfxe, -lualatex or -xelatex applies.) To configure
+ latexmk to have such behavior by default, see the section on
"Configuration/initialization (rc) files".
-pdfdvi
- Generate dvi file and then pdf version of document from the dvi
+ Generate dvi file and then pdf version of document from the dvi
file, by default using dvipdf.
- The program used to compile the document to dvi is latex by de-
- fault, but this can be changed to dvilulatex by the use of the
+ The program used to compile the document to dvi is latex by de-
+ fault, but this can be changed to dvilulatex by the use of the
-dvilua option or by setting $dvi_mode to 2.
@@ -1106,49 +1081,49 @@
-pdfps Generate dvi file, ps file from the dvi file, and then pdf file
from the ps file.
- The program used to compile the document to dvi is latex by de-
- fault, but this can be changed to dvilulatex by the use of the
+ The program used to compile the document to dvi is latex by de-
+ fault, but this can be changed to dvilulatex by the use of the
-dvilua option or by setting $dvi_mode to 2.
- -pdfxe Generate pdf version of document using xelatex. Note that to
- optimize processing time, latexmk uses xelatex to generate an
- .xdv file rather than a pdf file directly. Only after possibly
+ -pdfxe Generate pdf version of document using xelatex. Note that to
+ optimize processing time, latexmk uses xelatex to generate an
+ .xdv file rather than a pdf file directly. Only after possibly
+ multiple runs to generate a fully up-to-date .xdv file does la-
+ texmk then call xdvipdfmx to generate the final .pdf file.
+ (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.)
- 29 March 2024 17
+ -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
+ on, and then the program used to compiled a document will be la-
+ tex (or, more precisely, whatever program is configured to be
+ used in the $latex configuration variable).
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ 31 January 2024 17
- multiple runs to generate a fully up-to-date .xdv file does la-
- texmk then call xdvipdfmx to generate the final .pdf file.
- (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
- on, and then the program used to compiled a document will be la-
- tex (or, more precisely, whatever program is configured to be
- used in the $latex configuration variable).
+LATEXMK(1) General Commands Manual LATEXMK(1)
-pdflatex
@@ -1155,7 +1130,7 @@
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
+ Note: to set the command used when pdflatex is specified, see
the -pdflatex="COMMAND" option.
@@ -1167,31 +1142,19 @@
latexmk -pdf -pdflatex="pdflatex --shell-escape %O %S"
foo.tex
- The specification of the contents of the string are the same as
+ 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
+ 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
+ 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.
- To set the command for running latex (rather than the command
-
-
-
- 29 March 2024 18
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
+ To set the command for running latex (rather than the command
for pdflatex) see the -latex option.
@@ -1206,10 +1169,10 @@
-pretex=CODE
Given that CODE is some TeX code, this options sets that code to
- be executed before inputting source file. This only works if
+ be executed before inputting source file. This only works if
the command for invoking the relevant *latex is suitably config-
- ured. See the documentation of the variable $pre_tex_code, and
- the substitution strings %P and %U for more details. This op-
+ ured. See the documentation of the variable $pre_tex_code, and
+ the substitution strings %P and %U for more details. This op-
tion works by setting the variable $pre_tex_code.
See also the -usepretex option.
@@ -1217,6 +1180,18 @@
An example:
latexmk -pretex='\AtBeginDocument{Message\par}' -usepretex
+
+
+
+ 31 January 2024 18
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
foo.tex
But this is better written
@@ -1229,12 +1204,12 @@
-print=dvi, -print=ps, -print=pdf, -print=auto,
- Define which kind of file is printed. This option also ensures
+ Define which kind of file is printed. This option also ensures
that the requisite file is made, and turns on printing.
The (default) case -print=auto determines the kind of print file
- automatically from the set of files that is being made. The
- first in the list postscript, pdf, dvi that is among the files
+ automatically from the set of files that is being made. The
+ first in the list postscript, pdf, dvi that is among the files
to be made is the one used for print out.
@@ -1242,24 +1217,13 @@
-ps- Turn off generation of postscript version of document. This can
- be used to override a setting in a configuration file. (It may
- get overridden by some other option that requires a postscript
+ be used to override a setting in a configuration file. (It may
+ get overridden by some other option that requires a postscript
file, for example a request for printing.)
-
-
- 29 March 2024 19
-
-
-
-
-
-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
+ -pF Postscript file filtering. The argument to this option is a
+ filter which will generate a filtered postscript file with the
extension ".psF". All extra processing (e.g. preview, printing)
will then be performed on this filtered postscript file.
@@ -1272,83 +1236,94 @@
latexmk -ps -pF "psnup -2" foo.tex
Whether to use single or double quotes round the "psnup -2" will
- depend on your command interpreter, as used by the particular
+ depend on your command interpreter, as used by the particular
version of perl and the operating system on your computer.
- -pv Run file previewer. If the -view option is used, that will se-
+ -pv Run file previewer. If the -view option is used, that will se-
lect the kind of file to be previewed (.pdf, .ps or .dvi). Oth-
- erwise the viewer views the "highest" kind of output file that
- is made, with the ordering being .pdf, .ps, .dvi (high to low).
- This option is incompatible with the -p and -pvc options, so it
+ erwise the viewer views the "highest" kind of output file that
+ is made, with the ordering being .pdf, .ps, .dvi (high to low).
+ This option is incompatible with the -p and -pvc options, so it
turns them off.
+
+ 31 January 2024 19
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
-pv- Turn off -pv.
- -pvc Run a file previewer and continually update the .dvi, .ps,
+ -pvc Run a file previewer and continually update the .dvi, .ps,
and/or .pdf files whenever changes are made to source files (see
- the Description above). Which of these files is generated and
- which is viewed is governed by the other options, and is the
- same as for the -pv option. The preview-continuous option -pvc
- can only work with one file. So in this case you will normally
- only specify one filename on the command line. It is also in-
- compatible with the -p and -pv options, so it turns these op-
+ the Description above). Which of these files is generated and
+ which is viewed is governed by the other options, and is the
+ same as for the -pv option. The preview-continuous option -pvc
+ can only work with one file. So in this case you will normally
+ only specify one filename on the command line. It is also in-
+ compatible with the -p and -pv options, so it turns these op-
tions off.
- The -pvc option also turns off force mode (-f), as is normally
- best for continuous preview mode. If you really want force
+ The -pvc option also turns off force mode (-f), as is normally
+ best for continuous preview mode. If you really want force
mode, use the options in the order -pvc -f.
With a good previewer the display will be automatically updated.
- (Under some but not all versions of UNIX/Linux "gv -watch" does
- this for postscript files; this can be set by a configuration
- variable. This would also work for pdf files except for an ap-
+ (Under some but not all versions of UNIX/Linux "gv -watch" does
+ this for postscript files; this can be set by a configuration
+ variable. This would also work for pdf files except for an ap-
parent bug in gv that causes an error when the newly updated pdf
file is read.) Many other previewers will need a manual update.
Important note: the acroread program on MS-Windows locks the pdf
- file, and prevents new versions being written, so it is a bad
- idea to use acroread to view pdf files in preview-continuous
- mode. It is better to use a different viewer: SumatraPDF and
+ file, and prevents new versions being written, so it is a bad
+ idea to use acroread to view pdf files in preview-continuous
+ mode. It is better to use a different viewer: SumatraPDF and
+ gsview are good possibilities.
+ There are some other methods for arranging an update, notably
+ useful for many versions of xdvi and xpdf. These are best set
+ in latexmk's configuration; see below.
+ Note that if latexmk dies or is stopped by the user, the
+ "forked" previewer will continue to run. Successive invocations
+ with the -pvc option will not fork new previewers, but latexmk
+ will normally use the existing previewer. (At least this will
+ happen when latexmk is running under an operating system where
+ it knows how to determine whether an existing previewer is run-
+ ning.)
- 29 March 2024 20
+ -pvc- Turn off -pvc.
+ -pvctimeout
+ Do timeout in pvc mode after period of inactivity, which is 30
+ min. by default. Inactivity means a period when latexmk has de-
+ tected no file changes and hence has not taken any actions like
+ compiling the document.
-LATEXMK(1) General Commands Manual LATEXMK(1)
- gsview are good possibilities.
- There are some other methods for arranging an update, notably
- useful for many versions of xdvi and xpdf. These are best set
- in latexmk's configuration; see below.
- Note that if latexmk dies or is stopped by the user, the
- "forked" previewer will continue to run. Successive invocations
- with the -pvc option will not fork new previewers, but latexmk
- will normally use the existing previewer. (At least this will
- happen when latexmk is running under an operating system where
- it knows how to determine whether an existing previewer is run-
- ning.)
+ 31 January 2024 20
- -pvc- Turn off -pvc.
- -pvctimeout
- Do timeout in pvc mode after period of inactivity, which is 30
- min. by default. Inactivity means a period when latexmk has de-
- tected no file changes and hence has not taken any actions like
- compiling the document.
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
-pvctimeout-
Don't do timeout in pvc mode after inactivity.
@@ -1361,43 +1336,31 @@
-r <rcfile>
- Read the specified initialization file ("RC file") before pro-
+ Read the specified initialization file ("RC file") before pro-
cessing.
Be careful about the ordering: (1) Standard initialization files
- -- see the section below on "Configuration/initialization (RC)
- files" -- are read first. (2) Then the options on the command
- line are acted on in the order they are given. Therefore if an
- initialization file is specified by the -r option, it is read
- during this second step. Thus an initialization file specified
+ -- see the section below on "Configuration/initialization (RC)
+ files" -- are read first. (2) Then the options on the command
+ line are acted on in the order they are given. Therefore if an
+ initialization file is specified by the -r option, it is read
+ during this second step. Thus an initialization file specified
with the -r option can override both the standard initialization
files and previously specified options. But all of these can be
overridden by later options.
The contents of the RC file just comprise a piece of code in the
- Perl programming language (typically a sequence of assignment
+ Perl programming language (typically a sequence of assignment
statements); they are executed when the -r option is encountered
during latexmk's parsing of its command line. See the -e option
-
-
-
- 29 March 2024 21
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
- for a way of giving initialization code directly on latexmk's
- command line. An error results in latexmk stopping. Multiple
+ for a way of giving initialization code directly on latexmk's
+ command line. An error results in latexmk stopping. Multiple
instances of the -r and -e options can be used, and they are ex-
ecuted in the order they appear on the command line.
-rc-report
- After initialization, give a list of the RC files read. (De-
+ After initialization, give a list of the RC files read. (De-
fault)
@@ -1406,155 +1369,168 @@
-recorder
- Give the -recorder option with *latex. In (most) modern ver-
- sions of these programs, this 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
+ Give the -recorder option with *latex. In (most) modern ver-
+ sions of these programs, this 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. This is the default setting of latexmk, unless overrid-
den in an initialization file.
For further information, see the documentation for the $recorder
- configuration variable.
- -recorder-
- Do not supply the -recorder option with *latex.
+ 31 January 2024 21
- -rules Show a list of latemk's rules and dependencies after processing.
- -rules-
- Do not show a list of latexmk's rules and dependencies after
- processing. (This is the default.)
- -showextraoptions
- Show the list of extra *latex options that latexmk recognizes,
- but that it simply passes through to the programs *latex when
- they are run. These options are (currently) a combination of
- those allowed by the TeXLive and MiKTeX implementations. (If a
- particular option is given to latexmk but is not handled by the
- particular implementation of *latex that is being used, that
- program will probably give a warning or an error.) These op-
- tions are very numerous, but are not listed in this documenta-
- tion because they have no effect on latexmk's actions.
+LATEXMK(1) General Commands Manual LATEXMK(1)
- There are a few options (e.g., -includedirectory=dir, -initial-
- ize, -ini) that are not recognized, either because they don't
- fit with latexmk's intended operations, or because they need
+ configuration variable.
- 29 March 2024 22
+ -recorder-
+ Do not supply the -recorder option with *latex.
+ -rules Show a list of latemk's rules and dependencies after processing.
+ -rules-
+ Do not show a list of latexmk's rules and dependencies after
+ processing. (This is the default.)
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ -showextraoptions
+ Show the list of extra *latex options that latexmk recognizes,
+ but that it simply passes through to the programs *latex when
+ they are run. These options are (currently) a combination of
+ those allowed by the TeXLive and MiKTeX implementations. (If a
+ particular option is given to latexmk but is not handled by the
+ particular implementation of *latex that is being used, that
+ program will probably give a warning or an error.) These op-
+ tions are very numerous, but are not listed in this documenta-
+ tion because they have no effect on latexmk's actions.
- special processing by latexmk that isn't implemented (at least,
+ There are a few options (e.g., -includedirectory=dir, -initial-
+ ize, -ini) that are not recognized, either because they don't
+ fit with latexmk's intended operations, or because they need
+ special processing by latexmk that isn't implemented (at least,
not yet).
- There are certain options for *latex (e.g., -recorder) that
+ There are certain options for *latex (e.g., -recorder) that
trigger special actions or behavior by latexmk itself. Depending
- on the action, they may also be passed in some form to the
+ on the action, they may also be passed in some form to the
called *latex program, and/or may affect other programs as well.
- These options do have entries in this documentation. Among
+ These options do have entries in this documentation. Among
these options are: -jobname=STRING, -aux-directory=dir, -output-
directory=DIR, -quiet, and -recorder.
- There are also options that are accepted by *latex, but instead
+ There are also options that are accepted by *latex, but instead
trigger actions purely by latexmk: -help, -version.
-silent
Run commands silently, i.e., with options that reduce the amount
- of diagnostics generated. For example, with the default set-
- tings, the command "latex -interaction=batchmode" is used for
+ of diagnostics generated. For example, with the default set-
+ tings, the command "latex -interaction=batchmode" is used for
latex, and similarly for its friends.
- See also the -logfilewarninglist and -logfilewarninglist- op-
+ See also the -logfilewarninglist and -logfilewarninglist- op-
tions.
- Also reduce the number of informational messages that latexmk
+ Also reduce the number of informational messages that latexmk
+
+
+
+ 31 January 2024 22
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
itself generates.
- To change the options used to make the commands run silently,
+ To change the options used to make the commands run silently,
you need to configure latexmk with changed values of its config-
- uration variables, the relevant ones being $bib-
- tex_silent_switch, $biber_silent_switch, $dvipdf_silent_switch,
+ uration variables, the relevant ones being $bib-
+ tex_silent_switch, $biber_silent_switch, $dvipdf_silent_switch,
$dvips_silent_switch, $dvilualatex_silent_switch, $la-
- tex_silent_switch, $lualatex_silent_switch $makein-
- dex_silent_switch, $pdflatex_silent_switch, and $xela-
+ tex_silent_switch, $lualatex_silent_switch $makein-
+ dex_silent_switch, $pdflatex_silent_switch, and $xela-
tex_silent_switch
-stdtexcmds
- Sets the commands for latex, etc, so that they are the standard
+ Sets the commands for latex, etc, so that they are the standard
ones. This is useful to override special configurations.
- The result is that $latex = 'latex %O %S', and similarly for
- $pdflatex, $lualatex, and $xelatex. (The option -no-pdf needed
+ 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
the definition.)
-time Show time used. (On MS Windows, what is shown is clock time; on
- other systems CPU time.) See also the configuration variable
+ other systems CPU time.) See also the configuration variable
$show_time.
- -time- Do not show time used. See also the configuration variable
+ -time- Do not show time used. See also the configuration variable
$show_time.
+ -use-make
+ When after a run of *latex, there are warnings about missing
+ files (e.g., as requested by the LaTeX \input, \include, and
+ \includgraphics commands), latexmk tries to make them by a cus-
+ tom dependency. If no relevant custom dependency with an appro-
+ priate source file is found, and if the -use-make option is set,
+ then as a last resort latexmk will try to use the make program
+ to try to make the missing files.
- 29 March 2024 23
+ Note that the filename may be specified without an extension,
+ e.g., by \includegraphics{drawing} in a LaTeX file. In that
+ case, latexmk will try making drawing.ext with ext set in turn
+ to the possible extensions that are relevant for latex (or as
+ appropriate pdflatex, lualatex, xelatex).
+ See also the documentation for the $use_make_for_missing_files
+ configuration variable.
+ -use-make-
+ Do not use the make program to try to make missing files. (De-
+ fault.)
-LATEXMK(1) General Commands Manual LATEXMK(1)
- -use-make
- When after a run of *latex, there are warnings about missing
- files (e.g., as requested by the LaTeX \input, \include, and
- \includgraphics commands), latexmk tries to make them by a cus-
- tom dependency. If no relevant custom dependency with an appro-
- priate source file is found, and if the -use-make option is set,
- then as a last resort latexmk will try to use the make program
- to try to make the missing files.
+ 31 January 2024 23
- Note that the filename may be specified without an extension,
- e.g., by \includegraphics{drawing} in a LaTeX file. In that
- case, latexmk will try making drawing.ext with ext set in turn
- to the possible extensions that are relevant for latex (or as
- appropriate pdflatex, lualatex, xelatex).
- See also the documentation for the $use_make_for_missing_files
- configuration variable.
- -use-make-
- Do not use the make program to try to make missing files. (De-
- fault.)
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
-usepretex
Sets the command lines for latex, etc, so that they use the code
- that is defined by the variable $pre_tex_code or that is set by
+ that is defined by the variable $pre_tex_code or that is set by
the option -pretex=CODE to execute the specified TeX code before
the source file is read. This option overrides any previous de-
finition of the command lines.
- The result is that $latex = 'latex %O %P', and similarly for
- $pdflatex, $lualatex, and $xelatex. (The option -no-pdf needed
+ The result is that $latex = 'latex %O %P', and similarly for
+ $pdflatex, $lualatex, and $xelatex. (The option -no-pdf needed
for $xelatex is provided automatically, given that %O appears in
the definition.)
@@ -1576,46 +1552,45 @@
-view=default, -view=dvi, -view=ps, -view=pdf, -view=none
Set the kind of file used when previewing is requested (e.g., by
the -pv or -pvc switches). The default is to view the "highest"
+ kind of requested file (in the low-to-high order .dvi, .ps,
+ .pdf).
+ Note the possibility -view=none where no viewer is opened at
+ all. One example of is use is in conjunction with the -pvc op-
+ tion, when you want latexmk to do a compilation automatically
+ whenever source file(s) change, but do not want a previewer to
+ be opened.
- 29 March 2024 24
+ -Werror
+ This causes latexmk to return a non-zero status code if any of
+ the files processed gives a warning about problems with cita-
+ tions or references (i.e., undefined citations or references or
+ about multiply defined references). This is after latexmk has
+ completed all the runs it needs to try and resolve references
+ and citations. Thus -Werror causes latexmk to treat such warn-
+ ings as errors, but only when they occur on the last run of *la-
+ tex and only after processing is complete. Also can be set by
+ the configuration variable $warnings_as_errors.
+ -xdv Generate xdv version of document using xelatex.
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ 31 January 2024 24
- kind of requested file (in the low-to-high order .dvi, .ps,
- .pdf).
- Note the possibility -view=none where no viewer is opened at
- all. One example of is use is in conjunction with the -pvc op-
- tion, when you want latexmk to do a compilation automatically
- whenever source file(s) change, but do not want a previewer to
- be opened.
- -Werror
- This causes latexmk to return a non-zero status code if any of
- the files processed gives a warning about problems with cita-
- tions or references (i.e., undefined citations or references or
- about multiply defined references). This is after latexmk has
- completed all the runs it needs to try and resolve references
- and citations. Thus -Werror causes latexmk to treat such warn-
- ings as errors, but only when they occur on the last run of *la-
- tex and only after processing is complete. Also can be set by
- the configuration variable $warnings_as_errors.
+LATEXMK(1) General Commands Manual LATEXMK(1)
- -xdv Generate xdv version of document using xelatex.
-
-xelatex
Use xelatex. That is, use xelatex to process the source file(s)
- to pdf. The generation of dvi and postscript files is turned
+ to pdf. The generation of dvi and postscript files is turned
off.
This option is equivalent to using the following set of options
@@ -1622,45 +1597,33 @@
-pdfxe -dvi- -ps-
- [Note: Note that the method of implementation of this option,
- but not its intended primary effect, differ from some earlier
- versions of latexmk. Latexmk first uses xelatex to make an .xdv
- file, and does all the extra runs needed (including those of
- bibtex, etc). Only after that does it make the pdf file from
- the .xdv file, using xdvipdfmx. See the documentation for the
+ [Note: Note that the method of implementation of this option,
+ but not its intended primary effect, differ from some earlier
+ versions of latexmk. Latexmk first uses xelatex to make an .xdv
+ file, and does all the extra runs needed (including those of
+ bibtex, etc). Only after that does it make the pdf file from
+ the .xdv file, using xdvipdfmx. See the documentation for the
-pdfxe for why this is done.]
-xelatex="COMMAND"
- This sets the string specifying the command to run xelatex. It
+ This sets the string specifying the command to run xelatex. It
sets the variable $xelatex.
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
+ 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.
-
-
-
- 29 March 2024 25
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
An example of the use of the -pdfxelatex option:
- latexmk -pdfxe -pdfxelatex="xelatex --shell-escape %O %S"
+ 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
+ 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.
@@ -1667,11 +1630,11 @@
Compatibility between options
- The preview-continuous option -pvc can only work with one file. So in
- this case you will normally only specify one filename on the command
+ The preview-continuous option -pvc can only work with one file. So in
+ this case you will normally only specify one filename on the command
line.
- Options -p, -pv and -pvc are mutually exclusive. So each of these op-
+ Options -p, -pv and -pvc are mutually exclusive. So each of these op-
tions turns the others off.
@@ -1679,6 +1642,18 @@
% latexmk thesis # run latex enough times to resolve
cross-references
+
+
+
+ 31 January 2024 25
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
% latexmk -pvc -ps thesis# run latex enough times to resolve
cross-references, make a postscript
file, start a previewer. Then
@@ -1699,33 +1674,21 @@
DEALING WITH ERRORS, PROBLEMS, ETC
Some possibilities:
- a. If you get a strange error, do look carefully at the output that is
- on the screen and in log files. While there is much that is notori-
+ a. If you get a strange error, do look carefully at the output that is
+ on the screen and in log files. While there is much that is notori-
ously verbose in the output of latex (and that is added to by latexmk),
- the verbosity is there for a reason: to enable the user to diagnose
- problems. Latexmk does repeat some messages at the end of a run that
- it thinks would otherwise be easy to miss in the middle of other out-
+ the verbosity is there for a reason: to enable the user to diagnose
+ problems. Latexmk does repeat some messages at the end of a run that
+ it thinks would otherwise be easy to miss in the middle of other out-
put.
- b. Generally, remember that latexmk does its work by running other
+ b. Generally, remember that latexmk does its work by running other pro-
+ grams. Your first priority in dealing with errors should be to examine
+ what went wrong with the individual programs. Then you need to correct
+ the causes of errors in the runs of these programs. (Often these come
+ from errors in the source document, but they could also be about miss-
+ ing LaTeX packages, etc.)
-
-
- 29 March 2024 26
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
- programs. Your first priority in dealing with errors should be to ex-
- amine what went wrong with the individual programs. Then you need to
- correct the causes of errors in the runs of these programs. (Often
- these come from errors in the source document, but they could also be
- about missing LaTeX packages, etc.)
-
c. If latexmk doesn't run the programs the way you would like, then you
need to look in this documentation at the list of command line options
and then at the sections on configuration/initialization files. A lot
@@ -1745,6 +1708,18 @@
f. There's a useful trick that can be used when you use lualatex in-
stead of pdflatex (and in some related situations). The problem is
+
+
+
+ 31 January 2024 26
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
that latexmk won't notice a dependency on a file, bar.baz say, that is
input by the lua code in your document instead of by the LaTeX part.
(Thus if you change bar.baz and rerun latexmk, then latexmk will think
@@ -1773,19 +1748,6 @@
-
-
-
-
- 29 March 2024 27
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
AUXILIARY AND OUTPUT DIRECTORIES
Running *latex and the associated programs generate a number of files,
it is often convenient to arrange for the generated files to be in a
@@ -1812,6 +1774,18 @@
tex programs, these directories default to the current directory, and
then the generated files aren't segregated. If the two directories are
the same, as is the simplest situation, then all generated files are
+
+
+
+ 31 January 2024 27
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
written to the same directory, and one often simply refers to the out-
put directory, without mentioning a separate aux directory.
@@ -1839,26 +1813,14 @@
Latexmk also turns emulation on if it is found to be needed, as fol-
lows. Suppose emulation is initially off, but the aux and output di-
rectories are different. Then latexmk invokes *latex with an -aux-di-
- rectory option and after the run finds that it hasn't been obeyed,
+ rectory option and after the run finds that it hasn't been obeyed, no-
+ tably because the .log file is in the output directory rather than the
+ aux directory. Latexmk then sets emulation on, and retries. Conceiv-
+ ably, it could move all the appropriate generated files from the output
+ directory to the aux directory; but there is such a large variety of
+ possibilities for these files that this is hard to identify all of them
+ reliably except for simple cases.
-
-
- 29 March 2024 28
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
- notably because the .log file is in the output directory rather than
- the aux directory. Latexmk then sets emulation on, and retries. Con-
- ceivably, it could move all the appropriate generated files from the
- output directory to the aux directory; but there is such a large vari-
- ety of possibilities for these files that this is hard to identify all
- of them reliably except for simple cases.
-
Note that the emulation issue only arises when the user has arranged
for the the aux and output directories to be different. When instead
they are equal, e.g., because the user only set the $out_dir variable,
@@ -1877,50 +1839,50 @@
cause of compatibility issues, is of .fls files: See below.
Note that xelatex when invoked with its -no-pdf option, as latexmk
- does, generates an .xdv file, which would appear to have the same sta-
- tus as a .dvi file generated by latex. Nevertheless, latexmk treats
- .xdv as an intermediate file that is found in the aux directory. This
- is to match MiKTeX's treatment of the -aux-directory option. As fur-
- ther justification, one can say that under modern conditions an .xdv
- file is (almost) always an intermediate file. Historically, the situa-
- tion with .dvi files from latex was different, and currently dvi pre-
- viewers do exist.
+ does, generates an .xdv file, which would appear to have the same
- Variables and options for directories: The variables for setting the
- aux and output directories are $aux_dir and $out_dir, with correspond-
- ing command line options -auxdir (or -aux-directory) and -outdir (or
- -output-directory). When a value for these is blank (which is the de-
- fault value), it implies the use of a default: For the aux directory,
- the default is to set it equal to the output directory. For the output
- directory, the default is to be the current directory.
- For the turning on and off of the emulation mode, there is the configu-
- ration variable $emulate_aux and the options -emulate-aux-dir, -emu-
- late-aux-dir-, -noemulate-aux-dir.
+ 31 January 2024 28
- Interaction with -cd option: When the -cd option is used (or the equiv-
- alent setting of $do_cd variable), then latexmk changes the working di-
- rectory to the document directory before invoking *latex. If the aux
- and/or output directories are given by relative paths, e.g., by -out-
- dir=output for a directory named "output", then the directories are
- relative to the document directory, rather than relative to the working
- 29 March 2024 29
+LATEXMK(1) General Commands Manual LATEXMK(1)
+ status as a .dvi file generated by latex. Nevertheless, latexmk treats
+ .xdv as an intermediate file that is found in the aux directory. This
+ is to match MiKTeX's treatment of the -aux-directory option. As fur-
+ ther justification, one can say that under modern conditions an .xdv
+ file is (almost) always an intermediate file. Historically, the situa-
+ tion with .dvi files from latex was different, and currently dvi pre-
+ viewers do exist.
+ Variables and options for directories: The variables for setting the
+ aux and output directories are $aux_dir and $out_dir, with correspond-
+ ing command line options -auxdir (or -aux-directory) and -outdir (or
+ -output-directory). When a value for these is blank (which is the de-
+ fault value), it implies the use of a default: For the aux directory,
+ the default is to set it equal to the output directory. For the output
+ directory, the default is to be the current directory.
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ For the turning on and off of the emulation mode, there is the configu-
+ ration variable $emulate_aux and the options -emulate-aux-dir, -emu-
+ late-aux-dir-, -noemulate-aux-dir.
+ Interaction with -cd option: When the -cd option is used (or the equiv-
+ alent setting of $do_cd variable), then latexmk changes the working di-
+ rectory to the document directory before invoking *latex. If the aux
+ and/or output directories are given by relative paths, e.g., by -out-
+ dir=output for a directory named "output", then the directories are
+ relative to the document directory, rather than relative to the working
directory that was in effect when latexmk was invoked. This matches the
- behavior of *latex as invoked with the provided command line directory
- argument(s) after the change of working directory to the document di-
+ behavior of *latex as invoked with the provided command line directory
+ argument(s) after the change of working directory to the document di-
rectory.
Automatic creation of aux and output directories: Unlike *latex, if la-
@@ -1929,161 +1891,171 @@
If the document uses the \include macro to read a .tex file from a sub-
directory, *latex will attempt to write an extra aux file to the corre-
- sponding subdirectory of the aux directory. If the subdirectory
- doesn't exist, then *latex will complain that it can't write the aux
+ sponding subdirectory of the aux directory. If the subdirectory
+ doesn't exist, then *latex will complain that it can't write the aux
file. After the run of *latex, latexmk detects this situation, creates
- the necessary directory, and reruns *latex with the error situation
+ the necessary directory, and reruns *latex with the error situation
corrected.
Choice of aux and output directories: Often the aux and output directo-
- ries are given as subdirectories of the document directory, e.g., by
+ ries are given as subdirectories of the document directory, e.g., by
-outdir=output. But it is possible to provide, for example, an absolute
- path or a path relative to a parent directory, e.g., "/tmp/foo" or
+ path or a path relative to a parent directory, e.g., "/tmp/foo" or
"../output". Be aware that in general this can cause problems, notably
- with makeindex or bibtex. This is because modern versions of these
- programs, by default, will refuse to work when they find that they are
+ 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 cur-
- rent working directory or one of its subdirectories. This is part of
+ rent working directory or one of its subdirectories. This is part of
+
+
+
+ 31 January 2024 29
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
security measures by the whole TeX system that try to prevent malicious
or errant TeX documents from incorrectly messing with a user's files.
- By default, latexmk evades this issue: Before running bibtex and
+ By default, latexmk evades this issue: Before running bibtex and
makeindex, latexmk changes working directory to the aux directory, with
appropriate settings of search paths. The use or non-use of this trick
- is governed by the variables $bibtex_fudge and $makeindex_fudge. Un-
- fortunately, the trick sometimes makes bibtex and makeindex unable to
+ is governed by the variables $bibtex_fudge and $makeindex_fudge. Un-
+ fortunately, the trick sometimes makes bibtex and makeindex unable to
find files.
If necessary the trick can be turned off. But this is incompatible with
- an aux directory like, "/tmp/foo" of "../output"). If you really have
+ an aux directory like, "/tmp/foo" of "../output"). If you really have
to deal with this situation, and only if you have to deal with it, then
- you need to disable the security measures (and assume any risks). One
+ you need to disable the security measures (and assume any risks). One
way of doing this is to temporarily set an operating system environment
- variable openout_any to "a" (as in "all"), to override the default
+ variable openout_any to "a" (as in "all"), to override the default
"paranoid" setting.
- Certain names of aux and output directories not allowed on Microsoft
+ Certain names of aux and output directories not allowed on Microsoft
Windows: It is natural to want to use the name "aux" for the aux direc-
- tory, e.g., by using the option -auxdir=aux. But on Microsoft operat-
+ tory, e.g., by using the option -auxdir=aux. But on Microsoft operat-
ing systems "aux" is one of the names that is not allowed for a file or
- directory. I find it useful to standardize on a name like "auxdir"
- (e.g., by -auxdir=auxdir); this works independently of operating sys-
+ directory. I find it useful to standardize on a name like "auxdir"
+ (e.g., by -auxdir=auxdir); this works independently of operating sys-
tem.
- Location of .fls file: Much of the dependency information that latexmk
+ Location of .fls file: Much of the dependency information that latexmk
uses comes from the .fls file generated when *latex is invoked with the
+ -recorder option, which latexmk does by default. It may seem rational
+ that this is written to the aux directory. But in fact versions of
+ MiKTeX prior to Oct. 2020 wrote it to the output directory. Later ver-
+ sions do write it to the aux directory. To deal with this, latexmk
+ does two things: First, if latexmk finds that the .fls file has only
+ been generated in the "wrong" directory, then latexmk copies it to the
+ expected directory, after which latexmk's operation continues correctly
+ independently of the behavior of *latex. Second it allows its idea of
+ the "correct" (or expected) directory to be configured by the variable
+ $fls_uses_aux_dir. This defaults to zero, to correspond to MiKTeX's
+ current behavior.
- 29 March 2024 30
+ALLOWING FOR CHANGE OF OUTPUT FILE TYPE
+ When one of the latex engines is run, the usual situation is that latex
+ produces a .dvi file, while pdflatex and lualatex produce a .pdf file.
+ For xelatex the default is to produce a .pdf file, but to optimize pro-
+ cessing time latexmk runs xelatex its -no-pdf option so that it pro-
+ duces an .xdv file. Further processing by latexmk takes this as a
+ starting point.
+ However, the actual output file may differ from the normal expectation;
+ and then latexmk can adjust its processing to accommodate this situa-
+ tion. The difference in output file type can happen for two reasons:
+ One is that for latex, pdflatex and lualatex the document itself can
+ 31 January 2024 30
-LATEXMK(1) General Commands Manual LATEXMK(1)
- -recorder option, which latexmk does by default. It may seem rational
- that this is written to the aux directory. But in fact versions of
- MiKTeX prior to Oct. 2020 wrote it to the output directory. Later ver-
- sions do write it to the aux directory. To deal with this, latexmk
- does two things: First, if latexmk finds that the .fls file has only
- been generated in the "wrong" directory, then latexmk copies it to the
- expected directory, after which latexmk's operation continues correctly
- independently of the behavior of *latex. Second it allows its idea of
- the "correct" (or expected) directory to be configured by the variable
- $fls_uses_aux_dir. This defaults to zero, to correspond to MiKTeX's
- current behavior.
+LATEXMK(1) General Commands Manual LATEXMK(1)
-ALLOWING FOR CHANGE OF OUTPUT FILE TYPE
- When one of the latex engines is run, the usual situation is that latex
- produces a .dvi file, while pdflatex and lualatex produce a .pdf file.
- For xelatex the default is to produce a .pdf file, but to optimize pro-
- cessing time latexmk runs xelatex its -no-pdf option so that it pro-
- duces an .xdv file. Further processing by latexmk takes this as a
- starting point.
- However, the actual output file may differ from the normal expectation;
- and then latexmk can adjust its processing to accommodate this situa-
- 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,
+ override the defaults. The other is that there may be a configuration,
or misconfiguration, such that the program that latexmk invokes to com-
- pile the document is not the expected one, or is given options incom-
+ pile the document is not the expected one, or is given options incom-
patible with what latexmk initially expects.
- Under latex and pdflatex, control of the output format by the document
- is done by setting the \pdfoutput macro. Under lualatex, the \output-
+ Under latex and pdflatex, control of the output format by the document
+ is done by setting the \pdfoutput macro. Under lualatex, the \output-
mode macro is used instead.
One example of an important use-case for document control of the output
- format is a document that uses the psfrag package to insert graphical
+ format is a document that uses the psfrag package to insert graphical
elements in the output file. The psfrag package achieves its effects by
inserting postscript code in the output of the compilation of the docu-
- ment. This entails the use of compilation to a .dvi file, followed by
- the use of conversion to a postscript file (either directly, as by
- dvips or implicitly, as an intermediate step by dvipdf). Then it is
- useful to force output to be of the .dvi format by inserting \pdfout-
+ ment. This entails the use of compilation to a .dvi file, followed by
+ the use of conversion to a postscript file (either directly, as by
+ dvips or implicitly, as an intermediate step by dvipdf). Then it is
+ useful to force output to be of the .dvi format by inserting \pdfout-
put=0 in the preamble of the document.
- Another example is where the document uses graphics file of the .pdf,
- .jpg, and png types. With the default setting for the graphicx pack-
- age, these can be processed in compilation to .pdf but not with compi-
- lation to .dvi. In this case, it is useful to insert \pdfoutput=1 in
- the preamble of the document to force compilation to .pdf output for-
+ Another example is where the document uses graphics file of the .pdf,
+ .jpg, and png types. With the default setting for the graphicx pack-
+ age, these can be processed in compilation to .pdf but not with compi-
+ lation to .dvi. In this case, it is useful to insert \pdfoutput=1 in
+ the preamble of the document to force compilation to .pdf output for-
mat.
In all of these cases, it is needed that latexmk has to adjust its pro-
- cessing to deal with a mismatch between the actual output format (out
+ cessing to deal with a mismatch between the actual output format (out
+ of .pdf, .dvi, .xdv) and the initially expected output, if possible.
+ Latexmk does this provided the following conditions are met.
+ The first is that latexmk's $allow_switch configuration variable is set
+ to a non-zero value as it is by default. If this variable is zero, a
+ mismatch of filetypes in the compilation results in an error.
+ The second condition for latexmk to be able to handle a change of out-
+ put type is that no explicit requests for .dvi or .ps output files are
+ made. Explicit requests are by the -dvi and -ps, -print=dvi,
+ -print=ps, -view=dvi, and -view=ps options, and by corresponding set-
+ tings of the $dvi_mode, $postscript_mode, $print_type, and $view con-
+ figuration variables. The print-type and view-type restrictions only
+ apply when printing and viewing are explicitly requested, respectively.
+ For this purpose, the use of the -pdfdvi and -pdfps options (and the
+ corresponding setting of the $pdf_mode variable) does not count as an
+ explicit request for the .dvi and .ps files; they are merely regarded
+ as a request for making a .pdf file together with an initial proposal
+ for the processing route to make it.
- 29 March 2024 31
+ Note that when accommodating a change in output file type, there is in-
+ volved a substantial change in the network of rules that latexmk uses
+ in its actions. The second condition applied to accommodate a change
+ is to avoid situations where the change in the rule network is too rad-
+ ical to be readily handled automatically.
+ 31 January 2024 31
-LATEXMK(1) General Commands Manual LATEXMK(1)
- of .pdf, .dvi, .xdv) and the initially expected output, if possible.
- Latexmk does this provided the following conditions are met.
- The first is that latexmk's $allow_switch configuration variable is set
- to a non-zero value as it is by default. If this variable is zero, a
- mismatch of filetypes in the compilation results in an error.
- The second condition for latexmk to be able to handle a change of out-
- put type is that no explicit requests for .dvi or .ps output files are
- made. Explicit requests are by the -dvi and -ps, -print=dvi,
- -print=ps, -view=dvi, and -view=ps options, and by corresponding set-
- tings of the $dvi_mode, $postscript_mode, $print_type, and $view con-
- figuration variables. The print-type and view-type restrictions only
- apply when printing and viewing are explicitly requested, respectively.
- For this purpose, the use of the -pdfdvi and -pdfps options (and the
- corresponding setting of the $pdf_mode variable) does not count as an
- explicit request for the .dvi and .ps files; they are merely regarded
- as a request for making a .pdf file together with an initial proposal
- for the processing route to make it.
+LATEXMK(1) General Commands Manual LATEXMK(1)
- Note that when accommodating a change in output file type, there is in-
- volved a substantial change in the network of rules that latexmk uses
- in its actions. The second condition applied to accommodate a change
- is to avoid situations where the change in the rule network is too rad-
- ical to be readily handled automatically.
-
-
CONFIGURATION/INITIALIZATION (RC) FILES
- In this section is explained which configuration files are read by la-
- texmk. Subsequent sections "How to Set Variables in Initialization
- Files", "Format of Command Specifications", "List of Configuration
- Variables Usable in Initialization Files", "Custom Dependencies", and
- "Advanced Configuration" give details on what can be configured and
+ In this section is explained which configuration files are read by la-
+ texmk. Subsequent sections "How to Set Variables in Initialization
+ Files", "Format of Command Specifications", "List of Configuration
+ Variables Usable in Initialization Files", "Custom Dependencies", and
+ "Advanced Configuration" give details on what can be configured and
how.
Latexmk can be customized using initialization files, which are read at
@@ -2091,7 +2063,7 @@
1) The system RC file, if it exists.
On a UNIX system, latexmk searches the following directories for a
- system RC file, which may be named either "LatexMk" or "latexmkrc".
+ system RC file, which may be named either "LatexMk" or "latexmkrc".
The
directories are searched in the following order, and latexmk uses
the first such file it finds (if any):
@@ -2100,93 +2072,79 @@
"/usr/local/share/latexmk",
"/usr/local/lib/latexmk".
On a MS-Windows system it looks just in "C:\latexmk".
- On a cygwin system (i.e., a MS-Windows system in which Perl is that
+ On a cygwin system (i.e., a MS-Windows system in which Perl is that
of cygwin), latexmk looks in the directories
"/cygdrive/c/latexmk",
"/etc",
-
-
-
- 29 March 2024 32
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
"/opt/local/share/latexmk",
"/usr/local/share/latexmk",
"/usr/local/lib/latexmk".
- If the environment variable LATEXMKRCSYS is set, its value is used as
+ If the environment variable LATEXMKRCSYS is set, its value is used as
the name of the system RC file, instead of any of the above.
2) The user's RC file, if it exists. This can be in one of two places.
- The traditional one is ".latexmkrc" in the user's home directory. The
- other possibility is "latexmk/latexmkrc" in the user's XDG configura-
- tion home directory. The actual file read is the first of "$XDG_CON-
- FIG_HOME/latexmk/latexmkrc" or "$HOME/.latexmkrc" which exists. (See
+ The traditional one is ".latexmkrc" in the user's home directory. The
+ other possibility is "latexmk/latexmkrc" in the user's XDG configura-
+ tion home directory. The actual file read is the first of "$XDG_CON-
+ FIG_HOME/latexmk/latexmkrc" or "$HOME/.latexmkrc" which exists. (See
https://specifications.freedesktop.org/basedir-spec/basedir-spec-lat-
est.html for details on the XDG Base Directory Specification.)
- Here $HOME is the user's home directory. [Latexmk determines the
- user's home directory as follows: It is the value of the environment
- variable HOME, if this variable exists, which normally is the case on
- UNIX-like systems (including Linux and OS-X). Otherwise the environ-
- ment variable USERPROFILE is used, if it exists, which normally is the
+ Here $HOME is the user's home directory. [Latexmk determines the
+ user's home directory as follows: It is the value of the environment
+ variable HOME, if this variable exists, which normally is the case on
+ UNIX-like systems (including Linux and OS-X). Otherwise the environ-
+ ment variable USERPROFILE is used, if it exists, which normally is the
case on MS-Windows systems. Otherwise a blank string is used instead of
$HOME, in which case latexmk does not look for an RC file in it.]
- $XDG_CONFIG_HOME is the value of the environment variable XDG_CON-
- FIG_HOME if it exists. If this environment variable does not exist,
- but $HOME is non-blank, then $XDG_CONFIG_HOME is set to the default
- value of $HOME/.config. Otherwise $XDG_CONFIG_HOME is blank, and la-
+ $XDG_CONFIG_HOME is the value of the environment variable XDG_CON-
+ FIG_HOME if it exists. If this environment variable does not exist,
+ but $HOME is non-blank, then $XDG_CONFIG_HOME is set to the default
+ value of $HOME/.config. Otherwise $XDG_CONFIG_HOME is blank, and la-
texmk does not look for an RC file under it.
- 3) The RC file in the current working directory. This file can be
- named either "latexmkrc" or ".latexmkrc", and the first of these to be
+
+ 31 January 2024 32
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
+ 3) The RC file in the current working directory. This file can be
+ named either "latexmkrc" or ".latexmkrc", and the first of these to be
found is used, if any.
4) Any RC file(s) specified on the command line with the -r option.
Each RC file is a sequence of Perl commands. Naturally, a user can use
- this in creative ways. But for most purposes, one simply uses a se-
+ this in creative ways. But for most purposes, one simply uses a se-
quence of assignment statements that override some of the built-in set-
- tings of Latexmk. Straightforward cases can be handled without knowl-
- edge of the Perl language by using the examples in this document as
+ tings of Latexmk. Straightforward cases can be handled without knowl-
+ edge of the Perl language by using the examples in this document as
templates. Comment lines are introduced by the "#" character.
- Note that command line options are obeyed in the order in which they
+ Note that command line options are obeyed in the order in which they
are written; thus any RC file specified on the command line with the -r
- option can override previous options but can be itself overridden by
- later options on the command line. There is also the -e option, which
+ option can override previous options but can be itself overridden by
+ later options on the command line. There is also the -e option, which
allows initialization code to be specified in latexmk's command line.
For possible examples of code for in an RC file, see the directory ex-
- ample_rcfiles in the distribution of latexmk (e.g., at http://mir-
+ ample_rcfiles in the distribution of latexmk (e.g., at http://mir-
ror.ctan.org/support/latexmk/example_rcfiles).
-
-
-
- 29 March 2024 33
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
HOW TO SET VARIABLES IN INITIALIZATION FILES
- The important variables that can be configured are described in the
- section "List of configuration variables usable in initialization
- files". (See the earlier section "Configuration/Initialization (rc)
- Files" for the files where the configurations are done.) Syntax for
+ The important variables that can be configured are described in the
+ section "List of configuration variables usable in initialization
+ files". (See the earlier section "Configuration/Initialization (rc)
+ Files" for the files where the configurations are done.) Syntax for
setting these variables is of the following forms:
$bibtex = 'bibtex %O %S';
@@ -2199,60 +2157,60 @@
@default_files = ('paper', 'paper1');
- for the setting of an array of strings. It is possible to append an
+ for the setting of an array of strings. It is possible to append an
item to an array variable as follows:
push @default_files, 'paper2';
- Note that simple "scalar" variables have names that begin with a $
+ Note that simple "scalar" variables have names that begin with a $
character and array variables have names that begin with a @ character.
Each statement ends with a semicolon.
- Strings should be enclosed in single quotes. (You could use double
- quotes, as in many programming languages. But then the Perl program-
- ming language brings into play some special rules for interpolating
- variables into strings. People not fluent in Perl will want to avoid
- these complications.)
+ Strings should be enclosed in single quotes. (You could use double
+ quotes, as in many programming languages. But then the Perl program-
+ ming language brings into play some special rules for interpolating
+ variables into strings. People not fluent in Perl will want to avoid
- You can do much more complicated things, but for this you will need to
- consult a manual for the Perl programming language.
+ 31 January 2024 33
-FORMAT OF COMMAND SPECIFICATIONS
- Some of the variables set the commands that latexmk uses for carrying
- out its work, for example to generate a .dvi file from a .tex file or
- to view a postscript file. This section describes some important fea-
- tures of how the commands are specified. (Note that some of the possi-
- bilities listed here do not apply to the $kpsewhich variable; see its
- documentation.)
- Placeholders: Supposed you wanted latexmk to use the command elatex in
- place of the regular latex command, and suppose moreover that you
- wanted to give it the option "--shell-escape". You could do this by
- the following setting:
- $latex = 'elatex --shell-escape %O %S';
- The two items starting with the % character are placeholders. These
+LATEXMK(1) General Commands Manual LATEXMK(1)
+ these complications.)
- 29 March 2024 34
+ You can do much more complicated things, but for this you will need to
+ consult a manual for the Perl programming language.
+FORMAT OF COMMAND SPECIFICATIONS
+ Some of the variables set the commands that latexmk uses for carrying
+ out its work, for example to generate a .dvi file from a .tex file or
+ to view a postscript file. This section describes some important fea-
+ tures of how the commands are specified. (Note that some of the possi-
+ bilities listed here do not apply to the $kpsewhich variable; see its
+ documentation.)
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ Placeholders: Supposed you wanted latexmk to use the command elatex in
+ place of the regular latex command, and suppose moreover that you
+ wanted to give it the option "--shell-escape". You could do this by
+ the following setting:
+ $latex = 'elatex --shell-escape %O %S';
- are substituted by appropriate values before the command is run. Thus
- %S will be replaced by the source file that elatex will be applied to,
- and %O will be replaced by any options that latexmk has decided to use
+ The two items starting with the % character are placeholders. These
+ are substituted by appropriate values before the command is run. Thus
+ %S will be replaced by the source file that elatex will be applied to,
+ and %O will be replaced by any options that latexmk has decided to use
for this command. (E.g., if you used the -silent option in the invoca-
- tion of latexmk, it results in the replacement of %O by "-interac-
+ tion of latexmk, it results in the replacement of %O by "-interac-
tion=batchmode".)
The available placeholders are:
@@ -2261,125 +2219,123 @@
the setting of a jobname by the -jobname option or the $jobname
configuration value.
- %B base of filename for current command. E.g., if a postscript
- file document.ps is being made from the dvi file document.dvi,
+ %B base of filename for current command. E.g., if a postscript
+ file document.ps is being made from the dvi file document.dvi,
then the basename is document.
- %D destination file (e.g., the name of the postscript file when
+ %D destination file (e.g., the name of the postscript file when
converting a dvi file to postscript).
%O options
- %P If the variable $pre_tex_code is non-empty, then %P is substi-
- tuted by the contents of $pre_tex_code followed by \in-
- put{SOURCE}, where SOURCE stands for the name of the source
+ %P If the variable $pre_tex_code is non-empty, then %P is substi-
+ tuted by the contents of $pre_tex_code followed by \in-
+ put{SOURCE}, where SOURCE stands for the name of the source
file. Appropriate quoting is done. This enables TeX code to be
- passed to one of the *latex engines to be executed before the
+ passed to one of the *latex engines to be executed before the
source file is read.
- If the variable $pre_tex_code is the empty string, then %P is
- equivalent to %S.
+ If the variable $pre_tex_code is the empty string, then %P is
- %R root filename.
- By default this is the basename of the main tex file. However
- the value can be changed by the use of the -jobname option or
- the $jobname configuration variable. This is then the basename
- for files like the .aux and .log files produced by running *la-
- tex, as well for the main .dvi, .pdf, .ps and/or .xdvi files.
- %S source file (e.g., the name of the dvi file when converting a
- .dvi file to ps).
+ 31 January 2024 34
- %T The name of the primary tex file.
- %U If the variable $pre_tex_code is non-empty, then its value is
- substituted for %U (appropriately quoted). Otherwise it is re-
- placed by a null string.
- %Y Name of directory for auxiliary output files (see the configura-
- tion variable $aux_dir). A directory separation character ('/')
- is appended if $aux_dir is non-empty and does not end in a suit-
- able character, with suitable characters being those appropriate
- to UNIX and MS-Windows, i.e., ':', '/' and '\'. Note that if
+LATEXMK(1) General Commands Manual LATEXMK(1)
- 29 March 2024 35
+ equivalent to %S.
+ %R root filename. This is the base name for the main tex file.
+ By default this is the basename of the main tex file. However
+ the value can be changed by the use of the -jobname option or
+ the $jobname configuration variable.
+ %S source file (e.g., the name of the dvi file when converting a
+ .dvi file to ps).
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ %T The name of the primary tex file.
+ %U If the variable $pre_tex_code is non-empty, then its value is
+ substituted for %U (appropriately quoted). Otherwise it is re-
+ placed by a null string.
- after initialization, $out_dir is set, but $aux_dir is not set
- (i.e., it is blank), then latexmk sets $aux_dir to the same
+ %Y Name of directory for auxiliary output files (see the configura-
+ tion variable $aux_dir). A directory separation character ('/')
+ is appended if $aux_dir is non-empty and does not end in a suit-
+ able character, with suitable characters being those appropriate
+ to UNIX and MS-Windows, i.e., ':', '/' and '\'. Note that if
+ after initialization, $out_dir is set, but $aux_dir is not set
+ (i.e., it is blank), then latexmk sets $aux_dir to the same
value $out_dir.
- %Z Name of directory for output files (see the configuration vari-
- able $out_dir). A directory separation character ('/') is ap-
- pended if $out_dir is non-empty and does not end in a suitable
- character, with suitable characters being those appropriate to
+ %Z Name of directory for output files (see the configuration vari-
+ able $out_dir). A directory separation character ('/') is ap-
+ pended if $out_dir is non-empty and does not end in a suitable
+ character, with suitable characters being those appropriate to
UNIX and MS-Windows, i.e., ':', '/' and '\'.
- If for some reason you need a literal % character in your string not
+ If for some reason you need a literal % character in your string not
subject to the above rules, use "%%".
- Appropriate quoting will be applied to the filename substitutions, so
- you mustn't supply them yourself even if the names of your files have
+ Appropriate quoting will be applied to the filename substitutions, so
+ you mustn't supply them yourself even if the names of your files have
spaces in them. (But if your TeX filenames have spaces in them, beware
- that some older versions of the TeX program cannot correctly handle
- filenames containing spaces.) In case latexmk's quoting does not work
- correctly on your system, you can turn it off -- see the documentation
+ that some older versions of the TeX program cannot correctly handle
+ filenames containing spaces.) In case latexmk's quoting does not work
+ correctly on your system, you can turn it off -- see the documentation
for the variable $quote_filenames.
- See the default values in the section "List of configuration variables
+ See the default values in the section "List of configuration variables
usable in initialization files" for what is normally the most appropri-
ate usage.
If you omit to supply any placeholders whatever in the specification of
- a command, latexmk will supply what its author thinks are appropriate
+ a command, latexmk will supply what its author thinks are appropriate
defaults. This gives compatibility with configuration files for previ-
ous versions of latexmk, which didn't use placeholders.
- "Detaching" a command: Normally when latexmk runs a command, it waits
+ "Detaching" a command: Normally when latexmk runs a command, it waits
for the command to run to completion. This is appropriate for commands
- like latex, of course. But for previewers, the command should normally
- run detached, so that latexmk gets the previewer running and then re-
- turns to its next task (or exits if there is nothing else to do). To
- achieve this effect of detaching a command, you need to precede the
- command name with "start ", as in
- $dvi_previewer = 'start xdvi %O %S';
- This will be translated to whatever is appropriate for your operating
- system.
- Notes: (1) In some circumstances, latexmk will always run a command de-
- tached. This is the case for a previewer in preview continuous mode,
- since otherwise previewing continuously makes no sense. (2) This pre-
- cludes the possibility of running a command named start. (3) If the
- word start occurs more than once at the beginning of the command
- string, that is equivalent to having just one. (4) Under cygwin, some
- complications happen, since cygwin amounts to a complicated merging of
- UNIX and MS-Windows. See the source code for how I've handled the
- problem.
+ 31 January 2024 35
- Command names containing spaces: Under MS-Windows it is common that the
- 29 March 2024 36
+LATEXMK(1) General Commands Manual LATEXMK(1)
+ like latex, of course. But for previewers, the command should normally
+ run detached, so that latexmk gets the previewer running and then re-
+ turns to its next task (or exits if there is nothing else to do). To
+ achieve this effect of detaching a command, you need to precede the
+ command name with "start ", as in
+ $dvi_previewer = 'start xdvi %O %S';
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ This will be translated to whatever is appropriate for your operating
+ system.
+ Notes: (1) In some circumstances, latexmk will always run a command de-
+ tached. This is the case for a previewer in preview continuous mode,
+ since otherwise previewing continuously makes no sense. (2) This pre-
+ cludes the possibility of running a command named start. (3) If the
+ word start occurs more than once at the beginning of the command
+ string, that is equivalent to having just one. (4) Under cygwin, some
+ complications happen, since cygwin amounts to a complicated merging of
+ UNIX and MS-Windows. See the source code for how I've handled the
+ problem.
+ Command names containing spaces: Under MS-Windows it is common that the
name of a command includes spaces, since software is often installed in
a subdirectory of "C:\Program Files". Such command names should be en-
closed in double quotes, as in
@@ -2388,35 +2344,46 @@
%S';
$pdf_previewer = 'start "c:/Program Files/SumatraPDF/Suma-
traPDF.exe" %O %S';
- $pdf_previewer = 'start "c:/Program Files/SumatraPDF (x86)/Suma-
+ $pdf_previewer = 'start "c:/Program Files/SumatraPDF (x86)/Suma-
traPDF.exe" %O %S';
- (Note about the above example: Under MS-Windows forward slashes are
+ (Note about the above example: Under MS-Windows forward slashes are
equivalent to backslashes in a filename under almost all circumstances,
- provided that the filename is inside double quotes. It is easier to
+ provided that the filename is inside double quotes. It is easier to
use forward slashes in examples like the one above, since then one does
- not have to worry about the rules for dealing with forward slashes in
+ not have to worry about the rules for dealing with forward slashes in
strings in the Perl language.)
- Command names under Cygwin: If latexmk is executed by Cygwin's Perl,
+ Command names under Cygwin: If latexmk is executed by Cygwin's Perl,
be particularly certain that pathnames in commands have forward slashes
- not the usual backslashes for the separator of pathname components.
- See the above examples. Backslashes often get misinterpreted by the
+ not the usual backslashes for the separator of pathname components.
+ See the above examples. Backslashes often get misinterpreted by the
Unix shell used by Cygwin's Perl to execute external commands. Forward
slashes don't suffer from this problem, and (when quoted, as above) are
equally acceptable to MS-Windows.
- Using MS-Windows file associations: A useful trick under modern ver-
+ Using MS-Windows file associations: A useful trick under modern ver-
sions of MS-Windows (e.g., WinXP) is to use just the command 'start' by
itself:
$dvi_previewer = 'start %S';
+
+
+ 31 January 2024 36
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
Under MS-Windows, this will cause to be run whatever program the system
- has associated with dvi files. (The same applies for a postscript
+ has associated with dvi files. (The same applies for a postscript
viewer and a pdf viewer.) But note that this trick is not always suit-
- able for the pdf previwer, if your system has acroread for the default
+ able for the pdf previwer, if your system has acroread for the default
pdf viewer. As explained elsewhere, acroread under MS-Windows does not
work well with latex and latexmk, because acroread locks the pdf file.
@@ -2425,30 +2392,18 @@
$lpr = 'NONE lpr';
- This typically is used when an appropriate command does not exist on
+ This typically is used when an appropriate command does not exist on
your system. The string after the "NONE" is effectively a comment.
Options to commands: Setting the name of a command can be used not only
for changing the name of the command called, but also to add options to
- command. Suppose you want latexmk to use latex with source specials
- enabled. Then you might use the following line in an initialization
+ command. Suppose you want latexmk to use latex with source specials
+ enabled. Then you might use the following line in an initialization
file:
-
-
-
- 29 March 2024 37
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
$latex = 'latex --src-specials %O %S';
- Running a subroutine instead of an external command: Use a specifica-
+ Running a subroutine instead of an external command: Use a specifica-
tion starting with "internal", as in
$latex = 'internal mylatex %O %S';
@@ -2458,95 +2413,78 @@
return system 'latex', @args;
}
- For some of the more exotic possibilities that then become available,
- see the section "Advanced configuration: Some extra resources and ad-
- vanced tricks". Also see some of the examples in the directory exam-
+ For some of the more exotic possibilities that then become available,
+ see the section "Advanced configuration: Some extra resources and ad-
+ vanced tricks". Also see some of the examples in the directory exam-
ple_rcfiles in the latexmk distribution.
- Advanced tricks: Normally one specifies a single command for the com-
- mands invoked by latexmk. Naturally, if there is some complicated ad-
- ditional processing you need to do in your special situation, you can
+ Advanced tricks: Normally one specifies a single command for the com-
+ mands invoked by latexmk. Naturally, if there is some complicated ad-
+ ditional processing you need to do in your special situation, you can
write a script (or batch file) to do the processing, and then configure
latexmk to use your script in place of the standard program.
- You can also use a Perl subroutine instead of a script -- see above.
+ You can also use a Perl subroutine instead of a script -- see above.
This is generally the most flexible and portable solution.
It is also possible to configure latexmk to run multiple commands. For
- example, if when running pdflatex to generate a pdf file from a tex
+ example, if when running pdflatex to generate a pdf file from a tex
file you need to run another program after pdflatex to perform some ex-
tra processing, you could do something like:
- $pdflatex = 'pdflatex --shell-escape %O %S; pst2pdf_for_latexmk
+ $pdflatex = 'pdflatex --shell-escape %O %S; pst2pdf_for_latexmk
%B';
- This definition assumes you are using a UNIX-like system (which in-
- cludes Linux and OS-X), so that the two commands to be run are sepa-
- rated by the semicolon in the middle of the string.
- If you are using MS-Windows, you would replace the above line by
- $pdflatex = 'cmd /c pdflatex --shell-escape %O %S'
- . '&& pst2pdf_for_latexmk %B';
+ 31 January 2024 37
- Here, the UNIX command separator ; is replaced by &&. In addition,
- there is a problem that some versions of Perl on MS-Windows do not obey
- the command separator; this problem is overcome by explicitly invoking
- the MS-Windows command-line processor cmd.exe.
-LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES
- In this section are specified the variables whose values can be ad-
- justed to configure latexmk. (See the earlier section "Configura-
- tion/Initialization (rc) Files" for the files where the configurations
- are done.)
+LATEXMK(1) General Commands Manual LATEXMK(1)
- 29 March 2024 38
+ This definition assumes you are using a UNIX-like system (which in-
+ cludes Linux and OS-X), so that the two commands to be run are sepa-
+ rated by the semicolon in the middle of the string.
+ If you are using MS-Windows, you would replace the above line by
+ $pdflatex = 'cmd /c pdflatex --shell-escape %O %S'
+ . '&& pst2pdf_for_latexmk %B';
+ Here, the UNIX command separator ; is replaced by &&. In addition,
+ there is a problem that some versions of Perl on MS-Windows do not obey
+ the command separator; this problem is overcome by explicitly invoking
+ the MS-Windows command-line processor cmd.exe.
-LATEXMK(1) General Commands Manual LATEXMK(1)
+LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES
+ In this section are specified the variables whose values can be ad-
+ justed to configure latexmk. (See the earlier section "Configura-
+ tion/Initialization (rc) Files" for the files where the configurations
+ are done.)
Default values are indicated in brackets. Note that for variables that
- are boolean in character, concerning whether latexmk does or does not
- behave in a certain way, a non-zero value, normally 1, indicates true,
- i.e., the behavior occurs, while a zero value indicates a false value,
+ are boolean in character, concerning whether latexmk does or does not
+ behave in a certain way, a non-zero value, normally 1, indicates true,
+ i.e., the behavior occurs, while a zero value indicates a false value,
i.e., the behavior does not occur.
- $allow_subdir_creation [1]
-
- Specify action to take when message(s) in the .log file indicate
- a failure of an attempt by a *latex compilation to write a file
- to a subdirectory of the output directory because the subdirec-
- tory didn't exist.
-
- If the value if $allow_subdir_creation is 0, no action is taken.
- If it is 1, then the appropriate subdirectory is created and a
- rerun of *latex is triggered, but only if the file being written
- is an .aux file. (This happens, for example, if the document
- includes a file from a subdirectory of the document directory,
- by the \include command. If the value of $allow_subdir_creation
- is 2, then the subdirectory creation is done independently of
- which type of file is in question.
-
-
$allow_switch [1]
- This controls what happens when the output extension of latex,
- pdflatex, lualatex or xelatex differs from what is expected.
+ This controls what happens when the output extension of latex,
+ pdflatex, lualatex or xelatex differs from what is expected.
(The possible extensions are .dvi, .pdf, .xdv.) This can happen
- with the use of the \pdfoutput macro in a document compiled un-
- der latex or pdflatex, or with the use of the \outputmode macro
+ with the use of the \pdfoutput macro in a document compiled un-
+ der latex or pdflatex, or with the use of the \outputmode macro
under lualatex. It can also happen with certain kinds of incor-
rect configuration.
- In such a case, latexmk can appropriately adjust its network of
+ In such a case, latexmk can appropriately adjust its network of
rules. The adjustment is made if $allow_switch is on, and if no
request for a dvi or ps file has been made.
@@ -2554,22 +2492,18 @@
$always_view_file_via_temporary [0]
- Whether .ps and .pdf files are initially to be made in a tempo-
- rary directory and then moved to the final location. (This ap-
+ Whether .ps and .pdf files are initially to be made in a tempo-
+ rary directory and then moved to the final location. (This ap-
plies to dvips, dvipdf, and ps2pdf operations, and the filtering
operators on .dvi and .ps files. It does not apply to pdflatex,
- unfortunately, since pdflatex provides no way of specifying a
+ unfortunately, since pdflatex provides no way of specifying a
chosen name for the output file.)
This use of a temporary file solves a problem that the making of
- these files can occupy a substantial time. If a viewer (notably
- gv) sees that the file has changed, it may read the new file be-
- fore the program writing the file has not yet finished its work,
- which can cause havoc.
- 29 March 2024 39
+ 31 January 2024 38
@@ -2578,8 +2512,13 @@
LATEXMK(1) General Commands Manual LATEXMK(1)
+ these files can occupy a substantial time. If a viewer (notably
+ gv) sees that the file has changed, it may read the new file be-
+ fore the program writing the file has not yet finished its work,
+ which can cause havoc.
+
See the $pvc_view_file_via_temporary variable for a setting that
- applies only if preview-continuous mode (-pvc option) is used.
+ applies only if preview-continuous mode (-pvc option) is used.
See $tmpdir for the setting of the directory where the temporary
file is created.
@@ -2586,135 +2525,136 @@
$analyze_input_log_always [1]
- After a run of latex (etc), always analyze .log for input files
- in the <...> and (...) constructions. Otherwise, only do the
+ After a run of latex (etc), always analyze .log for input files
+ in the <...> and (...) constructions. Otherwise, only do the
analysis when fls file doesn't exist or is out of date.
- Under normal circumstances, the data in the fls file is reli-
+ Under normal circumstances, the data in the fls file is reli-
able, and the test of the log file gets lots of false positives;
- usually $analyze_input_log_always is best set to zero. But the
- test of the log file is needed at least in the following situa-
- tion: When a user needs to persuade latexmk that a certain file
- is a source file, and latexmk doesn't otherwise find it. Then
- the user can write code that causes a line with (...) to be
- written to log file. One important case is for lualatex, which
- doesn't always generate lines in the .fls file for input lua
- files. (The situation with lualatex is HIGHLY version depen-
- dent, e.g., there was a big change between TeXLive 2016 and
+ usually $analyze_input_log_always is best set to zero. But the
+ test of the log file is needed at least in the following situa-
+ tion: When a user needs to persuade latexmk that a certain file
+ is a source file, and latexmk doesn't otherwise find it. Then
+ the user can write code that causes a line with (...) to be
+ written to log file. One important case is for lualatex, which
+ doesn't always generate lines in the .fls file for input lua
+ files. (The situation with lualatex is HIGHLY version depen-
+ dent, e.g., there was a big change between TeXLive 2016 and
TeXLive 2017.)
- To keep backward compatibility with older versions of latexmk,
+ To keep backward compatibility with older versions of latexmk,
the default is to set $analyze_input_log_always to 1.
$auto_rc_use [1]
- Whether to automatically read the standard initialization (rc)
+ Whether to automatically read the standard initialization (rc)
files, which are the system RC file, the user's RC file, and the
RC file in the current directory. The command line option -norc
- can be used to turn this setting off. Each RC file could also
- turn this setting off, i.e., it could set $auto_rc_use to zero
+ can be used to turn this setting off. Each RC file co2uld also
+ turn this setting off, i.e., it could set $auto_rc_use to zero
to prevent automatic reading of the later RC files.
- This variable does not affect the reading of RC files specified
+ This variable does not affect the reading of RC files specified
on the command line by the -r option.
$aux_dir [""]
- The aux directory, i.e., the directory in which auxiliary files
+ The aux directory, i.e., the directory in which auxiliary files
(aux, log, etc) are to be written by a run of *latex.
- If this variable is not set, but $out_dir is set, then latexmk
- takes the aux directory to equal the output directory which is
+ If this variable is not set, but $out_dir is set, then latexmk
+ takes the aux directory to equal the output directory which is
the directory to which final output files are to be written.
- If neither variable is set, then the current directory when *la-
- tex is invoked is used both for the aux and output directories.
+ If neither variable is set, then the current directory when
- If the aux and output directories are distinct, then the aux di-
- rectory contains all generated files with the exception of "fi-
- nal output files", which are defined to be .dvi, .ps, .pdf,
+ 31 January 2024 39
- 29 March 2024 40
-
LATEXMK(1) General Commands Manual LATEXMK(1)
+ *latex is invoked is used both for the aux and output directo-
+ ries.
+
+ If the aux and output directories are distinct, then the aux di-
+ rectory contains all generated files with the exception of "fi-
+ nal output files", which are defined to be .dvi, .ps, .pdf,
.synctex, and .synctex.gz files.
- See the section AUXILIARY AND OUTPUT DIRECTORIES for more de-
+ See the section AUXILIARY AND OUTPUT DIRECTORIES for more de-
tails.
$aux_out_dir_report [0]
- If this variable is set to 1, then prior to the processing of
+ If this variable is set to 1, then prior to the processing of
each primary .tex file, list the settings for aux and output di-
- rectories, after they have been normalized from the settings
+ rectories, after they have been normalized from the settings
specified during initialization.
- This report gives a reminder of where to look for generated
+ This report gives a reminder of where to look for generated
files.
- The report is done per primary .tex file, because of possible
- directory changes for each file (when the -cd option is used).
+ The report is done per primary .tex file, because of possible
+ directory changes for each file (when the -cd option is used).
In the simplest cases, the directory names are the same as orig-
inally specified. But in general some clean up/normalization is
- performed; this helps performance and cleans up output to the
+ performed; this helps performance and cleans up output to the
screen.
If this variable is set to 2, then halt after reporting the set-
- tings for the aux and out directories, rather than continuing
- with processing of tex files. This setting is primarily used
- for debugging configuration issues. See the -dir-report-only
+ tings for the aux and out directories, rather than continuing
+ with processing of tex files. This setting is primarily used
+ for debugging configuration issues. See the -dir-report-only
option.
$bad_warning_is_error [0]
- Whether to treat bad warnings reported by *latex in log file as
- errors. The specifications of the warning messages are in
+ Whether to treat bad warnings reported by *latex in log file as
+ errors. The specifications of the warning messages are in
@bad_warnings.
@bad_warnings
- Array of regular expressions specifying messages in log file
- that are officially treated as warnings rather than errors by
- *latex, but which a user may treat as errors: See $bad_warn-
+ Array of regular expressions specifying messages in log file
+ that are officially treated as warnings rather than errors by
+ *latex, but which a user may treat as errors: See $bad_warn-
ing_is_error.
- Currently the default set of these warnings is those about \end
+ Currently the default set of these warnings is those about \end
occurring inside constructs.
$banner [0]
- If nonzero, the banner message is printed across each page when
- converting the dvi file to postscript. Without modifying the
- variable $banner_message, this is equivalent to specifying the
- -d option.
+ If nonzero, the banner message is printed across each page when
- Note that if $banner is nonzero, the $postscript_mode is assumed
- and the postscript file is always generated, even if it is newer
+ 31 January 2024 40
- 29 March 2024 41
-
LATEXMK(1) General Commands Manual LATEXMK(1)
+ converting the dvi file to postscript. Without modifying the
+ variable $banner_message, this is equivalent to specifying the
+ -d option.
+
+ Note that if $banner is nonzero, the $postscript_mode is assumed
+ and the postscript file is always generated, even if it is newer
than the dvi file.
$banner_intensity [0.95]
Equivalent to the -bi option, this is a decimal number between 0
- and 1 that specifies how dark to print the banner message. 0 is
+ and 1 that specifies how dark to print the banner message. 0 is
black, 1 is white. The default is just right if your toner car-
tridge isn't running too low.
@@ -2723,19 +2663,19 @@
dvi file to postscript. This is equivalent to the -bm option.
$banner_scale [220.0]
- A decimal number that specifies how large the banner message
- will be printed. Experimentation is necessary to get the right
- scale for your message, as a rule of thumb the scale should be
- about equal to 1100 divided by the number of characters in the
- message. The Default is just right for 5 character messages.
+ A decimal number that specifies how large the banner message
+ will be printed. Experimentation is necessary to get the right
+ scale for your message, as a rule of thumb the scale should be
+ about equal to 1100 divided by the number of characters in the
+ message. The Default is just right for 5 character messages.
This is equivalent to the -bs option.
@BIBINPUTS
- This is an array variable, now mostly obsolete, that specifies
- directories where latexmk should look for .bib files. By de-
- fault it is set from the BIBINPUTS environment variable of the
- operating system. If that environment variable is not set, a
- single element list consisting of the current directory is set.
+ This is an array variable, now mostly obsolete, that specifies
+ directories where latexmk should look for .bib files. By de-
+ fault it is set from the BIBINPUTS environment variable of the
+ operating system. If that environment variable is not set, a
+ single element list consisting of the current directory is set.
The format of the directory names depends on your operating sys-
tem, of course. Examples for setting this variable are:
@@ -2745,39 +2685,37 @@
@BIBINPUTS = ( ".", "//server/bibfiles" );
@BIBINPUTS = ( ".", "/usr/local/texmf/bibtex/bib" );
- Note that under MS Windows, either a forward slash "/" or a
- backward slash "\" can be used to separate pathname components,
- so the first two and the second two examples are equivalent.
- Each backward slash should be doubled to avoid running afoul of
- Perl's rules for writing strings. Generally, it is simplest al-
+ Note that under MS Windows, either a forward slash "/" or a
+ backward slash "\" can be used to separate pathname components,
+ so the first two and the second two examples are equivalent.
+ Each backward slash should be doubled to avoid running afoul of
+ Perl's rules for writing strings. Generally, it is simplest al-
ways to use forward slashes instead of backward slashes.
Important note: This variable is now mostly obsolete in the cur-
- rent version of latexmk, since it now uses a better method of
- searching for files using the kpsewhich command. However, if
+ rent version of latexmk, since it now uses a better method of
+ searching for files using the kpsewhich command. However, if
your system is an unusual one without the kpsewhich command, you
may need to set the variable @BIBINPUTS.
- $biber ["biber %O %S"]
- The biber processing program.
+ 31 January 2024 41
- 29 March 2024 42
+LATEXMK(1) General Commands Manual LATEXMK(1)
+ $biber ["biber %O %S"]
+ The biber processing program.
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
$biber_silent_switch ["--onlylog"]
- Switch(es) for the biber processing program when silent mode is
+ Switch(es) for the biber processing program when silent mode is
on.
$bibtex ["bibtex %O %S"]
@@ -2784,22 +2722,22 @@
The BibTeX processing program.
$bibtex_fudge [1]
- When using bibtex, whether to change directory to $aux_dir be-
+ When using bibtex, whether to change directory to $aux_dir be-
fore running bibtex.
The need arises as follows:
- a. With bibtex before about 2019, if the filename given to it
+ a. With bibtex before about 2019, if the filename given to it
contains a path component, there was a bug that bibtex would not
- find extra aux files, as produced by the \include command in
+ find extra aux files, as produced by the \include command in
TeX.
- b. With all moderately recent versions of bibtex, bibtex may
+ b. With all moderately recent versions of bibtex, bibtex may
refuse to write its bbl and blg files, for security reasons, for
certain cases of the path component of the filename given to it.
- However, there are also rare cases where the change-directory
- method prevents bibtex from finding certain bib or bst files.
+ However, there are also rare cases where the change-directory
+ method prevents bibtex from finding certain bib or bst files.
Then $bibtex_fudge needs to be set to 0.
@@ -2810,30 +2748,26 @@
$bibtex_use [1]
Under what conditions to run bibtex or biber. When latexmk dis-
- covers from the log file that one (or more) bibtex/biber-gener-
- ated bibliographies are used, it can run bibtex or biber when-
- ever it appears necessary to regenerate the bbl file(s) from
- their source bib database file(s). But sometimes, the bib
+ covers from the log file that one (or more) bibtex/biber-gener-
+ ated bibliographies are used, it can run bibtex or biber when-
+ ever it appears necessary to regenerate the bbl file(s) from
+ their source bib database file(s). But sometimes, the bib
file(s) are not available (e.g., for a document obtained from an
external archive), but the bbl files are provided. In that case
- use of bibtex or biber will result in incorrect overwriting of
- the precious bbl files. The variable $bibtex_use controls
- whether this happens, and also controls whether or not .bbl
+ use of bibtex or biber will result in incorrect overwriting of
+ the precious bbl files. The variable $bibtex_use controls
+ whether this happens, and also controls whether or not .bbl
files are deleted in a cleanup operation.
The possible values of $bibtex_use are:
- 0: never use bibtex or biber; never delete .bbl files in a
+ 0: never use bibtex or biber; never delete .bbl files in a
cleanup.
1: only use bibtex or biber if the bib file(s) exist; never
delete .bbl files in a cleanup.
- 1.5: only use bibtex or biber if the bib files exist;
- conditionally delete .bbl files in a cleanup (i.e., delete
- them only when
- the bib files all exist).
- 29 March 2024 43
+ 31 January 2024 42
@@ -2842,23 +2776,27 @@
LATEXMK(1) General Commands Manual LATEXMK(1)
+ 1.5: only use bibtex or biber if the bib files exist;
+ conditionally delete .bbl files in a cleanup (i.e., delete
+ them only when
+ the bib files all exist).
2: run bibtex or biber whenever it appears necessary to update
- the bbl file(s), without testing for the existence of the bib
+ the bbl file(s), without testing for the existence of the bib
files; always delete .bbl files in a cleanup.
- Note: When biber is being used, conditional use of biber can be
- problematic. From latexmk's point of view the problem is that
+ Note: When biber is being used, conditional use of biber can be
+ problematic. From latexmk's point of view the problem is that
because of how biber works, a full knowledge of its source files
can only be obtained after running biber. In contrast, for bib-
- tex, full information on which bib files are used is obtained
+ tex, full information on which bib files are used is obtained
from the .aux file(s) after a run of *latex. But for biber, the
- corresponding information is somewhat incomplete; this the in-
- formation obtained in the .bcf file that is generated by the
+ corresponding information is somewhat incomplete; this the in-
+ formation obtained in the .bcf file that is generated by the
biblatex package during a run of *latex.
$cleanup_includes_cusdep_generated [0]
- If nonzero, specifies that cleanup also deletes files that are
+ If nonzero, specifies that cleanup also deletes files that are
generated by custom dependencies. (When doing a clean up, e.g.,
by use of the -C option, custom dependencies are those listed in
the .fdb_latexmk file from a previous run.)
@@ -2865,49 +2803,51 @@
$cleanup_includes_generated [0]
- If nonzero, specifies that cleanup also deletes files that are
+ If nonzero, specifies that cleanup also deletes files that are
detected in the fls file (or failing that, in log file) as being
- generated. It will also include files made from these first
+ generated. It will also include files made from these first
generation generated files.
- This operation is somewhat dangerous, and can have unintended
- consequences, since the files to be deleted are determined from
- a file created by *latex, which can contain erroneous informa-
+ This operation is somewhat dangerous, and can have unintended
+ consequences, since the files to be deleted are determined from
+ a file created by *latex, which can contain erroneous informa-
tion. Therefore this variable is turned off by default, and then
files to be deleted are restricted to those explicitly specified
- by patterns configured in the variables clean_ext,
+ by patterns configured in the variables clean_ext,
clean_full_ext, and @generated_exts. Standard cases (e.g., .log
- files) appear in latexmk's initial value for the array @gener-
+ files) appear in latexmk's initial value for the array @gener-
ated_exts.
$cleanup_mode [0]
- If nonzero, specifies cleanup mode: 1 for full cleanup, 2 for
- cleanup except for .dvi, .ps and .pdf files, 3 for cleanup ex-
- cept for dep and aux files. (There is also extra cleaning as
+ If nonzero, specifies cleanup mode: 1 for full cleanup, 2 for
+ cleanup except for .dvi, .ps and .pdf files, 3 for cleanup ex-
+ cept for dep and aux files. (There is also extra cleaning as
specified by the $clean_ext, $clean_full_ext and @generated_exts
variables.)
- This variable is equivalent to specifying one of the -c or -C
- options. But there should be no need to set this variable from
+ This variable is equivalent to specifying one of the -c or -C
+ options. But there should be no need to set this variable from
an RC file.
- $clean_ext [""]
- Extra extensions of files for latexmk to remove when any of the
- clean-up options (-c or -C) is selected. The value of this
- variable is a string containing the extensions separated by
- spaces.
- 29 March 2024 44
+ 31 January 2024 43
+
LATEXMK(1) General Commands Manual LATEXMK(1)
+ $clean_ext [""]
+ Extra extensions of files for latexmk to remove when any of the
+ clean-up options (-c or -C) is selected. The value of this
+ variable is a string containing the extensions separated by
+ spaces.
+
It is also possible to specify a more general pattern of file to
be deleted, by using the place holder %R, as in commands, and it
is also possible to use wildcards. Thus setting
@@ -2916,130 +2856,130 @@
files-%R/*";
in an initialization file will imply that when a clean-up opera-
- tion is specified, not only is the standard set of files
- deleted, but also files of the form FOO.out, FOO-blx.bib, FOO-
- figures*.log, and pythontex-files-FOO/*, where FOO stands for
+ tion is specified, not only is the standard set of files
+ deleted, but also files of the form FOO.out, FOO-blx.bib, FOO-
+ figures*.log, and pythontex-files-FOO/*, where FOO stands for
the basename of the file being processed (as in FOO.tex).
- Most of the files to be deleted are relative to the directory
- specified by $aux_dir. Note that if $out_dir but not $aux_dir
- is set, then in its initialization, latexmk sets $aux_dir equal
- to $out_dir. A normal situation is therefore that $aux_dir
- equals $out_dir, which is the only case directly supported by
- TeXLive, unlike MiKTeX. Note that even with TeXLive latexmk
+ Most of the files to be deleted are relative to the directory
+ specified by $aux_dir. Note that if $out_dir but not $aux_dir
+ is set, then in its initialization, latexmk sets $aux_dir equal
+ to $out_dir. A normal situation is therefore that $aux_dir
+ equals $out_dir, which is the only case directly supported by
+ TeXLive, unlike MiKTeX. Note that even with TeXLive latexmk
does now support different values for the directories -- see the
explanation of the $emulate_aux variable.
If $out_dir and $aux_dir different, latexmk actually deletes any
files of the specified names in both $aux_dir and $out_dir; this
- is because under certain error conditions, the files may be put
- in $out_dir instead of $aux_dir. This also handles the case of
+ is because under certain error conditions, the files may be put
+ in $out_dir instead of $aux_dir. This also handles the case of
deleting any fls file, since that file is in $out_dir.
- The filenames specified for a clean-up operation can refer not
- only to regular files but also to directories. Directories are
+ The filenames specified for a clean-up operation can refer not
+ only to regular files but also to directories. Directories are
only deleted if they are empty. An example of an application is
- to pythontex, which creates files in a particular directory.
- You can arrange to remove both the files and the directory by
+ to pythontex, which creates files in a particular directory.
+ You can arrange to remove both the files and the directory by
setting
$clean_ext = "pythontex-files-%R/* pythontex-files-%R";
- See also the (array) variable @generated_exts. In the past,
- this variable had certain uses beyond that of $clean_ext. But
- now, they accomplish the same things. In fact, after initial-
- ization including the processing of command line options, la-
+ See also the (array) variable @generated_exts. In the past,
+ this variable had certain uses beyond that of $clean_ext. But
+ now, they accomplish the same things. In fact, after initial-
+ ization including the processing of command line options, la-
texmk simply appends the list of extensions in $clean_ext to the
array @generated_exts.
$clean_full_ext [""]
- Extra extensions of files for latexmk to remove when the -C op-
- tion is selected, i.e., extensions of files to remove when the
+ Extra extensions of files for latexmk to remove when the -C op-
+ tion is selected, i.e., extensions of files to remove when the
.dvi, etc files are to be cleaned-up.
- More general patterns are allowed, as for $clean_ext.
- The files specified by $clean_full_ext to be deleted are rela-
- tive to the directory specified by $out_dir.
+ 31 January 2024 44
- 29 March 2024 45
+LATEXMK(1) General Commands Manual LATEXMK(1)
+ More general patterns are allowed, as for $clean_ext.
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ The files specified by $clean_full_ext to be deleted are rela-
+ tive to the directory specified by $out_dir.
$compiling_cmd [""], $failure_cmd [""], $warning_cmd [""], $success_cmd
[""]
- These variables specify commands that are executed at certain
- points of compilations. One motivation for their existence is
- to allow very useful convenient visual indications of compila-
- tion status even when the window receiving the screen output of
- the compilation is hidden. This is particularly useful in pre-
+ These variables specify commands that are executed at certain
+ points of compilations. One motivation for their existence is
+ to allow very useful convenient visual indications of compila-
+ tion status even when the window receiving the screen output of
+ the compilation is hidden. This is particularly useful in pre-
view-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
- window to know the status of the 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
- More complicated situations can best be handled by defining a
- Perl subroutine to invoke the necessary commands, and using the
+ 31 January 2024 45
- 29 March 2024 46
-
LATEXMK(1) General Commands Manual LATEXMK(1)
+ indication in a window title can useful, since the user does not
+ have to keep shifting attention to the (possibly hidden) compi-
+ lation 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
be invoked. (See the section "Format of Command Specifications"
for how to do this.)
@@ -3088,24 +3028,24 @@
current 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
- processed.
+ 31 January 2024 46
- 29 March 2024 47
-
LATEXMK(1) General Commands Manual LATEXMK(1)
+ can list the files to be processed by setting @default_files in
+ an initialization file (e.g., the file "latexmkrc" in the cur-
+ rent directory). Then if no files are specified on the command
+ line then the files you specify by setting @default_files are
+ processed.
+
Three examples:
@default_files = ("paper_current");
@@ -3154,26 +3094,26 @@
Name of file to receive list(s) of dependencies at the end of a
run, to be used if $dependents_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
+ 31 January 2024 47
- 29 March 2024 48
+LATEXMK(1) General Commands Manual LATEXMK(1)
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ the screen).
- behavior is not to do this, which is the same as the behavior of
- *latex programs. This variable is set by the -cd and -cd- op-
+ $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 programs. This variable is set by the -cd and -cd- op-
tions on latexmk's command line.
$dvi_filter [empty]
@@ -3182,64 +3122,64 @@
$dvilualatex ["dvilualatex %O %S"]
- Specifies the command line to invoke the dvilualatex 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 to invoke the dvilualatex 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.,
- $dvilualatex = "dvilualatex --src-specials
+ $dvilualatex = "dvilualatex --src-specials
%O %S";
- To do a coordinated setting of all of $dvilualatex, $hilatex,
+ To do a coordinated setting of all of $dvilualatex, $hilatex,
$latex, $pdflatex, $lualatex, and $xelatex, see the section "Ad-
vanced Configuration".
$dvi_mode [See below for default]
- If one, generate a dvi version of the document by use of latex.
+ If one, generate a dvi version of the document by use of latex.
Equivalent to the -dvi option.
If 2, generate a dvi version of the document by use of dviluala-
tex. Equivalent to the -dvilua 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 and $dvi_mode is
+ 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 and $dvi_mode is
zero, then $dvi_mode is set to 1.
$dvilualatex_silent_switch ["-interaction=batchmode"]
- Switch(es) for the dvilualatex program (specified in the vari-
+ Switch(es) for the dvilualatex program (specified in the vari-
able $dvilualatex) 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 $dvilualatex_silent_switch.
$dvi_previewer ["start xdvi %O %S" under UNIX]
- The command to invoke a dvi-previewer. [Under MS-Windows the
- default is "start"; then latexmk arranges to use the MS-Windows
- start program, which will cause to be run whatever command the
- system has associated with .dvi files.]
+ The command to invoke a dvi-previewer. [Under MS-Windows the
- Important note: Normally you will want to have a previewer run
- detached, so that latexmk doesn't wait for the previewer to
+ 31 January 2024 48
- 29 March 2024 49
-
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
+ 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 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-
@@ -3287,28 +3227,27 @@
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
+ 31 January 2024 49
- 29 March 2024 50
+LATEXMK(1) General Commands Manual LATEXMK(1)
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ $dvips_silent_switch ["-q"]
+ Switch(es) for dvips program when silent mode is on.
+ $dvi_update_command [""]
+ When the dvi previewer is set to be updated by running a com-
+ mand, this is the command that is run. See the information for
+ the variable $dvi_update_method for further information, and see
+ information on the variable $pdf_update_method for an example
+ for the analogous case of a pdf previewer.
- 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_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-
@@ -3334,7 +3273,7 @@
variable $dvi_update_method. The default value is the one ap-
propriate for xdvi on a UNIX system.
- $emulate_aux [1]
+ $emulate_aux [0]
Whether to emulate the use of aux directory when $aux_dir and
$out_dir are different, rather than using the -aux-directory op-
tion for the *latex programs. (MiKTeX supports -aux-directory,
@@ -3352,24 +3291,23 @@
output directory provided to *latex is set to be the desired aux
directory. After that, any files that need to be in the output
directory will be moved there by latexmk. (These are the files
- with extensions .dvi, .ps, .pdf, .synctex, .synctex.gz, and, de-
- pending on the setting of the $fls_uses_out_dir variable, also
- the .fls file.)
+ with extensions .dvi, .ps, .pdf, .synctex, .synctex.gz, and,
+ 31 January 2024 50
- 29 March 2024 51
+LATEXMK(1) General Commands Manual LATEXMK(1)
+ depending on the setting of the $fls_uses_out_dir variable, also
+ the .fls file.)
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
$failure_cmd [undefined]
See the documentation for $compiling_cmd.
@@ -3419,15 +3357,11 @@
latexmk needs to determine whether a particular file has been
produced during a just-concluded run of some rule/program or is
leftover from a previous run. (An example is the production of a
- .bcf file by the biblatex package during a run of *latex to pro-
- vide bibliographic information to the biber program. If a .bcf
- file is not produced during a current run of *latex, but is
- leftover from a previous run, then latexmk has to conclude that
- the .tex document has changed so that biber is no longer to be
+ .bcf file by the biblatex package during a run of *latex to
- 29 March 2024 52
+ 31 January 2024 51
@@ -3436,6 +3370,10 @@
LATEXMK(1) General Commands Manual LATEXMK(1)
+ provide bibliographic information to the biber program. If a
+ .bcf file is not produced during a current run of *latex, but is
+ leftover from a previous run, then latexmk has to conclude that
+ the .tex document has changed so that biber is no longer to be
used.)
Latexmk's criterion that a file has been produced during a run
@@ -3486,22 +3424,22 @@
'out', 'toc', 'blg', 'ilg', 'log', 'xdv' )]
This contains a list of extensions for files that are generated
- during processing, and that should be deleted during a main
- clean up operation, as invoked by the command line option -c.
- (The use of -C or -gg gives this clean up and more.)
+ 31 January 2024 52
- 29 March 2024 53
-
LATEXMK(1) General Commands Manual LATEXMK(1)
+ during processing, and that should be deleted during a main
+ clean up operation, as invoked by the command line option -c.
+ (The use of -C or -gg gives this clean up and more.)
+
The default values are extensions for standard files generated
by *latex, bibtex, and the like. (Note that the clean up also
deletes the fdb_latexmk file, but that's separately coded into
@@ -3552,14 +3490,10 @@
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
- 29 March 2024 54
+ 31 January 2024 53
@@ -3568,6 +3502,10 @@
LATEXMK(1) General Commands Manual LATEXMK(1)
+ 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.
@@ -3618,14 +3556,10 @@
$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
- not contain spaces.)
- 29 March 2024 55
+ 31 January 2024 54
@@ -3634,6 +3568,11 @@
LATEXMK(1) General Commands Manual LATEXMK(1)
+ 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 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
@@ -3683,15 +3622,10 @@
.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
- 29 March 2024 56
+ 31 January 2024 55
@@ -3700,6 +3634,11 @@
LATEXMK(1) General Commands Manual LATEXMK(1)
+ $kpsewhich_show [0]
+ Whether to show diagnostics about invocations of kpsewhich: the
+ command line use to invoke it and the results. These diagnos-
+ tics are shown if $kpsewhich_show is non-zero or if diagnostics
+ mode is on. (But in the second case, lots of other diagnostics
are also shown.) Without these diagnostics there is nothing
visible in latexmk's screen output about invocations of kpse-
which.
@@ -3750,22 +3689,21 @@
add_input_ext( 'latex', 'asdf' );
- add the extension 'asdf to latex_input_extensions. (Naturally
- with such an extension, you should have made an appropriate cus-
- tom dependency for latexmk, and should also have done the appro-
- priate programming in the LaTeX source file to enable the file
+ 31 January 2024 56
- 29 March 2024 57
-
LATEXMK(1) General Commands Manual LATEXMK(1)
+ add the extension 'asdf to latex_input_extensions. (Naturally
+ with such an extension, you should have made an appropriate cus-
+ tom dependency for latexmk, and should also have done the appro-
+ priate programming in the LaTeX source file to enable the file
to be read. The standard extensions are handled by LaTeX and
its graphics/graphicx packages.)
@@ -3817,21 +3755,20 @@
("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
+ 31 January 2024 57
- 29 March 2024 58
-
LATEXMK(1) General Commands Manual LATEXMK(1)
+ $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
the option -lualatex.
To do a coordinated setting of all of $dvilualatex, $hilatex,
@@ -3883,62 +3820,61 @@
The maximum number of times latexmk will run *latex before de-
ciding that there may be an infinite loop and that it needs to
bail out, rather than rerunning *latex again to resolve cross-
- references, etc. The default value covers all normal cases.
- (Note that the "etc" covers a lot of cases where one run of
+ 31 January 2024 58
- 29 March 2024 59
-
LATEXMK(1) General Commands Manual LATEXMK(1)
- *latex generates files to be read in on a later run.)
+ references, etc. The default value covers all normal cases.
+ (Note that the "etc" covers a lot of cases where one run of *la-
+ tex generates files to be read in on a later run.)
+
$MSWin_back_slash [1]
- This configuration variable only has an effect when latexmk is
- running under MS-Windows. With the default value of 1 for this
- variable, when a command is executed under MS-Windows, latexmk
- substitutes "\" for the separator character between components
- of a directory name. Internally, latexmk uses "/" for the di-
- rectory separator character, which is the character used by
+ This configuration variable only has an effect when latexmk is
+ running under MS-Windows. With the default value of 1 for this
+ variable, when a command is executed under MS-Windows, latexmk
+ substitutes "\" for the separator character between components
+ of a directory name. Internally, latexmk uses "/" for the di-
+ rectory separator character, which is the character used by
Unix-like systems.
- For almost all programs and for almost all filenames under MS-
- Windows, both "\" and "/" are acceptable as the directory sepa-
- rator character, provided at least that filenames are properly
+ For almost all programs and for almost all filenames under MS-
+ Windows, both "\" and "/" are acceptable as the directory sepa-
+ rator character, provided at least that filenames are properly
quoted. But it is possible that programs exist that only accept
- "\" on the command line, since that is the standard directory
- separator for MS-Windows. So for safety latexmk makes the sub-
+ "\" on the command line, since that is the standard directory
+ separator for MS-Windows. So for safety latexmk makes the sub-
stitution from "/" to "\", by default.
- However there are also programs on MS-Windows for which a back
+ However there are also programs on MS-Windows for which a back
slash "\" is interpreted differently than as a directory separa-
- tor; for these the directory separator should be "/". Programs
- with this behavior include all the *latex programs in the
- TeXLive implementation (but not the MiKTeX implementation).
- Hence if you use TeXLive on MS-Windows, then $MSWin_back_slash
+ tor; for these the directory separator should be "/". Programs
+ with this behavior include all the *latex programs in the
+ TeXLive implementation (but not the MiKTeX implementation).
+ Hence if you use TeXLive on MS-Windows, then $MSWin_back_slash
should be set to zero.
$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 output directory.
- This is the directory in which the main output files are written
+ This is the directory in which final output files are written
(dvi, ps, pdf, synctex, synctex.gz). In addition, if the aux
directory equals the output directory, as is the case by de-
fault, then other generated files are in effect written to the
@@ -3953,51 +3889,15 @@
+ 31 January 2024 59
- 29 March 2024 60
-
-
LATEXMK(1) General Commands Manual LATEXMK(1)
- $out2_dir [""]
- (Experimental new feature.)
-
- If non-blank, this variable specifies the final-output direc-
- tory, i.e., the directory for the final output files. If this
- variable is blank (its default value), the final-output direc-
- tory is the same as the output directory.
-
- See the description of the option -out2dir for an explanation of
- the rationale for the idea of separate output and final-output
- directories.
-
- If the final-output directory is different from the output di-
- rectory, then after a full round of compilations of the docu-
- ment, the relevant set of files is copied here from the output
- directory. The files copied are specified by the @out2_exts
- variable, and by default are those with extensions 'hnt', 'pdf',
- 'ps', 'synctex', 'synctex.gz', and a basename the same as for
- the main *latex compilation.
-
-
- @out2_exts [( 'hnt', 'pdf', 'ps', 'synctex', 'synctex.gz' )]
-
- This variable lists the extensions of the files to be copied to
- the final-output directory. The basename of the files is that
- for the main *latex compilation (corresponding to the value
- specified by the placeholder %R). More general names may be
- specified in the same way as for the @generated_exts variable,
- by inclusion of %R in a pattern, e.g.,
-
- push @out2_exts, '%R-2up.pdf';
-
-
-
$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-
@@ -4018,18 +3918,6 @@
$pdflatex ["pdflatex %O %S"]
Specifies the command line for the LaTeX processing program in a
-
-
-
- 29 March 2024 61
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
version that makes a pdf file instead of a dvi file.
An example use of this variable is to add certain options to the
@@ -4064,6 +3952,18 @@
See details of the %latex_input_extensions for other information
that equally applies to %pdflatex_input_extensions.
+
+
+
+ 31 January 2024 60
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
$pdflatex_silent_switch ["-interaction=batchmode"]
Switch(es) for the pdflatex program (specified in the variable
$pdflatex) when silent mode is on.
@@ -4085,17 +3985,6 @@
file. By default, for pdf files this association is to OS-X's
preview, which is quite satisfactory.
-
-
- 29 March 2024 62
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
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
@@ -4130,6 +4019,17 @@
Note that acroread under MS-Windows (but not UNIX) locks the pdf
file, so the default value is then 3.
+
+
+ 31 January 2024 61
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
Arranging to use a command to get a previewer explicitly updated
requires three variables to be set. For example:
@@ -4150,18 +4050,6 @@
variable $pdf_update_method. The default value is the one ap-
propriate for gv on a UNIX system.
-
-
-
- 29 March 2024 63
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
$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.
@@ -4197,6 +4085,17 @@
+
+
+ 31 January 2024 62
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
$preview_continuous_mode [0]
If nonzero, run a previewer to view the document, and continue
running latexmk to keep .dvi up-to-date. Equivalent to the -pvc
@@ -4215,19 +4114,6 @@
mended not to be set from an RC file, otherwise you could waste
lots of paper.
-
-
-
-
- 29 March 2024 64
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
$print_type = ["auto"]
Type of file to printout: possibilities are "auto", "dvi",
"none", "pdf", or "ps". See the option -print= for the meaning
@@ -4264,6 +4150,18 @@
Note that gv could be used with the -watch option updates its
display whenever the postscript file changes, whereas ghostview
+
+
+
+ 31 January 2024 63
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
does not. However, different versions of gv have slightly dif-
ferent ways of writing this option. You can configure this
variable appropriately.
@@ -4283,17 +4181,6 @@
in yourself, whenever it is needed.
-
-
- 29 March 2024 65
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
$ps_previewer_landscape ["start gv -swap %O %S", but start %O %S under
MS-Windows]
The command to invoke a ps-previewer in landscape mode.
@@ -4330,6 +4217,17 @@
The period of inactivity, in minutes, after which pvc mode times
out. This is used if $pvc_timeout is nonzero.
+
+
+ 31 January 2024 64
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
$pvc_view_file_via_temporary [1]
The same as $always_view_file_via_temporary, except that it only
applies in preview-continuous mode (-pvc option).
@@ -4349,17 +4247,6 @@
correctly treated by the operating system in passing arguments
to programs.)
-
-
- 29 March 2024 66
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
$rc_report [1]
After initialization, whether to give a list of the RC files
read.
@@ -4395,6 +4282,18 @@
[Comment to technically savvy readers: *latex doesn't actually
need the modified search path. But, surprisingly, dvipdf and
+
+
+
+ 31 January 2024 65
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
dvips do, because sometimes graphics files get generated in the
output or aux directories.]
@@ -4414,18 +4313,6 @@
Note: On MS Windows, this is clock time. On other OSs it is the
CPU time used (by latexmk and the child processes it invokes).
-
-
-
- 29 March 2024 67
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
The OS-dependence is because of a limitation of Windows. If you
wish to force the use of clock instead of CPU time, you can set
@@ -4461,6 +4348,18 @@
subject to a minimum value give by the $min_sleep_time variable.
But a zero value is also allowed.
+
+
+
+ 31 January 2024 66
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
A value of exactly 0 gives no delay between checks for source-
file changes; it typically results in 100% CPU usage, which may
not be desirable.
@@ -4479,167 +4378,154 @@
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
+ then latexmk replaces @default_files with the filenames in $tex-
+ file_search to which is added "*.tex".
-
-
- 29 March 2024 68
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
- $texfile_search to which is added "*.tex".
-
$success_cmd [undefined]
See the documentation for $compiling_cmd.
$tmpdir [See below for default]
- Directory to store temporary files that latexmk may generate
+ 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, 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 pro-
+ a run of *latex, 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 pro-
gram.
Note that once a missing file has been made, no further calls to
- make will be made on a subsequent run of latexmk to update the
- file. Handling this problem is the job of a suitably defined
- Makefile. See the section "USING latexmk WITH make" for how to
- do this. The intent of calling make from latexmk is merely to
+ make will be made on a subsequent run of latexmk to update the
+ file. Handling this problem is the job of a suitably defined
+ Makefile. See the section "USING latexmk WITH make" for how to
+ do this. The intent of calling make from latexmk is merely to
detect dependencies.
$view ["default"]
- Which kind of file is to be previewed if a previewer is used.
- The possible values are "default", "dvi", "ps", "pdf". The
+ Which kind of file is to be previewed if a previewer is used.
+ The possible values are "default", "dvi", "ps", "pdf". The
value of "default" means that the "highest" of the kinds of file
- generated is to be used (among .dvi, .ps and .pdf).
- $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-
- 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
- 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-
- texmk to treat such warnings as errors, but only when they occur
- on the last run of *latex and only after processing is complete.
+ 31 January 2024 67
- 29 March 2024 69
+LATEXMK(1) General Commands Manual LATEXMK(1)
+ generated is to be used (among .dvi, .ps and .pdf).
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ $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-
+ able $warnings_as_errors controls whether this behavior is modi-
+ fied.
- A non-zero value $warnings_as_errors can be set by the command-
+ 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-
+ texmk to treat such warnings as errors, but only when they occur
+ on the last run of *latex and only after processing is complete.
+ 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
+ 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 *latex are generally
- needed to resolve references and citations, what matters is not
+ 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.)
$xdv_mode [0]
- If one, generate an xdv version of the document by use of xela-
+ If one, generate an xdv version of the document by use of xela-
tex.
$xdvipdfmx ["xdvipdfmx -E -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).
- $xdvipdfmx_silent_switch ["-q"]
- 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
- use of xelatex.
- 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.
+ 31 January 2024 68
- 29 March 2024 70
+LATEXMK(1) General Commands Manual LATEXMK(1)
+ $xdvipdfmx_silent_switch ["-q"]
+ 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
+ use of xelatex.
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ 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 $dvilualatex, $hilatex,
+ To do a coordinated setting of all of $dvilualatex, $hilatex,
$latex, $pdflatex, $lualatex, and $xelatex, see the section "Ad-
vanced 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
@@ -4646,10 +4532,10 @@
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.
@@ -4656,17 +4542,27 @@
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.
+
+ 31 January 2024 69
+
+
+
+
+
+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-
@@ -4678,20 +4574,8 @@
The arguments are as follows:
-
-
-
- 29 March 2024 71
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
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:
@@ -4698,27 +4582,27 @@
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.
@@ -4725,59 +4609,60 @@
How custom dependencies are used:
An instance of a custom dependency rule is created whenever latexmk de-
- tects that a run of *latex needs to read a file, like a graphics file,
- whose extension is the to-extension of a custom dependency. Then la-
- texmk examines whether a file exists with the same name, but with the
- corresponding from-extension, as specified in the custom-dependency.
- If it does, then a corresponding instance of the custom dependency is
- created, after which the rule is invoked whenever the destination file
- (the one with the to-extension) is out-of-date with respect to the cor-
- responding source file.
+ tects that a run of *latex needs to read a file, like a graphics file,
+ whose extension is the to-extension of a custom dependency. Then la-
+ texmk examines whether a file exists with the same name, but with 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,
- 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
- file fails to exist.
+ 31 January 2024 70
- 29 March 2024 72
+LATEXMK(1) General Commands Manual LATEXMK(1)
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ corresponding from-extension, as specified in the custom-dependency.
+ If it does, then a corresponding instance of the custom dependency is
+ created, after which the rule is invoked whenever the destination file
+ (the one with the to-extension) is out-of-date with respect to the cor-
+ responding source file.
+ To make the new destination file, the Perl subroutine specified in the
+ rule is invoked, with an argument that is the base name of the files in
+ question. Simple cases just involve a subroutine invoking an external
+ program; this can be done by following the templates below, even by
+ those without knowledge of the Perl programming language. Of course,
+ experts could do something much more elaborate.
- When latex reports that an input file (e.g., a graphics file) does not
+ 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
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' );
@@ -4785,45 +4670,45 @@
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.
- 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-
- 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,
- i.e., the invocation of system, which returns the value 0 on success.
- If you use pdflatex, lualatex or xelatex instead of latex, then you
+ 31 January 2024 71
- 29 March 2024 73
+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
+ 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-
+ 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,
+ i.e., the invocation of system, which returns the value 0 on success.
- will probably prefer to convert your graphics files to pdf format, in
- which case you would replace the above code in an initialization file
+ If you use pdflatex, lualatex or xelatex instead of latex, then you
+ will probably prefer to convert your graphics files to pdf format, in
+ which case you would replace the above code in an initialization file
by
add_cus_dep( 'fig', 'pdf, 0, 'fig2pdf' );
@@ -4831,63 +4716,64 @@
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
- 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
- line
- show_cus_dep();
+ 31 January 2024 72
- 29 March 2024 74
+LATEXMK(1) General Commands Manual LATEXMK(1)
+ Removing custom dependencies, and when you might need to do this:
+ If you have some general custom dependencies defined in the system or
+ user initialization file, you may find that for a particular project
+ they are undesirable. So you might want to delete the unneeded ones.
+ 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:
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ 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
+ line
+ show_cus_dep();
+
in an initialization file.
@@ -4894,29 +4780,29 @@
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 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. Latexmk does
+ The only index-file conversion built-in to latexmk is from an ".idx"
+ file written on one run of *latex 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. Latexmk does
not know how to deduce the extensions from the information it has. But
- you can easily write a custom dependency. For example if your latex
+ 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 extension .ndx to
- .nnd. The most elementary method is to define a custom dependency as
+ will need to get latexmk to convert files with the extension .ndx to
+ .nnd. The most elementary method is to define a custom dependency as
follows:
add_cus_dep( 'ndx', 'nnd', 0, 'ndx2nnd' );
@@ -4925,14 +4811,25 @@
}
push @generated_exts, 'ndx', 'nnd';
- Notice the added line compared with earlier examples. The extra line
+
+
+ 31 January 2024 73
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
+ Notice the added line compared with earlier examples. The extra line
gets the extensions "ndx" and "nnd" added to the list of extensions for
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' );
@@ -4942,18 +4839,6 @@
}
push @generated_exts, 'ndx', 'nnd', 'adx', 'and';
-
-
-
- 29 March 2024 75
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
You could also instead use
add_cus_dep( 'ndx', 'nnd', 0, 'dx2nd' );
@@ -4963,37 +4848,48 @@
}
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 and is always later than
+ .ndx file is written during a run of *latex 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 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
+ 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
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.
+ 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_calc_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.
+
+
+ 31 January 2024 74
+
+
+
+
+
+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";
@@ -5001,46 +4897,63 @@
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
+ this is what is used in the rc files.
+ See also the section DEALING WITH ERRORS, PROBLEMS, ETC. See also the
+ examples in the directory example_rcfiles in the latexmk distributions.
+ Even if none of the examples apply to your case, they may give you use-
+ ful ideas
- 29 March 2024 76
+ 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
+ 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 --
+ see the configuration variable $search_path_separator.
+ Example:
+ ensure_path( 'TEXINPUTS', './custom_cls_sty_files//' );
+ (In this example, the trailing '//' is documented by TeX systems
+ to mean that *latex search for files in the specified directory
+ and in all subdirectories.)
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ 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.
-ADVANCED CONFIGURATION: SOME EXTRA RESOURCES AND ADVANCED TRICKS
- For most purposes, simple configuration for latexmk along the lines of
- the examples given is sufficient. But sometimes you need something
- harder. In this section, I indicate some extra possibilities. Gener-
- ally to use these, you need to be fluent in the Perl language, since
- this is what is used in the rc files.
- In this section, I include first, a description of a number of vari-
- ables and subroutines that provide, among other things, access to la-
- texmk's internal data structures for handling dependencies. Then I de-
- scribe the hook mechanism whereby at certain points in the processing,
- latexmk can call user-defined subroutines.
- 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
+ 31 January 2024 75
+
+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
@@ -5061,139 +4974,25 @@
Note that the exact contents of this variable for a given rule
may be dependent on the version of latexmk
- $$Pbase
- This gives the basename for the rule. Generally, it determines
- the names of generated files. E.g., for a run of *latex, the
- name of the .log file is the aux directory concatenated with the
- basename and then `.log'.
-
- For a *latex rule, the basename is without a directory compo-
- nent. For other rules, it includes the directory component (if
- any is used).
-
- This (annoying) difference is associated with the different ways
- in which the commands invoked by latexmk work when the command
- line includes a name for a source file that includes a directory
-
-
-
- 29 March 2024 77
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
- component. For the *latex commands, the directory of the source
- file is irrelevant to the directory component the generated
- files, which instead is determined by the values in the -aux-di-
- rectory and/or -output-directory options.
-
- In contrast, many other programs (e.g., biber, bibtex) put their
- generated files in the same directory as the source file, merely
- with a changed extension.
-
- Note the double dollar signs: In Perl terms, the variable $Pbase
- is a reference to a variable that contains the basename. The
- second dollar sign derefences the reference to give the actual
- value. (A reference is is used rather like a pointer, and the
- `P' (for `pointer') at the start of the variable name is a con-
- vention used in latexmk to indicate that the variable is a ref-
- erence variable.)
-
-
- $$Pdest
- This gives the name of the main output file if any. Note the
- double dollar signs.
-
-
$$Psource
This gives the name of the primary source file. Note the double
dollar signs.
+ $$Pdest
+ This gives the name of the main output file if any. Note the
+ double dollar signs.
- add_hook( <stack_name>, <subroutine> )
- See the section `Hooks' for more details.
- This adds the subroutine specified in the second argument to la-
- texmk's stack of hooks specified by the stack name. It returns
- 1 on sucess, and zero otherwise (e.g., if the specified hook
- stack doesn't exist).
-
- The subroutine can be specified by a reference to the subrou-
- tine, as in
-
- add_hook( 'after_xlatex_analysis', mmz_analyze )
-
- Given that the subroutine mmz_analyze has been defined in the rc
- file.
-
- The subroutine can be specified by a string whose value is the
- name of the subroutine, e.g.,
-
- add_hook( 'after_xlatex_analysis', 'mmz_analyze' )
-
- In simple cases, the subroutine can be an anonymous subroutine
- defined in the call to add_hooks,
-
- add_hook( 'after_main_pdf', sub{ print
-
-
-
-
- 29 March 2024 78
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
- Observe that on success, the subroutine should return 0 (like a
- call to Perl's system subroutine), so normally this should be
- coded explicitly. If a hook subroutine returns a non-zero
- value, latexmk treats that as an error condition.
-
-
-
- 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
- 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 --
- see the configuration variable $search_path_separator.
-
- Example:
-
- ensure_path( 'TEXINPUTS', './custom_cls_sty_files//' );
-
- (In this example, the trailing '//' is documented by TeX systems
- to mean that *latex search for files in the specified 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
- invoked programs.
-
-
pushd( path ), popd()
- These subroutines are used when it is needed to temporarily
+ These subroutines are used when it is needed to temporarily
change the working directory, as in
pushd( 'some_directory' );
- ... Processing done with 'some_directory' as the working
+ ... Processing done with 'some_directory' as the working
directory
popd()
- They perform exactly the same function as the commands of the
+ They perform exactly the same function as the commands of the
same names in operating system command shells like bash on Unix,
and cmd.exe on the Windows.
@@ -5200,16 +4999,19 @@
rdb_add_generated( file, ... )
This subroutine is to be used in the context of a rule, that is,
- from within a subroutine that is carrying out processing of a
+ from within a subroutine that is carrying out processing of a
rule. Such is the case for the subroutine implementing a custom
- dependency, or the subroutine invoked by using the "internal"
- keyword in the command specification like that in the variable
+ dependency, or the subroutine invoked by using the "internal"
+ keyword in the command specification like that in the variable
$latex.
+ Its arguments are a sequence of filenames which are generated
+ during the running of the rule. The names might arise from an
+ analysis of the results of the run, e.g., in a log file, or from
- 29 March 2024 79
+ 31 January 2024 76
@@ -5218,79 +5020,70 @@
LATEXMK(1) General Commands Manual LATEXMK(1)
- Its arguments are a sequence of filenames which are generated
- during the running of the rule. The names might arise from an
- analysis of the results of the run, e.g., in a log file, or from
- knowledge of properties of the specific rule. Calling
- rdb_add_generated with these filenames ensures that these files
- are flagged as generated by the rule in latexmk's internal data
+ knowledge of properties of the specific rule. Calling
+ rdb_add_generated with these filenames ensures that these files
+ are flagged as generated by the rule in latexmk's internal data
structures. Basically, no action is taken if the files have al-
ready been flagged as generated.
- A main purpose of using this subroutine is for the situation
- when a generated file is also the source file for some rule, so
- that latexmk can correctly link the dependency information in
+ A main purpose of using this subroutine is for the situation
+ when a generated file is also the source file for some rule, so
+ that latexmk can correctly link the dependency information in
its network of rules.
Note: Unlike some other subroutines in this section, there is no
- argument for a rule for rdb_add_generated. Instead, the subrou-
- tine is to be invoked during the processing of a rule when la-
+ argument for a rule for rdb_add_generated. Instead, the subrou-
+ tine is to be invoked during the processing of a rule when la-
texmk has set up an appropriate context (i.e., appropriate vari-
- ables). In contrast, subroutines with a rule argument can be
+ ables). In contrast, subroutines with a rule argument can be
used also outside a rule context.
rdb_ensure_file( $rule, file )
- This subroutine ensures that the given file is among the source
+ This subroutine 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
+ 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
+ default methods don't find the dependency. Almost always the
+ first argument is the name of the rule currently being
processed, 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.
Note that rdb_ensure_file only has one filename argument, unlike
other subroutines in this section. If you want to apply its ac-
- tion to multiple files, you will need one call to rdb_en-
+ tion to multiple files, you will need one call to rdb_en-
sure_file for each file.
- rdb_ensure_files_here( file, ... )
- Like subroutine rdb_ensure_files, except that (a) it assumes the
- context is of a rule, and the files are to be added to the
- source list for that rule; (b) multiple files are allowed.
-
-
rdb_remove_files( $rule, file, ... )
This subroutine removes one or more files from the dependency
list for the given rule.
+ rdb_remove_generated( file, ... )
+ This subroutine is to be used in the context of a rule, that is,
+ from within a subroutine that is carrying out processing of a
+ rule. It performs the opposite action to rdb_add_generated.
+ Its effect is to ensure that the given filenames are not listed
+ in latexmk's internal data structures as being generated by the
+ rule.
- 29 March 2024 80
+ 31 January 2024 77
-LATEXMK(1) General Commands Manual LATEXMK(1)
- rdb_remove_generated( file, ... )
- This subroutine is to be used in the context of a rule, that is,
- from within a subroutine that is carrying out processing of a
- rule. It performs the opposite action to rdb_add_generated.
- Its effect is to ensure that the given filenames are not listed
- in latexmk's internal data structures as being generated by the
- rule.
+LATEXMK(1) General Commands Manual LATEXMK(1)
rdb_list_source( $rule )
@@ -5321,43 +5114,9 @@
silent mode.
- test_gen_file_time ( <file> )
- This subroutine is used in the context of a rule. It returns
- true or false according to whether or not a file of the given
- name both exists and was generated in the latest run of the
- rule. If the subroutine returns false, but the file exists,
- then the file is a leftover from a previous run.
-
- The test for a file being generated on the current run is
- whether the modification time of the file is at least as recent
- as the time that the run of the rule was started. An allowance
- for the granularity of the values of modification time on file
- systems is made. See the description of the variable $file-
- time_causality_threshold for details.
-
- In addition, latexmk makes allowance for the possiblity that
- files are hosted on a different computer than that running la-
- texmk and that the system clock times on the two computers are
-
-
-
- 29 March 2024 81
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
- mismatched. Latexmk automatically detects (and reports) any
- significant mismatch and corrects for it.
-
-
-
Coordinated Setting of Commands for *latex
To set all of $dvilualatex, $hilatex, $latex, $pdflatex, $lualatex, and
- $xelatex to a common pattern, you can use one of the following subrou-
+ $xelatex to a common pattern, you can use one of the following subrou-
tines, std_tex_cmds, alt_tex_cmds, and set_tex_cmds.
To get the standard commands, use
@@ -5365,28 +5124,39 @@
&std_tex_cmds;
This results in $latex = 'latex %O %S', and similarly for $dvilualatex,
- $hilatex, $pdflatex, $lualatex, and $xelatex. Note the ampersand in
- the invocation; this indicates to Perl that a subroutine is being
- called. (The use of this subroutine enables you to override previous
- redefinitions of the $latex, etc variables, which might have occurred
+ $hilatex, $pdflatex, $lualatex, and $xelatex. Note the ampersand in
+ the invocation; this indicates to Perl that a subroutine is being
+ called. (The use of this subroutine enables you to override previous
+ redefinitions of the $latex, etc variables, which might have occurred
in an earlier-read rc file.)
- To be able to use the string provided by the -pretex option (if any),
+ To be able to use the string provided by the -pretex option (if any),
you can use
&alt_tex_cmds;
- This results in $latex = 'latex %O %P', etc. Again note the ampersand
- in the invocation; this indicates to Perl that a subroutine is being
+ This results in $latex = 'latex %O %P', etc. Again note the ampersand
+ in the invocation; this indicates to Perl that a subroutine is being
called.
A more general way of specifying the variables is using
+
+
+ 31 January 2024 78
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
set_tex_cmds( 'CMD_SPEC' );
- Here CMD_SPEC is the command line without the program name. This re-
- sults in $latex = 'latex CMD_SPEC', and similarly for $pdflatex, etc.
- (An ampersand preceding the subroutine name is not necessary here,
+ Here CMD_SPEC is the command line without the program name. This re-
+ sults in $latex = 'latex CMD_SPEC', and similarly for $pdflatex, etc.
+ (An ampersand preceding the subroutine name is not necessary here,
since the parentheses show Perl that a subroutine is being invoked.)
An example that provides the --interaction=batchmode option to the *la-
@@ -5394,193 +5164,69 @@
set_tex_cmds( '--interaction=batchmode %O %S' );
- This results in $latex = 'latex --interaction=batchmode %O %S ', etc.
- Note that when '%O' appears after the added option, as here, options
+ This results in $latex = 'latex --interaction=batchmode %O %S ', etc.
+ Note that when '%O' appears after the added option, as here, options
provided on the command line to latexmk can override the supplied one.
A more general command line can be set up by using the placeholder '%C'
in CMD_SPEC. The '%C' is substituted by the basic name of the command,
i.e., whichever of 'latex', 'pdflatex', etc is appropriate. (More than
- one occurrence of '%C' is allowed.) For example to use the develop-
+ one occurrence of '%C' is allowed.) For example to use the develop-
ment/pre-release versions of latex, etc, which have names, 'latex-dev',
'pdflatex-dev', etc, you could use
-
-
- 29 March 2024 82
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
set_tex_cmds( '%C-dev %O %S' );
This results in $latex = 'latex-dev %O %S', etc. (The pre-release pro-
- grams latex-dev etc are provided in current distributions of TeXLive
+ grams latex-dev etc are provided in current distributions of TeXLive
and MiKTeX.)
- Hooks
- Latexmk provides a way to arrange for user-defined subroutines to be
- called at certain points in the processing. These can be used to con-
- figure appropriate behavior and actions beyond latexmk's normal behav-
- ior. For a good example of how they can be used to accommodate la-
- texmk's behavior to particular packages, see the file memoize_latexmkrc
- in the example_rcfiles subdirectory of the latexmk distribution. (In a
- standard TeXLive installation, that subdirectory is to be found in
- texmf-dist/doc/support/latexmk/)
+ Advanced configuration: Using latexmk with make
+ 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.
- The hook mechanism is complementary to the method of redefining command
- strings like $pdflatex etc. The two methods have overlapping domains
- of usefulness.
+ Now the basic task of latexmk is to run the appropriate programs to
+ make a viewable version of a LaTeX document. However, the usual make
+ program is not suited to this purpose for at least two reasons. First
+ is that the use of LaTeX involves circular dependencies (e.g., via .aux
+ files), and these cannot be handled by the standard make program. Sec-
+ ond is that in a large document the set of source files can change
+ quite frequently, particularly with included graphics files; in this
+ situation keeping a Makefile manually updated is inappropriate and er-
+ ror-prone, especially when the dependencies can be determined automati-
+ cally. Latexmk solves both of these problems robustly.
- Note that the hook mechanism is newly made public in v. 4.84 of la-
- texmk. It is subject to change and improvement as experience is
- gained.
+ 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.
- The hooks are arranged in named hook stacks, and a hook subroutine is
- added to a given stack by latexmk's add_hook subroutine (documented
- above). The currently available stacks are as follows, listed in the
- approximate order in which they are encountered in processing a docu-
- ment:
+ Nevertheless there are projects for which a Makefile is appropriate,
- before_xlatex
- The subroutines in this hook stack are called just before a
- *latex programs is run.
+ 31 January 2024 79
- after_xlatex
- The subroutines in this hook stack are called after a *latex pro-
- grams is
- run. Before the subroutines are called, latexmk has done some im-
- mediate
- postprocessing, e.g., to move the generated pdf file from the aux
- directory to the output directory when $emulate_aux is set to 1.
- after_xlatex_analysis
- The subroutines in this hook stack are called after latexmk has
- done its
- dependency analysis after a *latex programs is run. Subroutines in
- this
- stack provide a useful way of adding items to the dependency infor-
- mation
- associated with particular packages and that latexmk doesn't
-
- 29 March 2024 83
-
-
-
-
-
LATEXMK(1) General Commands Manual LATEXMK(1)
- automatically deal with.
-
-
- after_main_pdf
- The subroutines in this hook stack are called after one of the
- rules that
- creates the document's pdf file. (This covers any of pdflatex, lu-
- alatex,
- dvipdf, ps2pdf, xdvipdfmx.)
-
-
- cleanup
- The subroutines in this hook stack are called whenever latexmk is
- about
- to do a cleanup operation. They can be used, for example, to tai-
- lor the
- deleted files to the pecularities of particular packages when la-
- texmk's
- general mechanisms for specifying files to be deleted are too in-
- flexible.
-
- These subroutines are called before latexmk does any of its own
- file
- deletion; thus the hook subroutines have access to all the gener-
- ated
- files that give package-specific information.
-
-
- cleanup_extra_full
- The subroutines in this hook stack are called in addition to the
- ones in
- the cleanup stack, whenever a full cleanup operation is to be done
- (i.e.,
- one that includes the pdf, ps etc files). They are called immedi-
- ately
- after those in the cleanup stack, but still before latexmk does any
- of
- its own file deletion.
-
-
- (Any other stacks defined in latexmk.pl but not listed above are to be
- regarded as experimental and subject to change.)
-
- Each subroutine should return 0 on success and a non-zero value on
- failure. This matches the convention used for running programs, e.g.,
- by Perl's system subroutine, and the matching convention used for sub-
- routines for custom dependencies in latexmk.
-
- For most of the hook stacks, the subroutines are called in the context
- of a rule, with variables like $rule defined. However, some hook
- stacks, like the cleanup ones, are called from outside any rule; and
- latexmk adjusts the relevant variables to refer to the overall task
- (i.e., of processing a particular main .tex file).
-
-
-
-
- 29 March 2024 84
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
- Advanced configuration: Using latexmk with make
- This section is targeted only at advanced users who use the make pro-
- gram for complex projects, as for software development, with the depen-
- dencies specified by a Makefile.
-
- Now the basic task of latexmk is to run the appropriate programs to
- make a viewable version of a LaTeX document. However, the usual make
- program is not suited to this purpose for at least two reasons. First
- 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-
- 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
- equivalent of pattern rules in Makefiles.
-
- 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-
@@ -5592,45 +5238,33 @@
%.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
-
-
-
- 29 March 2024 85
-
-
-
-
-
-LATEXMK(1) General Commands Manual LATEXMK(1)
-
-
+ 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 la-
- texmk is always run. It is latexmk that decides whether any action is
- needed, e.g., a rerun of pdflatex. Effectively the Makefile delegates
- all decisions to latexmk, while make has no knowledge of the list of
+ 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 la-
+ texmk is always run. It is latexmk that decides whether any action is
+ needed, e.g., a rerun of pdflatex. Effectively the Makefile delegates
+ all decisions to latexmk, while make has no knowledge of the list of
source files except for primary LaTeX file for the document. If there
are, for example, graphics files to be made, these must be made by cus-
tom 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
@@ -5638,6 +5272,18 @@
LATEXMK = latexmk -recorder -use-make -deps \
-e 'warn qq(In Makefile, turn off custom dependencies\n);' \
-e '@cus_dep_list = ();' \
+
+
+
+ 31 January 2024 80
+
+
+
+
+
+LATEXMK(1) General Commands Manual LATEXMK(1)
+
+
-e 'show_cus_dep();'
all : $(TARGETS)
$(foreach file,$(TARGETS),$(eval -include $(DEPS_DIR)/$(file)P))
@@ -5649,64 +5295,64 @@
%.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
+ 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"
+ by calling "make graph.pdf", and after completion of its work, it lists
+ "fig.pdf" among the dependents of the file latexmk is making. Then let
+ "fig.fig" be updated, and then let make be run. Make first remakes
+ "fig.pdf", and only then reruns latexmk.
+ Thus we now have a method by which all the subsidiary processing is
+ delegated to make.
- 29 March 2024 86
+ Escaping of characters in dependency lists: There are certain special
+ characters that need to be escaped when names of files and directories
+ containing them appear in a dependency list used by a make program.
+ Generally, such special characters are best avoided.
+ By default, latexmk does no escaping of this kind, and the user will
+ have to arrange to deal with the issue separately, if the relevant spe-
+ cial characters are used. Note that the rules for escaping depend on
+ which make program is used, and on its version.
-LATEXMK(1) General Commands Manual LATEXMK(1)
+ 31 January 2024 81
- this. Instead the -use-make is used to delegate the making of missing
- files to make itself.
- Suppose in the LaTeX file there is a command \includegraphics{graph},
- and an xfig file "graph.fig" exists. On a first run, pdflatex reports
- a missing file, named "graph". Latexmk succeeds in making "graph.pdf"
- by calling "make graph.pdf", and after completion of its work, it lists
- "fig.pdf" among the dependents of the file latexmk is making. Then let
- "fig.fig" be updated, and then let make be run. Make first remakes
- "fig.pdf", and only then reruns latexmk.
- Thus we now have a method by which all the subsidiary processing is
- delegated to make.
- Escaping of characters in dependency lists: There are certain special
- characters that need to be escaped when names of files and directories
- containing them appear in a dependency list used by a make program.
- Generally, such special characters are best avoided.
+LATEXMK(1) General Commands Manual LATEXMK(1)
- By default, latexmk does no escaping of this kind, and the user will
- have to arrange to deal with the issue separately, if the relevant spe-
- cial characters are used. Note that the rules for escaping depend on
- which make program is used, and on its version.
- One special case is of spaces, since those are particularly prevalent,
- notably in standard choices of name for a user's home directory. So
- latexmk does provide an option to escape spaces. See the option
+ One special case is of spaces, since those are particularly prevalent,
+ notably in standard choices of name for a user's home directory. So
+ latexmk does provide an option to escape spaces. See the option
-deps_escape=... and the variable $deps_escape for details.
@@ -5713,11 +5359,11 @@
NON_ASCII CHARACTERS IN FILENAMES, RC FILES, ETC
Modern operating systems and file systems allow non-ASCII characters in
- the names of files and directories that encompass the full Unicode
+ the names of files and directories that encompass the full Unicode
range. Mostly, latexmk deals with these correctly. However, there are
- some situations in which there are problems, notably on Microsoft Win-
+ some situations in which there are problems, notably on Microsoft Win-
dows. Prior to version 4.77, latexmk had problems with non-ASCII file-
- names on Windows, even though there were no corresponding problems on
+ names on Windows, even though there were no corresponding problems on
macOS and Linux. These problems are corrected in the present version.
DETAILS TO BE FILLED IN
@@ -5730,47 +5376,47 @@
BUGS (SELECTED)
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-
+ trapdf instead.)
+THANKS TO
+ 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-
+ dard form to avoid being harvested too easily.)
+AUTHOR
+ Current version, by John Collins (Version 4.83). Report bugs etc to
+ his e-mail (jcc8 at psu.edu).
- 29 March 2024 87
+ Released version can be obtained from CTAN:
+ 31 January 2024 82
-LATEXMK(1) General Commands Manual LATEXMK(1)
- (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-
- 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-
- dard form to avoid being harvested too easily.)
+LATEXMK(1) General Commands Manual LATEXMK(1)
-AUTHOR
- Current version, by John Collins (Version 4.84). Report bugs etc to
- his e-mail (jcc8 at psu.edu).
- Released version can be obtained from CTAN:
- <http://www.ctan.org/pkg/latexmk/>, and from the author's website
+ <http://www.ctan.org/pkg/latexmk/>, and from the author's website
<https://www.cantab.net/users/johncollins/latexmk/>.
Modifications and enhancements by Evan McLean (Version 2.0)
Original script called "go" by David J. Musliner (RCS Version 3.2)
@@ -5803,6 +5449,30 @@
- 29 March 2024 88
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ 31 January 2024 83
+
+
Modified: trunk/Master/texmf-dist/scripts/latexmk/latexmk.pl
===================================================================
--- trunk/Master/texmf-dist/scripts/latexmk/latexmk.pl 2024-04-01 23:43:48 UTC (rev 70834)
+++ trunk/Master/texmf-dist/scripts/latexmk/latexmk.pl 2024-04-02 21:31:27 UTC (rev 70835)
@@ -2,8 +2,6 @@
use warnings;
use strict;
-
-
## Copyright John Collins 1998-2024
## (username jcc8 at node psu.edu)
## (and thanks to David Coppit (username david at node coppit.org)
@@ -49,8 +47,8 @@
# blocks.
$my_name = 'latexmk';
$My_name = 'Latexmk';
- $version_num = '4.84';
- $version_details = "$My_name, John Collins, 29 Mar. 2024. Version $version_num";
+ $version_num = '4.83';
+ $version_details = "$My_name, John Collins, 31 Jan. 2024. Version $version_num";
}
use Config;
@@ -367,8 +365,7 @@
#
# Single hash for various stacks of hooks:
our %hooks = ();
-for ( 'before_xlatex', 'after_xlatex', 'after_xlatex_analysis', 'after_main_pdf',
- 'cleanup', 'cleanup_extra_full' ) {
+for ( 'before_xlatex', 'after_xlatex', 'after_xlatex_analysis' ) {
$hooks{$_} = [];
}
$hooks{aux_hooks} = \@aux_hooks;
@@ -418,11 +415,7 @@
our $xelatex_silent_switch = '-interaction=batchmode';
# Whether to emulate -aux-directory, so we can use it on system(s) (TeXLive)
-# that don't support it.
-# Possible values: 0: I don't do any emulation, and use -aux-directory &
-# -out-directory options to *latex.
-# 1: Emulate MiKTeX behavior: Use -output-directory=<aux dir>
-# in call to *latex. Then move pdf (etc) files after run.
+# that don't support it:
our $emulate_aux = 1;
# Whether emulate_aux had to be switched on during a run:
our $emulate_aux_switched = 0;
@@ -749,7 +742,7 @@
# The following variables are assigned once and then used in symbolic
# references, so we need to avoid warnings 'name used only once':
-our ( $aux_dir_requested, $out_dir_requested, $out2_dir_requested );
+our ( $aux_dir_requested, $out_dir_requested );
our $dvi_update_signal = undef;
our $ps_update_signal = undef;
@@ -774,11 +767,6 @@
our $ps_update_method = 1;
our $pdf_update_method = 1;
-# Whether to allow latexmk to create subdirectories of aux_dir when there's
-# a report in the log file that *latex "can't write on file ...".
-# Values: 0: no subdir creation,
-# 1: only for aux files (occurs with \include{chapters/chap} etc
-# 2: generally
our $allow_subdir_creation = 1;
our $new_viewer_always = 0; # If 1, always open a new viewer in pvc mode.
@@ -1271,7 +1259,7 @@
# This variable is obsolete, and only in here for
# backward compatibility.
-our $jobname = ''; # Jobname: as with current tex, etc indicates
+our $jobname = ''; # Jobname: as with current tex, etc indicates
# basename of generated files. Defined so
# that --jobname=STRING on latexmk's command
# line has same effect as with current tex,
@@ -1284,7 +1272,6 @@
# dependent on name of main TeX file; this is
# useful when a jobname is used and latexmk is
# invoked on multiple files.
-our $out2_dir = ''; # Directory for final output files.
our $out_dir = ''; # Directory for output files.
# Cf. --output-directory of current *latex
# Blank means default, i.e., cwd.
@@ -1296,13 +1283,7 @@
# Corresponding forms that can be concatenated (e.g., when $aux_dir is '.', $aux_dir1 is './').
our $aux_dir1 = '';
our $out_dir1 = '';
-our $out2_dir1 = '';
-# Extensions for files to be copied to $out2_dir.
-# Specify as for @generated_exts: I.e., extension w/o period
-# or string including %R to be substituted by basename.
-our @out2_exts = ( 'hnt', 'pdf', 'ps', 'synctex', 'synctex.gz' );
-
## default flag settings.
our $recorder = 1; # Whether to use recorder option on latex/pdflatex
our $silent = 0; # Whether fo silence latex's messages (and others)
@@ -1660,7 +1641,6 @@
# %R for base of primary tex file, %T for
# texfile name, %O for options,
# %V=$aux_dir, %W=$out_dir,
- # %X for $out2_dir1
# %Y for $aux_dir1, and %Z for $out_dir1
# int_cmd specifies any internal command to be
# used to implement the application of the
@@ -1885,7 +1865,7 @@
$Plast_message, $Plast_result, $Plast_result_info,
$Pno_history, $Pout_of_date, $Pout_of_date_user, $Prun_time, $Psource,
$file, $PAfile_data, $Ptime, $Psize, $Pmd5, $DUMMY, $Pcorrect_after_primary
- );
+);
# User's home directory
our $HOME = '';
@@ -1990,6 +1970,8 @@
read_first_rc_file_in_list( ".latexmkrc", "latexmkrc" );
}
+
+
## Process command line args.
our @command_line_file_list = ();
our $bad_options = 0;
@@ -2126,9 +2108,6 @@
elsif ( /^-output-directory=(.*)$/ ||/^-outdir=(.*)$/ ) {
$out_dir = $1;
}
- elsif ( /^-out2dir=(.*)$/ ) {
- $out2_dir = $1;
- }
elsif ( /^-output-format=(.*)$/ ) {
my $format = $1;
if ($format eq 'dvi' ) {
@@ -2355,12 +2334,9 @@
# Default to cwd
$out_dir = '.';
}
-if ($out2_dir eq '' ){
- # Default to cwd
- $out2_dir = $out_dir;
-}
if ( $aux_dir eq '' ){
# Default to out_dir
+ # ?? This is different than MiKTeX
$aux_dir = $out_dir;
}
# Save original values for use in diagnositics.
@@ -2368,7 +2344,6 @@
# of results of misconfiguration.
$aux_dir_requested = $aux_dir;
$out_dir_requested = $out_dir;
-$out2_dir_requested = $out2_dir;
if ($bibtex_use > 1) {
push @generated_exts, 'bbl';
@@ -2767,18 +2742,10 @@
$dvi_name, $dviF_name, $hnt_name, $ps_name, $psF_name, $pdf_name,
$xdv_name,
$dvi_final, $hnt_final, $ps_final, $pdf_final, $xdv_final,
- $dvi_final2, $hnt_final2, $ps_final2, $pdf_final2,
$view_file,
%rule_list,
$missing_dvi_pdf, $switched_primary_output
- );
-# Defaults for when rule-using subroutines are used outside a rule:
-$rule = '';
-$Pbase = \$root_filename;
-$Psource = \$texfile_name;
-my $start_time = time();
-$Prun_time = \$start_time;
-
+);
FILE:
foreach $filename ( @file_list )
{
@@ -2809,7 +2776,6 @@
# Use of $do_cd, which can affect how $aux_dir and $out_dir get normalized.
local $aux_dir = $aux_dir;
local $out_dir = $out_dir;
- local $out2_dir = $out2_dir;
local $dvilualatex = $dvilualatex;
local $hilatex = $hilatex;
@@ -3283,19 +3249,15 @@
# Ensure the output/auxiliary directories exist, if need be, **with error checking**.
my $ret1 = 0;
my $ret2 = 0;
- my $ret3 = 0;
eval {
if ( $out_dir ) {
$ret1 = make_path_mod( $out_dir, 'output' );
}
- if ( $out_dir ) {
- $ret2 = make_path_mod( $out2_dir, 'final output' );
- }
if ( $aux_dir && ($aux_dir ne $out_dir) ) {
- $ret3 = make_path_mod( $aux_dir, 'auxiliary' );
+ $ret2 = make_path_mod( $aux_dir, 'auxiliary' );
}
};
- if ($ret1 || $ret2 || $ret3 || $@ ) {
+ if ($ret1 || $ret2 || $@ ) {
if ($@) { print "Error message:\n $@"; }
die "$My_name: Since there was trouble making the output (and aux) dirs, I'll stop\n"
}
@@ -3305,8 +3267,7 @@
}
$aux_dir1 = $aux_dir;
$out_dir1 = $out_dir;
- $out2_dir1 = $out2_dir;
- foreach ( $aux_dir1, $out_dir1, $out2_dir1 ) {
+ foreach ( $aux_dir1, $out_dir1 ) {
if ($_ eq '.') {$_ = '';}
if ( ($_ ne '') && ! m([\\/\:]$) ) {
# Add a trailing '/' if necessary to give a string that can be
@@ -3356,9 +3317,8 @@
if ($diagnostics || $aux_out_dir_report ) {
print "$My_name: Cwd: '", good_cwd(), "'\n";
- print "$My_name: Normalized aux dir and out dirs:\n",
- " '$aux_dir', '$out_dir', '$out2_dir'\n";
- print "$My_name: and combining forms: '$aux_dir1', '$out_dir1', '$out2_dir1'\n";
+ print "$My_name: Normalized aux dir and out dir: '$aux_dir', '$out_dir'\n";
+ print "$My_name: and combining forms: '$aux_dir1', '$out_dir1'\n";
if ($aux_out_dir_report == 2) {
exit 0;
}
@@ -3489,7 +3449,6 @@
# until run time, in case of changes.
foreach ($base, $source, $dest, @$PA_extra_gen, @$PA_extra_source ) {
s/%R/$root_filename/g;
- s/%X/$out2_dir1/;
s/%Y/$aux_dir1/;
s/%Z/$out_dir1/;
}
@@ -3545,7 +3504,6 @@
# Set up specifications for standard rules, adjusted to current conditions
# Substitutions: %S = source, %D = dest, %B = this rule's base
# %T = texfile, %R = root = base for latex.
-# %X for $out2_dir1,
# %Y for $aux_dir1, %Z for $out_dir1
@@ -3552,15 +3510,15 @@
my $print_file = '';
my $print_cmd = 'NONE';
if ( $print_type eq 'dvi' ) {
- $print_file = $dvi_final2;
+ $print_file = $dvi_final;
$print_cmd = $lpr_dvi;
}
elsif ( $print_type eq 'pdf' ) {
- $print_file = $pdf_final2;
+ $print_file = $pdf_final;
$print_cmd = $lpr_pdf;
}
elsif ( $print_type eq 'ps' ) {
- $print_file = $ps_final2;
+ $print_file = $ps_final;
$print_cmd = $lpr;
}
elsif ( $print_type eq 'none' ) {
@@ -3575,7 +3533,7 @@
if ( ($view eq 'dvi') || ($view eq 'hnt') || ($view eq 'pdf') || ($view eq 'ps') ) {
no strict "refs";
- $view_file = ${$view.'_final2'};
+ $view_file = ${$view.'_final'};
$viewer = ${$view.'_previewer'};
$viewer_update_method = ${$view.'_update_method'};
$viewer_update_signal = ${$view.'_update_signal'};
@@ -3586,8 +3544,6 @@
# Specification of internal command for viewer update:
my $PA_update = ['do_update_view', $viewer_update_method, $viewer_update_signal, 0, 1];
- # Base name is to be without path for *latex-type rules
- # With path for others.
%rule_list = (
'dvilualatex' => [ 'primary', "$dvilualatex", '', "%T", $dvi_name, "%R", 1, [$aux_main, $log_name], [$aux_main] ],
'hilatex' => [ 'primary', "$hilatex", '', "%T", $hnt_name, "%R", 1, [$aux_main, $log_name], [$aux_main] ],
@@ -3595,7 +3551,6 @@
'lualatex' => [ 'primary', "$lualatex", '', "%T", $pdf_name, "%R", 1, [$aux_main, $log_name], [$aux_main] ],
'pdflatex' => [ 'primary', "$pdflatex", '', "%T", $pdf_name, "%R", 1, [$aux_main, $log_name], [$aux_main] ],
'xelatex' => [ 'primary', "$xelatex", '', "%T", $xdv_name, "%R", 1, [$aux_main, $log_name], [$aux_main] ],
-
'dvipdf' => [ 'external', "$dvipdf", 'do_viewfile', $dvi_final, $pdf_name, "%Z%R", 1 ],
'xdvipdfmx' => [ 'external', "$xdvipdfmx", 'do_viewfile', $xdv_final, $pdf_name, "%Z%R", 1 ],
'dvips' => [ 'external', "$dvips", 'do_viewfile', $dvi_final, $ps_name, "%Z%R", 1 ],
@@ -3602,7 +3557,6 @@
'dvifilter' => [ 'external', $dvi_filter, 'do_viewfile', $dvi_name, $dviF_name, "%Z%R", 1 ],
'ps2pdf' => [ 'external', "$ps2pdf", 'do_viewfile', $ps_final, $pdf_name, "%Z%R", 1 ],
'psfilter' => [ 'external', $ps_filter, 'do_viewfile', $ps_name, $psF_name, "%Z%R", 1 ],
-
'print' => [ 'external', "$print_cmd", 'if_source', $print_file, "", "", 1 ],
'update_view' => [ 'external', $viewer_update_command, $PA_update,
$view_file, "", "", 2 ],
@@ -3809,12 +3763,7 @@
# 2. Write a corresponding fdb file
# 3. Provoke a run of *latex (actually of all primaries).
- # Use raw mode for writing aux file, so that line endings are \n.
- # Otherwise on Windows, the aux file file will have \r\n line endings.
- # Since both TeXLive and MiKTeX write \n rather than \r\n, latexmk will
- # unnecessarily detect a change in the aux file because of the changed
- # line endings, and thereby provoke a superfluous extra *latex run.
- open( my $aux_file, '> :raw', $aux_main )
+ open( my $aux_file, '>', $aux_main )
or die "Cannot write file '$aux_main'\n";
fprint8( $aux_file, "\\relax \n" );
# The following is added by recent versions of latex for a
@@ -3839,9 +3788,8 @@
my $kind = $_[0];
if (! $kind ) { return; }
my @files_to_delete = ();
- my %dirs = ();
- foreach ($aux_dir1, $out_dir1, $out2_dir1) { $dirs{$_} = 1; }
- my @dirs = keys %dirs;
+ my @dirs = ($aux_dir1);
+ if ($out_dir1 ne $aux_dir1) { push @dirs, $out_dir1; }
push @files_to_delete, &get_small_cleanup;
if ($kind == 1) {
@@ -3849,25 +3797,19 @@
push @files_to_delete, cleanup_get1( $dir1, @final_output_exts );
}
}
+ # show_array( "Files to delete", sort @files_to_delete );
- # Run the hooks first, since to determine what custom deletions they
- # are to make, the hook subroutines may need access to files that
- # cleanup later deletes (log, aux, ...).
- run_hooks( 'cleanup' );
- if ($kind == 1) { run_hooks( 'cleanup_extra_full' ); }
-
- # Names of contents of directory are longer than the name of the
- # directory, but contain the directory name as an initial segment.
- # Therefore deleting files and directories in the order given by
- # reverse sort deletes contents of directory before attempting to
- # delete the directory:
+ # Names of contents of directory are longer than the name of the directory,
+ # but contain the directory name as an initial segment.
+ # Therefore deleting files and directories in the order given by reverse
+ # sort deletes contents of directory before attempting to delete the
+ # directory:
unlink_or_move( reverse sort @files_to_delete );
- # If the fdb file (or log, fls and/or aux files) exist, it/they will
- # have been used to make a changed rule database. But a cleanup
- # implies that we need a virgin rule database, corresponding to
- # current state of files (after cleanup) so we reset the rule
- # database and rule net:
+ # If the fdb file (or log, fls and/or aux files) exist, it/they will have
+ # been used to make a changed rule database. But a cleanup implies
+ # that we need a virgin rule database, corresponding to current state
+ # of files (after cleanup) so we reset the rule database and rule net:
&rdb_initialize_rules;
}
@@ -4818,8 +4760,6 @@
" -norc - omit automatic reading of system, user and project rc files\n",
" -output-directory=dir or -outdir=dir\n",
" - set name of directory for output files\n",
- " -out2dir=dir\n",
- " - set name of directory for final output files\n",
" -output-format=FORMAT\n",
" - if FORMAT is dvi, turn on dvi output, turn off others\n",
" - if FORMAT is pdf, turn on pdf output, turn off others\n",
@@ -5483,10 +5423,6 @@
$ps_name = "%Z%R.ps";
$psF_name = "%Z%R.psF";
$pdf_name = "%Z%R.pdf";
- $dvi_final2 = "%X%R.pdf";
- $hnt_final2 = "%X%R.pdf";
- $pdf_final2 = "%X%R.pdf";
- $ps_final2 = "%X%R.pdf";
## It would be logical for a .xdv file to be put in the out_dir,
## just like a .dvi file. But the only program, MiKTeX, that
## currently implements aux_dir, and hence allows aux_dir ne out_dir,
@@ -5494,12 +5430,8 @@
$xdv_name = "%Y%R.xdv";
foreach ( $aux_main, $log_name, $fdb_name, $fls_name, $fls_name_alt,
- $dvi_name, $hnt_name, $ps_name, $pdf_name, $xdv_name,
- $dviF_name, $psF_name,
- $dvi_final2, $hnt_final2, $pdf_final2, $ps_final2,
- ) {
+ $dvi_name, $hnt_name, $ps_name, $pdf_name, $xdv_name, $dviF_name, $psF_name ) {
s/%R/$root_filename/g;
- s/%X/$out2_dir1/;
s/%Y/$aux_dir1/;
s/%Z/$out_dir1/;
}
@@ -5520,53 +5452,6 @@
#**************************************************
-sub do_moves_aux_to_out {
- # do_moves_aux_to_out( source, dest )
- # Moves appropriate output files from source dir (e.g., $aux_dir1) to
- # dest dir (e.g., $out_dir1).
- # Veto move of file if it wasn't generated on current compilation.
- # Special treatment of .fls file
- # Assume rule context, which may be global context.
- # Directory names should end in /, so that concatenation OK.
- my ($source1, $dest1) = @_;
- foreach my $ext ( 'fls', 'dvi', 'hnt', 'pdf', 'ps', 'synctex', 'synctex.gz' ) {
- if ( ($ext eq 'fls') && ! $fls_uses_out_dir ) {next;}
- my $from = "$source1$$Pbase.$ext";
- my $to = "$dest1$$Pbase.$ext" ;
- if ( test_gen_file_time( $from ) ) {
- if (! $silent) { print "$My_name: Moving '$from' to '$to'\n"; }
- my $ret = move( $from, $to );
- if ( ! $ret ) { die " That failed, with message '$!'\n";}
- }
- }
-}
-
-#*************************************************************************
-
-sub do_copies_out_to_out2 {
- # do_copies_out_to_out2( source, dest )
- # Copies final output files from source dir (e.g., $out_dir1) to
- # dest dir (e.g., $out2_dir1).
- # Note copy, not move, otherwise rules complain about non-existent
- # destination pdf file (etc).
- # Assume rule context, which is normally global context.
- # Directory names should end in /, so that concatenation OK.
- my ($source1, $dest1) = @_;
- foreach ( @out2_exts ) {
- my $name = ( /%R/ ? $_ : "%R.$_" );
- $name =~ s/%R/$$Pbase/;
- my $from = "$source1$name";
- my $to = "$dest1$name" ;
- if ( test_gen_file_time( $from ) ) {
- if (! $silent) { print "$My_name: Copying '$from' to '$to'\n"; }
- my $ret = copy( $from, $to );
- if ( ! $ret ) { die " That failed, with message '$!'\n";}
- }
- }
-}
-
-#*************************************************************************
-
sub correct_locations {
# Deal with situations after a *latex run where files are in different
# directories than expected (specifically aux v. output directory).
@@ -5582,15 +5467,26 @@
# Assumes rule context.
my $where_log = &find_set_log;
-
if ( $emulate_aux && ($aux_dir ne $out_dir) ) {
- do_moves_aux_to_out( $aux_dir1, $out_dir1 );
+ # Move output files from aux_dir to out_dir
+ # Move fls file also, if the configuration is for fls in out_dir.
+ # Omit 'xdv', that goes to aux_dir (as with MiKTeX). It's not final output.
+ foreach my $ext ( 'fls', 'dvi', 'hnt', 'pdf', 'ps', 'synctex', 'synctex.gz' ) {
+ if ( ($ext eq 'fls') && ! $fls_uses_out_dir ) {next;}
+ my $from = "$aux_dir1$$Pbase.$ext";
+ my $to = "$out_dir1$$Pbase.$ext" ;
+ if ( test_gen_file_time( $from ) ) {
+ if (! $silent) { print "$My_name: Moving '$from' to '$to'\n"; }
+ my $ret = move( $from, $to );
+ if ( ! $ret ) { die " That failed, with message '$!'\n";}
+ }
+ }
}
# Fix ups on fls file:
if ($recorder) {
# Deal with following special cases:
- # 1. Some implementations of *latex give fls files of name latex.fls
+ # 1. Some implemenations of *latex give fls files of name latex.fls
# or pdflatex.fls instead of $$Pbase.fls.
# 2. In some implementations, the writing of the fls file (memory
# of old implementations) may not respect the -output-directory
@@ -6122,9 +6018,8 @@
$idx_file = $1;
}
else {
- warn "$My_name: A message suggests an index file may have been written\n",
- " but it is not of a form I understand. This is probably innocuous.\n",
- " The message is\n",
+ warn "$My_name: Message indicates index file was written\n",
+ " ==> but I do not know how to understand it: <==\n",
" '$_'\n";
next LINE;
}
@@ -6222,9 +6117,7 @@
my $dir = $1;
my $file = $2;
my $full_dir = $aux_dir1.$dir;
- if ( ($aux_dir ne '') && (! -e $full_dir)
- && ( ($file =~ /\.aux$/) || ($allow_subdir_creation == 2) )
- ) {
+ if ( ($aux_dir ne '') && (! -e $full_dir) && ( $file =~ /\.aux$/) ) {
warn "$My_name: === There were problems writing to '$file' in '$full_dir'\n",
" I'll try to make the subdirectory later.\n"
if $diagnostics;
@@ -6233,9 +6126,9 @@
else {
warn "$My_name: ====== There were problems writing to",
"----- '$file' in '$full_dir'.\n",
- "----- But this is not the standard situation of file to subdir of output\n",
- "----- directory, with non-existent subdir, and either file is aux file or\n",
- "----- or \$allow_subdir_creation is set to 2.\n";
+ "----- But this is not the standard situation of\n",
+ "----- aux file to subdir of output directory, with\n",
+ "----- non-existent subdir\n",
}
}
@@ -7738,7 +7631,6 @@
}
close $in_handle;
# Get state of dependencies, including creating cus deps if needed
- # !!!??? This doesn't match definition of rdb_set_dependents
&rdb_set_dependents( keys %rule_db );
&rdb_set_rule_net;
@@ -8196,12 +8088,6 @@
}
}
- foreach my $file ( keys %generated_fls ) {
- if ( $file =~ /^(.*)\.idx$/ ) {
- $idx_files{$file} = [ "$1.ind", $1 ];
- print "Have index file '$file', @{$idx_files{$file}}\n";
- }
- }
IDX_FILE:
foreach my $idx_file ( keys %idx_files ) {
my ($ind_file, $ind_base) = @{$idx_files{$idx_file}};
@@ -8424,7 +8310,7 @@
my @more_sources = &rdb_set_dependents( $rule );
my $num_new = $#more_sources + 1;
- foreach (@more_sources) {
+ foreach (@more_sources) {
$dependents{$_} = 4;
if ( ! -e $_ ) {
# Failure was non-existence of makable file
@@ -8686,8 +8572,7 @@
}
if ( exists $ENV{TEXINPUTS} ) {
foreach my $searchpath (split $search_path_separator, $ENV{TEXINPUTS}) {
- my $file = catfileA($searchpath,$_[0]);
- if ( $file =~ /\\/ ) { print "====== '$file'\n"; die; }
+ my $file = catfile($searchpath,$_[0]);
my $test = "$file.$_[1]";
if ( -e $test ) {
return $file;
@@ -8704,7 +8589,7 @@
# Assume file (and rule) context for DESTINATION file.
# Only look for dependency if $rule is primary rule (i.e., latex
- # or pdflatex) or is a custom dependency: ???WHY???!!!
+ # or pdflatex) or is a custom dependency:
if ( (! exists $possible_primaries{$rule}) && ($rule !~ /^cusdep/) ) {
return;
}
@@ -8775,7 +8660,7 @@
&& (! -e $file )
&& (! -e "$base_name.$proptoext" )
&& exists $$Pinput_extensions{$proptoext}
- ) {
+ ) {
# Empty extension and non-existent destination
# This normally results from \includegraphics{A}
# without graphics extension for file, when file does
@@ -9353,11 +9238,6 @@
}
rdb_for_some( [@unusual_one_time], \&rdb_make1 );
- if ( $out_dir ne $out2_dir ) {
- print "================='$out_dir', '$out2_dir' '$out_dir1', '$out2_dir1'\n";
- do_copies_out_to_out2( $out_dir1, $out2_dir1 );
- }
-
#---------------------------------------
# All of make done. Finish book-keeping:
@@ -9752,13 +9632,7 @@
else {
# No special analysis for other rules
}
- if ($$Pdest eq $pdf_final) {
- if ( run_hooks( 'after_main_pdf' ) ) {
- warn "$My_name: ======Some hook failed.\n";
- $return = -1;
- }
- }
-
+
# General
$updated = 1;
if ( ($$Plast_result == 0) && ($return != 0) && ($return != -2) ) {
@@ -10698,7 +10572,6 @@
foreach ( $PAextra_gen, $PAextra_source ) {
if (! defined $_) { $_ = []; }
}
-
my $last_result = -1;
my $last_result_info = '';
my $no_history = ($run_time <= 0);
@@ -11632,7 +11505,6 @@
warn "In add_hook, request to add hook to non-existent stack '$stack'.\n";
return 0;
}
- print "============== ADDING HOOK to $stack\n";
my $ref;
if ( ref $routine ) {
@@ -11658,36 +11530,23 @@
# a. If arguments follow the stackname in the call to run_hooks, these
# are given to the called subroutines.
# b. Otherwise a hash of information is given to the called subroutines.
- # Each has a return value, which like from system, is 0 for success.
- # Return 0 for success, non-zero for failure.
+ # Return 1 for success, 0 for failure.
my $name = shift;
my $Pstack = $hooks{$name};
my @args = @_;
if (!@args) { @args = &info_make; }
else { print "Have args\n"; }
-
- if ( ! defined $Pstack ) {
- warn "run_hooks: No stack named '$name'\n";
- # But I'll not treat this as an error. Is that appropriate?
- return 0;
- }
- elsif (! @$Pstack) {
- # Nothing to do
- return 0;
- }
- else {
- print "$My_name: Running hooks in stack $name\n";
- my $fail = 0;
+ if (defined $Pstack) {
# Do NOT use default $_, as in "for (...) {...}":
# The called subroutine may change $_, which is a global variable
# (although localized to the for loop and called subroutines).
- for my $Psub ( @$Pstack) {
- if ( &$Psub(@args) ) {
- $fail = 1;
- }
- }
- return $fail;
+ for my $Psub ( @$Pstack) { &$Psub(@args); }
+ return 1;
}
+ else {
+ warn "run_hooks: No stack named '$name'\n";
+ return 0;
+ }
}
#-------------------------------------
@@ -11864,15 +11723,6 @@
#************************************************************
-sub catfileA {
- # Like catfile, but change \ to / in result.
- my $file = catfile(@_);
- $file =~ s[\\][/]g;
- return $file;
-}
-
-#************************************************************
-
sub fileparseA {
# Like fileparse but replace $path for current dir ('./' or '.\') by ''
# Also default second argument to get normal extension.
@@ -12450,7 +12300,7 @@
# -outdir=... option, are already in the system CS, because that is
# how strings are passed on the command line.
# So we just need to do a conversion for strings with utf8 flag on:
- foreach ( $out_dir, $out2_dir, $aux_dir, @default_files, @default_excluded_files ) {
+ foreach ( $out_dir, $aux_dir, @default_files, @default_excluded_files ) {
if (utf8::is_utf8($_)) { $_ = encode( $CS_system, $_ ); }
}
} #END config_to_mine
More information about the tex-live-commits
mailing list.