summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/latexmk.1
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2018-01-18 23:25:58 +0000
committerKarl Berry <karl@freefriends.org>2018-01-18 23:25:58 +0000
commitec3a66bfdc270c6ec6c872ad560be774cf46d617 (patch)
treee0a9d4ddf710c818312c95f483709e8d582ded49 /Master/texmf-dist/doc/man/man1/latexmk.1
parentab1f1f27607fc9dfce015d503843e67a46df1acd (diff)
latexmk (18jan18)
git-svn-id: svn://tug.org/texlive/trunk@46378 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/man/man1/latexmk.1')
-rw-r--r--Master/texmf-dist/doc/man/man1/latexmk.196
1 files changed, 88 insertions, 8 deletions
diff --git a/Master/texmf-dist/doc/man/man1/latexmk.1 b/Master/texmf-dist/doc/man/man1/latexmk.1
index 33b5fcd2120..0334565101f 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 "12 December 2017" ""
+.TH LATEXMK 1 "17 January 2018" ""
.SH NAME
latexmk \- generate LaTeX document
.SH SYNOPSIS
@@ -847,6 +847,21 @@ how to determine whether an existing previewer is running.)
Turn off \fB-pvc\fR.
.TP
+.B -pvctimeout
+Do timeout in pvc mode after period of inactivity, which is 30 min. by
+default. Inactivity means a period when \fIlatexmk\fR has detected no
+file changes and hence has not taken any actions like compiling the
+document.
+
+.TP
+.B -pvctimeout-
+Don't do timeout in pvc mode after inactivity.
+
+.TP
+.B -pvctimeoutmins=<time>
+Set period of inactivity in \fIminutes\fR for pvc timeout.
+
+.TP
.B -quiet
Same as -silent
@@ -1550,7 +1565,7 @@ converting the dvi file to postscript. Without modifying the variable
\fI$banner_message\fR, this is equivalent to specifying the \fB-d\fR
option.
-Note that if \fB$banner\fR is nonzero, the \fB$postscript_mode\fR is
+Note that if \fI$banner\fR is nonzero, the \fI$postscript_mode\fR is
assumed and the postscript file is always generated, even if it is newer
than the dvi file.
.TP
@@ -1918,6 +1933,59 @@ The extension of the file which \fIlatexmk\fR generates to contain a
database of information on source files. You will not normally need
to change this.
.TP
+.B $filetime_causality_threshold [5]; $filetime_offset_report_threshold [30]. \fR(Units of seconds.)
+
+These variables control how \fIlatexmk\fR deals with the following
+issue, which can affect the use of files that are on a remote
+filesystem (network share) instead of being on a file system local to
+the computer running \fIlatexmk\fR. Almost users will not have to
+worry about these settings, and can ignore the following explanation.
+
+In almost all situations, \fIlatexmk\fR does not need to use the time
+stamps of the files it works with. However, there are a couple of
+situations when it needs to know whether a certain file was created in
+the current run of a program (e.g., \fI(pdf)latex\fR) or is a leftover
+file from a previous run. It does this by comparing the modification
+time of the file with the system time just before the program was
+started. If the modification time is earlier than when the program was
+started, the file is a leftover file, which \fIlatexmk\fR treats as if
+it were not created. If the filetime is at least the program start
+time, then it can be assumed that the file was created in the current
+run.
+
+Unfortunately, this test can fail if the file is on a remote system,
+since its system time is not necessarily synchronized with that of the
+local system; the timestamps on the remote files are set by the remote
+system, not the local system. Generally, modern operating systems
+regularly synchronize their time with a server, so the
+non-synchronization is mostly small (a second or so, or a few
+seconds). But even a small difference can mess up \fIlatexmk\fR's
+test.
+
+\fILatexmk\fR measures the time difference between the time on the two
+systems and compensates for this. But the measurement (in a
+system-independent way) is only accurate to a second or two. So
+\fIlatexmk\fR allows for a threshold on the difference between file
+and system time before it concludes that a file is a leftover file
+from a previous run. The configuration variable
+\fI$filetime_causality_theshhold\fR, which in units of seconds,
+specifies this threshold. Luckily high precision is not needed. The
+previous run is normally the previous run in a human run-edit-run
+cycle, and is at least many seconds back. A few seconds is therefore
+appropriate for the threshold, \fI$filetime_causality_theshhold\fR; it
+should be non-negative always, and should be bigger than 2 if a remote
+filesystem or network share is used.
+
+If the difference in system times on the two systems is large, it
+normally indicates that at least one of the systems is misconfigured.
+The variable \fI$filetime_offset_report_threshold\fR specifies the
+smallest size of the difference (or offset) in seconds between the
+times of the local and remote system beyond which the offset is
+reported. This is reported at the point in the \fIlatexmk\fR's
+progress that it measures the offset. The report is made if silent
+mode is used and diagnostic mode is not on.
+
+.TP
.B $force_mode [0]
If nonzero, continue processing past minor \fIlatex\fR errors
including unrecognized cross references. Equivalent to specifying the
@@ -2079,7 +2147,7 @@ such an extension, you should have made an appropriate custom
dependency for \fIlatexmk\fR, and should also have done the appropriate
programming in the LaTeX source file to enable the file to be read.
The standard extensions are handled by LaTeX and its graphics/graphicx
-packages.
+packages.)
.TP
.B $latex_silent_switch ["-interaction=batchmode"]
Switch(es) for the LaTeX processing program when silent mode is on.
@@ -2460,6 +2528,18 @@ The number of the signal that is sent to the pdf viewer when it is
updated by sending a signal -- see \fI$ps_update_method\fR. The
default value is the one appropriate for gv on a UNIX system.
.TP
+.B $pvc_timeout [0]
+If this variable is nonzero, there will be a timeout in pvc mode
+after a period of inactivity. Inactivity means a period when
+\fIlatexmk\fR has detected no file changes and hence has not taken any
+actions like compiling the document. The period of inactivity is in
+the variable $pvc_timeout_mins.
+
+.TP
+.B $pvc_timeout_mins [30]
+The period of inactivity, in minutes, after which pvc mode times out.
+This is used if \fI$pvc_timeout\fR is nonzero.
+.TP
.B $pvc_view_file_via_temporary [1]
The same as \fI$always_view_file_via_temporary\fR, except that it only
applies in preview-continuous mode (-pvc option).
@@ -2644,7 +2724,7 @@ would be to allow \fIlatexmk\fR to convert a \fI.fig\fR file to
.SS Defining a custom dependency:
The old method of configuring \fIlatexmk\fR to use a custom dependency
-was to directly manipulate the \fB@cus_dep_list\fR array that contains
+was to directly manipulate the \fI@cus_dep_list\fR array that contains
information defining the custom dependencies. (See the section "Old Method of
Defining Custom Dependencies" for details.) This method still
works, but is no longer preferred.
@@ -2874,7 +2954,7 @@ You could also instead use
}
push @generated_exts, 'ndx', 'nnd', 'adx', 'and';
-This last example uses the command specification in \fB$makeindex\fR,
+This last example uses the command specification in \fI$makeindex\fR,
and so any customization you have made for the standard index also
applies to your extra indexes.
@@ -2897,7 +2977,7 @@ if you have to deal with such problems.
.SS Old Method of Defining Custom Dependencies:
In much older versions of \fIlatexmk\fR, the only method of defining
custom dependencies was to directly manipulate the table of custom
-dependencies. This is contained in the \fB@cus_dep_list\fR array. It
+dependencies. This is contained in the \fI@cus_dep_list\fR array. It
is an array of strings, and each string in the array has four items in
it, each separated by a space, the from-extension, the to-extension,
the "must" item, and the name of the subroutine for the custom
@@ -2968,7 +3048,7 @@ processing of a rule, it is known that a particular extra file is
among the dependencies that \fIlatexmk\fR should know, but its default
methods don't find the dependency. Almost always the first argument is
the name of the rule currently being processed, so it is then
-appropriate to specify it by \fB$rule\fR.
+appropriate to specify it by \fI$rule\fR.
For examples of its use, see some of the files in the directory
\fIexample_rcfiles\fR of \fIlatexmk\fR's distribution. Currently the
@@ -3169,7 +3249,7 @@ e-mail addresses are not written in their standard form to avoid being
harvested too easily.)
.SH AUTHOR
Current version, by John Collins (username jcc8 at node psu.edu).
-(Version 4.54c).
+(Version 4.55).
Released version can be obtained from CTAN:
<http://www.ctan.org/pkg/latexmk/>, and from the