Debian Codegraph @

upstream/debian-unstable/man1/addftinfo.1

raw
1 .TH addftinfo 1 "2026-04-22" "groff 1.24.1"
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-2025 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 .P
79 .SY addftinfo
80 .B \-\-help
81 .YS
82 .
83 .
84 .P
85 .SY addftinfo
86 .B \-v
87 .YS
88 .
89 .SY addftinfo
90 .B \%\-\-version
91 .YS
92 .
93 .
94 .\" ====================================================================
95 .SH Description
96 .\" ====================================================================
97 .
98 .I addftinfo
99 reads an
100 .RI AT&T \~troff
101 font description file
102 .IR font ,
103 adds further font metric information required by
104 .\" We need the "GNU" below because the \% prefix might be empty.
105 GNU
106 .MR \%troff 1 ,
107 and writes the combined result to the standard output stream.
108 .
109 The information added is derived from the font's existing parameters and
110 assumptions about traditional
111 .I troff
112 names for characters.
113 .
114 Among the font metrics added are the heights and depths of characters
115 (how far each extends vertically above and below the baseline).
116 .
117 The
118 .I resolution
119 and
120 .I unit-width
121 arguments should be the same as the corresponding parameters in the
122 .I DESC
123 file.
124 .
125 .I font
126 is the name of the file describing the font;
127 if
128 .I font
129 ends with
130 .RB \[lq] I \[rq],
131 the font is assumed to be oblique
132 (or italic).
133 .
134 .
135 .\" ====================================================================
136 .SH Options
137 .\" ====================================================================
138 .
139 .B \-\-help
140 displays a usage message,
141 while
142 .B \-v
143 and
144 .B \%\-\-version
145 show version information;
146 all exit afterward.
147 .
148 .
149 .P
150 All other options change parameters that are used to derive the heights
151 and depths.
152 .
153 Like the existing quantities in the font description file,
154 each
155 .RI value\~ n
156 is in
157 .I "scaled points,"
158 .RI inches/ resolution
159 for a font whose type size is
160 .IR unit-width ;
161 see
162 .MR groff_font 5 .
163 .
164 .
165 .TP
166 .BI \-asc\-height \~n
167 height of characters with ascenders,
168 such as \[lq]b\[rq],
169 \[lq]d\[rq],
170 or \[lq]l\[rq]
171 .
172 .
173 .TP
174 .BI \-body\-depth \~n
175 depth of characters such as parentheses
176 .
177 .
178 .TP
179 .BI \-body\-height \~n
180 height of characters such as parentheses
181 .
182 .
183 .TP
184 .BI \-cap\-height \~n
185 height of uppercase letters such as \[lq]A\[rq]
186 .
187 .
188 .TP
189 .BI \-comma\-depth \~n
190 depth of a comma
191 .
192 .
193 .TP
194 .BI \-desc\-depth \~n
195 depth of characters with descenders,
196 such as \[lq]p\[rq],
197 \[lq]q\[rq],
198 or \[lq]y\[rq]
199 .
200 .
201 .TP
202 .B \-fig\-height
203 height of figures (numerals)
204 .
205 .
206 .TP
207 .BI \-x\-height \~n
208 height of lowercase letters without ascenders such as \[lq]x\[rq]
209 .
210 .
211 .P
212 .I addftinfo
213 makes no attempt to use the specified parameters to infer unspecified
214 parameters.
215 .
216 If a parameter is not specified,
217 the default will be used.
218 .
219 The defaults are chosen to produce reasonable values for a Times font.
220 .
221 .
222 .\" ====================================================================
223 .SH "Exit status"
224 .\" ====================================================================
225 .
226 .I \%addftinfo
227 exits with
228 .RB status\~ 0
229 on successful operation,
230 and
231 .RB status\~ 2
232 if the program cannot interpret its command-line arguments.
233 .
234 .
235 .\" ====================================================================
236 .SH "See also"
237 .\" ====================================================================
238 .
239 .MR groff_font 5 ,
240 .MR groff 1 ,
241 .MR groff_char 7
242 .
243 .
244 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
245 .cp \n[*groff_addftinfo_1_man_C]
246 .do rr *groff_addftinfo_1_man_C
247 .
248 .
249 .\" Local Variables:
250 .\" fill-column: 72
251 .\" mode: nroff
252 .\" End:
253 .\" vim: set filetype=groff textwidth=72: