summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/support
diff options
context:
space:
mode:
authorKarl Berry <karl@freefriends.org>2009-06-28 23:31:04 +0000
committerKarl Berry <karl@freefriends.org>2009-06-28 23:31:04 +0000
commitf791da06d3c46df5086e8e9f6a492326b488c650 (patch)
tree6d93d2a5fb57602e61af385fb73fe61d01c6430e /Master/texmf-dist/doc/support
parentc93dde9fc21037240a4375c9c7902123f41098be (diff)
latexmk update (24jun09)
git-svn-id: svn://tug.org/texlive/trunk@13986 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support')
-rw-r--r--Master/texmf-dist/doc/support/latexmk/README2
-rw-r--r--Master/texmf-dist/doc/support/latexmk/latexmk.125
-rw-r--r--Master/texmf-dist/doc/support/latexmk/latexmk.pdfbin73828 -> 160153 bytes
-rw-r--r--Master/texmf-dist/doc/support/latexmk/latexmk.txt186
4 files changed, 123 insertions, 90 deletions
diff --git a/Master/texmf-dist/doc/support/latexmk/README b/Master/texmf-dist/doc/support/latexmk/README
index 2f80b235e9a..33d5fc6e6a9 100644
--- a/Master/texmf-dist/doc/support/latexmk/README
+++ b/Master/texmf-dist/doc/support/latexmk/README
@@ -88,7 +88,7 @@ I hope you find this useful.
John Collins
---------------------------- "latexmk -h" ----------------------------
-Latexmk 4.07: Automatic LaTeX document generation routine
+Latexmk 4.08: Automatic LaTeX document generation routine
Usage: latexmk [latexmk_options] [filename ...]
diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.1 b/Master/texmf-dist/doc/support/latexmk/latexmk.1
index 7ed711e8397..e8499cefadd 100644
--- a/Master/texmf-dist/doc/support/latexmk/latexmk.1
+++ b/Master/texmf-dist/doc/support/latexmk/latexmk.1
@@ -213,16 +213,31 @@ and \fB-e\fR options can be used, and they are executed in the order
they appear on the command line.
Some care is needed to deal with proper quoting of special characters
-in the code on the command line. For example, suppose it is desired
+in the code on the command line. For example, suppose you want
to set the latex command to use its -shell-escape option, then under
UNIX/LINUX you could use the line
latexmk -e '$latex=q/latex %O -shell-escape %S/' file.tex
-(Note that the q/.../ construct is a \fIPerl\fR idiom equivalent to using
-single quotes. This is easier than arranging to get a quote character
-correctly escaped in a way that is independent of the shell and the
-operating-system.)
+Note that the single quotes block normal UNIX/LINUX command shells
+from treating the characters inside the quotes as special.
+(In this example, the q/.../ construct is a
+\fIPerl\fR idiom equivalent to using
+single quotes. This avoids the complications of getting a quote
+character inside an already quoted string in a way that is independent
+of both the shell and the operating-system.)
+
+The above command line will NOT work under MS-Windows with cmd.exe or
+command.com or 4nt.exe. For MS-Windows with these command shells you
+could use
+
+ latexmk -e "$latex=q/latex %O -shell-escape %S/" file.tex
+
+or
+
+ latexmk -e "$latex='latex %O -shell-escape %S'" file.tex
+
+The last two examples will NOT work with UNIX/LINUX command shells.
.TP
.B -f
Force \fIlatexmk\fR to continue document processing despite errors.
diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.pdf b/Master/texmf-dist/doc/support/latexmk/latexmk.pdf
index fa94b34f8ff..2e7340e1fa6 100644
--- a/Master/texmf-dist/doc/support/latexmk/latexmk.pdf
+++ b/Master/texmf-dist/doc/support/latexmk/latexmk.pdf
Binary files differ
diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.txt b/Master/texmf-dist/doc/support/latexmk/latexmk.txt
index 0d82b1a44da..14a1d72e135 100644
--- a/Master/texmf-dist/doc/support/latexmk/latexmk.txt
+++ b/Master/texmf-dist/doc/support/latexmk/latexmk.txt
@@ -240,24 +240,24 @@ LATEXMK(1L) LATEXMK(1L)
appear on the command line.
Some care is needed to deal with proper quoting of special char-
- acters in the code on the command line. For example, suppose it
- is desired to set the latex command to use its -shell-escape
+ acters in the code on the command line. For example, suppose
+ you want to set the latex command to use its -shell-escape
option, then under UNIX/LINUX you could use the line
latexmk -e '$latex=q/latex %O -shell-escape %S/' file.tex
- (Note that the q/.../ construct is a Perl idiom equivalent to
- using single quotes. This is easier than arranging to get a
- quote character correctly escaped in a way that is independent
- of the shell and the operating-system.)
+ Note that the single quotes block normal UNIX/LINUX command
+ shells from treating the characters inside the quotes as spe-
+ cial. (In this example, the q/.../ construct is a Perl idiom
+ equivalent to using single quotes. This avoids the complica-
+ tions of getting a quote character inside an already quoted
+ string in a way that is independent of both the shell and the
+ operating-system.)
- -f Force latexmk to continue document processing despite errors.
- Normally, when latexmk detects that LaTeX or another program has
- found an error which will not be resolved by further processing,
- no further processing is carried out.
+ The above command line will NOT work under MS-Windows with
+ cmd.exe or command.com or 4nt.exe. For MS-Windows with these
+ command shells you could use
- -f- Turn off the forced processing-past-errors such as is set by the
- -f option. This could be used to override a setting in a
@@ -270,7 +270,23 @@ LATEXMK(1L) LATEXMK(1L)
LATEXMK(1L) LATEXMK(1L)
- configuration file.
+ latexmk -e "$latex=q/latex %O -shell-escape %S/" file.tex
+
+ or
+
+ latexmk -e "$latex='latex %O -shell-escape %S'" file.tex
+
+ The last two examples will NOT work with UNIX/LINUX command
+ shells.
+
+ -f Force latexmk to continue document processing despite errors.
+ Normally, when latexmk detects that LaTeX or another program has
+ found an error which will not be resolved by further processing,
+ no further processing is carried out.
+
+ -f- Turn off the forced processing-past-errors such as is set by the
+ -f option. This could be used to override a setting in a con-
+ figuration file.
-g Force latexmk to process document fully, even under situations
where latexmk would normally decide that no changes in the
@@ -310,6 +326,18 @@ LATEXMK(1L) LATEXMK(1L)
-p Print out the document. By default it is the generated
postscript file that is printed. But you can use the -print=...
+
+
+
+ 27 May 2009 5
+
+
+
+
+
+LATEXMK(1L) LATEXMK(1L)
+
+
option to print the dvi or pdf files instead, and you can con-
figure this in a start up file (by setting the $print_type vari-
able).
@@ -325,18 +353,6 @@ LATEXMK(1L) LATEXMK(1L)
for printing.
This option is incompatible with the -pv and -pvc options, so it
-
-
-
- 27 May 2009 5
-
-
-
-
-
-LATEXMK(1L) LATEXMK(1L)
-
-
turns them off.
-pdf Generate pdf version of document using pdflatex.
@@ -378,6 +394,18 @@ LATEXMK(1L) LATEXMK(1L)
latexmk -ps -pF "psnup -2" foo.tex
+
+
+
+ 27 May 2009 6
+
+
+
+
+
+LATEXMK(1L) LATEXMK(1L)
+
+
Whether to use single or double quotes round the "psnup -2" will
depend on your command interpreter, as used by the particular
version of perl and the operating system on your computer.
@@ -392,18 +420,6 @@ LATEXMK(1L) LATEXMK(1L)
-pv- Turn off -pv.
-
-
-
- 27 May 2009 6
-
-
-
-
-
-LATEXMK(1L) LATEXMK(1L)
-
-
-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
@@ -448,18 +464,6 @@ LATEXMK(1L) LATEXMK(1L)
Read the specified initialization file ("RC file") before pro-
cessing.
- Be careful about the ordering: (1) Standard initialization files
- -- see the section below on "Configuration/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 -r option, it is read
- during this second step. Thus an initialization file specified
- with the -r option can override both the standard initialization
- files and previously specified options. But all of these can be
- overridden by later options.
-
- The contents of the RC file just comprise a piece of code in the
-
27 May 2009 7
@@ -471,6 +475,17 @@ LATEXMK(1L) LATEXMK(1L)
LATEXMK(1L) LATEXMK(1L)
+ Be careful about the ordering: (1) Standard initialization files
+ -- see the section below on "Configuration/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 -r option, it is read
+ during this second step. Thus an initialization file specified
+ with the -r option can override both the standard initialization
+ files and previously specified options. But all of these can be
+ overridden by later options.
+
+ The contents of the RC file just comprise a piece of code in the
Perl programming language (typically a sequence of assignment
statements); they are executed when the -r option is encountered
during latexmk's parsing of its command line. See the -e option
@@ -517,15 +532,6 @@ EXAMPLES
watch for changes in the source
file thesis.tex and any files it
uses. After any changes rerun latex
- the appropriate number of times and
- remake the postscript file. If latex
- encounters an error, latexmk will
- keep running, watching for
- source file changes.
-
- % latexmk -c # remove .aux, .log, .bbl, .blg, .dvi,
- .pdf, .ps & .bbl files
-
@@ -538,6 +544,17 @@ EXAMPLES
LATEXMK(1L) LATEXMK(1L)
+ the appropriate number of times and
+ remake the postscript file. If latex
+ encounters an error, latexmk will
+ keep running, watching for
+ source file changes.
+
+ % latexmk -c # remove .aux, .log, .bbl, .blg, .dvi,
+ .pdf, .ps & .bbl files
+
+
+
CONFIGURATION/INITIALIZATION (RC) FILES
Latexmk can be customized using initialization files, which are read at
startup in the following order:
@@ -584,26 +601,26 @@ HOW TO SET VARIABLES IN INITIALIZATION FILES
for the setting of a string variable,
- $preview_mode = 1;
- for the setting of a numeric variable, and
- @default_files = ('paper', 'paper1');
- for the setting of an array of strings. It is possible to append an
- item to an array variable as follows:
+ 27 May 2009 9
- 27 May 2009 9
+LATEXMK(1L) LATEXMK(1L)
+ $preview_mode = 1;
+ for the setting of a numeric variable, and
-LATEXMK(1L) LATEXMK(1L)
+ @default_files = ('paper', 'paper1');
+ for the setting of an array of strings. It is possible to append an
+ item to an array variable as follows:
push @default_files, 'paper2';
@@ -654,24 +671,24 @@ FORMAT OF COMMAND SPECIFICATIONS
%O options
- %R root filename. This is the base name for the main tex file.
- %S source file (e.g., the name of the dvi file when converting a
- dvi file to ps).
- %T The name of the primary tex file.
+ 27 May 2009 10
- 27 May 2009 10
+LATEXMK(1L) LATEXMK(1L)
+ %R root filename. This is the base name for the main tex file.
-LATEXMK(1L) LATEXMK(1L)
+ %S source file (e.g., the name of the dvi file when converting a
+ dvi file to ps).
+ %T The name of the primary tex file.
If for some reason you need a literal % character in your string not
subject to the above rules, use a pair of these characters. Thus with
@@ -724,11 +741,6 @@ LATEXMK(1L) LATEXMK(1L)
system.
Notes: (1) In some circumstances, latex will always run a command
- detached. This is the case for a previewer in preview continuous mode,
- since otherwise previewing continuously makes no sense. (2) This pre-
- cludes the possibility of running a command named start. (3) If the
- word start occurs more than once at the beginning of the command
- string, that is equivalent to having just one. (4) Under cygwin, some
@@ -741,6 +753,11 @@ LATEXMK(1L) LATEXMK(1L)
LATEXMK(1L) LATEXMK(1L)
+ detached. This is the case for a previewer in preview continuous mode,
+ since otherwise previewing continuously makes no sense. (2) This pre-
+ cludes the possibility of running a command named start. (3) If the
+ word start occurs more than once at the beginning of the command
+ string, that is equivalent to having just one. (4) Under cygwin, some
complications happen, since cygwin amounts to a complicated merging of
UNIX and MS-Windows. See the source code for how I've handled the
problem.
@@ -794,9 +811,6 @@ LATEXMK(1L) LATEXMK(1L)
%B';
This definition assumes you are using a UNIX-like system, so that the
- two commands to be run are separated by the semicolon in the middle of
- the string.
-
@@ -809,6 +823,11 @@ LATEXMK(1L) LATEXMK(1L)
LATEXMK(1L) LATEXMK(1L)
+ two commands to be run are separated by the semicolon in the middle of
+ the string.
+
+
+
LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES
Default values are indicated in brackets.
@@ -862,9 +881,6 @@ LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES
Perl's rules for writing strings.
Important note: This variable is now mostly obsolete in the current
- version of latexmk, since it has a better method of searching for files
- using the kpsewhich command. However, if your system is an unusual one
- without the kpsewhich command, you may need to set the variable
@@ -877,7 +893,10 @@ LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES
LATEXMK(1L) LATEXMK(1L)
- @BIBINPUTS.
+ version of latexmk, since it has a better method of searching for files
+ using the kpsewhich command. However, if your system is an unusual one
+ without the kpsewhich command, you may need to set the variable @BIBIN-
+ PUTS.
$bibtex ["bibtex %O %S"]
The BibTeX processing program.
@@ -935,7 +954,6 @@ LATEXMK(1L) LATEXMK(1L)
-
27 May 2009 14