summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support/latexmk
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2011-01-29 23:24:32 +0000
committerKarl Berry <karl@freefriends.org>2011-01-29 23:24:32 +0000
commit78945180d93da4cff20fc17d331fc2874fa5b2b5 (patch)
tree20ca52b78e653dc648219089d92b643d98b80d34 /Master/texmf-dist/doc/support/latexmk
parenta14b05861d2dd0b4c264b70a4d181f6f8533cedf (diff)
latexmk 4.22d (30jan11)
git-svn-id: svn://tug.org/texlive/trunk@21226 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support/latexmk')
-rw-r--r--Master/texmf-dist/doc/support/latexmk/CHANGES4
-rw-r--r--Master/texmf-dist/doc/support/latexmk/INSTALL2
-rw-r--r--Master/texmf-dist/doc/support/latexmk/README6
-rw-r--r--Master/texmf-dist/doc/support/latexmk/latexmk.pdfbin85906 -> 82802 bytes
-rw-r--r--Master/texmf-dist/doc/support/latexmk/latexmk.txt607
5 files changed, 321 insertions, 298 deletions
diff --git a/Master/texmf-dist/doc/support/latexmk/CHANGES b/Master/texmf-dist/doc/support/latexmk/CHANGES
index b1450e7c850..0e7fa4e8b9a 100644
--- a/Master/texmf-dist/doc/support/latexmk/CHANGES
+++ b/Master/texmf-dist/doc/support/latexmk/CHANGES
@@ -227,3 +227,7 @@ From v. 4.22 to v. 4.22b
From v. 4.22b to v. 4.22c
Biber support is now compatible with MikTeX.
+From v. 4.22c to v. 4.22d
+ Fix compatibility problem MiKTeX v. 2.8, that latexmk didn't
+ always detect use of makeindex.
+
diff --git a/Master/texmf-dist/doc/support/latexmk/INSTALL b/Master/texmf-dist/doc/support/latexmk/INSTALL
index 76bda9ad95a..429ccf9faff 100644
--- a/Master/texmf-dist/doc/support/latexmk/INSTALL
+++ b/Master/texmf-dist/doc/support/latexmk/INSTALL
@@ -1,6 +1,6 @@
INSTALLING latexmk
==================
- (Version 4.22b, 23 January 2011)
+ (Version 4.22d, 26 January 2011)
John Collins
Physics Department
diff --git a/Master/texmf-dist/doc/support/latexmk/README b/Master/texmf-dist/doc/support/latexmk/README
index 6bb21a8acf6..be65d6230b8 100644
--- a/Master/texmf-dist/doc/support/latexmk/README
+++ b/Master/texmf-dist/doc/support/latexmk/README
@@ -1,5 +1,5 @@
-Latexmk, version 4.22b, 9 Jan. 2011
------------------------------------
+Latexmk, version 4.22d, 26 Jan. 2011
+------------------------------------
Latexmk completely automates the process of generating a LaTeX
document. Essentially, it is a highly specialized cousin of the
@@ -92,7 +92,7 @@ NOTES:-
John Collins
---------------------------- "latexmk -h" ----------------------------
-Latexmk 4.22c: Automatic LaTeX document generation routine
+Latexmk 4.22d: Automatic LaTeX document generation routine
Usage: latexmk [latexmk_options] [filename ...]
diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.pdf b/Master/texmf-dist/doc/support/latexmk/latexmk.pdf
index b9524e08bf0..19815d49289 100644
--- a/Master/texmf-dist/doc/support/latexmk/latexmk.pdf
+++ b/Master/texmf-dist/doc/support/latexmk/latexmk.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.txt b/Master/texmf-dist/doc/support/latexmk/latexmk.txt
index 2fa5f96837c..8f30d5725a9 100644
--- a/Master/texmf-dist/doc/support/latexmk/latexmk.txt
+++ b/Master/texmf-dist/doc/support/latexmk/latexmk.txt
@@ -1,9 +1,4 @@
-
-
-LATEXMK(1L) LATEXMK(1L)
-
-
NAME
latexmk - generate LaTeX document
@@ -58,10 +53,15 @@ DESCRIPTION
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,
- 23 January 2011 1
+ 1
@@ -70,11 +70,6 @@ DESCRIPTION
LATEXMK(1L) LATEXMK(1L)
- 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.
@@ -125,21 +120,22 @@ LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE
This property can also be configured by setting the $bibtex_use
variable to 2 in a configuration file
+ -bibtex-
+ Never run bibtex or biber.
+ A common use for this option is when a document comes from an
- 23 January 2011 2
+ 26 January 2011 2
-LATEXMK(1L) LATEXMK(1L)
- -bibtex-
- Never run bibtex or biber.
+LATEXMK(1L) LATEXMK(1L)
+
- 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 -bibtex- option will prevent latexmk from
@@ -167,8 +163,8 @@ LATEXMK(1L) LATEXMK(1L)
-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 spa-
- ces and such.
+ 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.
@@ -190,10 +186,14 @@ LATEXMK(1L) LATEXMK(1L)
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
- 23 January 2011 3
+ 26 January 2011 3
@@ -202,10 +202,6 @@ LATEXMK(1L) LATEXMK(1L)
LATEXMK(1L) LATEXMK(1L)
- -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.
@@ -256,10 +252,14 @@ 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.
- 23 January 2011 4
+
+ 26 January 2011 4
@@ -268,10 +268,6 @@ LATEXMK(1L) LATEXMK(1L)
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:
@@ -323,20 +319,20 @@ 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
- 23 January 2011 5
+ 26 January 2011 5
-LATEXMK(1L) LATEXMK(1L)
- latexmk -e "$latex=q/latex %O -shell-escape %S/" file.tex
+LATEXMK(1L) LATEXMK(1L)
- or
latexmk -e "$latex='latex %O -shell-escape %S'" file.tex
@@ -388,30 +384,30 @@ LATEXMK(1L) LATEXMK(1L)
normal behavior that in preview-continuous mode it checks for an
already-running previewer.
+ -nobibtex
+ Never run bibtex or biber.
+ A common use for this option is when a document comes from an
- 23 January 2011 6
+ 26 January 2011 6
-LATEXMK(1L) LATEXMK(1L)
+LATEXMK(1L) LATEXMK(1L)
- -nobibtex
- Never run bibtex or biber.
- 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 or biber, which would result in overwriting
of the bbl files.
- -p Print out the document. By default it is the generated post-
- script file that is printed. But you can use the -print=...
+ -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).
@@ -455,9 +451,13 @@ LATEXMK(1L) LATEXMK(1L)
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)
+
- 23 January 2011 7
+ 26 January 2011 7
@@ -466,9 +466,6 @@ LATEXMK(1L) LATEXMK(1L)
LATEXMK(1L) LATEXMK(1L)
- -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:
@@ -521,9 +518,12 @@ LATEXMK(1L) LATEXMK(1L)
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
- 23 January 2011 8
+
+ 26 January 2011 8
@@ -532,8 +532,6 @@ LATEXMK(1L) LATEXMK(1L)
LATEXMK(1L) LATEXMK(1L)
- 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
@@ -586,20 +584,20 @@ LATEXMK(1L) LATEXMK(1L)
tex_silent_switch, $biber_silent_switch, $dvips_silent_switch,
$latex_silent_switch, and $pdflatex_silent_switch.
+ -v, -version
+ Print version number of latexmk.
- 23 January 2011 9
+ 26 January 2011 9
-LATEXMK(1L) LATEXMK(1L)
+LATEXMK(1L) LATEXMK(1L)
- -v, -version
- Print version number of latexmk.
-verbose
Opposite of -silent. This is the default setting.
@@ -652,10 +650,14 @@ CONFIGURATION/INITIALIZATION (RC) FILES
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".
- 23 January 2011 10
+
+ 26 January 2011 10
@@ -664,10 +666,6 @@ CONFIGURATION/INITIALIZATION (RC) FILES
LATEXMK(1L) LATEXMK(1L)
- "/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,
@@ -718,22 +716,22 @@ HOW TO SET VARIABLES IN INITIALIZATION FILES
Each statement ends with a semicolon.
Strings should be enclosed in single quotes. (You could use double
+ quotes, as in many programming languages. But then the Perl program-
+ ming language brings into play some special rules for interpolating
+ variables into strings. People not fluent in Perl will want to avoid
+ these complications.)
- 23 January 2011 11
+ 26 January 2011 11
-LATEXMK(1L) LATEXMK(1L)
+LATEXMK(1L) LATEXMK(1L)
- 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
consult a manual for the Perl programming language.
@@ -784,24 +782,24 @@ FORMAT OF COMMAND SPECIFICATIONS
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.
+ 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
- 23 January 2011 12
+ 26 January 2011 12
-LATEXMK(1L) LATEXMK(1L)
+LATEXMK(1L) LATEXMK(1L)
- 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
- 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 $quote_filenames.
@@ -851,23 +849,24 @@ LATEXMK(1L) LATEXMK(1L)
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
+ enclosed in double quotes, as in
+
+ $lpr_pdf = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p
- 23 January 2011 13
+ 26 January 2011 13
-LATEXMK(1L) LATEXMK(1L)
+LATEXMK(1L) LATEXMK(1L)
- 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
- enclosed in double quotes, as in
- $lpr_pdf = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p
%S';
(Note about the above example: Forward slashes are equivalent to back-
@@ -916,24 +915,23 @@ LATEXMK(1L) LATEXMK(1L)
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.
- 23 January 2011 14
+ 26 January 2011 14
-LATEXMK(1L) LATEXMK(1L)
- %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.
+LATEXMK(1L) LATEXMK(1L)
LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES
@@ -982,10 +980,19 @@ LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES
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
- 23 January 2011 15
+ 26 January 2011 15
@@ -994,15 +1001,6 @@ LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES
LATEXMK(1L) LATEXMK(1L)
- 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 sys-
tem, of course. Examples for setting this variable are:
@@ -1048,18 +1046,6 @@ LATEXMK(1L) LATEXMK(1L)
But sometimes, the bib file(s) are not available (e.g., for a
document obtained from an external archive), but the bbl files
-
-
-
- 23 January 2011 16
-
-
-
-
-
-LATEXMK(1L) LATEXMK(1L)
-
-
are provided. In that case use of BibTeX or biber will result
in incorrect overwriting of the precious bbl files. The vari-
able $bibtex_use controls whether this happens. Its possible
@@ -1071,6 +1057,18 @@ LATEXMK(1L) LATEXMK(1L)
$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.,
+
+
+
+ 26 January 2011 16
+
+
+
+
+
+LATEXMK(1L) LATEXMK(1L)
+
+
by use of the -C option, custom dependencies are those listed in
the .fdb_latexmk file from a previous run.)
@@ -1093,8 +1091,8 @@ LATEXMK(1L) LATEXMK(1L)
$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 spa-
- ces.
+ variable is a string containing the extensions separated by
+ spaces.
It is also possible to specify a more general pattern of file to
be deleted, by using the place holder %R, as in commands. Thus
@@ -1114,18 +1112,6 @@ LATEXMK(1L) LATEXMK(1L)
option is selected, i.e., extensions of files to remove when the
.dvi, etc files are to be cleaned-up.
-
-
-
- 23 January 2011 17
-
-
-
-
-
-LATEXMK(1L) LATEXMK(1L)
-
-
@cus_dep_list [()]
Custom dependency list -- see section on "Custom Dependencies".
@@ -1139,6 +1125,18 @@ LATEXMK(1L) LATEXMK(1L)
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 @default_files in an initialization file (e.g., the
+
+
+
+ 26 January 2011 17
+
+
+
+
+
+LATEXMK(1L) LATEXMK(1L)
+
+
file "latexmkrc" in the current directory). Then if no files
are specified on the command line then the files you specify by
setting @default_files are processed.
@@ -1179,20 +1177,8 @@ LATEXMK(1L) LATEXMK(1L)
$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
-
-
-
- 23 January 2011 18
-
-
-
-
-
-LATEXMK(1L) LATEXMK(1L)
-
-
- system has associated with .dvi files.]
+ of Windows, this will cause to be run whatever command the sys-
+ tem has associated with .dvi files.]
$dvipdf ["dvipdf %O %S %D"]
Command to convert dvi to pdf file. A common reconfiguration is
@@ -1209,6 +1195,18 @@ LATEXMK(1L) LATEXMK(1L)
$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
+
+
+
+ 26 January 2011 18
+
+
+
+
+
+LATEXMK(1L) LATEXMK(1L)
+
+
of the $dvips_pdf_switch -- see below -- will be included in the
options substituted for "%O".
@@ -1245,20 +1243,8 @@ LATEXMK(1L) LATEXMK(1L)
4 => run a command to do the update. The command is speci-
fied by the variable $dvi_update_command.
- See information on the variable $pdf_update_method for an
-
-
-
- 23 January 2011 19
-
-
-
-
-
-LATEXMK(1L) LATEXMK(1L)
-
-
- example of updating by command.
+ See information on the variable $pdf_update_method for an exam-
+ ple of updating by command.
$dvi_update_signal [Under UNIX: SIGUSR1, which is a system-dependent
value]
@@ -1280,6 +1266,18 @@ LATEXMK(1L) LATEXMK(1L)
@generated_exts [( aux , bbl , idx , ind , lof , lot , out , toc ,
$fdb_ext )]
This contains a list of extensions for files that are generated
+
+
+
+ 26 January 2011 19
+
+
+
+
+
+LATEXMK(1L) LATEXMK(1L)
+
+
during a LaTeX run and that are read in by LaTeX in later runs,
either directly or indirectly.
@@ -1312,18 +1310,6 @@ LATEXMK(1L) LATEXMK(1L)
If nonzero, process files regardless of timestamps, and is then
equivalent to the -g option.
-
-
-
- 23 January 2011 20
-
-
-
-
-
-LATEXMK(1L) LATEXMK(1L)
-
-
%hash_calc_ignore_pattern
!!!This variable is for experts only!!!
@@ -1351,6 +1337,18 @@ LATEXMK(1L) LATEXMK(1L)
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
+
+
+
+ 26 January 2011 20
+
+
+
+
+
+LATEXMK(1L) LATEXMK(1L)
+
+
extension .eps has changed.
There is only one regular expression available for each exten-
@@ -1378,18 +1376,6 @@ LATEXMK(1L) LATEXMK(1L)
The program called to locate a source file when the name alone
is not sufficient. Most filenames used by latexmk have suffi-
cient path information to be found directly. But sometimes,
-
-
-
- 23 January 2011 21
-
-
-
-
-
-LATEXMK(1L) LATEXMK(1L)
-
-
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.
@@ -1423,6 +1409,17 @@ LATEXMK(1L) LATEXMK(1L)
specified by the variable %latex_input_extensions. The default
extensions are 'tex' and 'eps'.
+
+
+ 26 January 2011 21
+
+
+
+
+
+LATEXMK(1L) LATEXMK(1L)
+
+
(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-
@@ -1444,18 +1441,6 @@ LATEXMK(1L) LATEXMK(1L)
its graphics/graphicx packages.
-
-
-
- 23 January 2011 22
-
-
-
-
-
-LATEXMK(1L) LATEXMK(1L)
-
-
$latex_silent_switch ["-interaction=batchmode"]
Switch(es) for the LaTeX processing program when silent mode is
on.
@@ -1494,6 +1479,18 @@ LATEXMK(1L) LATEXMK(1L)
The printing program to print pdf files.
Under MS-Windows you could set this to use gsview, if it is
+
+
+
+ 26 January 2011 22
+
+
+
+
+
+LATEXMK(1L) LATEXMK(1L)
+
+
installed, e.g.,
$lpr = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p';
@@ -1510,18 +1507,6 @@ LATEXMK(1L) LATEXMK(1L)
$max_repeat [5]
The maximum number of times latexmk will run latex/pdflatex
-
-
-
- 23 January 2011 23
-
-
-
-
-
-LATEXMK(1L) LATEXMK(1L)
-
-
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
@@ -1566,27 +1551,27 @@ LATEXMK(1L) LATEXMK(1L)
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 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' );
- removes the extension 'tex' from pdflatex_input_extensions
+ 26 January 2011 23
- 23 January 2011 24
+LATEXMK(1L) LATEXMK(1L)
+ (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:
-LATEXMK(1L) LATEXMK(1L)
+ remove_input_ext( 'pdflatex', 'tex' );
+ removes the extension 'tex' from pdflatex_input_extensions
add_input_ext( 'pdflatex', 'asdf' );
@@ -1637,22 +1622,22 @@ LATEXMK(1L) LATEXMK(1L)
for the value 2, to specify update by signal, the signal is
specified by $pdf_update_signal.)
- Note that acroread under MS-Windows (but not UNIX) locks the pdf
- file, so the default value is then 3.
- Arranging to use a command to get a previewer explicitly updated
- requires three variables to be set. For example:
+ 26 January 2011 24
- 23 January 2011 25
+LATEXMK(1L) LATEXMK(1L)
-LATEXMK(1L) LATEXMK(1L)
+ 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;
@@ -1710,8 +1695,7 @@ LATEXMK(1L) LATEXMK(1L)
-
- 23 January 2011 26
+ 26 January 2011 25
@@ -1727,8 +1711,8 @@ LATEXMK(1L) LATEXMK(1L)
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
- process number is determined.
+ 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
(i.e., the command is not used), "ps --width 200 -f -u
@@ -1741,9 +1725,9 @@ LATEXMK(1L) LATEXMK(1L)
Command to convert ps to pdf file.
$ps_filter [empty]
- The postscript file filter to be run on the newly produced post-
- script file before other processing. Equivalent to specifying
- the -pF option.
+ 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-
@@ -1774,21 +1758,21 @@ LATEXMK(1L) LATEXMK(1L)
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.)
- 23 January 2011 27
+ 26 January 2011 26
-LATEXMK(1L) LATEXMK(1L)
- 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.)
+LATEXMK(1L) LATEXMK(1L)
$ps_update_signal [Under UNIX: SIGHUP, which is a system-dependent
@@ -1811,8 +1795,8 @@ LATEXMK(1L) LATEXMK(1L)
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 spa-
- ces. (But note that many versions of LaTeX and PdfLaTeX cannot cor-
+ 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.)
@@ -1840,10 +1824,20 @@ LATEXMK(1L) LATEXMK(1L)
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
- 23 January 2011 28
+ 26 January 2011 27
@@ -1852,16 +1846,6 @@ LATEXMK(1L) LATEXMK(1L)
LATEXMK(1L) LATEXMK(1L)
- $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
value of "default" means that the "highest" of the kinds of file
generated is to be used (among dvi, ps and pdf).
@@ -1906,18 +1890,6 @@ CUSTOM DEPENDENCIES
tion should return 0 if it was successful and a nonzero number
if it failed.
-
-
-
- 23 January 2011 29
-
-
-
-
-
-LATEXMK(1L) LATEXMK(1L)
-
-
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
@@ -1933,6 +1905,18 @@ LATEXMK(1L) LATEXMK(1L)
those without knowledge of the Perl programming language. Of course,
experts could do something much more elaborate.
+
+
+
+ 26 January 2011 28
+
+
+
+
+
+LATEXMK(1L) LATEXMK(1L)
+
+
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.
@@ -1973,17 +1957,6 @@ LATEXMK(1L) LATEXMK(1L)
could put single quotes around filenames in the command line that is
executed:
-
-
- 23 January 2011 30
-
-
-
-
-
-LATEXMK(1L) LATEXMK(1L)
-
-
add_cus_dep( 'fig', 'eps', 0, 'fig2eps' );
sub fig2eps {
system("fig2dev -Lps '$_[0].fig' '$_[0].eps'");
@@ -1991,10 +1964,10 @@ LATEXMK(1L) LATEXMK(1L)
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 spa-
- ces. 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.
+ 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
@@ -2003,6 +1976,18 @@ LATEXMK(1L) LATEXMK(1L)
add_cus_dep( 'fig', 'pdf, 0, 'fig2pdf' );
sub fig2pdf {
system("fig2dev -Lpdf $_[0].fig $_[0].pdf");
+
+
+
+ 26 January 2011 29
+
+
+
+
+
+LATEXMK(1L) LATEXMK(1L)
+
+
}
If you have some general custom dependencies defined in the system or
@@ -2038,18 +2023,6 @@ LATEXMK(1L) LATEXMK(1L)
}
(You will need to modify this code if you use filenames with spaces in
-
-
-
- 23 January 2011 31
-
-
-
-
-
-LATEXMK(1L) LATEXMK(1L)
-
-
them, to provide correct quoting of the filenames.)
Those of you with experience with Makefiles, will undoubtedly be con-
@@ -2073,8 +2046,20 @@ 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-
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"
+ strings, and each string in the array has four items in it, each
+
+
+
+ 26 January 2011 30
+
+
+
+
+
+LATEXMK(1L) LATEXMK(1L)
+
+
+ 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.
@@ -2103,20 +2088,8 @@ BUGS
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
-
-
-
- 23 January 2011 32
-
-
-
-
-
-LATEXMK(1L) LATEXMK(1L)
-
-
- previewers: Xdvi on UNIX/LINUX works for dvi files. Gv on UNIX/LINUX
+ 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
@@ -2135,10 +2108,10 @@ THANKS TO
AUTHOR
Current version, by John Collins (username collins at node
- phys.psu.edu). (Version 4.22c).
+ phys.psu.edu). (Version 4.22d).
- Released version can be obtained from CTAN: <http://www.tug.org/tex-ar-
- chive/support/latexmk/>, and from the author's website
+ 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)
Original script called "go" by David J. Musliner (RCS Version 3.2)
@@ -2148,6 +2121,52 @@ AUTHOR
+ 26 January 2011 31
+
+
+
+
+
+LATEXMK(1L) LATEXMK(1L)
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
@@ -2173,6 +2192,6 @@ AUTHOR
- 23 January 2011 33
+ 26 January 2011 32