From 4d12c3875aa543d42fc585b4771c9b9ef6981424 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Sat, 16 Jan 2010 23:43:33 +0000 Subject: latexmk 4.13 git-svn-id: svn://tug.org/texlive/trunk@16749 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf/doc/man/man1/latexmk.1 | 79 ++++++++++++++++++++++++++--- Master/texmf/doc/man/man1/latexmk.man1.pdf | Bin 84361 -> 88218 bytes 2 files changed, 73 insertions(+), 6 deletions(-) (limited to 'Master/texmf/doc') diff --git a/Master/texmf/doc/man/man1/latexmk.1 b/Master/texmf/doc/man/man1/latexmk.1 index 5ef13279d0e..f2b49a75b9b 100644 --- a/Master/texmf/doc/man/man1/latexmk.1 +++ b/Master/texmf/doc/man/man1/latexmk.1 @@ -1,4 +1,4 @@ -.TH LATEXMK 1L "24 November 2009" "" +.TH LATEXMK 1L "13 January 2010" "" .SH NAME latexmk \- generate LaTeX document .SH SYNOPSIS @@ -14,8 +14,8 @@ source file for a document, and it issues the appropriate sequence of commands to generate a .dvi, .ps, .pdf and/or hardcopy version of the document. .PP -By default \fIlatexmk\fR will run the commands necessary to generate a -.dvi file. +By default \fIlatexmk\fR will run the commands necessary to generate +a .dvi file. .PP \fILatexmk\fR can also be set to run continuously with a suitable previewer. In that case the LaTeX program, etc, are rerun whenever @@ -103,6 +103,40 @@ is automatically added, just as LaTeX does. Thus, if you specify: then \fIlatexmk\fR will operate on the file "foo.tex". .TP +.B -bibtex +When the source file uses bbl files for bibliography, run bibtex as needed +to regenerate the bbl files. + +This property can also be configured by setting the \fI$bibtex_use\fR +variable to 2 in a configuration file +.TP +.B -bibtex- +Never run bibtex. + +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 +\fB-bibtex-\fR option will prevent \fIlatexmk\fR from trying to run +\fIbibtex\fR, which would result in overwriting of the bbl files. +.TP +.B -bibtex-cond +When the source file uses bbl file(s) for the bibliography, run +\fIbibtex\fR as needed to regenerate the bbl files, but only if the +relevant bib file(s) exist. Thus when the bib files are not +available, \fIbibtex\fR is not run, thereby avoiding overwriting of +the bbl file(s). This is the default setting. + +(Note that it is possible for \fIlatexmk\fR to decide that the bib +file does not exist, even though the bib file does exist and +\fIbibtex\fR finds it. The problem is that the bib file may not be in +the current directory but in some search path; the places +\fIlatexmk\fR and \fIbibtex\fR cause to be searched need not be +identical. On modern installations of TeX and related programs this +problem should not arise, since \fIlatexmk\fR uses the \fIkpsewhich\fR +program to do the search, and \fIkpsewhich\fR should use the same +search path as \fIbibtex\fR. If this problem arises, use the +\fB-bibtex\fR option when invoking \fIlatexmk\fR.) +.TP .B -bm A banner message to print diagonally across each page when converting the dvi file to postscript. The message must be a single argument on @@ -139,6 +173,9 @@ removed. 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. .TP .B -C Clean up (remove) all regeneratable files generated by \fIlatex\fR and @@ -148,6 +185,9 @@ in the \fI$clean_full_ext\fR configuration variable. This cleanup is instead of a regular make. See the \fB-gg\fR option 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. .TP .B -CA Clean up (remove) absolutely all regeneratable files. It is now @@ -156,6 +196,9 @@ 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. .TP .B -CF Remove the file containing the database of source file information, @@ -290,6 +333,15 @@ The inverse of the \fB-new-viewer\fR option. It puts \fIlatexmk\fR in its normal behavior that in preview-continuous mode it checks for an already-running previewer. .TP +.B -nobibtex +Never run bibtex. + +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 +\fB-nobibtex\fR option will prevent \fIlatexmk\fR from trying to run +\fIbibtex\fR, which would result in overwriting of the bbl files. +.TP .B -p Print out the document. By default it is the generated postscript file that is printed. But you can use the @@ -785,6 +837,21 @@ The BibTeX processing program. .B $bibtex_silent_switch ["-terse"] \fBSwitch(es)\fR for the BibTeX processing program when silent mode is on. .TP +.B $bibtex_use [1] +Under what conditions to run BibTeX. When \fIlatexmk\fR discovers +from the log file that one (or more) BibTeX-generated bibliographies +are used, it can run BibTeX whenever it appears necessary to +regenerate the bbl file(s) from their source bib database file(s). + +But sometimes, the bib file(s) are not available (e.g., for a document +obtained from an external archive), but the bbl files are provided. +In that case use of BibTeX will result in incorrect overwriting of the +precious bbl files. The variable \fI$bibtex_use\fR controls whether +this happens. Its possible values are: 0: never use BibTeX. 1: only +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_generated [0] If nonzero, specifies that cleanup also deletes files that are detected in log file as being generated (see the \\openout lines in @@ -1002,8 +1069,8 @@ has changed. .B $kpsewhich ["kpsewhich %S"] The program called to locate a source file when the name alone is not sufficient. Most filenames used by \fIlatexmk\fR have sufficient path -information to be found directly. But sometimes, notably when -.bib files are found from the log file of a bibtex run, the name of +information to be found directly. But sometimes, notably +when .bib files are found from the log file of a bibtex run, the name of the file, but not its path is known. The program specified by $kpsewhich is used to find it. @@ -1589,7 +1656,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.11). +(Version 4.13). Released version can be obtained from CTAN: , and from the diff --git a/Master/texmf/doc/man/man1/latexmk.man1.pdf b/Master/texmf/doc/man/man1/latexmk.man1.pdf index 0c87487974a..962a0105291 100644 Binary files a/Master/texmf/doc/man/man1/latexmk.man1.pdf and b/Master/texmf/doc/man/man1/latexmk.man1.pdf differ -- cgit v1.2.3