tmac/mdoc-syms: add a couple of entries (Anthony J. Bentley)..
[s-roff.git] / man / ute-addftinfo.1.in
bloba596a376492853ab81b93e73622f877518460490
1 .ig
2 @ @L_ADDFTINFO@.1
4 Copyright (c) 2014 - 2017 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
6 Copyright (C) 1989 - 2001 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 .TH @U_ADDFTINFO@ @MAN1EXT@ "@MDATE@" "@T_ROFF@ v@VERSION@"
24 .SH NAME
25 @L_ADDFTINFO@ \- add information to troff font files for use with @T_ROFF@
26 .SH SYNOPSIS
27 .B @L_ADDFTINFO@
29 .B \-v
32 .BI \- param\ value\fR.\|.\|.
34 .I res
35 .I unitwidth
36 .I font
37 .SH DESCRIPTION
38 .B @L_ADDFTINFO@
39 reads a troff font file
40 and adds some additional font-metric information
41 that is used by the groff system.
42 The font file with the information added is written on the
43 standard output.
44 The information added is guessed using
45 some parametric information about the font
46 and assumptions
47 about the traditional troff names for characters.
48 The main information added is the heights and depths of characters.
49 The
50 .I res
51 and
52 .I unitwidth
53 arguments should be the same as the corresponding parameters
54 in the DESC file;
55 .I font
56 is the name of the file describing the font;
58 .I font
59 ends with
60 .B I
61 the font will be assumed to be italic.
62 .SH OPTIONS
63 .B \-v
64 prints the version number.
65 .LP
66 All other options changes one of the parameters that is used
67 to derive the heights and depths.
68 Like the existing quantities in the font
69 file, each
70 .I value
71 is in
72 .RI inches/ res
73 for a font whose point size is
74 .IR unitwidth .
75 .I param
76 must be one of:
77 .TP
78 .B x-height
79 The height of lowercase letters without ascenders such as x.
80 .TP
81 .B fig-height
82 The height of figures (digits).
83 .TP
84 .B asc-height
85 The height of characters with ascenders, such as b, d or l.
86 .TP
87 .B body-height
88 The height of characters such as parentheses.
89 .TP
90 .B cap-height
91 The height of uppercase letters such as A.
92 .TP
93 .B comma-depth
94 The depth of a comma.
95 .TP
96 .B desc-depth
97 The depth of characters with descenders, such as p,q, or y.
98 .TP
99 .B body-depth
100 The depth of characters such as parentheses.
102 .B @L_ADDFTINFO@
103 makes no attempt to use the specified parameters to guess
104 the unspecified parameters.
105 If a parameter is not specified the default will be used.
106 The defaults are chosen to have the reasonable values for
107 a Times font.
109 .SH "SEE ALSO"
110 .BR @L_ROFF@ (@MAN1EXT@),
111 .BR @L_ROFF@-font (@MAN5EXT@),
112 .BR @L_ROFF@-char (@MAN7EXT@)
114 .\" s-ts-mode