summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2023-11-09 22:13:57 +0000
committerKarl Berry <karl@freefriends.org>2023-11-09 22:13:57 +0000
commite8dcef4eb9e70ed986b683df23cb2b278a121ae2 (patch)
tree7dda7a8b5120a1d6ee509bcaa3a4f295b061c2b6 /Master/texmf-dist/doc/man
parent8fda739576093f019df0a4da907b38e7f591a328 (diff)
latexmk (7nov23)
git-svn-id: svn://tug.org/texlive/trunk@68769 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/man')
-rw-r--r--Master/texmf-dist/doc/man/man1/latexmk.198
-rw-r--r--Master/texmf-dist/doc/man/man1/latexmk.man1.pdfbin235246 -> 240175 bytes
2 files changed, 93 insertions, 5 deletions
diff --git a/Master/texmf-dist/doc/man/man1/latexmk.1 b/Master/texmf-dist/doc/man/man1/latexmk.1
index b71b5599774..0b57ebea1bc 100644
--- a/Master/texmf-dist/doc/man/man1/latexmk.1
+++ b/Master/texmf-dist/doc/man/man1/latexmk.1
@@ -1,4 +1,4 @@
-.TH LATEXMK 1 "4 April 2023" ""
+.TH LATEXMK 1 "6 November 2023" ""
.SH NAME
latexmk \- generate LaTeX document
.SH SYNOPSIS
@@ -2733,6 +2733,36 @@ database of information on source files. You will not normally need
to change this.
.TP
+.B @file_not_found
+This an array of Perl regular expressions that are patterns to find
+messages in the .log file from a run of *latex that indicate that a file
+was looked for and not found. To see the current default set, you should
+look at the definition of \fI@file_not_found\fR in the latexmk.pl file.
+
+In the regular expression, the string for the name of the missing file
+should be enclosed in parentheses. That carries the implication that after
+latexmk gets a succesful match to the pattern, the variable $1 is set to
+the filename, which is then picked up by latexmk.
+
+If you happen to encounter a package that gives a missing file message of a
+different form than one that matches one of the built-in patterns, you can
+add another pattern to the array. An example would be
+
+ push @file_not_found, '^No file\\\\s+(.+)\\\\s*$';
+
+The regular expression itself is
+
+ ^Missing file\\s+(.+)\\s*$
+
+But the corresponding string specification in the push statement has to
+have the backslashes doubled.
+
+This regular expression matches a line that starts with 'No file', then has
+one or more white space characters, then any number of characters forming
+the filename, then possible white space, and finally the end of the line.
+(See documentation on Perl regular expressions for details.)
+
+.TP
.B $fls_uses_out_dir [0]
This variable determines whether or not the .fls file should be in the
output directory instead of the natural directory, which is the aux
@@ -3995,9 +4025,49 @@ dollar signs.
.B $$Pdest
This gives the name of the main output file if any. Note the double
dollar signs.
+
+.TP
+.B pushd( path ), popd()
+These subroutines are used when it is needed to temporarily change the
+working directory, as in
+
+ pushd( 'some_directory' );
+ ... Processing done with 'some_directory' as the working directory
+ popd()
+
+They perform exactly the same function as the commands of the same names in
+operating system command shells like bash on Unix, and cmd.exe on the
+Windows.
+
+.TP
+.B rdb_add_generated( file, ... )
+This subroutine is to be used in the context of a rule, that is, from
+within a subroutine that is carrying out processing of a rule. Such is the
+case for the subroutine implementing a custom dependency, or the subroutine
+invoked by using the "internal" keyword in the command specification like
+that in the variable \fI$latex\fR.
+
+Its arguments are a sequence of filenames which are generated during the
+running of the rule. The names might arise from an analysis of the results
+of the run, e.g., in a log file, or from knowledge of properties of the
+specific rule. Calling \fIrdb_add_generated\fR with these filenames
+ensures that these files are flagged as generated by the rule in
+\fIlatexmk\fR's internal data structures. Basically, no action is taken if
+the files have already been flagged as generated.
+
+A main purpose of using this subroutine is for the situation when a
+generated file is also the source file for some rule, so that \fIlatexmk\fR
+can correctly link the dependency information in its network of rules.
+
+\fINote: Unlike some other subroutines in this section, there is no
+argument for a rule for \fRrdb_add_generated\fI. Instead, the subroutine is
+to be invoked during the processing of a rule when \fRlatexmk\fI has set up
+an appropriate context (i.e., appropriate variables). In contrast,
+subroutines with a rule argument can be used also outside a rule context.\fR
+
.TP
.B rdb_ensure_file( $rule, file )
-This a subroutine that ensures that the given file is among the source
+This subroutine ensures that the given file is among the source
files for the specified rule. It is typically used when, during the
processing of a rule, it is known that a particular extra file is
among the dependencies that \fIlatexmk\fR should know, but its default
@@ -4010,17 +4080,34 @@ For examples of its use, see some of the files in the directory
cases that use this subroutine are \fIbib2gls-latexmkrc\fR,
\fIexceltex_latexmkrc\fR and \fItexinfo-latexmkrc\fR. These
illustrate typical cases where \fIlatexmk\fR's normal processing fails
-to detect certain extra source files.
+to detect certain extra source files.
+
+\fINote that \fRrdb_ensure_file\fI only has one filename argument, unlike
+other subroutines in this section. If you want to apply its action to
+multiple files, you will need one call to \fRrdb_ensure_file\fI for each
+file.\fR
+
.TP
.B rdb_remove_files( $rule, file, ... )
This subroutine removes one or more files from the dependency list for
the given rule.
+
+.TP
+.B rdb_remove_generated( file, ... )
+This subroutine is to be used in the context of a rule, that is, from
+within a subroutine that is carrying out processing of a rule. It performs
+the opposite action to \fIrdb_add_generated\fR. Its effect is to ensure
+that the given filenames are not listed in \fIlatexmk\fR's internal data
+structures as being generated by the rule.
+
.TP
.B rdb_list_source( $rule )
This subroutine returns the list of source files (i.e., the dependency
list) for the given rule.
+
.TP
.B rdb_set_source( $rule, file, ... )
+
.TP
.B rdb_set_source( $rule, @files )
This subroutine sets the dependency list for the given rule to be the
@@ -4028,6 +4115,7 @@ specified files. Files that are already in the list have unchanged
information. Files that were not in the list are added to it. Files
in the previous dependency list that are not in the newly specified
list of files are removed from the dependency list.
+
.TP
.B Run_subst( command_spec )
This subroutine runs the command specified by \fIcommand_spec\fR. The
@@ -4296,12 +4384,12 @@ e-mail addresses are not written in their standard form to avoid being
harvested too easily.)
.SH AUTHOR
Current version, by John Collins
-(Version 4.80).
+(Version 4.81).
Report bugs etc to his e-mail (jcc8 at psu.edu).
Released version can be obtained from CTAN:
<http://www.ctan.org/pkg/latexmk/>, and from the
-author's website <http://www.personal.psu.edu/jcc8/latexmk/>.
+author's website <https://www.cantab.net/users/johncollins/latexmk/>.
.br
Modifications and enhancements by Evan McLean (Version 2.0)
.br
diff --git a/Master/texmf-dist/doc/man/man1/latexmk.man1.pdf b/Master/texmf-dist/doc/man/man1/latexmk.man1.pdf
index ec8a6364001..d5d95724cca 100644
--- a/Master/texmf-dist/doc/man/man1/latexmk.man1.pdf
+++ b/Master/texmf-dist/doc/man/man1/latexmk.man1.pdf
Binary files differ