diff options
Diffstat (limited to 'Master/texmf-dist/doc/lualatex/xindex/README.md')
-rw-r--r-- | Master/texmf-dist/doc/lualatex/xindex/README.md | 49 |
1 files changed, 49 insertions, 0 deletions
diff --git a/Master/texmf-dist/doc/lualatex/xindex/README.md b/Master/texmf-dist/doc/lualatex/xindex/README.md new file mode 100644 index 00000000000..a50ffb3ba3b --- /dev/null +++ b/Master/texmf-dist/doc/lualatex/xindex/README.md @@ -0,0 +1,49 @@ +# xindex + +Unicode compatible index programm for LaTeX. It needs Lua 5.3 which +will be included in at least LuaTeX 1.09 + + +* xindex.lua -- main file +* xindex-cfg.lua -- config module +* xindex-cfg-common.lua -- main config module +* xindex-base.lua -- base file +* xindex-lib.lua -- functions module +* xindex-lapp.lua -- read parameter +* unicode-category.lua -- list of Unicode categories + +The syntax of `index` + + index [options] <inputfile>[.idx] + +possible options are (short,long): + + -q,--quiet + -h,--help + -v + -c,--config (default cfg) + -e,--escapechar (default ") + -n,--noheadings + -o,--output (default "") + -l,--language (default en) + <input> (string) + +Testfiles: + +demo.tex: run + + lualatex demo + ./xindex.lua demo.idx + lualatex demo + + +buch.tex: run + + ./xindex.lua buch.idx + lualatex buch + + +after installing the files into the TeXLive distro you +can run `xindex` instead of `./xindex.lua`. + +LICENSE: LPPL 1.3 |