table of contents
- NAME
- SYNOPSIS
- DESCRIPTION
- LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE
- EXAMPLES
- CONFIGURATION/INITIALIZATION (RC) FILES
- HOW TO SET VARIABLES IN INITIALIZATION FILES
- FORMAT OF COMMAND SPECIFICATIONS
- LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES
- CUSTOM DEPENDENCIES
- OLD METHOD OF DEFINING CUSTOM DEPENDENCIES
- USING latexmk WITH make
- SEE ALSO
- BUGS
- THANKS TO
- AUTHOR
other versions
LATEXMK(1L) | LATEXMK(1L) |
NAME¶
latexmk - generate LaTeX documentSYNOPSIS¶
latexmk [options] [file ...]DESCRIPTION¶
Latexmk completely automates the process of compiling a LaTeX document. Essentially, it is like a specialized relative of the general make utility, but one which determines dependencies automatically and has some other very useful features. In its basic mode of operation latexmk 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. 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 on-screen view of the compiled document. Latexmk determines which are the source files by examining the log file. (Optionally, it also examines the list of input and output files generated by the -recorder option of modern versions of latex and pdflatex. See the documentation for the -recorder option of latexmk below.) 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 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, biber, 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 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 and command line options. The second previewing option is the powerful -pvc option (mnemonic: "preview continuously"). In this case, latexmk runs continuously, regularly monitoring all the source files to see if any have changed. Every time a change is detected, latexmk runs all the programs necessary to generate a new version of the document. A good previewer (like gv) will then automatically update its display. Thus the user can simply edit a file and, when the changes are written to disk, latexmk 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. For other previewers, the user may have to manually make the previewer update its display, which can be (some versions of xdvi and gsview) as simple as forcing a redraw of its display. Latexmk has the ability to print a banner in gray diagonally across each page when making the postscript file. It can also, if needed, call an external program to do other postprocessing on the generated files. Latexmk 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 latexmk often works without special configuration 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 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, 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 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, 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 working directory with a ".tex" extension. This behavior can be changed: see the description concerning the @default_files variable in the section "List of configuration variables usable in initialization files".
- -bibtex
- When the source file uses bbl files for bibliography, run
bibtex or biber as needed to regenerate the bbl files.
- -bibtex-
- Never run bibtex or biber.
- -bibtex-cond
- When the source file uses bbl file(s) for the bibliography,
run bibtex or biber 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 or biber is not run, thereby avoiding
overwriting of the bbl file(s). This is the default setting.
- -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.
- -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 message. The default is 220.0 which is just right for 5 character messages.
- -commands
- List the commands used by latexmk for processing files, and then exit.
- -c
- Clean up (remove) all regeneratable files generated by
latex and bibtex or biber 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 @generated_exts configuration variable. In
addition, files with extensions by the $clean_ext configuration
variable are removed.
- -C
- Clean up (remove) all regeneratable files generated by
latex and bibtex or biber. This is the same as the
-c option with the addition of dvi, postscript and pdf files, and
those with extensions in the $clean_full_ext configuration
variable.
- -CA
- (Obsolete). Now equivalent to the -C option. See that option for details.
- -CF
- Remove the file containing the database of source file information, before doing the other actions requested.
- -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 -bs and
-bi options. The -bm option will override this option as
this is really just a short way of specifying:
- -deps
- Show a list of dependent files after processing. This is in
the form of a dependency list of the form used by the make program,
and it is therefore suitable for use in a Makefile. It gives an overall
view of the files without listing intermediate files, as well as
latexmk can determine them.
- -dependents
- Equivalent to -deps.
- -deps-
- Do not show a list of dependent files after processing. (This is the default.)
- -dependents-
- Equivalent to -deps-.
- -deps-out=FILENAME
- Set the filename to which the list of dependent files is
written. If the FILENAME argument is omitted or set to '-', then the
output is sent to stdout.
- -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.
- -diagnostics
- Print detailed diagnostics during a run. This may help for debugging problems or to understand latexmk's behavior in difficult situations.
- -dvi
- Generate dvi version of document.
- -dvi-
- Turn off generation of dvi version of document. (This may get overridden, if some other file is made (e.g., a .ps file) that is generated from the dvi file, or if no generated file at all is requested.)
- -e <code>
- Execute the specified initialization code before
processing. The code is Perl code of the same form as is used in
latexmk's initialization files -- for more details, see the
information on the -r option, and the section about
"Configuration/initialization (RC) files". The code is typically
a sequence of assignment statements separated by semicolons.
- -f
- Force latexmk to continue document processing despite errors. Normally, when latexmk detects that LaTeX or another program has found an error which will not be resolved by further processing, no further processing is carried out.
- -f-
- Turn off the forced processing-past-errors such as is set by the -f option. This could be used to override a setting in a configuration file.
- -g
- Force latexmk to process document fully, even under situations where latexmk would normally decide that no changes in the source files have occurred since the previous run. This option is useful, for example, if you change some options and wish to reprocess the files.
- -g-
- Turn off -g.
- -gg
- "Super go mode" or "clean make": clean out generated files as if -C had been given, and then do a regular make.
- -h, -help
- Print help information.
- -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.
- -l-
- Turn off -l.
- -new-viewer
- When in continuous-preview mode, always start a new viewer to view the generated file. By default, latexmk 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.
- -new-viewer-
- The inverse of the -new-viewer option. It puts latexmk in its normal behavior that in preview-continuous mode it checks for an already-running previewer.
- -nobibtex
- Never run bibtex or biber.
- -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 configure this
in a start up file (by setting the $print_type variable).
- Generate pdf version of document using pdflatex.
- -pdfdvi
- 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 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 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 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 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 extension
".psF". All extra processing (e.g. preview, printing) will then
be performed on this filtered postscript file.
- -pv
- Run file previewer. If the -view 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 -dvi, -ps, -pdf, -pdfps 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 -p and -pvc options, so it turns them off.
- -pv-
- Turn off -pv.
- -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 options off.
- -pvc-
- Turn off -pvc.
- -quiet
- Same as -silent
- -r <rcfile>
- Read the specified initialization file ("RC
file") before processing.
- -recorder
- Use the -recorder option with latex and
pdflatex. In (most) modern versions of these programs, this results
in a file of extension .fls containing a list of the files that
these programs have read and written. Latexmk will then use this
file to improve its detection of source files and generated files after a
run of latex or pdflatex.
- -recorder-
- Do not use the -recorder option with latex and pdflatex.
- -rules
- Show a list of latemk's rules and dependencies after processing.
- -rules-
- Do not show a list of latexmk's rules and dependencies after processing. (This is the default.)
- -silent
- Run commands silently, i.e., with options that reduce the
amount of diagnostics generated. For example, with the default settings,
the command "latex -interaction=batchmode" is used for latex.
- -use-make
- When after a run of latex or pdflatex, there
are warnings about missing files (e.g., as requested by the LaTeX \input,
\include, and \includgraphics), latexmk tries to make them by a
custom dependency. If no relevant custom dependency with an appropriate
source file is found, and if the -use-make option is set, then
latexmk will try as a resort using the make program to try to make
the missing files.
- -use-make-
- Do not use the make program to try to make missing files. (Default.)
- -v, -version
- Print version number of latexmk.
- -verbose
- Opposite of -silent. This is the default setting.
- -view=default, -view=dvi, -view=ps, -view=pdf
- Set the kind of file used when previewing is requested (e.g., by the -pv or -pvc switches). The default is to view the "highest" kind of requested file (in the order dvi, ps, pdf).
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 keep running, watching for source file changes. % latexmk -c # remove .aux, .log, .bbl, .blg, .dvi, .pdf, .ps & .bbl files
CONFIGURATION/INITIALIZATION (RC) FILES¶
Latexmk can be customized using initialization files, which are read at startup in the following order: 1) The system RC file, if it exists.On a UNIX system, latexmk 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".
On a cygwin system (i.e., a MS-Windows system in which perl is
that of cygwin), latexmk reads for the first it finds of
"/cygdrive/c/latexmk/LatexMk",
"/opt/local/share/latexmk/LatexMk",
"/usr/local/share/latexmk/LatexMk",
"/usr/local/lib/latexmk/LatexMk". 2) The user's RC file, "$HOME/.latexmkrc", if it exists. Here $HOME is the value of the environment variable HOME. On UNIX and clones (including LINUX), this variable is set by the system; on MS-Windows, the user may choose to set it. 3) The RC file in the current working directory. This file can be named either "latexmkrc" or ".latexmkrc", and the first of these to be 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 as templates. Comment lines are introduced by the "#" character.
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'; for the setting of a string variable, $preview_mode = 1; for the setting of a numeric variable, and @default_files = ('paper', 'paper1'); for the setting of an array of strings. It is possible to append an item to an array variable as follows:FORMAT OF COMMAND SPECIFICATIONS¶
Some of the variables set the commands that latexmk uses for carrying out its work, for example to generate a dvi file from a tex file or to view a postscript file. This section describes some important features of how the commands are specified.$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".)
- %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).
- %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 dvi file to ps).
- %T
- The name of the primary tex file.
$bibtex = 'bibtex %O %B'; Generally, you should use %B rather than %R. Similarly for most purposes, the name %T of the primary texfile is not a useful placeholder.
$dvi_previewer = 'start xdvi %O %S'; This will be translated to whatever is appropriate for your operating system.
$lpr_pdf = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p %S'; (Note about the above example: Forward slashes are equivalent to backslashes in filenames under MS-Windows, provided that the filename is inside double quotes. It is easier to use forward slashes in examples like the one above, since then one does not have to worry about the rules for dealing with forward slashes in strings in the Perl language.)
$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 for a postscript viewer and a pdf viewer.)
$lpr = 'NONE lpr'; This typically is used when an appropriate command does not exist on your system. The string after the "NONE" is effectively a comment.
$latex = 'latex --src-specials %O %S';
$pdflatex = 'pdflatex --shell-escape %O %S; pst2pdf_for_latexmk %B';
LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES¶
Default values are indicated in brackets.- $always_view_file_via_temporary [0]
- Whether ps and pdf files are initially to be made in a
temporary directory and then moved to the final location. (This applies to
dvips, dvipdf, and ps2pdf operations, and the filtering operators on dvi
and ps files. It does not apply to pdflatex, unfortunately.)
- $banner [0]
- If nonzero, the banner message is printed across each page
when converting the dvi file to postscript. Without modifying the variable
$banner_message, this is equivalent to specifying the -d
option.
- $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 black, 1 is white. The default is just right if your toner cartridge isn't running too low.
- $banner_message ["DRAFT"]
- The banner message to print across each page when converting the 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. 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
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" );
- $biber ["biber %O %S"]
- The biber processing program.
- $biber_silent_switch ["--onlylog"]
- Switch(es) for the biber processing program when silent mode is on.
- $bibtex ["bibtex %O %S"]
- The BibTeX processing program.
- $bibtex_silent_switch ["-terse"]
- Switch(es) for the BibTeX processing program when silent mode is on.
- $bibtex_use [1]
- Under what conditions to run BibTeX or biber. When
latexmk discovers from the log file that one (or more)
BibTeX/biber-generated bibliographies are used, it can run BibTeX or biber
whenever it appears necessary to regenerate the bbl file(s) from their
source bib database file(s).
- $cleanup_includes_cusdep_generated [0]
- If nonzero, specifies that cleanup also deletes files that are generated by custom dependencies. (When doing a clean up, e.g., by use of the -C option, custom dependencies are those listed in the .fdb_latexmk file from a previous run.)
- $cleanup_includes_generated [0]
- If nonzero, specifies that cleanup also deletes files that are detected in log file as being generated (see the \openout lines in the log file). It will also include files made from these first generation generated files.
- $cleanup_mode [0]
- If nonzero, specifies cleanup mode: 1 for full cleanup, 2 for cleanup except for dvi, ps and pdf files, 3 for cleanup except for dep and aux files. (There is also extra cleaning as specified by the $clean_ext, $clean_full_ext and @generated_exts variables.)
- $clean_ext [""]
- Extra extensions of files for latexmk to remove when
any of the clean-up options ( -c or -C) is selected. The
value of this variable is a string containing the extensions separated by
spaces.
$clean_ext = "out %R-blx.bib";
- $clean_full_ext [""]
- Extra extensions of files for latexmk to remove when the -C option is selected, i.e., extensions of files to remove when the .dvi, etc files are to be cleaned-up.
- @cus_dep_list [()]
- Custom dependency list -- see section on "Custom Dependencies".
- @default_files [("*.tex")]
- Default list of files to be processed.
@default_files = ("paper_current");
@default_files = ("paper1", "paper2.tex");
@default_files = ("*.tex", "*.dtx");
- $dependents_list [0]
- Whether to display a list(s) of dependencies at the end of a run.
- $dvi_filter [empty]
- The dvi file filter to be run on the newly produced dvi file before other processing. Equivalent to specifying the -dF option.
- $dvi_mode [See below for default]
- If nonzero, generate a dvi version of the document. Equivalent to the -dvi option.
- $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.]
- $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.]
- $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";
- $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".
- $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.
- $dvips_pdf_switch ["-P pdf"]
- Switch(es) for dvips program when pdf file is to be generated from ps file.
- $dvips_silent_switch ["-q"]
- Switch(es) for dvips program when silent mode is on.
- $dvi_update_command [""]
- When the dvi previewer is set to be updated by running a command, this is the command that is run. See the information for the variable $dvi_update_method for further information, and see information on the variable $pdf_update_method for an example for the analogous case of a pdf previewer.
- $dvi_update_method [2 under UNIX, 1 under MS-Windows]
- How the dvi viewer updates its display when the dvi file
has changed. The values here apply equally to the
$pdf_update_method and to the $ps_update_method variables.
0 => update is automatic,
1=> manual update by user, which may only mean a mouse click on the viewer's window or may mean a more serious action.
2 => Send the signal, whose number is in the variable $dvi_update_signal. 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 $dvi_update_command.
- $dvi_update_signal [Under UNIX: SIGUSR1, which is a system-dependent value]
- The number of the signal that is sent to the dvi viewer when it is updated by sending a signal -- see the information on the variable $dvi_update_method. The default value is the one appropriate for xdvi on a UNIX system.
- $fdb_ext ["fdb_latexmk"]
- The extension of the file which latexmk generates to contain a database of information on source files. You will not normally need to change this.
- $force_mode [0]
- If nonzero, continue processing past minor latex errors including unrecognized cross references. Equivalent to specifying the -f option.
- @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.
push @generated_exts, "end";
- $go_mode [0]
- If nonzero, process files regardless of timestamps, and is then equivalent to the -g option.
- %hash_calc_ignore_pattern
- !!!This variable is for experts only!!!
$hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: ';
$hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: |^%%Title: ';
delete $hash_calc_ignore_pattern{'eps'};
- $kpsewhich ["kpsewhich %S"]
- The program called to locate a source file when the name
alone is not sufficient. Most filenames used by latexmk have
sufficient path information to be found directly. But sometimes, notably
when .bib files are found from the log file of a bibtex or biber run, the
name of the file, but not its path is known. The program specified by
$kpsewhich is used to find it.
- $landscape_mode [0]
- If nonzero, run in landscape mode, using the landscape mode previewers 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
program used, but also specify options to the program. E.g.,
- %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.
remove_input_ext( 'latex', 'tex' );
add_input_ext( 'latex', 'asdf' );
- $latex_silent_switch ["-interaction=batchmode"]
- Switch(es) for the LaTeX processing program when silent
mode is on.
$latex_silent_switch = "-interaction=batchmode -c-style-errors";
- $lpr ["lpr %O %S" under UNIX/LINUX, "NONE lpr" under MS-WINDOWS]
- The command to print postscript files.
$lpr = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p';
- $lpr_dvi ["NONE lpr_dvi"]
- The printing program to print dvi files.
- $lpr_pdf ["NONE lpr_pdf"]
- The printing program to print pdf files.
$lpr = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p';
- $make ["make"]
- The make processing program.
- $makeindex ["makeindex %O -o %D %S"]
- 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 needs to bail out, rather than rerunning latex/pdflatex again to
resolve cross-references, etc. The default value covers all normal cases.
- $new_viewer_always [0]
- This variable applies to latexmk only in continuous-preview mode. If $new_viewer_always is 0, latexmk will check for a previously running previewer on the same file, and if one is running 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.
- $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 $ps2pdf variable. If equal to 3,
generate a pdf version of the document from the dvi file, by using the
command specified by the $dvipdf variable.
- $pdflatex ["pdflatex %O %S"]
- 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 \input{file} or
\includegraphics{figure}, when the relevant source file does not exist.
remove_input_ext( 'pdflatex', 'tex' );
add_input_ext( 'pdflatex', 'asdf' );
- $pdflatex_silent_switch ["-interaction=batchmode"]
- Switch(es) for the pdflatex program (specified in the
variable $pdflatex when silent mode is on.
$latex_silent_switch = "-interaction=batchmode -c-style-errors";
- $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.]
- $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 $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
for the codes. (Note that information needs be changed slightly so that
for the value 4, to run a command to do the update, the command is
specified by the variable $pdf_update_command, and for the value 2,
to specify update by signal, the signal is specified by
$pdf_update_signal.)
$pdf_previewer = "start xpdf -remote %R %O %S";
$pdf_update_method = 4;
$pdf_update_command = "xpdf -remote %R -reload";
- $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 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 1 (2nd word in line) is correct for Solaris 2.6 and Linux. Setting 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.
- $preview_continuous_mode [0]
- If nonzero, run a previewer to view the document, and continue running latexmk to keep .dvi up-to-date. Equivalent to the -pvc 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 $view.
- $printout_mode [0]
- If nonzero, print the document using lpr. Equivalent to the -p option. This is recommended not to be set from an RC file, otherwise you could waste lots of paper.
- $print_type = ["ps"]
- 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
previewer about file changes).
- $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 postscript file before other processing. Equivalent to specifying the -pF option.
- $ps_previewer ["start gv %O %S", but "start %O %S" under MS-WINDOWS]
- The command to invoke a ps-previewer. (The default under
MS-WINDOWS will cause to be run whatever command the system has associated
with .ps files.)
- $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 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 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
signal, the signal is specified by $ps_update_signal.)
- $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 default value is the one appropriate for gv on a UNIX system.
- $pvc_view_file_via_temporary [1]
- The same as $always_view_file_via_temporary, except
that it only applies in preview-continuous mode (-pvc option).
- $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 as true), then quoting is done. Otherwise quoting is omitted.
- $recorder [0]
- Whether to use the -recorder option to latex
and pdflatex. Use of this option results in a file of extension
.fls containing a list of the files that these programs have read
and written. Latexmk will then use this file to improve its
detection of source files and generated files after a run of latex
or pdflatex.
- $sleep_time [2]
- The time to sleep (in seconds) between checking for source
file changes when running with the -pvc option. This is subject to
a minimum of one second delay, except that zero delay is also allowed.
- $texfile_search [""]
- This is an obsolete variable, replaced by the
@default_files variable.
- $tmpdir [See below for default]
- Directory to store temporary files that latexmk may
generate while running.
- $use_make_for_missing_files [0]
- Whether to use make to try and make files that are
missing after a run of latex or pdflatex, and for which a
custom dependency has not been found. This is generally useful only when
latexmk is used as part of a bigger project which is built by using
the make program.
- $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).
CUSTOM DEPENDENCIES¶
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.add_cus_dep( fromextension, toextension, must, subroutine )
remove_cus_dep( fromextension, toextension )
show_cus_dep()
- from extension:
- 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 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 function should return 0 if it was successful and a nonzero number if it failed.
add_cus_dep( 'fig', 'eps', 0, 'fig2eps' );
sub fig2eps {
system("fig2dev -Leps $_[0].fig $_[0].eps");
}
add_cus_dep( 'fig', 'eps', 0, 'fig2eps' );
sub fig2eps {
system("fig2dev -Lps '$_[0].fig' '$_[0].eps'");
}
add_cus_dep( 'fig', 'pdf, 0, 'fig2pdf' );
sub fig2pdf {
system("fig2dev -Lpdf $_[0].fig $_[0].pdf");
}
remove_cus_dep( 'fig', 'eps' );
show_cus_dep();
add_cus_dep('ndx', 'nnd', 0, 'makendx2nnd');
sub makendx2nnd {
system("makeindex -o $_[0].nnd $_[0].ndx");
}
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 dependencies. 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 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. 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 .fig files to .eps files:push @cus_dep_list, "fig eps 0 fig2eps";
sub fig2eps {
system("fig2dev -Lps $_[0].fig $_[0].eps");
}
USING latexmk WITH make¶
This section is targeted only at advanced users who use the make program for complex projects, as for software development, with the dependencies specified by a Makefile..PHONY : FORCE_MAKE
all : try.pdf
%.pdf : %.tex FORCE_MAKE
latexmk -pdf -dvi- -ps- $<
TARGETS = document1.pdf document2.pdf
DEPS_DIR = .deps
LATEXMK = latexmk -recorder -use-make -deps \
-e 'warn qq(In Makefile, turn off custom dependencies0;' \
-e '@cus_dep_list = ();' \
-e 'show_cus_dep();'
all : $(TARGETS)
$(foreach file,$(TARGETS),$(eval -include $(DEPS_DIR)/$(file)P))
$(DEPS_DIR) :
mkdir $@
%.pdf : %.tex
if [ ! -e $(DEPS_DIR) ]; then mkdir $(DEPS_DIR); fi
$(LATEXMK) -pdf -dvi- -ps- -deps-out=$(DEPS_DIR)/$@P $<
%.pdf : %.fig
fig2dev -Lpdf $< $@
SEE ALSO¶
latex(1), bibtex(1).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.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.24).7 May 2011 |