summaryrefslogtreecommitdiff
path: root/support/light-latex-make/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'support/light-latex-make/README.md')
-rw-r--r--support/light-latex-make/README.md51
1 files changed, 26 insertions, 25 deletions
diff --git a/support/light-latex-make/README.md b/support/light-latex-make/README.md
index b7d7d0f0ca..1ff40ffc21 100644
--- a/support/light-latex-make/README.md
+++ b/support/light-latex-make/README.md
@@ -1,7 +1,7 @@
![llmk: The Light LaTeX Make](./llmk-logo.png)
-[![Build Status](https://travis-ci.org/wtsnjp/llmk.svg?branch=master)](https://travis-ci.org/wtsnjp/llmk)
-[![Build status](https://ci.appveyor.com/api/projects/status/1papc7m85kl9iph1?svg=true)](https://ci.appveyor.com/project/wtsnjp/llmk)
+[![CI](https://github.com/wtsnjp/llmk/actions/workflows/ci.yml/badge.svg)](https://github.com/wtsnjp/llmk/actions/workflows/ci.yml)
+[![CTAN](https://img.shields.io/ctan/v/light-latex-make?color=FC02FF&label=CTAN)](https://www.ctan.org/pkg/light-latex-make)
This is yet another build tool for LaTeX documents. The features of **llmk** are:
@@ -14,7 +14,7 @@ See the bundled reference manual ([llmk.pdf](http://mirrors.ctan.org/support/lig
## 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).
+This software is included in [TeX Live](https://www.tug.org/texlive/) and [MiKTeX](https://miktex.org/) as Package `light-latex-make`. If you are using one of the latest distributions, you normally don't need to install it by yourself (for TeX Live, 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`.
@@ -49,23 +49,6 @@ will produce a PDF document (`hello.pdf`) with XeLaTeX, since it is specified in
You can find other example LaTeX document files in the [examples](https://github.com/wtsnjp/llmk/tree/master/examples) directory.
-### Action Clean/Clobber
-
-Similar to [latexmk](http://personal.psu.edu/jcc8/software/latexmk/), Actions `--clean` (`-c`) and `--clobber` (`-C`) are available.
-
-* The `--clean` action removes temporary files such as `*.aux` and `*.log`.
-* The `--clobber` action removes all generated files including final PDFs.
-
-Specifically,
-
-```
-$ llmk --clean FILE...
-```
-
-removes files generated by the specified `FILE`s. Files removed by these actions can be customized.
-
-## Advanced Usage
-
### Using llmk.toml
Alternatively, you can write your build settings in an independent file named `llmk.toml` (this file name is fixed).
@@ -123,6 +106,23 @@ is equivalent to:
Note that this magic comment is effective **only on the first line** of a LaTeX source file. Note also that if a TOML field exist in the file, the TOML field has higher priority and all the other magic comments will be ignored.
+### Action Clean/Clobber
+
+Similar to [latexmk](http://personal.psu.edu/jcc8/software/latexmk/), Actions `--clean` (`-c`) and `--clobber` (`-C`) are available.
+
+* The `--clean` action removes temporary files such as `*.aux` and `*.log`.
+* The `--clobber` action removes all generated files including final PDFs.
+
+Specifically,
+
+```
+$ llmk --clean FILE...
+```
+
+removes files generated by the specified `FILE`s. In case you omit the argument `FILE`, files generated by the `source` files are removed. In both case, the files to remove by these actions can be customized (see the reference manual for the details).
+
+## Advanced Usage
+
### Custom compile sequence
You can setup custom sequence for processing LaTeX documents; use `sequence` key to specify the order of programs to process the documents and specify the detailed settings for each program.
@@ -162,21 +162,22 @@ This way is a bit complicated but strong enough allowing you to use any kind of
The following is the list of available TOML keys in llmk. See the reference manual for the details.
* `bibtex` (type: *string*, default: `"bibtex"`)
-* `clean_files` (type: *string* or *array of strings*, default: `["%B.aux", "%B.log", "%B.toc", "%B.out", "%B.bbl", "%B.bcf", "%B.blg", "%B-blx.bib", "%B.idx", "%B.ilg", "%B.fls", "%B.run.xml"]`)
+* `clean_files` (type: *string* or *array of strings*, default: `["%B.aux", "%B.bbl", "%B.bcf", "%B-blx.bib", "%B.blg", "%B.fls", "%B.idx", "%B.ilg", "%B.ind", "%B.log", "%B.nav", "%B.out", "%B.run.xml", "%B.snm", "%B.toc", "%B.vrb"]`)
* `clobber_files` (type: *string* or *array of strings*, default: `["%B.pdf", "%B.dvi", "%B.ps", "%B.synctex.gz"]`)
* `dvipdf` (type: *string*, default: `"dvipdfmx"`)
* `dvips` (type: *string*, default: `"dvips"`)
+* `extra_clean_files` (type: *string* or *array of strings*, default: `[]`)
* `latex` (type: *string*, default: `"lualatex"`)
* `llmk_version` (type: *string*)
* `makeindex` (type: *string*, default: `"makeindex"`)
-* `max_repeat` (type: *integer*, default: 5)
+* `max_repeat` (type: *integer*, default: `5`)
* `programs` (type: *table*)
* \<program name\>
* `args` (type: *string* or *array of strings*, default: `["%T"]`)
* `aux_file` (type: *string*)
* `aux_empty_size` (type: *integer*)
* `command` (type: *string*, **required**)
- * `generated_target` (type: *boolean*, default: false)
+ * `generated_target` (type: *boolean*, default: `false`)
* `opts` (type: *string* or *array of strings*)
* `postprocess` (type: *string*)
* `target` (type: *string*, default: `"%S"`)
@@ -227,7 +228,7 @@ generated_target = true
* [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)
+* [TUGboat article](https://www.tug.org/TUGboat/tb41-2/tb128asakura-llmk.pdf): the post-proceedings of the above talk.
## Acknowledgements
@@ -235,7 +236,7 @@ This project has been supported by the [TeX Development Fund](https://www.tug.or
## License
-Copyright 2018-2020 Takuto ASAKURA ([wtsnjp](https://twitter.com/wtsnjp))
+Copyright 2018-2021 Takuto ASAKURA ([wtsnjp](https://twitter.com/wtsnjp))
This software is licensed under [the MIT license](./LICENSE).