summaryrefslogtreecommitdiff
path: root/Master/texmf-dist/doc/man/man1/luaotfload-tool.1
blob: b158f17ce932687ee6e757be7926dec1616928ab (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
.\" Man page generated from reStructuredText.
.
.TH LUAOTFLOAD-TOOL 1 "2013-06-02" "2.3" "text processing"
.SH NAME
luaotfload-tool \- generate and query the Luaotfload font names database
.
.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
.sp
\fBluaotfload\fP [ \-bDcfFiIpquvVwh ]
.sp
\fBluaotfload\fP \-\-update [ \-\-force ] [ \-\-quiet ] [ \-\-verbose ] [ \-\-prefer\-texmf ] [ \-\-dry\-run ]
.sp
\fBluaotfload\fP \-\-find=FONTNAME [ \-\-fuzzy ] [ \-\-info ] [ \-\-inspect ]
.sp
\fBluaotfload\fP \-\-flush\-lookups
.sp
\fBluaotfload\fP \-\-cache=DIRECTIVE
.sp
\fBluaotfload\fP \-\-list=CRITERION[:VALUE] [ \-\-fields=F1,F2,...,Fn ]
.sp
\fBluaotfload\fP \-\-help
.sp
\fBluaotfload\fP \-\-version
.sp
\fBluaotfload\fP \-\-show\-blacklist
.SH DESCRIPTION
.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.
.INDENT 0.0
.IP \(bu 2
\fBupdate\fP:  update the database or rebuild it entirely;
.IP \(bu 2
\fBquery\fP:   resolve a font name or display close matches.
.UNINDENT
.sp
A third mode for clearing the lookup cache is currently experimental.
.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
.TP
.B \-\-update,  \-u
Update the database; indexes new fonts.
.TP
.B \-\-force,  \-f
Force rebuilding of the database; re\-indexes
all fonts.
.TP
.B \-\-prefer\-texmf,  \-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
Don’t load fonts, scan directories only.
(For debugging file system related issues.)
.UNINDENT
.SS query mode
.INDENT 0.0
.TP
.BI \-\-find\fB= NAME
Resolve a font name; this looks up <name> in
the database and prints the file name it is
mapped to.
.TP
.B \-\-fuzzy,  \-F
Show approximate matches to the file name if
the lookup was unsuccessful (requires
\fB\-\-find\fP).
.TP
.B \-\-info,  \-i
Display basic information to a resolved font
file (requires \fB\-\-find\fP).
.TP
.B \-\-inspect,  \-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
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
Show blacklisted files (not directories).
.TP
.BI \-\-list\fB= CRITERION
Show entries, where \fICRITERION\fP is one of the
following:
.INDENT 7.0
.IP 1. 3
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
.IP 3. 3
an expression of the form \fBfield:value\fP to
limit the output to entries whose \fBfield\fP
matches \fBvalue\fP.
.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.)
.UNINDENT
.SS font and lookup caches
.INDENT 0.0
.TP
.B \-\-flush\-lookups
Clear font name lookup cache (experimental).
.TP
.BI \-\-cache\fB= DIRECTIVE
Cache control, where \fIDIRECTIVE\fP is one of the
following:
.INDENT 7.0
.IP 1. 3
\fBpurge\fP \-> delete Lua files from cache;
.IP 2. 3
\fBerase\fP \-> delete Lua and Luc files from
cache;
.IP 3. 3
\fBshow\fP  \-> print stats.
.UNINDENT
.UNINDENT
.SS miscellaneous
.INDENT 0.0
.TP
.BI \-\-verbose\fB= N, \ \-v
Set verbosity level to \fIn\fP or the number of
repetitions of \fB\-v\fP.
.TP
.B \-\-quiet
No verbose output (log level set to zero).
.TP
.BI \-\-log\fB= CHANNEL
Redirect log output (for database
troubleshooting), where \fICHANNEL\fP can be
.INDENT 7.0
.IP 1. 3
\fBstdout\fP \-> all output will be
dumped to the terminal; or
.IP 2. 3
\fBfile\fP \-> write to a file to the temporary
directory (the name will be chosen
automatically (\fBexperimental!\fP).
.UNINDENT
.TP
.B \-\-version,  \-V
Show version number and exit.
.TP
.B \-\-help,  \-h
Show help message and exit.
.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.
.SH SEE ALSO
.sp
\fBluatex\fP (1), \fBlua\fP (1)
.INDENT 0.0
.IP \(bu 2
\fBtexdoc luaotfload\fP to display the 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
ConTeXt                \fI\%http://wiki.contextgarden.net\fP
.IP \(bu 2
Luaotfload on CTAN     \fI\%http://ctan.org/pkg/luaotfload\fP
.UNINDENT
.SH BUGS
.sp
Tons, probably.
.SH AUTHORS
.sp
\fILuaotfload\fP is maintained by the LuaLaTeX dev team
(\fI\%https://github.com/lualatex/\fP).
The fontloader code is provided by Hans Hagen of Pragma ADE, Hasselt
NL (\fI\%http://pragma\-ade.com/\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.
.