latexmk 4.31 (4apr12)

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

2 files changed, 244 insertions, 51 deletions

diff --git a/Master/texmf/doc/man/man1/latexmk.1 b/Master/texmf/doc/man/man1/latexmk.1
index 629318f23ad..45858eb1c56 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 December 2011" ""
+.TH LATEXMK 1L "30 March 2012" ""
 .SH NAME
 latexmk \- generate LaTeX document
 .SH SYNOPSIS
@@ -24,9 +24,9 @@ updates the on-screen view of the compiled document.
 .PP
 \fILatexmk\fR 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 \fI-recorder\fR option of modern versions of
+files generated by the \fB-recorder\fR option of modern versions of
 \fIlatex\fR and \fIpdflatex\fR.  See the documentation for the
-\fI-recorder\fR option of \fIlatexmk\fR below.)
+\fB-recorder\fR option of \fIlatexmk\fR below.)
 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
@@ -63,8 +63,16 @@ 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.
+needed, call an external program to do other postprocessing on
+generated dvi and postscript files.  (See the options \fB-dF\fR and
+\fB-pF\fR, and the documentation for the \fI$dvi_filter\fR and
+\fI$ps_filter\fR configuration variables.)  These capabilities are
+leftover from older versions of \fIlatexmk\fR.  More flexibility can
+be obtained in current versions, since the command strings for running
+latex, pdflatex, etc can now be configured to run multiple commands.
+This also extends the possibility of postprocessing generated files to
+pdf files.
+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
@@ -112,13 +120,15 @@ then \fIlatexmk\fR will operate on the file "foo.tex".
 
 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,
+achieves its effect by the \fB-aux-directory\fR 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
+See also the \fB-outdir\fR/\fB-output-directory\fR options, and the
 \fI$aux_dir\fR, \fI$out_dir\fR, and \fI$search_path_separator\fR
-configuration variables of \fIlatexmk\fR.
+configuration variables of \fIlatexmk\fR.  In particular, see the
+documentation of \fI$out_dir\fR for some complications on what
+directory names are suitable.
 
 .TP
 
@@ -250,24 +260,26 @@ view of the files without listing intermediate files, as well as
 By default the list of dependent files is sent to stdout (i.e.,
 normally to the screen unless you've redirected latexmk's output).
 But you can set the filename where the list is sent by the
-\fI-deps-out=\fR option.
+\fB-deps-out=\fR option.
 
 See the section "USING \fIlatexmk\fR WITH \fImake\fR" for
 an example of how to use a dependency list with \fImake\fR.  
 
 Users familiar with GNU \fIautomake\fR and \fIgcc\fR will find that
-the \fI-deps\fR option is very similar in its purpose and results to
-the \fI-M\fR option to \fIgcc\fR.
+the \fB-deps\fR option is very similar in its purpose and results to
+the \fB-M\fR option to \fIgcc\fR.  (In fact, \fIlatexmk\fR also has
+options \fB-M\fR, \fB-MF\fR, and \fB-MP\fR options that behave like
+those of \fIgcc\fR.)
 .TP
 .B  -dependents
-Equivalent to \fI-deps\fR.
+Equivalent to \fB-deps\fR.
 .TP
 .B   -deps-  
 Do not show a list of dependent files after processing.  (This is the
 default.) 
 .TP
 .B  -dependents-
-Equivalent to \fI-deps-\fR.
+Equivalent to \fB-deps-\fR.
 .TP
 .B   -deps-out=FILENAME  
 Set the filename to which the list of dependent files is written.  If
@@ -400,6 +412,20 @@ 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 -M
+Show list of dependent files after processing.  This is equivalent to
+the \fB-deps\fR option.
+.TP
+.B -MF file
+If a list of dependents is made, the \fB-MF\fR specifies the file to
+write it to. 
+.TP
+.B -MP
+If a list of dependents is made, includes phony target for each source
+file.  If you use the dependents list in a Makefile, the dummy rules
+work around errors make gives if you remove header files without
+updating the Makefile to match.
+.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
@@ -436,14 +462,16 @@ no matter where is occurs on the command line.
 .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
+its effect by the \fB-output-directory\fR option of (pdf)latex, which
 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
+See also the \fB-auxdir\fR/\fB-aux-directory\fR options, and the
 \fI$aux_dir\fR, \fI$out_dir\fR, and \fI$search_path_separator\fR
-configuration variables of \fIlatexmk\fR.
+configuration variables of \fIlatexmk\fR.  In particular, see the
+documentation of \fI$out_dir\fR for some complications on what
+directory names are suitable.
 
 .TP
 
