upload webpage to other dir.
[mftrace.git] / mftrace.1
blob86e0639fa32cb9ce9ef0edc7cece7e5408895e98
1 .TH MFTRACE 1 "January 23, 2007"
2 .\" Copyright (c) 1999--2007 by the authors
3 .\"
4 .\" Permission is granted to copy, distribute and/or modify this document
5 .\" under the terms of the GNU General Public License.
6 .\"
7 .\" You should have received a copy of the GNU General Public License
8 .\" along with this program; if not, write to the Free Software
9 .\" Foundation, Inc.,
10 .\" 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA
11 .\"
13 .hw mftrace autotrace potrace fontforge pfaedit ghostscript kpsewhich
16 .SH NAME
17 mftrace \- convert METAFONT format fonts into Type1 outline fonts
20 .SH SYNOPSIS
21 .B mftrace
22 .RI [ options ] " fontname"
25 .SH DESCRIPTION
26 .B mftrace
27 is a program that can convert a METAFONT font into a Type1 font.
28 It is simply called with the name of the font (without a `.mf' suffix)
29 and produces a Type1 font file called either
30 .IR \%fontname .pfa
32 .IR \%fontname .pfb
33 depending on the command line options.
34 With the help of
35 .BR fontforge (1)
36 it can produce other font formats too.
39 For tracing the bitmap,
40 .B mftrace
41 either uses
42 .BR potrace (1)
44 .BR autotrace (1)
45 (the former preferred) if available; this can be overridden with the
46 .B \%\-\-autotrace
47 and
48 .B \%\-\-potrace
49 command line options.
52 .SH OPTIONS
53 This program follows the usual GNU command line syntax, with long
54 options starting with two dashes (`-').
56 .TP
57 .BR \-k ", " \-\-keep
58 Keep all output in directory `mftrace.dir'.
60 .TP
61 .BI \-\-magnification= MAG
62 The magnification to use for the PFA file.
63 The default is 1000.
64 The larger the magnification, the more precise the PFA file will be.
65 However, if the magnification is too large METAFONT can crash
66 with overflow errors.
68 .IP
69 Sadly, many MF fonts contain resolution checks
71 .RS
72 .IP
73 if dots_per_inch * design_size > 1500:
74 .RE
76 .IP
77 This check is susceptible to overflow errors.
78 Such code should be reported as a bug, and changed to
80 .RS
81 .IP
82 if dots_per_inch > (1500 / design_size):
83 .RE
85 .TP
86 .BI \-\-formats= FMT1 , FMT2 , .\|.\|.
87 Specify which formats to generate (default is pfa).
88 Choices are: `afm', `pfa', `pfb', `ttf', `svg'.
89 Note that
90 .B fontforge
91 (formerly called
92 .BR pfaedit )
93 must be installed to generate any format except `pfa' or `pfb'.
94 For generating `afm' you need either
95 .B fontforge
97 .BR ghostscript .
99 .TP
100 .B \-\-simplify
101 This passes the created Type1 font to
102 .B fontforge
103 (formerly called
104 .BR pfaedit )
105 to simplify and autohint it.
108 .BI \-\-gffile= FILE
109 Use generic font file
110 .I FILE
111 instead of running Metafont.
112 (GF is the default output format of Metafont.)
115 .BR \-I " " \fIDIR\fP ", " \-\-include= \fIDIR\fP
117 .I DIR
118 to the current path for searching files.
121 .BI \-\-glyphs= LIST
122 Process only these glyphs.
123 .I LIST
124 is a comma separated list of decimal numbers or ranges, for example
125 `1-10,50,55,90-100'.
128 .BI \-\-tfmfile= FILE
130 .I FILE
131 for the TFM file.
132 (The default is to use
133 .IR \%fontname .tfm).
136 .BR \-e " " \fIENC\fP ", " \-\-encoding=\fIENC\fP
137 Use encoding file
138 .IR ENC .
139 Encoding files used by
140 .B mftrace
141 are basically in the GhostScript/dvips format, but you may use a
142 special
143 .B \%\.notavail
144 glyph name in order to tell mftrace not to process a specific glyph.
145 If this option is not specified,
146 .B mftrace
147 tries to determine the encoding file automatically, from the
148 encoding specified in the TFM file, the default being `tex256.enc'.
151 .B \-\-keep-trying
152 Try to continue if external programs called by mftrace fail.
153 If METAFONT crashes with overflow errors, but nevertheless outputs
154 a GF file, try to process its output as is (useful for some buggy
155 fonts, see above).
157 .B potrace
159 .B autotrace
160 fail to trace a specific character, first try it with a less
161 smoothed curve, and if that fails, skip the character.
162 By default,
163 .B mftrace
164 leaves a file \%`trace-bug-\fIfont\fP-\fIchar\fP.pbm' and stops the
165 process with a request to file a bugreport.
168 .B \-\-dos-kpath
169 Try to use MikTeX's version of
170 .BR kpsewhich .
173 .B \-\-potrace
175 .B potrace
176 for tracing bitmaps.
177 The default is to use
178 .B potrace
179 if it is found, otherwise to use
180 .BR autotrace .
183 .B \-\-autotrace
185 .B autotrace
186 for tracing bitmaps.
189 .B \-\-no-afm
190 Don't read the AFM file to find font information.
193 .B \-\-noround
194 Do not round coordinates of control points to integer values (use with
195 .BR \-\-grid ).
196 Disabled by default.
199 .BI \-\-grid= GRID
200 Set reciprocal grid size in em units multiplied by ratio
201 magnification/1000.
202 For example,
203 .RB ` "\-\-grid\ 10 \%\-\-magnification\ 1000" '
204 rounds coordinates of control points to 1/10th of the em unit.
205 Useful simultaneously with the
206 .B \%\-\-noround
207 option.
208 Default
209 .I GRID
210 value is\~1, i.e., round to integer.
211 This option is only used with
212 .BR potrace .
215 .BI \-D,\-\-define= SYMBOL=VALUE
216 Set the font info
217 .I SYMBOL
218 to the given
219 .IR VALUE .
220 For example,
221 .B \%\-DFamilyName=Foo
222 sets the font family name to
223 .IR Foo .
224 .B mftrace
225 tries to fill in sensible default values for the
226 \%`FontName', \%`FamilyName', \%`FullName' and `Weight' fields.
229 .B \-V, \-\-verbose
230 Be verbose.
233 .B \-h, \-\-help
234 Show summary of options.
237 .B \-v, \-\-version
238 Show version of program.
241 .B \-w, \-\-warranty
242 Show warranty and copyright.
245 .SH COPYRIGHT
246 You may redistribute copies of mftrace under the terms of
247 the GNU General Public License <http://www.gnu.org/licenses/gpl.html>.
248 There is NO WARRANTY, to the extent permitted by law.
250 This manual page is copyright \(co 2005,2006,2007 Julian Gilbey and is
251 distributed under the GNU General Public License too.
254 .SH "SEE ALSO"
255 .BR mf (1),
256 .BR autotrace (1),
257 .BR potrace (1),
258 .BR fontforge (1).
261 .SH AUTHOR
262 .B mftrace
263 was written by Han-Wen Nienhuys <hanwen@xs4all.nl>.
264 This manual page was originally written by Julian Gilbey <jdg@debian.org>
265 and has been revised by Werner Lemberg <wl@gnu.org>.
267 .\" EOF