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 [OPTION] ... [COMMAND]
11 updmap-sys [OPTION] ... [COMMAND]
12
14 updmap (TeX Live, multi) version $Id: updmap.pl 26891 2012-06-10
15 22:41:49Z karl $
16 Update the default font map files used by pdftex, dvips, and
18 dvipdfm(x), and optionally pxdvi, as determined by all configuration
19 files updmap.cfg (the ones returned by running "kpsewhich --all
20 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 in the PDF or PostScript output.
25 By default, the TeX filename database (ls-R) is also updated.
27
29 --cnffile FILE
30 read FILE for the updmap configuration (can be given multiple
31 times, in which case all the files are used)
32 --dvipdfmxoutputdir DIR
34 specify output directory (dvipdfm(x) syntax)
35 --dvipsoutputdir DIR
37 specify output directory (dvips syntax)
38 --pdftexoutputdir DIR
40 specify output directory (pdftex syntax)
41 --pxdvioutputdir DIR
43 specify output directory (pxdvi syntax)
44 --outputdir DIR
46 specify output directory (for all files)
47 --copy cp generic files rather than using symlinks
49 --force
51 recreate files even if config hasn't changed
52 --nomkmap
54 do not recreate map files
55 --nohash
57 do not run texhash
58 -n, --dry-run
60 only show the configuration, no output
61 --quiet, --silent
63 reduce verbosity
64 Commands:
66 --help show this message and exit
67 --version
69 show version information and exit
70 --showoption OPTION
72 show the current setting of OPTION
73 --showoptions OPTION
75 show possible settings for OPTION
76 --setoption OPTION VALUE
78 set OPTION to value; option names below
79 --setoption OPTION=VALUE
81 as above, just different syntax
82 --enable MAPTYPE MAPFILE
84 add "MAPTYPE MAPFILE" to updmap.cfg, where MAPTYPE is Map,
85 MixedMap, or KanjiMap
86 --enable Map=MAPFILE
88 add "Map MAPFILE" to updmap.cfg
89 --enable MixedMap=MAPFILE add "MixedMap MAPFILE" to updmap.cfg
91 --enable KanjiMap=MAPFILE add "KanjiMap MAPFILE" to updmap.cfg
93 --disable MAPFILE
95 disable MAPFILE, of whatever type
96 --listmaps
98 list all active and inactive maps
99 --listavailablemaps
101 same as --listmaps, but without unavailable map files
102 --syncwithtrees
104 disable unavailable map files in updmap.cfg
105 Explanation of the map types: the (only) difference between Map and
107 MixedMap is that MixedMap entries are not added to psfonts_pk.map. The
108 purpose is to help users with devices that render Type 1 outline fonts
109 worse than mode-tuned Type 1 bitmap fonts. So, MixedMap is used for
110 fonts that are available as both Type 1 and Metafont. KanjiMap entries
111 are added to psfonts_t1.map and kanjix.map.
112 Explanation of the OPTION names for --showoptions, --showoptions,
114 --setoption:
115 dvipsPreferOutline
117 true|false (default true)
118 Whether dvips uses bitmaps or outlines, when both are available.
120 dvipsDownloadBase35
122 true|false (default true)
123 Whether dvips includes the standard 35 PostScript fonts in its
125 output.
126 pdftexDownloadBase14
128 true|false (default true)
129 Whether pdftex includes the standard 14 PDF fonts in its output.
131 pxdviUse
133 true|false (default false)
134 Whether maps for pxdvi (Japanese-patched xdvi) are under
136 updmap's control.
137 kanjiEmbed
139 (any string)
140 kanjiVariant
142 (any string)
143 See below.
145 LW35 URWkb|URW|ADOBEkb|ADOBE (default URWkb)
147 Adapt the font and file names of the standard 35 PostScript
149 fonts. URWkb URW fonts with "berry" filenames (e.g.
150 uhvbo8ac.pfb) URW URW fonts with "vendor" filenames (e.g.
151 n019064l.pfb) ADOBEkb Adobe fonts with "berry" filenames (e.g.
152 phvbo8an.pfb) ADOBE Adobe fonts with "vendor" filenames (e.g.
153 hvnbo___.pfb)
154 These options are only read and acted on by updmap; dvips, pdf‐
156 tex, etc., do not know anything about them. They work by chang‐
157 ing the default map file which the programs read, so they can be
158 overridden by specifying command-line options or configuration
159 files to the programs, as explained at the beginning of
160 updmap.cfg.
161 The options kanjiEmbed and kanjiVariant specify special replace‐
163 ments in the map lines. If a map contains the string @kanjiEm‐
164 bed@, then this will be replaced by the value of that option;
165 similarly for kanjiVariant. In this way, users of Japanese TeX
166 can select different fonts to be included in the final output.
167
169 Explanation of trees and files normally used:
170 If --cnffile is specified on the command line (possibly multiple
172 times), its value(s) are used. Otherwise, updmap reads all the
173 updmap.cfg files found by running `kpsewhich -all updmap.cfg',
174 in the order returned by kpsewhich, with one exception: an
175 updmap.cfg found in TEXMFLOCAL is given higher priority than the
176 updmap.cfg in TEXMFMAIN, to ensure that local adjustments by
177 administrators take precedence over what is shipped in TeX Live.
178 In any case, if multiple updmap.cfg files are found, all the
180 maps mentioned in all the updmap.cfg files are merged.
181 Thus, if updmap.cfg files are present in all trees, and the
183 default layout is used as shipped with TeX Live, the following
184 files are read, in the given order.
185 For updmap-sys:
187 TEXMFSYSCONFIG $TEXLIVE/YYYY/texmf-config/web2c/updmap.cfg
188 TEXMFSYSVAR $TEXLIVE/YYYY/texmf-var/web2c/updmap.cfg
189 TEXMFLOCAL $TEXLIVE/texmf-local/web2c/updmap.cfg
190 TEXMFMAIN $TEXLIVE/YYYY/texmf/web2c/updmap.cfg
191 TEXMFDIST $TEXLIVE/YYYY/texmf-dist/web2c/updmap.cfg
192 For updmap:
194 TEXMFCONFIG $HOME/.texliveYYYY/texmf-config/web2c/updmap.cfg
195 TEXMFVAR $HOME/.texliveYYYY/texmf-var/web2c/updmap.cfg
196 TEXMFHOME $HOME/texmf/web2c/updmap.cfg
197 TEXMFSYSCONFIG $TEXLIVE/YYYY/texmf-config/web2c/updmap.cfg
198 TEXMFSYSVAR $TEXLIVE/YYYY/texmf-var/web2c/updmap.cfg
199 TEXMFLOCAL $TEXLIVE/texmf-local/web2c/updmap.cfg
200 TEXMFMAIN $TEXLIVE/YYYY/texmf/web2c/updmap.cfg
201 TEXMFDIST $TEXLIVE/YYYY/texmf-dist/web2c/updmap.cfg
202 (where YYYY is the TeX Live release version).
204 There is another exception to keep upgradability from earlier
206 versions of TeX Live: if a file TEXMFLO‐
207 CAL/web2c/updmap-local.cfg exists (formerly used by tlmgr to
208 merge local fonts), then the file TEXMFLOCAL/web2c/updmap.cfg is
209 ignored (if it exists) and that updmap-local.cfg is used
210 instead. In this case, updmap recognizes the previous syntax
211 for disabling map files in updmap-local.cfg (this syntax is dif‐
212 ferent from what is used now).
213 According to the actions, updmap might write to one of the given
215 files or create a new updmap.cfg, described further below.
216 Where changes are saved: if config files are given on the com‐
218 mand line, then the first one given will be used to save any
219 changes from --setoption, --enable or --disable. If the config
220 files are taken from kpsewhich output, then the algorithm is
221 more complex:
222 1) If $TEXMFCONFIG/web2c/updmap.cfg or
224 $TEXMFHOME/web2c/updmap.cfg appears in the list of used files,
225 then the one listed first by kpsewhich --all (equivalently, the
226 one returned by kpsewhich updmap.cfg), is used.
227 2) If neither of the above two are present and changes are made,
229 a new config file is created in $TEXMFCONFIG/web2c/updmap.cfg.
230 Resolving multiple definitions of a font:
232 If a font is defined in more than one map file, then the defini‐
234 tion coming from the first-listed updmap.cfg is used. If a font
235 is defined multiple times within the same map file, one is cho‐
236 sen arbitrarily. In both cases a warning is issued.
237 Disabling maps:
239 updmap.cfg files with higher priority (listed earlier) can dis‐
241 able maps mentioned in lower priority (listed later) updmap.cfg
242 files by writing, e.g.,
243 #! Map mapname.map
245 or
247 #! MixedMap mapname.map
249 in the higher-priority updmap.cfg file.
251 As an example, suppose you have a copy of MathTime Pro fonts and
253 want to disable the Belleek version of the fonts; that is, dis‐
254 able the map belleek.map. You can create the file $TEXMFCON‐
255 FIG/web2c/updmap.cfg with the content
256 #! Map belleek.map Map mt-plus.map Map mt-yy.map
258 and call updmap.
260 updmap writes the map files for dvips (psfonts.map) and pdftex
262 (pdftex.map) to the TEXMFVAR/fonts/map/updmap/{dvips,pdftex}/
263 directories.
264 The log file is written to TEXMFVAR/web2c/updmap.log.
266 When updmap-sys is run, TEXMFSYSCONFIG and TEXMFSYSVAR are used
268 instead of TEXMFCONFIG and TEXMFVAR, respectively. This is the
269 only difference between updmap-sys and updmap.
270 Other locations may be used if you give them on the command
272 line, or these trees don't exist, or you are not using the orig‐
273 inal TeX Live.
274 To see the precise locations of the various files that will be
276 read and written, give the -n option (or read the source).
277
279 For step-by-step instructions on making new fonts known to TeX, read
280 http://tug.org/fonts/fontinstall.html. For even more terse instruc‐
281 tions, read the beginning of updmap.cfg.
282
284 Configuration and input files:
285 updmap.cfg
287 Main configuration file. In texmf/web2c by default, but may be
288 located elsewhere depending on your distribution. Each texmf
289 tree read should have its own updmap.cfg.
290 dvips35.map
292 Map file for standard 35 PostScript fonts for use with dvips(1).
293 pdftex35.map
295 Map file for standard 35 PostScript fonts for use with pdf‐
296 tex(1).
297 ps2pk35.map
299 Map file for standard 35 PostScript fonts for use with ps2pk(1).
300 Output files:
302 psfonts.map
304 For dvips(1). Same as psfonts_t1.map if option dvipsPreferOut‐
305 line active, else as psfonts_pk.map.
306 psfonts_pk.map
308 For dvips(1). Without information from MixedMap files. (Set‐
309 ting of dvipsPreferOutline ignored.)
310 psfonts_t1.map
312 For dvips(1). With information from MixedMap files. (Setting
313 of dvipsPreferOutline ignored.)
314 download35.map
316 For dvips(1). Always downloads the standard 35 fonts. (Setting
317 of dvipsDownloadBase35 ignored.)
318 builtin35.map
320 For dvips(1). Never downloads the standard 35 fonts. (Setting
321 of dvipsDownloadBase35 ignored.)
322 pdftex.map
324 For pdftex(1). Same as pdftex_dl14.map if option pdftexDown‐
325 loadBase14 active, else as pdftex_ndl14.map.
326 pdftex_dl14.map
328 For pdftex(1). Always downloads the standard 14 fonts.
329 pdftex_ndl14.map
331 For pdftex(1). Never downloads the standard 14 fonts.
332 ps2pk.map
334 Similar to psfonts.map file, but forces all fonts to be down‐
335 loaded, so this map file can be used with xdvi(1) and ps2pk(1).
336 Configuration files for dvips(1):
338 config.builtin35
340 Loads builtin35.map instead of psfonts.map.
341 config.download35
343 Loads download35.map instead of psfonts.map.
344 config.outline
346 Loads psfonts_t1.map instead of psfonts.map.
347 config.pdf
349 Loads psfonts_t1.map instead of psfonts.map and has additional
350 optimizations for PDF generation.
351 config.pk
353 Loads psfonts_pk.map instead of psfonts.map.
354 config.www
356 Loads psfonts_t1.map instead of psfonts.map. (For compatibility
357 with old versions.)
358 config.gstopk
360 Loads psfonts_t1.map instead of psfonts.map.
361
363 Report bugs to: tex-k@tug.org
364 TeX Live home page: <http://tug.org/texlive/>
365TeX Live June 2012 UPDMAP(1)