| blob | c72ae139fec7cdcfce8f849c7ae75a2dd184db3f |
1 .\" DO NOT MODIFY THIS FILE! It was generated by help2man 1.45.1.
2 .TH UPDMAP "1" "May 2014" "TeX Live" "User Commands"
3 .SH NAME
4 updmap \- manage TeX font maps, per-user
5 .br
6 updmap-sys \- manage TeX font maps, system-wide
7 .SH SYNOPSIS
8 .B updmap
9 [\fI\,OPTION\/\fR] ... [\fI\,COMMAND\/\fR]
10 .br
11 .B updmap-sys
12 [\fI\,OPTION\/\fR] ... [\fI\,COMMAND\/\fR]
13 .SH DESCRIPTION
14 updmap version svn33988 (2014\-05\-12 15:39:32 +0900)
15 .PP
16 Update the default font map files used by pdftex, dvips, and dvipdfm(x),
17 and optionally pxdvi, as determined by all configuration files updmap.cfg
18 (the ones returned by running "kpsewhich \fB\-\-all\fR updmap.cfg", but see below).
19 .PP
20 Among other things, these map files are used to determine which fonts
21 should be used as bitmaps and which as outlines, and to determine which
22 font files are included in the PDF or PostScript output.
23 .PP
24 updmap\-sys is intended to affect the system\-wide configuration, while
25 updmap affects personal configuration files only, overriding the system
26 files. As a consequence, once updmap has been run, even a single time,
27 running updmap\-sys no longer has any effect. (updmap\-sys issues a
28 warning in this situation.)
29 .PP
30 By default, the TeX filename database (ls\-R) is also updated.
31 .SH OPTIONS
32 .TP
33 \fB\-\-cnffile\fR FILE
34 read FILE for the updmap configuration
35 (can be given multiple times, in which case
36 all the files are used)
37 .TP
38 \fB\-\-dvipdfmxoutputdir\fR DIR
39 specify output directory (dvipdfm(x) syntax)
40 .TP
41 \fB\-\-dvipsoutputdir\fR DIR
42 specify output directory (dvips syntax)
43 .TP
44 \fB\-\-pdftexoutputdir\fR DIR
45 specify output directory (pdftex syntax)
46 .TP
47 \fB\-\-pxdvioutputdir\fR DIR
48 specify output directory (pxdvi syntax)
49 .TP
50 \fB\-\-outputdir\fR DIR
51 specify output directory (for all files)
52 .TP
53 \fB\-\-copy\fR
54 cp generic files rather than using symlinks
55 .TP
56 \fB\-\-force\fR
57 recreate files even if config hasn't changed
58 .TP
59 \fB\-\-nomkmap\fR
60 do not recreate map files
61 .TP
62 \fB\-\-nohash\fR
63 do not run texhash
64 .TP
65 \fB\-\-sys\fR
66 affect system\-wide files (equivalent to updmap\-sys)
67 .TP
68 \fB\-n\fR, \fB\-\-dry\-run\fR
69 only show the configuration, no output
70 .TP
71 \fB\-\-quiet\fR, \fB\-\-silent\fR
72 reduce verbosity
73 .SS "Commands:"
74 .TP
75 \fB\-\-help\fR
76 show this message and exit
77 .TP
78 \fB\-\-version\fR
79 show version information and exit
80 .TP
81 \fB\-\-showoption\fR OPTION
82 show the current setting of OPTION
83 .TP
84 \fB\-\-showoptions\fR OPTION
85 show possible settings for OPTION
86 .TP
87 \fB\-\-setoption\fR OPTION VALUE
88 set OPTION to value; option names below
89 .TP
90 \fB\-\-setoption\fR OPTION=VALUE
91 as above, just different syntax
92 .TP
93 \fB\-\-enable\fR MAPTYPE MAPFILE
94 add "MAPTYPE MAPFILE" to updmap.cfg,
95 where MAPTYPE is Map, MixedMap, or KanjiMap
96 .TP
97 \fB\-\-enable\fR Map=MAPFILE
98 add "Map MAPFILE" to updmap.cfg
99 .HP
100 \fB\-\-enable\fR MixedMap=MAPFILE add "MixedMap MAPFILE" to updmap.cfg
101 .HP
102 \fB\-\-enable\fR KanjiMap=MAPFILE add "KanjiMap MAPFILE" to updmap.cfg
103 .TP
104 \fB\-\-disable\fR MAPFILE
105 disable MAPFILE, of whatever type
106 .TP
107 \fB\-\-listmaps\fR
108 list all active and inactive maps
109 .TP
110 \fB\-\-listavailablemaps\fR
111 same as \fB\-\-listmaps\fR, but without
112 unavailable map files
113 .TP
114 \fB\-\-syncwithtrees\fR
115 disable unavailable map files in updmap.cfg
116 .PP
117 Explanation of the map types: the (only) difference between Map and
118 MixedMap is that MixedMap entries are not added to psfonts_pk.map.
119 The purpose is to help users with devices that render Type 1 outline
120 fonts worse than mode\-tuned Type 1 bitmap fonts. So, MixedMap is used
121 for fonts that are available as both Type 1 and Metafont.
122 KanjiMap entries are added to psfonts_t1.map and kanjix.map.
123 .PP
124 Explanation of the OPTION names for \fB\-\-showoptions\fR, \fB\-\-showoption\fR, \fB\-\-setoption\fR:
125 .TP
126 dvipsPreferOutline
127 true,false (default true)
128 .IP
129 Whether dvips uses bitmaps or outlines, when both are available.
130 .TP
131 dvipsDownloadBase35
132 true,false (default true)
133 .IP
134 Whether dvips includes the standard 35 PostScript fonts in its output.
135 .TP
136 pdftexDownloadBase14
137 true,false (default true)
138 .IP
139 Whether pdftex includes the standard 14 PDF fonts in its output.
140 .TP
141 pxdviUse
142 true,false (default false)
143 .IP
144 Whether maps for pxdvi (Japanese\-patched xdvi) are under updmap's control.
145 .TP
146 kanjiEmbed
147 (any string)
148 .TP
149 kanjiVariant
150 (any string)
151 .IP
152 See below.
153 .TP
154 LW35
155 URWkb,URW,ADOBEkb,ADOBE (default URWkb)
156 .IP
157 Adapt the font and file names of the standard 35 PostScript fonts.
158 .nf
159 .TP
160 URWkb
161 URW fonts with "berry" filenames (e.g. uhvbo8ac.pfb)
162 .TP
163 URW
164 URW fonts with "vendor" filenames (e.g. n019064l.pfb)
165 .fi
166 .TP
167 ADOBEkb
168 Adobe fonts with "berry" filenames (e.g. phvbo8an.pfb)
169 .TP
170 ADOBE
171 Adobe fonts with "vendor" filenames (e.g. hvnbo___.pfb)
172 .fi
173 .IP
174 These options are only read and acted on by updmap; dvips, pdftex, etc.,
175 do not know anything about them. They work by changing the default map
176 file which the programs read, so they can be overridden by specifying
177 command\-line options or configuration files to the programs, as
178 explained at the beginning of updmap.cfg.
179 .IP
180 The options kanjiEmbed and kanjiVariant specify special replacements
181 in the map lines. If a map contains the string @kanjiEmbed@, then
182 this will be replaced by the value of that option; similarly for
183 kanjiVariant. In this way, users of Japanese TeX can select different
184 fonts to be included in the final output.
185 .SH ENVIRONMENT
186 .PP
187 Explanation of trees and files normally used:
188 .IP
189 If \fB\-\-cnffile\fR is specified on the command line (possibly multiple
190 times), its value(s) are used. Otherwise, updmap reads all the
191 updmap.cfg files found by running `kpsewhich \fB\-all\fR updmap.cfg', in the
192 order returned by kpsewhich.
193 .IP
194 In any case, if multiple updmap.cfg files are found, all the maps
195 mentioned in all the updmap.cfg files are merged.
196 .IP
197 Thus, if updmap.cfg files are present in all trees, and the default
198 layout is used as shipped with TeX Live, the following files are
199 read, in the given order.
200 .nf
201 .IP
202 For updmap\-sys:
203 TEXMFSYSCONFIG \fI\,$TEXLIVE/YYYY/texmf\-config/web2c/updmap.cfg\/\fP
204 TEXMFSYSVAR \fI\,$TEXLIVE/YYYY/texmf\-var/web2c/updmap.cfg\/\fP
205 TEXMFLOCAL \fI\,$TEXLIVE/texmf\-local/web2c/updmap.cfg\/\fP
206 TEXMFDIST \fI\,$TEXLIVE/YYYY/texmf\-dist/web2c/updmap.cfg\/\fP
207 .IP
208 For updmap:
209 TEXMFCONFIG $HOME/.texliveYYYY/texmf\-config/web2c/updmap.cfg
210 TEXMFVAR $HOME/.texliveYYYY/texmf\-var/web2c/updmap.cfg
211 TEXMFHOME \fI\,$HOME/texmf/web2c/updmap.cfg\/\fP
212 TEXMFSYSCONFIG \fI\,$TEXLIVE/YYYY/texmf\-config/web2c/updmap.cfg\/\fP
213 TEXMFSYSVAR \fI\,$TEXLIVE/YYYY/texmf\-var/web2c/updmap.cfg\/\fP
214 TEXMFLOCAL \fI\,$TEXLIVE/texmf\-local/web2c/updmap.cfg\/\fP
215 TEXMFDIST \fI\,$TEXLIVE/YYYY/texmf\-dist/web2c/updmap.cfg\/\fP
216 .IP
217 (where YYYY is the TeX Live release version).
218 .fi
219 .IP
220 According to the actions, updmap might write to one of the given files
221 or create a new updmap.cfg, described further below.
222 .PP
223 Where changes are saved:
224 .IP
225 If config files are given on the command line, then the first one
226 given will be used to save any changes from \fB\-\-setoption\fR, \fB\-\-enable\fR
227 or \fB\-\-disable\fR. If the config files are taken from kpsewhich output,
228 then the algorithm is more complex:
229 .IP
230 1) If \fI\,$TEXMFCONFIG/web2c/updmap.cfg\/\fP or \fI\,$TEXMFHOME/web2c/updmap.cfg\/\fP
231 appears in the list of used files, then the one listed first by
232 kpsewhich \fB\-\-all\fR (equivalently, the one returned by kpsewhich
233 updmap.cfg), is used.
234 .IP
235 2) If neither of the above two are present and changes are made, a
236 new config file is created in \fI\,$TEXMFCONFIG/web2c/updmap.cfg\/\fP.
237 .IP
238 In general, the idea is that if a given config file is not writable, a
239 higher\-level one can be used. That way, the distribution's settings
240 can be overridden for system\-wide using TEXMFLOCAL, and then system
241 settings can be overridden again for a particular using using TEXMFHOME.
242 .PP
243 Resolving multiple definitions of a font:
244 .IP
245 If a font is defined in more than one map file, then the definition
246 coming from the first\-listed updmap.cfg is used. If a font is
247 defined multiple times within the same map file, one is chosen
248 arbitrarily. In both cases a warning is issued.
249 .PP
250 Disabling maps:
251 .IP
252 updmap.cfg files with higher priority (listed earlier) can disable
253 maps mentioned in lower priority (listed later) updmap.cfg files by
254 writing, e.g.,
255 .IP
256 #! Map mapname.map
257 .IP
258 or
259 .IP
260 #! MixedMap mapname.map
261 .IP
262 in the higher\-priority updmap.cfg file.
263 .IP
264 As an example, suppose you have a copy of MathTime Pro fonts
265 and want to disable the Belleek version of the fonts; that is,
266 disable the map belleek.map. You can create the file
267 \fI\,$TEXMFCONFIG/web2c/updmap.cfg\/\fP with the content
268 .IP
269 #! Map belleek.map
270 Map mt\-plus.map
271 Map mt\-yy.map
272 .IP
273 and call updmap.
274 .PP
275 updmap writes the map files for dvips (psfonts.map) and pdftex
276 (pdftex.map) to the TEXMFVAR/fonts/map/updmap/{dvips,pdftex}/
277 directories.
278 .PP
279 The log file is written to TEXMFVAR/web2c/updmap.log.
280 .PP
281 When updmap\-sys is run, TEXMFSYSCONFIG and TEXMFSYSVAR are used
282 instead of TEXMFCONFIG and TEXMFVAR, respectively. This is the only
283 difference between updmap\-sys and updmap.
284 .PP
285 Other locations may be used if you give them on the command line, or
286 these trees don't exist, or you are not using the original TeX Live.
287 .PP
288 To see the precise locations of the various files that
289 will be read and written, give the \fB\-n\fR option (or read the source).
290 .SH EXAMPLES
291 .PP
292 For step\-by\-step instructions on making new fonts known to TeX, read
293 http://tug.org/fonts/fontinstall.html. For even more terse
294 instructions, read the beginning of the main updmap.cfg.
295 .SH FILES
296 Configuration and input files:
297 .IP "\fIupdmap\&.cfg\fP"
298 Main configuration file\&. In
299 \fItexmf-dist/web2c\fP by default, but may be located elsewhere
300 depending on your distribution\&. Each texmf tree read should have its
301 own \fIupdmap.cfg\fP.
302 .IP "\fIdvips35\&.map\fP"
303 Map file for standard 35 PostScript fonts for
304 use with \fBdvips\fP(1)\&.
305 .IP "\fIpdftex35\&.map\fP"
306 Map file for standard 35 PostScript fonts for
307 use with \fBpdftex\fP(1)\&.
308 .IP "\fIps2pk35\&.map\fP"
309 Map file for standard 35 PostScript fonts for
310 use with \fBps2pk\fP(1)\&.
311 .PP
312 Output files:
313 .IP "\fIpsfonts\&.map\fP"
314 For \fBdvips\fP(1)\&.
315 Same as \fIpsfonts_t1\&.map\fP if option \fBdvipsPreferOutline\fP active,
316 else as \fIpsfonts_pk\&.map\fP.
317 .IP "\fIpsfonts_pk\&.map\fP"
318 For \fBdvips\fP(1)\&.
319 Without information from MixedMap files\&.
320 (Setting of \fBdvipsPreferOutline\fP ignored\&.)
321 .IP "\fIpsfonts_t1\&.map\fP"
322 For \fBdvips\fP(1)\&.
323 With information from MixedMap files\&.
324 (Setting of \fBdvipsPreferOutline\fP ignored\&.)
325 .IP "\fIdownload35\&.map\fP"
326 For \fBdvips\fP(1)\&.
327 Always downloads the standard 35 fonts\&.
328 (Setting of \fBdvipsDownloadBase35\fP ignored\&.)
329 .IP "\fIbuiltin35\&.map\fP"
330 For \fBdvips\fP(1)\&.
331 Never downloads the standard 35 fonts\&.
332 (Setting of \fBdvipsDownloadBase35\fP ignored\&.)
333 .IP "\fIpdftex\&.map\fP"
334 For \fBpdftex\fP(1)\&.
335 Same as \fIpdftex_dl14\&.map\fP if option \fBpdftexDownloadBase14\fP active,
336 else as \fIpdftex_ndl14\&.map\fP.
337 .IP "\fIpdftex_dl14\&.map\fP"
338 For \fBpdftex\fP(1)\&.
339 Always downloads the standard 14 fonts\&.
340 .IP "\fIpdftex_ndl14\&.map\fP"
341 For \fBpdftex\fP(1)\&.
342 Never downloads the standard 14 fonts\&.
343 .IP "\fIps2pk\&.map\fP"
344 Similar to \fIpsfonts.map\fP file, but
345 forces all fonts to be downloaded, so this map file can be used with
346 \fBxdvi\fP(1) and \fBps2pk\fP(1)\&.
347 .PP
348 Configuration files for \fBdvips\fP(1):
349 .IP "\fIconfig\&.builtin35\fP"
350 Loads \fIbuiltin35\&.map\fP instead
351 of \fIpsfonts\&.map\fP\&.
352 .IP "\fIconfig\&.download35\fP"
353 Loads \fIdownload35\&.map\fP instead
354 of \fIpsfonts\&.map\fP\&.
355 .IP "\fIconfig\&.outline\fP"
356 Loads \fIpsfonts_t1\&.map\fP instead
357 of \fIpsfonts\&.map\fP\&.
358 .IP "\fIconfig\&.pdf\fP"
359 Loads \fIpsfonts_t1\&.map\fP instead
360 of \fIpsfonts\&.map\fP and has additional optimizations for PDF generation\&.
361 .IP "\fIconfig\&.pk\fP"
362 Loads \fIpsfonts_pk\&.map\fP instead
363 of \fIpsfonts\&.map\fP\&.
364 .IP "\fIconfig\&.www\fP"
365 Loads \fIpsfonts_t1\&.map\fP instead
366 of \fIpsfonts\&.map\fP\&.
367 (For compatibility with old versions\&.)
368 .IP "\fIconfig\&.gstopk\fP"
369 Loads \fIpsfonts_t1\&.map\fP instead
370 of \fIpsfonts\&.map\fP\&.
371 .SH "REPORTING BUGS"
372 Report bugs to: tex\-k@tug.org
373 .br
374 TeX Live home page: <http://tug.org/texlive/>