2007-09-01 04:18:15 +00:00
|
|
|
diff -dur latexmk-3.20.ORIG/latexmk.1 latexmk-3.20/latexmk.1
|
|
|
|
--- latexmk-3.20.ORIG/latexmk.1 2007-07-03 14:22:44.000000000 -0600
|
|
|
|
+++ latexmk-3.20/latexmk.1 2007-08-31 21:44:15.000000000 -0600
|
2007-03-30 15:34:53 +00:00
|
|
|
@@ -1,9 +1,9 @@
|
2007-09-01 04:18:15 +00:00
|
|
|
-.TH LATEXMK 1L "3 July 2007" ""
|
2007-03-30 15:34:53 +00:00
|
|
|
-.SH NAME
|
2007-09-01 04:18:15 +00:00
|
|
|
+.TH "LATEXMK" "1L" "3 July 2007" "" ""
|
2007-03-30 15:34:53 +00:00
|
|
|
+.SH "NAME"
|
|
|
|
latexmk \- generate LaTeX document
|
|
|
|
-.SH SYNOPSIS
|
|
|
|
+.SH "SYNOPSIS"
|
|
|
|
.B latexmk [options] [file ...]
|
|
|
|
-.SH DESCRIPTION
|
|
|
|
+.SH "DESCRIPTION"
|
|
|
|
.I LatexMk
|
|
|
|
completely automates the process of compiling a LaTeX document.
|
2007-09-01 04:18:15 +00:00
|
|
|
Essentially, it is like a specialized relative of the general
|
|
|
|
@@ -15,8 +15,8 @@
|
|
|
|
document. It can also be set to run continuously with a suitable
|
|
|
|
previewer; in that case the LaTeX program, etc, are rerun whenever one
|
|
|
|
of the source files is modified, and the previewer updates the
|
|
|
|
-on-screen view of the compiled document.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.PP
|
2007-09-01 04:18:15 +00:00
|
|
|
+on\-screen view of the compiled document.
|
2007-03-30 15:34:53 +00:00
|
|
|
+.PP
|
2007-09-01 04:18:15 +00:00
|
|
|
\fILatexmk\fR determines which are the source files by examining the
|
|
|
|
log file. When \fIlatexmk\fR is run, it examines properties of the
|
|
|
|
source files, and if any have been changed since the last document
|
|
|
|
@@ -30,14 +30,14 @@
|
|
|
|
For example, from an updated figure file it can automatically generate
|
|
|
|
a file in encapsulated postscript or another suitable format for
|
|
|
|
reading by LaTeX.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
\fILatexmk\fR has two different previewing options. In the simple
|
2007-09-01 04:18:15 +00:00
|
|
|
-\fB-pv\fR option, a dvi, postscript or pdf previewer is automatically
|
|
|
|
+\fB\-pv\fR option, a dvi, postscript or pdf previewer is automatically
|
|
|
|
run after generating the dvi, postscript or pdf version of the
|
|
|
|
document. The type of file to view is selected according to
|
|
|
|
configuration settings and command line options.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.PP
|
2007-09-01 04:18:15 +00:00
|
|
|
-The second previewing option is the powerful \fB-pvc\fR option
|
2007-03-30 15:34:53 +00:00
|
|
|
+.PP
|
2007-09-01 04:18:15 +00:00
|
|
|
+The second previewing option is the powerful \fB\-pvc\fR option
|
|
|
|
(mnemonic: "preview continuously"). In this case, \fIlatexmk\fR runs
|
|
|
|
continuously, regularly monitoring all the source files to see if any
|
|
|
|
have changed. Every time a change is detected, \fIlatexmk\fR runs all
|
|
|
|
@@ -47,31 +47,31 @@
|
|
|
|
are written to disk, \fIlatexmk\fR completely automates the cycle of
|
|
|
|
updating the .dvi (and possibly the .ps and .pdf) file, and refreshing
|
|
|
|
the previewer's display. It's not quite WYSIWYG, but usefully close.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.PP
|
|
|
|
+.PP
|
2007-09-01 04:18:15 +00:00
|
|
|
For other previewers, the user may have to manually make the previewer
|
|
|
|
update its display, which can be (some versions of xdvi and gsview) as
|
|
|
|
simple as forcing a redraw of its display.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.PP
|
|
|
|
+.PP
|
2007-09-01 04:18:15 +00:00
|
|
|
\fILatexmk\fR has the ability to print a banner in gray diagonally
|
|
|
|
across each page when making the postscript file. It can also, if
|
|
|
|
needed, call an external program to do other postprocessing on the
|
|
|
|
generated files.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
\fILatexmk\fR is highly configurable, both from the command line and
|
|
|
|
in configuration files, so that it can accommodate a wide variety of
|
2007-09-01 04:18:15 +00:00
|
|
|
user needs and system configurations. Default values are set
|
|
|
|
according to the operating system, so \fIlatexmk\fR often works
|
|
|
|
-without special configuration on MS-Windows, cygwin, Linux, OS-X, and
|
|
|
|
+without special configuration on MS\-Windows, cygwin, Linux, OS\-X, and
|
|
|
|
other UNIX systems (notably Solaris).
|
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
A very annoying complication handled very reliably by \fILatexmk\fR,
|
|
|
|
is that LaTeX is a multiple pass system. On each run, LaTeX reads in
|
|
|
|
information generated on a previous run, for things like cross
|
|
|
|
referencing and indexing. In the simplest cases, a second run of
|
|
|
|
LaTeX suffices, and often the log file contains a message about the
|
|
|
|
-need for another pass. However, there is a wide variety of add-on
|
|
|
|
+need for another pass. However, there is a wide variety of add\-on
|
|
|
|
macro packages to LaTeX, with a variety of behaviors. The result is
|
|
|
|
-to break simple-minded determinations of how many runs are needed and
|
|
|
|
+to break simple\-minded determinations of how many runs are needed and
|
|
|
|
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
|
|
|
|
@@ -79,10 +79,10 @@
|
|
|
|
\fR.fdb_latexmk\fR, by default) that contains the source file
|
|
|
|
information.
|
|
|
|
|
2007-03-30 15:34:53 +00:00
|
|
|
-.SH LATEXMK OPTIONS AND ARGUMENTS
|
|
|
|
-(All options can be introduced by single or double "-" characters,
|
|
|
|
-e.g., "latexmk -help" or "latexmk --help".)
|
|
|
|
-.TP
|
|
|
|
+.SH "LATEXMK OPTIONS AND ARGUMENTS"
|
|
|
|
+(All options can be introduced by single or double "\-" characters,
|
|
|
|
+e.g., "latexmk \-help" or "latexmk \-\-help".)
|
|
|
|
+.TP
|
|
|
|
.B file
|
|
|
|
One or more files can be specified. If no files are specified,
|
|
|
|
\fIlatexmk\fR will, by default, run on all files in the current working directory
|
2007-09-01 04:18:15 +00:00
|
|
|
@@ -95,79 +95,79 @@
|
2007-03-30 15:34:53 +00:00
|
|
|
latexmk foo
|
|
|
|
|
|
|
|
then \fIlatexmk\fR will operate on the file "foo.tex".
|
|
|
|
-.TP
|
|
|
|
-.B -bm <message>
|
|
|
|
+.TP
|
|
|
|
+.B \-bm <message>
|
|
|
|
A banner message to print diagonally across each page when converting
|
|
|
|
the dvi file to postscript. The message must be a single argument on
|
|
|
|
the command line so be careful with quoting spaces and such.
|
|
|
|
|
|
|
|
-Note that if the \fB-bm\fR option is specified, the \fB-ps\fR option is
|
|
|
|
+Note that if the \fB\-bm\fR option is specified, the \fB\-ps\fR option is
|
2007-09-01 04:18:15 +00:00
|
|
|
assumed.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
|
|
|
-.B -bi <intensity>
|
|
|
|
+.TP
|
|
|
|
+.B \-bi <intensity>
|
|
|
|
How dark to print the banner message. A decimal number between 0 and 1.
|
2007-09-01 04:18:15 +00:00
|
|
|
0 is black and 1 is white. The default is 0.95, which is OK unless your
|
2007-03-30 15:34:53 +00:00
|
|
|
toner cartridge is getting low.
|
|
|
|
-.TP
|
|
|
|
-.B -bs <scale>
|
|
|
|
+.TP
|
|
|
|
+.B \-bs <scale>
|
|
|
|
A decimal number that specifies how large the banner message will be
|
|
|
|
printed. Experimentation is necessary to get the right scale for your
|
|
|
|
message, as a rule of thumb the scale should be about equal to 1100
|
2007-09-01 04:18:15 +00:00
|
|
|
divided by the number of characters in the message. The default is 220.0
|
2007-03-30 15:34:53 +00:00
|
|
|
which is just right for 5 character messages.
|
|
|
|
.TP
|
|
|
|
-.B -commands
|
|
|
|
+.B \-commands
|
|
|
|
List the commands used by \fIlatexmk\fR for processing files, and then
|
|
|
|
exit.
|
|
|
|
.TP
|
|
|
|
-.B -c
|
|
|
|
+.B \-c
|
2007-09-01 04:18:15 +00:00
|
|
|
Clean up (remove) all regenerateable files generated by \fIlatex\fR
|
|
|
|
and \fIbibtex\fR except dvi, postscript and pdf. In addition, files
|
|
|
|
specified by the $clean_ext configuration variable are removed. But
|
|
|
|
the file containing a database of source file information is not
|
|
|
|
removed.
|
2007-03-30 15:34:53 +00:00
|
|
|
|
|
|
|
-This cleanup is instead of a regular make. See the \fB-gg\fR option
|
|
|
|
+This cleanup is instead of a regular make. See the \fB\-gg\fR option
|
2007-09-01 04:18:15 +00:00
|
|
|
if you want to do a cleanup then a make.
|
2007-03-30 15:34:53 +00:00
|
|
|
.TP
|
|
|
|
-.B -C
|
|
|
|
+.B \-C
|
|
|
|
Clean up (remove) all regenerateable files generated by \fIlatex\fR
|
|
|
|
and \fIbibtex\fR including aux, dep, dvi, postscript and pdf. In
|
|
|
|
addition, those specified by the $clean_ext and $clean_full_ext
|
2007-09-01 04:18:15 +00:00
|
|
|
configuration variables are removed. But the file containing a
|
|
|
|
database of source file information is not removed.
|
2007-03-30 15:34:53 +00:00
|
|
|
|
|
|
|
-This cleanup is instead of a regular make. See the \fB-gg\fR option
|
|
|
|
+This cleanup is instead of a regular make. See the \fB\-gg\fR option
|
|
|
|
if you want to do a cleanup than a make.
|
2007-09-01 04:18:15 +00:00
|
|
|
.TP
|
|
|
|
-.B -CA
|
|
|
|
+.B \-CA
|
|
|
|
Clean up (remove) absolutely all regenerateable files generated by
|
|
|
|
\fIlatex\fR and \fIbibtex\fR including aux, dep, dvi, postscript and
|
|
|
|
pdf. In addition, those specified by the $clean_ext, $clean_full_ext,
|
|
|
|
and @generated_exts configuration variables are removed, and the file
|
|
|
|
containing a database of source file information.
|
2007-03-30 15:34:53 +00:00
|
|
|
|
2007-09-01 04:18:15 +00:00
|
|
|
-This cleanup is instead of a regular make. It is the same as \fB-C
|
|
|
|
--CF\fR. See the \fB-gg\fR option if you want to do a cleanup then a
|
|
|
|
+This cleanup is instead of a regular make. It is the same as \fB\-C
|
|
|
|
+\-CF\fR. See the \fB\-gg\fR option if you want to do a cleanup then a
|
|
|
|
make.
|
|
|
|
.TP
|
|
|
|
-.B -CF
|
|
|
|
+.B \-CF
|
|
|
|
Remove the file containing a database of source file information,
|
|
|
|
before doing the other actions requested.
|
2007-03-30 15:34:53 +00:00
|
|
|
.TP
|
|
|
|
-.B -d
|
|
|
|
+.B \-d
|
|
|
|
Set draft mode. This prints the banner message "DRAFT" across your
|
|
|
|
page when converting the dvi file to postscript. Size and intensity
|
|
|
|
-can be modified with the \fB-bs\fR and \fB-bi\fR options. The \fB-bm\fR
|
|
|
|
+can be modified with the \fB\-bs\fR and \fB\-bi\fR options. The \fB\-bm\fR
|
|
|
|
option will override this option as this is really just a short way of
|
|
|
|
specifying:
|
|
|
|
|
|
|
|
- latexmk -bm DRAFT
|
|
|
|
+ latexmk \-bm DRAFT
|
|
|
|
|
|
|
|
-Note that if the \fB-d\fR option is specified, the \fB-ps\fR option is
|
|
|
|
+Note that if the \fB\-d\fR option is specified, the \fB\-ps\fR option is
|
2007-09-01 04:18:15 +00:00
|
|
|
assumed.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
|
|
|
-.B -dF
|
|
|
|
+.TP
|
|
|
|
+.B \-dF
|
|
|
|
Dvi file filtering. The argument to this option is a filter which will
|
|
|
|
generate a filtered dvi file with the extension ".dviF". All extra
|
|
|
|
processing (e.g. conversion to postscript, preview, printing) will then
|
2007-09-01 04:18:15 +00:00
|
|
|
@@ -175,117 +175,117 @@
|
2007-03-30 15:34:53 +00:00
|
|
|
|
|
|
|
Example usage: To use dviselect to select only the even pages of the dvi file:
|
|
|
|
|
|
|
|
- latexmk -dF 'dviselect even' foo.tex
|
|
|
|
-.TP
|
2007-09-01 04:18:15 +00:00
|
|
|
-.B -diagnostics
|
2007-03-30 15:34:53 +00:00
|
|
|
+ latexmk \-dF 'dviselect even' foo.tex
|
|
|
|
+.TP
|
2007-09-01 04:18:15 +00:00
|
|
|
+.B \-diagnostics
|
|
|
|
Print detailed diagnostics during a run. This may help for debugging
|
|
|
|
problems or to understand \fI.latexmk\fR's behavior in difficult
|
|
|
|
situations.
|
|
|
|
-.TP
|
|
|
|
-.B -dvi
|
|
|
|
+.TP
|
2007-03-30 15:34:53 +00:00
|
|
|
+.B \-dvi
|
|
|
|
Generate dvi version of document.
|
|
|
|
-.TP
|
|
|
|
-.B -dvi-
|
|
|
|
+.TP
|
|
|
|
+.B \-dvi\-
|
|
|
|
Turn off generation of dvi version of document. (This may get
|
|
|
|
overridden, if some other file is made (a .ps file) that is generated from
|
|
|
|
the dvi file, or if no generated file at all is requested.)
|
|
|
|
-.TP
|
|
|
|
-.B -f
|
|
|
|
+.TP
|
|
|
|
+.B \-f
|
|
|
|
Force \fIlatexmk\fR to continue document processing despite errors.
|
2007-09-01 04:18:15 +00:00
|
|
|
Normally, when \fIlatexmk\fR detects that LaTeX or another program has
|
|
|
|
found an error which will not be resolved by further processing, no
|
|
|
|
further processing is carried out.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
|
|
|
-.B -f-
|
|
|
|
-Turn off the forced processing-past-errors such as is set by the
|
|
|
|
-\fB-f\fR option. This could be used to override a setting in a
|
|
|
|
+.TP
|
|
|
|
+.B \-f\-
|
|
|
|
+Turn off the forced processing\-past\-errors such as is set by the
|
|
|
|
+\fB\-f\fR option. This could be used to override a setting in a
|
|
|
|
configuration file.
|
|
|
|
-.TP
|
|
|
|
-.B -g
|
|
|
|
+.TP
|
|
|
|
+.B \-g
|
2007-09-01 04:18:15 +00:00
|
|
|
Force \fIlatexmk\fR to process document fully, even under situations
|
|
|
|
where \fIlatexmk\fR would normally decide that no changes in the
|
|
|
|
source files have occured since the previous run.
|
2007-03-30 15:34:53 +00:00
|
|
|
This option is useful, for example, if you change some options and
|
|
|
|
wish to reprocess the files.
|
|
|
|
-.TP
|
|
|
|
-.B -g-
|
|
|
|
-Turn off \fB-g\fR.
|
|
|
|
-.TP
|
|
|
|
-.B -gg
|
|
|
|
+.TP
|
|
|
|
+.B \-g\-
|
|
|
|
+Turn off \fB\-g\fR.
|
|
|
|
+.TP
|
|
|
|
+.B \-gg
|
2007-09-01 04:18:15 +00:00
|
|
|
"Super go mode" or "clean make": clean out generated files as if
|
|
|
|
-\fB-CA\fR had been given, and then do a regular make.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
|
|
|
-.B -h, -help
|
2007-09-01 04:18:15 +00:00
|
|
|
+\fB\-CA\fR had been given, and then do a regular make.
|
2007-03-30 15:34:53 +00:00
|
|
|
+.TP
|
|
|
|
+.B \-h, \-help
|
|
|
|
Print help information.
|
|
|
|
-.TP
|
|
|
|
-.B -l
|
|
|
|
+.TP
|
|
|
|
+.B \-l
|
|
|
|
Run in landscape mode, using the landscape mode for the previewers and
|
2007-09-01 04:18:15 +00:00
|
|
|
the dvi to postscript converters. This option is not normally needed
|
|
|
|
nowadays, since current previewers normally determine this information
|
|
|
|
automatically.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
|
|
|
-.B -l-
|
|
|
|
-Turn off \fB-l\fR.
|
|
|
|
-.TP
|
|
|
|
-.B -new-viewer
|
|
|
|
-When in continuous-preview mode, always start a new viewer to view the
|
|
|
|
-generated file. By default, \fIlatexmk\fR will, in continuous-preview
|
|
|
|
+.TP
|
|
|
|
+.B \-l\-
|
|
|
|
+Turn off \fB\-l\fR.
|
|
|
|
+.TP
|
|
|
|
+.B \-new\-viewer
|
|
|
|
+When in continuous\-preview mode, always start a new viewer to view the
|
|
|
|
+generated file. By default, \fIlatexmk\fR will, in continuous\-preview
|
|
|
|
mode, test for a previously running previewer for the same file and
|
|
|
|
not start a new one if a previous previewer is running. However, its
|
|
|
|
-test sometimes fails (notably if there is an already-running previewer
|
|
|
|
+test sometimes fails (notably if there is an already\-running previewer
|
|
|
|
that is viewing a file of the same name as the current file, but in a
|
|
|
|
different directory). This option turns off this default behavior.
|
|
|
|
-.TP
|
|
|
|
-.B -new-viewer-
|
2007-09-01 04:18:15 +00:00
|
|
|
-The inverse of the \fB-new-viewer\fR option. It puts \fIlatexmk\fR
|
2007-03-30 15:34:53 +00:00
|
|
|
-in its normal behavior that in preview-continuous mode it checks for
|
|
|
|
-an already-running previewer.
|
|
|
|
-.TP
|
|
|
|
-.B -p
|
|
|
|
+.TP
|
|
|
|
+.B \-new\-viewer\-
|
2007-09-01 04:18:15 +00:00
|
|
|
+The inverse of the \fB\-new\-viewer\fR option. It puts \fIlatexmk\fR
|
2007-03-30 15:34:53 +00:00
|
|
|
+in its normal behavior that in preview\-continuous mode it checks for
|
|
|
|
+an already\-running previewer.
|
|
|
|
+.TP
|
|
|
|
+.B \-p
|
2007-09-01 04:18:15 +00:00
|
|
|
Print out the document. By default on a UNIX or Linux system, this is
|
|
|
|
done using lpr after generating the postscript file. But you can use
|
|
|
|
-the \fB-print=...\fR option to print the dvi or pdf files instead, and
|
|
|
|
+the \fB\-print=...\fR option to print the dvi or pdf files instead, and
|
|
|
|
you can configure this in a start up file (by setting the
|
|
|
|
\fI$print_type\fR variable).
|
2007-03-30 15:34:53 +00:00
|
|
|
|
2007-09-01 04:18:15 +00:00
|
|
|
However, the correct behavior for printing very much depends on your
|
|
|
|
-system's software. In particular, under MS-Windows you must have
|
|
|
|
+system's software. In particular, under MS\-Windows you must have
|
|
|
|
suitable program(s) available, and you must have configured the print
|
|
|
|
-commands used by \fIlatexmk\fR. This can be non-trivial.
|
|
|
|
+commands used by \fIlatexmk\fR. This can be non\-trivial.
|
2007-03-30 15:34:53 +00:00
|
|
|
|
|
|
|
-This option is incompatible with the \fB-pv\fR and \fB-pvc\fR options,
|
|
|
|
+This option is incompatible with the \fB\-pv\fR and \fB\-pvc\fR options,
|
|
|
|
so it turns them off.
|
|
|
|
-.TP
|
|
|
|
-.B -pdf
|
|
|
|
+.TP
|
|
|
|
+.B \-pdf
|
|
|
|
Generate pdf version of document using pdflatex.
|
|
|
|
-.TP
|
|
|
|
-.B -pdfdvi
|
|
|
|
+.TP
|
|
|
|
+.B \-pdfdvi
|
|
|
|
Generate pdf version of document from the dvi file, by default using dvipdf.
|
|
|
|
-.TP
|
|
|
|
-.B -pdfps
|
|
|
|
+.TP
|
|
|
|
+.B \-pdfps
|
|
|
|
Generate pdf version of document from the ps file, by default using
|
|
|
|
ps2pdf.
|
|
|
|
-.TP
|
|
|
|
-.B -pdf-
|
|
|
|
+.TP
|
|
|
|
+.B \-pdf\-
|
|
|
|
Turn off generation of pdf version of document.
|
|
|
|
(This can be used to override a setting in a configuration file.
|
|
|
|
It may get overridden if some other option requires the generation of
|
|
|
|
a pdf file.)
|
|
|
|
-.TP
|
|
|
|
-.B -print=dvi, -print=ps, -print=pdf
|
|
|
|
+.TP
|
|
|
|
+.B \-print=dvi, \-print=ps, \-print=pdf
|
|
|
|
Define which kind of file is printed. This option also ensures that
|
|
|
|
the requisite file is made, and turns on printing.
|
|
|
|
-.TP
|
|
|
|
-.B -ps
|
|
|
|
+.TP
|
|
|
|
+.B \-ps
|
|
|
|
Generate postscript version of document.
|
|
|
|
-.TP
|
|
|
|
-.B -ps-
|
|
|
|
+.TP
|
|
|
|
+.B \-ps\-
|
|
|
|
Turn off generation of postscript version of document.
|
|
|
|
This can be used to override a setting in a configuration file.
|
|
|
|
(It may get overridden by some other option that requires a postscript
|
|
|
|
file, for example a request for printing.)
|
|
|
|
-.TP
|
|
|
|
-.B -pF
|
|
|
|
+.TP
|
|
|
|
+.B \-pF
|
|
|
|
Postscript file filtering. The argument to this option is a filter
|
|
|
|
which will generate a filtered postscript file with the extension
|
|
|
|
".psF". All extra processing (e.g. preview, printing) will then be
|
2007-09-01 04:18:15 +00:00
|
|
|
@@ -293,54 +293,54 @@
|
2007-03-30 15:34:53 +00:00
|
|
|
|
|
|
|
Example usage: Use psnup to print two pages on the one page:
|
|
|
|
|
|
|
|
- latexmk -ps -pF 'psnup -2' foo.tex
|
|
|
|
+ latexmk \-ps \-pF 'psnup \-2' foo.tex
|
|
|
|
|
|
|
|
or
|
|
|
|
|
|
|
|
- latexmk -ps -pF "psnup -2" foo.tex
|
|
|
|
+ latexmk \-ps \-pF "psnup \-2" foo.tex
|
|
|
|
|
|
|
|
-Whether to use single or double quotes round the "psnup -2" will depend on
|
|
|
|
+Whether to use single or double quotes round the "psnup \-2" will depend on
|
|
|
|
your command interpreter, in particular on the operating system.
|
|
|
|
-.TP
|
|
|
|
-.B -pv
|
|
|
|
-Run file previewer. If the \fB-view\fR option is used, this will select
|
|
|
|
+.TP
|
|
|
|
+.B \-pv
|
|
|
|
+Run file previewer. If the \fB\-view\fR option is used, this will select
|
|
|
|
the kind of file to be previewed (dvi, ps or pdf).
|
|
|
|
Otherwise the viewer views the "highest" kind of file selected, by the
|
|
|
|
-\fB-dvi\fR, \fB-ps\fR, \fB-pdf\fR, \fB-pdfps\fR options, in the
|
|
|
|
+\fB\-dvi\fR, \fB\-ps\fR, \fB\-pdf\fR, \fB\-pdfps\fR options, in the
|
|
|
|
order dvi, ps, pdf (low to high).
|
|
|
|
If no file type has been selected, the dvi previewer will be used.
|
|
|
|
-This option is incompatible with the \fB-p\fR and \fB-pvc\fR options,
|
|
|
|
+This option is incompatible with the \fB\-p\fR and \fB\-pvc\fR options,
|
|
|
|
so it turns them off.
|
|
|
|
-.TP
|
|
|
|
-.B -pv-
|
|
|
|
-Turn off \fB-pv\fR.
|
|
|
|
-.TP
|
|
|
|
-.B -pvc
|
|
|
|
+.TP
|
|
|
|
+.B \-pv\-
|
|
|
|
+Turn off \fB\-pv\fR.
|
|
|
|
+.TP
|
|
|
|
+.B \-pvc
|
|
|
|
Run a file previewer and continually update the .dvi, .ps, and/or .pdf
|
|
|
|
files whenever changes are made to source files (see the Description
|
|
|
|
above). Which of these files is generated and which is viewed is
|
|
|
|
-governed by the other options, and is the same as for the \fB-pv\fR
|
|
|
|
+governed by the other options, and is the same as for the \fB\-pv\fR
|
|
|
|
option.
|
|
|
|
-This option also turns on the \fB-f\fR option, since it is normally
|
|
|
|
-desirable in preview-continuous-mode to continue working even if
|
|
|
|
+This option also turns on the \fB\-f\fR option, since it is normally
|
|
|
|
+desirable in preview\-continuous\-mode to continue working even if
|
|
|
|
errors are found.
|
|
|
|
-The preview-continuous option \fB-pvc\fR can only work with one file.
|
|
|
|
+The preview\-continuous option \fB\-pvc\fR can only work with one file.
|
|
|
|
So in this case you will normally only specify one filename on
|
|
|
|
the command line. It is also incompatible with the
|
|
|
|
-\fB-p\fR and \fB-pv\fR options, so it turns these options off
|
|
|
|
+\fB\-p\fR and \fB\-pv\fR options, so it turns these options off
|
|
|
|
|
2007-09-01 04:18:15 +00:00
|
|
|
With a good previewer the display will be automatically updated.
|
|
|
|
-(Under \fIsome but not all\fR versions of UNIX/Linux "gv -watch" does
|
|
|
|
+(Under \fIsome but not all\fR versions of UNIX/Linux "gv \-watch" does
|
|
|
|
this for postscript files; this can be set by a configuration
|
|
|
|
variable. This would also work for pdf files except for an apparent
|
|
|
|
bug in gv that causes an error when the newly updated pdf file is
|
|
|
|
read.) Many other previewers will need a manual update.
|
2007-03-30 15:34:53 +00:00
|
|
|
|
|
|
|
-Important note: the acroread program on MS-Windows locks the pdf file,
|
|
|
|
+Important note: the acroread program on MS\-Windows locks the pdf file,
|
|
|
|
and prevents new versions being written, so it is a bad idea to use
|
|
|
|
-acroread to view pdf files in preview-continuous mode. It is better
|
|
|
|
-to use a dvi or ps viewer, as set by one of the \fB-view=dvi\fR and
|
|
|
|
-\fB-view=ps\fR options.
|
|
|
|
+acroread to view pdf files in preview\-continuous mode. It is better
|
|
|
|
+to use a dvi or ps viewer, as set by one of the \fB\-view=dvi\fR and
|
|
|
|
+\fB\-view=ps\fR options.
|
|
|
|
|
2007-09-01 04:18:15 +00:00
|
|
|
There are some other methods for arranging an update, notably useful
|
|
|
|
for many versions of xdvi and xpdf. These are best set in
|
|
|
|
@@ -348,65 +348,65 @@
|
|
|
|
|
|
|
|
Note that if \fIlatexmk\fR dies or is stopped by the user, the
|
2007-03-30 15:34:53 +00:00
|
|
|
"forked" previewer will continue to run. Successive invocations with
|
|
|
|
-the \fB-pvc\fR option will not fork new previewers, but \fIlatexmk\fR
|
|
|
|
+the \fB\-pvc\fR option will not fork new previewers, but \fIlatexmk\fR
|
2007-09-01 04:18:15 +00:00
|
|
|
will normally use the existing previewer. (At least this will happen
|
|
|
|
when \fIlatexmk\fR is running under an operating system where it knows
|
|
|
|
how to determine whether an existing previewer is running.)
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
|
|
|
-.B -pvc-
|
|
|
|
-Turn off \fB-pvc\fR.
|
|
|
|
-.TP
|
|
|
|
-.B -quiet
|
|
|
|
-Same as -silent
|
|
|
|
-.TP
|
|
|
|
-.B -r <rcfile>
|
|
|
|
+.TP
|
|
|
|
+.B \-pvc\-
|
|
|
|
+Turn off \fB\-pvc\fR.
|
|
|
|
+.TP
|
|
|
|
+.B \-quiet
|
|
|
|
+Same as \-silent
|
|
|
|
+.TP
|
|
|
|
+.B \-r <rcfile>
|
2007-09-01 04:18:15 +00:00
|
|
|
Read the specified initialization file ("RC file") before processing.
|
|
|
|
|
|
|
|
-Be careful about the ordering: (1) Standard initialization files --
|
|
|
|
-see the section below on "Initialization (RC) files" -- are read
|
|
|
|
+Be careful about the ordering: (1) Standard initialization files \-\-
|
|
|
|
+see the section below on "Initialization (RC) files" \-\- are read
|
|
|
|
first. (2) Then the options on the command line are acted on in the
|
|
|
|
order they are given. Therefore if an initialization file is
|
|
|
|
-specified by the \fB-r\fR option, it is read during this second step.
|
2007-03-30 15:34:53 +00:00
|
|
|
-Thus an initialization file specified with the \fB-r\fR option can
|
2007-09-01 04:18:15 +00:00
|
|
|
+specified by the \fB\-r\fR option, it is read during this second step.
|
2007-03-30 15:34:53 +00:00
|
|
|
+Thus an initialization file specified with the \fB\-r\fR option can
|
2007-09-01 04:18:15 +00:00
|
|
|
override both the standard initialization files and \fIpreviously\fR
|
|
|
|
specified options. But all of these can be overridden by \fIlater\fR
|
|
|
|
options. See below for more details about initialization (RC) files.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
|
|
|
-.B -silent
|
|
|
|
+.TP
|
|
|
|
+.B \-silent
|
|
|
|
Run commands silently, i.e., with options that reduce the amount of
|
|
|
|
diagnostics generated. For example, with the default settings for
|
|
|
|
-commands under UNIX, the command "latex -interaction=batchmode" is used
|
|
|
|
+commands under UNIX, the command "latex \-interaction=batchmode" is used
|
|
|
|
for latex.
|
|
|
|
|
|
|
|
Also reduce the number of informational messages that \fIlatexmk\fR
|
|
|
|
generates.
|
|
|
|
-.TP
|
|
|
|
-.B -v, -version
|
|
|
|
+.TP
|
|
|
|
+.B \-v, \-version
|
2007-09-01 04:18:15 +00:00
|
|
|
Print version number of \fIlatexmk\fR.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
|
|
|
-.B -verbose
|
|
|
|
-Opposite of \fB-silent\fR. This is the default setting.
|
|
|
|
-.TP
|
|
|
|
-.B -view=default, -view=dvi, -view=ps, -view=pdf
|
|
|
|
+.TP
|
|
|
|
+.B \-verbose
|
|
|
|
+Opposite of \fB\-silent\fR. This is the default setting.
|
|
|
|
+.TP
|
|
|
|
+.B \-view=default, \-view=dvi, \-view=ps, \-view=pdf
|
|
|
|
Set the kind of file used when previewing is requested (e.g., by the
|
|
|
|
-\fB-pv\fR or \fB-pvc\fR switches). The default is to view the "highest"
|
|
|
|
+\fB\-pv\fR or \fB\-pvc\fR switches). The default is to view the "highest"
|
|
|
|
kind of requested file (in the order dvi, ps, pdf).
|
|
|
|
-.PP
|
|
|
|
-The preview-continuous option \fB-pvc\fR can only work with one file.
|
|
|
|
+.PP
|
|
|
|
+The preview\-continuous option \fB\-pvc\fR can only work with one file.
|
|
|
|
So in this case you will normally only specify one filename on
|
|
|
|
the command line.
|
|
|
|
-.PP
|
|
|
|
-Options \fB-p\fR, \fB-pv\fR and \fB-pvc\fR are mutually exclusive. So
|
|
|
|
+.PP
|
|
|
|
+Options \fB\-p\fR, \fB\-pv\fR and \fB\-pvc\fR are mutually exclusive. So
|
|
|
|
each of these options turns the others off.
|
2007-09-01 04:18:15 +00:00
|
|
|
|
2007-03-30 15:34:53 +00:00
|
|
|
-.SH EXAMPLES
|
|
|
|
-.nf
|
|
|
|
+.SH "EXAMPLES"
|
|
|
|
+.nf
|
|
|
|
.ta 2i
|
|
|
|
% \fBlatexmk thesis\fR \fI# run latex enough times to resolve
|
|
|
|
- cross-references\fR
|
|
|
|
+ cross\-references\fR
|
|
|
|
|
|
|
|
-% \fBlatexmk -pvc -ps thesis\fR \fI# run latex enough times to resolve
|
|
|
|
- cross-references, make a postscript
|
|
|
|
+% \fBlatexmk \-pvc \-ps thesis\fR \fI# run latex enough times to resolve
|
|
|
|
+ cross\-references, make a postscript
|
|
|
|
file, start a previewer. Then
|
|
|
|
watch for changes in the source
|
|
|
|
file thesis.tex and any files it
|
2007-09-01 04:18:15 +00:00
|
|
|
@@ -416,55 +416,56 @@
|
2007-03-30 15:34:53 +00:00
|
|
|
encounters an error, latexmk will
|
|
|
|
keep running.
|
|
|
|
|
|
|
|
-% \fBlatexmk -c\fR \fI# remove .aux, .log, .bbl, .blg, .dep,
|
|
|
|
+% \fBlatexmk \-c\fR \fI# remove .aux, .log, .bbl, .blg, .dep,
|
|
|
|
.dvi, .pdf, .ps & .bbl files\fR
|
|
|
|
-.SH INITIALIZATION (RC) FILES
|
|
|
|
-.PP
|
|
|
|
+.SH "INITIALIZATION (RC) FILES"
|
|
|
|
+.PP
|
|
|
|
There are four initialization files ("RC files") that \fIlatexmk\fR can
|
|
|
|
read at startup:
|
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
1) The system RC file, if it exists.
|
|
|
|
On a UNIX system, \fIlatexmk\fR searches for following places for its
|
|
|
|
system RC file, in the following order, and reads the first it finds:
|
|
|
|
"/opt/local/share/latexmk/LatexMk",
|
|
|
|
"/usr/local/share/latexmk/LatexMk",
|
|
|
|
"/usr/local/lib/latexmk/LatexMk".
|
|
|
|
- On a MS-WINDOWS system it looks for "C:\\latexmk\\LatexMk".
|
|
|
|
-.PP
|
2007-09-01 04:18:15 +00:00
|
|
|
+ On Fedora systems, it only looks for "/etc/latexmk.conf".
|
2007-03-30 15:34:53 +00:00
|
|
|
+ On a MS\-WINDOWS system it looks for "C:\\latexmk\\LatexMk".
|
|
|
|
+.PP
|
|
|
|
2) The user's RC file in "$HOME/.latexmkrc", where $HOME is the value
|
|
|
|
of the environment variable HOME. On UNIX and clones (including LINUX),
|
|
|
|
this variable
|
|
|
|
-is set by the system; on MS-Windows, the user may choose to set it.
|
|
|
|
-.PP
|
|
|
|
+is set by the system; on MS\-Windows, the user may choose to set it.
|
|
|
|
+.PP
|
|
|
|
3) The RC file in the current working directory called "latexmkrc".
|
|
|
|
-.PP
|
|
|
|
-4) Any RC file(s) specified on the command line with the \fB-r\fR option.
|
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
+4) Any RC file(s) specified on the command line with the \fB\-r\fR option.
|
|
|
|
+.PP
|
|
|
|
Each RC file is a sequence of Perl commands. Usually it will be just a
|
|
|
|
-sequence of assignment statements that override the built-in settings of
|
|
|
|
+sequence of assignment statements that override the built\-in settings of
|
|
|
|
\fILatexmk\fR. Comment lines are introduced by the "#" character.
|
|
|
|
|
|
|
|
Note that command line options are obeyed in the order in which
|
|
|
|
they are written; thus any RC file specified on the command line with
|
|
|
|
-the \fB-r\fR option can override previous options but can be itself
|
|
|
|
+the \fB\-r\fR option can override previous options but can be itself
|
|
|
|
overridden by later options on the command line.
|
|
|
|
|
|
|
|
-.SH RC VARIABLES IN INITIALIZATION FILES
|
|
|
|
-.PP
|
|
|
|
+.SH "RC VARIABLES IN INITIALIZATION FILES"
|
|
|
|
+.PP
|
|
|
|
Many of the available variables that can be set are shown in the next
|
|
|
|
section. Syntax for the statements in an initialization file is of
|
|
|
|
the form:
|
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
$bibtex = 'bibtex';
|
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
for the setting of a string variable,
|
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
$preview_mode = 1;
|
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
for the setting of a numeric variable, and
|
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
@default_files = ('paper', 'paper1');
|
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
for the setting of an array of strings.
|
|
|
|
|
|
|
|
Some of the variables set the names of the commands that \fIlatexmk\fR
|
2007-09-01 04:18:15 +00:00
|
|
|
@@ -472,37 +473,37 @@
|
2007-03-30 15:34:53 +00:00
|
|
|
|
|
|
|
\fB"Detaching" a command\fR: If a command is to be run detached this
|
|
|
|
is indicated by preceding it with "start", as in
|
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
$dvi_previewer = 'start xdvi';
|
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
This will be translated to whatever is appropriate for your operating
|
|
|
|
system. (Note: in some circumstances, \fIlatex\fR will always run a
|
|
|
|
command detached. This is the case for a previewer in preview
|
|
|
|
continuous mode, since otherwise previewing continuously makes no
|
|
|
|
sense.)
|
|
|
|
|
|
|
|
-\fBCommand names containing spaces\fR: Under MS-Windows it is common
|
|
|
|
+\fBCommand names containing spaces\fR: Under MS\-Windows it is common
|
|
|
|
that the name of a command includes spaces, since software is often
|
|
|
|
installed in a subdirectory of "C:\Program Files". Such command names
|
|
|
|
should be enclosed in double quotes, as in
|
|
|
|
|
|
|
|
$lpr_pdf = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p';
|
|
|
|
|
|
|
|
-\fBUsing MS-Windows file associations\fR: A useful trick under modern
|
|
|
|
-versions of MS-Windows (e.g., WinXP) is to use just the command
|
|
|
|
+\fBUsing MS\-Windows file associations\fR: A useful trick under modern
|
|
|
|
+versions of MS\-Windows (e.g., WinXP) is to use just the command
|
|
|
|
'start' by itself:
|
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
$dvi_previewer = 'start';
|
|
|
|
-.PP
|
|
|
|
-Under recent versions of MS-Windows, this will cause to be run
|
|
|
|
+.PP
|
|
|
|
+Under recent versions of MS\-Windows, this will cause to be run
|
|
|
|
whatever program the system has associated with dvi files. (The same
|
|
|
|
applies for a postscript viewer and a pdf viewer.)
|
|
|
|
|
|
|
|
\fBNot using a certain command\fR: If a command is not to be run, the
|
|
|
|
command name NONE is used, as in
|
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
$lpr = 'NONE lpr';
|
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
This means that an appropriate command has not been configured. The
|
|
|
|
string after the 'NONE' is effectively a comment.
|
2007-09-01 04:18:15 +00:00
|
|
|
|
|
|
|
@@ -512,9 +513,9 @@
|
2007-03-30 15:34:53 +00:00
|
|
|
Suppose you want \fIlatexmk\fR to use latex with source specials
|
|
|
|
enabled. Then you might use the following line in an initialization
|
|
|
|
file:
|
|
|
|
-.PP
|
|
|
|
- $latex = 'latex --src-specials';
|
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
+ $latex = 'latex \-\-src\-specials';
|
|
|
|
+.PP
|
|
|
|
|
|
|
|
\fBAdvanced tricks\fR: Normally \fIlatexmk\fR assumes certain behavior
|
|
|
|
for commands and in particular it assumes certain kinds and ordering
|
2007-09-01 04:18:15 +00:00
|
|
|
@@ -522,50 +523,50 @@
|
2007-03-30 15:34:53 +00:00
|
|
|
example you might want to use Distiller to convert postscript files to
|
|
|
|
pdf files. You cannot simply change the name of the ps2pdf conversion
|
|
|
|
program, as in
|
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
$ps2pdf = 'distiller'; ######### WRONG
|
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
because the command line arguments will be wrong. In such a
|
|
|
|
-situation, your best bet is to write a batch file (under MS-Windows) or
|
|
|
|
+situation, your best bet is to write a batch file (under MS\-Windows) or
|
|
|
|
a script (under UNIX) that will do the conversion. Then you set
|
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
$ps2pdf = 'special_script';
|
|
|
|
-.PP
|
|
|
|
+.PP
|
|
|
|
Your script will be invoked by \fIlatexmk\fR in its usual way as
|
|
|
|
"Special_script file.ps file.pdf". Your script calls Distiller with
|
|
|
|
Distiller's correct arguments.
|
|
|
|
|
|
|
|
-.SH LIST OF RC VARIABLES IN INITIALIZATION FILES
|
|
|
|
-.PP
|
|
|
|
+.SH "LIST OF RC VARIABLES IN INITIALIZATION FILES"
|
|
|
|
+.PP
|
|
|
|
Default values are indicated in brackets.
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $banner [0]
|
|
|
|
If nonzero, the banner message is printed across each page when converting
|
|
|
|
the dvi file to postscript. Without modifying $banner_message, this is
|
|
|
|
-equivalent to specifying the \fB-d\fR option.
|
|
|
|
+equivalent to specifying the \fB\-d\fR option.
|
|
|
|
|
|
|
|
Note that if \fB$banner\fR is nonzero, the \fB$postscript_mode\fR is
|
|
|
|
assumed and the postscript file is always generated, even if it is newer
|
|
|
|
than the dvi file.
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $banner_intensity [0.95]
|
|
|
|
-Equivalent to the \fB-bi\fR option, this is a decimal number between 0
|
|
|
|
+Equivalent to the \fB\-bi\fR option, this is a decimal number between 0
|
|
|
|
and 1 that specifies how dark to print the banner message. 0 is black,
|
|
|
|
1 is white. The default is just right if your toner cartridge isn't
|
|
|
|
running too low.
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $banner_message ["DRAFT"]
|
|
|
|
The banner message to print across each page when converting the dvi
|
|
|
|
-file to postscript. This is equivalent to the \fB-bm\fR option.
|
|
|
|
-.TP
|
|
|
|
+file to postscript. This is equivalent to the \fB\-bm\fR option.
|
|
|
|
+.TP
|
|
|
|
.B $banner_scale [220.0]
|
|
|
|
A decimal number that specifies how large the banner message will be
|
|
|
|
printed. Experimentation is necessary to get the right scale for your
|
|
|
|
message, as a rule of thumb the scale should be about equal to 1100
|
|
|
|
divided by the number of characters in the message. The Default is
|
|
|
|
just right for 5 character messages. This is equivalent to the
|
|
|
|
-\fB-bs\fR option.
|
|
|
|
-.TP
|
|
|
|
+\fB\-bs\fR option.
|
|
|
|
+.TP
|
|
|
|
.B @BIBINPUTS
|
|
|
|
This is an array variable that specifies directories where
|
|
|
|
\fIlatexmk\fR should look for .bib files. By default it is set from
|
2007-09-01 04:18:15 +00:00
|
|
|
@@ -588,13 +589,13 @@
|
2007-03-30 15:34:53 +00:00
|
|
|
|
|
|
|
This variable is likely to become obsolete in a future version of
|
|
|
|
\fIlatexmk\fR which uses a better method of searching for files.
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $bibtex ["bibtex"]
|
|
|
|
The BibTeX processing program.
|
|
|
|
-.TP
|
|
|
|
-.B $bibtex_silent_switch ["-terse"]
|
|
|
|
+.TP
|
|
|
|
+.B $bibtex_silent_switch ["\-terse"]
|
|
|
|
\fBSwitch(es)\fR for the BibTeX processing program when silent mode is on.
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $cleanup_mode [0]
|
2007-09-01 04:18:15 +00:00
|
|
|
If nonzero, specifies cleanup mode: 1 for full cleanup, 2 for cleanup
|
2007-03-30 15:34:53 +00:00
|
|
|
except for dvi, ps and pdf files, 3 for cleanup except for dep and aux
|
2007-09-01 04:18:15 +00:00
|
|
|
@@ -602,21 +603,21 @@
|
|
|
|
$clean_full_ext and @generated_exts variables.)
|
2007-03-30 15:34:53 +00:00
|
|
|
|
|
|
|
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, \fB\-c1\fR, or \fB\-C\fR options. But there should be no need
|
|
|
|
to set this variable from an RC file.
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $clean_ext [""]
|
|
|
|
Extra extensions of files for \fIlatexmk\fR to remove when any of the
|
2007-09-01 04:18:15 +00:00
|
|
|
-clean-up options (\fB-c\fR, \fB-c1\fR, or \fB-C\fR) is selected.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
2007-09-01 04:18:15 +00:00
|
|
|
+clean\-up options (\fB\-c\fR, \fB\-c1\fR, or \fB\-C\fR) is selected.
|
2007-03-30 15:34:53 +00:00
|
|
|
+.TP
|
|
|
|
.B $clean_full_ext [""]
|
|
|
|
-Extra extensions of files for \fIlatexmk\fR to remove when the \fB-C\fR
|
|
|
|
+Extra extensions of files for \fIlatexmk\fR to remove when the \fB\-C\fR
|
|
|
|
option is selected, i.e., extensions of files to remove when the .dvi,
|
|
|
|
-etc files are to be cleaned-up.
|
|
|
|
-.TP
|
|
|
|
+etc files are to be cleaned\-up.
|
|
|
|
+.TP
|
|
|
|
.B @cus_dep_list [()]
|
|
|
|
-Custom dependency list -- see section on "Custom Dependencies".
|
|
|
|
-.TP
|
|
|
|
+Custom dependency list \-\- see section on "Custom Dependencies".
|
|
|
|
+.TP
|
|
|
|
.B @default_files [('*.tex')]
|
|
|
|
Default list of files to be processed.
|
|
|
|
|
2007-09-01 04:18:15 +00:00
|
|
|
@@ -643,30 +644,30 @@
|
|
|
|
is '.tex'. Wild cards are allowed. The parentheses are because
|
|
|
|
\fI@default_files\fR is an array variable, i.e., a sequence of
|
|
|
|
filename specifications is possible.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $dvi_filter [empty]
|
|
|
|
The dvi file filter to be run on the newly produced dvi file before
|
|
|
|
-other processing. Equivalent to specifying the \fB-dF\fR option.
|
|
|
|
-.TP
|
|
|
|
+other processing. Equivalent to specifying the \fB\-dF\fR option.
|
|
|
|
+.TP
|
|
|
|
.B $dvi_previewer ["start xdvi" under UNIX]
|
|
|
|
-The command to invoke a dvi-previewer.
|
|
|
|
-[Default is "start" under MS-WINDOWS; under more recent versions of
|
|
|
|
+The command to invoke a dvi\-previewer.
|
|
|
|
+[Default is "start" under MS\-WINDOWS; under more recent versions of
|
|
|
|
Windows, this will cause to be run whatever command the system has
|
|
|
|
associated with .dvi files.]
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $dvi_previewer_landscape ["start xdvi"]
|
|
|
|
-The command to invoke a dvi-previewer in landscape mode.
|
|
|
|
-[Default is "start" under MS-WINDOWS; under more recent versions of
|
|
|
|
+The command to invoke a dvi\-previewer in landscape mode.
|
|
|
|
+[Default is "start" under MS\-WINDOWS; under more recent versions of
|
|
|
|
Windows, this will cause to be run whatever command the system has
|
|
|
|
associated with .dvi files.]
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $dvipdf ["dvipdf"]
|
|
|
|
Command to convert dvi to pdf file.
|
|
|
|
|
|
|
|
WARNING1: The default dvipdf
|
|
|
|
script generates pdf files with bitmapped fonts, which don't look
|
|
|
|
good when viewed by acroread. The script should be modified to give
|
|
|
|
-dvips the options "-P pdf" to ensure that type 1 fonts are used in the
|
|
|
|
+dvips the options "\-P pdf" to ensure that type 1 fonts are used in the
|
|
|
|
pdf file.
|
|
|
|
|
|
|
|
WARNING 2: If you want to use one of the programs dvipdfm or dvipdfmx
|
2007-09-01 04:18:15 +00:00
|
|
|
@@ -676,29 +677,29 @@
|
2007-03-30 15:34:53 +00:00
|
|
|
the command line. See the extra_scripts directory of the latexmk
|
|
|
|
distribution, where the necessary scripts dvipdfm_call, etc are to be
|
|
|
|
found, together with instructions for their use in the file README1.
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $dvips ["dvips"]
|
|
|
|
The program to used as a filter to convert a .dvi file to a .ps file.
|
|
|
|
If pdf is going to be generated from pdf, then the value of the
|
2007-09-01 04:18:15 +00:00
|
|
|
-$dvips_pdf_switch -- see below -- will be appended.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
|
|
|
-.B $dvips_landscape ["dvips -tlandscape"]
|
2007-09-01 04:18:15 +00:00
|
|
|
+$dvips_pdf_switch \-\- see below \-\- will be appended.
|
2007-03-30 15:34:53 +00:00
|
|
|
+.TP
|
|
|
|
+.B $dvips_landscape ["dvips \-tlandscape"]
|
|
|
|
The program to used as a filter to convert a .dvi file to a .ps file
|
|
|
|
in landscape mode.
|
|
|
|
-.TP
|
|
|
|
-.B $dvips_pdf_switch ["-P pdf"]
|
|
|
|
+.TP
|
|
|
|
+.B $dvips_pdf_switch ["\-P pdf"]
|
2007-09-01 04:18:15 +00:00
|
|
|
Switch(es) for dvips program when pdf file is to be generated from
|
2007-03-30 15:34:53 +00:00
|
|
|
ps file.
|
|
|
|
-.TP
|
|
|
|
-.B $dvips_silent_switch ["-q"]
|
|
|
|
+.TP
|
|
|
|
+.B $dvips_silent_switch ["\-q"]
|
2007-09-01 04:18:15 +00:00
|
|
|
Switch(es) for dvips program when silent mode is on.
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $dvi_update_command [""]
|
|
|
|
When the dvi previewer is set to be updated by running a command, this
|
|
|
|
is the command that is run. See the information for the variable
|
|
|
|
\fI$dvi_update_method\fR.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
|
|
|
-.B $dvi_update_method [2 under UNIX, 1 under MS-Windows]
|
|
|
|
+.TP
|
|
|
|
+.B $dvi_update_method [2 under UNIX, 1 under MS\-Windows]
|
|
|
|
How the dvi viewer updates its display when the dvi file has changed.
|
|
|
|
0 => update is automatic,
|
|
|
|
1=> manual update by user, which may only mean a mouse click on the
|
2007-09-01 04:18:15 +00:00
|
|
|
@@ -706,26 +707,26 @@
|
2007-03-30 15:34:53 +00:00
|
|
|
2 => Send the signal, whose number is in the variable
|
|
|
|
$dvi_update_signal. The default value under UNIX is suitable for xdvi.
|
|
|
|
3 => Viewer cannot do an update, because it locks the file. (As with
|
|
|
|
-acroread under MS-Windows.)
|
2007-09-01 04:18:15 +00:00
|
|
|
+acroread under MS\-Windows.)
|
|
|
|
4 => run a command to do the update. The command is specified by
|
|
|
|
the variable $dvi_update_command.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
|
|
|
-.B $dvi_update_signal [Under UNIX: SIGUSR1, which is a system-dependent value]
|
|
|
|
+.TP
|
|
|
|
+.B $dvi_update_signal [Under UNIX: SIGUSR1, which is a system\-dependent value]
|
|
|
|
The number of the signal that is sent to the dvi viewer when it is
|
|
|
|
-updated by sending a signal -- see $dvi_update_method. The default
|
|
|
|
+updated by sending a signal \-\- see $dvi_update_method. The default
|
|
|
|
value is the one appropriate for xdvi on a UNIX system.
|
|
|
|
-.TP
|
|
|
|
+.TP
|
2007-09-01 04:18:15 +00:00
|
|
|
.B $fdb_ext ["fdb_latex"]
|
|
|
|
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.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $force_mode [0]
|
|
|
|
If nonzero, continue processing past minor \fIlatex\fR errors
|
|
|
|
including unrecognized cross references. Equivalent to specifying the
|
|
|
|
-\fB-f\fR option.
|
2007-09-01 04:18:15 +00:00
|
|
|
-Note that specifying the \fB-pvc\fR sets $force_mode to 1.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
|
|
|
+\fB\-f\fR option.
|
2007-09-01 04:18:15 +00:00
|
|
|
+Note that specifying the \fB\-pvc\fR sets $force_mode to 1.
|
2007-03-30 15:34:53 +00:00
|
|
|
+.TP
|
2007-09-01 04:18:15 +00:00
|
|
|
.B @generated_exts [( 'ind', 'lof', 'lot', 'out', 'toc', $fdb_ext)]
|
2007-03-30 15:34:53 +00:00
|
|
|
This contains a list of extensions for files that are generated
|
|
|
|
(directly or indirectly) during a LaTeX run and that are read in by
|
2007-09-01 04:18:15 +00:00
|
|
|
@@ -750,38 +751,38 @@
|
2007-03-30 15:34:53 +00:00
|
|
|
|
|
|
|
adds the extension 'end' to the list of predefined generated
|
|
|
|
extensions.
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $go_mode [0]
|
|
|
|
If nonzero, process files regardless of timestamps. Equivalent to the
|
|
|
|
-\fB-g\fR option.
|
|
|
|
-.TP
|
|
|
|
+\fB\-g\fR option.
|
|
|
|
+.TP
|
|
|
|
.B $index_mode [0 and then as determined from the results of a run]
|
|
|
|
If nonzero, run \fImakeindex\fR to produce index of document.
|
|
|
|
Normally you should not need to set this variable in an RC file, since
|
|
|
|
latexmk determines automatically if \fImakeindex\fR needs to be run.
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $landscape_mode [0]
|
|
|
|
If nonzero, run in landscape mode, using the landscape mode previewers and
|
|
|
|
-dvi to postscript converters. Equivalent to the \fB-l\fR option.
|
|
|
|
+dvi to postscript converters. Equivalent to the \fB\-l\fR option.
|
2007-09-01 04:18:15 +00:00
|
|
|
Normally not needed with current previewers.
|
|
|
|
-.TP
|
2007-03-30 15:34:53 +00:00
|
|
|
+.TP
|
|
|
|
.B $latex ["latex"]
|
|
|
|
The LaTeX processing program. Note that as with other programs, you
|
|
|
|
can use this variable not just to change the name of the program used,
|
|
|
|
but also specify options to the program. E.g.,
|
|
|
|
|
|
|
|
- $latex = 'latex --src-specials';
|
|
|
|
-.TP
|
|
|
|
-.B $latex_silent_switch ["-interaction=batchmode"]
|
|
|
|
+ $latex = 'latex \-\-src\-specials';
|
|
|
|
+.TP
|
|
|
|
+.B $latex_silent_switch ["\-interaction=batchmode"]
|
|
|
|
\fBSwitch(es)\fR for the LaTeX processing program when silent mode is on.
|
|
|
|
-Under MS-Windows, the default value is changed to
|
|
|
|
-"-interaction=batchmode -c-style-errors", as used by MikTeX and fpTeX.
|
|
|
|
-.TP
|
|
|
|
+Under MS\-Windows, the default value is changed to
|
|
|
|
+"\-interaction=batchmode \-c\-style\-errors", as used by MikTeX and fpTeX.
|
|
|
|
+.TP
|
|
|
|
.B $lpr ["lpr"]
|
|
|
|
-[Default is "NONE lpr" under MS-WINDOWS.]
|
|
|
|
+[Default is "NONE lpr" under MS\-WINDOWS.]
|
2007-09-01 04:18:15 +00:00
|
|
|
The command to print postscript files.
|
2007-03-30 15:34:53 +00:00
|
|
|
|
|
|
|
-Under MS-Windows (unlike UNIX/LINUX), there is no standard program for
|
|
|
|
+Under MS\-Windows (unlike UNIX/LINUX), there is no standard program for
|
|
|
|
printing files. But there are ways you can do it. For example, if
|
2007-09-01 04:18:15 +00:00
|
|
|
you have gsview installed, you could use it with the option '/p':
|
2007-03-30 15:34:53 +00:00
|
|
|
|
2007-09-01 04:18:15 +00:00
|
|
|
@@ -795,14 +796,14 @@
|
|
|
|
the command obeyed; this is necessary because one part of the command
|
|
|
|
name ('Program Files') contains a space which would otherwise be
|
|
|
|
misinterpreted.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $lpr_dvi ["NONE lpr_dvi"]
|
|
|
|
The printing program to print dvi files.
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $lpr_pdf ["NONE lpr_pdf"]
|
|
|
|
The printing program to print pdf files.
|
|
|
|
|
|
|
|
-Under MS-Windows you could set this to use gsview, if it is installed,
|
|
|
|
+Under MS\-Windows you could set this to use gsview, if it is installed,
|
|
|
|
e.g.,
|
|
|
|
|
|
|
|
$lpr = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p';
|
2007-09-01 04:18:15 +00:00
|
|
|
@@ -812,18 +813,18 @@
|
2007-03-30 15:34:53 +00:00
|
|
|
is necessary because one part of the command name ('Program Files')
|
|
|
|
contains a space which would otherwise be misinterpreted.
|
|
|
|
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $makeindex ["makeindex"]
|
|
|
|
The index processing program.
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $new_viewer_always [0]
|
|
|
|
This variable applies to \fIlatexmk\fR \fBonly\fR in
|
|
|
|
-continuous-preview mode. If $new_viewer_always is 0,
|
|
|
|
+continuous\-preview mode. If $new_viewer_always is 0,
|
|
|
|
\fIlatexmk\fR will check for a previously running previewer on the
|
|
|
|
same file, and if one is running will not start a new one. If
|
|
|
|
-$new_viewer_always is non-zero, this check will be skipped, and
|
|
|
|
+$new_viewer_always is non\-zero, this check will be skipped, and
|
|
|
|
\fIlatexmk\fR will behave as if no viewer is running.
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $pdf_mode [0]
|
|
|
|
If zero, do NOT generate a pdf version of the document.
|
|
|
|
If equal to 1, generate a pdf version of the document using pdflatex.
|
2007-09-01 04:18:15 +00:00
|
|
|
@@ -831,153 +832,153 @@
|
2007-03-30 15:34:53 +00:00
|
|
|
file, by using the command specified by the $ps2pdf variable.
|
|
|
|
If equal to 3, generate a pdf version of the document from the dvi
|
|
|
|
file, by using the command specified by the $dvipdf variable.
|
|
|
|
-Equivalent to the \fB-pdf-\fR, \fB-pdf\fR, \fB-pdfdvi\fR,
|
2007-09-01 04:18:15 +00:00
|
|
|
-\fB-pdfps\fR options.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
2007-09-01 04:18:15 +00:00
|
|
|
+Equivalent to the \fB\-pdf\-\fR, \fB\-pdf\fR, \fB\-pdfdvi\fR,
|
|
|
|
+\fB\-pdfps\fR options.
|
2007-03-30 15:34:53 +00:00
|
|
|
+.TP
|
|
|
|
.B $pdflatex ["pdflatex"]
|
|
|
|
The LaTeX processing program in the version that makes a pdf file instead
|
|
|
|
of a dvi file.
|
|
|
|
-.TP
|
|
|
|
-.B $pdflatex_silent_switch ["-interaction=batchmode"]
|
|
|
|
+.TP
|
|
|
|
+.B $pdflatex_silent_switch ["\-interaction=batchmode"]
|
2007-09-01 04:18:15 +00:00
|
|
|
Switch(es) for the LaTeX processing program when silent mode is on.
|
2007-03-30 15:34:53 +00:00
|
|
|
-Under MS-Windows, the default value is changed to
|
|
|
|
-"-interaction=batchmode -c-style-errors", as used by MikTeX and fpTeX.
|
|
|
|
-.TP
|
|
|
|
+Under MS\-Windows, the default value is changed to
|
|
|
|
+"\-interaction=batchmode \-c\-style\-errors", as used by MikTeX and fpTeX.
|
|
|
|
+.TP
|
|
|
|
.B $pdf_previewer ["start acroread"]
|
|
|
|
-The command to invoke a pdf-previewer.
|
|
|
|
-[Default is changed to "start" on MS-WINDOWS; under more recent versions of
|
|
|
|
+The command to invoke a pdf\-previewer.
|
|
|
|
+[Default is changed to "start" on MS\-WINDOWS; under more recent versions of
|
|
|
|
Windows, this will cause to be run whatever command the system has
|
|
|
|
associated with .pdf files.]
|
|
|
|
|
|
|
|
-Potential problem under MS-Windows:
|
|
|
|
+Potential problem under MS\-Windows:
|
|
|
|
if acroread is used as the pdf previewer, and it is
|
|
|
|
actually viewing a pdf file, the pdf file cannot be updated. Thus
|
|
|
|
makes acroread a bad choice of previewer if you use \fIlatexmk\fR's
|
|
|
|
-previous-continuous mode (option \fB-pvc\fR) under MS-windows.
|
|
|
|
+previous\-continuous mode (option \fB\-pvc\fR) under MS\-windows.
|
|
|
|
This problem does not occur if ghostview, gv or gsview is used to
|
|
|
|
view pdf files.
|
|
|
|
-.TP
|
2007-09-01 04:18:15 +00:00
|
|
|
+.TP
|
|
|
|
.B $pdf_update_command [""]
|
|
|
|
When the pdf previewer is set to be updated by running a command, this
|
|
|
|
is the command that is run. See the information for the variable
|
|
|
|
\fI$pdf_update_method\fR.
|
|
|
|
-.TP
|
2007-03-30 15:34:53 +00:00
|
|
|
-.B $pdf_update_method [1 under UNIX, 3 under MS-Windows]
|
|
|
|
+.TP
|
|
|
|
+.B $pdf_update_method [1 under UNIX, 3 under MS\-Windows]
|
|
|
|
How the pdf viewer updates its display when the pdf file has
|
2007-09-01 04:18:15 +00:00
|
|
|
changed. See $dvi_update_method for the codes, with the change that
|
|
|
|
for the value 4, to run a command to do the update, the command is
|
|
|
|
specified by the variable $pdf_update_command.
|
|
|
|
|
2007-03-30 15:34:53 +00:00
|
|
|
-Note that acroread under MS-Windows (but not UNIX) locks the pdf file, so
|
|
|
|
+Note that acroread under MS\-Windows (but not UNIX) locks the pdf file, so
|
|
|
|
the default value is then 3.
|
|
|
|
-.TP
|
|
|
|
-.B $pdf_update_signal [Under UNIX: SIGHUP, which is a system-dependent value]
|
|
|
|
+.TP
|
|
|
|
+.B $pdf_update_signal [Under UNIX: SIGHUP, which is a system\-dependent value]
|
|
|
|
The number of the signal that is sent to the pdf viewer when it is
|
|
|
|
-updated by sending a signal -- see $pdf_update_method. The default
|
|
|
|
+updated by sending a signal \-\- see $pdf_update_method. The default
|
|
|
|
value is the one appropriate for gv on a UNIX system.
|
|
|
|
-.TP
|
|
|
|
-.B $pid_position = [1 under UNIX, -1 under MS-Windows]
|
|
|
|
+.TP
|
|
|
|
+.B $pid_position = [1 under UNIX, \-1 under MS\-Windows]
|
|
|
|
Command used to get all the processes currently run by the user.
|
|
|
|
-The -pvc option uses the command specified by the variable $pscmd to
|
|
|
|
+The \-pvc option uses the command specified by the variable $pscmd to
|
|
|
|
determine if there is an already running previewer, and to find the
|
|
|
|
process ID (needed if \fIlatexmk\fR needs to signal the previewer about
|
|
|
|
file changes). The variable $pid_position is used to specify which word
|
|
|
|
in lines of the output from $pscmd corresponds to the process ID. The
|
|
|
|
first word in the line is numbered 0. The default value of 1 (2nd word in
|
|
|
|
-line) is correct for Solaris 2.6 and Linux. Setting the variable to -1 is
|
|
|
|
+line) is correct for Solaris 2.6 and Linux. Setting the variable to \-1 is
|
|
|
|
used to indicate that $pscmd is not to be used.
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $postscript_mode [0]
|
|
|
|
If nonzero, generate a postscript version of the document.
|
|
|
|
-Equivalent to the \fB-ps\fR option.
|
|
|
|
-.TP
|
|
|
|
+Equivalent to the \fB\-ps\fR option.
|
|
|
|
+.TP
|
|
|
|
.B $preview_continuous_mode [0]
|
|
|
|
If nonzero, run a previewer to view the document, and
|
|
|
|
-continue running \fIlatexmk\fR to keep .dvi up-to-date. Equivalent to
|
|
|
|
-the \fB-pvc\fR option.
|
|
|
|
+continue running \fIlatexmk\fR to keep .dvi up\-to\-date. Equivalent to
|
|
|
|
+the \fB\-pvc\fR option.
|
|
|
|
Which previewer is run depends on the other settings, see the command
|
2007-09-01 04:18:15 +00:00
|
|
|
-line options \fB-view=\fR, and the variable \fI$view\fR.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
2007-09-01 04:18:15 +00:00
|
|
|
+line options \fB\-view=\fR, and the variable \fI$view\fR.
|
2007-03-30 15:34:53 +00:00
|
|
|
+.TP
|
|
|
|
.B $preview_mode [0]
|
|
|
|
If nonzero, run a previewer to preview the document.
|
|
|
|
-Equivalent to the \fB-pv\fR option.
|
|
|
|
+Equivalent to the \fB\-pv\fR option.
|
|
|
|
Which previewer is run depends on the other settings, see the command
|
2007-09-01 04:18:15 +00:00
|
|
|
-line options \fB-view=\fR, and the variable \fI$view\fR.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
2007-09-01 04:18:15 +00:00
|
|
|
+line options \fB\-view=\fR, and the variable \fI$view\fR.
|
2007-03-30 15:34:53 +00:00
|
|
|
+.TP
|
|
|
|
.B $printout_mode [0]
|
|
|
|
If nonzero, print the document using \fIlpr\fR. Equivalent to the
|
2007-09-01 04:18:15 +00:00
|
|
|
-\fB-p\fR option. This is recommended \fBnot\fR to be set from an RC
|
|
|
|
+\fB\-p\fR option. This is recommended \fBnot\fR to be set from an RC
|
|
|
|
file, otherwise you could waste lots of paper.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $print_type = ["ps"]
|
|
|
|
Type of file to printout: possibilities are "dvi", "none", "pdf", or
|
|
|
|
"ps".
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $pscmd
|
|
|
|
-[On UNIX, the default is "ps -f -u $ENV{USER}", with changes for Linux
|
|
|
|
-and OS-X.
|
|
|
|
-On MS-WINDOWS the default in "NONE pscmd".]
|
|
|
|
+[On UNIX, the default is "ps \-f \-u $ENV{USER}", with changes for Linux
|
|
|
|
+and OS\-X.
|
|
|
|
+On MS\-WINDOWS the default in "NONE pscmd".]
|
|
|
|
Command used to get all the processes currently run by the user. This
|
|
|
|
-is used by the -pvc option to determine if there is an already running
|
|
|
|
+is used by the \-pvc option to determine if there is an already running
|
|
|
|
previewer.
|
|
|
|
The command line options for this command under the different flavors of
|
|
|
|
UNIX are quite variable. The command given above is suitable for Solaris
|
2007-09-01 04:18:15 +00:00
|
|
|
2.6 and above, and \fIlatexmk\fR corrects it for Linux and OSX.
|
2007-03-30 15:34:53 +00:00
|
|
|
|
2007-09-01 04:18:15 +00:00
|
|
|
NOTE: The variable \fI$pid_position\fR must also be set; see its description.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $ps2pdf ["ps2pdf"]
|
|
|
|
Command to convert ps to pdf file.
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $ps_filter [empty]
|
|
|
|
The postscript file filter to be run on the newly produced postscript
|
|
|
|
-file before other processing. Equivalent to specifying the \fB-pF\fR
|
|
|
|
+file before other processing. Equivalent to specifying the \fB\-pF\fR
|
|
|
|
option.
|
|
|
|
-.TP
|
|
|
|
-.B $ps_previewer ["start gv -watch"]
|
|
|
|
-The command to invoke a ps-previewer.
|
|
|
|
-[Default is "start" on MS-WINDOWS; under more recent versions of
|
|
|
|
+.TP
|
|
|
|
+.B $ps_previewer ["start gv \-watch"]
|
|
|
|
+The command to invoke a ps\-previewer.
|
|
|
|
+[Default is "start" on MS\-WINDOWS; under more recent versions of
|
|
|
|
Windows, this will cause to be run whatever command the system has
|
|
|
|
associated with .ps files.]
|
|
|
|
|
|
|
|
-Note that gv with the -watch option updates its display whenever the
|
|
|
|
+Note that gv with the \-watch option updates its display whenever the
|
|
|
|
postscript file changes, whereas ghostview does not.
|
|
|
|
-.TP
|
|
|
|
-.B $ps_previewer_landscape ["start gv -swap -watch"]
|
|
|
|
-The command to invoke a ps-previewer in landscape mode.
|
|
|
|
-[Default is "start" on MS-WINDOWS; under more recent versions of
|
|
|
|
+.TP
|
|
|
|
+.B $ps_previewer_landscape ["start gv \-swap \-watch"]
|
|
|
|
+The command to invoke a ps\-previewer in landscape mode.
|
|
|
|
+[Default is "start" on MS\-WINDOWS; under more recent versions of
|
|
|
|
Windows, this will cause to be run whatever command the system has
|
|
|
|
associated with .ps files.]
|
|
|
|
-.TP
|
2007-09-01 04:18:15 +00:00
|
|
|
+.TP
|
|
|
|
.B $ps_update_command [""]
|
|
|
|
When the postscript previewer is set to be updated by running a command, this
|
|
|
|
is the command that is run. See the information for the variable
|
|
|
|
\fI$ps_update_method\fR.
|
|
|
|
-.TP
|
2007-03-30 15:34:53 +00:00
|
|
|
-.B $ps_update_method [0 under UNIX, 1 under MS-Windows]
|
|
|
|
+.TP
|
|
|
|
+.B $ps_update_method [0 under UNIX, 1 under MS\-Windows]
|
|
|
|
How the postscript viewer updates its display when the ps file has
|
2007-09-01 04:18:15 +00:00
|
|
|
changed. See $dvi_update_method for the codes, with the change that
|
|
|
|
for the value 4, to run a command to do the update, the command is
|
|
|
|
specified by the variable $ps_update_command.
|
2007-03-30 15:34:53 +00:00
|
|
|
-.TP
|
|
|
|
-.B $ps_update_signal [Under UNIX: SIGHUP, which is a system-dependent value]
|
|
|
|
+.TP
|
|
|
|
+.B $ps_update_signal [Under UNIX: SIGHUP, which is a system\-dependent value]
|
|
|
|
The number of the signal that is sent to the pdf viewer when it is
|
|
|
|
-updated by sending a signal -- see $ps_update_method. The default
|
|
|
|
+updated by sending a signal \-\- see $ps_update_method. The default
|
|
|
|
value is the one appropriate for gv on a UNIX system.
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $sleep_time [2]
|
|
|
|
The time to sleep (in seconds) between checking for source file
|
|
|
|
-changes when running the \fB-pvc\fR option.
|
|
|
|
-.TP
|
|
|
|
+changes when running the \fB\-pvc\fR option.
|
|
|
|
+.TP
|
|
|
|
.B $texfile_search [""]
|
|
|
|
This is an obsolete variable, replaced by the \fI@default_files\fR
|
2007-09-01 04:18:15 +00:00
|
|
|
variable.
|
2007-03-30 15:34:53 +00:00
|
|
|
|
2007-09-01 04:18:15 +00:00
|
|
|
For backward compatibility, if you choose to set
|
|
|
|
-\fI$texfile_search\fR, it is a string of space-separated filenames, and
|
|
|
|
+\fI$texfile_search\fR, it is a string of space\-separated filenames, and
|
2007-03-30 15:34:53 +00:00
|
|
|
then \fIlatexmk\fR replaces \fI@default_files\fR with the filenames in
|
|
|
|
\fI$texfile_search\fR to which is added '*.tex'.
|
|
|
|
-.TP
|
2007-09-01 04:18:15 +00:00
|
|
|
+.TP
|
|
|
|
.B $tmpdir [See below for default]
|
|
|
|
Directory to store temporary files that \fIlatexmk\fR may generate while
|
|
|
|
running.
|
|
|
|
@@ -986,62 +987,62 @@
|
|
|
|
\fI$tmpdir\fR to the value of the first of whichever of the system
|
|
|
|
environment variables TMPDIR or TEMP exists, otherwise to the current
|
|
|
|
directory. Under other operating systems (expected to be UNIX/Linux,
|
|
|
|
-including OS-X), the default is the value of the system environment
|
|
|
|
+including OS\-X), the default is the value of the system environment
|
|
|
|
variable TMPDIR if it exists, otherwise to "/tmp".
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B $view ["default"]
|
|
|
|
Which kind of file is to be previewed if a previewer is used. The
|
|
|
|
possible values are 'default', 'dvi', 'ps', 'pdf'. The value of
|
|
|
|
"default" means that the "highest" of the kinds of file generated is
|
|
|
|
to be used (among dvi, ps and pdf).
|
|
|
|
|
2007-03-30 15:34:53 +00:00
|
|
|
-.SH CUSTOM DEPENDENCIES
|
|
|
|
-.PP
|
|
|
|
+.SH "CUSTOM DEPENDENCIES"
|
|
|
|
+.PP
|
|
|
|
In any RC file a set of custom dependencies can be set up to convert a
|
|
|
|
file with one extension to a file with another. An example use of this
|
|
|
|
-would be to allow \fIlatexmk\fR to convert a \fI.fig\fR file to
|
|
|
|
+would be to allow \fIlatexmk\fR to convert a \fI.fi g\fR file to
|
|
|
|
\fI.eps\fR to be included in the \fI.tex\fR file. A table of custom
|
|
|
|
dependencies are set up by using the \fB@cus_dep_list\fR array. Each
|
|
|
|
string in the array has four arguments, separated by a space:
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B from extension:
|
|
|
|
The extension of the file we are converting from (e.g. "fig").
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B to extension:
|
|
|
|
The extension of the file we are converting to (e.g. "eps").
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B must:
|
|
|
|
-If non-zero, the file we are converting from \fBmust\fR exist, if it
|
|
|
|
+If non\-zero, the file we are converting from \fBmust\fR exist, if it
|
|
|
|
doesn't exist \fIlatexmk\fR will give an error message and exit unless
|
|
|
|
-the \fB-f\fR option is specified. If \fImust\fR is zero and the file
|
|
|
|
+the \fB\-f\fR option is specified. If \fImust\fR is zero and the file
|
|
|
|
we are converting from doesn't exist, then no action is taken.
|
|
|
|
-.TP
|
|
|
|
+.TP
|
|
|
|
.B function:
|
|
|
|
The name of the subroutine that \fIlatexmk\fR should call to perform the
|
|
|
|
file conversion. The first argument to the subroutine is the base name
|
|
|
|
of the file to be converted without any extension. The subroutines are
|
|
|
|
declared in the syntax of \fIperl\fR. The function should return 0 if
|
|
|
|
it was successful and a nonzero number if it failed.
|
|
|
|
-.PP
|
|
|
|
-Example in an RC file to convert a \fI.fig\fR file to a \fI.eps\fR file:
|
|
|
|
+.PP
|
|
|
|
+Example in an RC file to convert a \fI.fi g\fR file to a \fI.eps\fR file:
|
|
|
|
|
|
|
|
@cus_dep_list = (@cus_dep_list, "fig eps 0 fig2eps");
|
|
|
|
|
|
|
|
sub fig2eps
|
|
|
|
{
|
|
|
|
- system("fig2dev -Lps $_[0].fig $_[0].eps");
|
|
|
|
+ system("fig2dev \-Lps $_[0].fi g $_[0].eps");
|
|
|
|
}
|
|
|
|
|
|
|
|
-The subroutine \fIfig2eps\fR will only be called if the \fI.fig\fR file
|
|
|
|
+The subroutine \fIfig2eps\fR will only be called if the \fI.fi g\fR file
|
|
|
|
was modified more recently then the \fI.eps\fR file, or the \fI.eps\fR
|
|
|
|
file does not exist.
|
|
|
|
|
|
|
|
-If the return value of the subroutine is non-zero, then \fIlatexmk\fR
|
|
|
|
+If the return value of the subroutine is non\-zero, then \fIlatexmk\fR
|
|
|
|
will assume an error occurred during the execution of the subroutine.
|
|
|
|
|
|
|
|
-.SH SEE ALSO
|
|
|
|
+.SH "SEE ALSO"
|
|
|
|
latex(1), bibtex(1).
|
|
|
|
-.SH BUGS
|
|
|
|
+.SH "BUGS"
|
|
|
|
Search for .bib files is not correct if they are not in the current
|
|
|
|
directory; the problem is that the log file generated by bibtex does not
|
|
|
|
give the full path to the .bib files. The easiest fix at the moment is to
|
2007-09-01 04:18:15 +00:00
|
|
|
@@ -1062,29 +1063,29 @@
|
2007-03-30 15:34:53 +00:00
|
|
|
Gv on UNIX/LINUX works for both postscript and pdf.
|
|
|
|
Ghostview on UNIX/LINUX needs a manual update (reopen); it views
|
|
|
|
postscript and pdf.
|
|
|
|
-Gsview under MS-Windows works for both postscript and pdf,
|
|
|
|
+Gsview under MS\-Windows works for both postscript and pdf,
|
|
|
|
but only reads the updated file when its screen is refreshed.
|
|
|
|
Acroread under UNIX/LINUX views pdf, but the file needs to be closed
|
|
|
|
and reopened to view an updated version.
|
|
|
|
-Under MS-Windows, acroread locks its input file and so the
|
|
|
|
+Under MS\-Windows, acroread locks its input file and so the
|
|
|
|
pdf file cannot be updated. (Remedy: configure \fIlatexmk\fR use gsview
|
|
|
|
instead.)
|
|
|
|
-.SH THANKS TO
|
|
|
|
+.SH "THANKS TO"
|
2007-09-01 04:18:15 +00:00
|
|
|
Authors of previous versions. Many users with their feedback, and
|
|
|
|
especially
|
|
|
|
David Coppit (username david at node coppit.org) who made many useful
|
2007-03-30 15:34:53 +00:00
|
|
|
suggestions that contributed to version 3. (Please note that the
|
|
|
|
-e-mail addresses are not written in their standard form to avoid being
|
|
|
|
+e\-mail addresses are not written in their standard form to avoid being
|
|
|
|
harvested by worms and viruses.)
|
|
|
|
-.SH AUTHOR
|
|
|
|
+.SH "AUTHOR"
|
|
|
|
Current version, with substantial modifications, enhancements and bug
|
|
|
|
fixes by John Collins (username collins at node phys.psu.edu).
|
2007-09-01 04:18:15 +00:00
|
|
|
(Version 3.09).
|
2007-03-30 15:34:53 +00:00
|
|
|
|
|
|
|
It can be obtained from CTAN:
|
|
|
|
-<http://www.tug.org/tex-archive/support/latexmk/>, and from the
|
|
|
|
+<http://www.tug.org/tex\-archive/support/latexmk/>, and from the
|
|
|
|
author's website <http://www.phys.psu.edu/~collins/software/latexmk/>.
|
|
|
|
-.br
|
|
|
|
+.br
|
|
|
|
Modifications and enhancements by Evan McLean (Version 2.0)
|
|
|
|
-.br
|
|
|
|
+.br
|
|
|
|
Original script called "go" by David J. Musliner (RCS Version 3.2)
|
2007-09-01 04:18:15 +00:00
|
|
|
diff -dur latexmk-3.20.ORIG/latexmk.pl latexmk-3.20/latexmk.pl
|
|
|
|
--- latexmk-3.20.ORIG/latexmk.pl 2007-08-31 21:46:47.000000000 -0600
|
|
|
|
+++ latexmk-3.20/latexmk.pl 2007-08-31 21:45:50.000000000 -0600
|
|
|
|
@@ -584,10 +584,8 @@
|
2007-03-30 15:34:53 +00:00
|
|
|
## /usr/local/share, depending on the local conventions.
|
|
|
|
## /usr/local/lib/latexmk/LatexMk is put in the list for
|
|
|
|
## compatibility with older versions of latexmk.
|
|
|
|
- @rc_system_files =
|
|
|
|
- ( '/opt/local/share/latexmk/LatexMk',
|
|
|
|
- '/usr/local/share/latexmk/LatexMk',
|
|
|
|
- '/usr/local/lib/latexmk/LatexMk' );
|
2007-09-01 04:18:15 +00:00
|
|
|
+ ## Fedora change: only look in /etc
|
2007-03-30 15:34:53 +00:00
|
|
|
+ @rc_system_files = ( '/etc/latexmk.conf' );
|
|
|
|
|
|
|
|
$search_path_separator = ':'; # Separator of elements in search_path
|
|
|
|
|