summaryrefslogtreecommitdiff
path: root/support/latexmk/latexmk.1
diff options
context:
space:
mode:
Diffstat (limited to 'support/latexmk/latexmk.1')
-rw-r--r--support/latexmk/latexmk.190
1 files changed, 83 insertions, 7 deletions
diff --git a/support/latexmk/latexmk.1 b/support/latexmk/latexmk.1
index 7149072b67..0c3bd60853 100644
--- a/support/latexmk/latexmk.1
+++ b/support/latexmk/latexmk.1
@@ -1,4 +1,4 @@
-.TH LATEXMK 1 "16 May 2021" ""
+.TH LATEXMK 1 "29 May 2021" ""
.SH NAME
latexmk \- generate LaTeX document
.SH SYNOPSIS
@@ -465,6 +465,17 @@ problems or to understand \fIlatexmk\fR's behavior in difficult
situations.
.TP
+.B -dir-report
+For each .tex file processed, list the settings for aux and out
+directories, after they have been normalized from the settings specified
+during initialization. See the description of the variable
+\fB$aux_out_dir_report\fR for more details.
+
+.TP
+.B -dir-report-
+Do not report the settings for aux and out directories. (Default)
+
+.TP
.B -dvi
Generate dvi version of document.
@@ -525,6 +536,22 @@ particular effect can be achieved also by the use of the \fB-latex\fR
option with less problems in dealing with quoting.)
.TP
+.B -emulate-aux-dir
+Emulate -aux-directory instead of leaving it to the *latex programs
+to do it. (MiKTeX supports -aux-directory, but TeXLive doesn't.)
+
+For more details see the explanation for the configuration variable
+\fI$emulate_aux\fR.
+
+.TP
+.B -emulate-aux-dir-
+Turn off emulatation -aux-directory and leave it to the *latex program
+to handle the case that aux_dir is not equal to out_dir. Note that if you
+use TeXLive, which doesn't support -aux-directory, latexmk will
+automatically switch aux_dir emulation on after the first run of *latex,
+because it will find the .log file in the wrong place.
+
+.TP
.B -f
Force \fIlatexmk\fR to continue document processing despite errors.
Normally, when \fIlatexmk\fR detects that LaTeX or another program has
@@ -759,6 +786,15 @@ Turn off the change-directory fudge for
bibtex. See documentation of \fI$bibtex_fudge\fR for details.
.TP
+.B -noemulate-aux-dir
+Turn aux_dir emulation off. Same as \fI-emulate-aux-dir-\fR.
+
+.TP
+.B -nomakeindexfudge
+Turn off the change-directory fudge for makeindex. See documentation of
+\fI$makeindex_fudge\fR for details.
+
+.TP
.B -norc
Turn off the automatic reading of initialization (rc) files.
@@ -768,11 +804,6 @@ But \fB-norc\fR is an exception to this rule: it is acted on first,
no matter where it occurs on the command line.
.TP
-.B -nomakeindexfudge
-Turn off the change-directory fudge for makeindex. See documentation of
-\fI$makeindex_fudge\fR for details.
-
-.TP
.B -outdir=FOO \fRor\fB -output-directory=FOO
Sets the directory for the output files of *latex. This achieves
@@ -1089,6 +1120,14 @@ error results in \fIlatexmk\fR stopping. Multiple instances of the
the order they appear on the command line.
.TP
+.B -rc-report
+After initialization, give a list of the RC files read. (Default)
+
+.TP
+.B -rc-report-
+After initialization, do not give a list of the RC files read. (Default)
+
+.TP
.B -recorder
Give the -recorder option with \fI*latex\fR. In
(most) modern versions of these programs, this results in a file of
@@ -1939,6 +1978,23 @@ what directory names are suitable.
If you also use the \fB-cd\fR option, and \fI$out_dir\fR (or \fI$aux_dir\fR) contains a
relative path, then the path is interpreted relative to the document
directory.
+
+.TP
+.B $aux_out_dir_report [0]
+For each .tex file processed, list the settings for aux and out
+directories, after they have been normalized from the settings specified
+during initialization.
+
+This report gives a reminder of where to look for output.
+
+The report has to be done per file, because of possible directory changes
+for each file. In the simplest cases, the result is the same as originally
+specified. In general, e.g., with an absolute directory specified, the
+normalization helps performance and cleans up output to the screen. It also
+avoids situations where a file in the current directory is refered to by
+different names, e.g., "file.aux" and "./file.aux", which can be annoying.
+
+
.TP
.B $banner [0]
If nonzero, the banner message is printed across each page when
@@ -2272,6 +2328,7 @@ Whether to display a list(s) of dependencies at the end of a run.
Name of file to receive list(s) of dependencies at the end of a run,
to be used if \fI$dependesnt_list\fR is set. If the filename is "-",
then the dependency list is set to stdout (i.e., normally the screen).
+
.TP
.B $do_cd [0]
Whether to change working directory to the directory specified for the
@@ -2383,6 +2440,22 @@ updated by sending a signal -- see the information on the variable
\fI$dvi_update_method\fR. The default value is the one appropriate
for \fIxdvi\fR on a UNIX system.
.TP
+.B $emulate_aux [0]
+Whether to emulate the use of aux_dir when $aux_dir and $out_dir are
+different, rather than using the -aux-directory option for the *latex
+programs. (MiKTeX supports -aux-directory, but TeXLive doesn't.)
+
+If you use a version of *latex that doesn't support -aux-directory, e.g.,
+TeXLive, latexmk will automatically switch aux_dir emulation on after the
+first run of *latex, because it will find the .log file in the wrong
+place.
+
+Aux_directory emulation means that when *latex is invoked, the \fIoutput\fR
+directory provided to *latex is set to be the aux_dir. After that, any
+files that need to be in the output directory will be moved there. (These
+are the files with extensions .dvi, .ps, .pdf, .fls, .synctex, .synctex.gz.)
+
+.TP
.B $failure_cmd [undefined]
See the documentation for \fI$compiling_cmd\fR.
.TP
@@ -3095,6 +3168,9 @@ correctly deal with TeX files whose names contain spaces. \fILatexmk\fR's
quoting only ensures that such filenames are correctly treated by the
operating system in passing arguments to programs.)
.TP
+.B $rc_report [1]
+After initialization, whether to give a list of the RC files read.
+.TP
.B $recorder [1]
Whether to use the \fB-recorder\fR option to \fI(latex\fR
Use of this option results in a file of extension
@@ -3919,7 +3995,7 @@ 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.74).
+(Version 4.74b).
Report bugs etc to his e-mail (jcc8 at psu.edu).
Released version can be obtained from CTAN: