diff options
author | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
---|---|---|
committer | Norbert Preining <norbert@preining.info> | 2019-09-02 13:46:59 +0900 |
commit | e0c6872cf40896c7be36b11dcc744620f10adf1d (patch) | |
tree | 60335e10d2f4354b0674ec22d7b53f0f8abee672 /indexing/xindex/README.md |
Initial commit
Diffstat (limited to 'indexing/xindex/README.md')
-rw-r--r-- | indexing/xindex/README.md | 46 |
1 files changed, 46 insertions, 0 deletions
diff --git a/indexing/xindex/README.md b/indexing/xindex/README.md new file mode 100644 index 0000000000..e47187276a --- /dev/null +++ b/indexing/xindex/README.md @@ -0,0 +1,46 @@ +# xindex + +Unicode compatible index programm for LaTeX. It needs Lua 5.3 which +will be included in at least LuaTeX 1.09 (TeXLive 2019) + + +* 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 +* xindex-unicode.lua -- list of Unicode categories + +The syntax of `xindex` + + xindex [options] <inputfile>[.idx] + +possible options are (short,long): + -q,--quiet + -h,--help + -v... Verbosity level; can be -v, -vv, -vvv + -c,--config (default cfg) + -e,--escapechar (default ") + -n,--noheadings + -a,--no_casesensitive + -o,--output (default "") + -l,--language (default en) + -p,--prefix (default L) + <input> (string) + +Testfiles: + +demo.tex: run + + lualatex demo + ./xindex.lua demo.idx + lualatex demo + + +buch.tex: run + + ./xindex.lua buch.idx + lualatex buch + + |