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