From 2a8c3416c9a62db3f1dd8082bb5a065dd6bfc0f8 Mon Sep 17 00:00:00 2001 From: Karl Berry Date: Wed, 1 Jan 2020 21:52:34 +0000 Subject: latexmk (1jan20) git-svn-id: svn://tug.org/texlive/trunk@53293 c570f23f-e606-0410-a88d-b1316a301751 --- Master/texmf-dist/doc/support/latexmk/latexmk.txt | 2006 +++++++++++---------- 1 file changed, 1036 insertions(+), 970 deletions(-) (limited to 'Master/texmf-dist/doc/support/latexmk/latexmk.txt') diff --git a/Master/texmf-dist/doc/support/latexmk/latexmk.txt b/Master/texmf-dist/doc/support/latexmk/latexmk.txt index 6f625423802..562501fb4fc 100644 --- a/Master/texmf-dist/doc/support/latexmk/latexmk.txt +++ b/Master/texmf-dist/doc/support/latexmk/latexmk.txt @@ -61,7 +61,7 @@ DESCRIPTION - 18 June 2019 1 + 26 December 2019 1 @@ -127,7 +127,7 @@ LATEXMK OPTIONS AND ARGUMENTS ON COMMAND LINE - 18 June 2019 2 + 26 December 2019 2 @@ -193,7 +193,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 3 + 26 December 2019 3 @@ -259,7 +259,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 4 + 26 December 2019 4 @@ -325,7 +325,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 5 + 26 December 2019 5 @@ -391,7 +391,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 6 + 26 December 2019 6 @@ -457,7 +457,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 7 + 26 December 2019 7 @@ -523,7 +523,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 8 + 26 December 2019 8 @@ -589,7 +589,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 9 + 26 December 2019 9 @@ -655,7 +655,7 @@ LATEXMK(1) General Commands Manual LATEXMK(1) - 18 June 2019 10 + 26 December 2019 10 @@ -703,6 +703,13 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -l- Turn off -l. + -latex This sets the generation of dvi files by latex, and turns off + the generation of pdf and ps files. + + Note: to set the command used when latex is specified, see the + -latex="COMMAND" option. + + -latex="COMMAND" This sets the string specifying the command to run latex, and is typically used to add desired options. Since the string nor- @@ -711,17 +718,10 @@ LATEXMK(1) General Commands Manual LATEXMK(1) latexmk -latex="latex --shell-escape %O %S" foo.tex The specification of the contents of the string are the same as - for the $latex configuration variable. Depending on your oper- - ating system and the command-line shell you are using, you may - need to change the single quotes to double quotes (or something - else). - - To set the command for running pdflatex (rather than the command - for latex) see the -pdflatex option. - 18 June 2019 11 + 26 December 2019 11 @@ -730,35 +730,72 @@ LATEXMK(1) General Commands Manual LATEXMK(1) LATEXMK(1) General Commands Manual LATEXMK(1) + for the $latex configuration variable. Depending on your oper- + ating system and the command-line shell you are using, you may + need to change the single quotes to double quotes (or something + else). + + Note: This option when provided with the COMMAND argument only + sets the command for invoking latex; it does not turn on the use + of latex. That is done by other options or in an initialization + file. + + To set the command for running pdflatex (rather than the command + for latex) see the -pdflatex option. + + -logfilewarninglist -logfilewarnings After a run of (pdf)latex, give a list of warn- - ings about undefined citations and references (unless silent + ings about undefined citations and references (unless silent mode is on). See also the $silence_logfile_warnings configuration variable. -logfilewarninglist- - -logfilewarnings- After a run of (pdf)latex, do not give a list + -logfilewarnings- After a run of (pdf)latex, do not give a list of warnings about undefined citations and references. (Default) See also the $silence_logfile_warnings configuration variable. -lualatex - Use lualatex. That is, use lualatex to process the source - file(s) to pdf. The generation of dvi and postscript files is + Use lualatex. That is, use lualatex to process the source + file(s) to pdf. The generation of dvi and postscript files is turned off. This option is equivalent to using the following set of options -pdflua -dvi- -ps- - (Note: Note that the method of implementation of this option, - but not its intended effect, differ from some earlier versions + (Note: Note that the method of implementation of this option, + but not its intended effect, differ from some earlier versions of latexmk.) + -lualatex="COMMAND" + This sets the string specifying the command to run lualatex. It + behaves like the -pdflatex option, but sets the variable $luala- + tex. + + Note: This option when provided with the COMMAND argument only + sets the command for invoking lualatex; it does not turn on the + use of lualatex. That is done by other options or in an initial- + ization file. + + + + + + 26 December 2019 12 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + -M Show list of dependent files after processing. This is equiva- lent to the -deps option. @@ -785,17 +822,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) option turns off the default behavior. - - - 18 June 2019 12 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - -new-viewer- The inverse of the -new-viewer option. It puts latexmk in its normal behavior that in preview-continuous mode it checks for an @@ -824,6 +850,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) See also the -auxdir/-aux-directory options, and the $aux_dir, $out_dir, and $search_path_separator configuration variables of + + + + 26 December 2019 13 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + latexmk. In particular, see the documentation of $out_dir for some complications on what directory names are suitable. @@ -852,16 +890,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) turns them off. - - 18 June 2019 13 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - -pdf Generate pdf version of document using pdflatex. (If you wish to use lualatex or xelatex, you can use whichever of the options -pdflua, -pdfxe, -lualatex or -xelatex applies.) To configure @@ -888,27 +916,48 @@ LATEXMK(1) General Commands Manual LATEXMK(1) multiple runs to generate a fully up-to-date .xdv file does la- texmk then call xdvipdfmx to generate the final .pdf file. - (Note: When the document includes large graphics files, espe- - cially .png files, the last step can be quite time consuming, - even when the creation of the .xdv file by xelatex is fast. So - the use of the intermediate .xdv file can result in substantial - gains in procesing time, since the .pdf file is produced once - rather than on every run of xelatex. See the documentation on - the -pdfxe option for why an .xdv file is used. - -pdf- Turn off generation of pdf version of document. (This can be - used to override a setting in a configuration file. It may get + + 26 December 2019 14 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + + (Note: The reason why latexmk arranges for xelatex to make an + .xdv file instead of the xelatex's default of a .pdf file is as + follows: When the document includes large graphics files, espe- + cially .png files, the production of a .pdf file can be quite + time consuming, even when the creation of the .xdv file by xela- + tex is fast. So the use of the intermediate .xdv file can re- + sult in substantial gains in procesing time, since the .pdf file + is produced once rather than on every run of xelatex.) + + + -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.) - If after all options have been processed, pdf generation is - still turned off, then generation of a dvi file will be turned + If after all options have been processed, pdf generation is + still turned off, then generation of a dvi file will be turned on, and then the program used to compiled a document will be la- - tex (or, more precisely, whatever program is configured to be + tex (or, more precisely, whatever program is configured to be used in the $latex configuration variable). + -pdflatex + This sets the generation of pdf files by pdflatex, and turns off + the generation of dvi and ps files. + + Note: to set the command used when pdflatex is specified, see + the -pdflatex="COMMAND" option. + + -pdflatex="COMMAND" This sets the string specifying the command to run pdflatex, and is typically used to add desired options. Since the string nor- @@ -917,49 +966,40 @@ LATEXMK(1) General Commands Manual LATEXMK(1) latexmk -pdf -pdflatex="pdflatex --shell-escape %O %S" foo.tex + The specification of the contents of the string are the same as + for the $pdflatex configuration variable. (The option -pdflatex + in fact sets the variable $pdflatex.) Depending on your operat- + ing system and the command-line shell you are using, you may + need to change the single quotes to double quotes (or something + else). + Note: This option when provided with the COMMAND argument only + sets the command for invoking pdflatex; it does not turn on the + use of pdflatex. That is done by other options or in an initial- + ization file. - 18 June 2019 14 - - + To set the command for running latex (rather than the command + for pdflatex) see the -latex option. -LATEXMK(1) General Commands Manual LATEXMK(1) - The specification of the contents of the string are the same as - for the $pdflatex configuration variable. (The option -pdflatex - in fact sets the variable $pdflatex.) Depending on your operat- - ing system and the command-line shell you are using, you may - need to change the single quotes to double quotes (or something - else). + 26 December 2019 15 - To set the command for running latex (rather than the command - for pdflatex) see the -latex option. - -pdflualatex="COMMAND" - This sets the string specifying the command to run lualatex. It - behaves like the -pdflatex option, but sets the variable $luala- - tex. - -pdfxelatex="COMMAND" - This sets the string specifying the command to run xelatex. It - behaves like the -pdflatex option, but sets the variable $xela- - tex. +LATEXMK(1) General Commands Manual LATEXMK(1) - Warning: It is important to ensure that the -no-pdf is used when - xelatex is invoked; see the explanation for the variable $xela- - tex for why this is necessary. If you provide %O in the command - specification, this will be done automatically. - An example of the use of the -pdfxelatex option: + -pdflualatex="COMMAND" + Equivalent to -lualatex="COMMAND". - latexmk -pdfxe -pdfxelatex="xelatex --shell-escape %O %S" - foo.tex + -pdfxelatex="COMMAND" + Equivalent to -xelatex="COMMAND". -pretex=CODE @@ -982,18 +1022,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) latexmk -usepretex='\AtBeginDocument{Message\par}' foo.tex - - - - 18 June 2019 15 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - If you already have a suitable command configured, you only need latexmk -pretex='\AtBeginDocument{Message\par}' foo.tex @@ -1020,6 +1048,18 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -pF Postscript file filtering. The argument to this option is a filter which will generate a filtered postscript file with the + + + + 26 December 2019 16 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + extension ".psF". All extra processing (e.g. preview, printing) will then be performed on this filtered postscript file. @@ -1048,18 +1088,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) -pv- Turn off -pv. - - - - 18 June 2019 16 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - -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 @@ -1087,6 +1115,17 @@ LATEXMK(1) General Commands Manual LATEXMK(1) mode. It is better to use a different viewer: SumatraPDF and gsview are good possibilities. + + + 26 December 2019 17 + + + + + +LATEXMK(1) General Commands Manual LATEXMK(1) + + There are some other methods for arranging an update, notably useful for many versions of xdvi and xpdf. These are best set in latexmk's configuration; see below. @@ -1114,18 +1153,6 @@ LATEXMK(1) General Commands Manual LATEXMK(1) Don't do timeout in pvc mode after inactivity. - - - - 18 June 2019 17 - - - - - -LATEXMK(1) General Commands Manual LATEXMK(1) - - -pvctimeoutmins=