diff options
| -rwxr-xr-x | Build/source/texk/texlive/linked_scripts/latexmk/latexmk.pl | 209 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/CHANGES | 11 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/README | 13 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/latexmk.1 | 1609 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/latexmk.pdf | bin | 75222 -> 78203 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/latexmk.txt | 1316 | ||||
| -rwxr-xr-x | Master/texmf-dist/scripts/latexmk/latexmk.pl | 209 | ||||
| -rw-r--r-- | Master/texmf/doc/man/man1/latexmk.1 | 79 | ||||
| -rw-r--r-- | Master/texmf/doc/man/man1/latexmk.man1.pdf | bin | 84361 -> 88218 bytes |
9 files changed, 1045 insertions, 2401 deletions
diff --git a/Build/source/texk/texlive/linked_scripts/latexmk/latexmk.pl b/Build/source/texk/texlive/linked_scripts/latexmk/latexmk.pl index 0588b2efe9c..2ea0e023e8f 100755 --- a/Build/source/texk/texlive/linked_scripts/latexmk/latexmk.pl +++ b/Build/source/texk/texlive/linked_scripts/latexmk/latexmk.pl @@ -95,6 +95,7 @@ use warnings; # 2. Convert errors to failure only in calling routine # 3. Save first warning/error. +# ?? Use of generated_exts arrays and hashes needs rationalization # To do: # Rationalize again handling of include files. @@ -107,8 +108,8 @@ use warnings; $my_name = 'latexmk'; $My_name = 'Latexmk'; -$version_num = '4.11'; -$version_details = "$My_name, John Collins, 27 November 2009"; +$version_num = '4.13'; +$version_details = "$My_name, John Collins, 13 January 2010"; use Config; @@ -141,7 +142,7 @@ else { warn "Something wrong with the perl configuration: No signals?\n"; } -## Copyright John Collins 1998-2009 +## Copyright John Collins 1998-2010 ## (username collins at node phys.psu.edu) ## (and thanks to David Coppit (username david at node coppit.org) ## for suggestions) @@ -175,8 +176,17 @@ else { ## 5. Parsing of log file instead of source file is used to ## obtain dependencies, by default. ## -## Modification log from 21 Aug 2009 onwards in detail +## Modification log from 25 Nov 2009 onwards in detail ## +## 13 Jan 2010, John Collins V. 4.13 +## 27 Dec 2009, John Collins Correct position of inserting bbl into list +## of generated extensions. +## Correct clean_up. It stopped deleting aux +## file. +## $bibtex_use defaults to 1. +## 15 Dec 2009, John Collins Option not to do bibtex +## (to allow for case that bbl files +## are available, but no bibtex). ## 27 Nov 2009, John Collins Solve problem that changes in \include ## files weren't reflected in changes ## in bibtex source files. @@ -205,20 +215,6 @@ else { ## that uses the file. ## Avoided excess md5 calculations at ## startup. -## 24 Nov 2009, John Collins Start 4.11 -## 22 Sep 2009, John Collins Bibtex error => message see blg file. -## 10 Sep 2009, John Collins When tmp view file is moved to view file, -## delete original file first. Avoids -## bug in kpdf -## 4 Sep 2009, John Collins A missing file message is now suppressed -## when -silent option used -## kpsewhich is used to find non-existent -## converted files (as with epstopdf) -## 1 Sep 2009, John Collins Change "last FILE" to "next FILE" -## on failure in main loop. -## I had earlier changed this from "next FILE" to -## "last FILE" (for v. 4.08), but I don't see why. -## 21 Aug 2009, John Collins V. 4.10 for CTAN release. ## ## 1998-2009, John Collins. Many improvements and fixes. ## See CHANGE-log.txt for full list, and CHANGES for summary @@ -384,6 +380,14 @@ add_input_ext( 'pdflatex', 'tex', 'jpg', 'pdf' ); $bibtex = 'bibtex %O %B'; # Switch(es) to make bibtex silent: $bibtex_silent_switch = '-terse'; +$bibtex_use = 1; # Whether to actually run bibtex to update bbl files + # 0: Never run bibtex + # 1: Run bibtex only if the bibfiles exists + # according to kpsewhich, and the bbl files + # appear to be out-of-date + # 2: Run bibtex when the bbl files are out-of-date + # In any event bibtex is only run if the log file + # indicates that the document uses bbl files. ## Command to invoke makeindex $makeindex = 'makeindex %O -o %D %S'; @@ -838,7 +842,8 @@ $landscape_mode = 0; # default to portrait mode # the run (which might correct the error) should provoke a # rerun, but a change in a generated file should not. # These arrays can be user-configured. -@generated_exts = ( 'aux', 'bbl', 'idx', 'ind', 'lof', 'lot', 'out', 'toc' ); + +@generated_exts = ( 'aux', 'idx', 'ind', 'lof', 'lot', 'out', 'toc' ); # N.B. 'out' is generated by hyperref package # Which kinds of file do I have requests to make? @@ -1189,6 +1194,10 @@ read_first_rc_file_in_list( "latexmkrc", ".latexmkrc" ); #================================================== +if ($bibtex_use > 1) { + push @generated_exts, 'bbl'; +} + #show_array ("BIBINPUTS", @BIBINPUTS); die; ## Process command line args. @@ -1202,7 +1211,11 @@ while ($_ = $ARGV[0]) # Make -- and - equivalent at beginning of option: s/^--/-/; shift; - if (/^-c$/) { $cleanup_mode = 2; $cleanup_fdb = 1; $cleanup_only = 1; } + if (/^-bibtex$/) { $bibtex_use = 2; } + elsif (/^-bibtex-$/) { $bibtex_use = 0; } + elsif (/^-nobibtex$/) { $bibtex_use = 0; } + elsif (/^-bibtex-cond$/) { $bibtex_use = 1; } + elsif (/^-c$/) { $cleanup_mode = 2; $cleanup_fdb = 1; $cleanup_only = 1; } elsif (/^-C$/ || /^-CA$/ ) { $cleanup_mode = 1; $cleanup_fdb = 1; $cleanup_only = 1; } elsif (/^-CF$/) { $cleanup_fdb = 1; } elsif (/^-cd$/) { $do_cd = 1; } @@ -1228,13 +1241,13 @@ while ($_ = $ARGV[0]) $jobname = $1; } elsif (/^-l$/) { $landscape_mode = 1; } + elsif (/^-l-$/) { $landscape_mode = 0; } elsif (/^-new-viewer$/) { $new_viewer_always = 1; } elsif (/^-new-viewer-$/) { $new_viewer_always = 0; } - elsif (/^-l-$/) { $landscape_mode = 0; } elsif (/^-p$/) { $printout_mode = 1; $preview_continuous_mode = 0; # to avoid conflicts $preview_mode = 0; @@ -1635,26 +1648,38 @@ foreach $filename ( @file_list ) if ( ($go_mode == 2) && !$silent ) { warn "$My_name: Removing all generated files\n" unless $silent; } - foreach (@index_bibtex_generated, @aux_files) { + if ($bibtex_use < 2) { + delete $generated_exts_all{'bbl'}; + } + my %index_bibtex_generated = (); + my %aux_files = (); + foreach (@index_bibtex_generated) { + $index_bibtex_generated{$_} = 1 + unless ( /\.bbl$/ && ($bibtex_use < 2) ); + delete( $other_generated{$_} ); + } + foreach (@aux_files) { + $aux_files{$_} = 1; delete( $other_generated{$_} ); } if ($diagnostics) { show_array( "For deletion:\n" ." Generated (from makeindex and bibtex):", - @index_bibtex_generated ); - show_array( " Aux files:", @aux_files ); + keys %index_bibtex_generated ); + show_array( " Aux files:", keys %aux_files ); show_array( "Other generated files:\n" ." (only deleted if \$cleanup_includes_generated is set): ", keys %other_generated ); } - # Add to the generated files, some log file and some backup # files used in previous versions of latexmk &cleanup1( $fdb_ext, 'blg', 'ilg', 'log', 'aux.bak', 'idx.bak', split(' ',$clean_ext), - @generated_exts + keys %generated_exts_all ); - unlink( 'texput.log', @index_bibtex_generated, "texput.aux", @aux_files ); + unlink( 'texput.log', "texput.aux", + keys %index_bibtex_generated, + keys %aux_files ); if ($cleanup_includes_generated) { unlink( keys %other_generated ); } @@ -2587,6 +2612,9 @@ sub print_help "$My_name $version_num: Automatic LaTeX document generation routine\n\n", "Usage: $my_name [latexmk_options] [filename ...]\n\n", " Latexmk_options:\n", + " -bibtex - use bibtex when needed (default)\n", + " -bibtex- - never use bibtex\n", + " -bibtex-cond - use bibtex when needed, but only if the bib files exist\n", " -bm <message> - Print message across the page when converting to postscript\n", " -bi <intensity> - Set contrast or intensity of banner\n", " -bs <scale> - Set scale for banner\n", @@ -2624,8 +2652,9 @@ sub print_help " implementations of latex/pdflatex.)\n", " -l - force landscape mode\n", " -l- - turn off -l\n", - " -new-viewer - in -pvc mode, always start a new viewer\n", - " -new-viewer- - in -pvc mode, start a new viewer only if needed\n", + " -new-viewer - in -pvc mode, always start a new viewer\n", + " -new-viewer- - in -pvc mode, start a new viewer only if needed\n", + " -nobibtex - never use bibtex\n", " -nodependents - Do not show list of dependent files after processing\n", " -pdf - generate pdf by pdflatex\n", " -pdfdvi - generate pdf by dvipdf\n", @@ -4097,8 +4126,6 @@ MISSING_FILE: } } -## ?? Is this correct? I used to use @includes -# rdb_update_files_for_rule( keys %PHsources ); if ( $diagnostics && ( $found > 0 ) ) { warn "$My_name: Detected previously missing files:\n"; foreach ( sort keys %new_includes ) { @@ -4110,53 +4137,6 @@ MISSING_FILE: #************************************************************ -sub rdb_update_files_for_rule { -#=========== APPEARS NOT TO BE USED! ========================= -# Usage: rdb_update_files_for_rule( source_files ...) -# Assume rule context. -# Update list of source files for current rule, treating properly cases -# where file didn't exist before run, etc - foreach my $file ( @_ ) { - if ( ! rdb_file_exists( $rule, $file ) ) { - # File that didn't appear in the source files for the run - # before. Two cases: (a) it was created during the run; - # (b) it existed before the run. - # If case (a), then the file was non-existent before the - # run, so we must now label it as non-existent, and - # we trigger a new run -#?? print "?? Adding '$file' to '$rule'\n"; - rdb_ensure_file( $rule, $file ); - my $file_time = get_mtime0( $file ); - if ( ($$Ptest_kind == 2) || ($$Ptest_kind == 3) ) { - # Test wrt destination time, but exclude files - # which appear to be generated (according to extension) - # Assume generated files up-to-date after last run. - # I.e., last run was valid. - my $ext = ext( $file ); - - if ( (! exists $generated_exts_all{$ext} ) - && ($file_time >= $dest_mtime) - ) { - # Only changes since the mtime of the destination matter, - # and only non-generated files count. - # Non-existent destination etc gives $dest_mtime=0 - # so this will automatically give out-of-date condition - # Flag out-of-date for a file by treating it as non-existent - rdb_set_file1( $rule, $file, 0, -1, 0); - } - } - elsif ($file_time >= $$Prun_time ) { - # File generated during run. So treat as non-existent at beginning - rdb_set_file1( $rule, $file, 0, -1, 0); - $$Pout_of_date = 1; - } - # Else default of current state of file is correct. - } # END not previously existent file - } # END file -} # END rdb_update_files_for_rule - -#************************************************************ - sub rdb_set_dependentsA { # Call rdb_set_dependentsA( rules ...) # Returns array (sorted), of new source files. @@ -4622,6 +4602,32 @@ sub rdb_makeB1 { if ($failure & ! $force_mode) {return;} if ( ! defined $pass{$rule} ) {$pass{$rule} = 0; } &rdb_clear_change_record; + + # Special fix up for bibtex: + my $bibtex_not_run = -1; # Flags status as to whether this is a + # bibtex rule and if it is, whether out-of-date condition is to + # be ignored. + # -1 => not a bibtex rule + # 0 => no special treatment + # 1 => don't run bibtex because of non-existent bibfiles + # (and setting to do this test) + # 2 => don't run bibtex because of setting + my @missing_bib_files = (); + if ( $rule =~ /^bibtex/ ) { + $bibtex_not_run = 0; + if ($bibtex_use == 0) { + $bibtex_not_run = 2; + } + elsif ($bibtex_use == 1) { + foreach ( keys %$PHsource ) { + if ( ( /\.bib$/ ) && (! -e $_) ) { + push @missing_bib_files, $_; + $bibtex_not_run = 1; + } + } + } + } + if ( ($$Prun_time == 0) && exists($possible_primaries{$rule}) ) { push @rules_never_run, $rule; $$Pout_of_date = 1; @@ -4675,6 +4681,7 @@ sub rdb_makeB1 { print "$My_name: applying rule '$rule'...\n"; &rdb_diagnose_changes( "Rule '$rule': " ); } + $rules_applied{$rule} = 1; $runs++; @@ -4697,11 +4704,23 @@ sub rdb_makeB1 { return; } $pass{$rule}++; - warn_running( "Run number $pass{$rule} of rule '$rule'" ); - if ($$Pcmd_type eq 'primary' ) { - $return = &rdb_primary_run; + if ($bibtex_not_run > 0) { + if ($bibtex_not_run == 1 ) { + show_array ("$My_name: I WON'T RUN '$rule' because I don't find the following files:", + @missing_bib_files); + } + elsif ($bibtex_not_run == 2 ) { + warn "$My_name: I AM CONFIGURED/INVOKED NOT TO RUN '$rule'\n"; + } + $return = &rdb_dummy_run1; + } + else { + warn_running( "Run number $pass{$rule} of rule '$rule'" ); + if ($$Pcmd_type eq 'primary' ) { + $return = &rdb_primary_run; + } + else { $return = &rdb_run1; } } - else { $return = &rdb_run1; } if ($$Pchanged) { $newrule_nofile = 1; $return = 0; @@ -4950,6 +4969,32 @@ sub rdb_run1 { #----------------- +sub rdb_dummy_run1 { + # Assumes contexts for: rule. + # Update rule state as if the rule ran successfully, + # but don't run the rule. + # Returns 0 (success code) + + # Source file data, by definition, correspond to the file state just before + # the latest run, and the run_time to the time just before the run: + &rdb_update_filesA; + $$Prun_time = time; + $$Pchanged = 0; # No special changes in files + $$Plast_result = 0; + $$Plast_message = ''; + + if ($$Ptest_kind == 3) { + # We are time-criterion first time only. Now switch to + # file-change criterion + $$Ptest_kind = 1; + } + $$Pout_of_date = $$Pout_of_date_user = 0; + + return 0; +} # END rdb_dummy_run1 + +#----------------- + sub rdb_ext_cmd { # Call: rdb_ext_cmd # Assumes rule context. Runs external command with substitutions. diff --git a/Master/texmf-dist/doc/support/latexmk/CHANGES b/Master/texmf-dist/doc/support/latexmk/CHANGES index 267f3dad12b..8926fcf0200 100644 --- a/Master/texmf-dist/doc/support/latexmk/CHANGES +++ b/Master/texmf-dist/doc/support/latexmk/CHANGES @@ -116,3 +116,14 @@ From v. 4.10 to v. 4.11 than continuing processing other requested files. The exit code returned by latexmk was also incorrect in this situation +From v. 4.11 to v. 4.12 + Added an option not to run bibtex (to deal with situations + where a bbl file is available but not the bib file from which + it was made). + Corrected misprints in documentation. + +From v. 4.12 to v. 4.13 + Correct clean_up so aux file is deleted + Default for running bibtex: Only when .bib file exists. + Correction insertion of bbl into list of generated extensions + diff --git a/Master/texmf-dist/doc/support/latexmk/README b/Master/texmf-dist/doc/support/latexmk/README index 363e39c4e37..b74f1da56b2 100644 --- a/Master/texmf-dist/doc/support/latexmk/README +++ b/Master/texmf-dist/doc/support/latexmk/README @@ -1,4 +1,5 @@ -Hi, and thanks for checking out latexmk. (Version 4.10, 21 August 2009) +Latexmk, version 4.13, 13 January 2010 +--------------------------------------- Latexmk completely automates the process of generating a LaTeX document. Essentially, it is a highly specialized cousin of the general make @@ -88,11 +89,14 @@ I hope you find this useful. John Collins ---------------------------- "latexmk -h" ---------------------------- -Latexmk 4.11: Automatic LaTeX document generation routine +Latexmk 4.13: Automatic LaTeX document generation routine Usage: latexmk [latexmk_options] [filename ...] Latexmk_options: + -bibtex - use bibtex when needed (default) + -bibtex- - never use bibtex + -bibtex-cond - use bibtex when needed, but only if the bib files exist -bm <message> - Print message across the page when converting to postscript -bi <intensity> - Set contrast or intensity of banner -bs <scale> - Set scale for banner @@ -130,8 +134,9 @@ Usage: latexmk [latexmk_options] [filename ...] implementations of latex/pdflatex.) -l - force landscape mode -l- - turn off -l - -new-viewer - in -pvc mode, always start a new viewer - -new-viewer- - in -pvc mode, start a new viewer only if needed + -new-viewer - in -pvc mode, always start a new viewer + -new-viewer- - in -pvc mode, start a new viewer only if needed + -nobibtex - never use bibtex -nodependents - Do not show list of dependent files after processing -pdf - generate pdf by pdflatex -pdfdvi - generate pdf by dvipdf diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.1 b/Master/texmf-dist/doc/support/latexmk/latexmk.1 deleted file mode 100644 index 5ef13279d0e..00000000000 --- a/Master/texmf-dist/doc/support/latexmk/latexmk.1 +++ /dev/null @@ -1,1609 +0,0 @@ -.TH LATEXMK 1L "24 November 2009" "" -.SH NAME -latexmk \- generate LaTeX document -.SH SYNOPSIS -.B latexmk [options] [file ...] -.SH DESCRIPTION -.I Latexmk -completely automates the process of compiling a LaTeX document. -Essentially, it is like a specialized relative of the general -\fImake\fR utility, but one which determines dependencies -automatically and has some other very useful features. In its basic -mode of operation \fIlatexmk\fR is given the name of the primary -source file for a document, and it issues the appropriate sequence of -commands to generate a .dvi, .ps, .pdf and/or hardcopy version of the -document. -.PP -By default \fIlatexmk\fR will run the commands necessary to generate a -.dvi file. -.PP -\fILatexmk\fR can also be set to run continuously with a suitable -previewer. In that case the LaTeX program, etc, are rerun whenever -one of the source files is modified, and the previewer automatically -updates the on-screen view of the compiled document. -.PP -\fILatexmk\fR determines which are the source files by examining the -log file. When \fIlatexmk\fR is run, it examines properties of the -source files, and if any have been changed since the last document -generation, \fIlatexmk\fR will run the various LaTeX processing -programs as necessary. In particular, it will repeat the run of LaTeX -(or pdflatex) often enough to resolve all cross references; depending -on the macro packages used. With some macro packages and document -classes, four, or even more, runs may be needed. If necessary, -\fIlatexmk\fR will also run bibtex and/or makeindex. In addition, -\fIlatexmk\fR can be configured to generate other necessary files. -For example, from an updated figure file it can automatically generate -a file in encapsulated postscript or another suitable format for -reading by LaTeX. -.PP -\fILatexmk\fR has two different previewing options. In the simple -\fB-pv\fR option, a dvi, postscript or pdf previewer is automatically -run after generating the dvi, postscript or pdf version of the -document. The type of file to view is selected according to -configuration settings and command line options. -.PP -The second previewing option is the powerful \fB-pvc\fR option -(mnemonic: "preview continuously"). In this case, \fIlatexmk\fR runs -continuously, regularly monitoring all the source files to see if any -have changed. Every time a change is detected, \fIlatexmk\fR runs all -the programs necessary to generate a new version of the document. A -good previewer (like \fIgv\fR) will then automatically update its -display. Thus the user can simply edit a file and, when the changes -are written to disk, \fIlatexmk\fR completely automates the cycle of -updating the .dvi (and possibly the .ps and .pdf) file, and refreshing -the previewer's display. It's not quite WYSIWYG, but usefully close. -.PP -For other previewers, the user may have to manually make the previewer -update its display, which can be (some versions of xdvi and gsview) as -simple as forcing a redraw of its display. -.PP -\fILatexmk\fR has the ability to print a banner in gray diagonally -across each page when making the postscript file. It can also, if -needed, call an external program to do other postprocessing on the -generated files. -.PP -\fILatexmk\fR is highly configurable, both from the command line and -in configuration files, so that it can accommodate a wide variety of -user needs and system configurations. Default values are set -according to the operating system, so \fIlatexmk\fR often works -without special configuration on MS-Windows, cygwin, Linux, OS-X, and -other UNIX systems (notably Solaris). -.PP -A very annoying complication handled very reliably by \fILatexmk\fR, -is that LaTeX is a multiple pass system. On each run, LaTeX reads in -information generated on a previous run, for things like cross -referencing and indexing. In the simplest cases, a second run of -LaTeX suffices, and often the log file contains a message about the -need for another pass. However, there is a wide variety of add-on -macro packages to LaTeX, with a variety of behaviors. The result is -to break simple-minded determinations of how many runs are needed and -of which programs. In its new version, \fIlatexmk\fR has a highly -general and efficient solution to these issues. The solution involves -retaining between runs information on the source files, and a symptom -is that \fIlatexmk\fR generates an extra file (with extension -\fR.fdb_latexmk\fR, by default) that contains the source file -information. - -.SH LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE -(All options can be introduced by single or double "-" characters, -e.g., "latexmk -help" or "latexmk --help".) -.TP -.B file -One or more files can be specified. If no files are specified, -\fIlatexmk\fR will, by default, run on all files in the current working directory -with a ".tex" extension. This behavior can be changed: see the -description concerning the \fI@default_files\fR variable in the -section "List of configuration variables usable in initialization -files". -.PP -If a file is specified without an extension, then the ".tex" extension -is automatically added, just as LaTeX does. Thus, if you specify: - - latexmk foo - -then \fIlatexmk\fR will operate on the file "foo.tex". -.TP -.B -bm <message> -A banner message to print diagonally across each page when converting -the dvi file to postscript. The message must be a single argument on -the command line so be careful with quoting spaces and such. - -Note that if the \fB-bm\fR option is specified, the \fB-ps\fR option is -assumed. -.TP -.B -bi <intensity> -How dark to print the banner message. A decimal number between 0 and 1. -0 is black and 1 is white. The default is 0.95, which is OK unless your -toner cartridge is getting low. -.TP -.B -bs <scale> -A decimal number that specifies how large the banner message will be -printed. Experimentation is necessary to get the right scale for your -message, as a rule of thumb the scale should be about equal to 1100 -divided by the number of characters in the message. The default is 220.0 -which is just right for 5 character messages. -.TP -.B -commands -List the commands used by \fIlatexmk\fR for processing files, and then -exit. -.TP -.B -c -Clean up (remove) all regeneratable files generated by \fIlatex\fR and -\fIbibtex\fR except dvi, postscript and pdf. These files are a -combination of log files, aux files, latexmk's database file of source -file information, -and those with extensions -specified in the \fI@generated_exts\fR configuration variable. In addition, -files with extensions by the \fI$clean_ext\fR configuration variable are -removed. - -This cleanup is instead of a regular make. See the \fB-gg\fR option -if you want to do a cleanup then a make. -.TP -.B -C -Clean up (remove) all regeneratable files generated by \fIlatex\fR and -\fIbibtex\fR. This is the same as the \fB-c\fR option with the -addition of dvi, postscript and pdf files, and those with extensions -in the \fI$clean_full_ext\fR configuration variable. - -This cleanup is instead of a regular make. See the \fB-gg\fR option -if you want to do a cleanup than a make. -.TP -.B -CA -Clean up (remove) absolutely all regeneratable files. It is now -equivalent to the \fB-C\fR option - -This cleanup is instead of a regular make. -See the \fB-gg\fR option if you want to do a cleanup then a -make. -.TP -.B -CF -Remove the file containing the database of source file information, -before doing the other actions requested. -.TP -.B -d -Set draft mode. This prints the banner message "DRAFT" across your -page when converting the dvi file to postscript. Size and intensity -can be modified with the \fB-bs\fR and \fB-bi\fR options. The \fB-bm\fR -option will override this option as this is really just a short way of -specifying: - - latexmk -bm DRAFT - -Note that if the \fB-d\fR option is specified, the \fB-ps\fR option is -assumed. -.TP -.B -dF -Dvi file filtering. The argument to this option is a filter which will -generate a filtered dvi file with the extension ".dviF". All extra -processing (e.g. conversion to postscript, preview, printing) will then -be performed on this filtered dvi file. - -Example usage: To use dviselect to select only the even pages of the dvi file: - - latexmk -dF 'dviselect even' foo.tex -.TP -.B -diagnostics -Print detailed diagnostics during a run. This may help for debugging -problems or to understand \fI.latexmk\fR's behavior in difficult -situations. -.TP -.B -dvi -Generate dvi version of document. -.TP -.B -dvi- -Turn off generation of dvi version of document. (This may get -overridden, if some other file is made (e.g., a .ps file) that is -generated from the dvi file, or if no generated file at all is -requested.) -.TP -.B -e <code> -Execute the specified initialization code before processing. The code -is \fIPerl\fR code of the same form as is used in \fIlatexmk\fR's -initialization files -- for more details, see the information on the -\fB-r\fR option, and the section about "Configuration/initialization -(RC) files". The code is typically a sequence of assignment -statements separated by semicolons. - -The code is executed when the \fB-e\fR option is encountered during -\fIlatexmk\fR's parsing of its command line. See the \fB-r\fR option -for a way of executing initialization code from a file. An error -results in \fIlatexmk\fR stopping. Multiple instances of the \fB-r\fR -and \fB-e\fR options can be used, and they are executed in the order -they appear on the command line. - -Some care is needed to deal with proper quoting of special characters -in the code on the command line. For example, suppose you want -to set the latex command to use its -shell-escape option, then under -UNIX/LINUX you could use the line - - latexmk -e '$latex=q/latex %O -shell-escape %S/' file.tex - -Note that the single quotes block normal UNIX/LINUX command shells -from treating the characters inside the quotes as special. -(In this example, the q/.../ construct is a -\fIPerl\fR idiom equivalent to using -single quotes. This avoids the complications of getting a quote -character inside an already quoted string in a way that is independent -of both the shell and the operating-system.) - -The above command line will NOT work under MS-Windows with cmd.exe or -command.com or 4nt.exe. For MS-Windows with these command shells you -could use - - latexmk -e "$latex=q/latex %O -shell-escape %S/" file.tex - -or - - latexmk -e "$latex='latex %O -shell-escape %S'" file.tex - -The last two examples will NOT work with UNIX/LINUX command shells. -.TP -.B -f -Force \fIlatexmk\fR to continue document processing despite errors. -Normally, when \fIlatexmk\fR detects that LaTeX or another program has -found an error which will not be resolved by further processing, no -further processing is carried out. -.TP -.B -f- -Turn off the forced processing-past-errors such as is set by the -\fB-f\fR option. This could be used to override a setting in a -configuration file. -.TP -.B -g -Force \fIlatexmk\fR to process document fully, even under situations -where \fIlatexmk\fR would normally decide that no changes in the -source files have occurred since the previous run. -This option is useful, for example, if you change some options and -wish to reprocess the files. -.TP -.B -g- -Turn off \fB-g\fR. -.TP -.B -gg -"Super go mode" or "clean make": clean out generated files as if -\fB-CA\fR had been given, and then do a regular make. -.TP -.B -h, -help -Print help information. -.TP -.B -l -Run in landscape mode, using the landscape mode for the previewers and -the dvi to postscript converters. This option is not normally needed -nowadays, since current previewers normally determine this information -automatically. -.TP -.B -l- -Turn off \fB-l\fR. -.TP -.B -new-viewer -When in continuous-preview mode, always start a new viewer to view the -generated file. By default, \fIlatexmk\fR will, in continuous-preview -mode, test for a previously running previewer for the same file and -not start a new one if a previous previewer is running. However, its -test sometimes fails (notably if there is an already-running previewer -that is viewing a file of the same name as the current file, but in a -different directory). This option turns off the default behavior. -.TP -.B -new-viewer- -The inverse of the \fB-new-viewer\fR option. It puts \fIlatexmk\fR -in its normal behavior that in preview-continuous mode it checks for -an already-running previewer. -.TP -.B -p -Print out the document. By default it is -the generated postscript file that is printed. But you can use the -\fB-print=...\fR option to print the dvi or pdf files instead, and you -can configure this in a start up file (by setting the -\fI$print_type\fR variable). - -However, printing is enabled by default only under UNIX/LINUX systems, -where the default is to use the lpr command. In general, the correct -behavior for printing very much depends on your system's software. In -particular, under MS-Windows you must have suitable program(s) -available, and you must have configured the print commands used by -\fIlatexmk\fR. This can be non-trivial. See the documentation on the -\fI$lpr\fR, \fI$lpr_dvi\fR, and \fI$lpr_pdf\fR configuration variables -to see how to set the commands for printing. - -This option is incompatible with the \fB-pv\fR and \fB-pvc\fR options, -so it turns them off. -.TP -.B -pdf -Generate pdf version of document using pdflatex. -.TP -.B -pdfdvi -Generate pdf version of document from the dvi file, by default using dvipdf. -.TP -.B -pdfps -Generate pdf version of document from the ps file, by default using -ps2pdf. -.TP -.B -pdf- -Turn off generation of pdf version of document. -(This can be used to override a setting in a configuration file. -It may get overridden if some other option requires the generation of -a pdf file.) -.TP -.B -print=dvi, -print=ps, -print=pdf -Define which kind of file is printed. This option also ensures that -the requisite file is made, and turns on printing. The default is to -print a postscript file. -.TP -.B -ps -Generate postscript version of document. -.TP -.B -ps- -Turn off generation of postscript version of document. -This can be used to override a setting in a configuration file. -(It may get overridden by some other option that requires a postscript -file, for example a request for printing.) -.TP -.B -pF -Postscript file filtering. The argument to this option is a filter -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. - -Example of usage: Use psnup to print two pages on the one page: - - latexmk -ps -pF 'psnup -2' foo.tex - -or - - latexmk -ps -pF "psnup -2" foo.tex - -Whether to use single or double quotes round the "psnup -2" will -depend on your command interpreter, as used by the particular version -of perl and the operating system on your computer. -.TP -.B -pv -Run file previewer. If the \fB-view\fR option is used, this will select -the kind of file to be previewed (dvi, ps or pdf). -Otherwise the viewer views the "highest" kind of file selected, by the -\fB-dvi\fR, \fB-ps\fR, \fB-pdf\fR, \fB-pdfps\fR options, in the -order dvi, ps, pdf (low to high). -If no file type has been selected, the dvi previewer will be used. -This option is incompatible with the \fB-p\fR and \fB-pvc\fR options, -so it turns them off. -.TP -.B -pv- -Turn off \fB-pv\fR. -.TP -.B -pvc -Run a file previewer and continually update the .dvi, .ps, and/or .pdf -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 \fB-pv\fR -option. -The preview-continuous option \fB-pvc\fR can only work with one file. -So in this case you will normally only specify one filename on -the command line. It is also incompatible with the -\fB-p\fR and \fB-pv\fR options, so it turns these options off - -With a good previewer the display will be automatically updated. -(Under \fIsome but not all\fR versions of UNIX/Linux "gv -watch" does -this for postscript files; this can be set by a configuration -variable. This would also work for pdf files except for an apparent -bug in gv that causes an error when the newly updated pdf file is -read.) Many other previewers will need a manual update. - -Important note: the acroread program on MS-Windows locks the pdf file, -and prevents new versions being written, so it is a bad idea to use -acroread to view pdf files in preview-continuous mode. It is better -to use a dvi or ps viewer, as set by one of the \fB-view=dvi\fR and -\fB-view=ps\fR options. - -There are some other methods for arranging an update, notably useful -for many versions of xdvi and xpdf. These are best set in -\fIlatexmk\fR's configuration; see below. - -Note that if \fIlatexmk\fR dies or is stopped by the user, the -"forked" previewer will continue to run. Successive invocations with -the \fB-pvc\fR option will not fork new previewers, but \fIlatexmk\fR -will normally use the existing previewer. (At least this will happen -when \fIlatexmk\fR is running under an operating system where it knows -how to determine whether an existing previewer is running.) -.TP -.B -pvc- -Turn off \fB-pvc\fR. -.TP -.B -quiet -Same as -silent -.TP -.B -r <rcfile> -Read the specified initialization file ("RC file") before processing. - -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 \fB-r\fR option, it is read during this second step. -Thus an initialization file specified with the \fB-r\fR option can -override both the standard initialization files and \fIpreviously\fR -specified options. But all of these can be overridden by \fIlater\fR -options. - -The contents of the RC file just comprise a piece of code in the -\fIPerl\fR programming language -(typically a sequence of assignment statements); they are executed -when the \fB-r\fR option is encountered during \fIlatexmk\fR's parsing -of its command line. See the \fB-e\fR option for a way of giving -initialization code directly on \fIlatexmk\fR's command line. An -error results in \fIlatexmk\fR stopping. Multiple instances of the -\fB-r\fR and \fB-e\fR options can be used, and they are executed in -the order they appear on the command line. -.TP -.B -silent -Run commands silently, i.e., with options that reduce the amount of -diagnostics generated. For example, with the default settings for -commands under UNIX, the command "latex -interaction=batchmode" is used -for latex. - -Also reduce the number of informational messages that \fIlatexmk\fR -generates. -.TP -.B -v, -version -Print version number of \fIlatexmk\fR. -.TP -.B -verbose -Opposite of \fB-silent\fR. This is the default setting. -.TP -.B -view=default, -view=dvi, -view=ps, -view=pdf -Set the kind of file used when previewing is requested (e.g., by the -\fB-pv\fR or \fB-pvc\fR switches). The default is to view the "highest" -kind of requested file (in the order dvi, ps, pdf). -.PP -The preview-continuous option \fB-pvc\fR can only work with one file. -So in this case you will normally only specify one filename on -the command line. -.PP -Options \fB-p\fR, \fB-pv\fR and \fB-pvc\fR are mutually exclusive. So -each of these options turns the others off. - -.SH EXAMPLES -.nf -.ta 2i -% \fBlatexmk thesis\fR \fI# run latex enough times to resolve - cross-references\fR - -% \fBlatexmk -pvc -ps thesis\fR \fI# run latex enough times to resolve - cross-references, make a postscript - file, start a previewer. Then - watch for changes in the source - file thesis.tex and any files it - uses. After any changes rerun latex - the appropriate number of times and - remake the postscript file. If latex - encounters an error, latexmk will - keep running, watching for - source file changes. - -% \fBlatexmk -c\fR \fI# remove .aux, .log, .bbl, .blg, .dvi, - .pdf, .ps & .bbl files\fR - - -.SH CONFIGURATION/INITIALIZATION (RC) FILES -.PP -\fILatexmk\fR can be customized using initialization files, which are -read at startup in the following order: -.PP -1) The system RC file, if it exists. - On a UNIX system, \fIlatexmk\fR searches for following places for its -system RC file, in the following order, and reads the first it finds: - "/opt/local/share/latexmk/LatexMk", - "/usr/local/share/latexmk/LatexMk", - "/usr/local/lib/latexmk/LatexMk". - On a MS-WINDOWS system it looks for "C:\\latexmk\\LatexMk". -.PP -2) The user's RC file, "$HOME/.latexmkrc", if it exists. Here $HOME -is the value of the environment variable HOME. On UNIX and clones -(including LINUX), this variable is set by the system; on MS-Windows, -the user may choose to set it. -.PP -3) The RC file in the current working directory. This file can be -named either "latexmkrc" or ".latexmkrc", and the first of these to be -found is used, if any. -.PP -4) Any RC file(s) specified on the command line with the \fB-r\fR option. -.PP -Each RC file is a sequence of \fIPerl\fR commands. Naturally, a user can use -this in creative ways. But for most purposes, one simply uses a -sequence of assignment statements that override some of the built-in -settings of \fILatexmk\fR. Straightforward cases can be handled -without knowledge of the \fIPerl\fR 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 are written; thus any RC file specified on the command line with -the \fB-r\fR option can override previous options but can be itself -overridden by later options on the command line. There is also the -\fB-e\fR option, which allows initialization code to be specified in -\fIlatexmk\fR's command line. - -.SH HOW TO SET VARIABLES IN INITIALIZATION FILES -.PP -The important variables that can be configured are described in the -section "List of configuration variables usable in initialization -files". Syntax for setting these variables is of the following forms: -.PP - $bibtex = 'bibtex %O %B'; -.PP -for the setting of a string variable, -.PP - $preview_mode = 1; -.PP -for the setting of a numeric variable, and -.PP - @default_files = ('paper', 'paper1'); -.PP -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 $ -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 \fIPerl\fR -programming language brings into play some special rules for -interpolating variables into strings. People not fluent in \fIPerl\fR -will want to avoid these complications.) - -You can do much more complicated things, but for this you will need to -consult a manual for the \fIPerl\fR programming language. - - - -.SH FORMAT OF COMMAND SPECIFICATIONS - -Some of the variables set the commands that \fIlatexmk\fR uses for -carrying out its work, for example to generate a dvi file from a tex -file or to view a postscript file. This section describes some -important features of how the commands are specified. - -\fBPlaceholders\fR: Supposed you wanted \fIlatexmk\fR 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: -.PP - $latex = 'elatex --shell-escape %O %S'; -.PP -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 \fIlatexmk\fR has decided -to use for this command. (E.g., if you used the -silent option it -would replace %O by "-interaction=batchmode".) - -The available placeholders are: -.TP -.B %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. -.TP -.B %D -destination file (e.g., the name of the postscript file when -converting a dvi file to postscript). -.TP -.B %O -options -.TP -.B %R -root filename. This is the base name for the main tex file. -.TP -.B %S -source file (e.g., the name of the dvi file when converting a dvi file -to ps). -.TP -.B %T -The name of the primary tex file. -.PP -If for some reason you need a literal % character in your string not -subject to the above rules, use a pair of these characters. Thus with -the command specification $ps_previewer = 'latex -ad=%%Sfile.ad %S', -the %%S will become %S when the command is executed, but the %S will -be replaced by the source filename, which in this case would be the -name of a postscript file to be viewed. -.PP -Appropriate quoting will be applied to the filename substitutions, so -you mustn't supply them yourself even if you the names of your have -spaces in them. (But if your TeX filenames have spaces in them, -beware that many versions of the TeX program cannot correctly handle -filenames containing spaces.) In case latexmk's quoting does not work -correctly on your system, you can turn it off -- see the documentation -for the variable \fI$quote_filenames\fR. -.PP -The distinction between %B and %R needs a bit of care, since they are -often the same, but not always. For example on a simple document, the -basename of a bibtex run is the same as for the texfile. But in a -document with several bibliographies, the bibliography files will have -a variety of names. Since bibtex is invoked with the basename of the -bibliography file, the setting for the bibtex command should therefore -be -.PP - $bibtex = 'bibtex %O %B'; -.PP -Generally, you should use %B rather than %R. Similarly for most -purposes, the name %T of the primary texfile is not a useful -placeholder. - -See the default values in the section "List of configuration variables -usable in initialization files" for what is normally the most -appropriate usage. - -If you omit to supply any placeholders whatever in the specification -of a command, \fIlatexmk\fR will supply what its author thinks are -appropriate defaults. This gives compatibility with configuration -files for previous versions of \fIlatexmk\fR, which didn't use -placeholders. - -\fB"Detaching" a command\fR: Normally when \fIlatexmk\fR 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 \fIlatexmk\fR gets -the previewer running and then returns to its next task (or exits if -there is nothing else to do). To achieve this effect of detaching a -command, you need to precede the command name with "start ", as in -.PP - $dvi_previewer = 'start xdvi %O %S'; -.PP -This will be translated to whatever is appropriate for your operating -system. - -Notes: (1) In some circumstances, \fIlatex\fR will always run a -command detached. This is the case for a previewer in preview -continuous mode, since otherwise previewing continuously makes no -sense. (2) This precludes 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. - -\fBCommand names containing spaces\fR: 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 enclosed in double quotes, as in -.PP - $lpr_pdf = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p %S'; -.PP -\fBUsing MS-Windows file associations\fR: A useful trick under modern -versions of MS-Windows (e.g., WinXP) is to use just the command -'start' by itself: -.PP - $dvi_previewer = 'start %S'; -.PP -Under recent versions of MS-Windows, this will cause to be run -whatever program the system has associated with dvi files. (The same -applies for a postscript viewer and a pdf viewer.) - -\fBNot using a certain command\fR: If a command is not to be run, the -command name NONE is used, as in -.PP - $lpr = 'NONE lpr'; -.PP -This typically is used when an appropriate command does not exist on -your system. The string after the "NONE" is effectively a comment. - -\fBOptions to commands\fR: -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 \fIlatexmk\fR to use latex with source specials -enabled. Then you might use the following line in an initialization -file: -.PP - $latex = 'latex --src-specials %O %S'; -.PP - -\fBAdvanced tricks\fR: Normally one specifies a single command for the -commands invoked by \fIlatexmk\fR. Naturally, if there is some -complicated additional processing you need to do in your special -situation, you can write a script (or batch file) to do the -processing, and then configure \fIlatexmk\fR to use your script in -place of the standard program. - -It is also possible to configure \fIlatexmk\fR to run multiple -commands. For example, if when running pdflatex to generate a pdf -file from a tex file you need to run another program after pdflatex to -perform some extra processing, you could do something like: - - $pdflatex = 'pdflatex --shell-escape %O %S; pst2pdf_for_latexmk %B'; - -This definition assumes you are using a UNIX-like system, so that the -two commands to be run are separated by the semicolon in the middle of -the string. - - -.SH LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES -.PP -Default values are indicated in brackets. -.TP -.B $banner [0] -If nonzero, the banner message is printed across each page when -converting the dvi file to postscript. Without modifying the variable -\fI$banner_message\fR, this is equivalent to specifying the \fB-d\fR -option. - -Note that if \fB$banner\fR is nonzero, the \fB$postscript_mode\fR is -assumed and the postscript file is always generated, even if it is newer -than the dvi file. -.TP -.B $banner_intensity [0.95] -Equivalent to the \fB-bi\fR option, this is a decimal number between 0 -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 cartridge isn't -running too low. -.TP -.B $banner_message ["DRAFT"] -The banner message to print across each page when converting the dvi -file to postscript. This is equivalent to the \fB-bm\fR option. -.TP -.B $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. This is equivalent to the -\fB-bs\fR option. -.TP -.B @BIBINPUTS -This is an array variable, now mostly obsolete, that specifies -directories where -\fIlatexmk\fR should look for .bib files. By default it is set from -the BIBINPUTS environment variable of the operating system. If that -environment variable is not set, a single element list consisting of -the current directory is set. The format of the directory names -depends on your operating system, of course. Examples for setting -this variable are: - - @BIBINPUTS = ( ".", "C:\\bibfiles" ); - @BIBINPUTS = ( ".", "\\\\server\\bibfiles" ); - @BIBINPUTS = ( ".", "C:/bibfiles" ); - @BIBINPUTS = ( ".", "//server/bibfiles" ); - @BIBINPUTS = ( ".", "/usr/local/texmf/bibtex/bib" ); - -Note that under MS Windows, either a forward slash "/" or a backward -slash "\(rs" 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 \fIPerl\fR's rules for writing -strings. -.PP -\fIImportant note:\fR This variable is now mostly obsolete in the -current version of \fIlatexmk\fR, -since it has a better method of searching for files using the -kpsewhich command. However, if your system is an unusual one without -the kpsewhich command, you may need to set the variable \fI@BIBINPUTS\fR. -.TP -.B $bibtex ["bibtex %O %S"] -The BibTeX processing program. -.TP -.B $bibtex_silent_switch ["-terse"] -\fBSwitch(es)\fR for the BibTeX processing program when silent mode is on. -.TP -.B $cleanup_includes_generated [0] -If nonzero, specifies that cleanup also deletes files that are -detected in log file as being generated (see the \\openout lines in -the log file). It will also include files made from these first -generation generated files. -.TP -.B $cleanup_mode [0] -If nonzero, specifies cleanup mode: 1 for full cleanup, 2 for cleanup -except for dvi, ps and pdf files, 3 for cleanup except for dep and aux -files. (There is also extra cleaning as specified by the -\fI$clean_ext\fR, \fI$clean_full_ext\fR and \fI@generated_exts\fR -variables.) -.PP -This variable is equivalent to specifying one of -the \fB-c\fR, \fB-c1\fR, or \fB-C\fR options. But there should be no need -to set this variable from an RC file. -.TP -.B $clean_ext [""] -Extra extensions of files for \fIlatexmk\fR to remove when any of the -clean-up options (\fB-c\fR, \fB-c1\fR, or \fB-C\fR) is selected. -The value of this variable is a string containing the extensions -separated by spaces. -.TP -.B $clean_full_ext [""] -Extra extensions of files for \fIlatexmk\fR to remove when the \fB-C\fR -option is selected, i.e., extensions of files to remove when the .dvi, -etc files are to be cleaned-up. -.TP -.B @cus_dep_list [()] -Custom dependency list -- see section on "Custom Dependencies". -.TP -.B @default_files [("*.tex")] -Default list of files to be processed. - -Normally, if no filenames are specified on the command line, -\fIlatexmk\fR processes all tex files specified in the \fI@default_files\fR -variable, which by default is set to all tex files ("*.tex") in the -current directory. This is a convenience: just run \fIlatexmk\fR 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 set the -\fI@default_files\fR in an initialization file -(e.g., the file "latexmkrc" in the current directory). Then if no -files are specified on the command line then the files you specify by -setting \fI@default_files\fR are processed. - -Three examples: - - @default_files = ("paper_current"); - - @default_files = ("paper1", "paper2.tex"); - - @default_files = ("*.tex", "*.dtx"); - -Note that more than file may be given, and that the default extension -is ".tex". Wild cards are allowed. The parentheses are because -\fI@default_files\fR is an array variable, i.e., a sequence of -filename specifications is possible. -.TP -.B $dvi_filter [empty] -The dvi file filter to be run on the newly produced dvi file before -other processing. Equivalent to specifying the \fB-dF\fR option. -.TP -.B $dvi_mode [See below for default] -If nonzero, generate a dvi version of the document. -Equivalent to the \fB-dvi\fR option. -.PP -The variable $dvi_mode defaults to 0, but if no explicit requests are -made for other types of file (postscript, pdf), then $dvi_mode will be -set to 1. In addition, if a request for a file for which a .dvi file -is a prerequisite, then $dvi_mode will be set to 1. -.TP -.B $dvi_previewer ["start xdvi %O %S" under UNIX] -The command to invoke a dvi-previewer. -[Default is "start" under MS-WINDOWS; under more recent versions of -Windows, this will cause to be run whatever command the system has -associated with .dvi files.] -.TP -.B $dvi_previewer_landscape ["start xdvi %O %S"] -The command to invoke a dvi-previewer in landscape mode. -[Default is "start" under MS-WINDOWS; under more recent versions of -Windows, this will cause to be run whatever command the system has -associated with .dvi files.] -.TP -.B $dvipdf ["dvipdf %O %S %D"] -Command to convert dvi to pdf file. A common reconfiguration is to -use the dvipdfm command, which needs its arguments in a different order: - - $dvipdf = "dvipdfm %O -o %D %S"; - -WARNING: The default dvipdf script generates pdf files with bitmapped -fonts, which do not look good when viewed by acroread. That script -should be modified to give dvips the options "-P pdf" to ensure that -type 1 fonts are used in the pdf file. -.TP -.B $dvips ["dvips %O -o %D %S"] -The program to used as a filter to convert a .dvi file to a .ps file. -If pdf is going to be generated from pdf, then the value of the -$dvips_pdf_switch -- see below -- will be included in the options -substituted for "%O". -.TP -.B $dvips_landscape ["dvips -tlandscape %O -o %D %S"] -The program to used as a filter to convert a .dvi file to a .ps file -in landscape mode. -.TP -.B $dvips_pdf_switch ["-P pdf"] -Switch(es) for dvips program when pdf file is to be generated from -ps file. -.TP -.B $dvips_silent_switch ["-q"] -Switch(es) for dvips program when silent mode is on. -.TP -.B $dvi_update_command [""] -When the dvi previewer is set to be updated by running a command, this -is the command that is run. See the information for the variable -\fI$dvi_update_method\fR for further information, and see information -on the variable \fI$pdf_update_method\fR for an example for the -analogous case of a pdf previewer. -.TP -.B $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 \fI$pdf_update_method\fR and to -the \fI$ps_update_method\fR variables. - 0 => update is automatic, - 1=> manual update by user, which may only mean a mouse click on the -viewer's window or may mean a more serious action. - 2 => Send the signal, whose number is in the variable -\fI$dvi_update_signal\fR. The default value under UNIX is -suitable for xdvi. - 3 => Viewer cannot do an update, because it locks the file. (As with -acroread under MS-Windows.) - 4 => run a command to do the update. The command is specified by -the variable \fI$dvi_update_command\fR. - -See information on the variable \fI$pdf_update_method\fR for an -example of updating by command. -.TP -.B $dvi_update_signal [Under UNIX: SIGUSR1, which is a system-dependent value] -The number of the signal that is sent to the dvi viewer when it is -updated by sending a signal -- see the information on the variable -\fI$dvi_update_method\fR. The default value is the one appropriate -for xdvi on a UNIX system. -.TP -.B $fdb_ext ["fdb_latexmk"] -The extension of the file which \fIlatexmk\fR generates to contain a -database of information on source files. You will not normally need -to change this. -.TP -.B $force_mode [0] -If nonzero, continue processing past minor \fIlatex\fR errors -including unrecognized cross references. Equivalent to specifying the -\fB-f\fR option. -.TP -.B @generated_exts [( "aux", "bbl", "idx", "ind", "lof", "lot", "out", "toc", $fdb_ext )] -This contains a list of extensions for files that are generated during -a LaTeX run and that are read in by LaTeX in later runs, either -directly or indirectly. - -This list has two uses: (a) to set the kinds of file to be deleted in -a cleanup operation (with the \fB-c\fR, \fB-C\fR, \fB-CA\fR, \fB-g\fR -and \fB-gg\fR options), and (b) in the determination of whether a -rerun of (pdf)LaTeX is needed after a run that gives an error. - -(Normally, a change of a source file during a run should provoke a -rerun. This includes a file generated by LaTeX, e.g., an aux file, -that is read in on subsequent runs. But after a run that results in -an error, a new run should occur until the user has made a change in -the files. But the user may have corrected an error in a source .tex -file during the run. So \fIlatexmk\fR needs to distinguish -user-generated and automatically generated files; it determines the -automatically generated files as those with extensions in the list in -@generated_exts.) - -A convenient way to add an extra extension to the list, without losing -the already defined ones is to use a push command in the line in an -RC file. E.g., - - push @generated_exts, "end"; - -adds the extension "end" to the list of predefined generated -extensions. (This extension is used by the RevTeX package, for -example.) -.TP -.B $go_mode [0] -If nonzero, process files regardless of timestamps, and is then -equivalent to the \fB-g\fR option. -.TP -.B %hash_calc_ignore_pattern -\fB!!!This variable is for experts only!!!\fR - -The general rule \fIlatexmk\fR uses for determining when an extra run -of some program is needed is that one of the source files has changed. -But consider for example a latex package that causes an encapsulated -postscript file (an "eps" file) to be made that is to be read in on -the next run. The file contains a comment line giving its creation -date and time. On the next run the time changes, \fIlatex\fR sees -that the eps file has changed, and therefore reruns latex. This -causes an infinite loop, only exited becaues \fIlatexmk\fR 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. You -can instruct \fIlatex\fR to ignore the offending line as follows: - - $hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: '; - -This creates a rule for files with extension \fI.eps\fR about lines to -ignore. The left-hand side is a \fIPerl\fR idiom for setting an item -in a hash. Note that the file extension is specified without a -period. The value, on the right-hand side, is a string containing a -regular expresssion. (See documentation on \fIPerl\fR for how they -are to be specified in general.) This particular regular expression -specifies that lines beginning with "%%CreationDate: " are to be -ignored in deciding whether a file of the given extension \fI.eps\fR -has changed. -.TP -.B $kpsewhich ["kpsewhich %S"] -The program called to locate a source file when the name alone is not -sufficient. Most filenames used by \fIlatexmk\fR have sufficient path -information to be found directly. But sometimes, notably when -.bib files are found from the log file of a bibtex run, the name of -the file, but not its path is known. The program specified by -$kpsewhich is used to find it. - -See also the \fI@BIBINPUTS\fR variable for another way that \fIlatexmk\fR -also uses to try to locate files; it applies only in the case of .bib -files. -.TP -.B $landscape_mode [0] -If nonzero, run in landscape mode, using the landscape mode previewers and -dvi to postscript converters. Equivalent to the \fB-l\fR option. -Normally not needed with current previewers. -.TP -.B $latex ["latex %O %S"] -The LaTeX processing program. Note that as with other programs, you -can use this variable not just to change the name of the program used, -but also specify options to the program. E.g., - - $latex = "latex --src-specials"; -.TP -.B %latex_input_extensions -This variable specifies the extensions tried by latexmk when it finds -that a LaTeX run resulted in an error that a file has not been found, -and the file is given without an extension. This typically happens when -LaTeX commands of the form \input{file} or \includegraphics{figure}, -when the relevant source file does not exist. - -In this situation, latexmk searches for custom dependencies to make -the missing file(s), but restricts it to the extensions specified by -the variable %latex_input_extensions. The default extensions are -'tex' and 'eps'. - -(For Perl experts: %latex_input_extensions is a hash whose keys are -the extensions. The values are irrelevant.) Two subroutines are -provided for manipulating this and the related variable -%pdflatex_input_extensions, add_input_ext and remove_input_ext. They -are used as in the following examples are possible lines in an -initialization file: - - remove_input_ext( 'latex', 'tex' ); - -removes the extension 'tex' from latex_input_extensions - - add_input_ext( 'latex', 'asdf' ); - -add the extension 'asdf to latex_input_extensions. (Naturally with -such an extension, you should have made an appropriate custom -dependency for latexmk, and should also have done the appropriate -programming in the LaTeX source file to enable the file to be read. -The standard extensions are handled by LaTeX and its graphics/graphicx -packages. - -.TP -.B $latex_silent_switch ["-interaction=batchmode"] -Switch(es) for the LaTeX processing program when silent mode is on. -Under MS-Windows, the default value is changed to -"-interaction=batchmode -c-style-errors", as used by MikTeX and fpTeX. -.TP -.B $lpr ["lpr %O %S" under UNIX/LINUX, \(dqNONE lpr\(dq under MS-WINDOWS] -The command to print postscript files. - -Under MS-Windows (unlike UNIX/LINUX), there is no standard program for -printing files. But there are ways you can do it. For example, if -you have gsview installed, you could use it with the option "/p": - - $lpr = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p'; - -If gsview is installed in a different directory, you will need to make -the appropriate change. Note the combination of single and double -quotes around the name. The single quotes specify that this is a -string to be assigned to the configuration variable \fI$lpr\fR. The double -quotes are part of the string passed to the operating system to get -the command obeyed; this is necessary because one part of the command -name ("Program Files") contains a space which would otherwise be -misinterpreted. -.TP -.B $lpr_dvi ["NONE lpr_dvi"] -The printing program to print dvi files. -.TP -.B $lpr_pdf ["NONE lpr_pdf"] -The printing program to print pdf files. - -Under MS-Windows you could set this to use gsview, if it is installed, -e.g., - - $lpr = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p'; - -If gsview is installed in a different directory, you will need to make -the appropriate change. Note the double quotes around the name: this -is necessary because one part of the command name ("Program Files") -contains a space which would otherwise be misinterpreted. - -.TP -.B $makeindex ["makeindex %O -o %D %S"] -The index processing program. -.TP -.B $max_repeat [5] -The maximum number of times \fIlatexmk\fR will run latex/pdflatex -before deciding that there may be an infinite loop and that it needs -to bail out, rather than rerunning latex/pdflatex again to resolve -cross-references, etc. The default value covers all normal cases. - -(Note that the "etc" covers a lot of cases where one run of -latex/pdflatex generates files to be read in on a later run.) -.TP -.B $new_viewer_always [0] -This variable applies to \fIlatexmk\fR \fBonly\fR in -continuous-preview mode. If \fI$new_viewer_always\fR is 0, -\fIlatexmk\fR will check for a previously running previewer on the -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 $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 pdflatex. -If equal to 2, generate a pdf version of the document from the ps -file, by using the command specified by the \fI$ps2pdf\fR variable. -If equal to 3, generate a pdf version of the document from the dvi -file, by using the command specified by the \fI$dvipdf\fR variable. - -Equivalent to the \fB-pdf-\fR, \fB-pdf\fR, \fB-pdfdvi\fR, -\fB-pdfps\fR options. -.TP -.B $pdflatex ["pdflatex %O %S"] -The LaTeX processing program in the version that makes a pdf file instead -of a dvi file. -.TP -.B %pdflatex_input_extensions -This variable specifies the extensions tried by latexmk when it finds -that a pdfLaTeX run resulted in an error that a file has not been found, -and the file is given without an extension. This typically happens when -LaTeX commands of the form \input{file} or \includegraphics{figure}, -when the relevant source file does not exist. - -In this situation, latexmk searches for custom dependencies to make -the missing file(s), but restricts it to the extensions specified by -the variable %pdflatex_input_extensions. The default extensions are -'tex', 'pdf', 'jpg, and 'png'. - -(For Perl experts: %pdflatex_input_extensions is a hash whose keys are -the extensions. The values are irrelevant.) Two subroutines are -provided for manipulating this and the related variable -%latex_input_extensions, add_input_ext and remove_input_ext. They -are used as in the following examples are possible lines in an -initialization file: - - remove_input_ext( 'pdflatex', 'tex' ); - -removes the extension 'tex' from pdflatex_input_extensions - - add_input_ext( 'pdflatex', 'asdf' ); - -add the extension 'asdf to pdflatex_input_extensions. (Naturally with -such an extension, you should have made an appropriate custom -dependency for latexmk, and should also have done the appropriate -programming in the LaTeX source file to enable the file to be read. -The standard extensions are handled by pdflatex and its graphics/graphicx -packages.) - -.TP -.B $pdflatex_silent_switch ["-interaction=batchmode"] -Switch(es) for the pdflatex program (specified in the variable -\fI$pdflatex\fR when silent mode is on. -Under MS-Windows, the default value is changed to -"-interaction=batchmode -c-style-errors", as used by MikTeX and fpTeX. -.TP -.B $pdf_previewer ["start acroread %O %S"] -The command to invoke a pdf-previewer. -[Default is changed to "start" on MS-WINDOWS; under more recent versions of -Windows, this will cause to be run whatever command the system has -associated with .pdf files.] - -\fBWARNING\fR: Potential problem under MS-Windows: -if acroread is used as the pdf previewer, and it is -actually viewing a pdf file, the pdf file cannot be updated. Thus -makes acroread a bad choice of previewer if you use \fIlatexmk\fR's -previous-continuous mode (option \fB-pvc\fR) under MS-windows. -This problem does not occur if ghostview, gv or gsview is used to -view pdf files. -.TP -.B $pdf_update_command [""] -When the pdf previewer is set to be updated by running a command, this -is the command that is run. See the information for the variable -\fI$pdf_update_method\fR. -.TP -.B $pdf_update_method [1 under UNIX, 3 under MS-Windows] -How the pdf viewer updates its display when the pdf file has -changed. See the information on the variable \fI$dvi_update_method\fR -for the codes. (Note that information needs be changed slightly so -that for the value 4, to run a command to do the update, the command -is specified by the variable \fI$pdf_update_command\fR, and for the -value 2, to specify update by signal, the signal is specified by -\fI$pdf_update_signal\fR.) - -Note that acroread under MS-Windows (but not UNIX) locks the pdf file, so -the default value is then 3. - -Arranging to use a command to get a previewer explicitly updated -requires three variables to be set. For example: - - $pdf_previewer = "start xpdf -remote %R %O %S"; - $pdf_update_method = 4; - $pdf_update_command = "xpdf -remote %R -reload"; - -The first setting arranges for the xpdf program to be used in its -"remote server mode", with the server name specified as the rootname -of the TeX file. The second setting arranges for updating to be done -in response to a command, and the third setting sets the update command. - -.TP -.B $pdf_update_signal [Under UNIX: SIGHUP, which is a system-dependent value] -The number of the signal that is sent to the pdf viewer when it is -updated by sending a signal -- see the information on the variable -\fI$pdf_update_method\fR. The default value is the one appropriate -for gv on a UNIX system. -.TP -.B $pid_position[1 under UNIX, -1 under MS-Windows] -The variable \fI$pid_position\fR is used to -specify which word in lines of the output from \fI$pscmd\fR -corresponds to the process ID. The first word in the line is numbered -0. The default value of 1 (2nd word in line) is correct for Solaris -2.6 and Linux. Setting the variable to -1 is used to indicate that -\fI$pscmd\fR is not to be used. -.TP -.B $postscript_mode [0] -If nonzero, generate a postscript version of the document. -Equivalent to the \fB-ps\fR option. -.PP -If some other request is made for which a postscript file is needed, -then $postscript_mode will be set to 1. -.TP -.B $preview_continuous_mode [0] -If nonzero, run a previewer to view the document, and -continue running \fIlatexmk\fR to keep .dvi up-to-date. Equivalent to -the \fB-pvc\fR option. -Which previewer is run depends on the other settings, see the command -line options \fB-view=\fR, and the variable \fI$view\fR. -.TP -.B $preview_mode [0] -If nonzero, run a previewer to preview the document. -Equivalent to the \fB-pv\fR option. -Which previewer is run depends on the other settings, see the command -line options \fB-view=\fR, and the variable \fI$view\fR. -.TP -.B $printout_mode [0] -If nonzero, print the document using \fIlpr\fR. Equivalent to the -\fB-p\fR option. This is recommended \fBnot\fR to be set from an RC -file, otherwise you could waste lots of paper. -.TP -.B $print_type = ["ps"] -Type of file to printout: possibilities are "dvi", "none", "pdf", or "ps". -.TP -.B $pscmd -Command used to get all the processes currently run by the user. The --pvc option uses the command specified by the variable \fI$pscmd\fR to -determine if there is an already running previewer, and to find the -process ID (needed if \fIlatexmk\fR needs to signal the previewer -about file changes). - -Each line of the output of this command is assumed to correspond to -one process. See the \fI$pid_position\fR variable for how the process -number is determined. - -The default for \fIpscmd\fR is "NONE" under MS-Windows and cygwin -(i.e., the command is not used), "ps --width 200 -f -u $ENV{USER}" -under linux, "ps -ww -u $ENV{USER}" under darwin (Macintosh OS-X), and -"ps -f -u $ENV{USER}" under other operating systems (including other -flavors of UNIX). In these specifications "$ENV{USER}" is substituted -by the username. -.TP -.B $ps2pdf ["ps2pdf %O %S %D"] -Command to convert ps to pdf file. -.TP -.B $ps_filter [empty] -The postscript file filter to be run on the newly produced postscript -file before other processing. Equivalent to specifying the \fB-pF\fR -option. -.TP -.B $ps_previewer ["start gv %O %S", but \(dqstart %O %S" under MS-WINDOWS] -The command to invoke a ps-previewer. (The default under MS-WINDOWS -will cause to be run whatever command the system has associated -with .ps files.) - -Note that gv could be used with the -watch option updates its display -whenever the postscript file changes, whereas ghostview does not. -However, different versions of gv have slightly different ways of -writing this option. You can configure this variable apppropriately. - -\fBWARNING\fR: Linux systems may have installed one (or more) versions -of gv under different names, e.g., ggv, kghostview, etc, but perhaps -not one called gv. -.TP -.B $ps_previewer_landscape ["start gv -swap %O %S", but \(dqstart %O %S" under MS-WINDOWS] -The command to invoke a ps-previewer in landscape mode. -.TP -.B $ps_update_command [""] -When the postscript previewer is set to be updated by running a command, this -is the command that is run. See the information for the variable -\fI$ps_update_method\fR. -.TP -.B $ps_update_method [0 under UNIX, 1 under MS-Windows] -How the postscript viewer updates its display when the ps file has -changed. See the information on the variable \fI$dvi_update_method\fR -for the codes. (Note that information needs be changed slightly so -that for the value 4, to run a command to do the update, the command -is specified by the variable \fI$ps_update_command\fR, and for the -value 2, to specify update by signal, the signal is specified by -\fI$ps_update_signal\fR.) - -.TP -.B $ps_update_signal [Under UNIX: SIGHUP, which is a system-dependent value] -The number of the signal that is sent to the pdf viewer when it is -updated by sending a signal -- see \fI$ps_update_method\fR. The -default value is the one appropriate for gv on a UNIX system. -.TP -.B $quote_filenames [1] -This specifies whether substitutions for placeholders in command -specifications (as in \fI$pdflatex\fR) are surrounded by double -quotes. If this variable is 1 (or any other value Perl regards as -true), then quoting is done. Otherwise quoting is omitted. -.PP -The quoting method used by latexmk is tested to work correctly under -UNIX systems (including Linux and Mac OS-X) and under MS-Windows. It -allows the use of filenames containing special characters, notably -spaces. (But note that many versions of LaTeX and PdfLaTeX cannot -correctly deal with TeX files whose names contain spaces. Latexmk's -quoting only ensures that such filenames are correctly treated by the -operating system in passing arguments to programs.) -.TP -.B $sleep_time [2] -The time to sleep (in seconds) between checking for source file -changes when running the \fB-pvc\fR option. -.TP -.B $texfile_search [""] -This is an obsolete variable, replaced by the \fI@default_files\fR -variable. - -For backward compatibility, if you choose to set -\fI$texfile_search\fR, it is a string of space-separated filenames, and -then \fIlatexmk\fR replaces \fI@default_files\fR with the filenames in -\fI$texfile_search\fR to which is added "*.tex". -.TP -.B $tmpdir [See below for default] -Directory to store temporary files that \fIlatexmk\fR may generate while -running. - -The default under MSWindows (including cygwin), is to set -\fI$tmpdir\fR to the value of the first of whichever of the system -environment variables TMPDIR or TEMP exists, otherwise to the current -directory. Under other operating systems (expected to be UNIX/Linux, -including OS-X), the default is the value of the system environment -variable TMPDIR if it exists, otherwise "/tmp". -.TP -.B $view ["default"] -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). - -.SH CUSTOM DEPENDENCIES -.PP -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 \fIlatexmk\fR to convert a \fI.fig\fR file to -\fI.eps\fR to be included in the \fI.tex\fR file. - -The old method of configuring \fIlatexmk\fR was to directly manipulate -the \fB@cus_dep_list\fR array that contains information defining the -custom dependencies. This method still works. But now there are -subroutines that allow convenient manipulations of the custom -dependency list. These are - - add_cus_dep( fromextension, toextension, must, subroutine ) - remove_cus_dep( fromextension, toextension ) - show_cus_dep() - -The custom dependency is a list of rules, each of which is specified -as follow: -.TP -.B from extension: -The extension of the file we are converting from (e.g. "fig"). -It is specified without a period. -.TP -.B to extension: -The extension of the file we are converting to (e.g. "eps"). -It is specified without a period. -.TP -.B must: -If non-zero, the file from which we are converting \fBmust\fR exist, if it -doesn't exist \fIlatexmk\fR will give an error message and exit unless -the \fB-f\fR option is specified. If \fImust\fR is zero and the file -we are converting from doesn't exist, then no action is taken. -.TP -.B function: -The name of the subroutine that \fIlatexmk\fR 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 \fIPerl\fR. The function should return 0 if -it was successful and a nonzero number if it failed. -.PP -It is invoked whenever \fIlatexmk\fR detects that a run of -latex/pdflatex needs to read a file, like a graphics file, whose -extension is the to-extension of a custom dependency. Then -\fIlatexmk\fR examines whether a file exists with the same name, but -with the corresponding from-extension, as specified in the -custom-dependency rule. If it does, then whenever the destination -file (the one with the to-extension) is out-of-date with respect to -the corresponding source file. - -To make the new destination file, the \fIPerl\fR 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 \fIPerl\fR programming language. Of -course, experts could do something much more elaborate. - -One other item in each custom-dependency rule labelled "must" above -specifies how the rule should be applied when the source file fails to -exist. - -A simple and typical example of code in an initialization rcfile is - - add_cus_dep( 'fig', 'eps', 0, 'fig2eps' ); - sub fig2eps { - system("fig2dev -Leps $_[0].fig $_[0].eps"); - } - -The first line adds a custom dependency that converts a file with -extension "fig", as created by the xfig program, to an encapsulated -postscript file, with extension "eps". The remaining lines define a -subroutine that carries out the conversion. If a rule for converting -"fig" to "eps" files already exists (e.g., from a previously read-in -initialization file), the \fIlatexmk\fR will delete this rule before -making the new one. - -Suppose \fIlatexmk\fR 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 \fIPerl\fR as $_[0]. In -the example above, the subroutine uses the \fIPerl\fR command system -to invoke the program fig2dev. The double quotes around the string -are a \fIPerl\fR idiom that signify that each string of the form of a -variable name, $_[0] in this case, is to be substituted by its value. - -If the return value of the subroutine is non-zero, then \fIlatexmk\fR -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 filenames with spaces in them, and if your LaTeX system and -all other relevant software correctly handle such filenames, then you -could put single quotes around filenames in the command line that is -executed: - - add_cus_dep( 'fig', 'eps', 0, 'fig2eps' ); - sub fig2eps { - system("fig2dev -Lps '$_[0].fig' '$_[0].eps'"); - } - -This causes the invocation of the \fIfig2dev\fR program to have quoted -filenames; it should therefore work with filenames containing spaces. -\fBHowever, not all software deals correctly with filenames that -contain spaces. Moreover, the rules, if any, for quoting filenames -vary between operating systems, command shells and individual pieces -of software, so this code may not always work.\fR - -If you use pdflatex instead of latex, then you will probably prefer to -convert your graphics files to pdf format, in which case you would -replace the above code in an initialization file by - - add_cus_dep( 'fig', 'pdf, 0, 'fig2pdf' ); - sub fig2pdf { - system("fig2dev -Lpdf $_[0].fig $_[0].pdf"); - } - -If you have some general custom dependencies defined in the system or -user initialization file, you may find that for a particular project -they are undesirable. So you might want to delete the unneeded ones. -For example, you remove any "fig" to "eps" rule by the line - - remove_cus_dep( 'fig', 'eps' ); - -If you have complicated sets of custom dependencies, you may want to -get a listing of the custom dependencies. This is done by using the -line - - show_cus_dep(); - -in an initialization file. - -Another example of a custom dependency overcomes a limitation of -\fIlatexmk\fR concerning index files. The only index-file conversion -built-in to \fIlatexmk\fR is from an ".idx" file written on one run of -latex/pdflatex to an ".ind" file to be read in on a subsequent run. -But with the index.sty package you can create extra indexes with -extensions that you configure. \fILatexmk\fR does not know how to -deduce the extensions from the information it has. But you can easily -write a custom dependency. For example if your latex file uses the -command "\\newindex{special}{ndx}{nnd}{Special index}" you will need to -convert files with the extension \fI.ndx\fR to \fI.nnd\fR. The -following lines in an initialization RC file will cause this to -happen: - - add_cus_dep('ndx', 'nnd', 0, 'makendx2nnd'); - sub makendx2nnd { - system("makeindex -o $_[0].nnd $_[0].ndx"); - } - -(You will need to modify this code if you use filenames -with spaces in them, to provide correct quoting of the filenames.) - -Those of you with experience with Makefiles, will undoubtedly be -concerned that the \fI.ndx\fR file is written during a run of -latex/pdflatex and is always later than the \fI.nnd\fR last read in. -Thus the \fI.nnd\fR appears to be perpetually out-of-date. This -situation, of circular dependencies, is endemic to latex, and -\fIlatexmk\fR in its current version works correctly with circular -dependencies. It examines the contents of the files (by use of an md5 -checksum), and only does a remake when the file contents have actually -changed. - -Of course if you choose to write random data to the \fI.nnd\fR (or and -\fI.aux\fR file, etc) that changes on each new run, then you will have -a problem. For real experts: See the \fI%hash_cal_ignore_pattern\fR -if you have to deal with such problems. - -Glossaries can be dealt with similarly. - -.SH OLD METHOD OF DEFINING CUSTOM DEPENDENCIES -In previous versions of \fIlatexmk\fR, the only method of defining -custom dependencies was to directly manipulate the table of custom -dependencies. This is contained in the \fB@cus_dep_list\fR array. It -is an array of strings, and each string in the array has four items in -it, each separated 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. -.PP -An example of the old method of defining custom dependencies is as -follows. It is the code in an RC file to ensure automatic conversion -of \fI.fig\fR files to \fI.eps\fR files: - - push @cus_dep_list, "fig eps 0 fig2eps"; - sub fig2eps { - system("fig2dev -Lps $_[0].fig $_[0].eps"); - } - -This method still works, and is equivalent to the earlier code using -the add_cus_dep subroutine, except that it doesn't delete any previous -custom-dependency for the same conversion. So the new method is -preferable. - -.SH SEE ALSO -latex(1), bibtex(1). -.SH BUGS -Sometimes a viewer (gv) tries to read an updated .ps or .pdf file -after its creation is started but before the file is complete. Work -around: manually refresh (or reopen) display. Or use one of the other -previewers and update methods. - -(The following isn't really a bug, but concerns features of previewers.) -Preview continuous mode only works perfectly with certain previewers: -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 \fIlatexmk\fR to use gsview -instead.) -.SH THANKS TO -Authors of previous versions. Many users with their feedback, and -especially -David Coppit (username david at node coppit.org) who made many useful -suggestions that contributed to version 3, and Herbert Schulz. -(Please note that the -e-mail addresses are not written in their standard form to avoid being -harvested by worms and viruses.) -.SH AUTHOR -Current version, by John Collins (username collins at node phys.psu.edu). -(Version 4.11). - -Released version can be obtained from CTAN: -<http://www.tug.org/tex-archive/support/latexmk/>, and from the -author's website <http://www.phys.psu.edu/~collins/software/latexmk/>. -.br -Modifications and enhancements by Evan McLean (Version 2.0) -.br -Original script called "go" by David J. Musliner (RCS Version 3.2) - -\" LocalWords: fR fIlatexmk dvi ps fILatexmk pdflatex bibtex makeindex fB pv -\" LocalWords: pvc fIgv xdvi gsview cygwin fdb TP tex bm bs fIlatex fIbibtex -\" LocalWords: gg regeneratable dep exts dF dviF dviselect fI fR's lpr pdfps -\" LocalWords: pdfdvi dvipdf pF psF psnup fIsome gv acroread xpdf rcfile cus -\" LocalWords: batchmode latexmkrc elatex basename texfile WinXP BIBINPUTS -\" LocalWords: kpsewhich BibTeX dtx dvipdfm dvips fpTeX MikTeX fBWARNING pid -\" LocalWords: pscmd fIlpr fBnot ENV OSX SIGHUP tmpdir MSWindows tmp eps dev -\" LocalWords: fImust fIperl Lps fIfig diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.pdf b/Master/texmf-dist/doc/support/latexmk/latexmk.pdf Binary files differindex f081e690501..4ae9600a47f 100644 --- a/Master/texmf-dist/doc/support/latexmk/latexmk.pdf +++ b/Master/texmf-dist/doc/support/latexmk/latexmk.pdf diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.txt b/Master/texmf-dist/doc/support/latexmk/latexmk.txt index 35636662e9d..152886527ae 100644 --- a/Master/texmf-dist/doc/support/latexmk/latexmk.txt +++ b/Master/texmf-dist/doc/support/latexmk/latexmk.txt @@ -14,50 +14,50 @@ DESCRIPTION and it issues the appropriate sequence of commands to generate a .dvi, .ps, .pdf and/or hardcopy version of the document. - By default latexmk will run the commands necessary to generate a + By default latexmk will run the commands necessary to generate a .dvi + file. - Latexmk can also be set to run continuously with a suitable previewer. - In that case the LaTeX program, etc, are rerun whenever one of the - source files is modified, and the previewer automatically updates the + Latexmk can also be set to run continuously with a suitable previewer. + In that case the LaTeX program, etc, are rerun whenever one of the + source files is modified, and the previewer automatically updates the on-screen view of the compiled document. - Latexmk determines which are the source files by examining the log + Latexmk determines which are the source files by examining the log file. When latexmk is run, it examines properties of the source files, - and if any have been changed since the last document generation, - latexmk will run the various LaTeX processing programs as necessary. - In particular, it will repeat the run of LaTeX (or pdflatex) often + and if any have been changed since the last document generation, + latexmk will run the various LaTeX processing programs as necessary. + In particular, it will repeat the run of LaTeX (or pdflatex) often enough to resolve all cross references; depending on the macro packages - used. With some macro packages and document classes, four, or even - more, runs may be needed. If necessary, latexmk will also run bibtex - and/or makeindex. In addition, latexmk can be configured to generate + used. With some macro packages and document classes, four, or even + more, runs may be needed. If necessary, latexmk will also run bibtex + and/or makeindex. In addition, latexmk can be configured to generate other necessary files. For example, from an updated figure file it can - automatically generate a file in encapsulated postscript or another + automatically generate a file in encapsulated postscript or another suitable format for reading by LaTeX. - Latexmk has two different previewing options. In the simple -pv - option, a dvi, postscript or pdf previewer is automatically run after - generating the dvi, postscript or pdf version of the document. The - type of file to view is selected according to configuration settings + Latexmk has two different previewing options. In the simple -pv + option, a dvi, postscript or pdf previewer is automatically run after + generating the dvi, postscript or pdf version of the document. The + type of file to view is selected according to configuration settings and command line options. - The second previewing option is the powerful -pvc option (mnemonic: + The second previewing option is the powerful -pvc option (mnemonic: "preview continuously"). In this case, latexmk runs continuously, reg- - ularly monitoring all the source files to see if any have changed. - Every time a change is detected, latexmk runs all the programs neces- + ularly monitoring all the source files to see if any have changed. + Every time a change is detected, latexmk runs all the programs neces- sary to generate a new version of the document. A good previewer (like gv) will then automatically update its display. Thus the user can sim- ply edit a file and, when the changes are written to disk, latexmk com- - pletely automates the cycle of updating the .dvi (and possibly the .ps + pletely automates the cycle of updating the .dvi (and possibly the .ps and .pdf) file, and refreshing the previewer's display. It's not quite WYSIWYG, but usefully close. - For other previewers, the user may have to manually make the previewer - update its display, which can be (some versions of xdvi and gsview) as + For other previewers, the user may have to manually make the previewer + update its display, which can be (some versions of xdvi and gsview) as simple as forcing a redraw of its display. - Latexmk has the ability to print a banner in gray diagonally across - each page when making the postscript file. It can also, if needed, - call an external program to do other postprocessing on the generated + Latexmk has the ability to print a banner in gray diagonally across + each page when making the postscript file. It can also, if needed, @@ -70,64 +70,64 @@ DESCRIPTION LATEXMK(1L) LATEXMK(1L) + call an external program to do other postprocessing on the generated files. - Latexmk is highly configurable, both from the command line and in con- - figuration files, so that it can accommodate a wide variety of user - needs and system configurations. Default values are set according to + Latexmk is highly configurable, both from the command line and in con- + figuration files, so that it can accommodate a wide variety of user + needs and system configurations. Default values are set according to the operating system, so latexmk often works without special configura- - tion on MS-Windows, cygwin, Linux, OS-X, and other UNIX systems + tion on MS-Windows, cygwin, Linux, OS-X, and other UNIX systems (notably Solaris). - A very annoying complication handled very reliably by Latexmk, is that - LaTeX is a multiple pass system. On each run, LaTeX reads in informa- + A very annoying complication handled very reliably by Latexmk, is that + LaTeX is a multiple pass system. On each run, LaTeX reads in informa- tion generated on a previous run, for things like cross referencing and - indexing. In the simplest cases, a second run of LaTeX suffices, and - often the log file contains a message about the need for another pass. - However, there is a wide variety of add-on macro packages to LaTeX, - with a variety of behaviors. The result is to break simple-minded - determinations of how many runs are needed and of which programs. In + indexing. In the simplest cases, a second run of LaTeX suffices, and + often the log file contains a message about the need for another pass. + However, there is a wide variety of add-on macro packages to LaTeX, + with a variety of behaviors. The result is to break simple-minded + determinations of how many runs are needed and of which programs. In its new version, latexmk has a highly general and efficient solution to these issues. The solution involves retaining between runs information - on the source files, and a symptom is that latexmk generates an extra + on the source files, and a symptom is that latexmk generates an extra file (with extension .fdb_latexmk, by default) that contains the source file information. LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE - (All options can be introduced by single or double "-" characters, + (All options can be introduced by single or double "-" characters, e.g., "latexmk -help" or "latexmk --help".) - file One or more files can be specified. If no files are specified, - latexmk will, by default, run on all files in the current work- - ing directory with a ".tex" extension. This behavior can be + file One or more files can be specified. If no files are specified, + latexmk will, by default, run on all files in the current work- + ing directory with a ".tex" extension. This behavior can be changed: see the description concerning the @default_files vari- - able in the section "List of configuration variables usable in + able in the section "List of configuration variables usable in initialization files". - If a file is specified without an extension, then the ".tex" extension + If a file is specified without an extension, then the ".tex" extension is automatically added, just as LaTeX does. Thus, if you specify: latexmk foo then latexmk will operate on the file "foo.tex". - -bm <message> - A banner message to print diagonally across each page when con- - verting the dvi file to postscript. The message must be a sin- - gle argument on the command line so be careful with quoting - spaces and such. + -bibtex + When the source file uses bbl files for bibliography, run bibtex + as needed to regenerate the bbl files. - Note that if the -bm option is specified, the -ps option is - assumed. + This property can also be configured by setting the $bibtex_use + variable to 2 in a configuration file - -bi <intensity> - How dark to print the banner message. A decimal number between - 0 and 1. 0 is black and 1 is white. The default is 0.95, which + -bibtex- + Never run bibtex. + A common use for this option is when a document comes from an - 24 November 2009 2 + + 13 January 2010 2 @@ -136,13 +136,49 @@ LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE LATEXMK(1L) LATEXMK(1L) + external source, complete with its bbl file(s), and the user + does not have the corresponding bib files available. In this + situation use of the -bibtex- option will prevent latexmk from + trying to run bibtex, which would result in overwriting of the + bbl files. + + -bibtex-cond + When the source file uses bbl file(s) for the bibliography, run + bibtex as needed to regenerate the bbl files, but only if the + relevant bib file(s) exist. Thus when the bib files are not + available, bibtex is not run, thereby avoiding overwriting of + the bbl file(s). This is the default setting. + + (Note that it is possible for latexmk to decide that the bib + file does not exist, even though the bib file does exist and + bibtex finds it. The problem is that the bib file may not be in + the current directory but in some search path; the places + latexmk and bibtex cause to be searched need not be identical. + On modern installations of TeX and related programs this problem + should not arise, since latexmk uses the kpsewhich program to do + the search, and kpsewhich should use the same search path as + bibtex. If this problem arises, use the -bibtex option when + invoking latexmk.) + + -bm <message> + A banner message to print diagonally across each page when con- + verting the dvi file to postscript. The message must be a sin- + gle argument on the command line so be careful with quoting + spaces and such. + + Note that if the -bm option is specified, the -ps option is + assumed. + + -bi <intensity> + How dark to print the banner message. A decimal number between + 0 and 1. 0 is black and 1 is white. The default is 0.95, which is OK unless your toner cartridge is getting low. -bs <scale> - A decimal number that specifies how large the banner message - will be printed. Experimentation is necessary to get the right - scale for your message, as a rule of thumb the scale should be - about equal to 1100 divided by the number of characters in the + A decimal number that specifies how large the banner message + will be printed. Experimentation is necessary to get the right + scale for your message, as a rule of thumb the scale should be + about equal to 1100 divided by the number of characters in the message. The default is 220.0 which is just right for 5 charac- ter messages. @@ -152,15 +188,30 @@ LATEXMK(1L) LATEXMK(1L) -c Clean up (remove) all regeneratable files generated by latex and bibtex except dvi, postscript and pdf. These files are a combi- - nation of log files, aux files, latexmk's database file of - source file information, and those with extensions specified in - the @generated_exts configuration variable. In addition, files - with extensions by the $clean_ext configuration variable are + nation of log files, aux files, latexmk's database file of + source file information, and those with extensions specified in + + + + 13 January 2010 3 + + + + + +LATEXMK(1L) LATEXMK(1L) + + + the @generated_exts configuration variable. In addition, files + with extensions by the $clean_ext configuration variable are removed. - This cleanup is instead of a regular make. See the -gg option + This cleanup is instead of a regular make. See the -gg option if you want to do a cleanup then a make. + If $bibtex_use is set to 0 or 1, bbl files are counted as non- + regeneratable. + -C Clean up (remove) all regeneratable files generated by latex and bibtex. This is the same as the -c option with the addition of dvi, postscript and pdf files, and those with extensions in the @@ -169,12 +220,18 @@ LATEXMK(1L) LATEXMK(1L) This cleanup is instead of a regular make. See the -gg option if you want to do a cleanup than a make. + If $bibtex_use is set to 0 or 1, bbl files are counted as non- + regeneratable. + -CA Clean up (remove) absolutely all regeneratable files. It is now equivalent to the -C option - This cleanup is instead of a regular make. See the -gg option + This cleanup is instead of a regular make. See the -gg option if you want to do a cleanup then a make. + If $bibtex_use is set to 0 or 1, bbl files are counted as non- + regeneratable. + -CF Remove the file containing the database of source file informa- tion, before doing the other actions requested. @@ -191,26 +248,25 @@ LATEXMK(1L) LATEXMK(1L) -dF Dvi file filtering. The argument to this option is a filter which will generate a filtered dvi file with the extension + ".dviF". All extra processing (e.g. conversion to postscript, + preview, printing) will then be performed on this filtered dvi + file. + Example usage: To use dviselect to select only the even pages of + the dvi file: - - 24 November 2009 3 + latexmk -dF 'dviselect even' foo.tex + 13 January 2010 4 -LATEXMK(1L) LATEXMK(1L) - ".dviF". All extra processing (e.g. conversion to postscript, - preview, printing) will then be performed on this filtered dvi - file. - Example usage: To use dviselect to select only the even pages of - the dvi file: +LATEXMK(1L) LATEXMK(1L) - latexmk -dF 'dviselect even' foo.tex -diagnostics Print detailed diagnostics during a run. This may help for @@ -258,26 +314,25 @@ LATEXMK(1L) LATEXMK(1L) cmd.exe or command.com or 4nt.exe. For MS-Windows with these command shells you could use + latexmk -e "$latex=q/latex %O -shell-escape %S/" file.tex + or + latexmk -e "$latex='latex %O -shell-escape %S'" file.tex - 24 November 2009 4 + The last two examples will NOT work with UNIX/LINUX command + shells. + 13 January 2010 5 -LATEXMK(1L) LATEXMK(1L) - latexmk -e "$latex=q/latex %O -shell-escape %S/" file.tex - or - - latexmk -e "$latex='latex %O -shell-escape %S'" file.tex +LATEXMK(1L) LATEXMK(1L) - The last two examples will NOT work with UNIX/LINUX command - shells. -f Force latexmk to continue document processing despite errors. Normally, when latexmk detects that LaTeX or another program has @@ -324,12 +379,19 @@ LATEXMK(1L) LATEXMK(1L) normal behavior that in preview-continuous mode it checks for an already-running previewer. - -p Print out the document. By default it is the generated - postscript file that is printed. But you can use the -print=... + -nobibtex + Never run bibtex. + A common use for this option is when a document comes from an + external source, complete with its bbl file(s), and the user + does not have the corresponding bib files available. In this + situation use of the -nobibtex option will prevent latexmk from + trying to run bibtex, which would result in overwriting of the + bbl files. - 24 November 2009 5 + + 13 January 2010 6 @@ -338,18 +400,20 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - option to print the dvi or pdf files instead, and you can con- + -p Print out the document. By default it is the generated + postscript file that is printed. But you can use the -print=... + option to print the dvi or pdf files instead, and you can con- figure this in a start up file (by setting the $print_type vari- able). - However, printing is enabled by default only under UNIX/LINUX - systems, where the default is to use the lpr command. In gen- - eral, the correct behavior for printing very much depends on - your system's software. In particular, under MS-Windows you - must have suitable program(s) available, and you must have con- - figured the print commands used by latexmk. This can be non- - trivial. See the documentation on the $lpr, $lpr_dvi, and - $lpr_pdf configuration variables to see how to set the commands + However, printing is enabled by default only under UNIX/LINUX + systems, where the default is to use the lpr command. In gen- + eral, the correct behavior for printing very much depends on + your system's software. In particular, under MS-Windows you + must have suitable program(s) available, and you must have con- + figured the print commands used by latexmk. This can be non- + trivial. See the documentation on the $lpr, $lpr_dvi, and + $lpr_pdf configuration variables to see how to set the commands for printing. This option is incompatible with the -pv and -pvc options, so it @@ -358,31 +422,31 @@ LATEXMK(1L) LATEXMK(1L) -pdf Generate pdf version of document using pdflatex. -pdfdvi - Generate pdf version of document from the dvi file, by default + Generate pdf version of document from the dvi file, by default using dvipdf. - -pdfps Generate pdf version of document from the ps file, by default + -pdfps Generate pdf version of document from the ps file, by default using ps2pdf. - -pdf- Turn off generation of pdf version of document. (This can be - used to override a setting in a configuration file. It may get + -pdf- Turn off generation of pdf version of document. (This can be + used to override a setting in a configuration file. It may get overridden if some other option requires the generation of a pdf file.) -print=dvi, -print=ps, -print=pdf - Define which kind of file is printed. This option also ensures - that the requisite file is made, and turns on printing. The + Define which kind of file is printed. This option also ensures + that the requisite file is made, and turns on printing. The default is to print a postscript file. -ps Generate postscript version of document. -ps- Turn off generation of postscript version of document. This can - be used to override a setting in a configuration file. (It may - get overridden by some other option that requires a postscript + be used to override a setting in a configuration file. (It may + get overridden by some other option that requires a postscript file, for example a request for printing.) - -pF Postscript file filtering. The argument to this option is a - filter which will generate a filtered postscript file with the + -pF Postscript file filtering. The argument to this option is a + filter which will generate a filtered postscript file with the extension ".psF". All extra processing (e.g. preview, printing) will then be performed on this filtered postscript file. @@ -390,117 +454,118 @@ LATEXMK(1L) LATEXMK(1L) latexmk -ps -pF 'psnup -2' foo.tex - or - latexmk -ps -pF "psnup -2" foo.tex + 13 January 2010 7 - 24 November 2009 6 +LATEXMK(1L) LATEXMK(1L) -LATEXMK(1L) LATEXMK(1L) + or + latexmk -ps -pF "psnup -2" foo.tex Whether to use single or double quotes round the "psnup -2" will - depend on your command interpreter, as used by the particular + depend on your command interpreter, as used by the particular version of perl and the operating system on your computer. - -pv Run file previewer. If the -view option is used, this will - select the kind of file to be previewed (dvi, ps or pdf). Oth- - erwise the viewer views the "highest" kind of file selected, by - the -dvi, -ps, -pdf, -pdfps options, in the order dvi, ps, pdf - (low to high). If no file type has been selected, the dvi pre- - viewer will be used. This option is incompatible with the -p + -pv Run file previewer. If the -view option is used, this will + select the kind of file to be previewed (dvi, ps or pdf). Oth- + erwise the viewer views the "highest" kind of file selected, by + the -dvi, -ps, -pdf, -pdfps options, in the order dvi, ps, pdf + (low to high). If no file type has been selected, the dvi pre- + viewer will be used. This option is incompatible with the -p and -pvc options, so it turns them off. -pv- Turn off -pv. - -pvc Run a file previewer and continually update the .dvi, .ps, + -pvc Run a file previewer and continually update the .dvi, .ps, and/or .pdf files whenever changes are made to source files (see - the Description above). Which of these files is generated and - which is viewed is governed by the other options, and is the - same as for the -pv option. The preview-continuous option -pvc - can only work with one file. So in this case you will normally - only specify one filename on the command line. It is also - incompatible with the -p and -pv options, so it turns these + the Description above). Which of these files is generated and + which is viewed is governed by the other options, and is the + same as for the -pv option. The preview-continuous option -pvc + can only work with one file. So in this case you will normally + only specify one filename on the command line. It is also + incompatible with the -p and -pv options, so it turns these options off With a good previewer the display will be automatically updated. - (Under some but not all versions of UNIX/Linux "gv -watch" does - this for postscript files; this can be set by a configuration - variable. This would also work for pdf files except for an - apparent bug in gv that causes an error when the newly updated - pdf file is read.) Many other previewers will need a manual + (Under some but not all versions of UNIX/Linux "gv -watch" does + this for postscript files; this can be set by a configuration + variable. This would also work for pdf files except for an + apparent bug in gv that causes an error when the newly updated + pdf file is read.) Many other previewers will need a manual update. Important note: the acroread program on MS-Windows locks the pdf - file, and prevents new versions being written, so it is a bad - idea to use acroread to view pdf files in preview-continuous - mode. It is better to use a dvi or ps viewer, as set by one of + 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 dvi or ps viewer, as set by one of the -view=dvi and -view=ps options. - There are some other methods for arranging an update, notably - useful for many versions of xdvi and xpdf. These are best set + There are some other methods for arranging an update, notably + useful for many versions of xdvi and xpdf. These are best set in latexmk's configuration; see below. - Note that if latexmk dies or is stopped by the user, the + Note that if latexmk dies or is stopped by the user, the "forked" previewer will continue to run. Successive invocations - with the -pvc option will not fork new previewers, but latexmk - will normally use the existing previewer. (At least this will - happen when latexmk is running under an operating system where - it knows how to determine whether an existing previewer is run- + 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.) - -pvc- Turn off -pvc. - -quiet Same as -silent - -r <rcfile> - Read the specified initialization file ("RC file") before pro- - cessing. + 13 January 2010 8 - 24 November 2009 7 +LATEXMK(1L) LATEXMK(1L) -LATEXMK(1L) LATEXMK(1L) + -pvc- Turn off -pvc. + + -quiet Same as -silent + -r <rcfile> + Read the specified initialization file ("RC file") before pro- + cessing. Be careful about the ordering: (1) Standard initialization files - -- see the section below on "Configuration/initialization (RC) - files" -- are read first. (2) Then the options on the command - line are acted on in the order they are given. Therefore if an - initialization file is specified by the -r option, it is read - during this second step. Thus an initialization file specified + -- see the section below on "Configuration/initialization (RC) + files" -- are read first. (2) Then the options on the command + line are acted on in the order they are given. Therefore if an + initialization file is specified by the -r option, it is read + during this second step. Thus an initialization file specified with the -r option can override both the standard initialization files and previously specified options. But all of these can be overridden by later options. The contents of the RC file just comprise a piece of code in the - Perl programming language (typically a sequence of assignment + Perl programming language (typically a sequence of assignment statements); they are executed when the -r option is encountered during latexmk's parsing of its command line. See the -e option - for a way of giving initialization code directly on latexmk's - command line. An error results in latexmk stopping. Multiple - instances of the -r and -e options can be used, and they are + for a way of giving initialization code directly on latexmk's + command line. An error results in latexmk stopping. Multiple + instances of the -r and -e options can be used, and they are executed in the order they appear on the command line. -silent Run commands silently, i.e., with options that reduce the amount - of diagnostics generated. For example, with the default set- - tings for commands under UNIX, the command "latex -interac- + of diagnostics generated. For example, with the default set- + tings for commands under UNIX, the command "latex -interac- tion=batchmode" is used for latex. - Also reduce the number of informational messages that latexmk + Also reduce the number of informational messages that latexmk generates. -v, -version @@ -514,28 +579,17 @@ LATEXMK(1L) LATEXMK(1L) the -pv or -pvc switches). The default is to view the "highest" kind of requested file (in the order dvi, ps, pdf). - The preview-continuous option -pvc can only work with one file. So in - this case you will normally only specify one filename on the command + The preview-continuous option -pvc can only work with one file. So in + this case you will normally only specify one filename on the command line. - Options -p, -pv and -pvc are mutually exclusive. So each of these + Options -p, -pv and -pvc are mutually exclusive. So each of these options turns the others off. -EXAMPLES - % latexmk thesis # run latex enough times to resolve - cross-references - - % latexmk -pvc -ps thesis# run latex enough times to resolve - cross-references, make a postscript - file, start a previewer. Then - watch for changes in the source - file thesis.tex and any files it - uses. After any changes rerun latex - - 24 November 2009 8 + 13 January 2010 9 @@ -544,6 +598,16 @@ EXAMPLES LATEXMK(1L) LATEXMK(1L) +EXAMPLES + % latexmk thesis # run latex enough times to resolve + cross-references + + % latexmk -pvc -ps thesis# run latex enough times to resolve + cross-references, make a postscript + file, start a previewer. Then + watch for changes in the source + file thesis.tex and any files it + uses. After any changes rerun latex the appropriate number of times and remake the postscript file. If latex encounters an error, latexmk will @@ -568,50 +632,50 @@ CONFIGURATION/INITIALIZATION (RC) FILES On a MS-WINDOWS system it looks for "C:\latexmk\LatexMk". 2) The user's RC file, "$HOME/.latexmkrc", if it exists. Here $HOME is - the value of the environment variable HOME. On UNIX and clones - (including LINUX), this variable is set by the system; on MS-Windows, + the value of the environment variable HOME. On UNIX and clones + (including LINUX), this variable is set by the system; on MS-Windows, the user may choose to set it. - 3) The RC file in the current working directory. This file can be - named either "latexmkrc" or ".latexmkrc", and the first of these to be + 3) The RC file in the current working directory. This file can be + named either "latexmkrc" or ".latexmkrc", and the first of these to be found is used, if any. 4) Any RC file(s) specified on the command line with the -r option. Each RC file is a sequence of Perl commands. Naturally, a user can use - this in creative ways. But for most purposes, one simply uses a - sequence of assignment statements that override some of the built-in - settings of Latexmk. Straightforward cases can be handled without - knowledge of the Perl language by using the examples in this document + this in creative ways. But for most purposes, one simply uses a + sequence of assignment statements that override some of the built-in + settings of Latexmk. Straightforward cases can be handled without + knowledge of the Perl language by using the examples in this document as templates. Comment lines are introduced by the "#" character. - Note that command line options are obeyed in the order in which they + Note that command line options are obeyed in the order in which they are written; thus any RC file specified on the command line with the -r - option can override previous options but can be itself overridden by - later options on the command line. There is also the -e option, which - allows initialization code to be specified in latexmk's command line. + option can override previous options but can be itself overridden by -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". Syntax for setting these variables is of the following forms: - $bibtex = 'bibtex %O %B'; + 13 January 2010 10 - for the setting of a string variable, - 24 November 2009 9 +LATEXMK(1L) LATEXMK(1L) + later options on the command line. There is also the -e option, which + allows initialization code to be specified in latexmk's command line. +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". Syntax for setting these variables is of the following forms: -LATEXMK(1L) LATEXMK(1L) + $bibtex = 'bibtex %O %B'; + for the setting of a string variable, $preview_mode = 1; @@ -619,164 +683,164 @@ LATEXMK(1L) LATEXMK(1L) @default_files = ('paper', 'paper1'); - for the setting of an array of strings. It is possible to append an + for the setting of an array of strings. It is possible to append an item to an array variable as follows: push @default_files, 'paper2'; - Note that simple "scalar" variables have names that begin with a $ + Note that simple "scalar" variables have names that begin with a $ character and array variables have names that begin with a @ character. Each statement ends with a semicolon. - Strings should be enclosed in single quotes. (You could use double - quotes, as in many programming languages. But then the Perl program- - ming language brings into play some special rules for interpolating - variables into strings. People not fluent in Perl will want to avoid + Strings should be enclosed in single quotes. (You could use double + quotes, as in many programming languages. But then the Perl program- + ming language brings into play some special rules for interpolating + variables into strings. People not fluent in Perl will want to avoid these complications.) - You can do much more complicated things, but for this you will need to + You can do much more complicated things, but for this you will need to consult a manual for the Perl programming language. FORMAT OF COMMAND SPECIFICATIONS - Some of the variables set the commands that latexmk uses for carrying - out its work, for example to generate a dvi file from a tex file or to + Some of the variables set the commands that latexmk uses for carrying + out its work, for example to generate a dvi file from a tex file or to view a postscript file. This section describes some important features of how the commands are specified. Placeholders: Supposed you wanted latexmk to use the command elatex in - place of the regular latex command, and suppose moreover that you - wanted to give it the option "--shell-escape". You could do this by + place of the regular latex command, and suppose moreover that you + wanted to give it the option "--shell-escape". You could do this by the following setting: $latex = 'elatex --shell-escape %O %S'; - The two items starting with the % character are placeholders. These - are substituted by appropriate values before the command is run. Thus - %S will be replaced by the source file that elatex will be applied to, - and %O will be replaced by any options that latexmk has decided to use - for this command. (E.g., if you used the -silent option it would - replace %O by "-interaction=batchmode".) + The two items starting with the % character are placeholders. These - The available placeholders are: - %B base of filename for current command. E.g., if a postscript - file document.ps is being made from the dvi file document.dvi, - then the basename is document. - %D destination file (e.g., the name of the postscript file when - converting a dvi file to postscript). + 13 January 2010 11 - %O options - 24 November 2009 10 +LATEXMK(1L) LATEXMK(1L) + are substituted by appropriate values before the command is run. Thus + %S will be replaced by the source file that elatex will be applied to, + and %O will be replaced by any options that latexmk has decided to use + for this command. (E.g., if you used the -silent option it would + replace %O by "-interaction=batchmode".) + The available placeholders are: + %B base of filename for current command. E.g., if a postscript + file document.ps is being made from the dvi file document.dvi, + then the basename is document. -LATEXMK(1L) LATEXMK(1L) + %D destination file (e.g., the name of the postscript file when + converting a dvi file to postscript). + %O options %R root filename. This is the base name for the main tex file. - %S source file (e.g., the name of the dvi file when converting a + %S source file (e.g., the name of the dvi file when converting a dvi file to ps). %T The name of the primary tex file. - If for some reason you need a literal % character in your string not - subject to the above rules, use a pair of these characters. Thus with - the command specification $ps_previewer = 'latex -ad=%%Sfile.ad %S', + If for some reason you need a literal % character in your string not + subject to the above rules, use a pair of these characters. Thus with + the command specification $ps_previewer = 'latex -ad=%%Sfile.ad %S', the %%S will become %S when the command is executed, but the %S will be - replaced by the source filename, which in this case would be the name + replaced by the source filename, which in this case would be the name of a postscript file to be viewed. - Appropriate quoting will be applied to the filename substitutions, so - you mustn't supply them yourself even if you the names of your have + Appropriate quoting will be applied to the filename substitutions, so + you mustn't supply them yourself even if you the names of your have spaces in them. (But if your TeX filenames have spaces in them, beware that many versions of the TeX program cannot correctly handle filenames - containing spaces.) In case latexmk's quoting does not work correctly - on your system, you can turn it off -- see the documentation for the + containing spaces.) In case latexmk's quoting does not work correctly + on your system, you can turn it off -- see the documentation for the variable $quote_filenames. - The distinction between %B and %R needs a bit of care, since they are - often the same, but not always. For example on a simple document, the + The distinction between %B and %R needs a bit of care, since they are + often the same, but not always. For example on a simple document, the basename of a bibtex run is the same as for the texfile. But in a doc- - ument with several bibliographies, the bibliography files will have a - variety of names. Since bibtex is invoked with the basename of the - bibliography file, the setting for the bibtex command should therefore + ument with several bibliographies, the bibliography files will have a + variety of names. Since bibtex is invoked with the basename of the + bibliography file, the setting for the bibtex command should therefore be $bibtex = 'bibtex %O %B'; - Generally, you should use %B rather than %R. Similarly for most pur- - poses, the name %T of the primary texfile is not a useful placeholder. + Generally, you should use %B rather than %R. Similarly for most pur- + poses, the name %T of the primary texfile is not a useful placeholder. - See the default values in the section "List of configuration variables - usable in initialization files" for what is normally the most appropri- - ate usage. + See the default values in the section "List of configuration variables + usable in initialization files" for what is normally the most - If you omit to supply any placeholders whatever in the specification of - 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 - for the command to run to completion. This is appropriate for commands - like latex, of course. But for previewers, the command should normally - run detached, so that latexmk gets the previewer running and then - returns to its next task (or exits if there is nothing else to do). To - achieve this effect of detaching a command, you need to precede the - command name with "start ", as in - $dvi_previewer = 'start xdvi %O %S'; + 13 January 2010 12 - This will be translated to whatever is appropriate for your operating - system. - Notes: (1) In some circumstances, latex will always run a command - 24 November 2009 11 +LATEXMK(1L) LATEXMK(1L) + appropriate usage. + If you omit to supply any placeholders whatever in the specification of + 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 + for the command to run to completion. This is appropriate for commands + like latex, of course. But for previewers, the command should normally + run detached, so that latexmk gets the previewer running and then + returns to its next task (or exits if there is nothing else to do). To + achieve this effect of detaching a command, you need to precede the + command name with "start ", as in -LATEXMK(1L) LATEXMK(1L) + $dvi_previewer = 'start xdvi %O %S'; + This will be translated to whatever is appropriate for your operating + system. + Notes: (1) In some circumstances, latex will always run a command detached. This is the case for a previewer in preview continuous mode, - since otherwise previewing continuously makes no sense. (2) This pre- - cludes the possibility of running a command named start. (3) If the - word start occurs more than once at the beginning of the command - string, that is equivalent to having just one. (4) Under cygwin, some - complications happen, since cygwin amounts to a complicated merging of - UNIX and MS-Windows. See the source code for how I've handled the + since otherwise previewing continuously makes no sense. (2) This pre- + cludes the possibility of running a command named start. (3) If the + word start occurs more than once at the beginning of the command + string, that is equivalent to having just one. (4) Under cygwin, some + complications happen, since cygwin amounts to a complicated merging of + UNIX and MS-Windows. See the source code for how I've handled the problem. Command names containing spaces: Under MS-Windows it is common that the name of a command includes spaces, since software is often installed in - a subdirectory of "C:Program Files". Such command names should be + a subdirectory of "C:Program Files". Such command names should be enclosed in double quotes, as in $lpr_pdf = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p %S'; - 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 $dvi_previewer = 'start %S'; Under recent versions of MS-Windows, this will cause to be run whatever - program the system has associated with dvi files. (The same applies + program the system has associated with dvi files. (The same applies for a postscript viewer and a pdf viewer.) Not using a certain command: If a command is not to be run, the command @@ -784,46 +848,45 @@ LATEXMK(1L) LATEXMK(1L) $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. + + + 13 January 2010 13 + + + + + +LATEXMK(1L) LATEXMK(1L) + + Options to commands: Setting the name of a command can be used not only for changing the name of the command called, but also to add options to - command. Suppose you want latexmk to use latex with source specials - enabled. Then you might use the following line in an initialization + command. Suppose you want latexmk to use latex with source specials + enabled. Then you might use the following line in an initialization file: $latex = 'latex --src-specials %O %S'; - Advanced tricks: Normally one specifies a single command for the com- - mands invoked by latexmk. Naturally, if there is some complicated + Advanced tricks: Normally one specifies a single command for the com- + mands invoked by latexmk. Naturally, if there is some complicated additional processing you need to do in your special situation, you can write a script (or batch file) to do the processing, and then configure latexmk to use your script in place of the standard program. It is also possible to configure latexmk to run multiple commands. For - example, if when running pdflatex to generate a pdf file from a tex - file you need to run another program after pdflatex to perform some + example, if when running pdflatex to generate a pdf file from a tex + file you need to run another program after pdflatex to perform some extra processing, you could do something like: - $pdflatex = 'pdflatex --shell-escape %O %S; pst2pdf_for_latexmk + $pdflatex = 'pdflatex --shell-escape %O %S; pst2pdf_for_latexmk %B'; - This definition assumes you are using a UNIX-like system, so that the - - - - 24 November 2009 12 - - - - - -LATEXMK(1L) LATEXMK(1L) - - - two commands to be run are separated by the semicolon in the middle of + This definition assumes you are using a UNIX-like system, so that the + two commands to be run are separated by the semicolon in the middle of the string. @@ -832,9 +895,9 @@ LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES Default values are indicated in brackets. $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 + If nonzero, the banner message is printed across each page when + converting the dvi file to postscript. Without modifying the + variable $banner_message, this is equivalent to specifying the -d option. Note that if $banner is nonzero, the $postscript_mode is assumed @@ -843,7 +906,7 @@ LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES $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. @@ -852,19 +915,31 @@ LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES 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 + + + + 13 January 2010 14 + + + + + +LATEXMK(1L) LATEXMK(1L) + + + scale for your message, as a rule of thumb the scale should be + about equal to 1100 divided by the number of characters in the + message. The Default is just right for 5 character messages. This is equivalent to the -bs option. @BIBINPUTS - This is an array variable, now mostly obsolete, that specifies - directories where latexmk should look for .bib files. By + This is an array variable, now mostly obsolete, that specifies + directories where latexmk should look for .bib files. By default it is set from the BIBINPUTS environment variable of the - operating system. If that environment variable is not set, a - single element list consisting of the current directory is set. + operating system. If that environment variable is not set, a + single element list consisting of the current directory is set. The format of the directory names depends on your operating sys- tem, of course. Examples for setting this variable are: @@ -874,36 +949,52 @@ LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES @BIBINPUTS = ( ".", "//server/bibfiles" ); @BIBINPUTS = ( ".", "/usr/local/texmf/bibtex/bib" ); - Note that under MS Windows, either a forward slash "/" or a - backward slash "\" can be used to separate pathname components, - so the first two and the second two examples are equivalent. - Each backward slash should be doubled to avoid running afoul of + Note that under MS Windows, either a forward slash "/" or a + backward slash "\" can be used to separate pathname components, + so the first two and the second two examples are equivalent. + Each backward slash should be doubled to avoid running afoul of Perl's rules for writing strings. - Important note: This variable is now mostly obsolete in the current + Important note: This variable is now mostly obsolete in the current + version of latexmk, since it has a better method of searching for files + using the kpsewhich command. However, if your system is an unusual one + without the kpsewhich command, you may need to set the variable @BIBIN- + PUTS. + $bibtex ["bibtex %O %S"] + The BibTeX processing program. + $bibtex_silent_switch ["-terse"] + Switch(es) for the BibTeX processing program when silent mode is + on. - 24 November 2009 13 + $bibtex_use [1] + Under what conditions to run BibTeX. When latexmk discovers + from the log file that one (or more) BibTeX-generated bibliogra- + phies are used, it can run BibTeX whenever 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 will result in incor- + rect overwriting of the precious bbl files. The variable $bib- + tex_use controls whether this happens. Its possible values are: + 0: never use BibTeX. 1: only use BibTeX if the bib files exist. + 2: run BibTeX whenever it appears necessary to update the bbl + files, without testing for the existence of the bib files. -LATEXMK(1L) LATEXMK(1L) + 13 January 2010 15 - version of latexmk, since it has a better method of searching for files - using the kpsewhich command. However, if your system is an unusual one - without the kpsewhich command, you may need to set the variable @BIBIN- - PUTS. - $bibtex ["bibtex %O %S"] - The BibTeX processing program. - $bibtex_silent_switch ["-terse"] - Switch(es) for the BibTeX processing program when silent mode is - on. + +LATEXMK(1L) LATEXMK(1L) + $cleanup_includes_generated [0] If nonzero, specifies that cleanup also deletes files that are @@ -952,25 +1043,26 @@ LATEXMK(1L) LATEXMK(1L) Three examples: + @default_files = ("paper_current"); + @default_files = ("paper1", "paper2.tex"); - 24 November 2009 14 + @default_files = ("*.tex", "*.dtx"); + Note that more than file may be given, and that the default + extension is ".tex". Wild cards are allowed. The parentheses + 13 January 2010 16 -LATEXMK(1L) LATEXMK(1L) - @default_files = ("paper_current"); - @default_files = ("paper1", "paper2.tex"); - @default_files = ("*.tex", "*.dtx"); +LATEXMK(1L) LATEXMK(1L) + - Note that more than file may be given, and that the default - extension is ".tex". Wild cards are allowed. The parentheses are because @default_files is an array variable, i.e., a sequence of filename specifications is possible. @@ -1022,20 +1114,21 @@ LATEXMK(1L) LATEXMK(1L) The program to used as a filter to convert a .dvi file to a .ps file in landscape mode. + $dvips_pdf_switch ["-P pdf"] + Switch(es) for dvips program when pdf file is to be generated + from ps file. - 24 November 2009 15 + 13 January 2010 17 -LATEXMK(1L) LATEXMK(1L) - $dvips_pdf_switch ["-P pdf"] - Switch(es) for dvips program when pdf file is to be generated - from ps file. +LATEXMK(1L) LATEXMK(1L) + $dvips_silent_switch ["-q"] Switch(es) for dvips program when silent mode is on. @@ -1091,10 +1184,11 @@ LATEXMK(1L) LATEXMK(1L) This list has two uses: (a) to set the kinds of file to be deleted in a cleanup operation (with the -c, -C, -CA, -g and -gg options), and (b) in the determination of whether a rerun of + (pdf)LaTeX is needed after a run that gives an error. - 24 November 2009 16 + 13 January 2010 18 @@ -1103,8 +1197,6 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - (pdf)LaTeX is needed after a run that gives an error. - (Normally, a change of a source file during a run should provoke a rerun. This includes a file generated by LaTeX, e.g., an aux file, that is read in on subsequent runs. But after a run that @@ -1164,7 +1256,7 @@ LATEXMK(1L) LATEXMK(1L) - 24 November 2009 17 + 13 January 2010 19 @@ -1174,43 +1266,44 @@ LATEXMK(1L) LATEXMK(1L) sufficient path information to be found directly. But some- - times, notably when the file, but not its path is known. The - program specified by $kpsewhich is used to find it. + times, notably when .bib files are found from the log file of a + bibtex run, the name of the file, but not its path is known. + The program specified by $kpsewhich is used to find it. - See also the @BIBINPUTS variable for another way that latexmk + See also the @BIBINPUTS variable for another way that latexmk also uses to try to locate files; it applies only in the case of .bib files. $landscape_mode [0] If nonzero, run in landscape mode, using the landscape mode pre- - viewers and dvi to postscript converters. Equivalent to the -l + viewers and dvi to postscript converters. Equivalent to the -l option. Normally not needed with current previewers. $latex ["latex %O %S"] The LaTeX processing program. Note that as with other programs, - you can use this variable not just to change the name of the + you can use this variable not just to change the name of the program used, but also specify options to the program. E.g., $latex = "latex --src-specials"; %latex_input_extensions - This variable specifies the extensions tried by latexmk when it - finds that a LaTeX run resulted in an error that a file has not - been found, and the file is given without an extension. This + This variable specifies the extensions tried by latexmk when it + finds that a LaTeX run resulted in an error that a file has not + been found, and the file is given without an extension. This typically happens when LaTeX commands of the form input{file} or - includegraphics{figure}, when the relevant source file does not + includegraphics{figure}, when the relevant source file does not exist. - In this situation, latexmk searches for custom dependencies to - make the missing file(s), but restricts it to the extensions - specified by the variable %latex_input_extensions. The default + In this situation, latexmk searches for custom dependencies to + make the missing file(s), but restricts it to the extensions + specified by the variable %latex_input_extensions. The default extensions are - (For Perl experts: %latex_input_extensions is a hash whose keys - are the extensions. The values are irrelevant.) Two subrou- - tines are provided for manipulating this and the related vari- - able %pdflatex_input_extensions, add_input_ext and - remove_input_ext. They are used as in the following examples + (For Perl experts: %latex_input_extensions is a hash whose keys + are the extensions. The values are irrelevant.) Two subrou- + tines are provided for manipulating this and the related vari- + able %pdflatex_input_extensions, add_input_ext and + remove_input_ext. They are used as in the following examples are possible lines in an initialization file: remove_input_ext( 'latex', 'tex' ); @@ -1219,22 +1312,21 @@ LATEXMK(1L) LATEXMK(1L) add_input_ext( 'latex', 'asdf' ); - add the extension 'asdf to latex_input_extensions. (Naturally + add the extension 'asdf to latex_input_extensions. (Naturally with such an extension, you should have made an appropriate cus- tom dependency for latexmk, and should also have done the appro- - priate programming in the LaTeX source file to enable the file - to be read. The standard extensions are handled by LaTeX and + priate programming in the LaTeX source file to enable the file + to be read. The standard extensions are handled by LaTeX and its graphics/graphicx packages. $latex_silent_switch ["-interaction=batchmode"] - Switch(es) for the LaTeX processing program when silent mode is - on. Under MS-Windows, the default value is changed to "-inter- - action=batchmode -c-style-errors", as used by MikTeX and fpTeX. + Switch(es) for the LaTeX processing program when silent mode is + on. Under MS-Windows, the default value is changed to - 24 November 2009 18 + 13 January 2010 20 @@ -1243,22 +1335,25 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) + "-interaction=batchmode -c-style-errors", as used by MikTeX and + fpTeX. + $lpr ["lpr %O %S" under UNIX/LINUX, "NONE lpr" under MS-WINDOWS] The command to print postscript files. - Under MS-Windows (unlike UNIX/LINUX), there is no standard pro- + Under MS-Windows (unlike UNIX/LINUX), there is no standard pro- gram for printing files. But there are ways you can do it. For example, if you have gsview installed, you could use it with the option "/p": $lpr = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p'; - If gsview is installed in a different directory, you will need - to make the appropriate change. Note the combination of single - and double quotes around the name. The single quotes specify - that this is a string to be assigned to the configuration vari- - able $lpr. The double quotes are part of the string passed to - the operating system to get the command obeyed; this is neces- + If gsview is installed in a different directory, you will need + to make the appropriate change. Note the combination of single + and double quotes around the name. The single quotes specify + that this is a string to be assigned to the configuration vari- + able $lpr. The double quotes are part of the string passed to + the operating system to get the command obeyed; this is neces- sary because one part of the command name ("Program Files") con- tains a space which would otherwise be misinterpreted. @@ -1268,13 +1363,13 @@ LATEXMK(1L) LATEXMK(1L) $lpr_pdf ["NONE lpr_pdf"] The printing program to print pdf files. - Under MS-Windows you could set this to use gsview, if it is + Under MS-Windows you could set this to use gsview, if it is installed, e.g., $lpr = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p'; - If gsview is installed in a different directory, you will need - to make the appropriate change. Note the double quotes around + If gsview is installed in a different directory, you will need + to make the appropriate change. Note the double quotes around the name: this is necessary because one part of the command name ("Program Files") contains a space which would otherwise be mis- interpreted. @@ -1284,27 +1379,24 @@ LATEXMK(1L) LATEXMK(1L) The index processing program. $max_repeat [5] - The maximum number of times latexmk will run latex/pdflatex - before deciding that there may be an infinite loop and that it + The maximum number of times latexmk will run latex/pdflatex + before deciding that there may be an infinite loop and that it needs to bail out, rather than rerunning latex/pdflatex again to - resolve cross-references, etc. The default value covers all + resolve cross-references, etc. The default value covers all normal cases. - (Note that the "etc" covers a lot of cases where one run of + (Note that the "etc" covers a lot of cases where one run of latex/pdflatex generates files to be read in on a later run.) $new_viewer_always [0] - This variable applies to latexmk only in continuous-preview + This variable applies to latexmk only in continuous-preview mode. If $new_viewer_always is 0, latexmk will check for a pre- - viously running previewer on the same file, and if one is run- - ning will not start a new one. If $new_viewer_always is non- - zero, this check will be skipped, and latexmk will behave as if - no viewer is running. - + 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- - 24 November 2009 19 + 13 January 2010 21 @@ -1313,39 +1405,42 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) + zero, this check will be skipped, and latexmk will behave as if + no viewer is running. + $pdf_mode [0] - If zero, do NOT generate a pdf version of the document. If - equal to 1, generate a pdf version of the document using pdfla- + If zero, do NOT generate a pdf version of the document. If + equal to 1, generate a pdf version of the document using pdfla- tex. If equal to 2, generate a pdf version of the document from the ps file, by using the command specified by the $ps2pdf vari- - able. If equal to 3, generate a pdf version of the document + able. If equal to 3, generate a pdf version of the document from the dvi file, by using the command specified by the $dvipdf variable. Equivalent to the -pdf-, -pdf, -pdfdvi, -pdfps options. $pdflatex ["pdflatex %O %S"] - The LaTeX processing program in the version that makes a pdf + The LaTeX processing program in the version that makes a pdf file instead of a dvi file. %pdflatex_input_extensions - This variable specifies the extensions tried by latexmk when it - finds that a pdfLaTeX run resulted in an error that a file has - not been found, and the file is given without an extension. - This typically happens when LaTeX commands of the form + This variable specifies the extensions tried by latexmk when it + finds that a pdfLaTeX run resulted in an error that a file has + not been found, and the file is given without an extension. + This typically happens when LaTeX commands of the form input{file} or includegraphics{figure}, when the relevant source file does not exist. - In this situation, latexmk searches for custom dependencies to - make the missing file(s), but restricts it to the extensions - specified by the variable %pdflatex_input_extensions. The + In this situation, latexmk searches for custom dependencies to + make the missing file(s), but restricts it to the extensions + specified by the variable %pdflatex_input_extensions. The default extensions are - (For Perl experts: %pdflatex_input_extensions is a hash whose - keys are the extensions. The values are irrelevant.) Two sub- - routines are provided for manipulating this and the related - variable %latex_input_extensions, add_input_ext and - remove_input_ext. They are used as in the following examples + (For Perl experts: %pdflatex_input_extensions is a hash whose + keys are the extensions. The values are irrelevant.) Two sub- + routines are provided for manipulating this and the related + variable %latex_input_extensions, add_input_ext and + remove_input_ext. They are used as in the following examples are possible lines in an initialization file: remove_input_ext( 'pdflatex', 'tex' ); @@ -1354,27 +1449,24 @@ LATEXMK(1L) LATEXMK(1L) add_input_ext( 'pdflatex', 'asdf' ); - add the extension 'asdf to pdflatex_input_extensions. (Natu- - rally with such an extension, you should have made an appropri- + add the extension 'asdf to pdflatex_input_extensions. (Natu- + rally with such an extension, you should have made an appropri- ate custom dependency for latexmk, and should also have done the - appropriate programming in the LaTeX source file to enable the - file to be read. The standard extensions are handled by pdfla- + appropriate programming in the LaTeX source file to enable the + file to be read. The standard extensions are handled by pdfla- tex and its graphics/graphicx packages.) $pdflatex_silent_switch ["-interaction=batchmode"] - Switch(es) for the pdflatex program (specified in the variable + Switch(es) for the pdflatex program (specified in the variable $pdflatex when silent mode is on. Under MS-Windows, the default value is changed to "-interaction=batchmode -c-style-errors", as used by MikTeX and fpTeX. - $pdf_previewer ["start acroread %O %S"] - The command to invoke a pdf-previewer. [Default is changed to - "start" on MS-WINDOWS; under more recent versions of Windows, - 24 November 2009 20 + 13 January 2010 22 @@ -1383,28 +1475,31 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - this will cause to be run whatever command the system has asso- + $pdf_previewer ["start acroread %O %S"] + The command to invoke a pdf-previewer. [Default is changed to + "start" on MS-WINDOWS; under more recent versions of Windows, + this will cause to be run whatever command the system has asso- ciated with .pdf files.] WARNING: Potential problem under MS-Windows: if acroread is used as the pdf previewer, and it is actually viewing a pdf file, the pdf file cannot be updated. Thus makes acroread a bad choice of - previewer if you use latexmk's previous-continuous mode (option - -pvc) under MS-windows. This problem does not occur if + previewer if you use latexmk's previous-continuous mode (option + -pvc) under MS-windows. This problem does not occur if ghostview, gv or gsview is used to view pdf files. $pdf_update_command [""] - When the pdf previewer is set to be updated by running a com- - mand, this is the command that is run. See the information for + When the pdf previewer is set to be updated by running a com- + mand, this is the command that is run. See the information for the variable $pdf_update_method. $pdf_update_method [1 under UNIX, 3 under MS-Windows] - How the pdf viewer updates its display when the pdf file has - changed. See the information on the variable $dvi_update_method + How the pdf viewer updates its display when the pdf file has + changed. See the information on the variable $dvi_update_method for the codes. (Note that information needs be changed slightly - so that for the value 4, to run a command to do the update, the - command is specified by the variable $pdf_update_command, and - for the value 2, to specify update by signal, the signal is + so that for the value 4, to run a command to do the update, the + command is specified by the variable $pdf_update_command, and + for the value 2, to specify update by signal, the signal is specified by $pdf_update_signal.) Note that acroread under MS-Windows (but not UNIX) locks the pdf @@ -1417,35 +1512,31 @@ LATEXMK(1L) LATEXMK(1L) $pdf_update_method = 4; $pdf_update_command = "xpdf -remote %R -reload"; - The first setting arranges for the xpdf program to be used in - its "remote server mode", with the server name specified as the - rootname of the TeX file. The second setting arranges for + The first setting arranges for the xpdf program to be used in + its "remote server mode", with the server name specified as the + rootname of the TeX file. The second setting arranges for updating to be done in response to a command, and the third set- ting sets the update command. - $pdf_update_signal [Under UNIX: SIGHUP, which is a system-dependent + $pdf_update_signal [Under UNIX: SIGHUP, which is a system-dependent value] - The number of the signal that is sent to the pdf viewer when it - is updated by sending a signal -- see the information on the - variable $pdf_update_method. The default value is the one + The number of the signal that is sent to the pdf viewer when it + is updated by sending a signal -- see the information on the + variable $pdf_update_method. The default value is the one appropriate for gv on a UNIX system. $pid_position[1 under UNIX, -1 under MS-Windows] - The variable $pid_position is used to specify which word in - lines of the output from $pscmd corresponds to the process ID. - The first word in the line is numbered 0. The default value of + The variable $pid_position is used to specify which word in + lines of the output from $pscmd corresponds to the process ID. + The first word in the line is numbered 0. The default value of 1 (2nd word in line) is correct for Solaris 2.6 and Linux. Set- - ting the variable to -1 is used to indicate that $pscmd is not + ting the variable to -1 is used to indicate that $pscmd is not to be used. - $postscript_mode [0] - If nonzero, generate a postscript version of the document. - Equivalent to the -ps option. - - 24 November 2009 21 + 13 January 2010 23 @@ -1454,69 +1545,68 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - If some other request is made for which a postscript file is needed, + $postscript_mode [0] + If nonzero, generate a postscript version of the document. + Equivalent to the -ps option. + + If some other request is made for which a postscript file is needed, then $postscript_mode will be set to 1. $preview_continuous_mode [0] - If nonzero, run a previewer to view the document, and continue + If nonzero, run a previewer to view the document, and continue running latexmk to keep .dvi up-to-date. Equivalent to the -pvc - option. Which previewer is run depends on the other settings, + option. Which previewer is run depends on the other settings, see the command line options -view=, and the variable $view. $preview_mode [0] If nonzero, run a previewer to preview the document. Equivalent - to the -pv option. Which previewer is run depends on the other - settings, see the command line options -view=, and the variable + to the -pv option. Which previewer is run depends on the other + settings, see the command line options -view=, and the variable $view. $printout_mode [0] - If nonzero, print the document using lpr. Equivalent to the -p + If nonzero, print the document using lpr. Equivalent to the -p option. This is recommended not to be set from an RC file, oth- erwise you could waste lots of paper. $print_type = ["ps"] - Type of file to printout: possibilities are "dvi", "none", + Type of file to printout: possibilities are "dvi", "none", "pdf", or "ps". $pscmd Command used to get all the processes currently run by the user. - The -pvc option uses the command specified by the variable - $pscmd to determine if there is an already running previewer, - and to find the process ID (needed if latexmk needs to signal + The -pvc option uses the command specified by the variable + $pscmd to determine if there is an already running previewer, + and to find the process ID (needed if latexmk needs to signal the previewer about file changes). Each line of the output of this command is assumed to correspond to one process. See the $pid_position variable for how the pro- cess number is determined. - The default for pscmd is "NONE" under MS-Windows and cygwin + The default for pscmd is "NONE" under MS-Windows and cygwin (i.e., the command is not used), "ps --width 200 -f -u - $ENV{USER}" under linux, "ps -ww -u $ENV{USER}" under darwin - (Macintosh OS-X), and "ps -f -u $ENV{USER}" under other operat- - ing systems (including other flavors of UNIX). In these speci- + $ENV{USER}" under linux, "ps -ww -u $ENV{USER}" under darwin + (Macintosh OS-X), and "ps -f -u $ENV{USER}" under other operat- + ing systems (including other flavors of UNIX). In these speci- fications "$ENV{USER}" is substituted by the username. $ps2pdf ["ps2pdf %O %S %D"] Command to convert ps to pdf file. $ps_filter [empty] - The postscript file filter to be run on the newly produced + The postscript file filter to be run on the newly produced postscript file before other processing. Equivalent to specify- ing the -pF option. $ps_previewer ["start gv %O %S", but "start %O %S" under MS-WINDOWS] - The command to invoke a ps-previewer. (The default under MS- - WINDOWS will cause to be run whatever command the system has + The command to invoke a ps-previewer. (The default under MS- + WINDOWS will cause to be run whatever command the system has associated with .ps files.) - Note that gv could be used with the -watch option updates its - display whenever the postscript file changes, whereas ghostview - does not. However, different versions of gv have slightly dif- - ferent ways of writing this option. You can configure this - variable apppropriately. - 24 November 2009 22 + 13 January 2010 24 @@ -1525,69 +1615,68 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) + Note that gv could be used with the -watch option updates its + display whenever the postscript file changes, whereas ghostview + does not. However, different versions of gv have slightly dif- + ferent ways of writing this option. You can configure this + variable apppropriately. + WARNING: Linux systems may have installed one (or more) versions - of gv under different names, e.g., ggv, kghostview, etc, but + of gv under different names, e.g., ggv, kghostview, etc, but perhaps not one called gv. - $ps_previewer_landscape ["start gv -swap %O %S", but "start %O %S" + $ps_previewer_landscape ["start gv -swap %O %S", but "start %O %S" under MS-WINDOWS] The command to invoke a ps-previewer in landscape mode. $ps_update_command [""] - When the postscript previewer is set to be updated by running a - command, this is the command that is run. See the information + When the postscript previewer is set to be updated by running a + command, this is the command that is run. See the information for the variable $ps_update_method. $ps_update_method [0 under UNIX, 1 under MS-Windows] - How the postscript viewer updates its display when the ps file - has changed. See the information on the variable - $dvi_update_method for the codes. (Note that information needs + How the postscript viewer updates its display when the ps file + has changed. See the information on the variable + $dvi_update_method for the codes. (Note that information needs be changed slightly so that for the value 4, to run a command to do the update, the command is specified by the variable - $ps_update_command, and for the value 2, to specify update by + $ps_update_command, and for the value 2, to specify update by signal, the signal is specified by $ps_update_signal.) - $ps_update_signal [Under UNIX: SIGHUP, which is a system-dependent + $ps_update_signal [Under UNIX: SIGHUP, which is a system-dependent value] - The number of the signal that is sent to the pdf viewer when it - is updated by sending a signal -- see $ps_update_method. The + The number of the signal that is sent to the pdf viewer when it + is updated by sending a signal -- see $ps_update_method. The default value is the one appropriate for gv on a UNIX system. $quote_filenames [1] This specifies whether substitutions for placeholders in command specifications (as in $pdflatex) are surrounded by double - quotes. If this variable is 1 (or any other value Perl regards + quotes. If this variable is 1 (or any other value Perl regards as true), then quoting is done. Otherwise quoting is omitted. - The quoting method used by latexmk is tested to work correctly under - UNIX systems (including Linux and Mac OS-X) and under MS-Windows. It - allows the use of filenames containing special characters, notably + The quoting method used by latexmk is tested to work correctly under + UNIX systems (including Linux and Mac OS-X) and under MS-Windows. It + allows the use of filenames containing special characters, notably spaces. (But note that many versions of LaTeX and PdfLaTeX cannot cor- rectly deal with TeX files whose names contain spaces. Latexmk's quot- ing only ensures that such filenames are correctly treated by the oper- ating system in passing arguments to programs.) $sleep_time [2] - The time to sleep (in seconds) between checking for source file + The time to sleep (in seconds) between checking for source file changes when running the -pvc option. $texfile_search [""] - This is an obsolete variable, replaced by the @default_files + This is an obsolete variable, replaced by the @default_files variable. - For backward compatibility, if you choose to set $tex- - file_search, it is a string of space-separated filenames, and - then latexmk replaces @default_files with the filenames in $tex- - file_search to which is added "*.tex". - - $tmpdir [See below for default] - Directory to store temporary files that latexmk may generate - while running. + For backward compatibility, if you choose to set - 24 November 2009 23 + 13 January 2010 25 @@ -1596,31 +1685,39 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - The default under MSWindows (including cygwin), is to set - $tmpdir to the value of the first of whichever of the system - environment variables TMPDIR or TEMP exists, otherwise to the - current directory. Under other operating systems (expected to - be UNIX/Linux, including OS-X), the default is the value of the - system environment variable TMPDIR if it exists, otherwise + $texfile_search, it is a string of space-separated filenames, + and then latexmk replaces @default_files with the filenames in + $texfile_search to which is added "*.tex". + + $tmpdir [See below for default] + Directory to store temporary files that latexmk may generate + while running. + + The default under MSWindows (including cygwin), is to set + $tmpdir to the value of the first of whichever of the system + environment variables TMPDIR or TEMP exists, otherwise to the + current directory. Under other operating systems (expected to + be UNIX/Linux, including OS-X), the default is the value of the + system environment variable TMPDIR if it exists, otherwise "/tmp". $view ["default"] - Which kind of file is to be previewed if a previewer is used. - The possible values are "default", "dvi", "ps", "pdf". The + Which kind of file is to be previewed if a previewer is used. + The possible values are "default", "dvi", "ps", "pdf". The value of "default" means that the "highest" of the kinds of file generated is to be used (among dvi, ps and pdf). CUSTOM DEPENDENCIES - In any RC file a set of custom dependencies can be set up to convert a + In any RC file a set of custom dependencies can be set up to convert a file with one extension to a file with another. An example use of this would be to allow latexmk to convert a .fig file to .eps to be included in the .tex file. - The old method of configuring latexmk was to directly manipulate the - @cus_dep_list array that contains information defining the custom - dependencies. This method still works. But now there are subroutines - that allow convenient manipulations of the custom dependency list. + The old method of configuring latexmk was to directly manipulate the + @cus_dep_list array that contains information defining the custom + dependencies. This method still works. But now there are subroutines + that allow convenient manipulations of the custom dependency list. These are add_cus_dep( fromextension, toextension, must, subroutine ) @@ -1631,34 +1728,25 @@ CUSTOM DEPENDENCIES follow: from extension: - The extension of the file we are converting from (e.g. "fig"). + The extension of the file we are converting from (e.g. "fig"). It is specified without a period. to extension: The extension of the file we are converting to (e.g. "eps"). It is specified without a period. - must: If non-zero, the file from which we are converting must exist, - if it doesn't exist latexmk will give an error message and exit + must: If non-zero, the file from which we are converting must exist, + if it doesn't exist latexmk will give an error message and exit unless the -f option is specified. If must is zero and the file we are converting from doesn't exist, then no action is taken. function: - The name of the subroutine that latexmk should call to perform - the file conversion. The first argument to the subroutine is - the 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 - if it failed. - - It is invoked whenever latexmk detects that a run of latex/pdflatex - needs to read a file, like a graphics file, whose extension is the to- - extension of a custom dependency. Then latexmk examines whether a file - exists with the same name, but with the corresponding from-extension, + The name of the subroutine that latexmk should call to perform + the file conversion. The first argument to the subroutine is - 24 November 2009 24 + 13 January 2010 26 @@ -1667,19 +1755,28 @@ CUSTOM DEPENDENCIES LATEXMK(1L) LATEXMK(1L) - as specified in the custom-dependency rule. If it does, then whenever - the destination file (the one with the to-extension) is out-of-date + 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 + if it failed. + + It is invoked whenever latexmk detects that a run of latex/pdflatex + needs to read a file, like a graphics file, whose extension is the to- + extension of a custom dependency. Then latexmk examines whether a file + exists with the same name, but with the corresponding from-extension, + as specified in the custom-dependency rule. If it does, then whenever + the destination file (the one with the to-extension) is out-of-date with respect to the corresponding source file. - To make the new destination file, the Perl subroutine specified in the + To make the new destination file, the Perl subroutine specified in the rule is invoked, with an argument that is the base name of the files in - question. Simple cases just involve a subroutine invoking an external - program; this can be done by following the templates below, even by - those without knowledge of the Perl programming language. Of course, + question. Simple cases just involve a subroutine invoking an external + program; this can be done by following the templates below, even by + those without knowledge of the Perl programming language. Of course, experts could do something much more elaborate. - One other item in each custom-dependency rule labelled "must" above - specifies how the rule should be applied when the source file fails to + One other item in each custom-dependency rule labelled "must" above + specifies how the rule should be applied when the source file fails to exist. A simple and typical example of code in an initialization rcfile is @@ -1689,61 +1786,61 @@ LATEXMK(1L) LATEXMK(1L) system("fig2dev -Leps $_[0].fig $_[0].eps"); } - The first line adds a custom dependency that converts a file with - extension "fig", as created by the xfig program, to an encapsulated - postscript file, with extension "eps". The remaining lines define a - subroutine that carries out the conversion. If a rule for converting - "fig" to "eps" files already exists (e.g., from a previously read-in - initialization file), the latexmk will delete this rule before making + The first line adds a custom dependency that converts a file with + extension "fig", as created by the xfig program, to an encapsulated + postscript file, with extension "eps". The remaining lines define a + subroutine that carries out the conversion. If a rule for converting + "fig" to "eps" files already exists (e.g., from a previously read-in + initialization file), the latexmk will delete this rule before making the new one. - Suppose latexmk is using this rule to convert a file "figure.fig" to - "figure.eps". Then it will invoke the fig2eps subroutine defined in - the above code with a single argument "figure", which is the basename - of each of the files (possibly with a path component). This argument - is referred to by Perl as $_[0]. In the example above, the subroutine + Suppose latexmk is using this rule to convert a file "figure.fig" to + "figure.eps". Then it will invoke the fig2eps subroutine defined in + the above code with a single argument "figure", which is the basename + of each of the files (possibly with a path component). This argument + is referred to by Perl as $_[0]. In the example above, the subroutine uses the Perl command system to invoke the program fig2dev. The double quotes around the string are a Perl idiom that signify that each string - of the form of a variable name, $_[0] in this case, is to be substi- + of the form of a variable name, $_[0] in this case, is to be substi- tuted by its value. - If the return value of the subroutine is non-zero, then latexmk will - assume an error occurred during the execution of the subroutine. In - the above example, no explicit return value is given, and instead the - return value is the value returned by the last (and only) statement, + If the return value of the subroutine is non-zero, then latexmk will + assume an error occurred during the execution of the subroutine. In + the above example, no explicit return value is given, and instead the + return value is the value returned by the last (and only) statement, i.e., the invocation of system, which returns the value 0 on success. - If you use filenames with spaces in them, and if your LaTeX system and - all other relevant software correctly handle such filenames, then you - could put single quotes around filenames in the command line that is - executed: + If you use filenames with spaces in them, and if your LaTeX system and + all other relevant software correctly handle such filenames, then you + could put single quotes around filenames in the command line that is - add_cus_dep( 'fig', 'eps', 0, 'fig2eps' ); - sub fig2eps { - system("fig2dev -Lps '$_[0].fig' '$_[0].eps'"); - } - This causes the invocation of the fig2dev program to have quoted file- - names; it should therefore work with filenames containing spaces. How- - ever, not all software deals correctly with filenames that contain + 13 January 2010 27 - 24 November 2009 25 +LATEXMK(1L) LATEXMK(1L) -LATEXMK(1L) LATEXMK(1L) + executed: + add_cus_dep( 'fig', 'eps', 0, 'fig2eps' ); + sub fig2eps { + system("fig2dev -Lps '$_[0].fig' '$_[0].eps'"); + } - spaces. Moreover, the rules, if any, for quoting filenames vary - between operating systems, command shells and individual pieces of + This causes the invocation of the fig2dev program to have quoted file- + names; it should therefore work with filenames containing spaces. How- + ever, not all software deals correctly with filenames that contain + spaces. Moreover, the rules, if any, for quoting filenames vary + between operating systems, command shells and individual pieces of software, so this code may not always work. - If you use pdflatex instead of latex, then you will probably prefer to - convert your graphics files to pdf format, in which case you would + If you use pdflatex instead of latex, then you will probably prefer to + convert your graphics files to pdf format, in which case you would replace the above code in an initialization file by add_cus_dep( 'fig', 'pdf, 0, 'fig2pdf' ); @@ -1751,31 +1848,31 @@ LATEXMK(1L) LATEXMK(1L) system("fig2dev -Lpdf $_[0].fig $_[0].pdf"); } - If you have some general custom dependencies defined in the system or - user initialization file, you may find that for a particular project - they are undesirable. So you might want to delete the unneeded ones. + If you have some general custom dependencies defined in the system or + user initialization file, you may find that for a particular project + they are undesirable. So you might want to delete the unneeded ones. For example, you remove any "fig" to "eps" rule by the line remove_cus_dep( 'fig', 'eps' ); - If you have complicated sets of custom dependencies, you may want to - get a listing of the custom dependencies. This is done by using the + If you have complicated sets of custom dependencies, you may want to + get a listing of the custom dependencies. This is done by using the line show_cus_dep(); in an initialization file. - Another example of a custom dependency overcomes a limitation of - latexmk concerning index files. The only index-file conversion built- + Another example of a custom dependency overcomes a limitation of + latexmk concerning index files. The only index-file conversion built- in to latexmk is from an ".idx" file written on one run of latex/pdfla- - tex to an ".ind" file to be read in on a subsequent run. But with the + tex to an ".ind" file to be read in on a subsequent run. But with the index.sty package you can create extra indexes with extensions that you configure. Latexmk does not know how to deduce the extensions from the information it has. But you can easily write a custom dependency. For - example if your latex file uses the command "\newindex{spe- + example if your latex file uses the command "\newindex{spe- cial}{ndx}{nnd}{Special index}" you will need to convert files with the - extension .ndx to .nnd. The following lines in an initialization RC + extension .ndx to .nnd. The following lines in an initialization RC file will cause this to happen: add_cus_dep('ndx', 'nnd', 0, 'makendx2nnd'); @@ -1783,24 +1880,13 @@ LATEXMK(1L) LATEXMK(1L) system("makeindex -o $_[0].nnd $_[0].ndx"); } - (You will need to modify this code if you use filenames with spaces in + (You will need to modify this code if you use filenames with spaces in them, to provide correct quoting of the filenames.) - Those of you with experience with Makefiles, will undoubtedly be con- - cerned that the .ndx file is written during a run of latex/pdflatex and - is always later than the .nnd last read in. Thus the .nnd appears to - be perpetually out-of-date. This situation, of circular dependencies, - is endemic to latex, and latexmk in its current version works correctly - with circular dependencies. It examines the contents of the files (by - use of an md5 checksum), and only does a remake when the file contents - have actually changed. - - Of course if you choose to write random data to the .nnd (or and .aux - file, etc) that changes on each new run, then you will have a problem. - 24 November 2009 26 + 13 January 2010 28 @@ -1809,23 +1895,34 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - For real experts: See the %hash_cal_ignore_pattern if you have to deal + Those of you with experience with Makefiles, will undoubtedly be con- + cerned that the .ndx file is written during a run of latex/pdflatex and + is always later than the .nnd last read in. Thus the .nnd appears to + be perpetually out-of-date. This situation, of circular dependencies, + is endemic to latex, and latexmk in its current version works correctly + with circular dependencies. It examines the contents of the files (by + use of an md5 checksum), and only does a remake when the file contents + have actually changed. + + Of course if you choose to write random data to the .nnd (or and .aux + file, etc) that changes on each new run, then you will have a problem. + For real experts: See the %hash_cal_ignore_pattern if you have to deal with such problems. Glossaries can be dealt with similarly. OLD METHOD OF DEFINING CUSTOM DEPENDENCIES - In previous versions of latexmk, the only method of defining custom - dependencies was to directly manipulate the table of custom dependen- + In previous versions of latexmk, the only method of defining custom + dependencies was to directly manipulate the table of custom dependen- cies. This is contained in the @cus_dep_list array. It is an array of - strings, and each string in the array has four items in it, each sepa- - rated by a space, the from-extension, the to-extension, the "must" - item, and the name of the subroutine for the custom dependency. These + strings, and each string in the array has four items in it, each sepa- + rated by a space, the from-extension, the to-extension, the "must" + item, and the name of the subroutine for the custom dependency. These were all defined above. An example of the old method of defining custom dependencies is as fol- - lows. It is the code in an RC file to ensure automatic conversion of + lows. It is the code in an RC file to ensure automatic conversion of .fig files to .eps files: push @cus_dep_list, "fig eps 0 fig2eps"; @@ -1833,9 +1930,9 @@ OLD METHOD OF DEFINING CUSTOM DEPENDENCIES system("fig2dev -Lps $_[0].fig $_[0].eps"); } - This method still works, and is equivalent to the earlier code using - the add_cus_dep subroutine, except that it doesn't delete any previous - custom-dependency for the same conversion. So the new method is + This method still works, and is equivalent to the earlier code using + the add_cus_dep subroutine, except that it doesn't delete any previous + custom-dependency for the same conversion. So the new method is preferable. @@ -1844,45 +1941,46 @@ SEE ALSO BUGS Sometimes a viewer (gv) tries to read an updated .ps or .pdf file after - its creation is started but before the file is complete. Work around: + its creation is started but before the file is complete. Work around: manually refresh (or reopen) display. Or use one of the other preview- ers and update methods. - (The following isn't really a bug, but concerns features of preview- - ers.) Preview continuous mode only works perfectly with certain pre- - viewers: Xdvi on UNIX/LINUX works for dvi files. Gv on UNIX/LINUX - works for both postscript and pdf. Ghostview on UNIX/LINUX needs a - manual update (reopen); it views postscript and pdf. Gsview under MS- - Windows works for both postscript and pdf, but only reads the updated - file when its screen is refreshed. Acroread under UNIX/LINUX views - pdf, but the file needs to be closed and reopened to view an updated - version. Under MS-Windows, acroread locks its input file and so the - pdf file cannot be updated. (Remedy: configure latexmk to use gsview - instead.) + (The following isn't really a bug, but concerns features of preview- + ers.) Preview continuous mode only works perfectly with certain pre- + viewers: Xdvi on UNIX/LINUX works for dvi files. Gv on UNIX/LINUX + works for both postscript and pdf. Ghostview on UNIX/LINUX needs a + manual update (reopen); it views postscript and pdf. Gsview under MS- + Windows works for both postscript and pdf, but only reads the updated + file when its screen is refreshed. Acroread under UNIX/LINUX views + pdf, but the file needs to be closed and reopened to view an updated -THANKS TO - Authors of previous versions. Many users with their feedback, and - especially David Coppit (username david at node coppit.org) who made - many useful suggestions that contributed to version 3, and Herbert - Schulz. (Please note that the e-mail addresses are not written in - their standard form to avoid being harvested by worms and viruses.) -AUTHOR - Current version, by John Collins (username collins at node - phys.psu.edu). (Version 4.11). + 13 January 2010 29 - 24 November 2009 27 +LATEXMK(1L) LATEXMK(1L) -LATEXMK(1L) LATEXMK(1L) + version. Under MS-Windows, acroread locks its input file and so the + pdf file cannot be updated. (Remedy: configure latexmk to use gsview + instead.) +THANKS TO + Authors of previous versions. Many users with their feedback, and + especially David Coppit (username david at node coppit.org) who made + many useful suggestions that contributed to version 3, and Herbert + Schulz. (Please note that the e-mail addresses are not written in + their standard form to avoid being harvested by worms and viruses.) - Released version can be obtained from CTAN: <http://www.tug.org/tex- +AUTHOR + Current version, by John Collins (username collins at node + phys.psu.edu). (Version 4.13). + + Released version can be obtained from CTAN: <http://www.tug.org/tex- archive/support/latexmk/>, and from the author's website <http://www.phys.psu.edu/~collins/software/latexmk/>. Modifications and enhancements by Evan McLean (Version 2.0) @@ -1928,24 +2026,6 @@ LATEXMK(1L) LATEXMK(1L) - - - - - - - - - - - - - - - - - - - 24 November 2009 28 + 13 January 2010 30 diff --git a/Master/texmf-dist/scripts/latexmk/latexmk.pl b/Master/texmf-dist/scripts/latexmk/latexmk.pl index 0588b2efe9c..2ea0e023e8f 100755 --- a/Master/texmf-dist/scripts/latexmk/latexmk.pl +++ b/Master/texmf-dist/scripts/latexmk/latexmk.pl @@ -95,6 +95,7 @@ use warnings; # 2. Convert errors to failure only in calling routine # 3. Save first warning/error. +# ?? Use of generated_exts arrays and hashes needs rationalization # To do: # Rationalize again handling of include files. @@ -107,8 +108,8 @@ use warnings; $my_name = 'latexmk'; $My_name = 'Latexmk'; -$version_num = '4.11'; -$version_details = "$My_name, John Collins, 27 November 2009"; +$version_num = '4.13'; +$version_details = "$My_name, John Collins, 13 January 2010"; use Config; @@ -141,7 +142,7 @@ else { warn "Something wrong with the perl configuration: No signals?\n"; } -## Copyright John Collins 1998-2009 +## Copyright John Collins 1998-2010 ## (username collins at node phys.psu.edu) ## (and thanks to David Coppit (username david at node coppit.org) ## for suggestions) @@ -175,8 +176,17 @@ else { ## 5. Parsing of log file instead of source file is used to ## obtain dependencies, by default. ## -## Modification log from 21 Aug 2009 onwards in detail +## Modification log from 25 Nov 2009 onwards in detail ## +## 13 Jan 2010, John Collins V. 4.13 +## 27 Dec 2009, John Collins Correct position of inserting bbl into list +## of generated extensions. +## Correct clean_up. It stopped deleting aux +## file. +## $bibtex_use defaults to 1. +## 15 Dec 2009, John Collins Option not to do bibtex +## (to allow for case that bbl files +## are available, but no bibtex). ## 27 Nov 2009, John Collins Solve problem that changes in \include ## files weren't reflected in changes ## in bibtex source files. @@ -205,20 +215,6 @@ else { ## that uses the file. ## Avoided excess md5 calculations at ## startup. -## 24 Nov 2009, John Collins Start 4.11 -## 22 Sep 2009, John Collins Bibtex error => message see blg file. -## 10 Sep 2009, John Collins When tmp view file is moved to view file, -## delete original file first. Avoids -## bug in kpdf -## 4 Sep 2009, John Collins A missing file message is now suppressed -## when -silent option used -## kpsewhich is used to find non-existent -## converted files (as with epstopdf) -## 1 Sep 2009, John Collins Change "last FILE" to "next FILE" -## on failure in main loop. -## I had earlier changed this from "next FILE" to -## "last FILE" (for v. 4.08), but I don't see why. -## 21 Aug 2009, John Collins V. 4.10 for CTAN release. ## ## 1998-2009, John Collins. Many improvements and fixes. ## See CHANGE-log.txt for full list, and CHANGES for summary @@ -384,6 +380,14 @@ add_input_ext( 'pdflatex', 'tex', 'jpg', 'pdf' ); $bibtex = 'bibtex %O %B'; # Switch(es) to make bibtex silent: $bibtex_silent_switch = '-terse'; +$bibtex_use = 1; # Whether to actually run bibtex to update bbl files + # 0: Never run bibtex + # 1: Run bibtex only if the bibfiles exists + # according to kpsewhich, and the bbl files + # appear to be out-of-date + # 2: Run bibtex when the bbl files are out-of-date + # In any event bibtex is only run if the log file + # indicates that the document uses bbl files. ## Command to invoke makeindex $makeindex = 'makeindex %O -o %D %S'; @@ -838,7 +842,8 @@ $landscape_mode = 0; # default to portrait mode # the run (which might correct the error) should provoke a # rerun, but a change in a generated file should not. # These arrays can be user-configured. -@generated_exts = ( 'aux', 'bbl', 'idx', 'ind', 'lof', 'lot', 'out', 'toc' ); + +@generated_exts = ( 'aux', 'idx', 'ind', 'lof', 'lot', 'out', 'toc' ); # N.B. 'out' is generated by hyperref package # Which kinds of file do I have requests to make? @@ -1189,6 +1194,10 @@ read_first_rc_file_in_list( "latexmkrc", ".latexmkrc" ); #================================================== +if ($bibtex_use > 1) { + push @generated_exts, 'bbl'; +} + #show_array ("BIBINPUTS", @BIBINPUTS); die; ## Process command line args. @@ -1202,7 +1211,11 @@ while ($_ = $ARGV[0]) # Make -- and - equivalent at beginning of option: s/^--/-/; shift; - if (/^-c$/) { $cleanup_mode = 2; $cleanup_fdb = 1; $cleanup_only = 1; } + if (/^-bibtex$/) { $bibtex_use = 2; } + elsif (/^-bibtex-$/) { $bibtex_use = 0; } + elsif (/^-nobibtex$/) { $bibtex_use = 0; } + elsif (/^-bibtex-cond$/) { $bibtex_use = 1; } + elsif (/^-c$/) { $cleanup_mode = 2; $cleanup_fdb = 1; $cleanup_only = 1; } elsif (/^-C$/ || /^-CA$/ ) { $cleanup_mode = 1; $cleanup_fdb = 1; $cleanup_only = 1; } elsif (/^-CF$/) { $cleanup_fdb = 1; } elsif (/^-cd$/) { $do_cd = 1; } @@ -1228,13 +1241,13 @@ while ($_ = $ARGV[0]) $jobname = $1; } elsif (/^-l$/) { $landscape_mode = 1; } + elsif (/^-l-$/) { $landscape_mode = 0; } elsif (/^-new-viewer$/) { $new_viewer_always = 1; } elsif (/^-new-viewer-$/) { $new_viewer_always = 0; } - elsif (/^-l-$/) { $landscape_mode = 0; } elsif (/^-p$/) { $printout_mode = 1; $preview_continuous_mode = 0; # to avoid conflicts $preview_mode = 0; @@ -1635,26 +1648,38 @@ foreach $filename ( @file_list ) if ( ($go_mode == 2) && !$silent ) { warn "$My_name: Removing all generated files\n" unless $silent; } - foreach (@index_bibtex_generated, @aux_files) { + if ($bibtex_use < 2) { + delete $generated_exts_all{'bbl'}; + } + my %index_bibtex_generated = (); + my %aux_files = (); + foreach (@index_bibtex_generated) { + $index_bibtex_generated{$_} = 1 + unless ( /\.bbl$/ && ($bibtex_use < 2) ); + delete( $other_generated{$_} ); + } + foreach (@aux_files) { + $aux_files{$_} = 1; delete( $other_generated{$_} ); } if ($diagnostics) { show_array( "For deletion:\n" ." Generated (from makeindex and bibtex):", - @index_bibtex_generated ); - show_array( " Aux files:", @aux_files ); + keys %index_bibtex_generated ); + show_array( " Aux files:", keys %aux_files ); show_array( "Other generated files:\n" ." (only deleted if \$cleanup_includes_generated is set): ", keys %other_generated ); } - # Add to the generated files, some log file and some backup # files used in previous versions of latexmk &cleanup1( $fdb_ext, 'blg', 'ilg', 'log', 'aux.bak', 'idx.bak', split(' ',$clean_ext), - @generated_exts + keys %generated_exts_all ); - unlink( 'texput.log', @index_bibtex_generated, "texput.aux", @aux_files ); + unlink( 'texput.log', "texput.aux", + keys %index_bibtex_generated, + keys %aux_files ); if ($cleanup_includes_generated) { unlink( keys %other_generated ); } @@ -2587,6 +2612,9 @@ sub print_help "$My_name $version_num: Automatic LaTeX document generation routine\n\n", "Usage: $my_name [latexmk_options] [filename ...]\n\n", " Latexmk_options:\n", + " -bibtex - use bibtex when needed (default)\n", + " -bibtex- - never use bibtex\n", + " -bibtex-cond - use bibtex when needed, but only if the bib files exist\n", " -bm <message> - Print message across the page when converting to postscript\n", " -bi <intensity> - Set contrast or intensity of banner\n", " -bs <scale> - Set scale for banner\n", @@ -2624,8 +2652,9 @@ sub print_help " implementations of latex/pdflatex.)\n", " -l - force landscape mode\n", " -l- - turn off -l\n", - " -new-viewer - in -pvc mode, always start a new viewer\n", - " -new-viewer- - in -pvc mode, start a new viewer only if needed\n", + " -new-viewer - in -pvc mode, always start a new viewer\n", + " -new-viewer- - in -pvc mode, start a new viewer only if needed\n", + " -nobibtex - never use bibtex\n", " -nodependents - Do not show list of dependent files after processing\n", " -pdf - generate pdf by pdflatex\n", " -pdfdvi - generate pdf by dvipdf\n", @@ -4097,8 +4126,6 @@ MISSING_FILE: } } -## ?? Is this correct? I used to use @includes -# rdb_update_files_for_rule( keys %PHsources ); if ( $diagnostics && ( $found > 0 ) ) { warn "$My_name: Detected previously missing files:\n"; foreach ( sort keys %new_includes ) { @@ -4110,53 +4137,6 @@ MISSING_FILE: #************************************************************ -sub rdb_update_files_for_rule { -#=========== APPEARS NOT TO BE USED! ========================= -# Usage: rdb_update_files_for_rule( source_files ...) -# Assume rule context. -# Update list of source files for current rule, treating properly cases -# where file didn't exist before run, etc - foreach my $file ( @_ ) { - if ( ! rdb_file_exists( $rule, $file ) ) { - # File that didn't appear in the source files for the run - # before. Two cases: (a) it was created during the run; - # (b) it existed before the run. - # If case (a), then the file was non-existent before the - # run, so we must now label it as non-existent, and - # we trigger a new run -#?? print "?? Adding '$file' to '$rule'\n"; - rdb_ensure_file( $rule, $file ); - my $file_time = get_mtime0( $file ); - if ( ($$Ptest_kind == 2) || ($$Ptest_kind == 3) ) { - # Test wrt destination time, but exclude files - # which appear to be generated (according to extension) - # Assume generated files up-to-date after last run. - # I.e., last run was valid. - my $ext = ext( $file ); - - if ( (! exists $generated_exts_all{$ext} ) - && ($file_time >= $dest_mtime) - ) { - # Only changes since the mtime of the destination matter, - # and only non-generated files count. - # Non-existent destination etc gives $dest_mtime=0 - # so this will automatically give out-of-date condition - # Flag out-of-date for a file by treating it as non-existent - rdb_set_file1( $rule, $file, 0, -1, 0); - } - } - elsif ($file_time >= $$Prun_time ) { - # File generated during run. So treat as non-existent at beginning - rdb_set_file1( $rule, $file, 0, -1, 0); - $$Pout_of_date = 1; - } - # Else default of current state of file is correct. - } # END not previously existent file - } # END file -} # END rdb_update_files_for_rule - -#************************************************************ - sub rdb_set_dependentsA { # Call rdb_set_dependentsA( rules ...) # Returns array (sorted), of new source files. @@ -4622,6 +4602,32 @@ sub rdb_makeB1 { if ($failure & ! $force_mode) {return;} if ( ! defined $pass{$rule} ) {$pass{$rule} = 0; } &rdb_clear_change_record; + + # Special fix up for bibtex: + my $bibtex_not_run = -1; # Flags status as to whether this is a + # bibtex rule and if it is, whether out-of-date condition is to + # be ignored. + # -1 => not a bibtex rule + # 0 => no special treatment + # 1 => don't run bibtex because of non-existent bibfiles + # (and setting to do this test) + # 2 => don't run bibtex because of setting + my @missing_bib_files = (); + if ( $rule =~ /^bibtex/ ) { + $bibtex_not_run = 0; + if ($bibtex_use == 0) { + $bibtex_not_run = 2; + } + elsif ($bibtex_use == 1) { + foreach ( keys %$PHsource ) { + if ( ( /\.bib$/ ) && (! -e $_) ) { + push @missing_bib_files, $_; + $bibtex_not_run = 1; + } + } + } + } + if ( ($$Prun_time == 0) && exists($possible_primaries{$rule}) ) { push @rules_never_run, $rule; $$Pout_of_date = 1; @@ -4675,6 +4681,7 @@ sub rdb_makeB1 { print "$My_name: applying rule '$rule'...\n"; &rdb_diagnose_changes( "Rule '$rule': " ); } + $rules_applied{$rule} = 1; $runs++; @@ -4697,11 +4704,23 @@ sub rdb_makeB1 { return; } $pass{$rule}++; - warn_running( "Run number $pass{$rule} of rule '$rule'" ); - if ($$Pcmd_type eq 'primary' ) { - $return = &rdb_primary_run; + if ($bibtex_not_run > 0) { + if ($bibtex_not_run == 1 ) { + show_array ("$My_name: I WON'T RUN '$rule' because I don't find the following files:", + @missing_bib_files); + } + elsif ($bibtex_not_run == 2 ) { + warn "$My_name: I AM CONFIGURED/INVOKED NOT TO RUN '$rule'\n"; + } + $return = &rdb_dummy_run1; + } + else { + warn_running( "Run number $pass{$rule} of rule '$rule'" ); + if ($$Pcmd_type eq 'primary' ) { + $return = &rdb_primary_run; + } + else { $return = &rdb_run1; } } - else { $return = &rdb_run1; } if ($$Pchanged) { $newrule_nofile = 1; $return = 0; @@ -4950,6 +4969,32 @@ sub rdb_run1 { #----------------- +sub rdb_dummy_run1 { + # Assumes contexts for: rule. + # Update rule state as if the rule ran successfully, + # but don't run the rule. + # Returns 0 (success code) + + # Source file data, by definition, correspond to the file state just before + # the latest run, and the run_time to the time just before the run: + &rdb_update_filesA; + $$Prun_time = time; + $$Pchanged = 0; # No special changes in files + $$Plast_result = 0; + $$Plast_message = ''; + + if ($$Ptest_kind == 3) { + # We are time-criterion first time only. Now switch to + # file-change criterion + $$Ptest_kind = 1; + } + $$Pout_of_date = $$Pout_of_date_user = 0; + + return 0; +} # END rdb_dummy_run1 + +#----------------- + sub rdb_ext_cmd { # Call: rdb_ext_cmd # Assumes rule context. Runs external command with substitutions. diff --git a/Master/texmf/doc/man/man1/latexmk.1 b/Master/texmf/doc/man/man1/latexmk.1 index 5ef13279d0e..f2b49a75b9b 100644 --- a/Master/texmf/doc/man/man1/latexmk.1 +++ b/Master/texmf/doc/man/man1/latexmk.1 @@ -1,4 +1,4 @@ -.TH LATEXMK 1L "24 November 2009" "" +.TH LATEXMK 1L "13 January 2010" "" .SH NAME latexmk \- generate LaTeX document .SH SYNOPSIS @@ -14,8 +14,8 @@ source file for a document, and it issues the appropriate sequence of commands to generate a .dvi, .ps, .pdf and/or hardcopy version of the document. .PP -By default \fIlatexmk\fR will run the commands necessary to generate a -.dvi file. +By default \fIlatexmk\fR will run the commands necessary to generate +a .dvi file. .PP \fILatexmk\fR can also be set to run continuously with a suitable previewer. In that case the LaTeX program, etc, are rerun whenever @@ -103,6 +103,40 @@ is automatically added, just as LaTeX does. Thus, if you specify: then \fIlatexmk\fR will operate on the file "foo.tex". .TP +.B -bibtex +When the source file uses bbl files for bibliography, run bibtex as needed +to regenerate the bbl files. + +This property can also be configured by setting the \fI$bibtex_use\fR +variable to 2 in a configuration file +.TP +.B -bibtex- +Never run bibtex. + +A common use for this option is when a document comes from an external +source, complete with its bbl file(s), and the user does not have the +corresponding bib files available. In this situation use of the +\fB-bibtex-\fR option will prevent \fIlatexmk\fR from trying to run +\fIbibtex\fR, which would result in overwriting of the bbl files. +.TP +.B -bibtex-cond +When the source file uses bbl file(s) for the bibliography, run +\fIbibtex\fR as needed to regenerate the bbl files, but only if the +relevant bib file(s) exist. Thus when the bib files are not +available, \fIbibtex\fR is not run, thereby avoiding overwriting of +the bbl file(s). This is the default setting. + +(Note that it is possible for \fIlatexmk\fR to decide that the bib +file does not exist, even though the bib file does exist and +\fIbibtex\fR finds it. The problem is that the bib file may not be in +the current directory but in some search path; the places +\fIlatexmk\fR and \fIbibtex\fR cause to be searched need not be +identical. On modern installations of TeX and related programs this +problem should not arise, since \fIlatexmk\fR uses the \fIkpsewhich\fR +program to do the search, and \fIkpsewhich\fR should use the same +search path as \fIbibtex\fR. If this problem arises, use the +\fB-bibtex\fR option when invoking \fIlatexmk\fR.) +.TP .B -bm <message> A banner message to print diagonally across each page when converting the dvi file to postscript. The message must be a single argument on @@ -139,6 +173,9 @@ removed. This cleanup is instead of a regular make. See the \fB-gg\fR option if you want to do a cleanup then a make. + +If \fI$bibtex_use\fR is set to 0 or 1, bbl files are counted as +non-regeneratable. .TP .B -C Clean up (remove) all regeneratable files generated by \fIlatex\fR and @@ -148,6 +185,9 @@ in the \fI$clean_full_ext\fR configuration variable. This cleanup is instead of a regular make. See the \fB-gg\fR option if you want to do a cleanup than a make. + +If \fI$bibtex_use\fR is set to 0 or 1, bbl files are counted as +non-regeneratable. .TP .B -CA Clean up (remove) absolutely all regeneratable files. It is now @@ -156,6 +196,9 @@ equivalent to the \fB-C\fR option This cleanup is instead of a regular make. See the \fB-gg\fR option if you want to do a cleanup then a make. + +If \fI$bibtex_use\fR is set to 0 or 1, bbl files are counted as +non-regeneratable. .TP .B -CF Remove the file containing the database of source file information, @@ -290,6 +333,15 @@ The inverse of the \fB-new-viewer\fR option. It puts \fIlatexmk\fR in its normal behavior that in preview-continuous mode it checks for an already-running previewer. .TP +.B -nobibtex +Never run bibtex. + +A common use for this option is when a document comes from an external +source, complete with its bbl file(s), and the user does not have the +corresponding bib files available. In this situation use of the +\fB-nobibtex\fR option will prevent \fIlatexmk\fR from trying to run +\fIbibtex\fR, which would result in overwriting of the bbl files. +.TP .B -p Print out the document. By default it is the generated postscript file that is printed. But you can use the @@ -785,6 +837,21 @@ The BibTeX processing program. .B $bibtex_silent_switch ["-terse"] \fBSwitch(es)\fR for the BibTeX processing program when silent mode is on. .TP +.B $bibtex_use [1] +Under what conditions to run BibTeX. When \fIlatexmk\fR discovers +from the log file that one (or more) BibTeX-generated bibliographies +are used, it can run BibTeX whenever 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 will result in incorrect overwriting of the +precious bbl files. The variable \fI$bibtex_use\fR controls whether +this happens. Its possible values are: 0: never use BibTeX. 1: only +use BibTeX if the bib files exist. 2: run BibTeX whenever it appears +necessary to update the bbl files, without testing for the existence +of the bib files. +.TP .B $cleanup_includes_generated [0] If nonzero, specifies that cleanup also deletes files that are detected in log file as being generated (see the \\openout lines in @@ -1002,8 +1069,8 @@ has changed. .B $kpsewhich ["kpsewhich %S"] The program called to locate a source file when the name alone is not sufficient. Most filenames used by \fIlatexmk\fR have sufficient path -information to be found directly. But sometimes, notably when -.bib files are found from the log file of a bibtex run, the name of +information to be found directly. But sometimes, notably +when .bib files are found from the log file of a bibtex run, the name of the file, but not its path is known. The program specified by $kpsewhich is used to find it. @@ -1589,7 +1656,7 @@ e-mail addresses are not written in their standard form to avoid being harvested by worms and viruses.) .SH AUTHOR Current version, by John Collins (username collins at node phys.psu.edu). -(Version 4.11). +(Version 4.13). Released version can be obtained from CTAN: <http://www.tug.org/tex-archive/support/latexmk/>, and from the diff --git a/Master/texmf/doc/man/man1/latexmk.man1.pdf b/Master/texmf/doc/man/man1/latexmk.man1.pdf Binary files differindex 0c87487974a..962a0105291 100644 --- a/Master/texmf/doc/man/man1/latexmk.man1.pdf +++ b/Master/texmf/doc/man/man1/latexmk.man1.pdf |