diff options
Diffstat (limited to 'Master/texmf-dist/doc')
| -rw-r--r-- | Master/texmf-dist/doc/man/man1/llmk.1 | 14 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/man/man1/llmk.man1.pdf | bin | 21786 -> 22160 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/light-latex-make/README.md | 16 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/light-latex-make/llmk-doc.cls | 15 | ||||
| -rw-r--r-- | Master/texmf-dist/doc/support/light-latex-make/llmk-logo.png | bin | 79049 -> 77263 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/light-latex-make/llmk.pdf | bin | 92657 -> 93443 bytes | |||
| -rw-r--r-- | Master/texmf-dist/doc/support/light-latex-make/llmk.tex | 100 |
7 files changed, 77 insertions, 68 deletions
diff --git a/Master/texmf-dist/doc/man/man1/llmk.1 b/Master/texmf-dist/doc/man/man1/llmk.1 index 55bc26df329..1f284f5de98 100644 --- a/Master/texmf-dist/doc/man/man1/llmk.1 +++ b/Master/texmf-dist/doc/man/man1/llmk.1 @@ -1,10 +1,10 @@ .\" generated with Ronn/v0.7.3 .\" http://github.com/rtomayko/ronn/tree/0.7.3 . -.TH "LLMK" "1" "September 2020" "llmk 0.1.0" "llmk manual" +.TH "LLMK" "1" "October 2020" "llmk 0.2.0" "llmk manual" . .SH "NAME" -\fBllmk\fR \- The Light LaTeX Make +\fBllmk\fR \- Light LaTeX Make . .SH "SYNOPSIS" \fBllmk\fR [OPTION]\.\.\. [FILE]\.\.\. @@ -38,6 +38,10 @@ Activate all debug output (equal to "\-\-debug=all")\. Print this help message\. . .TP +\fB\-n\fR, \fB\-\-dry\-run\fR +Show what would have been executed\. +. +.TP \fB\-q\fR, \fB\-\-quiet\fR Suppress warnings and most error messages\. . @@ -47,7 +51,7 @@ Silence messages from called programs\. . .TP \fB\-v\fR, \fB\-\-verbose\fR -Print additional information (e\.g\., viewer command)\. +Print additional information (e\.g\., running commands)\. . .TP \fB\-V\fR, \fB\-\-version\fR @@ -76,10 +80,10 @@ Parser error\. Type error\. . .SH "REPORTING BUGS" -Report bugs to tkt\.asakura@gmail\.com\. +Report bugs to \fIhttps://github\.com/wtsnjp/llmk/issues\fR\. . .br -Source: https://github\.com/wtsnjp/llmk +Source: \fIhttps://github\.com/wtsnjp/llmk\fR . .SH "COPYRIGHT" Copyright 2018\-2020 Takuto ASAKURA (wtsnjp)\. diff --git a/Master/texmf-dist/doc/man/man1/llmk.man1.pdf b/Master/texmf-dist/doc/man/man1/llmk.man1.pdf Binary files differindex c0ac06f8108..8e79d3a1b8d 100644 --- a/Master/texmf-dist/doc/man/man1/llmk.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/llmk.man1.pdf diff --git a/Master/texmf-dist/doc/support/light-latex-make/README.md b/Master/texmf-dist/doc/support/light-latex-make/README.md index 9b6c51325a1..b7d7d0f0ca4 100644 --- a/Master/texmf-dist/doc/support/light-latex-make/README.md +++ b/Master/texmf-dist/doc/support/light-latex-make/README.md @@ -10,11 +10,17 @@ This is yet another build tool for LaTeX documents. The features of **llmk** are * no complicated nesting of configuration, and * modern default settings (make LuaTeX de facto standard!) -See the bundled reference manual (llmk.pdf) for the full specification of the program. The following sections are for a quick guidance. +See the bundled reference manual ([llmk.pdf](http://mirrors.ctan.org/support/light-latex-make/llmk.pdf)) for the full specification of the program. The following sections are for a quick guidance. + +## Installation + +This software is included in [TeX Live](https://www.tug.org/texlive/) as Package `light-latex-make`. If you are using the latest TeX Live, you normally don't need to install it by yourself (please use the `tlmgr` command to install it, if the package is missing). + +In case the package is not installed in your TeX system or you want to use the latest (development) version of the program, you have to install it manually. You can acquire any material related to this software from [our GitHub repository](https://github.com/wtsnjp/llmk). The installation procedure is very simple anyway because the `llmk.lua` is the standalone executable. Running `texlua <path>/llmk.lua` should work in any case. In UNIX-like systems, the easiest way to install the program is copy or symlink the file `llmk.lua` as `llmk` in any place in the `PATH`. ## Basic Usage -The easiest way to use **llmk** is to write the build settings into the LaTeX document itself. The settings can be written as [TOML](https://toml.io) format in comments of a source file, and those have to be placed between the comment lines only with the consecutive `+` characters (at least three). +The most simple way to use **llmk** is to write the build settings into the LaTeX document itself. The settings can be written as [TOML](https://toml.io) format in comments of a source file, and those have to be placed between the comment lines only with the consecutive `+` characters (at least three). Here's a very simple example: @@ -217,6 +223,12 @@ target = "%B.ps" generated_target = true ``` +## Links to other materials + +* [Reference manual](http://mirrors.ctan.org/support/light-latex-make/llmk.pdf): it describes the full specification. +* [Talk in TUG 2020](https://www.youtube.com/watch?v=kzqlNHKmzBo): the author talked about the design concept with a demonstration. +* [TUGboat article](https://tug.org/members/TUGboat/tb41-2/tb128asakura-llmk.pdf): the post-proceedings of the above talk. (currently TUG member access only) + ## Acknowledgements This project has been supported by the [TeX Development Fund](https://www.tug.org/tc/devfund/) created by the TeX Users Group (No. 29). I would like to thank all contributors and the people who gave me advice and suggestions for new features for the llmk project. diff --git a/Master/texmf-dist/doc/support/light-latex-make/llmk-doc.cls b/Master/texmf-dist/doc/support/light-latex-make/llmk-doc.cls index fedf4a7a2cd..632becfcd3d 100644 --- a/Master/texmf-dist/doc/support/light-latex-make/llmk-doc.cls +++ b/Master/texmf-dist/doc/support/light-latex-make/llmk-doc.cls @@ -16,7 +16,7 @@ \def\@tempb{\@gobble}% \@for\next:=\@classoptionslist\do {\ifx\next\@tempa - \message{Cleared option \next\space from global list}% + \message{Cleared option \next\space from global list}% \else \edef\@tempb{\@tempb,\next}% \fi}% @@ -131,7 +131,7 @@ \vskip 1em {\fontsize{1.2cm}{0pt}\selectfont\logomainfont llmk} \vskip .3em - {\fontsize{0.5cm}{0pt}\selectfont\logosubfont The Light {\LaTeX} Make} + {\fontsize{0.5cm}{0pt}\selectfont\logosubfont Light {\LaTeX} Make} \vskip .5em %{\ifx\@subtitle\@empty\else\usekomafont{subtitle}\@subtitle\par\fi}% \vskip 1em @@ -166,8 +166,8 @@ \newcommand*{\hyph}{-} \newcommand*{\meta}[1]{\bgroup \normalfont\color{special}$\langle$\textit{#1}$\rangle$\egroup} -\newcommand*{\code}[1]{\bgroup - \chardef\_=`\_\code@font #1\egroup} +\DeclareRobustCommand{\code}[1]{% + \texorpdfstring{\bgroup\chardef\_=`\_\code@font #1\egroup}{#1}} \newcommand*{\cs}[1]{\texttt{\char`\\#1}} \newcommand*{\sopt}[1]{\hyperlink{clo:#1}{\code{\hyph#1}}} \newcommand*{\lopt}[1]{\hyperlink{clo:#1}{\code{\hyph{}\hyph#1}}} @@ -182,6 +182,13 @@ \expandafter\egroup\x \hyperlink{\@tmp@hyname}{\code{#1}}} \newcommand*{\type}[1]{\textcolor{special}{#1}} +\newcommand*{\README}{% + \href{https://github.com/wtsnjp/llmk/blob/master/README.md} + {\code{README.md}}} +\newcommand{\printLICENSE}{% + \IfFileExists{./LICENSE}{\input{./LICENSE}}{% else + \IfFileExists{../LICENSE}{\input{../LICENSE}}{% else + \message{File LICENSE not found}}}} % verbatim \def\code@font{% code diff --git a/Master/texmf-dist/doc/support/light-latex-make/llmk-logo.png b/Master/texmf-dist/doc/support/light-latex-make/llmk-logo.png Binary files differindex 2e079487e85..768f202812e 100644 --- a/Master/texmf-dist/doc/support/light-latex-make/llmk-logo.png +++ b/Master/texmf-dist/doc/support/light-latex-make/llmk-logo.png diff --git a/Master/texmf-dist/doc/support/light-latex-make/llmk.pdf b/Master/texmf-dist/doc/support/light-latex-make/llmk.pdf Binary files differindex 17f9258386c..d74d3d42117 100644 --- a/Master/texmf-dist/doc/support/light-latex-make/llmk.pdf +++ b/Master/texmf-dist/doc/support/light-latex-make/llmk.pdf 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 2bb140dc0e4..7f145a371e0 100644 --- a/Master/texmf-dist/doc/support/light-latex-make/llmk.tex +++ b/Master/texmf-dist/doc/support/light-latex-make/llmk.tex @@ -10,7 +10,7 @@ \title{llmk: Light {\LaTeX} Make} \author{Takuto Asakura (wtsnjp)} \subtitle{Reference Manual} -\date{v0.1.0\quad\today} +\date{v0.2.0\quad\today} \keywords{llmk, build-tool, toml, lua, luatex} \begin{document} @@ -19,8 +19,8 @@ \section{Overview} -The \prog{llmk} program is yet another build tool specific for {\LaTeX} -documents. Its aim is to provide a simple way to specify a workflow of +Light {\LaTeX} Make (\prog{llmk}) is yet another build tool specific for +{\LaTeX} documents. Its aim is to provide a simple way to specify a workflow of processing {\LaTeX} documents and encourage people to always explicitly show the right workflow for each document. @@ -36,15 +36,20 @@ configuration. Therefore, one can guarantee that a {\LaTeX} document with an \prog{llmk} setup, the process of typesetting the document must be reproduced in any {\TeX} environment with the program. -% TODO: explain that llmk is included in TeX Live and MiKTeX when ready +\subsection{Installation} + +This software is included in {\TeX} Live as Package \code{light-latex-make}. If +you have the latest {\TeX} Live, you normally don't need to install it by +yourself. If you want to install the development version, please refer to our +{\README}. +% TODO: mention MiKTeX when ready \subsection{Learning \prog{llmk}} -The bundled \href{https://github.com/wtsnjp/llmk/blob/master/README.md} -{\code{README.md}} has a general introduction for the program. If you are new -to \prog{llmk} and looking for a quick guidance, you are recommended to read it -first. Conversely, this document can be regarded as a reference manual: it -contains detailed descriptions for every feature of \prog{llmk} as much as +The bundled {\README} has a general introduction for the program. If you are +new to \prog{llmk} and looking for a quick guidance, you are recommended to +read it first. Conversely, this document can be regarded as a reference manual: +it contains detailed descriptions for every feature of \prog{llmk} as much as possible, but unsuitable for getting general ideas of its basic usage. \begin{samepage} @@ -85,11 +90,6 @@ author cannot promise to implement the requested features, but will happy to take them into account. Before making a request, it is strongly recommended to read the article about the design concept~\cite{asakura2020}. -One more thing: as you can see, the author of the program is not a native -English speaker. Thus, there should be plenty of grammatical errors and -unnatural sentences in the documentation, including this manual itself. -Correction for such writing issues is particularly welcome. - \section{Command-line interface} \subsection{Command usage} @@ -143,21 +143,19 @@ formats, in each source {\LaTeX} files specified in the \ckey{source} array will be ignored. \subsubsection*{Command-line options \meta{options}} +\enlargethispage{5mm}% FIXME We have tried to implement a GNU-compatible option parser. Short options, each of which consists of a single letter, must start with a single hyphen |-|. Multiple short options can be specified with a single hyphen, \eg |-vs| is equivalent to |-v -s|. Long options have to be following double hyphens |--|. All options must be specified before the first argument. A string beginning -with a hyphen after the first argument will be treated as an argument starting -with a hyphen. +with a hyphen after the first argument will be treated as an argument. When two or more options are specified, \prog{llmk} applies them in the given order. If contradicting options are specified, \eg \sopt{q} v.s.\ \sopt{v}, the option in the latter position wins over the former one. -The following is the full list of available command-line options: - \begin{clopt}{\sopt{c}, \lopt{clean}} Removes temporary files such as \code{aux} and \code{log} files. The files removed with this action can be customized with the key \ckey{clean\_files}. @@ -185,6 +183,13 @@ successfully. When this is specified, all other options and arguments are ignored. \end{clopt} +\begin{clopt}{\sopt{n}, \lopt{dry-run}} +Show what would have been executed without actually invoking the commands. This +flag is useful if you want to make sure whether your configuration will work as +expected before the actual building. With option \lopt{verbose}, you can get +further detailed information. +\end{clopt} + \begin{clopt}{\sopt{q}, \lopt{quiet}} This suppress most of the messages from the program. \end{clopt} @@ -206,23 +211,23 @@ specified, all other options and arguments are ignored. \subsection{Exit codes} +\begin{samepage} You can grasp whether \prog{llmk} successfully executed or not by seeing its status code. Note that the exit codes of invoked programs are not directly transferred as the exit code of \prog{llmk}; instead, the statuses of external programs that failed, if any, are reported in the error messages. % -\begin{description}[left=2em] -\item[\code{0}] - Success. -\item[\code{1}] - General error. -\item[\code{2}] - Invoked program failed. -\item[\code{3}] - Parser error. -\item[\code{4}] - Type error. -\end{description} +\begin{center} +\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 & \\ +\bottomrule +\end{tabular} +\end{center} +\end{samepage} \section{Writing workflows in TOML format} \label{sec:toml} @@ -376,10 +381,11 @@ In other words, you only need to write the differences from the default configuration. \begin{confkey}{bibtex}{type: \type{string}}[default: \code{"bibtex"}] -The command to use for the \progname{bibtex} program. Internally, this key is -an alias for the \ckey{command} key in the \progname{bibtex} entry. If the -\ckey{command} key is specified in the \ckey{programs} table, this alias is -ineffective. +The command to use for the \progname{bibtex} program. Reference processing +tools that are compatible with {\BibTeX} can be specified for this key, \eg +\code{"biber"}. Internally, this key is an alias for the \ckey{command} key in +the \progname{bibtex} entry. If the \ckey{command} key is specified in the +\ckey{programs} table, this alias is ineffective. \end{confkey} \begin{confkey}{clean\_files}{type: \type{array of strings}} @@ -593,8 +599,8 @@ Only some of them are used in the default \ckey{sequence} (see Section~% \ref{sec:default-sequence}), but other entries can be easily used just by overriding the \ckey{sequence} array. -\Program{bibtex} The entry for the {\BibTeX} program and friends. The -\progname{latex} program is set as \ckey{postprocess} so that to make sure +\Program{bibtex} The entry for the {\BibTeX} program and friends, \eg Biber. +The \progname{latex} program is set as \ckey{postprocess} so that to make sure rerunning {\LaTeX} command after this execution. % \begin{lstlisting}[style=toml] @@ -832,27 +838,7 @@ This software is released under the MIT license: \parskip=\baselineskip \small\ttfamily \noindent -The MIT License (MIT) - -Copyright 2018-2020 Takuto ASAKURA (wtsnjp) - -Permission is hereby granted, free of charge, to any person obtaining a copy -of this software and associated documentation files (the "Software"), to deal -in the Software without restriction, including without limitation the rights -to use, copy, modify, merge, publish, distribute, sublicense, and/or sell -copies of the Software, and to permit persons to whom the Software is -furnished to do so, subject to the following conditions: - -The above copyright notice and this permission notice shall be included in all -copies or substantial portions of the Software. - -THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR -IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, -FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE -AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER -LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, -OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE -SOFTWARE. +\printLICENSE \end{quotation} \subsection*{Third-party software} |