@@ -467,7 +495,9 @@ 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.
+Generate pdf version of document using pdflatex.  (See the
+\fB-xelatex\fR if you wish to use \fIxelatex\fR to make your pdf
+file(s).) 
 .TP
 .B -pdfdvi
 Generate pdf version of document from the dvi file, by default using dvipdf.
@@ -569,7 +599,7 @@ 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,
+\fBImportant note\fR: 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
@@ -682,6 +712,14 @@ Opposite of \fB-silent\fR.  This is the default setting.
 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).  
+.TP
+.B -xelatex
+Use xelatex.  That is, use xelatex to process the source file(s) to
+pdf (in place of pdflatex).  This option is exactly equivalent to
+specifying the following sequence of options: 
+
+     -pdflatex="xelatex %O %S" -pdf -dvi- -ps
+
 .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
@@ -725,16 +763,19 @@ system RC file, in the following order, and reads the first it finds:
    "/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), \fIlatexmk\fR reads for the first it finds of
+that of cygwin), \fIlatexmk\fR 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".
 .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.
+is the user's home directory.  [\fILatexmk\fR determines the user's
+home directory as follows:  It is the value of the environment variable
+HOME, if this variable exists, which normally is the case on UNIX-like
+systems (including LINUX and OS-X).  Otherwise the environment
+variable USERPROFILE is used, if it exists, which normally is the case
+on MS-Windows systems. Otherwise a blank string is used instead of $HOME.]
 .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
@@ -864,7 +905,7 @@ 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
+you mustn't supply them yourself even if the names of your files 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
@@ -975,6 +1016,17 @@ file:
      $latex = 'latex --src-specials %O %S';
 .PP
 
+\fBRunning a subroutine instead of an external command\fR: Use a
+specification starting with "internal", as in 
+.PP
+     $latex = 'internal mylatex %O %S';
+     sub mylatex {
+         my @args = @_;
+         # Possible preprocessing here
+         return system 'latex', @args;
+     }
+.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
@@ -989,10 +1041,20 @@ 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
+This definition assumes you are using a UNIX-like system (which
+includes Linux and OS-X), so that the
 two commands to be run are separated by the semicolon in the middle of
-the string.  
+the string.
+
+If you are using MS-Windows, you would replace the above line by 
 
+   $pdflatex = 'cmd /c pdflatex --shell-escape %O %S'
+               . '&& pst2pdf_for_latexmk %B';
+
+Here, the UNIX command separator ; is replaced by &&.  In addition,
+there is a problem that some versions of \fIPerl\fR on MS-Windows do
+not obey the command separator; this problem is overcome by explicitly
+invoking the MS-Windows command-line processor \fIcmd.exe\fR.
 
 .SH LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES
 .PP
@@ -1034,11 +1096,14 @@ written by a run of (pdf)latex.  If this variable is not set, but
 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 (Dec. 2011) this only works on the
+\fBImportant note\fR:  The effect of \fI$aux_dir\fR, if different from
+\fI$out_dir\fR, is achieved by giving (pdf)latex the
+\fB-aux-directory\fR.  Currently (Dec. 2011) this only works on the
 MiKTeX version of (pdf)latex.
 
+See also the documentation of \fI$out_dir\fR for some complications on
+what directory names are suitable.
+
 .TP
 .B $banner [0]
 If nonzero, the banner message is printed across each page when
@@ -1089,7 +1154,7 @@ 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
@@ -1126,7 +1191,7 @@ files, without testing for the existence of the bib files.
 .B $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 \fI-C\fR option, custom
+(When doing a clean up, e.g., by use of the \fB-C\fR option, custom
 dependencies are those listed in the \fI.fdb_latexmk\fR file from a
 previous run.)
 .TP
@@ -1142,7 +1207,7 @@ 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 or \fB-C\fR options.  But there should be no need
 to set this variable from an RC file.
@@ -1168,9 +1233,50 @@ basename of the file being processed (as in FOO.tex).
 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.
