groff before CVS: release 1.06
[s-roff.git] / addftinfo / addftinfo.man
blob4c92477c7b8b1a693ab0d59df5bae873f917682a
1 .\" -*- nroff -*-
2 .TH ADDFTINFO @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
3 .SH NAME
4 addftinfo \- add information to troff font files for use with groff
5 .SH SYNOPSIS
6 .B addftinfo
8 .BI \- param\ value\fR.\|.\|.
10 .I res
11 .I unitwidth
12 .I font
13 .SH DESCRIPTION
14 .B addftinfo
15 reads a troff font file
16 and adds some additional font-metric information
17 that is used by the groff system.
18 The font file with the information added is written on the
19 standard output.
20 The information added is guessed using 
21 some parametric information about the font
22 and assumptions
23 about the traditional troff names for characters.
24 The main information added is the heights and depths of characters.
25 The
26 .I res
27 and
28 .I unitwidth
29 arguments should be the same as the corresponding parameters
30 in the DESC file;
31 .I font
32 is the name of the file describing the font;
34 .I font
35 ends with
36 .B I
37 the font will be assumed to be italic.
38 .SH OPTIONS
39 Each of the options changes one of the parameters that is used
40 to derive the heights and depths.
41 Like the existing quantities in the font
42 file, each
43 .I value
44 is in
45 .RI inches/ res
46 for a font whose point size is
47 .IR unitwidth .
48 .I param
49 must be one of:
50 .TP
51 .B x-height
52 The height of lowercase letters without ascenders such as x.
53 .TP
54 .B fig-height
55 The height of figures (digits).
56 .TP
57 .B asc-height
58 The height of characters with ascenders, such as b, d or l.
59 .TP
60 .B body-height
61 The height of characters such as parentheses.
62 .TP
63 .B cap-height
64 The height of uppercase letters such as A.
65 .TP
66 .B comma-depth
67 The depth of a comma.
68 .TP
69 .B desc-depth
70 The depth of characters with descenders, such as p,q, or y.
71 .TP
72 .B body-depth
73 The depth of characters such as parentheses.
74 .LP
75 .B addftinfo
76 makes no attempt to use the specified parameters to guess
77 the unspecified parameters.
78 If a parameter is not specified the default will be used.
79 The defaults are chosen to have the reasonable values for
80 a Times font.
81 .SH "SEE ALSO"
82 .BR font (5)
83 .BR groff_font (@MAN5EXT@),
84 .BR groff (@MAN1EXT@),
85 .BR groff_char (@MAN7EXT@)