summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man5/luaotfload.conf.5
diff options
context:
space:
mode:
Diffstat (limited to 'Master/texmf-dist/doc/man/man5/luaotfload.conf.5')
-rw-r--r--Master/texmf-dist/doc/man/man5/luaotfload.conf.571
1 files changed, 62 insertions, 9 deletions
diff --git a/Master/texmf-dist/doc/man/man5/luaotfload.conf.5 b/Master/texmf-dist/doc/man/man5/luaotfload.conf.5
index 68d40eba01f..89c8fbb5f46 100644
--- a/Master/texmf-dist/doc/man/man5/luaotfload.conf.5
+++ b/Master/texmf-dist/doc/man/man5/luaotfload.conf.5
@@ -1,6 +1,6 @@
.\" Man page generated from reStructuredText.
.
-.TH LUAOTFLOAD.CONF 5 "2014-06-09" "2.5" "text processing"
+.TH LUAOTFLOAD.CONF 5 "2015-12-09" "2.6" "text processing"
.SH NAME
luaotfload.conf \- Luaotfload configuration file
.
@@ -83,11 +83,26 @@ To observe the difference in behavior, save above snippet to
.sp
.nf
.ft C
-luaotfload \-\-update \-\-force
+luaotfload\-tool \-\-update \-\-force
.ft P
.fi
.UNINDENT
.UNINDENT
+.sp
+The current configuration can be written to disk using
+\fBluaotfload\-tool\fP:
+.INDENT 0.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+luaotfload\-tool \-\-dumpconf > luaotfload.conf
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+The result can itself be used as a configuration file.
.SH SYNTAX
.sp
The configuration file syntax follows the common INI format. For a more
@@ -139,8 +154,9 @@ letters as well as dashes (\fB\-\fP).
Variables in belong into a configuration section and their values must
be of a certain type. Some of them have further constraints. For
example, the “color callback” must be a string of one of the values
-\fBpre_linebreak_filter\fP or \fBpre_output_filter\fP, defined in the
-section \fIrun\fP\&.
+\fBpost_linebreak_filter\fP, \fBpre_linebreak_filter\fP, or
+\fBpre_output_filter\fP, defined in the section \fIrun\fP of the
+configuration file.
.sp
Currently, the configuration is organized into four sections:
.INDENT 0.0
@@ -433,7 +449,7 @@ color\-callback
T} T{
s
T} T{
-\fB"pre_linebreak_filter"\fP
+\fB"post_linebreak_filter"\fP
T}
_
T{
@@ -460,14 +476,26 @@ T} T{
\fB"cached"\fP
T}
_
+T{
+fontloader
+T} T{
+s
+T} T{
+\fB"default"\fP
+T}
+_
.TE
.sp
The \fBcolor\-callback\fP option determines the stage at which fonts that
defined with a \fBcolor=xxyyzz\fP feature will be colorized. By default
-this happens in a \fBpre_linebreak_filter\fP but alternatively the
-\fBpre_output_filter\fP may be chosen, which is faster but might produce
-inconsistent output. The latter also was the default in the 1.x series
-of Luaotfload.
+this happens in a \fBpost_linebreak_filter\fP but alternatively the
+\fBpre_linebreak_filter\fP or \fBpre_output_filter\fP may be chosen, which
+is faster but might produce inconsistent output. The
+\fBpre_output_filter\fP used to be the default in the 1.x series of
+Luaotfload, whilst later versions up to and including 2.5 hooked into
+the \fBpre_linebreak_filter\fP which naturally didn’t affect any glyphs
+inserting during hyphenation. Both are kept around as options to
+restore the previous behavior if necessary.
.sp
The \fBdefiner\fP allows for switching the \fBdefine_font\fP callback.
Apart from the default \fBpatch\fP one may also choose the \fBgeneric\fP
@@ -475,6 +503,31 @@ one that comes with the vanilla fontloader. Beware that this might
break tools like Fontspect that rely on the \fBpatch_font\fP callback
provided by Luaotfload to perform important corrections on font data.
.sp
+The fontloader backend can be selected by setting the value of
+\fBfontloader\fP\&. The most important choices are \fBdefault\fP, which will
+load the dedicated Luaotfload fontloader, and \fBreference\fP, the
+upstream package as shipped with Luaotfload. Other than those, a file
+name accessible via kpathsea can be specified.
+.sp
+Alternatively, the individual files that constitute the fontloader can
+be loaded directly. While less efficient, this greatly aids debugging
+since error messages will reference the actual line numbers of the
+source files and explanatory comments are not stripped. Currently,
+three distinct loading strategies are available: \fBunpackaged\fP will
+load the batch that is part of Luaotfload. These contain the identical
+source code that the reference fontloader has been compiled from.
+Another option, \fBcontext\fP will attempt to load the same files by
+their names in the Context format from the search path. Consequently
+this option allows to use the version of Context that comes with the
+TeX distribution. Distros tend to prefer the stable version (“current”
+in Context jargon) of those files so certain bugs encountered in the
+more bleeding edge Luaotfload can be avoided this way. A third option
+is to use \fBcontext\fP with a colon to specify a directory prefix where
+the \fITEXMF\fP is located that the files should be loaded from, e. g.
+\fBcontext:~/context/tex/texmf\-context\fP\&. This can be used when
+referencing another distribution like the Context minimals that is
+installed under a different path not indexed by kpathsea.
+.sp
The value of \fBlog\-level\fP sets the default verbosity of messages
printed by Luaotfload. Only messages defined with a verbosity of less
than or equal to the supplied value will be output on the terminal.