latexmk 4.21 (30dec10)

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

1 files changed, 54 insertions, 14 deletions

diff --git a/Master/texmf/doc/man/man1/latexmk.1 b/Master/texmf/doc/man/man1/latexmk.1
index 21bbc3766b7..7e0bc674c09 100644
--- a/Master/texmf/doc/man/man1/latexmk.1
+++ b/Master/texmf/doc/man/man1/latexmk.1
@@ -1,4 +1,4 @@
-.TH LATEXMK 1L "27 July 2010" ""
+.TH LATEXMK 1L "28 December 2010" ""
 .SH NAME
 latexmk \- generate LaTeX document
 .SH SYNOPSIS
@@ -81,7 +81,7 @@ of which programs.  In its new version, \fIlatexmk\fR 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 \fIlatexmk\fR generates an extra file (with extension
-\fR.fdb_latexmk\fR, by default) that contains the source file
+\fI.fdb_latexmk\fR, by default) that contains the source file
 information.
 
 .SH LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE
@@ -176,6 +176,10 @@ if you want to do a cleanup then a make.
 
 If \fI$bibtex_use\fR is set to 0 or 1, bbl files are counted as
 non-regeneratable. 
+
+If \fI$cleanup_includes_cusdep_generated\fR is nonzero, regeneratable
+files are considered as including those generated by custom
+dependencies and are also deleted.  Otherwise these files are not deleted.
 .TP 
 .B -C
 Clean up (remove) all regeneratable files generated by \fIlatex\fR and
@@ -188,17 +192,14 @@ if you want to do a cleanup than a make.
 
 If \fI$bibtex_use\fR is set to 0 or 1, bbl files are counted as
 non-regeneratable. 
+
+If \fI$cleanup_includes_cusdep_generated\fR is nonzero, regeneratable
+files are considered as including those generated by custom
+dependencies and are also deleted.  Otherwise these files are not deleted.
 .TP 
 .B -CA
 Clean up (remove) absolutely all regeneratable files.  It is now
-equivalent to the \fB-C\fR option
-
-This cleanup is instead of a regular make.  
-See the \fB-gg\fR option if you want to do a cleanup then a
-make.
-
-If \fI$bibtex_use\fR is set to 0 or 1, bbl files are counted as
-non-regeneratable. 
+equivalent to the \fB-C\fR option.  See that option for details.
 .TP 
 .B -CF
 Remove the file containing the database of source file information,
@@ -891,6 +892,13 @@ use BibTeX if the bib files exist.  2: run BibTeX whenever it appears
 necessary to update the bbl files, without testing for the existence
 of the bib files.
 .TP
+.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
+dependencies are those listed in the \fI.fdb_latexmk\fR file from a
+previous run.)
+.TP
 .B $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
@@ -905,14 +913,25 @@ files.  (There is also extra cleaning as specified by the
 variables.)
 .PP
 This variable is equivalent to specifying one of
-the \fB-c\fR, \fB-c1\fR, or \fB-C\fR options.  But there should be no need
+the \fB-c\fR or \fB-C\fR options.  But there should be no need
 to set this variable from an RC file.
 .TP
 .B $clean_ext [""]
 Extra extensions of files for \fIlatexmk\fR to remove when any of the
-clean-up options (\fB-c\fR, \fB-c1\fR, or \fB-C\fR) is selected.
+clean-up options (\fB-c\fR or \fB-C\fR) is selected.
 The value of this 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 setting
+
+   $clean_ext = "out %R-blx.bib";
+
+in an initialization file will imply that when a clean-up operation is
+specified, not only is the standard set of files deleted, but also
+files of the form FOO.out and FOO-blx.bib, where FOO stands for the
+basename of the file being processed (as in FOO.tex).
+
 .TP
 .B $clean_full_ext [""]
 Extra extensions of files for \fIlatexmk\fR to remove when the \fB-C\fR
@@ -1087,7 +1106,8 @@ postscript file (an "eps" file) to be made that is to be read in on
 the next run.  The file contains a comment line giving its creation
 date and time.  On the next run the time changes, \fIlatex\fR sees
 that the eps file has changed, and therefore reruns latex.  This
-causes an infinite loop, only exited becaues \fIlatexmk\fR has a limit
+causes an infinite loop, that is only terminated becaues \fIlatexmk\fR
+has a limit 
 on the number of runs to guard against pathological situations.
 
 But the changing line has no real effect, since it is a comment.  You
@@ -1104,6 +1124,26 @@ 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 extension \fI.eps\fR
 has changed.
+
+There is only one regular expression available for each extension.  If
+you need more one pattern to specify lines to ignore, then you need to
+combine the patterns into a single regular expression.  The simplest
+method is separate the different simple patterns by a vertical bar
+character (indicating "alternation" in the jargon of regular
+expressions).  For example,
+
+   $hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: |^%%Title: ';
+
+causes lines starting with either "^%%CreationDate: " or "^%%Title: "
+to be ignored.  
+
+It may happen that a pattern to be ignored is specified in, for
+example, in a system or user initialization file, and you wish to
+remove this in a file read later.  To do this, you use perl's delete
+function, e.g.,
+
+    delete $hash_calc_ignore_pattern{'eps'};
+
 .TP
 .B $kpsewhich ["kpsewhich %S"]
 The program called to locate a source file when the name alone is not
@@ -1715,7 +1755,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.17).
+(Version 4.21).
 
 Released version can be obtained from CTAN:
 <http://www.tug.org/tex-archive/support/latexmk/>, and from the