tentative fix for issue 3 (ex 53)
[mplib] / src / texk / kpathsea / mktexpk.man
1 .TH MKTEXPK 1 "4 January 1998" "Kpathsea @VERSION@"
2 .\"=====================================================================
3 .if n .ds MP MetaPost
4 .if t .ds MP MetaPost
5 .if n .ds MF Metafont
6 .if t .ds MF M\s-2ETAFONT\s0
7 .if t .ds TX \fRT\\h'-0.1667m'\\v'0.20v'E\\v'-0.20v'\\h'-0.125m'X\fP
8 .if n .ds TX TeX
9 .ie t .ds OX \fIT\v'+0.25m'E\v'-0.25m'X\fP for troff
10 .el .ds OX TeX for nroff
11 .\" the same but obliqued
12 .\" BX definition must follow TX so BX can use TX
13 .if t .ds BX \fRB\s-2IB\s0\fP\*(TX
14 .if n .ds BX BibTeX
15 .\" LX definition must follow TX so LX can use TX
16 .if t .ds LX \fRL\\h'-0.36m'\\v'-0.15v'\s-2A\s0\\h'-0.15m'\\v'0.15v'\fP\*(TX
17 .if n .ds LX LaTeX
18 .\"=====================================================================
19 .SH NAME
20 mktexpk \- create a PK file for a font
21 .SH SYNOPSIS
22 .B mktexpk
23 .RI [ options ]
24 .I font
25 .RI [ redirect ]
26 .\"=====================================================================
27 .SH DESCRIPTION
28 This manual page is not meant to be exhaustive.  The complete
29 documentation for this version of \*(TX can be found in the info file
30 or manual
31 .IR "Kpathsea: A library for path searching" .
32 .PP
33 .B mktexpk
34 is used to generate a
35 .I pk
36 file from the \*(MF source files or type1 sources for
37 .IR font ,
38 if possible.
39 .PP
40 If
41 .I redirect
42 is given, it must be string of the form
43 .I >&n
44 where
45 .I n
46 is the number of the file descriptor which is to receive, instead of
47 standard output, the name of the generated file.
48 .PP
49 .B mktexpk
50 is typically called by other programs, rather than from the command
51 line.
52 .\"=====================================================================
53 .SH OPTIONS
54 .B mktexpk
55 accepts the following options:
56 .TP
57 .BI --bdpi \ num
58 Set the base device resolution.
59 .rb
60 .TP
61 .BI --dpi \ num
62 Generate the font at resolution
63 .IR num .
64 .rb
65 .TP
66 .B --help
67 .rb
68 Print help message and exit.
69 .TP
70 .BI --mag \ mag
71 The \*(MF magnification that corresponds to the combination of
72 .I bdpi
73 and
74 .I dpi
75 that has been specified.
76 .rb
77 .TP
78 .BI --mfmode \ mode
79 The \*(MF mode to use.
80 .rb
81 .TP
82 .BI --destdir \ dir
83 A directory name. If the directory is absolute, it is used as-is.
84 Otherwise, it is appended to the root destination directory set in the
85 script.
86 .rb
87 .TP
88 .B --version
89 .rb
90 Print version information and exit.
91 .\"=====================================================================
92 .SH BUGS
93 If the
94 .I mode
95 is not specified,
96 .B mktexpk
97 tries to determine it from
98 .IR bdpi .
99 The manner in which this is done is primitive.  Since
100 .I bpdi
101 doesn't provide sufficient information to uniquely determine a
102 .I mode
103 it is strongly recommended that it be specified explicitly.
104 .PP
105 If the
106 .I mode
107 and
108 .I bpdi
109 don't match, the
110 .I mode
111 is discarded.
112 .PP
113 The
114 .I dpi
115 parameter is redundant, but is not checked for consistency.  Worse,
116 the program will fail if the wrong
117 .I dpi
118 is specified.
119 .\"=====================================================================
120 .SH "SEE ALSO"
121 .BR mktexmf (1),
122 .BR mktextfm (1).