diff options
| author | Karl Berry <karl@freefriends.org> | 2011-08-12 00:21:46 +0000 |
|---|---|---|
| committer | Karl Berry <karl@freefriends.org> | 2011-08-12 00:21:46 +0000 |
| commit | 4ef16cc33e3975ee384eb75c8c120d53c402ff3a (patch) | |
| tree | 5bc6eb4ebfa26a2990d8d450e13adb462d3ecec1 /Master/texmf-dist/doc/support/latexmk | |
| parent | 1d0f670384327d7898abef21822d0fbf113349e6 (diff) | |
latexmk 4.26 (11aug11)
git-svn-id: svn://tug.org/texlive/trunk@23503 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/support/latexmk')
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/CHANGES | 4 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/INSTALL | 2 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/README | 7 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/latexmk.pdf | bin | 97578 -> 100945 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/latexmk/latexmk.txt | 770 |
5 files changed, 402 insertions, 381 deletions
diff --git a/Master/texmf-dist/doc/support/latexmk/CHANGES b/Master/texmf-dist/doc/support/latexmk/CHANGES index 79579a9c885..0d4660bf493 100644 --- a/Master/texmf-dist/doc/support/latexmk/CHANGES +++ b/Master/texmf-dist/doc/support/latexmk/CHANGES @@ -263,3 +263,7 @@ From v. 4.24 to v. 4.25 Diagnostic for unreadable rc-file. Add deps output file to target part of dependency information +From v. 4.25 to v. 4.26 + Make compatible with biber 0.9.4. + Fix some bugs in error reporting. + diff --git a/Master/texmf-dist/doc/support/latexmk/INSTALL b/Master/texmf-dist/doc/support/latexmk/INSTALL index 2a8d7deb3a0..23328a15393 100644 --- a/Master/texmf-dist/doc/support/latexmk/INSTALL +++ b/Master/texmf-dist/doc/support/latexmk/INSTALL @@ -1,6 +1,6 @@ INSTALLING latexmk ================== - (Version 4.25, 7 July 2011) + (Version 4.26, 9 August 2011) John Collins Physics Department diff --git a/Master/texmf-dist/doc/support/latexmk/README b/Master/texmf-dist/doc/support/latexmk/README index 4600297c863..5e6492c1941 100644 --- a/Master/texmf-dist/doc/support/latexmk/README +++ b/Master/texmf-dist/doc/support/latexmk/README @@ -1,5 +1,5 @@ -Latexmk, version 4.25, 7 July 2011 ----------------------------------- +Latexmk, version 4.26, 9 August 2011 +------------------------------------ Latexmk completely automates the process of generating a LaTeX document. Essentially, it is a highly specialized cousin of the @@ -92,7 +92,8 @@ NOTES:- John Collins ---------------------------- "latexmk -h" ---------------------------- -Latexmk 4.25: Automatic LaTeX document generation routine +===========I am /usr/local/lib/latexmk/LatexMk +Latexmk 4.26: Automatic LaTeX document generation routine Usage: latexmk [latexmk_options] [filename ...] diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.pdf b/Master/texmf-dist/doc/support/latexmk/latexmk.pdf Binary files differindex 4c14c86c4ad..b2d327eb1a1 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 c918915149c..fb45ee11931 100644 --- a/Master/texmf-dist/doc/support/latexmk/latexmk.txt +++ b/Master/texmf-dist/doc/support/latexmk/latexmk.txt @@ -1,4 +1,9 @@ + + +LATEXMK(1L) LATEXMK(1L) + + NAME latexmk - generate LaTeX document @@ -53,15 +58,10 @@ DESCRIPTION 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. - - 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. - 1 + 9 August 2011 1 @@ -70,6 +70,12 @@ DESCRIPTION LATEXMK(1L) LATEXMK(1L) + WYSIWYG, but usefully close. + + 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. + 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 @@ -119,23 +125,22 @@ LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE When the source file uses bbl files for bibliography, run bibtex or biber as needed to regenerate the bbl files. - This property can also be configured by setting the $bibtex_use - variable to 2 in a configuration file - - -bibtex- - Never run bibtex or biber. + 9 August 2011 2 - 7 July 2011 2 +LATEXMK(1L) LATEXMK(1L) -LATEXMK(1L) LATEXMK(1L) + This property can also be configured by setting the $bibtex_use + variable to 2 in a configuration file + -bibtex- + Never run bibtex or biber. A common use for this option is when a document comes from an external source, complete with its bbl file(s), and the user @@ -165,8 +170,8 @@ LATEXMK(1L) LATEXMK(1L) -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. + gle argument on the command line so be careful with quoting spa- + ces and such. Note that if the -bm option is specified, the -ps option is assumed. @@ -184,18 +189,11 @@ LATEXMK(1L) LATEXMK(1L) message. The default is 220.0 which is just right for 5 charac- ter messages. - -commands - List the commands used by latexmk for processing files, and then - exit. - -c Clean up (remove) all regeneratable files generated by latex and - bibtex or biber except dvi, postscript and pdf. These files are - a combination of log files, aux files, latexmk's database file - of source file information, and those with extensions specified - 7 July 2011 3 + 9 August 2011 3 @@ -204,6 +202,14 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) + -commands + List the commands used by latexmk for processing files, and then + exit. + + -c Clean up (remove) all regeneratable files generated by latex and + bibtex or biber except dvi, postscript and pdf. These files are + a combination 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. @@ -250,27 +256,27 @@ LATEXMK(1L) LATEXMK(1L) latexmk -bm DRAFT Note that if the -d option is specified, the -ps option is - assumed. - -deps Show a list of dependent files after processing. This is in the - form of a dependency list of the form used by the make program, - and it is therefore suitable for use in a Makefile. It gives an - overall view of the files without listing intermediate files, as - well as latexmk can determine them. - By default the list of dependent files is sent to stdout (i.e., + 9 August 2011 4 - 7 July 2011 4 +LATEXMK(1L) LATEXMK(1L) -LATEXMK(1L) LATEXMK(1L) + assumed. + -deps Show a list of dependent files after processing. This is in the + form of a dependency list of the form used by the make program, + and it is therefore suitable for use in a Makefile. It gives an + overall view of the files without listing intermediate files, as + well as latexmk can determine them. + By default the list of dependent files is sent to stdout (i.e., normally to the screen unless you've redirected latexmk's out- put). But you can set the filename where the list is sent by the -deps-out= option. @@ -317,19 +323,9 @@ LATEXMK(1L) LATEXMK(1L) -dvi Generate dvi version of document. - -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.) - - -e <code> - Execute the specified initialization code before processing. - The code is Perl code of the same form as is used in latexmk's - initialization files -- for more details, see the information on - - 7 July 2011 5 + 9 August 2011 5 @@ -338,6 +334,15 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) + -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.) + + -e <code> + Execute the specified initialization code before processing. + 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 -r option, and the section about "Configuration/initializa- tion (RC) files". The code is typically a sequence of assign- ment statements separated by semicolons. @@ -383,28 +388,28 @@ LATEXMK(1L) LATEXMK(1L) no further processing is carried out. -f- Turn off the forced processing-past-errors such as is set by the - -f option. This could be used to override a setting in a con- - figuration file. - -g Force latexmk to process document fully, even under situations - where latexmk would normally decide that no changes in the - 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. - -g- Turn off -g. + 9 August 2011 6 - 7 July 2011 6 +LATEXMK(1L) LATEXMK(1L) + -f option. This could be used to override a setting in a con- + figuration file. -LATEXMK(1L) LATEXMK(1L) + -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. + -g- Turn off -g. -gg "Super go mode" or "clean make": clean out generated files as if -C had been given, and then do a regular make. @@ -444,12 +449,23 @@ LATEXMK(1L) LATEXMK(1L) trying to run bibtex or biber, which would result in overwriting of the bbl files. - -p Print out the document. By default it is the generated - postscript file that is printed. But you can use the -print=... + -p Print out the document. By default it is the generated post- + script 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 $print_type vari- able). + + + 9 August 2011 7 + + + + + +LATEXMK(1L) LATEXMK(1L) + + However, printing is enabled by default only under UNIX/LINUX systems, where the default is to use the lpr command. In gen- eral, the correct behavior for printing very much depends on @@ -463,17 +479,6 @@ LATEXMK(1L) LATEXMK(1L) This option is incompatible with the -pv and -pvc options, so it turns them off. - - - 7 July 2011 7 - - - - - -LATEXMK(1L) LATEXMK(1L) - - -pdf Generate pdf version of document using pdflatex. -pdfdvi @@ -515,6 +520,18 @@ LATEXMK(1L) LATEXMK(1L) Whether to use single or double quotes round the "psnup -2" will depend on your command interpreter, as used by the particular + + + + 9 August 2011 8 + + + + + +LATEXMK(1L) LATEXMK(1L) + + version of perl and the operating system on your computer. -pv Run file previewer. If the -view option is used, this will @@ -530,18 +547,6 @@ LATEXMK(1L) LATEXMK(1L) -pvc Run a file previewer and continually update the .dvi, .ps, and/or .pdf files whenever changes are made to source files (see the Description above). Which of these files is generated and - - - - 7 July 2011 8 - - - - - -LATEXMK(1L) LATEXMK(1L) - - which is viewed is governed by the other options, and is the same as for the -pv option. The preview-continuous option -pvc can only work with one file. So in this case you will normally @@ -581,6 +586,18 @@ LATEXMK(1L) LATEXMK(1L) -pvc- Turn off -pvc. + + + + 9 August 2011 9 + + + + + +LATEXMK(1L) LATEXMK(1L) + + -quiet Same as -silent -r <rcfile> @@ -598,18 +615,6 @@ LATEXMK(1L) LATEXMK(1L) overridden by later options. The contents of the RC file just comprise a piece of code in the - - - - 7 July 2011 9 - - - - - -LATEXMK(1L) LATEXMK(1L) - - 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 @@ -647,6 +652,18 @@ LATEXMK(1L) LATEXMK(1L) Also reduce the number of informational messages that latexmk generates. + + + + 9 August 2011 10 + + + + + +LATEXMK(1L) LATEXMK(1L) + + To change the options used to make the commands run silently, you need to configure latexmk with changed values of its config- uration variables, the relevant ones being $bib- @@ -666,18 +683,6 @@ LATEXMK(1L) LATEXMK(1L) e.g., by \includegraphics{drawing} in a LaTeX file. In that case, latexmk will try making drawing.ext with ext set in turn to the possible extensions that are relevant for latex (or as - - - - 7 July 2011 10 - - - - - -LATEXMK(1L) LATEXMK(1L) - - appropriate pdflatex). See also the documentation for the $use_make_for_missing_files @@ -713,6 +718,18 @@ EXAMPLES % latexmk -pvc -ps thesis# run latex enough times to resolve cross-references, make a postscript file, start a previewer. Then + + + + 9 August 2011 11 + + + + + +LATEXMK(1L) LATEXMK(1L) + + watch for changes in the source file thesis.tex and any files it uses. After any changes rerun latex @@ -734,18 +751,6 @@ CONFIGURATION/INITIALIZATION (RC) FILES 1) The system RC file, if it exists. 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: - - - - 7 July 2011 11 - - - - - -LATEXMK(1L) LATEXMK(1L) - - "/opt/local/share/latexmk/LatexMk", "/usr/local/share/latexmk/LatexMk", "/usr/local/lib/latexmk/LatexMk". @@ -779,6 +784,18 @@ LATEXMK(1L) LATEXMK(1L) 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 -e option, which + + + + 9 August 2011 12 + + + + + +LATEXMK(1L) LATEXMK(1L) + + allows initialization code to be specified in latexmk's command line. @@ -802,18 +819,6 @@ HOW TO SET VARIABLES IN INITIALIZATION FILES push @default_files, 'paper2'; - - - - 7 July 2011 12 - - - - - -LATEXMK(1L) LATEXMK(1L) - - Note that simple "scalar" variables have names that begin with a $ character and array variables have names that begin with a @ character. Each statement ends with a semicolon. @@ -845,6 +850,18 @@ FORMAT OF COMMAND SPECIFICATIONS The two items starting with the % character are placeholders. These are substituted by appropriate values before the command is run. Thus + + + + 9 August 2011 13 + + + + + +LATEXMK(1L) LATEXMK(1L) + + %S will be replaced by the source file that elatex will be applied to, 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 @@ -870,18 +887,6 @@ FORMAT OF COMMAND SPECIFICATIONS If for some reason you need a literal % character in your string not subject to the above rules, use a pair of these characters. Thus with - - - - 7 July 2011 13 - - - - - -LATEXMK(1L) LATEXMK(1L) - - the command specification $ps_previewer = 'latex -ad=%%Sfile.ad %S', the %%S will become %S when the command is executed, but the %S will be replaced by the source filename, which in this case would be the name @@ -912,6 +917,17 @@ LATEXMK(1L) LATEXMK(1L) usable in initialization files" for what is normally the most appropri- ate usage. + + + 9 August 2011 14 + + + + + +LATEXMK(1L) LATEXMK(1L) + + If you omit to supply any placeholders whatever in the specification of a command, latexmk will supply what its author thinks are appropriate defaults. This gives compatibility with configuration files for previ- @@ -938,18 +954,6 @@ LATEXMK(1L) LATEXMK(1L) string, that is equivalent to having just one. (4) Under cygwin, some complications happen, since cygwin amounts to a complicated merging of UNIX and MS-Windows. See the source code for how I've handled the - - - - 7 July 2011 14 - - - - - -LATEXMK(1L) LATEXMK(1L) - - problem. Command names containing spaces: Under MS-Windows it is common that the @@ -978,6 +982,18 @@ LATEXMK(1L) LATEXMK(1L) See the above examples. Backslashes often get misinterpreted by the Unix shell used by Cygwin's Perl to execute external commands. Forward slashes don't suffer from this problem, and (when quoted, as above) are + + + + 9 August 2011 15 + + + + + +LATEXMK(1L) LATEXMK(1L) + + equally acceptable to MS-Windows. Using MS-Windows file associations: A useful trick under modern ver- @@ -1006,18 +1022,6 @@ LATEXMK(1L) LATEXMK(1L) for changing the name of the command called, but also to add options to command. Suppose you want latexmk to use latex with source specials enabled. Then you might use the following line in an initialization - - - - 7 July 2011 15 - - - - - -LATEXMK(1L) LATEXMK(1L) - - file: $latex = 'latex --src-specials %O %S'; @@ -1043,6 +1047,19 @@ LATEXMK(1L) LATEXMK(1L) + + + + + 9 August 2011 16 + + + + + +LATEXMK(1L) LATEXMK(1L) + + LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES Default values are indicated in brackets. @@ -1075,17 +1092,6 @@ LIST OF CONFIGURATION VARIABLES USABLE IN INITIALIZATION FILES and the postscript file is always generated, even if it is newer than the dvi file. - - - 7 July 2011 16 - - - - - -LATEXMK(1L) LATEXMK(1L) - - $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 @@ -1108,6 +1114,18 @@ LATEXMK(1L) LATEXMK(1L) This is an array variable, now mostly obsolete, that specifies directories where latexmk should look for .bib files. By default it is set from the BIBINPUTS environment variable of the + + + + 9 August 2011 17 + + + + + +LATEXMK(1L) LATEXMK(1L) + + operating system. If that environment variable is not set, a single element list consisting of the current directory is set. The format of the directory names depends on your operating sys- @@ -1145,17 +1163,6 @@ LATEXMK(1L) LATEXMK(1L) Switch(es) for the BibTeX processing program when silent mode is on. - - - 7 July 2011 17 - - - - - -LATEXMK(1L) LATEXMK(1L) - - $bibtex_use [1] Under what conditions to run BibTeX or biber. When latexmk dis- covers from the log file that one (or more) BibTeX/biber-gener- @@ -1173,6 +1180,18 @@ LATEXMK(1L) LATEXMK(1L) it appears necessary to update the bbl files, without testing for the existence of the bib files. + + + + 9 August 2011 18 + + + + + +LATEXMK(1L) LATEXMK(1L) + + $cleanup_includes_cusdep_generated [0] If nonzero, specifies that cleanup also deletes files that are generated by custom dependencies. (When doing a clean up, e.g., @@ -1198,8 +1217,8 @@ LATEXMK(1L) LATEXMK(1L) $clean_ext [""] Extra extensions of files for latexmk to remove when any of the clean-up options (-c or -C) is selected. The value of this - variable is a string containing the extensions separated by - spaces. + variable is a string containing the extensions separated by spa- + ces. It is also possible to specify a more general pattern of file to be deleted, by using the place holder %R, as in commands. Thus @@ -1214,18 +1233,6 @@ LATEXMK(1L) LATEXMK(1L) (as in FOO.tex). - - - - 7 July 2011 18 - - - - - -LATEXMK(1L) LATEXMK(1L) - - $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 @@ -1239,6 +1246,18 @@ LATEXMK(1L) LATEXMK(1L) Normally, if no filenames are specified on the command line, latexmk processes all tex files specified in the @default_files + + + + 9 August 2011 19 + + + + + +LATEXMK(1L) LATEXMK(1L) + + variable, which by default is set to all tex files ("*.tex") in the current directory. This is a convenience: just run latexmk and it will process an appropriate set of files. But sometimes @@ -1285,25 +1304,26 @@ LATEXMK(1L) LATEXMK(1L) will cause to be run whatever command the system has associated with .dvi files.] + $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.] + $dvipdf ["dvipdf %O %S %D"] + Command to convert dvi to pdf file. A common reconfiguration is - 7 July 2011 19 + 9 August 2011 20 -LATEXMK(1L) LATEXMK(1L) - $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.] +LATEXMK(1L) LATEXMK(1L) + - $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: @@ -1353,23 +1373,23 @@ LATEXMK(1L) LATEXMK(1L) 4 => run a command to do the update. The command is speci- fied by the variable $dvi_update_command. - See information on the variable $pdf_update_method for an + See information on the variable $pdf_update_method for an exam- + ple of updating by command. + $dvi_update_signal [Under UNIX: SIGUSR1, which is a system-dependent + value] - 7 July 2011 20 + 9 August 2011 21 -LATEXMK(1L) LATEXMK(1L) +LATEXMK(1L) LATEXMK(1L) - example of updating by command. - $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 $dvi_update_method. The default value is the one @@ -1427,7 +1447,7 @@ LATEXMK(1L) LATEXMK(1L) - 7 July 2011 21 + 9 August 2011 22 @@ -1490,14 +1510,10 @@ LATEXMK(1L) LATEXMK(1L) or biber run, the name of the file, but not its path is known. The program specified by $kpsewhich is used to find it. - See also the @BIBINPUTS variable for another way that latexmk - also uses to try to locate files; it applies only in the case of - .bib files. - - 7 July 2011 22 + 9 August 2011 23 @@ -1506,6 +1522,10 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) + See also the @BIBINPUTS variable for another way that latexmk + also uses to try to locate files; it applies only in the case of + .bib files. + $landscape_mode [0] If nonzero, run in landscape mode, using the landscape mode pre- viewers and dvi to postscript converters. Equivalent to the -l @@ -1556,24 +1576,24 @@ LATEXMK(1L) LATEXMK(1L) Switch(es) for the LaTeX processing program when silent mode is on. - If you use MikTeX, you may prefer the results if you configure - the options to include -c-style-errors, e.g., by the following - line in an initialization file - $latex_silent_switch = "-interaction=batchmode -c-style- - errors"; + 9 August 2011 24 - 7 July 2011 23 +LATEXMK(1L) LATEXMK(1L) + If you use MikTeX, you may prefer the results if you configure + the options to include -c-style-errors, e.g., by the following + line in an initialization file -LATEXMK(1L) LATEXMK(1L) + $latex_silent_switch = "-interaction=batchmode -c-style- + errors"; $lpr ["lpr %O %S" under UNIX/LINUX, "NONE lpr" under MS-WINDOWS] @@ -1622,31 +1642,31 @@ LATEXMK(1L) LATEXMK(1L) $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 - normal cases. - (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.) - $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 + 9 August 2011 25 - 7 July 2011 24 +LATEXMK(1L) LATEXMK(1L) -LATEXMK(1L) LATEXMK(1L) + 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 + normal cases. + (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.) - running will not start a new one. If $new_viewer_always is non- + $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 $new_viewer_always is non- zero, this check will be skipped, and latexmk will behave as if no viewer is running. @@ -1689,6 +1709,17 @@ LATEXMK(1L) LATEXMK(1L) removes the extension 'tex' from pdflatex_input_extensions + + + 9 August 2011 26 + + + + + +LATEXMK(1L) LATEXMK(1L) + + add_input_ext( 'pdflatex', 'asdf' ); add the extension 'asdf to pdflatex_input_extensions. (Natu- @@ -1704,18 +1735,6 @@ LATEXMK(1L) LATEXMK(1L) $pdflatex when silent mode is on. If you use MikTeX, you may prefer the results if you configure - - - - 7 July 2011 25 - - - - - -LATEXMK(1L) LATEXMK(1L) - - the options to include -c-style-errors, e.g., by the following line in an initialization file @@ -1756,6 +1775,17 @@ LATEXMK(1L) LATEXMK(1L) Arranging to use a command to get a previewer explicitly updated requires three variables to be set. For example: + + + 9 August 2011 27 + + + + + +LATEXMK(1L) LATEXMK(1L) + + $pdf_previewer = "start xpdf -remote %R %O %S"; $pdf_update_method = 4; $pdf_update_command = "xpdf -remote %R -reload"; @@ -1774,18 +1804,6 @@ LATEXMK(1L) LATEXMK(1L) variable $pdf_update_method. The default value is the one appropriate for gv on a UNIX system. - - - - 7 July 2011 26 - - - - - -LATEXMK(1L) LATEXMK(1L) - - $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. @@ -1822,6 +1840,18 @@ LATEXMK(1L) LATEXMK(1L) Type of file to printout: possibilities are "dvi", "none", "pdf", or "ps". + + + + 9 August 2011 28 + + + + + +LATEXMK(1L) LATEXMK(1L) + + $pscmd Command used to get all the processes currently run by the user. The -pvc option uses the command specified by the variable $pscmd to determine if there is an already running previewer, @@ -1829,8 +1859,8 @@ LATEXMK(1L) LATEXMK(1L) the previewer about file changes). Each line of the output of this command is assumed to correspond - to one process. See the $pid_position variable for how the pro- - cess number is determined. + to one process. See the $pid_position variable for how the + process number is determined. The default for pscmd is "NONE" under MS-Windows and cygwin (i.e., the command is not used), "ps --width 200 -f -u @@ -1843,21 +1873,9 @@ LATEXMK(1L) LATEXMK(1L) Command to convert ps to pdf file. $ps_filter [empty] - The postscript file filter to be run on the newly produced - postscript file before other processing. Equivalent to - - - - 7 July 2011 27 - - - - - -LATEXMK(1L) LATEXMK(1L) - - - specifying the -pF option. + The postscript file filter to be run on the newly produced post- + script file before other processing. Equivalent to specifying + the -pF option. $ps_previewer ["start gv %O %S", but "start %O %S" under MS-WINDOWS] The command to invoke a ps-previewer. (The default under MS- @@ -1888,6 +1906,18 @@ LATEXMK(1L) LATEXMK(1L) has 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 + + + + 9 August 2011 29 + + + + + +LATEXMK(1L) LATEXMK(1L) + + do the update, the command is specified by the variable $ps_update_command, and for the value 2, to specify update by signal, the signal is specified by $ps_update_signal.) @@ -1913,23 +1943,11 @@ LATEXMK(1L) LATEXMK(1L) The quoting method used by latexmk is tested to work correctly under UNIX systems (including Linux and Mac OS-X) and under MS-Windows. It - allows the use of filenames containing special characters, notably - spaces. (But note that many versions of LaTeX and PdfLaTeX cannot cor- - rectly deal with TeX files whose names contain spaces. Latexmk's - - - - 7 July 2011 28 - - - - - -LATEXMK(1L) LATEXMK(1L) - - - quoting only ensures that such filenames are correctly treated by the - operating system in passing arguments to programs.) + allows the use of filenames containing special characters, notably spa- + ces. (But note that many versions of LaTeX and PdfLaTeX cannot cor- + rectly deal with TeX files whose names contain spaces. Latexmk's quot- + ing only ensures that such filenames are correctly treated by the oper- + ating system in passing arguments to programs.) $recorder [0] Whether to use the -recorder option to latex and pdflatex. Use @@ -1953,6 +1971,19 @@ LATEXMK(1L) LATEXMK(1L) tex.fls to a file with the basename of the main LaTeX document, e.g., Document.fls. + + + + + 9 August 2011 30 + + + + + +LATEXMK(1L) LATEXMK(1L) + + $sleep_time [2] The time to sleep (in seconds) between checking for source file changes when running with the -pvc option. This is subject to a @@ -1987,18 +2018,6 @@ LATEXMK(1L) LATEXMK(1L) Whether to use make to try and make files that are missing after a run of latex or pdflatex, and for which a custom dependency has not been found. This is generally useful only when latexmk - - - - 7 July 2011 29 - - - - - -LATEXMK(1L) LATEXMK(1L) - - is used as part of a bigger project which is built by using the make program. @@ -2019,6 +2038,18 @@ 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 + + + + 9 August 2011 31 + + + + + +LATEXMK(1L) LATEXMK(1L) + + would be to allow latexmk to convert a .fig file to .eps to be included in the .tex file. @@ -2058,18 +2089,6 @@ CUSTOM DEPENDENCIES 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- - - - - 7 July 2011 30 - - - - - -LATEXMK(1L) LATEXMK(1L) - - 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 @@ -2085,6 +2104,18 @@ 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 + + + + 9 August 2011 32 + + + + + +LATEXMK(1L) LATEXMK(1L) + + exist. A simple and typical example of code in an initialization rcfile is @@ -2128,28 +2159,28 @@ LATEXMK(1L) LATEXMK(1L) system("fig2dev -Lps '$_[0].fig' '$_[0].eps'"); } - This causes the invocation of the fig2dev program to have quoted + 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 spa- + ces. 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 - 7 July 2011 31 + 9 August 2011 33 -LATEXMK(1L) LATEXMK(1L) - filenames; it should therefore work with filenames containing spaces. - However, 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. +LATEXMK(1L) LATEXMK(1L) - 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 add_cus_dep( 'fig', 'pdf, 0, 'fig2pdf' ); sub fig2pdf { @@ -2200,10 +2231,15 @@ LATEXMK(1L) LATEXMK(1L) 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 .nnd (or and .aux + file, etc) that changes on each new run, then you will have a problem. + For real experts: See the %hash_cal_ignore_pattern if you have to deal + with such problems. + - 7 July 2011 32 + 9 August 2011 34 @@ -2212,11 +2248,6 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) - 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 %hash_cal_ignore_pattern if you have to deal - with such problems. - Glossaries can be dealt with similarly. @@ -2274,7 +2305,7 @@ USING latexmk WITH make - 7 July 2011 33 + 9 August 2011 35 @@ -2337,15 +2368,10 @@ LATEXMK(1L) LATEXMK(1L) -e 'warn qq(In Makefile, turn off custom dependencies0;' \ -e '@cus_dep_list = ();' \ -e 'show_cus_dep();' - all : $(TARGETS) - $(foreach file,$(TARGETS),$(eval -include $(DEPS_DIR)/$(file)P)) - $(DEPS_DIR) : - mkdir $@ - %.pdf : %.tex - 7 July 2011 34 + 9 August 2011 36 @@ -2354,6 +2380,11 @@ LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) LATEXMK(1L) + all : $(TARGETS) + $(foreach file,$(TARGETS),$(eval -include $(DEPS_DIR)/$(file)P)) + $(DEPS_DIR) : + mkdir $@ + %.pdf : %.tex if [ ! -e $(DEPS_DIR) ]; then mkdir $(DEPS_DIR); fi $(LATEXMK) -pdf -dvi- -ps- -deps-out=$(DEPS_DIR)/$@P $< %.pdf : %.fig @@ -2402,21 +2433,11 @@ BUGS manually refresh (or reopen) display. Or use one of the other preview- ers and update methods. - (The following isn't really a bug, but concerns features of preview- - ers.) Preview continuous mode only works perfectly with certain pre- - viewers: Xdvi on UNIX/LINUX works for dvi files. 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, 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 - pdf file cannot be updated. (Remedy: configure latexmk to use gsview - instead.) + (The following isn't really a bug, but concerns features of - 7 July 2011 35 + 9 August 2011 37 @@ -2425,6 +2446,17 @@ BUGS LATEXMK(1L) LATEXMK(1L) + previewers.) Preview continuous mode only works perfectly with certain + previewers: Xdvi on UNIX/LINUX works for dvi files. 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, 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 + pdf file cannot be updated. (Remedy: configure latexmk to use gsview + instead.) + THANKS TO Authors of previous versions. Many users with their feedback, and especially David Coppit (username david at node coppit.org) who made @@ -2434,10 +2466,10 @@ THANKS TO AUTHOR Current version, by John Collins (username collins at node - phys.psu.edu). (Version 4.25). + phys.psu.edu). (Version 4.26). - Released version can be obtained from CTAN: <http://www.tug.org/tex- - archive/support/latexmk/>, and from the author's website + Released version can be obtained from CTAN: <http://www.tug.org/tex-ar- + chive/support/latexmk/>, and from the author's website <http://www.phys.psu.edu/~collins/software/latexmk/>. Modifications and enhancements by Evan McLean (Version 2.0) Original script called "go" by David J. Musliner (RCS Version 3.2) @@ -2471,22 +2503,6 @@ AUTHOR - - - - - - - - - - - - - - - - - 7 July 2011 36 + 9 August 2011 38 |