+
+More general patterns are allowed, as for \fI$clean_ext\fR.
+
+.TP
+.B $compiling_cmd [undefined], $failure_cmd [undefined], $success_cmd [undefined]
+
+These variables specify commands that are executed at certain points
+of compilations during preview-continuous mode.  One motivation for
+their existance is to allow convenient visual indications of
+compilation status even when the window receiving the screen output of
+the compilation is hidden.
+
+The commands are executed at the following points:
+$compiling_cmd at the start of compilation, $success_cmd at the end of
+a successful compilation, and $failure_cmd at the end of an
+unsuccessful compilation.  If any of above variables is undefined (the
+default situation) or blank, then the corresponding command is not
+executed.  
+
+An example of a typical setting of these variables is as follows
+
+    $compiling_cmd = "xdotool search --name \\"%D\\" set_window --name \\"%D compiling\\"";
+    $success_cmd   = "xdotool search --name \\"%D\\" set_window --name \\"%D OK\\"";
+    $failure_cmd   = "xdotool search --name \\"%D\\" set_window --name \\"%D FAILURE\\"";
+
+These assume that the program \fIxdotool\fR is installed, that the
+previewer is using an X-Window system for display, and that the title
+of the window contains the name of the displayed file, as it normally
+does.  When the commands are executed, the placeholder string %D is replaced by
+the name of the destination file, which is the previewed file.  The
+above commands result in an appropriate string being appended to the
+filename in the window title: " compiling", " OK", or " FAILURE".  
+
+Other placeholders that can be used are %S, %T, and %R, with %S and %T
+normally being identical. These can be useful for a command changing
+the title of the edit window. The visual indication in a window title
+can useful, since the user does not have to keep shifting attention to
+the (possibly hidden) compilation window to know the status of the
+compilation.
+
 .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.  
@@ -1199,6 +1305,13 @@ 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 $dependents_phony [0]
+If a list of dependencies is output, this variable determines whether
+to include a phony target for each source file.  If you use the
+dependents list in a Makefile, the dummy rules work around errors make
+gives if you remove header files without updating the Makefile to
+match.
+.TP
 .B $dependents_list [0]
 Whether to display a list(s) of dependencies at the end of a run.
 .TP
@@ -1209,7 +1322,7 @@ other processing.  Equivalent to specifying the \fB-dF\fR option.
 .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
@@ -1219,7 +1332,18 @@ is a prerequisite, then $dvi_mode will be set to 1.
 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.] 
+associated with .dvi files.]
+
+\fBImportant note\fR: Normally you will want to have a previewer run
+detached, so that \fIlatexmk\fR doesn't wait for the previewer to
+terminate before continuing its work.  So normally you should prefix
+the command by "start ", which flags to \fIlatexmk\fR that it should
+do the detaching of the previewer itself (by whatever method is
+appropriate to the operating system).  But sometimes letting
+\fIlatexmk\fR do the detaching is not appropriate (for a variety of
+non-trivial reasons), so you should put the "start " bit in
+yourself, whenever it is needed.
+
 .TP
 .B $dvi_previewer_landscape ["start xdvi %O %S"]
 The command to invoke a dvi-previewer in landscape mode.
@@ -1286,6 +1410,9 @@ 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 $failure_cmd [undefined]
+See the documentation for $compiling_cmd.
+.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
@@ -1511,11 +1638,27 @@ same file, and if one is running will not start a new one.  If
 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 (Dec. 2011) implementations, i.e., MiKTeX and TeXLive.
-But it may not be present in other versions.
-
+The effect of this variable (when non-blank) is achieved by using the
+\fB-output-directory\fR option of (pdf)latex.  This exists in the
+usual current (Dec. 2011) implementations of TeX, i.e., MiKTeX and
+TeXLive. But it may not be present in other versions.
+
+Commonly, the directory specified for output files is a subdirectory
+of the current working directory.  However, if you specify some other
+directory, e.g., "/tmp/foo" or "../output", be aware that this could
+cause problems, e.g., with \fImakeindex\fR or \fIbibtex\fR.  This is
+because modern versions of these programs, by default, will refuse to
+work when they find that they are asked to write to a file in a
+directory that appears not to be the current working directory or one
+of its subdirectories.  This is part of security measures by the whole
+TeX system that try to prevent malicious or errant TeX documents from
+incorrectly messing with a user's files.  If for \fI$out_dir\fR or
+\fI$aux_dir\fR you really do need to specify an absolute pathname
+(e.g., "/tmp/foo") or a path (e.g., "../output") that includes a
+higher-level directory, then you need to disable the security measures
+(and assume any risks).  This can be done by temporarily setting the
+operating system's environment variable openout_any to "a" (as in
+"all"), to override the default "paranoid" setting.
 .TP
 
 .B $pdf_mode [0]
@@ -1529,9 +1672,24 @@ 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.
+
+An example of the use of this variable is to arrange for \fIxelatex\fR
+to be used instead of \fIpdflatex\fR, when you could set
+
+     $pdflatex = "xelatex %O %S";
+
+Note that \fIxelatex\fR only produces .pdf files (and not .dvi), so to
+use it you will also need to turn on production of .pdf files, and to
+turn off the production of .dvi (and .ps) files, either by command
+line options or by the following settings in an initialization file
+
+    $pdf_mode = 1; $postscript_mode = $dvi_mode = 0;
+
+
 .TP
 .B %pdflatex_input_extensions
 This variable specifies the extensions tried by latexmk when it finds
@@ -1579,9 +1737,17 @@ initialization file
 .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
