diff options
| author | Dr. Clea F. Rees <cfrees@imapmail.org> | 2008-12-03 00:39:57 +0000 |
|---|---|---|
| committer | Dr. Clea F. Rees <cfrees@imapmail.org> | 2008-12-03 00:39:57 +0000 |
| commit | d41f00b32c62f7b61e10009b913bcdf4d3af65a7 (patch) | |
| tree | d08e49fcd824a6ae5326b59a449e571a35ba87d4 /Master/texmf-dist/doc | |
| parent | 345df745f9c4bb7fe8030e4605141267e59a8a03 (diff) | |
latexmk 4.01
git-svn-id: svn://tug.org/texlive/trunk@11505 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc')
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/README | 7 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/latexmk.1 | 18 | ||||
| -rwxr-xr-x | Master/texmf-dist/doc/support/latexmk/latexmk.bat | 10 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/latexmk.pdf | bin | 148208 -> 148150 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/latexmk.txt | 1071 |
5 files changed, 569 insertions, 537 deletions
diff --git a/Master/texmf-dist/doc/support/latexmk/README b/Master/texmf-dist/doc/support/latexmk/README index 28cc68bba6a..cd0a58aae24 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.02a: Automatic LaTeX document generation routine +Latexmk 4.02b: Automatic LaTeX document generation routine Usage: latexmk [latexmk_options] [filename ...] @@ -102,10 +102,9 @@ Usage: latexmk [latexmk_options] [filename ...] This and the other clean-ups are instead of a regular make. -C - clean up (remove) all nonessential files including aux, dep, dvi, postscript and pdf files - But exclude file of database of file information - -CA - clean up (remove) absolutely ALL nonessential files - including aux, dep, dvi, postscript and pdf files, and file of database of file information + -CA - clean up (remove) absolutely ALL nonessential files. + Now equivalent to -C option. -CF - Remove file of database of file information before doing other actions -cd - Change to directory of source file when processing it diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.1 b/Master/texmf-dist/doc/support/latexmk/latexmk.1 index a61358cc3b0..937807a138c 100644 --- a/Master/texmf-dist/doc/support/latexmk/latexmk.1 +++ b/Master/texmf-dist/doc/support/latexmk/latexmk.1 @@ -1,4 +1,4 @@ -.TH LATEXMK 1L "30 September 2008" "" +.TH LATEXMK 1L "1 December 2008" "" .SH NAME latexmk \- generate LaTeX document .SH SYNOPSIS @@ -127,11 +127,12 @@ exit. .B -c Clean up (remove) all regeneratable files generated by \fIlatex\fR and \fIbibtex\fR except dvi, postscript and pdf. These files are a -combination of log files, aux files, and those with extensions +combination of log files, aux files, latexmk's database file of source +file information, +and those with extensions specified in the \fI@generated_exts\fR configuration variable. In addition, files with extensions by the \fI$clean_ext\fR configuration variable are -removed. But the file containing a database of source file -information is not removed. +removed. This cleanup is instead of a regular make. See the \fB-gg\fR option if you want to do a cleanup then a make. @@ -146,12 +147,11 @@ This cleanup is instead of a regular make. See the \fB-gg\fR option if you want to do a cleanup than a make. .TP .B -CA -Clean up (remove) absolutely all regeneratable files. This is the -action specified by \fB-C\fR with the addition of deleting the file -containing the database of source file information. +Clean up (remove) absolutely all regeneratable files. It is now +equivalent to the \fB-C\fR option -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. +See the \fB-gg\fR option if you want to do a cleanup then a make. .TP .B -CF diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.bat b/Master/texmf-dist/doc/support/latexmk/latexmk.bat index f119082adac..48e01d6e5e1 100755 --- a/Master/texmf-dist/doc/support/latexmk/latexmk.bat +++ b/Master/texmf-dist/doc/support/latexmk/latexmk.bat @@ -1,5 +1,5 @@ -Rem Execute latexmk.pl, searching for it in the PATH
-Rem Assume perl is in the PATH. If not, you should replace 'perl' by
-Rem the full pathname of the perl executable, e.g., 'C:\perl\bin\perl.exe'
-
-perl -S latexmk.pl %1 %2 %3 %4 %5 %6 %7 %8 %9
+Rem Execute latexmk.pl, searching for it in the PATH +Rem Assume perl is in the PATH. If not, you should replace 'perl' by +Rem the full pathname of the perl executable, e.g., 'C:\perl\bin\perl.exe' + +perl -S latexmk.pl %1 %2 %3 %4 %5 %6 %7 %8 %9 diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.pdf b/Master/texmf-dist/doc/support/latexmk/latexmk.pdf Binary files differindex 86ba4a955f9..f81f5706f2b 100644 --- a/Master/texmf-dist/doc/support/latexmk/latexmk.pdf +++ b/Master/texmf-dist/doc/support/latexmk/latexmk.pdf diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.txt b/Master/texmf-dist/doc/support/latexmk/latexmk.txt index 1b735710eee..8f6e735eade 100644 --- a/Master/texmf-dist/doc/support/latexmk/latexmk.txt +++ b/Master/texmf-dist/doc/support/latexmk/latexmk.txt @@ -1,55 +1,50 @@ - - -LATEXMK(1L) LATEXMK(1L) - - -[1mNAME[0m +NAME latexmk - generate LaTeX document -[1mSYNOPSIS[0m - [1mlatexmk [options] [file ...][0m +SYNOPSIS + latexmk [options] [file ...] -[1mDESCRIPTION[0m - [4mLatexmk[24m completely automates the process of compiling a LaTeX document. - Essentially, it is like a specialized relative of the general [4mmake[0m +DESCRIPTION + Latexmk completely automates the process of compiling a LaTeX document. + Essentially, it is like a specialized relative of the general make utility, but one which determines dependencies automatically and has some other very useful features. In its basic mode of operation - [4mlatexmk[24m is given the name of the primary source file for a document, + latexmk is given the name of the primary source file for a document, and it issues the appropriate sequence of commands to generate a .dvi, .ps, .pdf and/or hardcopy version of the document. - [4mLatexmk[24m can also be set to run continuously with a suitable previewer. + Latexmk 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 automatically updates the on-screen view of the compiled document. - [4mLatexmk[24m determines which are the source files by examining the log - file. When [4mlatexmk[24m is run, it examines properties of the source files, + Latexmk determines which are the source files by examining the log + file. When latexmk is run, it examines properties of the source files, and if any have been changed since the last document generation, - [4mlatexmk[24m will run the various LaTeX processing programs as necessary. + latexmk will run the various LaTeX processing programs as necessary. In particular, it will repeat the run of LaTeX (or pdflatex) often enough to resolve all cross references; depending on the macro packages used. With some macro packages and document classes, four, or even - more, runs may be needed. If necessary, [4mlatexmk[24m will also run bibtex - and/or makeindex. In addition, [4mlatexmk[24m can be configured to generate + more, runs may be needed. If necessary, latexmk will also run bibtex + and/or makeindex. In addition, latexmk can be configured to generate other necessary files. For example, from an updated figure file it can automatically generate a file in encapsulated postscript or another suitable format for reading by LaTeX. - [4mLatexmk[24m has two different previewing options. In the simple [1m-pv[0m + Latexmk has two different previewing options. In the simple -pv 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. - The second previewing option is the powerful [1m-pvc [22moption (mnemonic: - "preview continuously"). In this case, [4mlatexmk[24m runs continuously, reg- + The second previewing option is the powerful -pvc option (mnemonic: + "preview continuously"). In this case, latexmk runs continuously, reg- ularly monitoring all the source files to see if any have changed. - Every time a change is detected, [4mlatexmk[24m runs all the programs neces- + Every time a change is detected, latexmk runs all the programs neces- sary to generate a new version of the document. A good previewer (like - [4mgv[24m) will then automatically update its display. Thus the user can sim- - ply edit a file and, when the changes are written to disk, [4mlatexmk[24m com- + gv) will then automatically update its display. Thus the user can sim- + ply edit a file and, when the changes are written to disk, latexmk com- pletely 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. @@ -58,31 +53,31 @@ LATEXMK(1L) LATEXMK(1L) update its display, which can be (some versions of xdvi and gsview) as simple as forcing a redraw of its display. + Latexmk 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. - 30 September 2008 1 + 1 -LATEXMK(1L) LATEXMK(1L) +LATEXMK(1L) LATEXMK(1L) - [4mLatexmk[24m 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. - [4mLatexmk[24m is highly configurable, both from the command line and in con- + Latexmk is highly configurable, both from the command line and in con- figuration files, so that it can accommodate a wide variety of user needs and system configurations. Default values are set according to - the operating system, so [4mlatexmk[24m often works without special configura- + the operating system, so latexmk often works without special configura- tion on MS-Windows, cygwin, Linux, OS-X, and other UNIX systems (notably Solaris). - A very annoying complication handled very reliably by [4mLatexmk[24m, is that + A very annoying complication handled very reliably by Latexmk, is that LaTeX is a multiple pass system. On each run, LaTeX reads in informa- tion generated on a previous run, for things like cross referencing and indexing. In the simplest cases, a second run of LaTeX suffices, and @@ -90,21 +85,21 @@ LATEXMK(1L) LATEXMK(1L) 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 of which programs. In - its new version, [4mlatexmk[24m has a highly general and efficient solution to + its new version, latexmk has a highly general and efficient solution to these issues. The solution involves retaining between runs information - on the source files, and a symptom is that [4mlatexmk[24m generates an extra + on the source files, and a symptom is that latexmk generates an extra file (with extension .fdb_latexmk, by default) that contains the source file information. -[1mLATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE[0m +LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE (All options can be introduced by single or double "-" characters, e.g., "latexmk -help" or "latexmk --help".) - [1mfile [22mOne or more files can be specified. If no files are specified, - [4mlatexmk[24m will, by default, run on all files in the current work- + file One or more files can be specified. If no files are specified, + latexmk will, by default, run on all files in the current work- ing directory with a ".tex" extension. This behavior can be - changed: see the description concerning the [4m@default_files[24m vari- + changed: see the description concerning the @default_files vari- able in the section "List of configuration variables usable in initialization files". @@ -113,21 +108,26 @@ LATEXMK(1L) LATEXMK(1L) latexmk foo - then [4mlatexmk[24m will operate on the file "foo.tex". + then latexmk will operate on the file "foo.tex". - [1m-bm <message>[0m + -bm <message> A banner message to print diagonally across each page when con- verting the dvi file to postscript. The message must be a sin- gle argument on the command line so be careful with quoting spaces and such. - Note that if the [1m-bm [22moption is specified, the [1m-ps [22moption is + Note that if the -bm option is specified, the -ps option is assumed. + -bi <intensity> + How dark to print the banner message. A decimal number between + 0 and 1. 0 is black and 1 is white. The default is 0.95, which + is OK unless your toner cartridge is getting low. + - 30 September 2008 2 + 1 December 2008 2 @@ -136,12 +136,7 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - [1m-bi <intensity>[0m - How dark to print the banner message. A decimal number between - 0 and 1. 0 is black and 1 is white. The default is 0.95, which - is OK unless your toner cartridge is getting low. - - [1m-bs <scale>[0m + -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 @@ -149,65 +144,64 @@ LATEXMK(1L) LATEXMK(1L) message. The default is 220.0 which is just right for 5 charac- ter messages. - [1m-commands[0m - List the commands used by [4mlatexmk[24m for processing files, and then + -commands + List the commands used by latexmk for processing files, and then exit. - [1m-c [22mClean up (remove) all regeneratable files generated by [4mlatex[24m and - [4mbibtex[24m except dvi, postscript and pdf. These files are a combi- - nation of log files, aux files, and those with extensions speci- - fied in the [4m@generated_exts[24m configuration variable. In addi- - tion, files with extensions by the [4m$clean_ext[24m configuration - variable are removed. But the file containing a database of - source file information is not removed. + -c Clean up (remove) all regeneratable files generated by latex and + bibtex except dvi, postscript and pdf. These files are a combi- + nation of log files, aux files, latexmk's database file of + source file information, and those with extensions specified in + the @generated_exts configuration variable. In addition, files + with extensions by the $clean_ext configuration variable are + removed. - This cleanup is instead of a regular make. See the [1m-gg [22moption + This cleanup is instead of a regular make. See the -gg option if you want to do a cleanup then a make. - [1m-C [22mClean up (remove) all regeneratable files generated by [4mlatex[24m and - [4mbibtex[24m. This is the same as the [1m-c [22moption with the addition of + -C Clean up (remove) all regeneratable files generated by latex and + bibtex. This is the same as the -c option with the addition of dvi, postscript and pdf files, and those with extensions in the - [4m$clean_full_ext[24m configuration variable. + $clean_full_ext configuration variable. - This cleanup is instead of a regular make. See the [1m-gg [22moption + This cleanup is instead of a regular make. See the -gg option if you want to do a cleanup than a make. - [1m-CA [22mClean up (remove) absolutely all regeneratable files. This is - the action specified by [1m-C [22mwith the addition of deleting the - file containing the database of source file information. + -CA Clean up (remove) absolutely all regeneratable files. It is now + equivalent to the -C option - This cleanup is instead of a regular make. It is the same as [1m-C[0m - [1m-CF[22m. See the [1m-gg [22moption if you want to do a cleanup then a - make. + This cleanup is instead of a regular make. See the -gg option + if you want to do a cleanup then a make. - [1m-CF [22mRemove the file containing the database of source file informa- + -CF Remove the file containing the database of source file informa- tion, before doing the other actions requested. - [1m-d [22mSet draft mode. This prints the banner message "DRAFT" across + -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 [1m-bs [22mand [1m-bi [22moptions. The [1m-bm[0m + intensity can be modified with the -bs and -bi options. The -bm option will override this option as this is really just a short way of specifying: latexmk -bm DRAFT + Note that if the -d option is specified, the -ps option is + assumed. + -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, - 30 September 2008 3 + 1 December 2008 3 -LATEXMK(1L) LATEXMK(1L) - Note that if the [1m-d [22moption is specified, the [1m-ps [22moption is - assumed. +LATEXMK(1L) LATEXMK(1L) + - [1m-dF [22mDvi 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 be performed on this filtered dvi file. @@ -216,31 +210,31 @@ LATEXMK(1L) LATEXMK(1L) latexmk -dF 'dviselect even' foo.tex - [1m-diagnostics[0m + -diagnostics Print detailed diagnostics during a run. This may help for - debugging problems or to understand [4m.latexmk[24m's behavior in dif- + debugging problems or to understand .latexmk's behavior in dif- ficult situations. - [1m-dvi [22mGenerate dvi version of document. + -dvi Generate dvi version of document. - [1m-dvi- [22mTurn off generation of dvi version of document. (This may get + -dvi- Turn off generation of dvi version of document. (This may get overridden, if some other file is made (e.g., a .ps file) that is generated from the dvi file, or if no generated file at all is requested.) - [1m-e <code>[0m + -e <code> Execute the specified initialization code before processing. - The code is [4mPerl[24m code of the same form as is used in [4mlatexmk[24m's + The code is Perl code of the same form as is used in latexmk's initialization files -- for more details, see the information on - the [1m-r [22moption, and the section about "Configuration/initializa- + the -r option, and the section about "Configuration/initializa- tion (RC) files". The code is typically a sequence of assign- ment statements separated by semicolons. - The code is executed when the [1m-e [22moption is encountered during - [4mlatexmk[24m's parsing of its command line. See the [1m-r [22moption for a + The code is executed when the -e option is encountered during + latexmk's parsing of its command line. See the -r option for a way of executing initialization code from a file. An error - results in [4mlatexmk[24m stopping. Multiple instances of the [1m-r [22mand - [1m-e [22moptions can be used, and they are executed in the order they + results in latexmk stopping. Multiple instances of the -r and + -e 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 char- @@ -250,56 +244,56 @@ LATEXMK(1L) LATEXMK(1L) latexmk -e '$latex=q/latex %O -shell-escape %S/' file.tex - (Note that the q/.../ construct is a [4mPerl[24m idiom equivalent to + (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.) - [1m-f [22mForce [4mlatexmk[24m to continue document processing despite errors. - Normally, when [4mlatexmk[24m detects that LaTeX or another program has + -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 - 30 September 2008 4 + 1 December 2008 4 -LATEXMK(1L) LATEXMK(1L) +LATEXMK(1L) LATEXMK(1L) - found an error which will not be resolved by further processing, - no further processing is carried out. - [1m-f- [22mTurn off the forced processing-past-errors such as is set by the - [1m-f [22moption. This could be used to override a setting in a con- - figuration file. + configuration file. - [1m-g [22mForce [4mlatexmk[24m to process document fully, even under situations - where [4mlatexmk[24m would normally decide that no changes in the + -g Force latexmk to process document fully, even under situations + where latexmk would normally decide that no changes in the source files have occurred since the previous run. This option is useful, for example, if you change some options and wish to reprocess the files. - [1m-g- [22mTurn off [1m-g[22m. + -g- Turn off -g. - [1m-gg [22m"Super go mode" or "clean make": clean out generated files as if - [1m-CA [22mhad been given, and then do a regular make. + -gg "Super go mode" or "clean make": clean out generated files as if + -CA had been given, and then do a regular make. - [1m-h, -help[0m + -h, -help Print help information. - [1m-l [22mRun in landscape mode, using the landscape mode for the preview- + -l Run in landscape mode, using the landscape mode for the preview- ers and the dvi to postscript converters. This option is not normally needed nowadays, since current previewers normally determine this information automatically. - [1m-l- [22mTurn off [1m-l[22m. + -l- Turn off -l. - [1m-new-viewer[0m + -new-viewer When in continuous-preview mode, always start a new viewer to - view the generated file. By default, [4mlatexmk[24m will, in continu- + view the generated file. By default, latexmk will, in continu- ous-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 @@ -307,15 +301,15 @@ LATEXMK(1L) LATEXMK(1L) name as the current file, but in a different directory). This option turns off the default behavior. - [1m-new-viewer-[0m - The inverse of the [1m-new-viewer [22moption. It puts [4mlatexmk[24m in its + -new-viewer- + The inverse of the -new-viewer option. It puts latexmk in its normal behavior that in preview-continuous mode it checks for an already-running previewer. - [1m-p [22mPrint out the document. By default it is the generated - postscript file that is printed. But you can use the [1m-print=...[0m + -p Print out the document. By default it is the generated + postscript file that is printed. But you can use the -print=... option to print the dvi or pdf files instead, and you can con- - figure this in a start up file (by setting the [4m$print_type[24m vari- + figure this in a start up file (by setting the $print_type vari- able). However, printing is enabled by default only under UNIX/LINUX @@ -323,53 +317,53 @@ LATEXMK(1L) LATEXMK(1L) eral, the correct behavior for printing very much depends on your system's software. In particular, under MS-Windows you must have suitable program(s) available, and you must have con- - figured the print commands used by [4mlatexmk[24m. This can be non- + figured the print commands used by latexmk. This can be non- + trivial. See the documentation on the $lpr, $lpr_dvi, and + $lpr_pdf configuration variables to see how to set the commands + for printing. - 30 September 2008 5 + 1 December 2008 5 -LATEXMK(1L) LATEXMK(1L) +LATEXMK(1L) LATEXMK(1L) - trivial. See the documentation on the [4m$lpr[24m, [4m$lpr_dvi[24m, and - [4m$lpr_pdf[24m configuration variables to see how to set the commands - for printing. - This option is incompatible with the [1m-pv [22mand [1m-pvc [22moptions, so it + This option is incompatible with the -pv and -pvc options, so it turns them off. - [1m-pdf [22mGenerate pdf version of document using pdflatex. + -pdf Generate pdf version of document using pdflatex. - [1m-pdfdvi[0m + -pdfdvi Generate pdf version of document from the dvi file, by default using dvipdf. - [1m-pdfps [22mGenerate pdf version of document from the ps file, by default + -pdfps Generate pdf version of document from the ps file, by default using ps2pdf. - [1m-pdf- [22mTurn off generation of pdf version of document. (This can be + -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.) - [1m-print=dvi, -print=ps, -print=pdf[0m + -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. The default is to print a postscript file. - [1m-ps [22mGenerate postscript version of document. + -ps Generate postscript version of document. - [1m-ps- [22mTurn off generation of postscript version of document. This can + -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.) - [1m-pF [22mPostscript file filtering. The argument to this option is a + -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 performed on this filtered postscript file. @@ -386,40 +380,40 @@ LATEXMK(1L) LATEXMK(1L) depend on your command interpreter, as used by the particular version of perl and the operating system on your computer. - [1m-pv [22mRun file previewer. If the [1m-view [22moption is used, this will + -pv Run file previewer. If the -view option is used, this will select the kind of file to be previewed (dvi, ps or pdf). Oth- erwise the viewer views the "highest" kind of file selected, by - the [1m-dvi[22m, [1m-ps[22m, [1m-pdf[22m, [1m-pdfps [22moptions, in the order dvi, ps, pdf - (low to high). If no file type has been selected, the dvi + the -dvi, -ps, -pdf, -pdfps options, in the order dvi, ps, pdf + (low to high). If no file type has been selected, the dvi pre- + viewer will be used. This option is incompatible with the -p + and -pvc options, so it turns them off. - 30 September 2008 6 + 1 December 2008 6 -LATEXMK(1L) LATEXMK(1L) +LATEXMK(1L) LATEXMK(1L) - previewer will be used. This option is incompatible with the [1m-p[0m - and [1m-pvc [22moptions, so it turns them off. - [1m-pv- [22mTurn off [1m-pv[22m. + -pv- Turn off -pv. - [1m-pvc [22mRun a file previewer and continually update the .dvi, .ps, + -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 [1m-pv [22moption. The preview-continuous option [1m-pvc[0m + same as for the -pv option. The preview-continuous option -pvc 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 [1m-p [22mand [1m-pv [22moptions, so it turns these + incompatible with the -p and -pv options, so it turns these options off With a good previewer the display will be automatically updated. - (Under [4msome[24m [4mbut[24m [4mnot[24m [4mall[24m versions of UNIX/Linux "gv -watch" does + (Under some but not all 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 @@ -430,25 +424,25 @@ LATEXMK(1L) LATEXMK(1L) 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 [1m-view=dvi [22mand [1m-view=ps [22moptions. + the -view=dvi and -view=ps options. There are some other methods for arranging an update, notably useful for many versions of xdvi and xpdf. These are best set - in [4mlatexmk[24m's configuration; see below. + in latexmk's configuration; see below. - Note that if [4mlatexmk[24m dies or is stopped by the user, the + Note that if latexmk dies or is stopped by the user, the "forked" previewer will continue to run. Successive invocations - with the [1m-pvc [22moption will not fork new previewers, but [4mlatexmk[0m + with the -pvc option will not fork new previewers, but latexmk will normally use the existing previewer. (At least this will - happen when [4mlatexmk[24m is running under an operating system where + happen when latexmk is running under an operating system where it knows how to determine whether an existing previewer is run- ning.) - [1m-pvc- [22mTurn off [1m-pvc[22m. + -pvc- Turn off -pvc. - [1m-quiet [22mSame as -silent + -quiet Same as -silent - [1m-r <rcfile>[0m + -r <rcfile> Read the specified initialization file ("RC file") before pro- cessing. @@ -456,12 +450,14 @@ LATEXMK(1L) LATEXMK(1L) -- 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 [1m-r [22moption, it is read + 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 - 30 September 2008 7 + 1 December 2008 7 @@ -470,65 +466,64 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - with the [1m-r [22moption can override both the standard initialization - files and [4mpreviously[24m specified options. But all of these can be - overridden by [4mlater[24m options. + overridden by later options. The contents of the RC file just comprise a piece of code in the - [4mPerl[24m programming language (typically a sequence of assignment - statements); they are executed when the [1m-r [22moption is encountered - during [4mlatexmk[24m's parsing of its command line. See the [1m-e [22moption - for a way of giving initialization code directly on [4mlatexmk[24m's - command line. An error results in [4mlatexmk[24m stopping. Multiple - instances of the [1m-r [22mand [1m-e [22moptions can be used, and they are + 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 + for a way of giving initialization code directly on latexmk's + command line. An error results in latexmk stopping. Multiple + instances of the -r and -e options can be used, and they are executed in the order they appear on the command line. - [1m-silent[0m + -silent Run commands silently, i.e., with options that reduce the amount of diagnostics generated. For example, with the default set- tings for commands under UNIX, the command "latex -interac- tion=batchmode" is used for latex. - Also reduce the number of informational messages that [4mlatexmk[0m + Also reduce the number of informational messages that latexmk generates. - [1m-v, -version[0m - Print version number of [4mlatexmk[24m. + -v, -version + Print version number of latexmk. - [1m-verbose[0m - Opposite of [1m-silent[22m. This is the default setting. + -verbose + Opposite of -silent. This is the default setting. - [1m-view=default, -view=dvi, -view=ps, -view=pdf[0m + -view=default, -view=dvi, -view=ps, -view=pdf Set the kind of file used when previewing is requested (e.g., by - the [1m-pv [22mor [1m-pvc [22mswitches). The default is to view the "highest" + the -pv or -pvc switches). The default is to view the "highest" kind of requested file (in the order dvi, ps, pdf). - The preview-continuous option [1m-pvc [22mcan only work with one file. So in + The preview-continuous option -pvc can only work with one file. So in this case you will normally only specify one filename on the command line. - Options [1m-p[22m, [1m-pv [22mand [1m-pvc [22mare mutually exclusive. So each of these + Options -p, -pv and -pvc are mutually exclusive. So each of these options turns the others off. -[1mEXAMPLES[0m - % [1mlatexmk thesis [4m[22m#[24m [4mrun[24m [4mlatex[24m [4menough[24m [4mtimes[24m [4mto[24m [4mresolve[0m - [4mcross-references[0m +EXAMPLES + % latexmk thesis # run latex enough times to resolve + cross-references - % [1mlatexmk -pvc -ps thesis[4m[22m#[24m [4mrun[24m [4mlatex[24m [4menough[24m [4mtimes[24m [4mto[24m [4mresolve[0m - [4mcross-references,[24m [4mmake[24m [4ma[24m [4mpostscript[0m - [4mfile,[24m [4mstart[24m [4ma[24m [4mpreviewer.[24m [4mThen[0m - [4mwatch[24m [4mfor[24m [4mchanges[24m [4min[24m [4mthe[24m [4msource[0m - [4mfile[24m [4mthesis.tex[24m [4mand[24m [4many[24m [4mfiles[24m [4mit[0m - [4muses.[24m [4mAfter[24m [4many[24m [4mchanges[24m [4mrerun[24m [4mlatex[0m - [4mthe[24m [4mappropriate[24m [4mnumber[24m [4mof[24m [4mtimes[24m [4mand[0m - [4mremake[24m [4mthe[24m [4mpostscript[24m [4mfile.[24m [4mIf[24m [4mlatex[0m - [4mencounters[24m [4man[24m [4merror,[24m [4mlatexmk[24m [4mwill[0m - [4mkeep[24m [4mrunning,[24m [4mwatching[24m [4mfor[0m + % latexmk -pvc -ps thesis# 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 + 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. - 30 September 2008 8 + 1 December 2008 8 @@ -537,19 +532,17 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - [4msource[24m [4mfile[24m [4mchanges.[0m - - [4m%[24m [1mlatexmk -c [4m[22m#[24m [4mremove[24m [4m.aux,[24m [4m.log,[24m [4m.bbl,[24m [4m.blg,[24m [4m.dvi,[0m - [4m.pdf,[24m [4m.ps[24m [4m&[24m [4m.bbl[24m [4mfiles[0m + % latexmk -c # remove .aux, .log, .bbl, .blg, .dvi, + .pdf, .ps & .bbl files -[1mCONFIGURATION/INITIALIZATION (RC) FILES[0m - [4mLatexmk[24m can be customized using initialization files, which are read at +CONFIGURATION/INITIALIZATION (RC) FILES + Latexmk can be customized using initialization files, which are read at startup in the following order: 1) The system RC file, if it exists. - On a UNIX system, [4mlatexmk[24m searches for following places for its sys- + On a UNIX system, latexmk searches for following places for its sys- tem RC file, in the following order, and reads the first it finds: "/opt/local/share/latexmk/LatexMk", "/usr/local/share/latexmk/LatexMk", @@ -565,23 +558,23 @@ LATEXMK(1L) LATEXMK(1L) named either "latexmkrc" or ".latexmkrc", and the first of these to be found is used, if any. - 4) Any RC file(s) specified on the command line with the [1m-r [22moption. + 4) Any RC file(s) specified on the command line with the -r option. - Each RC file is a sequence of [4mPerl[24m commands. Naturally, a user can use + Each RC file is a sequence of Perl commands. Naturally, a user can use this in creative ways. But for most purposes, one simply uses a sequence of assignment statements that override some of the built-in - settings of [4mLatexmk[24m. Straightforward cases can be handled without - knowledge of the [4mPerl[24m language by using the examples in this document + settings of Latexmk. Straightforward cases can be handled without + knowledge of the Perl language by using the examples in this document as templates. 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 [1m-r[0m + are written; thus any RC file specified on the command line with the -r option can override previous options but can be itself overridden by - later options on the command line. There is also the [1m-e [22moption, which - allows initialization code to be specified in [4mlatexmk[24m's command line. + later options on the command line. There is also the -e option, which + allows initialization code to be specified in latexmk's command line. -[1mHOW TO SET VARIABLES IN INITIALIZATION FILES[0m +HOW TO SET VARIABLES IN INITIALIZATION FILES The important variables that can be configured are described in the section "List of configuration variables usable in initialization files". Syntax for setting these variables is of the following forms: @@ -592,10 +585,11 @@ LATEXMK(1L) LATEXMK(1L) $preview_mode = 1; + for the setting of a numeric variable, and - 30 September 2008 9 + 1 December 2008 9 @@ -604,8 +598,6 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - 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 @@ -618,18 +610,18 @@ LATEXMK(1L) LATEXMK(1L) Each statement ends with a semicolon. You can do much more complicated things, but for this you will need to - consult a manual for the [4mPerl[24m programming language. + consult a manual for the Perl programming language. -[1mFORMAT OF COMMAND SPECIFICATIONS[0m - Some of the variables set the commands that [4mlatexmk[24m uses for carrying +FORMAT OF COMMAND SPECIFICATIONS + Some of the variables set the commands that latexmk uses for carrying out its work, for example to generate a dvi file from a tex file or to view a postscript file. This section describes some important features of how the commands are specified. - [1mPlaceholders[22m: Supposed you wanted [4mlatexmk[24m to use the command elatex in + Placeholders: Supposed you wanted latexmk to use the command elatex in place of the regular latex command, and suppose moreover that you wanted to give it the option "--shell-escape". You could do this by the following setting: @@ -639,39 +631,39 @@ LATEXMK(1L) LATEXMK(1L) The two items starting with the % character are placeholders. These are substituted by appropriate values before the command is run. Thus %S will be replaced by the source file that elatex will be applied to, - and %O will be replaced by any options that [4mlatexmk[24m has decided to use + and %O will be replaced by any options that latexmk has decided to use for this command. (E.g., if you used the -silent option it would replace %O by "-interaction=batchmode".) The available placeholders are: - [1m%B [22mbase of filename for current command. E.g., if a postscript + %B base of filename for current command. E.g., if a postscript file document.ps is being made from the dvi file document.dvi, then the basename is document. - [1m%D [22mdestination file (e.g., the name of the postscript file when + %D destination file (e.g., the name of the postscript file when converting a dvi file to postscript). - [1m%O [22moptions + %O options - [1m%R [22mroot filename. This is the base name for the main tex file. + %R root filename. This is the base name for the main tex file. - [1m%S [22msource file (e.g., the name of the dvi file when converting a + %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. - 30 September 2008 10 + 1 December 2008 10 -LATEXMK(1L) LATEXMK(1L) +LATEXMK(1L) LATEXMK(1L) - [1m%T [22mThe name of the primary tex file. The distinction between %B and %R needs a bit of care, since they are often the same, but not always. For example on a simple document, the @@ -691,14 +683,14 @@ LATEXMK(1L) LATEXMK(1L) ate usage. If you omit to supply any placeholders whatever in the specification of - a command, [4mlatexmk[24m will supply what its author thinks are appropriate + a command, latexmk will supply what its author thinks are appropriate defaults. This gives compatibility with configuration files for previ- - ous versions of [4mlatexmk[24m, which didn't use placeholders. + ous versions of latexmk, which didn't use placeholders. - [1m"Detaching" a command[22m: Normally when [4mlatexmk[24m runs a command, it waits + "Detaching" a command: Normally when latexmk runs a command, it waits for the command to run to completion. This is appropriate for commands like latex, of course. But for previewers, the command should normally - run detached, so that [4mlatexmk[24m gets the previewer running and then + run detached, so that latexmk gets the previewer running and then returns to its next task (or exits if there is nothing else to do). To achieve this effect of detaching a command, you need to precede the command name with "start ", as in @@ -708,7 +700,7 @@ LATEXMK(1L) LATEXMK(1L) This will be translated to whatever is appropriate for your operating system. - Notes: (1) In some circumstances, [4mlatex[24m will always run a command + 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 @@ -718,7 +710,7 @@ LATEXMK(1L) LATEXMK(1L) UNIX and MS-Windows. See the source code for how I've handled the problem. - [1mCommand names containing spaces[22m: Under MS-Windows it is common that the + Command names containing spaces: 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 @@ -726,10 +718,12 @@ LATEXMK(1L) LATEXMK(1L) $lpr_pdf = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p %S'; + Using MS-Windows file associations: A useful trick under modern ver- + sions of MS-Windows (e.g., WinXP) is to use just the command - 30 September 2008 11 + 1 December 2008 11 @@ -738,16 +732,13 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - [1mUsing MS-Windows file associations[22m: A useful trick under modern ver- - sions of MS-Windows (e.g., WinXP) is to use just the command - $dvi_previewer = 'start %S'; 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.) - [1mNot using a certain command[22m: If a command is not to be run, the command + Not using a certain command: If a command is not to be run, the command name NONE is used, as in $lpr = 'NONE lpr'; @@ -755,22 +746,22 @@ LATEXMK(1L) LATEXMK(1L) This typically is used when an appropriate command does not exist on your system. The string after the "NONE" is effectively a comment. - [1mOptions to commands[22m: Setting the name of a command can be used not only + Options to commands: Setting the name of a command can be used not only for changing the name of the command called, but also to add options to - command. Suppose you want [4mlatexmk[24m to use latex with source specials + command. Suppose you want latexmk to use latex with source specials enabled. Then you might use the following line in an initialization file: $latex = 'latex --src-specials %O %S'; - [1mAdvanced tricks[22m: Normally one specifies a single command for the com- - mands invoked by [4mlatexmk[24m. Naturally, if there is some complicated + Advanced tricks: Normally one specifies a single command for the com- + mands invoked by latexmk. Naturally, if there is some complicated additional processing you need to do in your special situation, you can write a script (or batch file) to do the processing, and then configure - [4mlatexmk[24m to use your script in place of the standard program. + latexmk to use your script in place of the standard program. - It is also possible to configure [4mlatexmk[24m to run multiple commands. For + It is also possible to configure latexmk to run multiple commands. For example, if when running pdflatex to generate a pdf file from a tex file you need to run another program after pdflatex to perform some extra processing, you could do something like: @@ -784,19 +775,22 @@ LATEXMK(1L) LATEXMK(1L) -[1mLIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES[0m +LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES Default values are indicated in brackets. - [1m$banner [0][0m + $banner [0] If nonzero, the banner message is printed across each page when converting the dvi file to postscript. Without modifying the - variable [4m$banner_message[24m, this is equivalent to specifying the - [1m-d [22moption. + variable $banner_message, this is equivalent to specifying the + -d option. + Note that if $banner is nonzero, the $postscript_mode is assumed + and the postscript file is always generated, even if it is newer + than the dvi file. - 30 September 2008 12 + 1 December 2008 12 @@ -805,31 +799,27 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - Note that if [1m$banner [22mis nonzero, the [1m$postscript_mode [22mis assumed - and the postscript file is always generated, even if it is newer - than the dvi file. - - [1m$banner_intensity [0.95][0m - Equivalent to the [1m-bi [22moption, this is a decimal number between 0 + $banner_intensity [0.95] + Equivalent to the -bi 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 car- tridge isn't running too low. - [1m$banner_message ["DRAFT"][0m + $banner_message ["DRAFT"] The banner message to print across each page when converting the - dvi file to postscript. This is equivalent to the [1m-bm [22moption. + dvi file to postscript. This is equivalent to the -bm option. - [1m$banner_scale [220.0][0m + $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 [1m-bs [22moption. + This is equivalent to the -bs option. - [1m@BIBINPUTS[0m + @BIBINPUTS This is an array variable, now mostly obsolete, that specifies - directories where [4mlatexmk[24m should look for .bib files. By + directories where latexmk should look for .bib files. By default it is set from the BIBINPUTS environment variable of the operating system. If that environment variable is not set, a single element list consisting of the current directory is set. @@ -846,24 +836,28 @@ LATEXMK(1L) LATEXMK(1L) backward slash "\" can be used to separate pathname components, so the first two and the second two examples are equivalent. Each backward slash should be doubled to avoid running afoul of - [4mPerl[24m's rules for writing strings. + Perl's rules for writing strings. - [4mImportant[24m [4mnote:[24m This variable is now mostly obsolete in the current - version of [4mlatexmk[24m, since it has a better method of searching for files + 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 [4m@BIBIN-[0m - [4mPUTS[24m. + without the kpsewhich command, you may need to set the variable @BIBIN- + PUTS. - [1m$bibtex ["bibtex %O %S"][0m + $bibtex ["bibtex %O %S"] The BibTeX processing program. - [1m$bibtex_silent_switch ["-terse"][0m - [1mSwitch(es) [22mfor the BibTeX processing program when silent mode is + $bibtex_silent_switch ["-terse"] + Switch(es) for the BibTeX processing program when silent mode is on. + $cleanup_includes_generated [0] + If nonzero, specifies that cleanup also deletes files that are + detected in log file as being generated (see the \openout lines + - 30 September 2008 13 + 1 December 2008 13 @@ -872,50 +866,47 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - [1m$cleanup_includes_generated [0][0m - If nonzero, specifies that cleanup also deletes files that are - detected in log file as being generated (see the \openout lines in the log file). It will also include files made from these first generation generated files. - [1m$cleanup_mode [0][0m + $cleanup_mode [0] If nonzero, specifies cleanup mode: 1 for full cleanup, 2 for cleanup except for dvi, ps and pdf files, 3 for cleanup except for dep and aux files. (There is also extra cleaning as speci- - fied by the [4m$clean_ext[24m, [4m$clean_full_ext[24m and [4m@generated_exts[0m + fied by the $clean_ext, $clean_full_ext and @generated_exts variables.) - This variable is equivalent to specifying one of the [1m-c[22m, [1m-c1[22m, or [1m-C[0m + This variable is equivalent to specifying one of the -c, -c1, or -C options. But there should be no need to set this variable from an RC file. - [1m$clean_ext [""][0m - Extra extensions of files for [4mlatexmk[24m to remove when any of the - clean-up options ([1m-c[22m, [1m-c1[22m, or [1m-C[22m) is selected. The value of + $clean_ext [""] + Extra extensions of files for latexmk to remove when any of the + clean-up options (-c, -c1, or -C) is selected. The value of this variable is a string containing the extensions separated by spaces. - [1m$clean_full_ext [""][0m - Extra extensions of files for [4mlatexmk[24m to remove when the [1m-C[0m + $clean_full_ext [""] + Extra extensions of files for latexmk to remove when the -C option is selected, i.e., extensions of files to remove when the .dvi, etc files are to be cleaned-up. - [1m@cus_dep_list [()][0m + @cus_dep_list [()] Custom dependency list -- see section on "Custom Dependencies". - [1m@default_files [("*.tex")][0m + @default_files [("*.tex")] Default list of files to be processed. Normally, if no filenames are specified on the command line, - [4mlatexmk[24m processes all tex files specified in the [4m@default_files[0m + latexmk processes all tex files specified in the @default_files variable, which by default is set to all tex files ("*.tex") in - the current directory. This is a convenience: just run [4mlatexmk[0m + the current directory. This is a convenience: just run latexmk and it will process an appropriate set of files. But sometimes you want only some of these files to be processed. In this case - you set the [4m@default_files[24m in an initialization file (e.g., the + you set the @default_files in an initialization file (e.g., the file "latexmkrc" in the current directory). Then if no files are specified on the command line then the files you specify by - setting [4m@default_files[24m are processed. + setting @default_files are processed. Three examples: @@ -927,43 +918,43 @@ LATEXMK(1L) LATEXMK(1L) Note that more than file may be given, and that the default extension is ".tex". Wild cards are allowed. The parentheses + are because @default_files is an array variable, i.e., a + sequence of filename specifications is possible. - 30 September 2008 14 + 1 December 2008 14 -LATEXMK(1L) LATEXMK(1L) +LATEXMK(1L) LATEXMK(1L) - are because [4m@default_files[24m is an array variable, i.e., a - sequence of filename specifications is possible. - [1m$dvi_filter [empty][0m + $dvi_filter [empty] The dvi file filter to be run on the newly produced dvi file - before other processing. Equivalent to specifying the [1m-dF[0m + before other processing. Equivalent to specifying the -dF option. - [1m$dvi_mode [0][0m + $dvi_mode [0] If nonzero, generate a dvi version of the document. Equivalent - to the [1m-dvi [22moption. + to the -dvi option. - [1m$dvi_previewer ["start xdvi %O %S" under UNIX][0m + $dvi_previewer ["start xdvi %O %S" under UNIX] 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.] - [1m$dvi_previewer_landscape ["start xdvi %O %S"][0m + $dvi_previewer_landscape ["start xdvi %O %S"] 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 sys- tem has associated with .dvi files.] - [1m$dvipdf ["dvipdf %O %S %D"][0m + $dvipdf ["dvipdf %O %S %D"] Command to convert dvi to pdf file. A common reconfiguration is to use the dvipdfm command, which needs its arguments in a dif- ferent order: @@ -975,30 +966,32 @@ LATEXMK(1L) LATEXMK(1L) That script should be modified to give dvips the options "-P pdf" to ensure that type 1 fonts are used in the pdf file. - [1m$dvips ["dvips %O -o %D %S"][0m + $dvips ["dvips %O -o %D %S"] 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 $dvips_pdf_switch -- see below -- will be included in the options substituted for "%O". - [1m$dvips_landscape ["dvips -tlandscape %O -o %D %S"][0m + $dvips_landscape ["dvips -tlandscape %O -o %D %S"] The program to used as a filter to convert a .dvi file to a .ps file in landscape mode. - [1m$dvips_pdf_switch ["-P pdf"][0m + $dvips_pdf_switch ["-P pdf"] Switch(es) for dvips program when pdf file is to be generated from ps file. - [1m$dvips_silent_switch ["-q"][0m + $dvips_silent_switch ["-q"] Switch(es) for dvips program when silent mode is on. - [1m$dvi_update_command [""][0m + $dvi_update_command [""] When the dvi previewer is set to be updated by running a com- mand, this is the command that is run. See the information for + the variable $dvi_update_method for further information, and see + information on the variable $pdf_update_method for an example - 30 September 2008 15 + 1 December 2008 15 @@ -1007,53 +1000,51 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - the variable [4m$dvi_update_method[24m for further information, and see - information on the variable [4m$pdf_update_method[24m for an example for the analogous case of a pdf previewer. - [1m$dvi_update_method [2 under UNIX, 1 under MS-Windows][0m + $dvi_update_method [2 under UNIX, 1 under MS-Windows] How the dvi viewer updates its display when the dvi file has changed. The values here apply equally to the - [4m$pdf_update_method[24m and to the [4m$ps_update_method[24m variables. + $pdf_update_method and to the $ps_update_method variables. 0 => update is automatic, 1=> manual update by user, which may only mean a mouse click on the viewer's window or may mean a more serious action. 2 => Send the signal, whose number is in the variable - [4m$dvi_update_signal[24m. The default value under UNIX is suitable + $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.) 4 => run a command to do the update. The command is speci- - fied by the variable [4m$dvi_update_command[24m. + fied by the variable $dvi_update_command. - See information on the variable [4m$pdf_update_method[24m for an exam- + See information on the variable $pdf_update_method for an exam- ple of updating by command. - [1m$dvi_update_signal [Under UNIX: SIGUSR1, which is a system-dependent[0m - [1mvalue][0m + $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 the information on the - variable [4m$dvi_update_method[24m. The default value is the one + variable $dvi_update_method. The default value is the one appropriate for xdvi on a UNIX system. - [1m$fdb_ext ["fdb_latexmk"][0m - The extension of the file which [4mlatexmk[24m generates to contain a + $fdb_ext ["fdb_latexmk"] + The extension of the file which latexmk generates to contain a database of information on source files. You will not normally need to change this. - [1m$force_mode [0][0m - If nonzero, continue processing past minor [4mlatex[24m errors includ- + $force_mode [0] + If nonzero, continue processing past minor latex errors includ- ing unrecognized cross references. Equivalent to specifying the - [1m-f [22moption. + -f option. - [1m@generated_exts [( aux , bbl , idx , ind , lof , lot , out , toc ,[0m - [1m$fdb_ext )][0m + @generated_exts [( aux , bbl , idx , ind , lof , lot , out , toc , + $fdb_ext )] This contains a list of extensions for files that are generated during a LaTeX run and that are read in by LaTeX in later runs, either directly or indirectly. This list has two uses: (a) to set the kinds of file to be - deleted in a cleanup operation (with the [1m-c[22m, [1m-C[22m, [1m-CA[22m, [1m-g [22mand [1m-gg[0m + deleted in a cleanup operation (with the -c, -C, -CA, -g and -gg options), and (b) in the determination of whether a rerun of (pdf)LaTeX is needed after a run that gives an error. @@ -1062,11 +1053,12 @@ LATEXMK(1L) LATEXMK(1L) file, that is read in on subsequent runs. But after a run that results in an error, a new run should occur until the user has made a change in the files. But the user may have corrected an - error in a source .tex file during the run. So [4mlatexmk[24m needs to + error in a source .tex file during the run. So latexmk needs to + distinguish user-generated and automatically generated files; it - 30 September 2008 16 + 1 December 2008 16 @@ -1075,7 +1067,6 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - distinguish user-generated and automatically generated files; it determines the automatically generated files as those with extensions in the list in @generated_exts.) @@ -1089,52 +1080,52 @@ LATEXMK(1L) LATEXMK(1L) extensions. (This extension is used by the RevTeX package, for example.) - [1m$go_mode [0][0m + $go_mode [0] If nonzero, process files regardless of timestamps, and is then - equivalent to the [1m-g [22moption. + equivalent to the -g option. - [1m%hash_calc_ignore_pattern[0m - [1m!!!This variable is for experts only!!![0m + %hash_calc_ignore_pattern + !!!This variable is for experts only!!! - The general rule [4mlatexmk[24m uses for determining when an extra run + The general rule latexmk uses for determining when an extra run of some program is needed is that one of the source files has changed. But consider for example a latex package that causes an encapsulated postscript file (an "eps" file) to be made that is to be read in on the next run. The file contains a comment line giving its creation date and time. On the next run the - time changes, [4mlatex[24m sees that the eps file has changed, and + time changes, latex sees that the eps file has changed, and therefore reruns latex. This causes an infinite loop, only - exited becaues [4mlatexmk[24m has a limit on the number of runs to + exited becaues latexmk has a limit on the number of runs to guard against pathological situations. But the changing line has no real effect, since it is a comment. - You can instruct [4mlatex[24m to ignore the offending line as follows: + You can instruct latex to ignore the offending line as follows: $hash_calc_ignore_pattern{'eps'} = '^%%CreationDate: '; - This creates a rule for files with extension [4m.eps[24m about lines to - ignore. The left-hand side is a [4mPerl[24m idiom for setting an item + This creates a rule for files with extension .eps about lines to + ignore. The left-hand side is a Perl idiom for setting an item in a hash. Note that the file extension is specified without a period. The value, on the right-hand side, is a string contain- - ing a regular expresssion. (See documentation on [4mPerl[24m for how + ing a regular expresssion. (See documentation on Perl for how they are to be specified in general.) This particular regular expression specifies that lines beginning with "%%CreationDate: " are to be ignored in deciding whether a file of the given - extension [4m.eps[24m has changed. + extension .eps has changed. - [1m$kpsewhich ["kpsewhich %S"][0m + $kpsewhich ["kpsewhich %S"] The program called to locate a source file when the name alone - is not sufficient. Most filenames used by [4mlatexmk[24m have suffi- + is not sufficient. Most filenames used by latexmk have suffi- cient path information to be found directly. But sometimes, notably when the file, but not its path is known. The program specified by $kpsewhich is used to find it. - See also the [4m@BIBINPUTS[24m variable for another way that [4mlatexmk[0m + See also the @BIBINPUTS variable for another way that latexmk also uses to try to locate files; it applies only in the case of - 30 September 2008 17 + 1 December 2008 17 @@ -1145,24 +1136,24 @@ LATEXMK(1L) LATEXMK(1L) .bib files. - [1m$landscape_mode [0][0m + $landscape_mode [0] If nonzero, run in landscape mode, using the landscape mode pre- - viewers and dvi to postscript converters. Equivalent to the [1m-l[0m + viewers and dvi to postscript converters. Equivalent to the -l option. Normally not needed with current previewers. - [1m$latex ["latex %O %S"][0m + $latex ["latex %O %S"] 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"; - [1m$latex_silent_switch ["-interaction=batchmode"][0m + $latex_silent_switch ["-interaction=batchmode"] Switch(es) for the LaTeX processing program when silent mode is on. Under MS-Windows, the default value is changed to "-inter- action=batchmode -c-style-errors", as used by MikTeX and fpTeX. - [1m$lpr ["lpr %O %S" under UNIX/LINUX, "NONE lpr" under MS-WINDOWS][0m + $lpr ["lpr %O %S" under UNIX/LINUX, "NONE lpr" under MS-WINDOWS] The command to print postscript files. Under MS-Windows (unlike UNIX/LINUX), there is no standard pro- @@ -1176,15 +1167,15 @@ LATEXMK(1L) LATEXMK(1L) to make the appropriate change. Note the combination of single and double quotes around the name. The single quotes specify that this is a string to be assigned to the configuration vari- - able [4m$lpr[24m. The double quotes are part of the string passed to + able $lpr. The double quotes are part of the string passed to the operating system to get the command obeyed; this is neces- sary because one part of the command name ("Program Files") con- tains a space which would otherwise be misinterpreted. - [1m$lpr_dvi ["NONE lpr_dvi"][0m + $lpr_dvi ["NONE lpr_dvi"] The printing program to print dvi files. - [1m$lpr_pdf ["NONE lpr_pdf"][0m + $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 @@ -1201,8 +1192,7 @@ LATEXMK(1L) LATEXMK(1L) - - 30 September 2008 18 + 1 December 2008 18 @@ -1211,11 +1201,11 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - [1m$makeindex ["makeindex %O -o %D %S"][0m + $makeindex ["makeindex %O -o %D %S"] The index processing program. - [1m$max_repeat [5][0m - The maximum number of times [4mlatexmk[24m will run latex/pdflatex + $max_repeat [5] + The maximum number of times latexmk will run latex/pdflatex before deciding that there may be an infinite loop and that it needs to bail out, rather than rerunning latex/pdflatex again to resolve cross-references, etc. The default value covers all @@ -1224,55 +1214,52 @@ LATEXMK(1L) LATEXMK(1L) (Note that the "etc" covers a lot of cases where one run of latex/pdflatex generates files to be read in on a later run.) - [1m$new_viewer_always [0][0m - This variable applies to [4mlatexmk[24m [1monly [22min continuous-preview - mode. If [4m$new_viewer_always[24m is 0, [4mlatexmk[24m will check for a pre- + $new_viewer_always [0] + This variable applies to latexmk only in continuous-preview + mode. If $new_viewer_always is 0, latexmk will check for a pre- viously running previewer on the same file, and if one is run- - ning will not start a new one. If [4m$new_viewer_always[24m is non- - zero, this check will be skipped, and [4mlatexmk[24m will behave as if + ning will not start a new one. If $new_viewer_always is non- + zero, this check will be skipped, and latexmk will behave as if no viewer is running. - [1m$pdf_mode [0][0m + $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 pdfla- tex. If equal to 2, generate a pdf version of the document from - the ps file, by using the command specified by the [4m$ps2pdf[24m vari- + the ps file, by using the command specified by the $ps2pdf vari- able. If equal to 3, generate a pdf version of the document - from the dvi file, by using the command specified by the [4m$dvipdf[0m + from the dvi file, by using the command specified by the $dvipdf variable. - Equivalent to the [1m-pdf-[22m, [1m-pdf[22m, [1m-pdfdvi[22m, [1m-pdfps [22moptions. + Equivalent to the -pdf-, -pdf, -pdfdvi, -pdfps options. - [1m$pdflatex ["pdflatex %O %S"][0m + $pdflatex ["pdflatex %O %S"] The LaTeX processing program in the version that makes a pdf file instead of a dvi file. - [1m$pdflatex_silent_switch ["-interaction=batchmode"][0m + $pdflatex_silent_switch ["-interaction=batchmode"] Switch(es) for the pdflatex program (specified in the variable - [4m$pdflatex[24m when silent mode is on. Under MS-Windows, the default + $pdflatex 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. - [1m$pdf_previewer ["start acroread %O %S"][0m + $pdf_previewer ["start acroread %O %S"] 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 asso- ciated with .pdf files.] - [1mWARNING[22m: Potential problem under MS-Windows: if acroread is used + WARNING: 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 [4mlatexmk[24m's previous-continuous mode (option - [1m-pvc[22m) under MS-windows. This problem does not occur if + previewer if you use latexmk's previous-continuous mode (option + -pvc) under MS-windows. This problem does not occur if ghostview, gv or gsview is used to view pdf files. - [1m$pdf_update_command [""][0m - When the pdf previewer is set to be updated by running a com- - mand, this is the command that is run. See the information for - 30 September 2008 19 + 1 December 2008 19 @@ -1281,16 +1268,19 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - the variable [4m$pdf_update_method[24m. + $pdf_update_command [""] + When the pdf previewer is set to be updated by running a com- + mand, this is the command that is run. See the information for + the variable $pdf_update_method. - [1m$pdf_update_method [1 under UNIX, 3 under MS-Windows][0m + $pdf_update_method [1 under UNIX, 3 under MS-Windows] How the pdf viewer updates its display when the pdf file has - changed. See the information on the variable [4m$dvi_update_method[0m + changed. See the information on the variable $dvi_update_method for the codes. (Note that information needs be changed slightly so that for the value 4, to run a command to do the update, the - command is specified by the variable [4m$pdf_update_command[24m, and + command is specified by the variable $pdf_update_command, and for the value 2, to specify update by signal, the signal is - specified by [4m$pdf_update_signal[24m.) + specified by $pdf_update_signal.) Note that acroread under MS-Windows (but not UNIX) locks the pdf file, so the default value is then 3. @@ -1309,40 +1299,34 @@ LATEXMK(1L) LATEXMK(1L) ting sets the update command. - [1m$pdf_update_signal [Under UNIX: SIGHUP, which is a system-dependent[0m - [1mvalue][0m + $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 the information on the - variable [4m$pdf_update_method[24m. The default value is the one + variable $pdf_update_method. The default value is the one appropriate for gv on a UNIX system. - [1m$pid_position[1 under UNIX, -1 under MS-Windows][0m - The variable [4m$pid_position[24m is used to specify which word in - lines of the output from [4m$pscmd[24m corresponds to the process ID. + $pid_position[1 under UNIX, -1 under MS-Windows] + 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. Set- - ting the variable to -1 is used to indicate that [4m$pscmd[24m is not + ting the variable to -1 is used to indicate that $pscmd is not to be used. - [1m$postscript_mode [0][0m + $postscript_mode [0] If nonzero, generate a postscript version of the document. - Equivalent to the [1m-ps [22moption. + Equivalent to the -ps option. - [1m$preview_continuous_mode [0][0m + $preview_continuous_mode [0] If nonzero, run a previewer to view the document, and continue - running [4mlatexmk[24m to keep .dvi up-to-date. Equivalent to the [1m-pvc[0m + running latexmk to keep .dvi up-to-date. Equivalent to the -pvc option. Which previewer is run depends on the other settings, - see the command line options [1m-view=[22m, and the variable [4m$view[24m. - - [1m$preview_mode [0][0m - If nonzero, run a previewer to preview the document. Equivalent - to the [1m-pv [22moption. Which previewer is run depends on the other - settings, see the command line options [1m-view=[22m, and the variable - [4m$view[24m. + see the command line options -view=, and the variable $view. - 30 September 2008 20 + 1 December 2008 20 @@ -1351,41 +1335,47 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - [1m$printout_mode [0][0m - If nonzero, print the document using [4mlpr[24m. Equivalent to the [1m-p[0m - option. This is recommended [1mnot [22mto be set from an RC file, oth- + $preview_mode [0] + If nonzero, run a previewer to preview the document. Equivalent + to the -pv option. Which previewer is run depends on the other + settings, see the command line options -view=, and the variable + $view. + + $printout_mode [0] + If nonzero, print the document using lpr. Equivalent to the -p + option. This is recommended not to be set from an RC file, oth- erwise you could waste lots of paper. - [1m$print_type = ["ps"][0m + $print_type = ["ps"] Type of file to printout: possibilities are "dvi", "none", "pdf", or "ps". - [1m$pscmd [22mCommand used to get all the processes currently run by the user. + $pscmd Command used to get all the processes currently run by the user. The -pvc option uses the command specified by the variable - [4m$pscmd[24m to determine if there is an already running previewer, - and to find the process ID (needed if [4mlatexmk[24m needs to signal + $pscmd to determine if there is an already running previewer, + and to find the process ID (needed if latexmk needs to signal the previewer about file changes). Each line of the output of this command is assumed to correspond - to one process. See the [4m$pid_position[24m variable for how the pro- + to one process. See the $pid_position variable for how the pro- cess number is determined. - The default for [4mpscmd[24m is "NONE" under MS-Windows and cygwin + The default for pscmd is "NONE" under MS-Windows and cygwin (i.e., the command is not used), "ps --width 200 -f -u $ENV{USER}" under linux, "ps -ww -u $ENV{USER}" under darwin (Macintosh OS-X), and "ps -f -u $ENV{USER}" under other operat- ing systems (including other flavors of UNIX). In these speci- fications "$ENV{USER}" is substituted by the username. - [1m$ps2pdf ["ps2pdf %O %S %D"][0m + $ps2pdf ["ps2pdf %O %S %D"] Command to convert ps to pdf file. - [1m$ps_filter [empty][0m + $ps_filter [empty] The postscript file filter to be run on the newly produced postscript file before other processing. Equivalent to specify- - ing the [1m-pF [22moption. + ing the -pF option. - [1m$ps_previewer ["start gv %O %S", but "start %O %S" under MS-WINDOWS][0m + $ps_previewer ["start gv %O %S", but "start %O %S" under MS-WINDOWS] The command to invoke a ps-previewer. (The default under MS- WINDOWS will cause to be run whatever command the system has associated with .ps files.) @@ -1396,93 +1386,81 @@ LATEXMK(1L) LATEXMK(1L) ferent ways of writing this option. You can configure this variable apppropriately. - [1mWARNING[22m: Linux systems may have installed one (or more) versions + WARNING: Linux systems may have installed one (or more) versions of gv under different names, e.g., ggv, kghostview, etc, but perhaps not one called gv. - [1m$ps_previewer_landscape ["start gv -swap %O %S", but "start %O %S"[0m - [1munder MS-WINDOWS][0m - The command to invoke a ps-previewer in landscape mode. - [1m$ps_update_command [""][0m - 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 [4m$ps_update_method[24m. + 1 December 2008 21 - 30 September 2008 21 +LATEXMK(1L) LATEXMK(1L) -LATEXMK(1L) LATEXMK(1L) + $ps_previewer_landscape ["start gv -swap %O %S", but "start %O %S" + under MS-WINDOWS] + The command to invoke a ps-previewer in landscape mode. + $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 $ps_update_method. - [1m$ps_update_method [0 under UNIX, 1 under MS-Windows][0m + $ps_update_method [0 under UNIX, 1 under MS-Windows] How the postscript viewer updates its display when the ps file has changed. See the information on the variable - [4m$dvi_update_method[24m for the codes. (Note that information needs + $dvi_update_method for the codes. (Note that information needs be changed slightly so that for the value 4, to run a command to do the update, the command is specified by the variable - [4m$ps_update_command[24m, and for the value 2, to specify update by - signal, the signal is specified by [4m$ps_update_signal[24m.) + $ps_update_command, and for the value 2, to specify update by + signal, the signal is specified by $ps_update_signal.) - [1m$ps_update_signal [Under UNIX: SIGHUP, which is a system-dependent[0m - [1mvalue][0m + $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 [4m$ps_update_method[24m. The + is updated by sending a signal -- see $ps_update_method. The default value is the one appropriate for gv on a UNIX system. - [1m$sleep_time [2][0m + $sleep_time [2] The time to sleep (in seconds) between checking for source file - changes when running the [1m-pvc [22moption. + changes when running the -pvc option. - [1m$texfile_search [""][0m - This is an obsolete variable, replaced by the [4m@default_files[0m + $texfile_search [""] + This is an obsolete variable, replaced by the @default_files variable. - For backward compatibility, if you choose to set [4m$tex-[0m - [4mfile_search[24m, it is a string of space-separated filenames, and - then [4mlatexmk[24m replaces [4m@default_files[24m with the filenames in [4m$tex-[0m - [4mfile_search[24m to which is added "*.tex". + For backward compatibility, if you choose to set $tex- + file_search, it is a string of space-separated filenames, and + then latexmk replaces @default_files with the filenames in $tex- + file_search to which is added "*.tex". - [1m$tmpdir [See below for default][0m - Directory to store temporary files that [4mlatexmk[24m may generate + $tmpdir [See below for default] + Directory to store temporary files that latexmk may generate while running. The default under MSWindows (including cygwin), is to set - [4m$tmpdir[24m to the value of the first of whichever of the system + $tmpdir 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 variable TMPDIR if it exists, otherwise "/tmp". - [1m$view ["default"][0m + $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). -[1mCUSTOM DEPENDENCIES[0m - 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 [4mlatexmk[24m to convert a [4m.fig[24m file to [4m.eps[24m to be included - in the [4m.tex[24m file. - - The old method of configuring [4mlatexmk[24m was to directly manipulate the - [1m@cus_dep_list [22marray that contains information defining the custom - dependencies. This method still works. But now there are subroutines - that allow convenient manipulations of the custom dependency list. - - - 30 September 2008 22 + 1 December 2008 22 @@ -1491,6 +1469,16 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) +CUSTOM DEPENDENCIES + 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 latexmk to convert a .fig file to .eps to be included + in the .tex file. + + The old method of configuring latexmk was to directly manipulate the + @cus_dep_list array that contains information defining the custom + dependencies. This method still works. But now there are subroutines + that allow convenient manipulations of the custom dependency list. These are add_cus_dep( fromextension, toextension, must, subroutine ) @@ -1500,84 +1488,84 @@ LATEXMK(1L) LATEXMK(1L) The custom dependency is a list of rules, each of which is specified as follow: - [1mfrom extension:[0m + from extension: The extension of the file we are converting from (e.g. "fig"). It is specified without a period. - [1mto extension:[0m + to extension: The extension of the file we are converting to (e.g. "eps"). It is specified without a period. - [1mmust: [22mIf non-zero, the file from which we are converting [1mmust [22mexist, - if it doesn't exist [4mlatexmk[24m will give an error message and exit - unless the [1m-f [22moption is specified. If [4mmust[24m is zero and the file + must: If non-zero, the file from which we are converting must exist, + if it doesn't exist latexmk will give an error message and exit + unless the -f option is specified. If must is zero and the file we are converting from doesn't exist, then no action is taken. - [1mfunction:[0m - The name of the subroutine that [4mlatexmk[24m should call to perform + function: + The name of the subroutine that latexmk 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 [4mPerl[24m. The func- + The subroutines are declared in the syntax of Perl. The func- tion should return 0 if it was successful and a nonzero number if it failed. - It is invoked whenever [4mlatexmk[24m detects that a run of latex/pdflatex + It is invoked whenever latexmk detects that a run of latex/pdflatex needs to read a file, like a graphics file, whose extension is the to- - extension of a custom dependency. Then [4mlatexmk[24m examines whether a file + extension of a custom dependency. Then latexmk examines whether a file exists with the same name, but with the corresponding from-extension, as specified in the custom-dependency rule. If it does, then whenever the destination file (the one with the to-extension) is out-of-date with respect to the corresponding source file. - To make the new destination file, the [4mPerl[24m subroutine specified in the + To make the new destination file, the Perl subroutine specified in the rule is invoked, with an argument that is the base name of the files in question. Simple cases just involve a subroutine invoking an external program; this can be done by following the templates below, even by - those without knowledge of the [4mPerl[24m programming language. Of course, + those without knowledge of the Perl programming language. Of course, experts could do something much more elaborate. - One other item in each custom-dependency rule labelled "must" above - specifies how the rule should be applied when the source file fails to - exist. - A simple and typical example of code in an initialization rcfile is - add_cus_dep( 'fig', 'eps', 0, 'fig2eps' ); - sub fig2eps { - system("fig2dev -Leps $_[0].fig $_[0].eps"); - } - The first line adds a custom dependency that converts a file with - extension "fig", as created by the xfig program, to an encapsulated + 1 December 2008 23 - 30 September 2008 23 +LATEXMK(1L) LATEXMK(1L) + One other item in each custom-dependency rule labelled "must" above + specifies how the rule should be applied when the source file fails to + exist. -LATEXMK(1L) LATEXMK(1L) + A simple and typical example of code in an initialization rcfile is + add_cus_dep( 'fig', 'eps', 0, 'fig2eps' ); + sub fig2eps { + system("fig2dev -Leps $_[0].fig $_[0].eps"); + } + The first line adds a custom dependency that converts a file with + extension "fig", as created by the xfig program, to an encapsulated postscript file, with extension "eps". The remaining lines define a subroutine that carries out the conversion. If a rule for converting "fig" to "eps" files already exists (e.g., from a previously read-in - initialization file), the [4mlatexmk[24m will delete this rule before making + initialization file), the latexmk will delete this rule before making the new one. - Suppose [4mlatexmk[24m is using this rule to convert a file "figure.fig" to + Suppose latexmk is using this rule to convert a file "figure.fig" to "figure.eps". Then it will invoke the fig2eps subroutine defined in the above code with a single argument "figure", which is the basename of each of the files (possibly with a path component). This argument - is referred to by [4mPerl[24m as $_[0]. In the example above, the subroutine - uses the [4mPerl[24m command system to invoke the program fig2dev. The double - quotes around the string are a [4mPerl[24m idiom that signify that each string + is referred to by Perl as $_[0]. In the example above, the subroutine + uses the Perl command system to invoke the program fig2dev. The double + quotes around the string are a Perl idiom that signify that each string of the form of a variable name, $_[0] in this case, is to be substi- tuted by its value. - If the return value of the subroutine is non-zero, then [4mlatexmk[24m will + If the return value of the subroutine is non-zero, then latexmk will assume an error occurred during the execution of the subroutine. In the above example, no explicit return value is given, and instead the return value is the value returned by the last (and only) statement, @@ -1593,17 +1581,28 @@ LATEXMK(1L) LATEXMK(1L) system("fig2dev -Lps '$_[0].fig' '$_[0].eps'"); } - This causes the invocation of the [4mfig2dev[24m program to have quoted file- - names; it should therefore work with filenames containing spaces. [1mHow-[0m - [1mever, not all software deals correctly with filenames that contain[0m - [1mspaces. Moreover, the rules, if any, for quoting filenames vary[0m - [1mbetween operating systems, command shells and individual pieces of[0m - [1msoftware, so this code may not always work.[0m + This causes the invocation of the fig2dev program to have quoted file- + names; it should therefore work with filenames containing spaces. How- + ever, not all software deals correctly with filenames that contain + spaces. Moreover, the rules, if any, for quoting filenames vary + between operating systems, command shells and individual pieces of + software, so this code may not always work. If you use pdflatex instead of latex, then you will probably prefer to convert your graphics files to pdf format, in which case you would replace the above code in an initialization file by + + + 1 December 2008 24 + + + + + +LATEXMK(1L) LATEXMK(1L) + + add_cus_dep( 'fig', 'pdf, 0, 'fig2pdf' ); sub fig2pdf { system("fig2dev -Lpdf $_[0].fig $_[0].pdf"); @@ -1620,31 +1619,20 @@ LATEXMK(1L) LATEXMK(1L) get a listing of the custom dependencies. This is done by using the line - - - 30 September 2008 24 - - - - - -LATEXMK(1L) LATEXMK(1L) - - show_cus_dep(); in an initialization file. Another example of a custom dependency overcomes a limitation of - [4mlatexmk[24m concerning index files. The only index-file conversion built- - in to [4mlatexmk[24m is from an ".idx" file written on one run of latex/pdfla- + latexmk concerning index files. The only index-file conversion built- + in to latexmk is from an ".idx" file written on one run of latex/pdfla- tex to an ".ind" file to be read in on a subsequent run. But with the index.sty package you can create extra indexes with extensions that you - configure. [4mLatexmk[24m does not know how to deduce the extensions from the + configure. Latexmk does not know how to deduce the extensions from the information it has. But you can easily write a custom dependency. For example if your latex file uses the command "\newindex{spe- cial}{ndx}{nnd}{Special index}" you will need to convert files with the - extension [4m.ndx[24m to [4m.nnd[24m. The following lines in an initialization RC + extension .ndx to .nnd. The following lines in an initialization RC file will cause this to happen: add_cus_dep('ndx', 'nnd', 0, 'makendx2nnd'); @@ -1656,26 +1644,36 @@ LATEXMK(1L) LATEXMK(1L) them, to provide correct quoting of the filenames.) Those of you with experience with Makefiles, will undoubtedly be con- - cerned that the [4m.ndx[24m file is written during a run of latex/pdflatex and - is always later than the [4m.nnd[24m last read in. Thus the [4m.nnd[24m appears to + cerned that the .ndx file is written during a run of latex/pdflatex and + is always later than the .nnd last read in. Thus the .nnd appears to be perpetually out-of-date. This situation, of circular dependencies, - is endemic to latex, and [4mlatexmk[24m in its current version works correctly + is endemic to latex, and latexmk in its current version works correctly with circular dependencies. It examines the contents of the files (by use of an md5 checksum), and only does a remake when the file contents have actually changed. - Of course if you choose to write random data to the [4m.nnd[24m (or and [4m.aux[0m + Of course if you choose to write random data to the .nnd (or and .aux file, etc) that changes on each new run, then you will have a problem. - For real experts: See the [4m%hash_cal_ignore_pattern[24m if you have to deal + For real experts: See the %hash_cal_ignore_pattern if you have to deal with such problems. Glossaries can be dealt with similarly. -[1mOLD METHOD OF DEFINING CUSTOM DEPENDENCIES[0m - In previous versions of [4mlatexmk[24m, the only method of defining custom + + 1 December 2008 25 + + + + + +LATEXMK(1L) LATEXMK(1L) + + +OLD METHOD OF DEFINING CUSTOM DEPENDENCIES + In previous versions of latexmk, the only method of defining custom dependencies was to directly manipulate the table of custom dependen- - cies. This is contained in the [1m@cus_dep_list [22marray. It is an array of + cies. This is contained in the @cus_dep_list array. It is an array of strings, and each string in the array has four items in it, each sepa- rated by a space, the from-extension, the to-extension, the "must" item, and the name of the subroutine for the custom dependency. These @@ -1683,34 +1681,23 @@ LATEXMK(1L) LATEXMK(1L) An example of the old method of defining custom dependencies is as fol- lows. It is the code in an RC file to ensure automatic conversion of - [4m.fig[24m files to [4m.eps[24m files: + .fig files to .eps files: push @cus_dep_list, "fig eps 0 fig2eps"; sub fig2eps { system("fig2dev -Lps $_[0].fig $_[0].eps"); } - - - 30 September 2008 25 - - - - - -LATEXMK(1L) LATEXMK(1L) - - This method still works, and is equivalent to the earlier code using the add_cus_dep subroutine, except that it doesn't delete any previous custom-dependency for the same conversion. So the new method is preferable. -[1mSEE ALSO[0m +SEE ALSO latex(1), bibtex(1). -[1mBUGS[0m +BUGS Sometimes a viewer (gv) tries to read an updated .ps or .pdf file after its creation is started but before the file is complete. Work around: manually refresh (or reopen) display. Or use one of the other preview- @@ -1725,20 +1712,31 @@ LATEXMK(1L) LATEXMK(1L) 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 - pdf file cannot be updated. (Remedy: configure [4mlatexmk[24m to use gsview + pdf file cannot be updated. (Remedy: configure latexmk to use gsview instead.) -[1mTHANKS TO[0m +THANKS TO Authors of previous versions. Many users with their feedback, and especially David Coppit (username david at node coppit.org) who made many useful suggestions that contributed to version 3, and Herbert Schulz. (Please note that the e-mail addresses are not written in their standard form to avoid being harvested by worms and viruses.) -[1mAUTHOR[0m +AUTHOR Current version, by John Collins (username collins at node phys.psu.edu). (Version 4.01a). + + + 1 December 2008 26 + + + + + +LATEXMK(1L) LATEXMK(1L) + + Released version (last was 4.01) can be obtained from CTAN: <http://www.tug.org/tex-archive/support/latexmk/>, and from the author's website <http://www.phys.psu.edu/~collins/software/latexmk/>. @@ -1762,6 +1760,41 @@ LATEXMK(1L) LATEXMK(1L) - 30 September 2008 26 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + 1 December 2008 27 |