diff options
Diffstat (limited to 'Master/texmf-dist/doc/support/light-latex-make/llmk.tex')
-rw-r--r-- | Master/texmf-dist/doc/support/light-latex-make/llmk.tex | 69 |
1 files changed, 53 insertions, 16 deletions
diff --git a/Master/texmf-dist/doc/support/light-latex-make/llmk.tex b/Master/texmf-dist/doc/support/light-latex-make/llmk.tex index 61673f016e9..2884d211a10 100644 --- a/Master/texmf-dist/doc/support/light-latex-make/llmk.tex +++ b/Master/texmf-dist/doc/support/light-latex-make/llmk.tex @@ -1,8 +1,8 @@ % llmk: the reference manual -% Copyright 2020 Takuto ASAKURA (wtsnjp) +% Copyright 2020-2023 Takuto Asakura (wtsnjp) % +++ -% latex = "xelatex" +% latex = "texfot xelatex" % +++ \documentclass{llmk-doc} @@ -10,7 +10,7 @@ \title{llmk: Light {\LaTeX} Make} \author{Takuto Asakura (wtsnjp)} \subtitle{Reference Manual} -\date{v1.1.0\quad\today} +\date{v1.2.0\quad\today} \keywords{llmk, build-tool, toml, lua, luatex} \begin{document} @@ -220,9 +220,9 @@ programs that failed, if any, are reported in the error messages. \begin{tabular}{rp{12em}rp{12em}} \toprule Code & Error type & Code & Error Type \\ \midrule -\code{0} & Success & \code{3} & Parser Error \\ -\code{1} & General Error & \code{4} & Type Error \\ -\code{2} & Invoked program failed & \\ +\code{0} & Success & \code{3} & Parser error \\ +\code{1} & General error & \code{4} & Type error \\ +\code{2} & Error in invoked program & \\ \bottomrule \end{tabular} \end{center} @@ -249,7 +249,7 @@ keys (Section~\ref{sec:top-level-keys}~\&~\ref{sec:keys-in-programs}) are supported. \begin{center} -\newcommand{\ok}{{\color{special}\checkmark}} +\newcommand{\ok}{{\color{special}\usym{1F5F8}}} \begin{tabular}{llc} \toprule Type & Example & Supported \\ \midrule @@ -368,8 +368,12 @@ executing actions by \prog{llmk}: argument or as an element of the \ckey{source} array. \item |%T| is replaced by the target for each program. -\item |%B| +\item |%o| + is replaced by the output directory, or \code{.} if none was specified. +\item |%b| is replaced by the basename of |%S|. +\item |%B| + is replaced by the output directory concatenated with the basename of |%S|. \end{itemize} Some keys have default values; the default configuration of \prog{llmk} should @@ -462,6 +466,13 @@ the \ckey{command} key is specified in the \ckey{programs} table, this alias is ineffective. \end{confkey} +\begin{confkey}{makeglossaries}{type: \type{string}}[default: \code{"makeglossaries"}] +The command to use for the \progname{makeglossaries} program. Internally, this key +is an alias for the \ckey{command} key in the \progname{makeglossaries} entry. If +the \ckey{command} key is specified in the \ckey{programs} table, this alias is +ineffective. +\end{confkey} + \begin{confkey}{max\_repeat}{type: \type{integer}}[default: \code{5}] You can specify the maximum number of execution repetitions for each command in your \ckey{sequence}. When processing your \ckey{sequence}, \prog{llmk} repeats @@ -470,6 +481,10 @@ the key is specified and the corresponding auxiliary file exists. This key is to prevent the potential infinite loop of repetition. \end{confkey} +\begin{confkey}{output\_directory}{type: \type{string}} +Use this option to specify a directory where \progname{latex} output files should be written to and read from. This directory must already exist, or else \prog{llmk} will fail with an error. If the option is not specified, then output files will be written to the directory where \prog{llmk} is run from. +\end{confkey} + \begin{confkey}{programs}{type: \type{table}} [default: see Section~\ref{sec:default-programs}] The table that contains the detailed configuration for each program. See @@ -644,7 +659,12 @@ command is chosen for the default. \begin{lstlisting}[style=toml] [programs.latex] command = "lualatex" -opts = ["-interaction=nonstopmode", "-file-line-error", "-synctex=1"] +opts = [ + "-interaction=nonstopmode", + "-file-line-error", + "-synctex=1", + '-output-directory="%o"' +] aux_file = "%B.aux" aux_empty_size = 9 \end{lstlisting} @@ -661,6 +681,20 @@ generated_target = true postprocess = "latex" \end{lstlisting} +\Program{makeglossaries} The entry for the Makeglossaries program and friends. The +\progname{latex} program is set as \ckey{postprocess} so that to make sure +rerunning {\LaTeX} command after this execution. +% +\begin{lstlisting}[style=toml] +[programs.makeglossaries] +command = "makeglossaries" +target = "%B.glo" +generated_target = true +postprocess = "latex" +opts = ['-d "%o"'] +args = ["%b.glo"] +\end{lstlisting} + \Program{ps2pdf} The entry for the \prog{ps2pdf} program and friends. % \begin{lstlisting}[style=toml] @@ -676,7 +710,7 @@ generated_target = true The following is the default value for the \ckey{sequence} array: % \begin{htcode} -["latex", "bibtex", "makeindex", "dvipdf"] +["latex", "bibtex", "makeindex", "makeglossaries", "dvipdf"] \end{htcode} With these default settings in the \ckey{programs} table the \ckey{sequence} @@ -691,9 +725,10 @@ array, the default behavior of \prog{llmk} can be summarized as follows. \code{\%B.bib}, exists, the {\BibTeX} program is executed. When the execution occurs, the \progname{latex} program is executed again right after because the program is set as \ckey{postprocess}. -\item Identically, if the corresponding input file for Makeindex exists, the - program is executed. When the execution occurs, the \progname{latex} program - is executed again right after because the program is set as \ckey{postprocess}. +\item Identically, if the corresponding input files for Makeindex and + Makeglossaries exist, the program is executed. When the execution occurs, + the \progname{latex} program is executed again right after because the + program is set as \ckey{postprocess}. \item In case the corresponding DVI file is generated in the previous steps, though this will not happen with the default value of \ckey{latex}, \ie \code{"lualatex"}, the \progname{dvipdf} program, by default \code{dvipdfmx}, @@ -705,9 +740,11 @@ easier to use other tools from the above. For instance, if you wan to use $\text{\progname{dvips}}+\text{\progname{ps2pdf}}$ combination instead of \progname{dvipdf}, you can just modify the value of \ckey{sequence} a bit: % -\begin{lstlisting}[style=toml] -sequence = ["latex", "bibtex", "makeindex", "dvips", "ps2pdf"] -\end{lstlisting} +\begin{htcode} +sequence = [ + "latex", "bibtex", "makeindex", "makeglossaries", "dvips", "ps2pdf" +] +\end{htcode} \section{Other supported formats} \label{sec:magic-comment} |