1UPDMAP(1) User Commands UPDMAP(1)
2
6 updmap - manage TeX font maps, per-user
7 updmap-sys - manage TeX font maps, system-wide
8
10 updmap [-user|-sys] [OPTION] ... [COMMAND]
11 updmap-user [OPTION] ... [COMMAND]
12 updmap-sys [OPTION] ... [COMMAND]
13
15 updmap version r51338 (2019-06-07 18:36:59 +0200)
16 Update the default font map files used by pdftex (pdftex.map), dvips
18 (psfonts.map), and dvipdfm(x), and optionally pxdvi, as determined by
19 all configuration files updmap.cfg (the ones returned by running "kpse‐
20 which --all updmap.cfg", but see below).
21 Among other things, these map files are used to determine which fonts
23 should be used as bitmaps and which as outlines, and to determine which
24 font files are included, typically subsetted, in the PDF or PostScript
25 output.
26 updmap-sys (or updmap -sys) is intended to affect the system-wide con‐
28 figuration, while updmap-user (or updmap -user) affects personal con‐
29 figuration files only, overriding the system files. As a consequence,
30 once updmap-user has been run, even a single time, running updmap-sys
31 no longer has any effect. (updmap-sys issues a warning in this situa‐
32 tion.)
33 See http://tug.org/texlive/scripts-sys-user.html for details.
35 By default, the TeX filename database (ls-R) is also updated.
37 The updmap system is regrettably complicated, for both inherent and
39 historical reasons. A general overview:
40 - updmap.cfg files are mainly about listing other files, namely the
42 font-specific .maps, in which each line gives information about
44 a different TeX (.tfm) font.
45 - updmap reads the updmap.cfg files and then concatenates the
47 contents of those .map files into the main output files:
49 psfonts.map for dvips and pdftex.map for pdftex and dvipdfmx.
50 - The updmap.cfg files themselves are created and updated at package
52 installation time, by the system installer or the package man‐
54 ager or by hand, and not (by default) by updmap.
55 Good luck.
57
59 --cnffile FILE
60 read FILE for the updmap configuration (can be given multiple
61 times, in which case all the files are used)
62 --dvipdfmxoutputdir DIR
64 specify output directory (dvipdfm(x) syntax)
65 --dvipsoutputdir DIR
67 specify output directory (dvips syntax)
68 --pdftexoutputdir DIR
70 specify output directory (pdftex syntax)
71 --pxdvioutputdir DIR
73 specify output directory (pxdvi syntax)
74 --outputdir DIR
76 specify output directory (for all files)
77 --copy cp generic files rather than using symlinks
79 --force
81 recreate files even if config hasn't changed
82 --nomkmap
84 do not recreate map files
85 --nohash
87 do not run texhash
88 --sys affect system-wide files (equivalent to updmap-sys)
90 --user affect personal files (equivalent to updmap-user)
92 -n, --dry-run
94 only show the configuration, no output
95 --quiet, --silent
97 reduce verbosity
98 Commands:
100 --help show this message and exit
101 --version
103 show version information and exit
104 --showoption OPTION
106 show the current setting of OPTION
107 --showoptions OPTION
109 show possible settings for OPTION
110 --setoption OPTION VALUE
112 set OPTION to value; option names below
113 --setoption OPTION=VALUE
115 as above, just different syntax
116 --enable MAPTYPE MAPFILE
118 add "MAPTYPE MAPFILE" to updmap.cfg, where MAPTYPE is Map,
119 MixedMap, or KanjiMap
120 --enable Map=MAPFILE
122 add "Map MAPFILE" to updmap.cfg
123 --enable MixedMap=MAPFILE add "MixedMap MAPFILE" to updmap.cfg
125 --enable KanjiMap=MAPFILE add "KanjiMap MAPFILE" to updmap.cfg
127 --disable MAPFILE
129 disable MAPFILE, of whatever type
130 --listmaps
132 list all maps (details below)
133 --listavailablemaps
135 list available maps (details below)
136 --syncwithtrees
138 disable unavailable map files in updmap.cfg
139 The main output:
141 The main output of updmap is the files containing the individual
143 font map lines which the drivers (dvips, pdftex, etc.) read to
144 handle fonts.
145 The map files for dvips (psfonts.map) and pdftex and dvipdfmx
147 (pdftex.map) are written to TEXMF‐
148 VAR/fonts/map/updmap/{dvips,pdftex}/.
149 In addition, information about Kanji fonts is written to TEXMF‐
151 VAR/fonts/map/updmap/dvipdfmx/kanjix.map, and optionally to
152 TEXMFVAR/fonts/map/updmap/pxdvi/xdvi-ptex.map. These are for
153 Kanji only and are not like other map files. dvipdfmx reads
154 pdftex.map for the map entries for non-Kanji fonts.
155 If no option is given, so the invocation is just "updmap-user"
157 or "updmap-sys", these output files are always recreated.
158 Otherwise, if an option such as --enable or --disable is given,
160 the output files are recreated if the list of enabled map files
161 (from updmap.cfg) has changed. The --force option overrides
162 this, always recreating the output files.
163 Explanation of the map types:
165 The normal type is Map.
167 The only difference between Map and MixedMap is that MixedMap
169 entries are not added to psfonts_pk.map. The purpose is to help
170 users with devices that render Type 1 outline fonts worse than
171 mode-tuned Type 1 bitmap fonts. So, MixedMap is used for fonts
172 that are available as both Type 1 and Metafont.
173 KanjiMap entries are added to psfonts_t1.map and kanjix.map.
175 Explanation of the OPTION names for --showoptions, --showoption,
177 --setoption:
178 dvipsPreferOutline
180 true,false (default true)
181 Whether dvips uses bitmaps or outlines, when both are available.
183 dvipsDownloadBase35
185 true,false (default true)
186 Whether dvips includes the standard 35 PostScript fonts in its
188 output.
189 pdftexDownloadBase14
191 true,false (default true)
192 Whether pdftex includes the standard 14 PDF fonts in its output.
194 pxdviUse
196 true,false (default false)
197 Whether maps for pxdvi (Japanese-patched xdvi) are under
199 updmap's control.
200 jaEmbed
202 (any string)
203 jaVariant
205 (any string)
206 scEmbed
208 (any string)
209 tcEmbed
211 (any string)
212 koEmbed
214 (any string)
215 See below.
217 LW35 URWkb,URW,ADOBEkb,ADOBE (default URWkb)
219 Adapt the font and file names of the standard 35 PostScript
221 fonts.
222 URWkb URW fonts with "berry" filenames (e.g. uhvbo8ac.pfb)
224 URW URW fonts with "vendor" filenames (e.g. n019064l.pfb)
226 ADOBEkb
228 Adobe fonts with "berry" filenames (e.g. phvbo8an.pfb)
229 ADOBE Adobe fonts with "vendor" filenames (e.g. hvnbo___.pfb)
231 These options are only read and acted on by updmap; dvips, pdf‐
233 tex, etc., do not know anything about them. They work by chang‐
234 ing the default map file which the programs read, so they can be
235 overridden by specifying command-line options or configuration
236 files to the programs, as explained at the beginning of
237 updmap.cfg.
238 The options jaEmbed and jaVariant (formerly kanjiEmbed and kan‐
240 jiVariant) specify special replacements in the map lines. If a
241 map contains the string @jaEmbed@, then this will be replaced by
242 the value of that option; similarly for jaVariant. In this way,
243 users of Japanese TeX can select different fonts to be included
244 in the final output. The counterpart for Simplified Chinese,
245 Traditional Chinese and Korean fonts are scEmbed, tcEmbed and
246 koEmbed respectively.
247
249 Explanation of trees and files normally used:
250 If --cnffile is specified on the command line (can be given mul‐
252 tiple times), its value(s) is(are) used. Otherwise, updmap
253 reads all the updmap.cfg files found by running `kpsewhich -all
254 updmap.cfg', in the order returned by kpsewhich (which is the
255 order of trees defined in texmf.cnf).
256 In either case, if multiple updmap.cfg files are found, all the
258 maps mentioned in all the updmap.cfg files are merged.
259 Thus, if updmap.cfg files are present in all trees, and the
261 default layout is used as shipped with TeX Live, the following
262 files are read, in the given order.
263 For updmap-sys:
265 TEXMFSYSCONFIG $TEXLIVE/YYYY/texmf-config/web2c/updmap.cfg
266 TEXMFSYSVAR $TEXLIVE/YYYY/texmf-var/web2c/updmap.cfg
267 TEXMFLOCAL $TEXLIVE/texmf-local/web2c/updmap.cfg
268 TEXMFDIST $TEXLIVE/YYYY/texmf-dist/web2c/updmap.cfg
269 For updmap-user:
271 TEXMFCONFIG $HOME/.texliveYYYY/texmf-config/web2c/updmap.cfg
272 TEXMFVAR $HOME/.texliveYYYY/texmf-var/web2c/updmap.cfg
273 TEXMFHOME $HOME/texmf/web2c/updmap.cfg
274 TEXMFSYSCONFIG $TEXLIVE/YYYY/texmf-config/web2c/updmap.cfg
275 TEXMFSYSVAR $TEXLIVE/YYYY/texmf-var/web2c/updmap.cfg
276 TEXMFLOCAL $TEXLIVE/texmf-local/web2c/updmap.cfg
277 TEXMFDIST $TEXLIVE/YYYY/texmf-dist/web2c/updmap.cfg
278 (where YYYY is the TeX Live release version).
280 According to the actions, updmap might write to one of the given
282 files or create a new updmap.cfg, described further below.
283 Where and which updmap.cfg changes are saved:
285 When no options are given, the updmap.cfg file(s) are only read,
287 not written. It's when an option --setoption, --enable or
288 --disable is specified that an updmap.cfg needs to be updated.
289 In this case:
290 1) If config files are given on the command line, then the first
292 one given is used to save any such changes.
293 2) If the config files are taken from kpsewhich output, then the
295 algorithm is more complex:
296 2a) If $TEXMFCONFIG/web2c/updmap.cfg or
298 $TEXMFHOME/web2c/updmap.cfg appears in the list of used files,
299 then the one listed first by kpsewhich --all (equivalently, the
300 one returned by kpsewhich updmap.cfg), is used.
301 2b) If neither of the above two are present and changes are
303 made, a new config file is created in $TEXMFCON‐
304 FIG/web2c/updmap.cfg.
305 In general, the idea is that if the user cannot write to a given
307 config file, a higher-level one can be used. That way, the dis‐
308 tribution's settings can be overridden system-wide using TEXM‐
309 FLOCAL, and system settings can be overridden again in a partic‐
310 ular user's TEXMFHOME.
311 Resolving multiple definitions of a font:
313 If a font is defined in more than one map file, then the defini‐
315 tion coming from the first-listed updmap.cfg is used. If a font
316 is defined multiple times within the same map file, one is cho‐
317 sen arbitrarily. In both cases a warning is issued.
318 Disabling maps:
320 updmap.cfg files with higher priority (listed earlier) can dis‐
322 able maps mentioned in lower priority (listed later) updmap.cfg
323 files by writing, e.g.,
324 #! Map mapname.map
326 or
328 #! MixedMap mapname.map
330 in the higher-priority updmap.cfg file.
332 (The #! must be at the
333 beginning of the line, with at least one space or tab afterward,
335 and whitespace between each word on the list.)
336 As an example, suppose you have a copy of MathTime Pro fonts and
338 want to disable the Belleek version of the fonts; that is, dis‐
339 able the map belleek.map. You can create the file $TEXMFCON‐
340 FIG/web2c/updmap.cfg with the content
341 #! Map belleek.map Map mt-plus.map Map mt-yy.map
343 and call updmap.
345 Listing of maps:
347 The two options --listmaps and --listavailablemaps list all maps
349 defined in any of the updmap.cfg files (for --listmaps), and
350 only those actually found on the system (for --listavail‐
351 ablemaps). The output format is one line per font map, with the
352 following fields separated by tabs: map, type (Map, MixedMap,
353 KanjiMap), status (enabled, disabled), origin (the updmap.cfg
354 file where it is mentioned, or 'builtin' for the three basic
355 maps).
356 In the case of --listmaps there can be one additional fields
358 (again separated by tab) containing '(not available)' for those
359 map files that cannot be found.
360 updmap-user vs. updmap-sys:
362 When updmap-sys is run, TEXMFSYSCONFIG and TEXMFSYSVAR are used
364 instead of TEXMFCONFIG and TEXMFVAR, respectively. This is the
365 primary difference between updmap-sys and updmap-user.
366 Other locations may be used if you give them on the command
368 line, or these trees don't exist, or you are not using the orig‐
369 inal TeX Live.
370 To see the precise locations of the various files that will be read and
372 written, give the -n option (or read the source).
373
375 The log file is written to TEXMFVAR/web2c/updmap.log.
376 For step-by-step instructions on making new fonts known to TeX, read
378 http://tug.org/fonts/fontinstall.html. For even more terse instruc‐
379 tions, read the beginning of the main updmap.cfg file.
380
382 Configuration and input files:
383 updmap.cfg
385 Main configuration file. In texmf-dist/web2c by default, but
386 may be located elsewhere depending on your distribution. Each
387 texmf tree read should have its own updmap.cfg.
388 dvips35.map
390 Map file for standard 35 PostScript fonts for use with dvips(1).
391 pdftex35.map
393 Map file for standard 35 PostScript fonts for use with pdf‐
394 tex(1).
395 ps2pk35.map
397 Map file for standard 35 PostScript fonts for use with ps2pk(1).
398 Output files:
400 psfonts.map
402 For dvips(1). Same as psfonts_t1.map if option dvipsPreferOut‐
403 line active, else as psfonts_pk.map.
404 psfonts_pk.map
406 For dvips(1). Without information from MixedMap files. (Set‐
407 ting of dvipsPreferOutline ignored.)
408 psfonts_t1.map
410 For dvips(1). With information from MixedMap files. (Setting
411 of dvipsPreferOutline ignored.)
412 download35.map
414 For dvips(1). Always downloads the standard 35 fonts. (Setting
415 of dvipsDownloadBase35 ignored.)
416 builtin35.map
418 For dvips(1). Never downloads the standard 35 fonts. (Setting
419 of dvipsDownloadBase35 ignored.)
420 pdftex.map
422 For pdftex(1). Same as pdftex_dl14.map if option pdftexDown‐
423 loadBase14 active, else as pdftex_ndl14.map.
424 pdftex_dl14.map
426 For pdftex(1). Always downloads the standard 14 fonts.
427 pdftex_ndl14.map
429 For pdftex(1). Never downloads the standard 14 fonts.
430 ps2pk.map
432 Similar to psfonts.map file, but forces all fonts to be down‐
433 loaded, so this map file can be used with xdvi(1) and ps2pk(1).
434 Configuration files for dvips(1):
436 config.builtin35
438 Loads builtin35.map instead of psfonts.map.
439 config.download35
441 Loads download35.map instead of psfonts.map.
442 config.outline
444 Loads psfonts_t1.map instead of psfonts.map.
445 config.pdf
447 Loads psfonts_t1.map instead of psfonts.map and has additional
448 optimizations for PDF generation.
449 config.pk
451 Loads psfonts_pk.map instead of psfonts.map.
452 config.www
454 Loads psfonts_t1.map instead of psfonts.map. (For compatibility
455 with old versions.)
456 config.gstopk
458 Loads psfonts_t1.map instead of psfonts.map.
459
461 Report bugs to: tex-live@tug.org
462 TeX Live home page: <http://tug.org/texlive/>
463TeX Live March 2020 UPDMAP(1)