luaotfload (1jan14)

git-svn-id: svn://tug.org/texlive/trunk@32538 c570f23f-e606-0410-a88d-b1316a301751

2 files changed, 151 insertions, 32 deletions

diff --git a/Master/texmf-dist/doc/man/man1/luaotfload-tool.1 b/Master/texmf-dist/doc/man/man1/luaotfload-tool.1
index 6a1aba566ee..5d4ad3176c5 100644
--- a/Master/texmf-dist/doc/man/man1/luaotfload-tool.1
+++ b/Master/texmf-dist/doc/man/man1/luaotfload-tool.1
@@ -1,6 +1,6 @@
 .\" Man page generated from reStructuredText.
 .
-.TH LUAOTFLOAD-TOOL 1 "2013-07-10" "2.3a" "text processing"
+.TH LUAOTFLOAD-TOOL 1 "2013-07-31" "2.4" "text processing"
 .SH NAME
 luaotfload-tool \- generate and query the Luaotfload font names database
 .
@@ -32,11 +32,17 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 ..
 .SH SYNOPSIS
 .sp
-\fBluaotfload\-tool\fP [ \-bDcfFiIpquvVwh ]
-.sp
-\fBluaotfload\-tool\fP \-\-update [ \-\-force ] [ \-\-quiet ] [ \-\-verbose ] [ \-\-prefer\-texmf ] [ \-\-dry\-run ]
-.sp
-\fBluaotfload\-tool\fP \-\-find=FONTNAME [ \-\-fuzzy ] [ \-\-info ] [ \-\-inspect ]
+\fBluaotfload\-tool\fP [ \-bDfFiIlnpquvVhw ]
+.INDENT 0.0
+.TP
+.B \fBluaotfload\-tool\fP \-\-update [ \-\-force ] [ \-\-quiet ] [ \-\-verbose ]
+[ \-\-prefer\-texmf ] [ \-\-dry\-run ]
+[ \-\-formats=[+|\-]EXTENSIONS ]
+[ \-\-no\-compress ] [ \-\-no\-strip ]
+.TP
+.B \fBluaotfload\-tool\fP \-\-find=FONTNAME [ \-\-fuzzy ] [ \-\-info ] [ \-\-inspect ]
+[ \-\-no\-reload ]
+.UNINDENT
 .sp
 \fBluaotfload\-tool\fP \-\-flush\-lookups
 .sp
@@ -55,7 +61,7 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
 .sp
 luaotfload\-tool accesses the font names database that is required by
 the \fILuaotfload\fP package. There are two general modes: \fBupdate\fP and
-\fBquery\fP.
+\fBquery\fP\&.
 .INDENT 0.0
 .IP \(bu 2
 \fBupdate\fP:  update the database or rebuild it entirely;
@@ -70,19 +76,62 @@ the verbosity level will be set to 2.
 .SS update mode
 .INDENT 0.0
 .TP
-.B \-\-update,  \-u
+.B \-\-update\fP,\fB  \-u
 Update the database; indexes new fonts.
 .TP
-.B \-\-force,  \-f
+.B \-\-force\fP,\fB  \-f
 Force rebuilding of the database; re\-indexes
 all fonts.
 .TP
-.B \-\-prefer\-texmf,  \-p
+.B \-\-no\-reload\fP,\fB  \-n
+Suppress auto\-updates to the database (e.g.
+when \fB\-\-find\fP is passed an unknown name).
+.TP
+.B \-\-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.
+.TP
+.B \-\-no\-compress\fP,\fB  \-c
+Do not filter the plain text version of the
+font index through gzip. Useful for debugging
+if your editor is built without zlib.
+.TP
+.B \-\-prefer\-texmf\fP,\fB  \-p
 Organize the file name database in a way so
 that it prefer fonts in the \fITEXMF\fP tree over
 system fonts if they are installed in both.
 .TP
-.B \-\-dry\-run,  \-D
+.BI \-\-max\-fonts\fB= N
+Process at most \fIN\fP font files, including fonts
+already indexed in the count.
+.TP
+.BI \-\-formats\fB= EXTENSIONS
+Extensions of the font files to index.
+Where \fIEXTENSIONS\fP is a comma\-separated list of
+supported file extensions (otf, ttf, ttc,
+dfont, pfa, and pfb).  If the list is prefixed
+with a \fB+\fP sign, the given list is added to
+the currently active one; \fB\-\fP subtracts.
+Default: \fIotf,ttf,ttc,dfont\fP\&.
+Examples:
+.INDENT 7.0
+.IP 1. 3
+\fB\-\-formats=\-ttc,ttf\fP would skip
+TrueType fonts and font collections;
+.IP 2. 3
+\fB\-\-formats=otf\fP would scan only OpenType
+files;
+.IP 3. 3
+\fB\-\-formats=+pfb\fP includes binary
+Postscript files. \fBWarning\fP: with a
+standard TeX Live installation this will
+grow the database considerably and slow down
+font indexing.
+.UNINDENT
+.TP
+.B \-\-dry\-run\fP,\fB  \-D
 Don’t load fonts, scan directories only.
 (For debugging file system related issues.)
 .UNINDENT
@@ -93,29 +142,32 @@ Don’t load fonts, scan directories only.
 Resolve a font name; this looks up <name> in
 the database and prints the file name it is
 mapped to.
+\fB\-\-find\fP also understands request syntax,
+i.e. \fB\-\-find=file:foo.otf\fP checks whether
+\fBfoo.otf\fP is indexed.
 .TP
-.B \-\-fuzzy,  \-F
+.B \-\-fuzzy\fP,\fB  \-F
 Show approximate matches to the file name if
 the lookup was unsuccessful (requires
 \fB\-\-find\fP).
 .TP
-.B \-\-info,  \-i
+.B \-\-info\fP,\fB  \-i
 Display basic information to a resolved font
 file (requires \fB\-\-find\fP).
 .TP
-.B \-\-inspect,  \-I
+.B \-\-inspect\fP,\fB  \-I
 Display detailed information by loading the
 font and analyzing the font table; very slow!
 For the meaning of the returned fields see
 the LuaTeX documentation.
 (requires \fB\-\-find\fP).
 .TP
-.B \-\-warnings,  \-w
+.B \-\-warnings\fP,\fB  \-w
 Print the warnings generated by the fontloader
 library (assumes \fB\-I\fP). Automatically enabled
 if the verbosity level exceeds 2.
 .TP
-.B \-\-show\-blacklist,  \-b
+.B \-\-show\-blacklist\fP,\fB  \-b
 Show blacklisted files (not directories).
 .TP
 .BI \-\-list\fB= CRITERION
@@ -126,18 +178,68 @@ following:
 the character \fB*\fP, selecting all entries;
 .IP 2. 3
 a field of a database entry, for instance
-\fIfullname\fP or \fIunits_per_em\fP, according to
-which the output will be sorted; or
+\fIversion\fP or \fIformat*\fP, according to which
+the output will be sorted.
+Information in an unstripped database (see
+the option \fB\-\-no\-strip\fP above) is nested:
+Subfields of a record can be addressed using
+the \fB\->\fP separator, e. g.
+\fBfile\->location\fP, \fBstyle\->units_per_em\fP,
+or
+\fBnames\->sanitized\->english\->prefmodifiers\fP\&.
+NB: shell syntax requires that arguments
+containing \fB\->\fP be properly quoted!
 .IP 3. 3
 an expression of the form \fBfield:value\fP to
 limit the output to entries whose \fBfield\fP
-matches \fBvalue\fP.
+matches \fBvalue\fP\&.
+.UNINDENT
+.sp
+For example, in order to output file names and
+corresponding versions, sorted by the font
+format:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+\&./luaotfload\-tool.lua \-\-list="format" \-\-fields="file\->base,version"
+.ft P
+.fi
+.UNINDENT
+.UNINDENT
+.sp
+This prints:
+.INDENT 7.0
+.INDENT 3.5
+.sp
+.nf
+.ft C
+otf latinmodern\-math.otf  Version 1.958
+otf lmromancaps10\-oblique.otf 2.004
+otf lmmono8\-regular.otf 2.004
+otf lmmonoproplt10\-bold.otf 2.004
+otf lmsans10\-oblique.otf  2.004
+otf lmromanslant8\-regular.otf 2.004
+otf lmroman12\-italic.otf  2.004
+otf lmsansdemicond10\-oblique.otf  2.004
+\&...
+.ft P
+.fi
+.UNINDENT
 .UNINDENT
 .TP
 .BI \-\-fields\fB= FIELDS
 Comma\-separated list of fields that should be
-printed.  The default is \fIfullname,version\fP.
-(Only meaningful with \fB\-\-list\fP.)
+printed.
+Information in an unstripped database (see the
+option \fB\-\-no\-strip\fP above) is nested:
+Subfields of a record can be addressed using
+the \fB\->\fP separator, e. g.
+\fBfile\->location\fP, \fBstyle\->units_per_em\fP,
+or \fBnames\->sanitized\->english\->subfamily\fP\&.
+The default is plainname,version*.
+(Only meaningful with \fB\-\-list\fP\&.)
 .UNINDENT
 .SS font and lookup caches
 .INDENT 0.0
@@ -161,9 +263,9 @@ cache;
 .SS miscellaneous
 .INDENT 0.0
 .TP
-.BI \-\-verbose\fB= N, \ \-v
+.BI \-\-verbose\fB= N\fP,\fB \ \-v
 Set verbosity level to \fIn\fP or the number of
-repetitions of \fB\-v\fP.
+repetitions of \fB\-v\fP\&.
 .TP
 .B \-\-quiet
 No verbose output (log level set to zero).
@@ -181,14 +283,14 @@ directory (the name will be chosen
 automatically (\fBexperimental!\fP).
 .UNINDENT
 .TP
-.B \-\-version,  \-V
+.B \-\-version\fP,\fB  \-V
 Show version number and exit.
 .TP
-.B \-\-help,  \-h
+.B \-\-help\fP,\fB  \-h
 Show help message and exit.
 .TP
 .BI \-\-diagnose\fB= CHECK
-Run the diagnostic procedure \fICHECK\fP. Available
+Run the diagnostic procedure \fICHECK\fP\&. Available
 procedures are:
 .INDENT 7.0
 .IP 1. 3
@@ -198,21 +300,38 @@ modifications;
 \fBpermissions\fP \-> check permissions of
 cache directories and files;
 .IP 3. 3
+.INDENT 3.0
+.TP
+.B \fBenvironment\fP \-> print relevant
+environment and kpse variables;
+.UNINDENT
+.IP 4. 3
 \fBrepository\fP \-> check the git repository
-for new releases.
+for new releases,
+.IP 5. 3
+\fBindex\fP \-> check database, display
+information about it.
 .UNINDENT
 .sp
+Procedures can be chained by concatenating with
+commas, e.g. \fB\-\-diagnose=files,permissions\fP\&.
 Specify \fBthorough\fP to run all checks.
 .UNINDENT
 .SH FILES
 .sp
 The font name database is usually located in the directory
 \fBtexmf\-var/luatex\-cache/generic/names/\fP (\fB$TEXMFCACHE\fP as set in
-\fBtexmf.cnf\fP) of your \fITeX Live\fP distribution as
-\fBluaotfload\-names.lua\fP.  The experimental lookup cache will be
-created as \fBluaotfload\-lookup\-cache.lua\fP in the same directory.
-Both files are safe to delete, at the cost of regenerating them with
-the next run of \fILuaTeX\fP.
+\fBtexmf.cnf\fP) of your \fITeX Live\fP distribution as a zlib\-compressed
+file \fBluaotfload\-names.lua.gz\fP\&.
+The experimental lookup cache will be created as
+\fBluaotfload\-lookup\-cache.lua\fP in the same directory.
+These Lua tables are not used directly by Luaotfload, though.
+Instead, they are compiled to Lua bytecode which is written to
+corresponding files with the extension \fB\&.luc\fP in the same directory.
+When modifying the files by hand keep in mind that only if the bytecode
+files are missing will Luaotfload use the plain version instead.
+Both kinds of files are safe to delete, at the cost of regenerating
+them with the next run of \fILuaTeX\fP\&.
 .SH SEE ALSO
 .sp
 \fBluatex\fP (1), \fBlua\fP (1)
diff --git a/Master/texmf-dist/doc/man/man1/luaotfload-tool.man1.pdf b/Master/texmf-dist/doc/man/man1/luaotfload-tool.man1.pdf
index 530bd191a8a..dd8df8abab4 100644
--- a/Master/texmf-dist/doc/man/man1/luaotfload-tool.man1.pdf
+++ b/Master/texmf-dist/doc/man/man1/luaotfload-tool.man1.pdf