From f66b2ffe8fdc30e517d00b4796c142acd0e4438d Mon Sep 17 00:00:00 2001 From: Philipp Gesang Date: Sun, 13 Jul 2014 15:15:46 +0200 Subject: [doc] describe feature settings and config file syntax in manpage --- doc/luaotfload.conf.rst | 44 +++++++++++++++++++++++++++++++++++++++++++- 1 file changed, 43 insertions(+), 1 deletion(-) (limited to 'doc/luaotfload.conf.rst') diff --git a/doc/luaotfload.conf.rst b/doc/luaotfload.conf.rst index 9940be2..774095b 100644 --- a/doc/luaotfload.conf.rst +++ b/doc/luaotfload.conf.rst @@ -61,7 +61,29 @@ To observe the difference in behavior, save above snippet to SYNTAX ======================================================================= -* TODO, short intro to ``.ini`` file syntax +The configuration file syntax follows the common INI format. For a more +detailed description please refer to the section “CONFIGURATION FILE” +of **git-config**\(1). A brief list of rules is given below: + + * Blank lines and lines starting with a semicolon (``;``) are ignored. + + * A configuration file is partitioned into sections that are declared + by specifying the section title in brackets on a separate line: :: + + [some-section] + ... section content ... + + * Sections consist of one or more variable assignments of the form + ``variable-name = value`` E. g.:: + + [foo] + bar = baz + quux = xyzzy + ... + + * Section and variable names may contain only uppercase and lowercase + letters as well as dashes (``-``). + VARIABLES ======================================================================= @@ -160,6 +182,26 @@ cannot find a requested font. Those who prefer to update manually using **luaotfload-tool** should unset this flag. +Section ``default-features`` +----------------------------------------------------------------------- + +By default Luaotfload enables ``node`` mode and picks the default font +features that are prescribed in the OpenType standard. This behavior +may be overridden in the ``default-features`` section. Global defaults +that will be applied for all scripts can be set via the ``global`` +option, others by the script they are to be applied to. For example, +a setting of :: + + [default-features] + global = mode=base,color=0000FF + dflt = smcp,onum + +would force *base* mode, tint all fonts blue and activate small +capitals and text figures globally. Features are specified as a comma +separated list of variables or variable-value pairs. Variables without +an explicit value are set to ``true``. + + Section ``misc`` ----------------------------------------------------------------------- -- cgit v1.2.3