summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorPhilipp Gesang <phg42.2a@gmail.com>2014-06-04 22:58:08 +0200
committerPhilipp Gesang <phg42.2a@gmail.com>2014-06-04 22:58:08 +0200
commit50e033bd254a087fccbe1a0bcaef208f5e106b2a (patch)
treec7438f192214b9d71746897900b789d4fa2ddd79 /doc
parent467bddf27f4c158e04cfefa3d68d64b58a290a72 (diff)
downloadluaotfload-50e033bd254a087fccbe1a0bcaef208f5e106b2a.tar.gz
doc: document user access to font index
Diffstat (limited to 'doc')
-rw-r--r--doc/luaotfload-main.tex33
1 files changed, 25 insertions, 8 deletions
diff --git a/doc/luaotfload-main.tex b/doc/luaotfload-main.tex
index e4b28dc..034b704 100644
--- a/doc/luaotfload-main.tex
+++ b/doc/luaotfload-main.tex
@@ -1412,17 +1412,35 @@ are defined for which scripts.
\endsubsubsection
+\beginsubsubsection{Database}
+
%% not implemented, may come back later
-% \beginsubsubsection{Database}
-%
-% \beginfunctionlist
+\beginfunctionlist
% \beginaltitem {aux.scan_external_dir(dir : string)}
% Include fonts in directory \luafunction{dir} in font lookups without
% adding them to the database.
%
-% \endfunctionlist
-%
-% \endsubsubsection
+ \beginaltitem {aux.read_font_index (void)}
+ Read the index file from the appropriate location (usually
+ the bytecode file \fileent{luaotfload-names.luc} somewhere
+ in the \fileent{texmf-var} tree) and return the result as a
+ table. The file is processed with each call so it is up to
+ the user to store the result for later access.
+ \endaltitem
+
+ \beginaltitem {aux.font_index (void)}
+ Return a reference of the font names table used internally
+ by \identifier{luaotfload}. The index will be read if it
+ has not been loaded up to this point. Also a font scan that
+ overwrites the current index file might be triggered. Since
+ the return value points to the actual index, any
+ modifications to the table might influence runtime behavior
+ of \identifier{luaotfload}.
+ \endaltitem
+
+\endfunctionlist
+
+\endsubsubsection
\endsubsection
\endsection
@@ -1440,8 +1458,7 @@ target.
%
The development takes place on \identifier{github} at
\hyperlink {https://github.com/lualatex/luaotfload} where there is an issue
-tracker for submitting bug reports, feature requests and the likes
-requests and the likes.
+tracker for submitting bug reports, feature requests and the likes.
Bug reports are more likely to be addressed if they contain the output
of