Debian Codegraph @

upstream/debian-trixie/man1/addftinfo.1

raw
1 .TH addftinfo 1 "3 June 2025" "groff 1.23.0"
2 .SH Name
3 addftinfo \- add font metrics to
4 .I troff
5 fonts for use with
6 .I groff
7 .
8 .
9 .\" ====================================================================
10 .\" Legal Terms
11 .\" ====================================================================
12 .\"
13 .\" Copyright (C) 1989-2020 Free Software Foundation, Inc.
14 .\"
15 .\" Permission is granted to make and distribute verbatim copies of this
16 .\" manual provided the copyright notice and this permission notice are
17 .\" preserved on all copies.
18 .\"
19 .\" Permission is granted to copy and distribute modified versions of
20 .\" this manual under the conditions for verbatim copying, provided that
21 .\" the entire resulting derived work is distributed under the terms of
22 .\" a permission notice identical to this one.
23 .\"
24 .\" Permission is granted to copy and distribute translations of this
25 .\" manual into another language, under the above conditions for
26 .\" modified versions, except that this permission notice may be
27 .\" included in translations approved by the Free Software Foundation
28 .\" instead of in the original English.
29 .
30 .
31 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
32 .do nr *groff_addftinfo_1_man_C \n[.cp]
33 .cp 0
34 .
35 .\" Define fallback for groff 1.23's MR macro if the system lacks it.
36 .nr do-fallback 0
37 .if !\n(.f .nr do-fallback 1 \" mandoc
38 .if \n(.g .if !d MR .nr do-fallback 1 \" older groff
39 .if !\n(.g .nr do-fallback 1 \" non-groff *roff
40 .if \n[do-fallback] \{\
41 . de MR
42 . ie \\n(.$=1 \
43 . I \%\\$1
44 . el \
45 . IR \%\\$1 (\\$2)\\$3
46 . .
47 .\}
48 .rr do-fallback
49 .
50 .
51 .\" ====================================================================
52 .SH Synopsis
53 .\" ====================================================================
54 .
55 .SY addftinfo
56 .RB [ \-asc\-height\~\c
57 .IR n ]
58 .RB [ \-body\-depth\~\c
59 .IR n ]
60 .RB [ \-body\-height\~\c
61 .IR n ]
62 .RB [ \-cap\-height\~\c
63 .IR n ]
64 .RB [ \-comma\-depth\~\c
65 .IR n ]
66 .RB [ \-desc\-depth\~\c
67 .IR n ]
68 .RB [ \-fig\-height\~\c
69 .IR n ]
70 .RB [ \-x\-height\~\c
71 .IR n ]
72 .I resolution
73 .I unit-width
74 .I font
75 .YS
76 .
77 .
78 .SY addftinfo
79 .B \-\-help
80 .YS
81 .
82 .
83 .SY addftinfo
84 .B \-v
85 .
86 .SY addftinfo
87 .B \-\-version
88 .YS
89 .
90 .
91 .\" ====================================================================
92 .SH Description
93 .\" ====================================================================
94 .
95 .I addftinfo
96 reads an
97 .RI AT&T \~troff
98 font description file
99 .IR font ,
100 adds additional font metric information required by
101 .\" We need the "GNU" below because the \% prefix might be empty.
102 .RI GNU \~\%troff (1),
103 and writes the combined result to the standard output.
104 .
105 The information added is derived from the font's existing parameters and
106 assumptions about traditional
107 .I troff
108 names for characters.
109 .
110 Among the font metrics added are the heights and depths of characters
111 (how far each extends vertically above and below the baseline).
112 .
113 The
114 .I resolution
115 and
116 .I unit-width
117 arguments should be the same as the corresponding parameters in the
118 .I DESC
119 file.
120 .
121 .I font
122 is the name of the file describing the font;
123 if
124 .I font
125 ends with
126 .RB \[lq] I \[rq],
127 the font is assumed to be oblique
128 (or italic).
129 .
130 .
131 .\" ====================================================================
132 .SH Options
133 .\" ====================================================================
134 .
135 .B \-\-help
136 displays a usage message,
137 while
138 .B \-v
139 and
140 .B \-\-version
141 show version information;
142 all exit afterward.
143 .
144 .
145 .P
146 All other options change parameters that are used to derive the heights
147 and depths.
148 .
149 Like the existing quantities in the font description file,
150 each
151 .RI value\~ n
152 is in
153 .I "scaled points,"
154 .RI inches/ resolution
155 for a font whose type size is
156 .IR unit-width ;
157 see
158 .MR groff_font 5 .
159 .
160 .
161 .TP
162 .BI \-asc\-height \~n
163 height of characters with ascenders,
164 such as \[lq]b\[rq],
165 \[lq]d\[rq],
166 or \[lq]l\[rq]
167 .
168 .
169 .TP
170 .BI \-body\-depth \~n
171 depth of characters such as parentheses
172 .
173 .
174 .TP
175 .BI \-body\-height \~n
176 height of characters such as parentheses
177 .
178 .
179 .TP
180 .BI \-cap\-height \~n
181 height of uppercase letters such as \[lq]A\[rq]
182 .
183 .
184 .TP
185 .BI \-comma\-depth \~n
186 depth of a comma
187 .
188 .
189 .TP
190 .BI \-desc\-depth \~n
191 depth of characters with descenders,
192 such as \[lq]p\[rq],
193 \[lq]q\[rq],
194 or \[lq]y\[rq]
195 .
196 .
197 .TP
198 .B \-fig\-height
199 height of figures (numerals)
200 .
201 .
202 .TP
203 .BI \-x\-height \~n
204 height of lowercase letters without ascenders such as \[lq]x\[rq]
205 .
206 .
207 .P
208 .I addftinfo
209 makes no attempt to use the specified parameters to infer unspecified
210 parameters.
211 .
212 If a parameter is not specified,
213 the default will be used.
214 .
215 The defaults are chosen to produce reasonable values for a Times font.
216 .
217 .
218 .\" ====================================================================
219 .SH "See also"
220 .\" ====================================================================
221 .
222 .MR groff_font 5 ,
223 .MR groff 1 ,
224 .MR groff_char 7
225 .
226 .
227 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
228 .cp \n[*groff_addftinfo_1_man_C]
229 .do rr *groff_addftinfo_1_man_C
230 .
231 .
232 .\" Local Variables:
233 .\" fill-column: 72
234 .\" mode: nroff
235 .\" End:
236 .\" vim: set filetype=groff textwidth=72: