diff options
author | Karl Berry <karl@freefriends.org> | 2014-07-15 22:56:45 +0000 |
---|---|---|
committer | Karl Berry <karl@freefriends.org> | 2014-07-15 22:56:45 +0000 |
commit | 6caf348b43edcfc1dce127bf0895a5fb9bd77f2d (patch) | |
tree | 7b4b79f90596e69716ad87e3293743756b2a1954 /Master/texmf-dist/doc/man | |
parent | d71cd04a4c07d1cdaf85a7b7c2398022cc39beab (diff) |
luaotfload (15jul14)
git-svn-id: svn://tug.org/texlive/trunk@34622 c570f23f-e606-0410-a88d-b1316a301751
Diffstat (limited to 'Master/texmf-dist/doc/man')
-rw-r--r-- | Master/texmf-dist/doc/man/man1/luaotfload-tool.1 | 122 | ||||
-rw-r--r-- | Master/texmf-dist/doc/man/man1/luaotfload-tool.man1.pdf | bin | 15440 -> 18400 bytes | |||
-rw-r--r-- | Master/texmf-dist/doc/man/man5/luaotfload.conf.5 | 545 |
3 files changed, 641 insertions, 26 deletions
diff --git a/Master/texmf-dist/doc/man/man1/luaotfload-tool.1 b/Master/texmf-dist/doc/man/man1/luaotfload-tool.1 index d368e35f84a..dd8abe2999f 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 "2014-05-18" "2.4-4" "text processing" +.TH LUAOTFLOAD-TOOL 1 "2014-03-30" "2.5" "text processing" .SH NAME luaotfload-tool \- generate and query the Luaotfload font names database . @@ -32,13 +32,14 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .. .SH SYNOPSIS .sp -\fBluaotfload\-tool\fP [ \-bDfFiIlnpquvVhw ] +\fBluaotfload\-tool\fP [ \-bcDfFiIlLnpqRSuvVhw ] .INDENT 0.0 .TP .B \fBluaotfload\-tool\fP \-\-update [ \-\-force ] [ \-\-quiet ] [ \-\-verbose ] [ \-\-prefer\-texmf ] [ \-\-dry\-run ] [ \-\-formats=[+|\-]EXTENSIONS ] [ \-\-no\-compress ] [ \-\-no\-strip ] +[ \-\-local ] [ \-\-max\-fonts=N ] .TP .B \fBluaotfload\-tool\fP \-\-find=FONTNAME [ \-\-fuzzy ] [ \-\-info ] [ \-\-inspect ] [ \-\-no\-reload ] @@ -50,6 +51,8 @@ level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] .sp \fBluaotfload\-tool\fP \-\-list=CRITERION[:VALUE] [ \-\-fields=F1,F2,...,Fn ] .sp +\fBluaotfload\-tool\fP \-\-bisect=DIRECTIVE +.sp \fBluaotfload\-tool\fP \-\-help .sp \fBluaotfload\-tool\fP \-\-version @@ -68,10 +71,6 @@ the \fILuaotfload\fP package. There are two general modes: \fBupdate\fP and .IP \(bu 2 \fBquery\fP: resolve a font name or display close matches. .UNINDENT -.sp -Note that if the script is named \fBmkluatexfontdb\fP it will behave like -earlier versions (<=1.3) and always update the database first. Also, -the verbosity level will be set to 2. .SH OPTIONS .SS update mode .INDENT 0.0 @@ -83,16 +82,19 @@ Update the database; indexes new fonts. Force rebuilding of the database; re\-indexes all fonts. .TP +.B \-\-local\fP,\fB \-L +Include font files in \fB$PWD\fP\&. This option +will cause large parts of the database to be +rebuilt. Thus it is quite inefficient. +Additionally, if local font files are found, +the database is prevented from being saved +to disk, so the local fonts need to be parsed +with every invocation of \fBluaotfload\-tool\fP\&. +.TP .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 @@ -103,10 +105,6 @@ 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 -.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 @@ -130,10 +128,6 @@ 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 .SS query mode .INDENT 0.0 @@ -167,9 +161,6 @@ Print the warnings generated by the fontloader library (assumes \fB\-I\fP). Automatically enabled if the verbosity level exceeds 2. .TP -.B \-\-show\-blacklist\fP,\fB \-b -Show blacklisted files (not directories). -.TP .BI \-\-list\fB= CRITERION Show entries, where \fICRITERION\fP is one of the following: @@ -260,6 +251,84 @@ cache; \fBshow\fP \-> print stats. .UNINDENT .UNINDENT +.SS debugging methods +.INDENT 0.0 +.TP +.B \-\-show\-blacklist\fP,\fB \-b +Show blacklisted files (not directories). +.TP +.B \-\-dry\-run\fP,\fB \-D +Don’t load fonts when updating the database; +scan directories only. +(For debugging file system related issues.) +.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 +.BI \-\-max\-fonts\fB= N +Process at most \fIN\fP font files, including fonts +already indexed in the count. +.TP +.BI \-\-bisect\fB= DIRECTIVE +Bisection of the font database. +This mode is intended as assistance in +debugging the Luatex engine, especially when +tracking memleaks or buggy fonts. +.sp +\fIDIRECTIVE\fP can be one of the following: +.INDENT 7.0 +.IP 1. 3 +\fBrun\fP \-> Make \fBluaotfload\-tool\fP respect +the bisection progress when running. +Combined with \fB\-\-update\fP and possibly +\fB\-\-force\fP this will only process the files +from the start up until the pivot and ignore +the rest. +.IP 2. 3 +\fBstart\fP \-> Start bisection: create a +bisection state file and initialize the low, +high, and pivot indices. +.IP 3. 3 +\fBstop\fP \-> Terminate the current bisection +session by deleting the state file. +.IP 4. 3 +\fBgood\fP | \fBbad\fP \-> Mark the section +processed last as “good” or “bad”, +respectively. The next bisection step will +continue with the bad section. +.IP 5. 3 +\fBstatus\fP \-> Print status information about +the current bisection session. Hint: Use +with higher verbosity settings for more +output. +.UNINDENT +.sp +A bisection session is initiated by issuing the +\fBstart\fP directive. This sets the pivot to the +middle of the list of available font files. +Now run \fIluaotfload\-tool\fP with the \fB\-\-update\fP +flag set as well as \fB\-\-bisect=run\fP: only the +fonts up to the pivot will be considered. If +that task exhibited the issue you are tracking, +then tell Luaotfload using \fB\-\-bisect=bad\fP\&. +The next step of \fB\-\-bisect=run\fP will continue +bisection with the part of the files below the +pivot. +Likewise, issue \fB\-\-bisect=good\fP in order to +continue with the fonts above the pivot, +assuming the tested part of the list did not +trigger the bug. +.sp +Once the culprit font is tracked down, \fBgood\fP +or \fBbad\fP will have no effect anymore. \fBrun\fP +will always end up processing the single font +file that was left. +Use \fB\-\-bisect=stop\fP to clear the bisection +state. +.UNINDENT .SS miscellaneous .INDENT 0.0 .TP @@ -276,15 +345,16 @@ troubleshooting), where \fICHANNEL\fP can be .INDENT 7.0 .IP 1. 3 \fBstdout\fP \-> all output will be -dumped to the terminal; or +dumped to the terminal (default); or .IP 2. 3 \fBfile\fP \-> write to a file to the temporary directory (the name will be chosen -automatically (\fBexperimental!\fP). +automatically. .UNINDENT .TP .B \-\-version\fP,\fB \-V -Show version info of components and exit. +Show version numbers of components as well as +some basic information and exit. .TP .B \-\-help\fP,\fB \-h Show help message and exit. diff --git a/Master/texmf-dist/doc/man/man1/luaotfload-tool.man1.pdf b/Master/texmf-dist/doc/man/man1/luaotfload-tool.man1.pdf Binary files differindex ee830d8378d..39103c39cd8 100644 --- a/Master/texmf-dist/doc/man/man1/luaotfload-tool.man1.pdf +++ b/Master/texmf-dist/doc/man/man1/luaotfload-tool.man1.pdf diff --git a/Master/texmf-dist/doc/man/man5/luaotfload.conf.5 b/Master/texmf-dist/doc/man/man5/luaotfload.conf.5 new file mode 100644 index 00000000000..68d40eba01f --- /dev/null +++ b/Master/texmf-dist/doc/man/man5/luaotfload.conf.5 @@ -0,0 +1,545 @@ +.\" Man page generated from reStructuredText. +. +.TH LUAOTFLOAD.CONF 5 "2014-06-09" "2.5" "text processing" +.SH NAME +luaotfload.conf \- Luaotfload configuration file +. +.nr rst2man-indent-level 0 +. +.de1 rstReportMargin +\\$1 \\n[an-margin] +level \\n[rst2man-indent-level] +level margin: \\n[rst2man-indent\\n[rst2man-indent-level]] +- +\\n[rst2man-indent0] +\\n[rst2man-indent1] +\\n[rst2man-indent2] +.. +.de1 INDENT +.\" .rstReportMargin pre: +. RS \\$1 +. nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin] +. nr rst2man-indent-level +1 +.\" .rstReportMargin post: +.. +.de UNINDENT +. RE +.\" indent \\n[an-margin] +.\" old: \\n[rst2man-indent\\n[rst2man-indent-level]] +.nr rst2man-indent-level -1 +.\" new: \\n[rst2man-indent\\n[rst2man-indent-level]] +.in \\n[rst2man-indent\\n[rst2man-indent-level]]u +.. +.SH SYNOPSIS +.INDENT 0.0 +.IP \(bu 2 +\fB\&./luaotfload{.conf,rc}\fP +.IP \(bu 2 +\fBXDG_CONFIG_HOME/luaotfload/luaotfload{.conf,rc}\fP +.IP \(bu 2 +\fB~/.luaotfloadrc\fP +.UNINDENT +.SH DESCRIPTION +.sp +The file \fBluaotfload.conf\fP contains configuration options for +\fILuaotfload\fP, a font loading and font management component for LuaTeX. +.SH EXAMPLE +.sp +A small Luaotfload configuration file with few customizations could +look as follows: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +[db] + formats = afm, pfa, pfb + compress = false + +[misc] + termwidth = 60 + +[run] + log\-level = 6 +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +This will make Luaotfload ignore all font files except for PostScript +formats. NB: With a default Tex Live install the PS fonts will take +much longer to index than OpenType or TrueType ones. Also, an +uncompressed index file will be dumped which is going to be much larger +due to the huge amount of PostScript fonts indexed. The terminal width +is truncated to 60 characters which influences the verbose output +during indexing. Finally, the verbosity is increased greatly: each font +file being processed will be printed to the stdout on a separate line, +along with lots of other information. +.sp +To observe the difference in behavior, save above snippet to +\fB\&./luaotfload.conf\fP and update the font index: +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +luaotfload \-\-update \-\-force +.ft P +.fi +.UNINDENT +.UNINDENT +.SH SYNTAX +.sp +The configuration file syntax follows the common INI format. For a more +detailed description please refer to the section “CONFIGURATION FILE” +of \fBgit\-config\fP(1). A brief list of rules is given below: +.INDENT 0.0 +.INDENT 3.5 +.INDENT 0.0 +.IP \(bu 2 +Blank lines and lines starting with a semicolon (\fB;\fP) are ignored. +.IP \(bu 2 +A configuration file is partitioned into sections that are declared +by specifying the section title in brackets on a separate line: +.INDENT 2.0 +.INDENT 3.5 +.sp +.nf +.ft C +[some\-section] +\&... section content ... +.ft P +.fi +.UNINDENT +.UNINDENT +.IP \(bu 2 +Sections consist of one or more variable assignments of the form +\fBvariable\-name = value\fP E. g.: +.INDENT 2.0 +.INDENT 3.5 +.sp +.nf +.ft C +[foo] + bar = baz + quux = xyzzy + ... +.ft P +.fi +.UNINDENT +.UNINDENT +.IP \(bu 2 +Section and variable names may contain only uppercase and lowercase +letters as well as dashes (\fB\-\fP). +.UNINDENT +.UNINDENT +.UNINDENT +.SH VARIABLES +.sp +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\&. +.sp +Currently, the configuration is organized into four sections: +.INDENT 0.0 +.TP +.B db +Options relating to the font index. +.TP +.B misc +Options without a clearly defined category. +.TP +.B paths +Path and file name settings. +.TP +.B run +Options controlling runtime behavior of Luaotfload. +.UNINDENT +.sp +The list of valid variables, the sections they are part of and their +type is given below. Types represent Lua types that the values must be +convertible to; they are abbreviated as follows: \fBs\fP for the \fIstring\fP +type, \fBn\fP for \fInumber\fP, \fBb\fP for \fIboolean\fP\&. A value of \fBnil\fP means +the variable is unset. +.SS Section \fBdb\fP +.TS +center; +|l|l|l|. +_ +T{ +variable +T} T{ +type +T} T{ +default +T} +_ +T{ +compress +T} T{ +b +T} T{ +\fBtrue\fP +T} +_ +T{ +formats +T} T{ +s +T} T{ +\fB"otf,ttf,ttc,dfont"\fP +T} +_ +T{ +max\-fonts +T} T{ +n +T} T{ +\fB2^51\fP +T} +_ +T{ +scan\-local +T} T{ +b +T} T{ +\fBfalse\fP +T} +_ +T{ +skip\-read +T} T{ +b +T} T{ +\fBfalse\fP +T} +_ +T{ +strip +T} T{ +b +T} T{ +\fBtrue\fP +T} +_ +T{ +update\-live +T} T{ +b +T} T{ +\fBtrue\fP +T} +_ +.TE +.sp +The flag \fBcompress\fP determines whether the font index (usually +\fBluaotfload\-names.lua[.gz]\fP will be stored in compressed forms. +If unset it is equivalent of passing \fB\-\-no\-compress\fP to +\fBluaotfload\-tool\fP\&. Since the file is only created for convenience +and has no effect on the runtime behavior of Luaotfload, the flag +should remain set. Most editors come with zlib support anyways. +.sp +The list of \fBformats\fP must be a comma separated sequence of strings +containing one or more of these elements: +.INDENT 0.0 +.IP \(bu 2 +\fBotf\fP (OpenType format), +.IP \(bu 2 +\fBttf\fP and \fBttc\fP (TrueType format), +.IP \(bu 2 +\fBdfont\fP (Macintosh TrueType format), +.IP \(bu 2 +\fBafm\fP (Adobe Font Metrics), +.IP \(bu 2 +\fBpfb\fP and \fBpfa\fP (PostScript format). +.UNINDENT +.sp +It corresponds loosely to the \fB\-\-formats\fP option to +\fBluaotfload\-tool\fP\&. Invalid or duplicate members are ignored; if the +list does not contain any useful identifiers, the default list +\fB"otf,ttf,ttc,dfont"\fP will be used. +.sp +The variable \fBmax\-fonts\fP determines after processing how many font +files the font scanner will terminate the search. This is useful for +debugging issues with the font index and has the same effect as the +option \fB\-\-max\-fonts\fP to \fBluaotfload\-tools\fP\&. +.sp +The \fBscan\-local\fP flag, if set, will incorporate the current working +directory as a font search location. NB: This will potentially slow +down document processing because a font index with local fonts will not +be saved to disk, so these fonts will have to be re\-indexed whenever +the document is built. +.sp +The \fBskip\-read\fP flag is only useful for debugging: It makes +Luaotfload skip reading fonts. The font information for rebuilding the +index is taken from the presently existing one. +.sp +Unsetting the \fBstrip\fP flag prevents Luaotfload from removing data +from the index that is only useful when processing font files. NB: this +can increase the size of the index files significantly and has no +effect on the runtime behavior. +.sp +If \fBupdate\-live\fP is set, Luaotfload will reload the database if it +cannot find a requested font. Those who prefer to update manually using +\fBluaotfload\-tool\fP should unset this flag. +.SS Section \fBdefault\-features\fP +.sp +By default Luaotfload enables \fBnode\fP mode and picks the default font +features that are prescribed in the OpenType standard. This behavior +may be overridden in the \fBdefault\-features\fP section. Global defaults +that will be applied for all scripts can be set via the \fBglobal\fP +option, others by the script they are to be applied to. For example, +a setting of +.INDENT 0.0 +.INDENT 3.5 +.sp +.nf +.ft C +[default\-features] + global = mode=base,color=0000FF + dflt = smcp,onum +.ft P +.fi +.UNINDENT +.UNINDENT +.sp +would force \fIbase\fP 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 \fBtrue\fP\&. +.SS Section \fBmisc\fP +.TS +center; +|l|l|l|. +_ +T{ +variable +T} T{ +type +T} T{ +default +T} +_ +T{ +statistics +T} T{ +b +T} T{ +\fBfalse\fP +T} +_ +T{ +termwidth +T} T{ +n +T} T{ +\fBnil\fP +T} +_ +T{ +version +T} T{ +s +T} T{ +<Luaotfload version> +T} +_ +.TE +.sp +With \fBstatistics\fP enabled, extra statistics will be collected during +index creation and appended to the index file. It may then be queried +at the Lua end or inspected by reading the file itself. +.sp +The value of \fBtermwidth\fP, if set, overrides the value retrieved by +querying the properties of the terminal in which Luatex runs. This is +useful if the engine runs with \fBshell_escape\fP disabled and the actual +terminal dimensions cannot be retrieved. +.sp +The value of \fBversion\fP is derived from the version string hard\-coded +in the Luaotfload source. Override at your own risk. +.SS Section \fBpaths\fP +.TS +center; +|l|l|l|. +_ +T{ +variable +T} T{ +type +T} T{ +default +T} +_ +T{ +cache\-dir +T} T{ +s +T} T{ +\fB"fonts"\fP +T} +_ +T{ +names\-dir +T} T{ +s +T} T{ +\fB"names"\fP +T} +_ +T{ +index\-file +T} T{ +s +T} T{ +\fB"luaotfload\-names.lua"\fP +T} +_ +T{ +lookups\-file +T} T{ +s +T} T{ +\fB"luaotfload\-lookup\-cache.lua"\fP +T} +_ +.TE +.sp +The paths \fBcache\-dir\fP and \fBnames\-dir\fP determine the subdirectory +inside the Luaotfload subtree of the \fBluatex\-cache\fP directory where +the font cache and the font index will be stored, respectively. +.sp +Inside the index directory, the names of the index file and the font +lookup cache will be derived from the respective values of +\fBindex\-file\fP and \fBlookups\-file\fP\&. This is the filename base for the +bytecode compiled version as well as \-\- for the index \-\- the gzipped +version. +.SS Section \fBrun\fP +.TS +center; +|l|l|l|. +_ +T{ +variable +T} T{ +type +T} T{ +default +T} +_ +T{ +color\-callback +T} T{ +s +T} T{ +\fB"pre_linebreak_filter"\fP +T} +_ +T{ +definer +T} T{ +s +T} T{ +\fB"patch"\fP +T} +_ +T{ +log\-level +T} T{ +n +T} T{ +\fB0\fP +T} +_ +T{ +resolver +T} T{ +s +T} T{ +\fB"cached"\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. +.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 +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 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. +At a log level of five Luaotfload can be very noisy. Also, printing too +many messages will slow down the interpreter due to line buffering +being disabled (see \fBsetbuf\fP(3)). +.sp +The \fBresolver\fP setting allows choosing the font name resolution +function: With the default value \fBcached\fP Luaotfload saves the result +of a successful font name request to a cache file to speed up +subsequent lookups. The alternative, \fBnormal\fP circumvents the cache +and resolves every request individually. (Since to the restructuring of +the font name index in Luaotfload 2.4 the performance difference +between the cached and uncached lookups should be marginal.) +.SH FILES +.sp +Luaotfload only processes the first configuration file it encounters at +one of the search locations. The file name may be either +\fBluaotfload.conf\fP or \fBluaotfloadrc\fP, except for the dotfile in the +user’s home directory which is expected at \fB~/.luaotfloadrc\fP\&. +.sp +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 +.INDENT 0.0 +.IP i. 5 +The current working directory of the LuaTeX process. +.IP ii. 5 +The subdirectory \fBluaotfload/\fP inside the XDG configuration +tree, e. g. \fB/home/oenothea/config/luaotfload/\fP\&. +.IP iii. 5 +The dotfile. +.IP iv. 5 +The \fITEXMF\fP (using kpathsea). +.UNINDENT +.SH SEE ALSO +.sp +\fBluaotfload\-tool\fP(1), \fBluatex\fP(1), \fBlua\fP(1) +.INDENT 0.0 +.IP \(bu 2 +\fBtexdoc luaotfload\fP to display the PDF manual for the \fILuaotfload\fP +package +.IP \(bu 2 +Luaotfload development \fI\%https://github.com/lualatex/luaotfload\fP +.IP \(bu 2 +LuaLaTeX mailing list \fI\%http://tug.org/pipermail/lualatex\-dev/\fP +.IP \(bu 2 +LuaTeX \fI\%http://luatex.org/\fP +.IP \(bu 2 +Luaotfload on CTAN \fI\%http://ctan.org/pkg/luaotfload\fP +.UNINDENT +.SH REFERENCES +.INDENT 0.0 +.IP \(bu 2 +The XDG base specification +\fI\%http://standards.freedesktop.org/basedir\-spec/basedir\-spec\-latest.html\fP\&. +.UNINDENT +.SH AUTHORS +.sp +\fILuaotfload\fP is maintained by the LuaLaTeX dev team +(\fI\%https://github.com/lualatex/\fP). +.sp +This manual page was written by Philipp Gesang +<\fI\%philipp.gesang@alumni.uni\-heidelberg.de\fP>. +.SH COPYRIGHT +GPL v2.0 +.\" Generated by docutils manpage writer. +. |