+
+On MS-WINDOWS, the default is changed to "cmd /c start """; under more recent versions of
 Windows, this will cause to be run whatever command the system has
-associated with .pdf files.]  
+associated with .pdf files.  But this may be undesirable if this
+association is to \fIacroread\fR -- see the notes in the explanation
+of the \fB-pvc\fR option.]  
+
+On OS-X the default is changed to "open %S", which results in OS-X
+starting up (and detaching) the viewer associated with the file.  By
+default, for pdf files this association is to OS-X's preview, which is
+quite satisfactory.
 
 \fBWARNING\fR: Potential problem under MS-Windows:
 if acroread is used as the pdf previewer, and it is
@@ -1590,6 +1756,17 @@ 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.
+
+\fBImportant note\fR: Normally you will want to have a previewer run
+detached, so that \fIlatexmk\fR doesn't wait for the previewer to
+terminate before continuing its work.  So normally you should prefix
+the command by "start ", which flags to \fIlatexmk\fR that it should
+do the detaching of the previewer itself (by whatever method is
+appropriate to the operating system).  But sometimes letting
+\fIlatexmk\fR do the detaching is not appropriate (for a variety of
+non-trivial reasons), so you should put the "start " bit in
+yourself, whenever it is needed.
+
 .TP
 .B $pdf_update_command [""]
 When the pdf previewer is set to be updated by running a command, this
@@ -1638,7 +1815,7 @@ corresponds to the process ID.  The first word in the line is numbered
 .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
@@ -1702,6 +1879,17 @@ 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.  
+
+\fBImportant note\fR: Normally you will want to have a previewer run
+detached, so that \fIlatexmk\fR doesn't wait for the previewer to
+terminate before continuing its work.  So normally you should prefix
+the command by "start ", which flags to \fIlatexmk\fR that it should
+do the detaching of the previewer itself (by whatever method is
+appropriate to the operating system).  But sometimes letting
+\fIlatexmk\fR do the detaching is not appropriate (for a variety of
+non-trivial reasons), so you should put the "start " bit in
+yourself, whenever it is needed.
+
 .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.
@@ -1737,7 +1925,7 @@ 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
@@ -1747,7 +1935,7 @@ quoting only ensures that such filenames are correctly treated by the
 operating system in passing arguments to programs.)
 .TP
 .B $recorder [0]
-Whether to use the \fI-recorder\fR option to \fIlatex\fR and
+Whether to use the \fB-recorder\fR option to \fIlatex\fR and
 \fIpdflatex\fR. Use of this option results in a file of extension
 \fI.fls\fR containing a list of the files that these programs have
 read and written.  \fILatexmk\fR will then use this file to improve
@@ -1771,8 +1959,8 @@ file with the basename of the main LaTeX document, e.g., Document.fls.
 .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
+\fIlatexmk\fR when the \fB-outdir\fR, \fB-output-directory\fR,
+\fB-auxdir\fR, and/or \fB-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.  
@@ -1810,6 +1998,11 @@ 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 $success_cmd [undefined]
+See the documentation for $compiling_cmd.
+
 .TP
 .B $tmpdir [See below for default]
 Directory to store temporary files that \fIlatexmk\fR may generate while
@@ -2152,11 +2345,11 @@ make .pdf files from .tex files.  But I have added a rule to
 make .pdf files from .fig files produced by the \fIxfig\fR program;
 these are commonly used for graphics insertions in LaTeX documents.
 \fILatexmk\fR is arranged to output a dependency file after each run.
-It is given the \fI-recorder\fR option, which improves its detection
+It is given the \fB-recorder\fR option, which improves its detection
 of files generated during a run of \fIpdflatex\fR; such files should
-not be in the dependency list.  The \fI-e\fR options are used to turn
+not be in the dependency list.  The \fB-e\fR options are used to turn
 off all custom dependencies, and to document this.  Instead the
-\fI-use-make\fR is used to delegate the making of missing files to
+\fB-use-make\fR is used to delegate the making of missing files to
 \fImake\fR itself.
 
 Suppose in the LaTeX file there is a command \\includegraphics{graph},
@@ -2190,8 +2383,8 @@ 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.) 
+pdf file cannot be updated.  (Remedy: configure \fIlatexmk\fR to use
+\fIsumatrapdf\fR instead.) 
 .SH THANKS TO
 Authors of previous versions.  Many users with their feedback, and
 especially 
@@ -2202,7 +2395,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.30).
+(Version 4.31).
 
 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 c53201cc67e..bbfefcd087c 100644
--- a/Master/texmf/doc/man/man1/latexmk.man1.pdf
+++ b/Master/texmf/doc/man/man1/latexmk.man1.pdf