summaryrefslogtreecommitdiff
path: root/Master/texmf/doc/man/man1
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2011-12-11 22:30:30 +0000
committerKarl Berry <karl@freefriends.org>2011-12-11 22:30:30 +0000
commitbca3b6017c5eda5d6c5d67bb266062fb7f363b5b (patch)
tree4982edcfc2080e1c96ac6d3d3a7b83655c273393 /Master/texmf/doc/man/man1
parent66913a012bff67aeac726ca83cbaffcafbae1118 (diff)
latexmk 4.30a (10dec11)
git-svn-id: svn://tug.org/texlive/trunk@24819 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf/doc/man/man1')
-rw-r--r--Master/texmf/doc/man/man1/latexmk.155
-rw-r--r--Master/texmf/doc/man/man1/latexmk.man1.pdfbin116268 -> 118034 bytes
2 files changed, 44 insertions, 11 deletions
diff --git a/Master/texmf/doc/man/man1/latexmk.1 b/Master/texmf/doc/man/man1/latexmk.1
index 91406c85195..629318f23ad 100644
--- a/Master/texmf/doc/man/man1/latexmk.1
+++ b/Master/texmf/doc/man/man1/latexmk.1
@@ -1,4 +1,4 @@
-.TH LATEXMK 1L "1 December 2011" ""
+.TH LATEXMK 1L "9 December 2011" ""
.SH NAME
latexmk \- generate LaTeX document
.SH SYNOPSIS
@@ -117,8 +117,8 @@ which currently is only implemented on the MiKTeX version of
(pdf)latex.
See also the \fI-outdir\fR/\fI-output-directory\fR options, and the
-\fI$aux_dir\fR and \fI$out_dir\fR configuration variables of
-\fIlatexmk\fR.
+\fI$aux_dir\fR, \fI$out_dir\fR, and \fI$search_path_separator\fR
+configuration variables of \fIlatexmk\fR.
.TP
@@ -437,13 +437,13 @@ no matter where is occurs on the command line.
Sets the directory for the output files of (pdf)latex. This achieves
its effect by the \fI-output-directory\fI option of (pdf)latex, which
-currently (Oct. 2011) is implemented on the common versions of
+currently (Dec. 2011) is implemented on the common versions of
(pdf)latex, i.e., MiKTeX and TeXLive. It may not be present in other
versions.
See also the \fI-auxdir\fR/\fI-aux-directory\fR options, and the
-\fI$aux_dir\fR and \fI$out_dir\fR configuration variables of
-\fIlatexmk\fR.
+\fI$aux_dir\fR, \fI$out_dir\fR, and \fI$search_path_separator\fR
+configuration variables of \fIlatexmk\fR.
.TP
@@ -757,6 +757,12 @@ 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.
+\fI
+For possible examples of code for in an RC file, see the directory
+example_rcfiles in the distribution of latexmk (e.g., at
+http://ctan.tug.org/tex-archive/support/latexmk/example_rcfiles).
+\fR
+
.SH HOW TO SET VARIABLES IN INITIALIZATION FILES
.PP
The important variables that can be configured are described in the
@@ -1021,7 +1027,7 @@ This variable does not affect the reading of RC files specified on the
command line by the \fB-r\fR option.
.TP
-.B $aux_dir ['']
+.B $aux_dir [""]
The directory in which auxiliary files (aux, log, etc) are to be
written by a run of (pdf)latex. If this variable is not set, but
\fI$out_dir\fR is set, then \fI$aux_dir\fR is set to \fI$out_dir\fR,
@@ -1030,7 +1036,7 @@ written.
\fBImportant note\fR. The effect of \fI$aux_dir\fR, if different from
\fI$out_dir\fR, is achieved by given (pdf)latex the
-\fI-aux-directory\fR. Currently (Oct. 2011) this only works on the
+\fI-aux-directory\fR. Currently (Dec. 2011) this only works on the
MiKTeX version of (pdf)latex.
.TP
@@ -1501,13 +1507,13 @@ same file, and if one is running will not start a new one. If
\fIlatexmk\fR will behave as if no viewer is running.
.TP
-.B $out_dir ['']
+.B $out_dir [""]
The directory in which output files are to be written by a run of
(pdf)latex. See also the variable \fI$aux_dir\fR.
The effect of this variable is achieved by using the
\fI-output-directory\fR option of (pdf)latex. This exists in the
-usual current (Oct. 2011) implementations, i.e., MiKTeX and TeXLive.
+usual current (Dec. 2011) implementations, i.e., MiKTeX and TeXLive.
But it may not be present in other versions.
.TP
@@ -1760,6 +1766,33 @@ Document.fls. However, some implementations instead produce files
named for the program, i.e., latex.fls or pdflatex.fls. In this
second case, \fIlatexmk\fR copies the latex.fls or pdflatex.fls to a
file with the basename of the main LaTeX document, e.g., Document.fls.
+
+.TP
+.B $search_path_separator [See below for default]
+The character separating paths in the environment variables TEXINPUTS,
+BIBINPUTS, and BSTINPUTS. This variable is mainly used by
+\fIlatexmk\fR when the \fI-outdir\fR, \fI-output-directory\fR,
+\fI-auxdir\fR, and/or \fI-aux-directory\fR options are used. In that
+case \fIlatexmk\fR needs to communicate appropriately modified search
+paths to $\fIbibtex\fR, \fIdvipdf\fR, \fIdvips\fR, and
+\fI(pdf)latex\fR.
+
+[Comment to technically savvy readers: \fI(pdf)latex\fR doesn't
+actually need the modified search path, because it corrects it
+internally. But, surprisingly, \fIdvipdf\fR and \fIdvips\fR do,
+because sometimes graphics files get generated in the output or aux
+directories.]
+
+The default under MSWin and Cygwin is ';' and under UNIX-like
+operating systems (including Linux and OS-X) is ':'. Normally the
+defaults give correct behavior. But there can be difficulties if your
+operating system is of one kind, but some of your software is running
+under an emulator for the other kind of operating system; in that case
+you'll need to find out what is needed, and set
+\fI$search_path_separator\fR explicitly. (The same goes, of course,
+for unusual operating systems that are not in the MSWin, Linux, OS-X,
+Unix collection.)
+
.TP
.B $sleep_time [2]
The time to sleep (in seconds) between checking for source file
@@ -2169,7 +2202,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.28c).
+(Version 4.30).
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
index 484717ed34b..c53201cc67e 100644
--- a/Master/texmf/doc/man/man1/latexmk.man1.pdf
+++ b/Master/texmf/doc/man/man1/latexmk.man1.pdf
Binary files differ