Initial import from FreeBSD RELENG_4:
[dragonfly.git] / contrib / groff / src / utils / addftinfo / addftinfo.man
1 .ig
2 Copyright (C) 1989-2000, 2001 Free Software Foundation, Inc.
3
4 Permission is granted to make and distribute verbatim copies of
5 this manual provided the copyright notice and this permission notice
6 are preserved on all copies.
7
8 Permission is granted to copy and distribute modified versions of this
9 manual under the conditions for verbatim copying, provided that the
10 entire resulting derived work is distributed under the terms of a
11 permission notice identical to this one.
12
13 Permission is granted to copy and distribute translations of this
14 manual into another language, under the above conditions for modified
15 versions, except that this permission notice may be included in
16 translations approved by the Free Software Foundation instead of in
17 the original English.
18 ..
19 .TH ADDFTINFO @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
20 .SH NAME
21 addftinfo \- add information to troff font files for use with groff
22 .SH SYNOPSIS
23 .B addftinfo
24 [
25 .B \-v
26 ]
27 [
28 .BI \- param\ value\fR.\|.\|.
29 ]
30 .I res
31 .I unitwidth
32 .I font
33 .SH DESCRIPTION
34 .B addftinfo
35 reads a troff font file
36 and adds some additional font-metric information
37 that is used by the groff system.
38 The font file with the information added is written on the
39 standard output.
40 The information added is guessed using 
41 some parametric information about the font
42 and assumptions
43 about the traditional troff names for characters.
44 The main information added is the heights and depths of characters.
45 The
46 .I res
47 and
48 .I unitwidth
49 arguments should be the same as the corresponding parameters
50 in the DESC file;
51 .I font
52 is the name of the file describing the font;
53 if
54 .I font
55 ends with
56 .B I
57 the font will be assumed to be italic.
58 .SH OPTIONS
59 .B \-v
60 prints the version number.
61 .LP
62 All other options changes one of the parameters that is used
63 to derive the heights and depths.
64 Like the existing quantities in the font
65 file, each
66 .I value
67 is in
68 .RI inches/ res
69 for a font whose point size is
70 .IR unitwidth .
71 .I param
72 must be one of:
73 .TP
74 .B x-height
75 The height of lowercase letters without ascenders such as x.
76 .TP
77 .B fig-height
78 The height of figures (digits).
79 .TP
80 .B asc-height
81 The height of characters with ascenders, such as b, d or l.
82 .TP
83 .B body-height
84 The height of characters such as parentheses.
85 .TP
86 .B cap-height
87 The height of uppercase letters such as A.
88 .TP
89 .B comma-depth
90 The depth of a comma.
91 .TP
92 .B desc-depth
93 The depth of characters with descenders, such as p,q, or y.
94 .TP
95 .B body-depth
96 The depth of characters such as parentheses.
97 .LP
98 .B addftinfo
99 makes no attempt to use the specified parameters to guess
100 the unspecified parameters.
101 If a parameter is not specified the default will be used.
102 The defaults are chosen to have the reasonable values for
103 a Times font.
104 .SH "SEE ALSO"
105 .BR groff_font (@MAN5EXT@),
106 .BR groff (@MAN1EXT@),
107 .BR groff_char (@MAN7EXT@)
108 .
109 .\" Local Variables:
110 .\" mode: nroff
111 .\" End: