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