diff -dur latexmk-4.00e.ORIG/latexmk.1 latexmk-4.00e/latexmk.1 --- latexmk-4.00e.ORIG/latexmk.1 2008-03-12 09:34:24.000000000 -0600 +++ latexmk-4.00e/latexmk.1 2008-09-24 10:05:29.000000000 -0600 @@ -1,9 +1,9 @@ -.TH LATEXMK 1L "12 March 2008" "" -.SH NAME +.TH "LATEXMK" "1L" "12 March 2008" "" "" +.SH "NAME" latexmk \- generate LaTeX document -.SH SYNOPSIS +.SH "SYNOPSIS" .B latexmk [options] [file ...] -.SH DESCRIPTION +.SH "DESCRIPTION" .I Latexmk completely automates the process of compiling a LaTeX document. Essentially, it is like a specialized relative of the general @@ -15,8 +15,8 @@ document. It can also be set to run continuously with a suitable previewer; in that case the LaTeX program, etc, are rerun whenever one of the source files is modified, and the previewer updates the -on-screen view of the compiled document. -.PP +on\-screen view of the compiled document. +.PP \fILatexmk\fR determines which are the source files by examining the log file. When \fIlatexmk\fR is run, it examines properties of the source files, and if any have been changed since the last document @@ -30,14 +30,14 @@ For example, from an updated figure file it can automatically generate a file in encapsulated postscript or another suitable format for reading by LaTeX. -.PP +.PP \fILatexmk\fR has two different previewing options. In the simple -\fB-pv\fR option, a dvi, postscript or pdf previewer is automatically +\fB\-pv\fR option, a dvi, postscript or pdf previewer is automatically run after generating the dvi, postscript or pdf version of the document. The type of file to view is selected according to configuration settings and command line options. -.PP -The second previewing option is the powerful \fB-pvc\fR option +.PP +The second previewing option is the powerful \fB\-pvc\fR option (mnemonic: "preview continuously"). In this case, \fIlatexmk\fR runs continuously, regularly monitoring all the source files to see if any have changed. Every time a change is detected, \fIlatexmk\fR runs all @@ -47,31 +47,31 @@ are written to disk, \fIlatexmk\fR completely automates the cycle of updating the .dvi (and possibly the .ps and .pdf) file, and refreshing the previewer's display. It's not quite WYSIWYG, but usefully close. -.PP +.PP For other previewers, the user may have to manually make the previewer update its display, which can be (some versions of xdvi and gsview) as simple as forcing a redraw of its display. -.PP +.PP \fILatexmk\fR has the ability to print a banner in gray diagonally across each page when making the postscript file. It can also, if needed, call an external program to do other postprocessing on the generated files. -.PP +.PP \fILatexmk\fR is highly configurable, both from the command line and in configuration files, so that it can accommodate a wide variety of user needs and system configurations. Default values are set according to the operating system, so \fIlatexmk\fR often works -without special configuration on MS-Windows, cygwin, Linux, OS-X, and +without special configuration on MS\-Windows, cygwin, Linux, OS\-X, and other UNIX systems (notably Solaris). -.PP +.PP A very annoying complication handled very reliably by \fILatexmk\fR, is that LaTeX is a multiple pass system. On each run, LaTeX reads in information generated on a previous run, for things like cross referencing and indexing. In the simplest cases, a second run of LaTeX suffices, and often the log file contains a message about the -need for another pass. However, there is a wide variety of add-on +need for another pass. However, there is a wide variety of add\-on macro packages to LaTeX, with a variety of behaviors. The result is -to break simple-minded determinations of how many runs are needed and +to break simple\-minded determinations of how many runs are needed and of which programs. In its new version, \fIlatexmk\fR has a highly general and efficient solution to these issues. The solution involves retaining between runs information on the source files, and a symptom @@ -79,10 +79,10 @@ \fR.fdb_latexmk\fR, by default) that contains the source file information. -.SH LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE -(All options can be introduced by single or double "-" characters, -e.g., "latexmk -help" or "latexmk --help".) -.TP +.SH "LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE" +(All options can be introduced by single or double "\-" characters, +e.g., "latexmk \-help" or "latexmk \-\-help".) +.TP .B file One or more files can be specified. If no files are specified, \fIlatexmk\fR will, by default, run on all files in the current working directory @@ -97,32 +97,32 @@ latexmk foo then \fIlatexmk\fR will operate on the file "foo.tex". -.TP -.B -bm +.TP +.B \-bm A banner message to print diagonally across each page when converting the dvi file to postscript. The message must be a single argument on the command line so be careful with quoting spaces and such. -Note that if the \fB-bm\fR option is specified, the \fB-ps\fR option is +Note that if the \fB\-bm\fR option is specified, the \fB\-ps\fR option is assumed. -.TP -.B -bi +.TP +.B \-bi 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. -.TP -.B -bs +.TP +.B \-bs 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 220.0 which is just right for 5 character messages. .TP -.B -commands +.B \-commands List the commands used by \fIlatexmk\fR for processing files, and then exit. .TP -.B -c +.B \-c 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 @@ -131,44 +131,44 @@ removed. But the file containing a database of source file information is not removed. -This cleanup is instead of a regular make. See the \fB-gg\fR option +This cleanup is instead of a regular make. See the \fB\-gg\fR option if you want to do a cleanup then a make. .TP -.B -C +.B \-C Clean up (remove) all regeneratable files generated by \fIlatex\fR and -\fIbibtex\fR. This is the same as the \fB-c\fR option with the +\fIbibtex\fR. This is the same as the \fB\-c\fR option with the addition of dvi, postscript and pdf files, and those with extensions in the \fI$clean_full_ext\fR configuration variable. -This cleanup is instead of a regular make. See the \fB-gg\fR option +This cleanup is instead of a regular make. See the \fB\-gg\fR option if you want to do a cleanup than a make. .TP -.B -CA +.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 +action specified by \fB\-C\fR with the addition of deleting the file containing the database of source file information. -This cleanup is instead of a regular make. It is the same as \fB-C --CF\fR. See the \fB-gg\fR option if you want to do a cleanup then a +This cleanup is instead of a regular make. It is the same as \fB\-C +\-CF\fR. See the \fB\-gg\fR option if you want to do a cleanup then a make. .TP -.B -CF +.B \-CF Remove the file containing a database of source file information, before doing the other actions requested. .TP -.B -d +.B \-d Set draft mode. This prints the banner message "DRAFT" across your page when converting the dvi file to postscript. Size and intensity -can be modified with the \fB-bs\fR and \fB-bi\fR options. The \fB-bm\fR +can be modified with the \fB\-bs\fR and \fB\-bi\fR options. The \fB\-bm\fR option will override this option as this is really just a short way of specifying: - latexmk -bm DRAFT + latexmk \-bm DRAFT -Note that if the \fB-d\fR option is specified, the \fB-ps\fR option is +Note that if the \fB\-d\fR option is specified, the \fB\-ps\fR option is assumed. -.TP -.B -dF +.TP +.B \-dF Dvi file filtering. The argument to this option is a filter which will generate a filtered dvi file with the extension ".dviF". All extra processing (e.g. conversion to postscript, preview, printing) will then @@ -176,145 +176,145 @@ Example usage: To use dviselect to select only the even pages of the dvi file: - latexmk -dF 'dviselect even' foo.tex -.TP -.B -diagnostics + latexmk \-dF 'dviselect even' foo.tex +.TP +.B \-diagnostics Print detailed diagnostics during a run. This may help for debugging problems or to understand \fI.latexmk\fR's behavior in difficult situations. -.TP -.B -dvi +.TP +.B \-dvi Generate dvi version of document. -.TP -.B -dvi- +.TP +.B \-dvi\- Turn off generation of dvi version of document. (This may get overridden, if some other file is made (e.g., a .ps file) that is generated from the dvi file, or if no generated file at all is requested.) -.TP -.B -e +.TP +.B \-e Execute the specified initialization code before processing. The code is \fIPerl\fR code of the same form as is used in \fIlatexmk\fR's -initialization files -- for more details, see the information on the -\fB-r\fR option, and the section about "Configuration/initialization +initialization files \-\- for more details, see the information on the +\fB\-r\fR option, and the section about "Configuration/initialization (RC) files". The code is typically a sequence of assignment statements separated by semicolons. -The code is executed when the \fB-e\fR option is encountered during -\fIlatexmk\fR's parsing of its command line. See the \fB-r\fR option +The code is executed when the \fB\-e\fR option is encountered during +\fIlatexmk\fR's parsing of its command line. See the \fB\-r\fR option for a way of executing initialization code from a file. An error -results in \fIlatexmk\fR stopping. Multiple instances of the \fB-r\fR -and \fB-e\fR options can be used, and they are executed in the order +results in \fIlatexmk\fR stopping. Multiple instances of the \fB\-r\fR +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 -to set the latex command to use its -shell-escape option, then under +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 + 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.) -.TP -.B -f +operating\-system.) +.TP +.B \-f Force \fIlatexmk\fR to continue document processing despite errors. Normally, when \fIlatexmk\fR detects that LaTeX or another program has found an error which will not be resolved by further processing, no further processing is carried out. -.TP -.B -f- -Turn off the forced processing-past-errors such as is set by the -\fB-f\fR option. This could be used to override a setting in a +.TP +.B \-f\- +Turn off the forced processing\-past\-errors such as is set by the +\fB\-f\fR option. This could be used to override a setting in a configuration file. -.TP -.B -g +.TP +.B \-g Force \fIlatexmk\fR to process document fully, even under situations where \fIlatexmk\fR 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. -.TP -.B -g- -Turn off \fB-g\fR. -.TP -.B -gg +.TP +.B \-g\- +Turn off \fB\-g\fR. +.TP +.B \-gg "Super go mode" or "clean make": clean out generated files as if -\fB-CA\fR had been given, and then do a regular make. -.TP -.B -h, -help +\fB\-CA\fR had been given, and then do a regular make. +.TP +.B \-h, \-help Print help information. -.TP -.B -l +.TP +.B \-l Run in landscape mode, using the landscape mode for the previewers and the dvi to postscript converters. This option is not normally needed nowadays, since current previewers normally determine this information automatically. -.TP -.B -l- -Turn off \fB-l\fR. -.TP -.B -new-viewer -When in continuous-preview mode, always start a new viewer to view the -generated file. By default, \fIlatexmk\fR will, in continuous-preview +.TP +.B \-l\- +Turn off \fB\-l\fR. +.TP +.B \-new\-viewer +When in continuous\-preview mode, always start a new viewer to view the +generated file. By default, \fIlatexmk\fR will, in continuous\-preview mode, test for a previously running previewer for the same file and not start a new one if a previous previewer is running. However, its -test sometimes fails (notably if there is an already-running previewer +test sometimes fails (notably if there is an already\-running previewer that is viewing a file of the same name as the current file, but in a different directory). This option turns off this default behavior. -.TP -.B -new-viewer- -The inverse of the \fB-new-viewer\fR option. It puts \fIlatexmk\fR -in its normal behavior that in preview-continuous mode it checks for -an already-running previewer. -.TP -.B -p +.TP +.B \-new\-viewer\- +The inverse of the \fB\-new\-viewer\fR option. It puts \fIlatexmk\fR +in its normal behavior that in preview\-continuous mode it checks for +an already\-running previewer. +.TP +.B \-p Print out the document. By default on a UNIX or Linux system, this is done using lpr after generating the postscript file. But you can use -the \fB-print=...\fR option to print the dvi or pdf files instead, and +the \fB\-print=...\fR option to print the dvi or pdf files instead, and you can configure this in a start up file (by setting the \fI$print_type\fR variable). However, the correct behavior for printing very much depends on your -system's software. In particular, under MS-Windows you must have +system's software. In particular, under MS\-Windows you must have suitable program(s) available, and you must have configured the print -commands used by \fIlatexmk\fR. This can be non-trivial. +commands used by \fIlatexmk\fR. This can be non\-trivial. -This option is incompatible with the \fB-pv\fR and \fB-pvc\fR options, +This option is incompatible with the \fB\-pv\fR and \fB\-pvc\fR options, so it turns them off. -.TP -.B -pdf +.TP +.B \-pdf Generate pdf version of document using pdflatex. -.TP -.B -pdfdvi +.TP +.B \-pdfdvi Generate pdf version of document from the dvi file, by default using dvipdf. -.TP -.B -pdfps +.TP +.B \-pdfps Generate pdf version of document from the ps file, by default using ps2pdf. -.TP -.B -pdf- +.TP +.B \-pdf\- Turn off generation of pdf version of document. (This can be used to override a setting in a configuration file. It may get overridden if some other option requires the generation of a pdf file.) -.TP -.B -print=dvi, -print=ps, -print=pdf +.TP +.B \-print=dvi, \-print=ps, \-print=pdf Define which kind of file is printed. This option also ensures that the requisite file is made, and turns on printing. -.TP -.B -ps +.TP +.B \-ps Generate postscript version of document. -.TP -.B -ps- +.TP +.B \-ps\- Turn off generation of postscript version of document. This can be used to override a setting in a configuration file. (It may get overridden by some other option that requires a postscript file, for example a request for printing.) -.TP -.B -pF +.TP +.B \-pF Postscript file filtering. The argument to this option is a filter which will generate a filtered postscript file with the extension ".psF". All extra processing (e.g. preview, printing) will then be @@ -322,51 +322,51 @@ Example of usage: Use psnup to print two pages on the one page: - latexmk -ps -pF 'psnup -2' foo.tex + latexmk \-ps \-pF 'psnup \-2' foo.tex or - latexmk -ps -pF "psnup -2" foo.tex + latexmk \-ps \-pF "psnup \-2" foo.tex -Whether to use single or double quotes round the "psnup -2" will depend on +Whether to use single or double quotes round the "psnup \-2" will depend on your command interpreter, in particular on the operating system. -.TP -.B -pv -Run file previewer. If the \fB-view\fR option is used, this will select +.TP +.B \-pv +Run file previewer. If the \fB\-view\fR option is used, this will select the kind of file to be previewed (dvi, ps or pdf). Otherwise the viewer views the "highest" kind of file selected, by the -\fB-dvi\fR, \fB-ps\fR, \fB-pdf\fR, \fB-pdfps\fR options, in the +\fB\-dvi\fR, \fB\-ps\fR, \fB\-pdf\fR, \fB\-pdfps\fR options, in the order dvi, ps, pdf (low to high). If no file type has been selected, the dvi previewer will be used. -This option is incompatible with the \fB-p\fR and \fB-pvc\fR options, +This option is incompatible with the \fB\-p\fR and \fB\-pvc\fR options, so it turns them off. -.TP -.B -pv- -Turn off \fB-pv\fR. -.TP -.B -pvc +.TP +.B \-pv\- +Turn off \fB\-pv\fR. +.TP +.B \-pvc Run a file previewer and continually update the .dvi, .ps, and/or .pdf files whenever changes are made to source files (see the Description above). Which of these files is generated and which is viewed is -governed by the other options, and is the same as for the \fB-pv\fR +governed by the other options, and is the same as for the \fB\-pv\fR option. -The preview-continuous option \fB-pvc\fR can only work with one file. +The preview\-continuous option \fB\-pvc\fR can only work with one file. So in this case you will normally only specify one filename on the command line. It is also incompatible with the -\fB-p\fR and \fB-pv\fR options, so it turns these options off +\fB\-p\fR and \fB\-pv\fR options, so it turns these options off With a good previewer the display will be automatically updated. -(Under \fIsome but not all\fR versions of UNIX/Linux "gv -watch" does +(Under \fIsome but not all\fR versions of UNIX/Linux "gv \-watch" does this for postscript files; this can be set by a configuration variable. This would also work for pdf files except for an apparent bug in gv that causes an error when the newly updated pdf file is read.) Many other previewers will need a manual update. -Important note: the acroread program on MS-Windows locks the pdf file, +Important note: the acroread program on MS\-Windows locks the pdf file, and prevents new versions being written, so it is a bad idea to use -acroread to view pdf files in preview-continuous mode. It is better -to use a dvi or ps viewer, as set by one of the \fB-view=dvi\fR and -\fB-view=ps\fR options. +acroread to view pdf files in preview\-continuous mode. It is better +to use a dvi or ps viewer, as set by one of the \fB\-view=dvi\fR and +\fB\-view=ps\fR options. There are some other methods for arranging an update, notably useful for many versions of xdvi and xpdf. These are best set in @@ -374,26 +374,26 @@ Note that if \fIlatexmk\fR dies or is stopped by the user, the "forked" previewer will continue to run. Successive invocations with -the \fB-pvc\fR option will not fork new previewers, but \fIlatexmk\fR +the \fB\-pvc\fR option will not fork new previewers, but \fIlatexmk\fR will normally use the existing previewer. (At least this will happen when \fIlatexmk\fR is running under an operating system where it knows how to determine whether an existing previewer is running.) -.TP -.B -pvc- -Turn off \fB-pvc\fR. -.TP -.B -quiet -Same as -silent -.TP -.B -r +.TP +.B \-pvc\- +Turn off \fB\-pvc\fR. +.TP +.B \-quiet +Same as \-silent +.TP +.B \-r Read the specified initialization file ("RC file") before processing. -Be careful about the ordering: (1) Standard initialization files -- -see the section below on "Configuration/initialization (RC) files" -- +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 \fB-r\fR option, it is read during this second step. -Thus an initialization file specified with the \fB-r\fR option can +specified by the \fB\-r\fR option, it is read during this second step. +Thus an initialization file specified with the \fB\-r\fR option can override both the standard initialization files and \fIpreviously\fR specified options. But all of these can be overridden by \fIlater\fR options. @@ -401,48 +401,48 @@ The contents of the RC file just comprise a piece of code in the \fIPerl\fR programming language (typically a sequence of assignment statements); they are executed -when the \fB-r\fR option is encountered during \fIlatexmk\fR's parsing -of its command line. See the \fB-e\fR option for a way of giving +when the \fB\-r\fR option is encountered during \fIlatexmk\fR's parsing +of its command line. See the \fB\-e\fR option for a way of giving initialization code directly on \fIlatexmk\fR's command line. An error results in \fIlatexmk\fR stopping. Multiple instances of the -\fB-r\fR and \fB-e\fR options can be used, and they are executed in +\fB\-r\fR and \fB\-e\fR options can be used, and they are executed in the order they appear on the command line. -.TP -.B -silent +.TP +.B \-silent Run commands silently, i.e., with options that reduce the amount of diagnostics generated. For example, with the default settings for -commands under UNIX, the command "latex -interaction=batchmode" is used +commands under UNIX, the command "latex \-interaction=batchmode" is used for latex. Also reduce the number of informational messages that \fIlatexmk\fR generates. -.TP -.B -v, -version +.TP +.B \-v, \-version Print version number of \fIlatexmk\fR. -.TP -.B -verbose -Opposite of \fB-silent\fR. This is the default setting. -.TP -.B -view=default, -view=dvi, -view=ps, -view=pdf +.TP +.B \-verbose +Opposite of \fB\-silent\fR. This is the default setting. +.TP +.B \-view=default, \-view=dvi, \-view=ps, \-view=pdf Set the kind of file used when previewing is requested (e.g., by the -\fB-pv\fR or \fB-pvc\fR switches). The default is to view the "highest" +\fB\-pv\fR or \fB\-pvc\fR switches). The default is to view the "highest" kind of requested file (in the order dvi, ps, pdf). -.PP -The preview-continuous option \fB-pvc\fR can only work with one file. +.PP +The preview\-continuous option \fB\-pvc\fR can only work with one file. So in this case you will normally only specify one filename on the command line. -.PP -Options \fB-p\fR, \fB-pv\fR and \fB-pvc\fR are mutually exclusive. So +.PP +Options \fB\-p\fR, \fB\-pv\fR and \fB\-pvc\fR are mutually exclusive. So each of these options turns the others off. -.SH EXAMPLES -.nf +.SH "EXAMPLES" +.nf .ta 2i % \fBlatexmk thesis\fR \fI# run latex enough times to resolve - cross-references\fR + cross\-references\fR -% \fBlatexmk -pvc -ps thesis\fR \fI# run latex enough times to resolve - cross-references, make a postscript +% \fBlatexmk \-pvc \-ps thesis\fR \fI# run latex enough times to resolve + cross\-references, make a postscript file, start a previewer. Then watch for changes in the source file thesis.tex and any files it @@ -452,37 +452,38 @@ encounters an error, latexmk will keep running. -% \fBlatexmk -c\fR \fI# remove .aux, .log, .bbl, .blg, .dvi, +% \fBlatexmk \-c\fR \fI# remove .aux, .log, .bbl, .blg, .dvi, .pdf, .ps & .bbl files\fR -.SH CONFIGURATION/INITIALIZATION (RC) FILES -.PP +.SH "CONFIGURATION/INITIALIZATION (RC) FILES" +.PP \fILatexmk\fR can be customized using initialization files, which are read at startup in the following order: -.PP +.PP 1) The system RC file, if it exists. On a UNIX system, \fIlatexmk\fR searches for following places for its system RC file, in the following order, and reads the first it finds: "/opt/local/share/latexmk/LatexMk", "/usr/local/share/latexmk/LatexMk", "/usr/local/lib/latexmk/LatexMk". - On a MS-WINDOWS system it looks for "C:\\latexmk\\LatexMk". -.PP + On Fedora systems, it only looks for "/etc/latexmk.conf". + On a MS\-WINDOWS system it looks for "C:\\latexmk\\LatexMk". +.PP 2) The user's RC file, "$HOME/.latexmkrc", if it exists. Here $HOME is the value of the environment variable HOME. On UNIX and clones -(including LINUX), this variable is set by the system; on MS-Windows, +(including LINUX), this variable is set by the system; on MS\-Windows, the user may choose to set it. -.PP +.PP 3) The RC file in the current working directory. This file can be named either "latexmkrc" or ".latexmkrc", and the first of these to be found is used, if any. -.PP -4) Any RC file(s) specified on the command line with the \fB-r\fR option. -.PP +.PP +4) Any RC file(s) specified on the command line with the \fB\-r\fR option. +.PP Each RC file is a sequence of \fIPerl\fR 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 +sequence of assignment statements that override some of the built\-in settings of \fILatexmk\fR. Straightforward cases can be handled without knowledge of the \fIPerl\fR language by using the examples in this document as templates. Comment lines are introduced by the "#" @@ -490,27 +491,27 @@ Note that command line options are obeyed in the order in which they are written; thus any RC file specified on the command line with -the \fB-r\fR option can override previous options but can be itself +the \fB\-r\fR option can override previous options but can be itself overridden by later options on the command line. There is also the -\fB-e\fR option, which allows initialization code to be specified in +\fB\-e\fR option, which allows initialization code to be specified in \fIlatexm\fR's command line. -.SH HOW TO SET VARIABLES IN INITIALIZATION FILES -.PP +.SH "HOW TO SET VARIABLES IN INITIALIZATION FILES" +.PP 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: -.PP +.PP $bibtex = 'bibtex %O %B'; -.PP +.PP for the setting of a string variable, -.PP +.PP $preview_mode = 1; -.PP +.PP for the setting of a numeric variable, and -.PP +.PP @default_files = ('paper', 'paper1'); -.PP +.PP for the setting of an array of strings. It is possible to append an item to an array variable as follows: @@ -525,8 +526,7 @@ -.SH FORMAT OF COMMAND SPECIFICATIONS - +.SH "FORMAT OF COMMAND SPECIFICATIONS" Some of the variables set the commands that \fIlatexmk\fR 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 @@ -534,42 +534,42 @@ \fBPlaceholders\fR: Supposed you wanted \fIlatexmk\fR 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 +moreover that you wanted to give it the option "\-\-shell\-escape". You could do this by the following setting: - $latex = 'elatex --shell-escape %O %S'; + $latex = 'elatex \-\-shell\-escape %O %S'; 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 \fIlatexmk\fR has decided -to use for this command. (E.g., if you used the -silent option it -would replace %O by "-interaction=batchmode".) +to use for this command. (E.g., if you used the \-silent option it +would replace %O by "\-interaction=batchmode".) The available placeholders are: -.TP +.TP .B %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. -.TP +.TP .B %D destination file (e.g., the name of the postscript file when converting a dvi file to postscript). -.TP +.TP .B %O options -.TP +.TP .B %R root filename. This is the base name for the main tex file. -.TP +.TP .B %S source file (e.g., the name of the dvi file when converting a dvi file to ps). -.TP +.TP .B %T The name of the primary tex file. -.PP +.PP 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 basename of a bibtex run is the same as for the texfile. But in a @@ -601,9 +601,9 @@ 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 -.PP +.PP $dvi_previewer = 'start xdvi %O %S'; -.PP +.PP This will be translated to whatever is appropriate for your operating system. @@ -615,28 +615,28 @@ of the command string, that is equivalent to having just one. -\fBCommand names containing spaces\fR: Under MS-Windows it is common +\fBCommand names containing spaces\fR: Under MS\-Windows it is common that the name of a command includes spaces, since software is often installed in a subdirectory of "C:\Program Files". Such command names should be enclosed in double quotes, as in $lpr_pdf = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p %S'; -\fBUsing MS-Windows file associations\fR: A useful trick under modern -versions of MS-Windows (e.g., WinXP) is to use just the command +\fBUsing MS\-Windows file associations\fR: A useful trick under modern +versions of MS\-Windows (e.g., WinXP) is to use just the command 'start' by itself: -.PP +.PP $dvi_previewer = 'start %S'; -.PP -Under recent versions of MS-Windows, this will cause to be run +.PP +Under recent versions of MS\-Windows, this will cause to be run whatever program the system has associated with dvi files. (The same applies for a postscript viewer and a pdf viewer.) \fBNot using a certain command\fR: If a command is not to be run, the command name NONE is used, as in -.PP +.PP $lpr = 'NONE lpr'; -.PP +.PP This typically is used when an appropriate command does not exist on your system. The string after the "NONE" is effectively a comment. @@ -646,9 +646,9 @@ Suppose you want \fIlatexmk\fR to use latex with source specials enabled. Then you might use the following line in an initialization file: -.PP - $latex = 'latex --src-specials %O %S'; -.PP +.PP + $latex = 'latex \-\-src\-specials %O %S'; +.PP \fBAdvanced tricks\fR: Normally one specifies a single command for the commands invoked by \fIlatexmk\fR. Naturally, if there is some @@ -662,45 +662,45 @@ file from a tex file you need to run another program after pdflatex to perform some extra processing, you could do something like: - $pdflatex = 'pdflatex --shell-escape %O %S; pst2pdf_for_latexmk %B'; + $pdflatex = 'pdflatex \-\-shell\-escape %O %S; pst2pdf_for_latexmk %B'; -This definition assumes you are using a UNIX-like system, so that the +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. -.SH LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES -.PP +.SH "LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES" +.PP Default values are indicated in brackets. -.TP +.TP .B $banner [0] If nonzero, the banner message is printed across each page when converting the dvi file to postscript. Without modifying the variable -\fI$banner_message\fR, this is equivalent to specifying the \fB-d\fR +\fI$banner_message\fR, this is equivalent to specifying the \fB\-d\fR option. Note that if \fB$banner\fR is nonzero, the \fB$postscript_mode\fR is assumed and the postscript file is always generated, even if it is newer than the dvi file. -.TP +.TP .B $banner_intensity [0.95] -Equivalent to the \fB-bi\fR option, this is a decimal number between 0 +Equivalent to the \fB\-bi\fR option, this is a decimal number between 0 and 1 that specifies how dark to print the banner message. 0 is black, 1 is white. The default is just right if your toner cartridge isn't running too low. -.TP +.TP .B $banner_message ["DRAFT"] The banner message to print across each page when converting the dvi -file to postscript. This is equivalent to the \fB-bm\fR option. -.TP +file to postscript. This is equivalent to the \fB\-bm\fR option. +.TP .B $banner_scale [220.0] A decimal number that specifies how large the banner message will be printed. Experimentation is necessary to get the right scale for your message, as a rule of thumb the scale should be about equal to 1100 divided by the number of characters in the message. The Default is just right for 5 character messages. This is equivalent to the -\fB-bs\fR option. -.TP +\fB\-bs\fR option. +.TP .B @BIBINPUTS This is an array variable, now mostly obsolete, that specifies directories where @@ -728,13 +728,13 @@ 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 \fI@BIBINPUTS\fR. -.TP +.TP .B $bibtex ["bibtex %O %S"] The BibTeX processing program. -.TP -.B $bibtex_silent_switch ["-terse"] +.TP +.B $bibtex_silent_switch ["\-terse"] \fBSwitch(es)\fR for the BibTeX processing program when silent mode is on. -.TP +.TP .B $cleanup_mode [0] 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 @@ -743,21 +743,21 @@ variables.) This variable is equivalent to specifying one of -the \fB-c\fR, \fB-c1\fR, or \fB-C\fR options. But there should be no need +the \fB\-c\fR, \fB\-c1\fR, or \fB\-C\fR options. But there should be no need to set this variable from an RC file. -.TP +.TP .B $clean_ext [""] Extra extensions of files for \fIlatexmk\fR to remove when any of the -clean-up options (\fB-c\fR, \fB-c1\fR, or \fB-C\fR) is selected. -.TP +clean\-up options (\fB\-c\fR, \fB\-c1\fR, or \fB\-C\fR) is selected. +.TP .B $clean_full_ext [""] -Extra extensions of files for \fIlatexmk\fR to remove when the \fB-C\fR +Extra extensions of files for \fIlatexmk\fR to remove when the \fB\-C\fR option is selected, i.e., extensions of files to remove when the .dvi, -etc files are to be cleaned-up. -.TP +etc files are to be cleaned\-up. +.TP .B @cus_dep_list [()] -Custom dependency list -- see section on "Custom Dependencies". -.TP +Custom dependency list \-\- see section on "Custom Dependencies". +.TP .B @default_files [('*.tex')] Default list of files to be processed. @@ -784,56 +784,56 @@ is '.tex'. Wild cards are allowed. The parentheses are because \fI@default_files\fR is an array variable, i.e., a sequence of filename specifications is possible. -.TP +.TP .B $dvi_filter [empty] The dvi file filter to be run on the newly produced dvi file before -other processing. Equivalent to specifying the \fB-dF\fR option. -.TP +other processing. Equivalent to specifying the \fB\-dF\fR option. +.TP .B $dvi_mode [0] If nonzero, generate a dvi version of the document. -Equivalent to the \fB-dvi\fR option. -.TP +Equivalent to the \fB\-dvi\fR option. +.TP .B $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 +The command to invoke a dvi\-previewer. +[Default is "start" under MS\-WINDOWS; under more recent versions of Windows, this will cause to be run whatever command the system has associated with .dvi files.] -.TP +.TP .B $dvi_previewer_landscape ["start xdvi %O %S"] -The command to invoke a dvi-previewer in landscape mode. -[Default is "start" under MS-WINDOWS; under more recent versions of +The command to invoke a dvi\-previewer in landscape mode. +[Default is "start" under MS\-WINDOWS; under more recent versions of Windows, this will cause to be run whatever command the system has associated with .dvi files.] -.TP +.TP .B $dvipdf ["dvipdf %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 different order: - $dvipdf = 'dvipdfm %O -o %D %S'; + $dvipdf = 'dvipdfm %O \-o %D %S'; WARNING: The default dvipdf script generates pdf files with bitmapped fonts, which do not look good when viewed by acroread. That script -should be modified to give dvips the options "-P pdf" to ensure that +should be modified to give dvips the options "\-P pdf" to ensure that type 1 fonts are used in the pdf file. -.TP -.B $dvips ["dvips %O -o %D %S"] +.TP +.B $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 +$dvips_pdf_switch \-\- see below \-\- will be included in the options substituted for '%O'. -.TP -.B $dvips_landscape ["dvips -tlandscape %O -o %D %S"] +.TP +.B $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. -.TP -.B $dvips_pdf_switch ["-P pdf"] +.TP +.B $dvips_pdf_switch ["\-P pdf"] Switch(es) for dvips program when pdf file is to be generated from ps file. -.TP -.B $dvips_silent_switch ["-q"] +.TP +.B $dvips_silent_switch ["\-q"] Switch(es) for dvips program when silent mode is on. -.TP +.TP .B $dvi_update_command [""] When the dvi previewer is set to be updated by running a command, this is the command that is run. See the information for the variable @@ -841,8 +841,8 @@ on the variable \fI$pdf_update_method\fR for an example for the analogous case of a pdf previewer. -.TP -.B $dvi_update_method [2 under UNIX, 1 under MS-Windows] +.TP +.B $dvi_update_method [2 under UNIX, 1 under MS\-Windows] How the dvi viewer updates its display when the dvi file has changed. The values here apply equally to the \fI$pdf_update_method\fR and to the \fI$ps_update_method\fR variables. @@ -852,38 +852,38 @@ 2 => Send the signal, whose number is in the variable \fI$dvi_update_signal\fR. 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.) +acroread under MS\-Windows.) 4 => run a command to do the update. The command is specified by the variable \fI$dvi_update_command\fR. See information on the variable \fI$pdf_update_method\fR for an example of updating by command. -.TP -.B $dvi_update_signal [Under UNIX: SIGUSR1, which is a system-dependent value] +.TP +.B $dvi_update_signal [Under UNIX: SIGUSR1, which is a system\-dependent value] The number of the signal that is sent to the dvi viewer when it is -updated by sending a signal -- see the information on the variable +updated by sending a signal \-\- see the information on the variable \fI$dvi_update_method\fR. The default value is the one appropriate for xdvi on a UNIX system. -.TP +.TP .B $fdb_ext ["fdb_latexmk"] The extension of the file which \fIlatexmk\fR generates to contain a database of information on source files. You will not normally need to change this. -.TP +.TP .B $force_mode [0] If nonzero, continue processing past minor \fIlatex\fR errors including unrecognized cross references. Equivalent to specifying the -\fB-f\fR option. -.TP +\fB\-f\fR option. +.TP .B @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 \fB-c\fR, \fB-C\fR, \fB-CA\fR, \fB-g\fR -and \fB-gg\fR options), and (b) in the determination of whether a +a cleanup operation (with the \fB\-c\fR, \fB\-C\fR, \fB\-CA\fR, \fB\-g\fR +and \fB\-gg\fR options), and (b) in the determination of whether a rerun of (pdf)LaTeX is needed after a run that gives an error. (Normally, a change of a source file during a run should provoke a @@ -892,7 +892,7 @@ 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 \fIlatexmk\fR needs to distinguish -user-generated and automatically generated files; it determines the +user\-generated and automatically generated files; it determines the automatically generated files as those with extensions in the list in @generated_exts.) @@ -905,11 +905,11 @@ adds the extension 'end' to the list of predefined generated extensions. (This extension is used by the RevTeX package, for example.) -.TP +.TP .B $go_mode [0] If nonzero, process files regardless of timestamps, and is then -equivalent to the \fB-g\fR option. -.TP +equivalent to the \fB\-g\fR option. +.TP .B $kpsewhich ["kpsewhich %S"] The program called to locate a source file when the name alone is not sufficient. Most filenames used by \fIlatexmk\fR have sufficient path @@ -921,28 +921,28 @@ See also the \fI@BIBINPUTS\fR variable for another way that \fIlatexmk\fR also uses to try to locate files; it applies only in the case of .bib files. -.TP +.TP .B $landscape_mode [0] If nonzero, run in landscape mode, using the landscape mode previewers and -dvi to postscript converters. Equivalent to the \fB-l\fR option. +dvi to postscript converters. Equivalent to the \fB\-l\fR option. Normally not needed with current previewers. -.TP +.TP .B $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'; -.TP -.B $latex_silent_switch ["-interaction=batchmode"] + $latex = 'latex \-\-src\-specials'; +.TP +.B $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 -"-interaction=batchmode -c-style-errors", as used by MikTeX and fpTeX. -.TP -.B $lpr ["lpr %O %S", or "NONE lpr" under MS-WINDOWS] +Under MS\-Windows, the default value is changed to +"\-interaction=batchmode \-c\-style\-errors", as used by MikTeX and fpTeX. +.TP +.B $lpr ["lpr %O %S", or "NONE lpr" under MS\-WINDOWS] The command to print postscript files. -Under MS-Windows (unlike UNIX/LINUX), there is no standard program for +Under MS\-Windows (unlike UNIX/LINUX), there is no standard program for printing files. But there are ways you can do it. For example, if you have gsview installed, you could use it with the option '/p': @@ -956,14 +956,14 @@ the command obeyed; this is necessary because one part of the command name ('Program Files') contains a space which would otherwise be misinterpreted. -.TP +.TP .B $lpr_dvi ["NONE lpr_dvi"] The printing program to print dvi files. -.TP +.TP .B $lpr_pdf ["NONE lpr_pdf"] The printing program to print pdf files. -Under MS-Windows you could set this to use gsview, if it is installed, +Under MS\-Windows you could set this to use gsview, if it is installed, e.g., $lpr = '"c:/Program Files/Ghostgum/gsview/gsview32.exe" /p'; @@ -973,18 +973,18 @@ is necessary because one part of the command name ('Program Files') contains a space which would otherwise be misinterpreted. -.TP -.B $makeindex ["makeindex %O -o %D %S"] +.TP +.B $makeindex ["makeindex %O \-o %D %S"] The index processing program. -.TP +.TP .B $new_viewer_always [0] This variable applies to \fIlatexmk\fR \fBonly\fR in -continuous-preview mode. If \fI$new_viewer_always\fR is 0, +continuous\-preview mode. If \fI$new_viewer_always\fR is 0, \fIlatexmk\fR will check for a previously running previewer on the same file, and if one is running will not start a new one. If -\fI$new_viewer_always\fR is non-zero, this check will be skipped, and +\fI$new_viewer_always\fR is non\-zero, this check will be skipped, and \fIlatexmk\fR will behave as if no viewer is running. -.TP +.TP .B $pdf_mode [0] If zero, do NOT generate a pdf version of the document. If equal to 1, generate a pdf version of the document using pdflatex. @@ -993,39 +993,39 @@ If equal to 3, generate a pdf version of the document from the dvi file, by using the command specified by the \fI$dvipdf\fR variable. -Equivalent to the \fB-pdf-\fR, \fB-pdf\fR, \fB-pdfdvi\fR, -\fB-pdfps\fR options. -.TP +Equivalent to the \fB\-pdf\-\fR, \fB\-pdf\fR, \fB\-pdfdvi\fR, +\fB\-pdfps\fR options. +.TP .B $pdflatex ["pdflatex %O %S"] The LaTeX processing program in the version that makes a pdf file instead of a dvi file. -.TP -.B $pdflatex_silent_switch ["-interaction=batchmode"] +.TP +.B $pdflatex_silent_switch ["\-interaction=batchmode"] Switch(es) for the pdflatex program (specified in the variable \fI$pdflatex\fR when silent mode is on. -Under MS-Windows, the default value is changed to -"-interaction=batchmode -c-style-errors", as used by MikTeX and fpTeX. -.TP +Under MS\-Windows, the default value is changed to +"\-interaction=batchmode \-c\-style\-errors", as used by MikTeX and fpTeX. +.TP .B $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 +The command to invoke a pdf\-previewer. +[Default is changed to "start" on MS\-WINDOWS; under more recent versions of Windows, this will cause to be run whatever command the system has associated with .pdf files.] -\fBWARNING\fR: Potential problem under MS-Windows: +\fBWARNING\fR: Potential problem under MS\-Windows: if acroread is used as the pdf previewer, and it is actually viewing a pdf file, the pdf file cannot be updated. Thus makes acroread a bad choice of previewer if you use \fIlatexmk\fR's -previous-continuous mode (option \fB-pvc\fR) under MS-windows. +previous\-continuous mode (option \fB\-pvc\fR) under MS\-windows. This problem does not occur if ghostview, gv or gsview is used to view pdf files. -.TP +.TP .B $pdf_update_command [""] When the pdf previewer is set to be updated by running a command, this is the command that is run. See the information for the variable \fI$pdf_update_method\fR. -.TP -.B $pdf_update_method [1 under UNIX, 3 under MS-Windows] +.TP +.B $pdf_update_method [1 under UNIX, 3 under MS\-Windows] How the pdf viewer updates its display when the pdf file has changed. See the information on the variable \fI$dvi_update_method\fR for the codes. (Note that information needs be changed slightly so @@ -1034,95 +1034,95 @@ value 2, to specify update by signal, the signal is specified by \fI$pdf_update_signal\fR.) -Note that acroread under MS-Windows (but not UNIX) locks the pdf file, so +Note that acroread under MS\-Windows (but not UNIX) locks the pdf file, so the default value is then 3. Arranging to use a command to get a previewer explicitly updated requires three variables to be set. For example: - $pdf_previewer = 'start xpdf -remote %R %O %S'; + $pdf_previewer = 'start xpdf \-remote %R %O %S'; $pdf_update_method = 4; - $pdf_update_command = 'xpdf -remote %R -reload'; + $pdf_update_command = 'xpdf \-remote %R \-reload'; The first setting arranges for the xpdf program to be used in its 'remote server mode', with the server name specified as the rootname of the TeX file. The second setting arranges for updating to be done in response to a command, and the third setting sets the update command. -.TP -.B $pdf_update_signal [Under UNIX: SIGHUP, which is a system-dependent value] +.TP +.B $pdf_update_signal [Under UNIX: SIGHUP, which is a system\-dependent value] The number of the signal that is sent to the pdf viewer when it is -updated by sending a signal -- see the information on the variable +updated by sending a signal \-\- see the information on the variable \fI$pdf_update_method\fR. The default value is the one appropriate for gv on a UNIX system. -.TP -.B $pid_position = [1 under UNIX, -1 under MS-Windows] +.TP +.B $pid_position = [1 under UNIX, \-1 under MS\-Windows] Command used to get all the processes currently run by the user. The --pvc option uses the command specified by the variable \fI$pscmd\fR to +\-pvc option uses the command specified by the variable \fI$pscmd\fR to determine if there is an already running previewer, and to find the process ID (needed if \fIlatexmk\fR needs to signal the previewer about file changes). The variable \fI$pid_position\fR is used to specify which word in lines of the output from \fI$pscmd\fR corresponds to the process ID. The first word in the line is numbered 0. The default value of 1 (2nd word in line) is correct for Solaris -2.6 and Linux. Setting the variable to -1 is used to indicate that +2.6 and Linux. Setting the variable to \-1 is used to indicate that \fI$pscmd\fR is not to be used. -.TP +.TP .B $postscript_mode [0] If nonzero, generate a postscript version of the document. -Equivalent to the \fB-ps\fR option. -.TP +Equivalent to the \fB\-ps\fR option. +.TP .B $preview_continuous_mode [0] If nonzero, run a previewer to view the document, and -continue running \fIlatexmk\fR to keep .dvi up-to-date. Equivalent to -the \fB-pvc\fR option. +continue running \fIlatexmk\fR to keep .dvi up\-to\-date. Equivalent to +the \fB\-pvc\fR option. Which previewer is run depends on the other settings, see the command -line options \fB-view=\fR, and the variable \fI$view\fR. -.TP +line options \fB\-view=\fR, and the variable \fI$view\fR. +.TP .B $preview_mode [0] If nonzero, run a previewer to preview the document. -Equivalent to the \fB-pv\fR option. +Equivalent to the \fB\-pv\fR option. Which previewer is run depends on the other settings, see the command -line options \fB-view=\fR, and the variable \fI$view\fR. -.TP +line options \fB\-view=\fR, and the variable \fI$view\fR. +.TP .B $printout_mode [0] If nonzero, print the document using \fIlpr\fR. Equivalent to the -\fB-p\fR option. This is recommended \fBnot\fR to be set from an RC +\fB\-p\fR option. This is recommended \fBnot\fR to be set from an RC file, otherwise you could waste lots of paper. -.TP +.TP .B $print_type = ["ps"] Type of file to printout: possibilities are "dvi", "none", "pdf", or "ps". -.TP +.TP .B $pscmd -[On UNIX, the default is "ps -f -u $ENV{USER}", with changes for Linux -and OS-X. -On MS-WINDOWS the default in "NONE pscmd".] +[On UNIX, the default is "ps \-f \-u $ENV{USER}", with changes for Linux +and OS\-X. +On MS\-WINDOWS the default in "NONE pscmd".] Command used to get a list all the processes currently run by the user. This -is used by the -pvc option to determine if there is an already running +is used by the \-pvc option to determine if there is an already running previewer. The command line options for this command under the different flavors of UNIX are quite variable. The command given above is suitable for Solaris 2.6 and above, and \fIlatexmk\fR corrects it for Linux and OSX. NOTE: The variable \fI$pid_position\fR must also be set; see its description. -.TP +.TP .B $ps2pdf ["ps2pdf %O %S %D"] Command to convert ps to pdf file. -.TP +.TP .B $ps_filter [empty] The postscript file filter to be run on the newly produced postscript -file before other processing. Equivalent to specifying the \fB-pF\fR +file before other processing. Equivalent to specifying the \fB\-pF\fR option. -.TP +.TP .B $ps_previewer ["start gv %O %S"] -The command to invoke a ps-previewer. -[Default is "start" on MS-WINDOWS; under more recent versions of +The command to invoke a ps\-previewer. +[Default is "start" on MS\-WINDOWS; under more recent versions of Windows, this will cause to be run whatever command the system has associated with .ps files.] -Note that gv could be used with the -watch option updates its display +Note that gv could be used with the \-watch option updates its display whenever the postscript file changes, whereas ghostview does not. However, different versions of gv have slightly different ways of writing this option. Moreover, you can always configure gv to do this @@ -1131,19 +1131,19 @@ \fBWARNING\fR: 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. -.TP -.B $ps_previewer_landscape ["start gv -swap %O %S"] -The command to invoke a ps-previewer in landscape mode. -[Default is "start" on MS-WINDOWS; under more recent versions of +.TP +.B $ps_previewer_landscape ["start gv \-swap %O %S"] +The command to invoke a ps\-previewer in landscape mode. +[Default is "start" on MS\-WINDOWS; under more recent versions of Windows, this will cause to be run whatever command the system has associated with .ps files.] -.TP +.TP .B $ps_update_command [""] When the postscript previewer is set to be updated by running a command, this is the command that is run. See the information for the variable \fI$ps_update_method\fR. -.TP -.B $ps_update_method [0 under UNIX, 1 under MS-Windows] +.TP +.B $ps_update_method [0 under UNIX, 1 under MS\-Windows] How the postscript viewer updates its display when the ps file has changed. See the information on the variable \fI$dvi_update_method\fR for the codes. (Note that information needs be changed slightly so @@ -1152,25 +1152,25 @@ value 2, to specify update by signal, the signal is specified by \fI$ps_update_signal\fR.) -.TP -.B $ps_update_signal [Under UNIX: SIGHUP, which is a system-dependent value] +.TP +.B $ps_update_signal [Under UNIX: SIGHUP, which is a system\-dependent value] The number of the signal that is sent to the pdf viewer when it is -updated by sending a signal -- see \fI$ps_update_method\fR. The +updated by sending a signal \-\- see \fI$ps_update_method\fR. The default value is the one appropriate for gv on a UNIX system. -.TP +.TP .B $sleep_time [2] The time to sleep (in seconds) between checking for source file -changes when running the \fB-pvc\fR option. -.TP +changes when running the \fB\-pvc\fR option. +.TP .B $texfile_search [""] This is an obsolete variable, replaced by the \fI@default_files\fR variable. For backward compatibility, if you choose to set -\fI$texfile_search\fR, it is a string of space-separated filenames, and +\fI$texfile_search\fR, it is a string of space\-separated filenames, and then \fIlatexmk\fR replaces \fI@default_files\fR with the filenames in \fI$texfile_search\fR to which is added '*.tex'. -.TP +.TP .B $tmpdir [See below for default] Directory to store temporary files that \fIlatexmk\fR may generate while running. @@ -1179,54 +1179,54 @@ \fI$tmpdir\fR to the value of the first of whichever of the system environment variables TMPDIR or TEMP exists, otherwise to the current directory. Under other operating systems (expected to be UNIX/Linux, -including OS-X), the default is the value of the system environment +including OS\-X), the default is the value of the system environment variable TMPDIR if it exists, otherwise "/tmp". -.TP +.TP .B $view ["default"] Which kind of file is to be previewed if a previewer is used. The possible values are 'default', 'dvi', 'ps', 'pdf'. The value of "default" means that the "highest" of the kinds of file generated is to be used (among dvi, ps and pdf). -.SH CUSTOM DEPENDENCIES -.PP +.SH "CUSTOM DEPENDENCIES" +.PP In any RC file a set of custom dependencies can be set up to convert a file with one extension to a file with another. An example use of this -would be to allow \fIlatexmk\fR to convert a \fI.fig\fR file to +would be to allow \fIlatexmk\fR to convert a \fI.fi g\fR file to \fI.eps\fR to be included in the \fI.tex\fR file. A table of custom dependencies are set up by using the \fB@cus_dep_list\fR array. Each string in the array has four arguments, separated by a space: -.TP +.TP .B from extension: The extension of the file we are converting from (e.g. "fig"). -.TP +.TP .B to extension: The extension of the file we are converting to (e.g. "eps"). -.TP +.TP .B must: -If non-zero, the file from which we are converting \fBmust\fR exist, if it +If non\-zero, the file from which we are converting \fBmust\fR exist, if it doesn't exist \fIlatexmk\fR will give an error message and exit unless -the \fB-f\fR option is specified. If \fImust\fR is zero and the file +the \fB\-f\fR option is specified. If \fImust\fR is zero and the file we are converting from doesn't exist, then no action is taken. -.TP +.TP .B function: The name of the subroutine that \fIlatexmk\fR should call to perform the file conversion. The first argument to the subroutine is the base name of the file to be converted without any extension. The subroutines are declared in the syntax of \fIPerl\fR. The function should return 0 if it was successful and a nonzero number if it failed. -.PP -Example in an RC file to ensure automatic conversion of \fI.fig\fR +.PP +Example in an RC file to ensure automatic conversion of \fI.fi g\fR files to \fI.eps\fR files: push @cus_dep_list, "fig eps 0 fig2eps"; sub fig2eps { - system("fig2dev -Lps $_[0].fig $_[0].eps"); + system("fig2dev \-Lps $_[0].fi g $_[0].eps"); } The first line specifies the custom dependency, which specifies that -the subroutine \fIfig2eps\fR will be called if the \fI.fig\fR file has +the subroutine \fIfig2eps\fR will be called if the \fI.fi g\fR file has changed since the \fI.eps\fR file was last made, or if the \fI.eps\fR file does not exist. The remaining lines define this subroutine. When it is called, this subroutine will have one argument which is the @@ -1236,7 +1236,7 @@ \fIPerl\fR idiom that signify that each string of the form of a variable name, $_[0] in this case, is to be substituted by its value. -If the return value of the subroutine is non-zero, then \fIlatexmk\fR +If the return value of the subroutine is non\-zero, then \fIlatexmk\fR will assume an error occurred during the execution of the subroutine. In the above example, no explicit return value is given, and instead the return value is the value returned by the last (and only) @@ -1244,9 +1244,9 @@ on success. -.SH SEE ALSO +.SH "SEE ALSO" latex(1), bibtex(1). -.SH BUGS +.SH "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 @@ -1258,32 +1258,32 @@ Gv on UNIX/LINUX works for both postscript and pdf. Ghostview on UNIX/LINUX needs a manual update (reopen); it views postscript and pdf. -Gsview under MS-Windows works for both postscript and pdf, +Gsview under MS\-Windows works for both postscript and pdf, but only reads the updated file when its screen is refreshed. Acroread under UNIX/LINUX views pdf, but the file needs to be closed and reopened to view an updated version. -Under MS-Windows, acroread locks its input file and so the +Under MS\-Windows, acroread locks its input file and so the pdf file cannot be updated. (Remedy: configure \fIlatexmk\fR use gsview instead.) -.SH THANKS TO +.SH "THANKS TO" 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. (Please note that the -e-mail addresses are not written in their standard form to avoid being +e\-mail addresses are not written in their standard form to avoid being harvested by worms and viruses.) -.SH AUTHOR +.SH "AUTHOR" Current version, with substantial modifications, enhancements and bug fixes by John Collins (username collins at node phys.psu.edu). (Version 4.00). It can be obtained from CTAN: -, and from the +, and from the author's website . -.br +.br Modifications and enhancements by Evan McLean (Version 2.0) -.br +.br Original script called "go" by David J. Musliner (RCS Version 3.2) \" LocalWords: fR fIlatexmk dvi ps fILatexmk pdflatex bibtex makeindex fB pv diff -dur latexmk-4.00e.ORIG/latexmk.pl latexmk-4.00e/latexmk.pl --- latexmk-4.00e.ORIG/latexmk.pl 2008-09-22 16:45:08.000000000 -0600 +++ latexmk-4.00e/latexmk.pl 2008-09-24 10:06:40.000000000 -0600 @@ -777,10 +777,8 @@ ## /usr/local/share, depending on the local conventions. ## /usr/local/lib/latexmk/LatexMk is put in the list for ## compatibility with older versions of latexmk. - @rc_system_files = - ( '/opt/local/share/latexmk/LatexMk', - '/usr/local/share/latexmk/LatexMk', - '/usr/local/lib/latexmk/LatexMk' ); + ## Fedora change: only look in /etc + @rc_system_files = ( '/etc/latexmk.conf' ); $search_path_separator = ':'; # Separator of elements in search_path