Debian Codegraph @

texmf-dist/doc/man/man5/updmap.cfg.5

raw
1 .\" Hey, Emacs! This is an -*- nroff -*- source file.
2 .\"
3 .\" Copyright (C) 2025 Karl Berry <[email protected]>
4 .\" Copyright (C) 2004, 2012 Hilmar Preusse <[email protected]>
5 .\" Copyright (C) 2012 Norbert Preining <[email protected]>
6 .\"
7 .\" This is free software; you can redistribute it and/or modify it under
8 .\" the terms of the GNU General Public License as published by the Free
9 .\" Software Foundation; either version 2, or (at your option) any later
10 .\" version.
11 .\"
12 .\" This is distributed in the hope that it will be useful, but WITHOUT
13 .\" ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
14 .\" FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
15 .\" for more details.
16 .\"
17 .\" You should have received a copy of the GNU General Public License
18 .\" along with this program. if not, see <http://www.gnu.org/licenses/>.
19 .\"
20 .TH "UPDMAP.CFG" "5" "19 February 2025" "TeX Live" "TeX Live"
21 .SH "NAME"
22 \fBupdmap.cfg\fR \- configuration of font mapping/inclusion for dvips and
23 friends.
24 .SH "DESCRIPTION"
25 The file \fBupdmap.cfg\fR is the central font configuration file of a
26 teTeX system and is read by \fBupdmap\fP(1). It describes if and how
27 fonts should be included (or not included) into PS/PDF output files. This
28 works for outline (Postscript Type1) and bitmap fonts (Postscript
29 Type3) mostly coming from Metafont.
30 .PP
31 \fBupdmap\fP is a utility that creates font configuration files for
32 \fBdvips\fP(1), \fBpdftex\fP(1), \fBxdvi\fP(1), \fBps2pk\fP(1),
33 \fBgsftopk\fP(1), and \fBdvipdfmx\fP(1). In
34 an ideal world, updmap would be unnecessary, and each of these programs
35 would read the same configuration file to learn what fonts are
36 available and how they should be treated. As things stand, however,
37 each of these tools has subtly different requirements and thereby
38 needs its own font configuration file. \fBupdmap\fP creates font
39 configuration files for all of these programs from several sources,
40 namely all \fBupdmap.cfg\fR, allowing you to easily keep all the different
41 configuration files in sync.
42 .P
43 Running "updmap --help" will output the main documentation for using
44 \fBupdmap\fR.
45 .P
46 \fBdvipsPreferOutline\fR
47 .br
48 Configures if \fBdvips\fR (by default) should prefer bitmap fonts or
49 outline fonts if both are available. Independent of this setting,
50 outlines can be forced by putting "p psfonts_t1.map" into a config file
51 that dvips reads. Bitmaps can be forced by putting "p psfonts_pk.map"
52 into a config file. We provide such config files which can be enabled
53 via \fBdvips\fR \fI-Poutline\fR (resp. \fBdvips\fR \fI-Ppk\fR).
54 .br
55 Valid settings for dvipsPreferOutline are \fItrue\fR / \fIfalse\fR.
56 .P
57 \fBLW35\fR
58 .br
59 Which fonts of the "Basic 35 Laserwriter Fonts" do you want to use and
60 how are the filenames chosen? Valid settings:
61 .br
62 URW: URW fonts with "vendor" filenames (e.g.\& n019064l.pfb)
63 .br
64 URWkb: URW fonts with "berry" filenames (e.g.\& uhvbo8ac.pfb)
65 .br
66 ADOBE: Adobe fonts with "vendor" filenames (e.g.\& hvnbo___.pfb)
67 .br
68 ADOBEkb: Adobe fonts with "berry" filenames (e.g.\& phvbo8an.pfb)
69 .P
70 \fBdvipsDownloadBase35\fR
71 .br
72 Configures if \fBdvips\fR (by default) should download the 35 base
73 PostScript fonts into the document (set \fItrue\fR) or should these
74 fonts be used from the PostScript interpreter or printer (set \fIfalse\fR).
75 .br
76 The user can override the default by specifying \fBdvips\fR \fI-Pdownload35\fR
77 (resp. \fBdvips\fR \fI-Pbuiltin35\fR) to download the LW35 fonts
78 (resp. use the built-in fonts).
79 .br
80 Valid settings are \fItrue\fR / \fIfalse\fR.
81 .P
82 \fBpdftexDownloadBase14\fR
83 .br
84 Should \fBpdftex\fR download the 14 base PDF fonts? Since some configurations
85 (ps / pdf tools / printers) use bad default fonts, it is safer to download
86 the fonts. The pdf files get bigger, but that is the cost.
87 .br
88 Valid settings are \fItrue\fR (download the fonts) or \fIfalse\fR (don't
89 download the fonts). Adobe recommends embedding all fonts.
90 .P
91 \fBpxdviUse\fR
92 .br
93 Should special map files for pxdvi be created? pxdvi is an adaption of xdvi
94 with support for reading and displaying files generated by the ptex family
95 of engines.
96 .br
97 Valid settings are \fItrue\fR (generate configuration) or \fIfalse\fR. See
98 http://www.tug.org/texlive/updmap-kanji.html for detailed discussion.
99 .P
100 \fBkanjiEmbed\fR
101 .br
102 \fBkanjiVariant\fR
103 .br
104 The options \fBkanjiEmbed\fR and \fBkanjiVariant\fR specify special
105 replacements in the map lines. In a map, the string "@kanjiEmbed@"
106 will be replaced by the value of that option; similarly for
107 \fBkanjiVariant\fR. In this way, users of Japanese TeX can select
108 different fonts to be included in the final output.
109 .P
110 \fBMap\fR
111 .br
112 Points to a map file, which describes a mapping from a font (called in the TeX
113 document) to the pfb file containing the Postscript code.
114 .br
115 Usage: \fBMap\fR filename.map
116 .P
117 The syntax of map files is the same as \fBdvips\fP(1) uses, see the
118 section "psfonts.map" in the manual of \fBdvips\fP(1).
119 .P
120 \fBMixedMap\fR
121 .br
122 Similar to \fBMap\fR. It should be used when there is Type1 and a bitmap
123 implementation of the font (the latter mostly coming from Metafont). These
124 entries will not be used in the default map of \fBdvips\fR if
125 \fBdvipsPreferOutline\fR is set to \fIfalse\fR.
126 .br
127 Usage: \fBMixedMap\fR filename.map
128 .P
129 \fBKanjiMap\fR
130 .br
131 Similar to \fBMap\fR. This should be used for kanji fonts.
132 .br
133 Usage: \fBKanjiMap\fR filename.map
134 .P
135 The sign \fB#\fR precedes a comment.
136 .P
137 Map files not to be used should be commented out using the string
138 \fB#!\fR at the beginning of the line. Such entries can be
139 (de-)activated using \fBupdmap\fR with the options \fI--enable\fR and
140 \fI--disable\fR, respectively.
141
142 .SH "SEE ALSO"
143 updmap(1), dvips(1).
144
145 .SH "THANKS TO"
146 Frank Kuester,
147 Thomas Esser.
148
149 .SH "AUTHOR"
150 This manual page was written by Hilmar Preusse <[email protected]> and
151 extended by Norbert Preining <[email protected]>, for
152 the Debian GNU/Linux system by simply copying the comments from
153 \fBupdmap.cfg\fR and rewriting some of them. It may be used by other
154 distributions without contacting the author.
155
156 .SH "BUGS"
157 .PP
158 Email bug reports to <https://lists.tug.org/tex-k> (public mailing list).