latexmk 4.27a (18oct11)

git-svn-id: svn://tug.org/texlive/trunk@24326 c570f23f-e606-0410-a88d-b1316a301751

2 files changed, 129 insertions, 2 deletions

diff --git a/Master/texmf/doc/man/man1/latexmk.1 b/Master/texmf/doc/man/man1/latexmk.1
index 240e5464e22..034da7cb064 100644
--- a/Master/texmf/doc/man/man1/latexmk.1
+++ b/Master/texmf/doc/man/man1/latexmk.1
@@ -1,4 +1,4 @@
-.TH LATEXMK 1L "9 August 2011" ""
+.TH LATEXMK 1L "10 October 2011" ""
 .SH NAME
 latexmk \- generate LaTeX document
 .SH SYNOPSIS
@@ -107,6 +107,21 @@ is automatically added, just as LaTeX does.  Thus, if you specify:
 
 then \fIlatexmk\fR will operate on the file "foo.tex".  
 .TP
+
+.B -auxdir=FOO or -aux-directory=FOO
+
+Sets the directory for auxiliary output files of (pdf)latex 
+(.aux, .log etc).  This
+achieves its effect by the \fI-aux-directory\fI option of (pdf)latex,
+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. 
+
+.TP
+
 .B -bibtex 
 When the source file uses bbl files for bibliography, run bibtex or
 biber as needed to regenerate the bbl files.  
@@ -365,6 +380,26 @@ automatically.
 .B -l-
 Turn off \fB-l\fR.
 .TP
+.B -latex='command'
+This sets the string specifying the command to run latex, and is
+typically used to add desired options.  Since the string normally
+contains spaces, it should be quoted, e.g.,
+
+     latex -latex='latex --shell-escape %O %S'  foo.tex
+
+The specification of the contents of the string are the same as for
+the \fI$latex\fR configuration variable.  Depending on your
+operating system and the command-line shell you are using, you may
+need to change the single quotes to double quotes (or something
+else). 
+
+To set the command for running pdflatex (rather than the command for
+latex) see the \fB-pdflatex\fR option.
+
+Note that the effect of this option can also be achieved by using
+the \fB-e\fR option with a suitable line of Perl code to set the
+\fI$latex\fR variable.  See the explanation of the \fB-e\fR option.
+.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
@@ -389,6 +424,29 @@ corresponding bib files available.  In this situation use of the
 \fIbibtex\fR or \fIbiber\fR, which would result in overwriting of the
 bbl files. 
 .TP
+.B -norc
+Turn off the automatic reading of initialization (rc) files.
+
+N.B. Normally the initialization files are read and obeyed, and then
+command line options are obeyed in the order they are encountered.
+Then \fB-norc\fR is an exception to this rule: it is acted on first,
+no matter where is occurs on the command line.
+.TP
+
+.B -outdir=FOO or -output-directory=FOO
+
+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
+(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. 
+
+.TP
+
 .B -p
 Print out the document.  By default it is
 the generated postscript file that is printed.  But you can use the
@@ -424,6 +482,26 @@ Turn off generation of pdf version of document.
 It may get overridden if some other option requires the generation of
 a pdf file.)
 .TP
+.B -pdflatex='command'
+This sets the string specifying the command to run pdflatex, and is
+typically used to add desired options.  Since the string normally
+contains spaces, it should be quoted, e.g.,
+
+     latex -pdf -pdflatex='pdflatex --shell-escape %O %S'  foo.tex
+
+The specification of the contents of the string are the same as for
+the \fI$pdflatex\fR configuration variable.  Depending on your
+operating system and the command-line shell you are using, you may
+need to change the single quotes to double quotes (or something
+else). 
+
+To set the command for running latex (rather than the command for
+pdflatex) see the \fB-latex\fR option.
+
+Note that the effect of this option can also be achieved by using
+the \fB-e\fR option with a suitable line of Perl code to set the
+\fI$pdflatex\fR variable. See the explanation of the \fB-e\fR option.
+.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
@@ -759,6 +837,18 @@ to ps).
 .TP
 .B %T
 The name of the primary tex file.
+.B %Y
+Name of directory for auxiliary output files (see the configuration
+variable \fI$aux_dir\fR).  A directory separation character ('/') is
+appended if \fI$aux_dir\fR is non-empty and does not end in a suitable
+character, with suitable characters being those appropriate to UNIX
+and MS-Windows, i.e., ':', '/' and '\\'. 
+.B %Z
+Name of directory for output files (see the configuration
+variable \fI$out_dir\fR).  A directory separation character ('/') is
+appended if \fI$out_dir\fR is non-empty and does not end in a suitable
+character, with suitable characters being those appropriate to UNIX
+and MS-Windows, i.e., ':', '/' and '\\'. 
 .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
@@ -919,6 +1009,31 @@ applies only if preview-continuous mode (-pvc option) is used.  See
 file is created. 
 
 .TP
+.B $auto_rc_use [1]
+Whether to automatically read the standard initialization (rc) files,
+which are the system RC file, the user's RC file, and the RC file in
+the current directory.  The command line option \fB-norc\fR can be
+used to turn this setting off.  Each RC file could also turn this
+setting off, i.e., it could set \fI$auto_rc_use\fR to zero to prevent
+automatic reading of the later RC files.
+
+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 ['']
+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,
+which is the directory to which general output files are to be
+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
+MiKTeX version of (pdf)latex.
+
+.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
@@ -1385,6 +1500,18 @@ same file, and if one is running will not start a new one.  If
 \fI$new_viewer_always\fR is non-zero, this check will be skipped, and
 \fIlatexmk\fR will behave as if no viewer is running.
 .TP
+
+.B $out_dir ['']
+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.
+But it may not be present in other versions.
+
+.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.  
@@ -2042,7 +2169,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.26).
+(Version 4.27).
 
 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 49c7de4499b..2559491adaf 100644
--- a/Master/texmf/doc/man/man1/latexmk.man1.pdf
+++ b/Master/texmf/doc/man/man1/latexmk.man1.pdf