summaryrefslogtreecommitdiff
path: root/doc/luaotfload-tool.rst
diff options
context:
space:
mode:
authorPhilipp Gesang <phg42.2a@gmail.com>2014-03-30 12:53:06 +0200
committerPhilipp Gesang <phg42.2a@gmail.com>2014-03-30 12:53:06 +0200
commit4cfc73bd1bab8a51da618119e1e24dae3d7ccf1a (patch)
tree74754562772599afb770afab284426e2e058fbf0 /doc/luaotfload-tool.rst
parentcfde02f4d2a24ca55b40cc6a3ad05fc38a429a7a (diff)
parent60478137d15bec36b66276a4bfbfe0f1b1f20269 (diff)
downloadluaotfload-4cfc73bd1bab8a51da618119e1e24dae3d7ccf1a.tar.gz
Merge pull request #211 from phi-gamma/texlive2014
update documentation
Diffstat (limited to 'doc/luaotfload-tool.rst')
-rw-r--r--doc/luaotfload-tool.rst88
1 files changed, 71 insertions, 17 deletions
diff --git a/doc/luaotfload-tool.rst b/doc/luaotfload-tool.rst
index 761b0ec..4b1a934 100644
--- a/doc/luaotfload-tool.rst
+++ b/doc/luaotfload-tool.rst
@@ -6,22 +6,22 @@
generate and query the Luaotfload font names database
-----------------------------------------------------------------------
-:Date: 2014-01-02
-:Copyright: GPL v2.0
-:Version: 2.5
-:Manual section: 1
-:Manual group: text processing
+:Date: 2014-03-30
+:Copyright: GPL v2.0
+:Version: 2.5
+:Manual section: 1
+:Manual group: text processing
SYNOPSIS
=======================================================================
-**luaotfload-tool** [ -bDfFiIlnpquvVhw ]
+**luaotfload-tool** [ -bcDfFiIlLnpqRSuvVhw ]
**luaotfload-tool** --update [ --force ] [ --quiet ] [ --verbose ]
[ --prefer-texmf ] [ --dry-run ]
[ --formats=[+|-]EXTENSIONS ]
[ --no-compress ] [ --no-strip ]
- [ --local ]
+ [ --local ] [ --max-fonts=N ]
**luaotfload-tool** --find=FONTNAME [ --fuzzy ] [ --info ] [ --inspect ]
[ --no-reload ]
@@ -32,6 +32,8 @@ SYNOPSIS
**luaotfload-tool** --list=CRITERION[:VALUE] [ --fields=F1,F2,...,Fn ]
+**luaotfload-tool** --bisect=DIRECTIVE
+
**luaotfload-tool** --help
**luaotfload-tool** --version
@@ -67,10 +69,6 @@ update mode
with every invocation of ``luaotfload-tool``.
--no-reload, -n Suppress auto-updates to the database (e.g.
when ``--find`` is passed an unknown name).
---no-strip Do not strip redundant information after
- building the database. Warning: this will
- inflate the index to about two to three times
- the normal size.
--no-compress, -c Do not filter the plain text version of the
font index through gzip. Useful for debugging
if your editor is built without zlib.
@@ -78,8 +76,6 @@ update mode
--prefer-texmf, -p Organize the file name database in a way so
that it prefer fonts in the *TEXMF* tree over
system fonts if they are installed in both.
---max-fonts=N Process at most *N* font files, including fonts
- already indexed in the count.
--formats=EXTENSIONS Extensions of the font files to index.
Where *EXTENSIONS* is a comma-separated list of
supported file extensions (otf, ttf, ttc,
@@ -99,9 +95,6 @@ update mode
grow the database considerably and slow down
font indexing.
---dry-run, -D Don’t load fonts, scan directories only.
- (For debugging file system related issues.)
-
query mode
-----------------------------------------------------------------------
--find=NAME Resolve a font name; this looks up <name> in
@@ -125,7 +118,6 @@ query mode
library (assumes ``-I``). Automatically enabled
if the verbosity level exceeds 2.
---show-blacklist, -b Show blacklisted files (not directories).
--list=CRITERION Show entries, where *CRITERION* is one of the
following:
@@ -187,6 +179,68 @@ font and lookup caches
cache;
3) ``show`` -> print stats.
+debugging methods
+-----------------------------------------------------------------------
+--show-blacklist, -b Show blacklisted files (not directories).
+--dry-run, -D Don’t load fonts when updating the database;
+ scan directories only.
+ (For debugging file system related issues.)
+--no-strip Do not strip redundant information after
+ building the database. Warning: this will
+ inflate the index to about two to three times
+ the normal size.
+--max-fonts=N Process at most *N* font files, including fonts
+ already indexed in the count.
+--bisect=DIRECTIVE Bisection of the font database.
+ This mode is intended as assistance in
+ debugging the Luatex engine, especially when
+ tracking memleaks or buggy fonts.
+
+ *DIRECTIVE* can be one of the following:
+
+ 1) ``run`` -> Make ``luaotfload-tool`` respect
+ the bisection progress when running.
+ Combined with ``--update`` and possibly
+ ``--force`` this will only process the files
+ from the start up until the pivot and ignore
+ the rest.
+ 2) ``start`` -> Start bisection: create a
+ bisection state file and initialize the low,
+ high, and pivot indices.
+ 3) ``stop`` -> Terminate the current bisection
+ session by deleting the state file.
+ 4) ``good`` | ``bad`` -> Mark the section
+ processed last as “good” or “bad”,
+ respectively. The next bisection step will
+ continue with the bad section.
+ 5) ``status`` -> Print status information about
+ the current bisection session. Hint: Use
+ with higher verbosity settings for more
+ output.
+
+ A bisection session is initiated by issuing the
+ ``start`` directive. This sets the pivot to the
+ middle of the list of available font files.
+ Now run *luaotfload-tool* with the ``--update``
+ flag set as well as ``--bisect=run``: only the
+ fonts up to the pivot will be considered. If
+ that task exhibited the issue you are tracking,
+ then tell Luaotfload using ``--bisect=bad``.
+ The next step of ``--bisect=run`` will continue
+ bisection with the part of the files below the
+ pivot.
+ Likewise, issue ``--bisect=good`` in order to
+ continue with the fonts above the pivot,
+ assuming the tested part of the list did not
+ trigger the bug.
+
+ Once the culprit font is tracked down, ``good``
+ or ``bad`` will have no effect anymore. ``run``
+ will always end up processing the single font
+ file that was left.
+ Use ``--bisect=stop`` to clear the bisection
+ state.
+
miscellaneous
-----------------------------------------------------------------------
--verbose=N, -v Set verbosity level to *n* or the number of