Merge branch 'topic/sync-to-go-2'
[s-roff.git] / man / ute-tfmtodit.1.in
blobd64bfb5506ef0ac1fa38df31127c9c7b4d861a60
1 .ig
2 @ @L_TFMTODIT@.1
4 Copyright (c) 2014 - 2017 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
6 Copyright (C) 1989 - 2002 Free Software Foundation, Inc.
8 Permission is granted to make and distribute verbatim copies of
9 this manual provided the copyright notice and this permission notice
10 are preserved on all copies.
12 Permission is granted to copy and distribute modified versions of this
13 manual under the conditions for verbatim copying, provided that the
14 entire resulting derived work is distributed under the terms of a
15 permission notice identical to this one.
17 Permission is granted to copy and distribute translations of this
18 manual into another language, under the above conditions for modified
19 versions, except that this permission notice may be included in
20 translations approved by the Free Software Foundation instead of in
21 the original English.
23 .ie t .ds tx T\h'-.1667m'\v'.224m'E\v'-.224m'\h'-.125m'X
24 .el .ds tx TeX
25 .\" Like TP, but if specified indent is more than half
26 .\" the current line-length - indent, use the default indent.
27 .de Tp
28 .ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
29 .el .TP "\\$1"
31 .TH @U_TFMTODIT@ @MAN1EXT@ "@MDATE@" "@T_ROFF@ v@VERSION@"
33 .SH NAME
34 @L_TFMTODIT@ \- create font files for use with @L_ROFF@ \-Tdvi
35 .SH SYNOPSIS
36 .nr a \n(.j
37 .ad l
38 .nr i \n(.i
39 .in +\w'\fB@L_TFMTODIT@ 'u
40 .ti \niu
41 .B @L_TFMTODIT@
42 .de OP
43 .ie \\n(.$-1 .RI "[\ \fB\\$1\fP" "\\$2" "\ ]"
44 .el .RB "[\ " "\\$1" "\ ]"
46 .OP \-sv
47 .OP \-g gf_file
48 .OP \-k skewchar
49 .I tfm_file
50 .I map_file
51 .I font
52 .br
53 .ad \na
54 .PP
55 It is possible to have whitespace between a command line option and its
56 parameter.
57 .SH DESCRIPTION
58 .B @L_TFMTODIT@
59 creates a font file for use with
61 @L_ROFF@ \-Tdvi\fR.
62 .I tfm_file
63 is the name of the \*(tx font metric file for the font.
64 .I map_file
65 is a file giving the roff names for characters in the font;
66 this file should consist of a sequence of lines of the form:
67 .IP
69 n c1 c2 \fR.\|.\|.
70 .LP
71 where
72 .I n
73 is a decimal integer giving the position of the character in the font,
74 and
75 .IR c1 ,
76 .IR c2 ,.\|.\|.
77 are the roff names of the character.
78 If a character has no roff names but exists in the tfm file,
79 then it will be put in the roff font file as an unnamed character.
80 .I font
81 is the name of the roff font file.
82 The roff font file is written to
83 .IR font .
84 .LP
85 The
86 .B \-s
87 option should be given if the font is special
88 (a font is
89 .I special
91 .B troff
92 should search it whenever
93 a character is not found in the current font.)
94 If the font is special,
95 it should be listed in the
96 .B fonts
97 command in the DESC file;
98 if it is not special, there is no need to list it, since
99 .B @L_TROFF@
100 can automatically mount it when it's first used.
102 To do a good job of math typesetting, @L_ROFF@ requires
103 font metric information not present in the tfm file.
104 The reason for this is that \*(tx has separate math italic fonts
105 whereas @L_ROFF@ uses normal italic fonts for math.
106 The additional information required by @L_ROFF@ is given by the
107 two arguments to the
108 .B math_fit
109 macro in the Metafont programs for the Computer Modern fonts.
110 In a text font (a font for which
111 .B math_fitting
112 is false), Metafont normally ignores these two arguments.
113 Metafont can be made to put this information in the gf file
114 by loading the following definition after
115 .B cmbase
116 when creating
117 .BR cm.base :
120 .ft B
121 def ignore_math_fit(expr left_adjustment,right_adjustment) =
122     special "adjustment";
123     numspecial left_adjustment*16/designsize;
124     numspecial right_adjustment*16/designsize;
125     enddef;
127 .ft R
129 For the EC font family, load the following definition after
130 .B exbase
131 (it is probably easiest to patch
132 .B exbase.mf
133 locally):
136 .ft B
137 def ignore_math_fit(expr left_adjustment,right_adjustment) =
138     ori_special "adjustment";
139     ori_numspecial left_adjustment*16/designsize;
140     ori_numspecial right_adjustment*16/designsize;
141     enddef;
143 .ft R
145 The gf file created using this modified
146 .B cm.base
148 .B exbase
149 should be specified with the
150 .B \-g
151 option.
153 .B \-g
154 option should not be given for a font for which
155 .B math_fitting
156 is true.
157 .SH OPTIONS
159 .B \-v
160 Print the version number.
162 .B \-s
163 The font is special.
164 The effect of this option is to add the
165 .B special
166 command to the font file.
168 .BI \-k n
169 The skewchar of this font is at position
170 .IR n .
171 .I n
172 should be an integer;
173 it may be given in decimal,
174 or with a leading
175 .B 0
176 in octal,
177 or with a leading
178 .B 0x
179 in hexadecimal.
180 The effect of this option is to ignore any kerns whose second component
181 is the specified character.
183 .BI \-g gf_file
184 .I gf_file
185 is a gf file produced by Metafont containing special and numspecial
186 commands giving additional font metric information.
187 .SH FILES
188 .Tp \w'\fB@FONTDIR@/dev-dvi/DESC'u+2n
189 .B @FONTDIR@/dev-dvi/DESC
190 Device description file.
192 .BI @FONTDIR@/dev-dvi/ F
193 Font description file for font
194 .IR F .
196 .SH "SEE ALSO"
197 .BR @L_ROFF@ (@MAN1EXT@),
198 .BR @L_D_DVI@ (@MAN1EXT@),
199 .BR @L_ROFF@-font (@MAN5EXT@)
201 .\" s-ts-mode