From 992a8e8b1967486291cc1f480fd3ff83d904576c Mon Sep 17 00:00:00 2001
From: Philipp Gesang <phg42.2a@gmail.com>
Date: Sat, 12 Jul 2014 13:55:04 +0200
Subject: [doc] describe config file search sequence in manpage
---
doc/luaotfload.conf.rst | 33 ++++++++++++++++++++++++++++-----
1 file changed, 28 insertions(+), 5 deletions(-)
(limited to 'doc')
diff --git a/doc/luaotfload.conf.rst b/doc/luaotfload.conf.rst
index bd080d1..eb7788e 100644
--- a/doc/luaotfload.conf.rst
+++ b/doc/luaotfload.conf.rst
@@ -3,7 +3,7 @@
=======================================================================
-----------------------------------------------------------------------
- Luaotfload configuration
+ Luaotfload configuration file
-----------------------------------------------------------------------
:Date: 2014-06-09
@@ -15,13 +15,16 @@
SYNOPSIS
=======================================================================
-**XDG_CONFIG_HOME/luaotfload/luaotfload.conf**
-**XDG_CONFIG_HOME/luaotfload/luaotfloadrc**
-**~/.luaotfloadrc**
+- **./luaotfload{.conf,rc}**
+- **XDG_CONFIG_HOME/luaotfload/luaotfload{.conf,rc}**
+- **~/.luaotfloadrc**
DESCRIPTION
=======================================================================
+The file ``luaotfload.conf`` contains configuration options for
+*Luaotfload*, a font loading and font management component for LuaTeX.
+
EXAMPLE
=======================================================================
@@ -37,13 +40,27 @@ SYNTAX
VARIABLES
=======================================================================
+
* TODO, list variables
FILES
=======================================================================
-* file locations
+Luaotfload only processes the first configuration file it encounters at
+one of the search locations. The file name may be either
+``luaotfload.conf`` or ``luaotfloadrc``, except for the dotfile in the
+user’s home directory which is expected at ``~/.luaotfloadrc``.
+
+Configuration files are located following a series of steps. The search
+terminates as soon as a suitable file is encountered. The sequence of
+locations that Luaotfload looks at is
+
+i. The current working directory of the LuaTeX process.
+ii. The subdirectory ``luaotfload/`` inside the XDG configuration
+ tree, e. g. ``/home/oenothea/config/luaotfload/``.
+iii. The dotfile.
+iv. The *TEXMF* (using kpathsea).
SEE ALSO
@@ -59,6 +76,12 @@ SEE ALSO
* Luaotfload on CTAN `<http://ctan.org/pkg/luaotfload>`_
+REFERENCES
+=======================================================================
+
+* The XDG base specification
+ `<http://standards.freedesktop.org/basedir-spec/basedir-spec-latest.html>`_.
+
AUTHORS
=======================================================================
--
cgit v1.2.3