Initial import from FreeBSD RELENG_4:
[dragonfly.git] / contrib / groff / src / utils / hpftodit / hpftodit.man
1 .ig
2 Copyright (C) 1994-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 .\" Like TP, but if specified indent is more than half
20 .\" the current line-length - indent, use the default indent.
21 .de Tp
22 .ie \\n(.$=0:((0\\$1)*2u>(\\n(.lu-\\n(.iu)) .TP
23 .el .TP "\\$1"
24 ..
25 .TH HPFTODIT @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
26 .SH NAME
27 hpftodit \- create font description files for use with groff \-Tlj4
28 .SH SYNOPSIS
29 .B hpftodit
30 [
31 .B \-sv
32 ]
33 [
34 .BI \-i n
35 ]
36 .I tfm_file
37 .I map_file
38 .I font
39 .PP
40 It is possible to have whitespace between the
41 .B \-i
42 command line option and its parameter.
43 .SH DESCRIPTION
44 .B hpftodit
45 creates a font file for use with
46 .B
47 groff \-Tlj4\fR
48 from an HP tagged font metric file.
49 .I tfm_file
50 is the name of the tagged font metric file for the font.
51 .I map_file
52 is a file giving the groff names for characters in the font;
53 this file should consist of a sequence of lines of the form:
54 .IP
55 .I
56 n c1 c2 \fR.\|.\|.
57 .LP
58 where
59 .I n
60 is a decimal integer giving the MSL number of the character,
61 and
62 .IR c1 ,
63 .IR c2 ,.\|.\|.
64 are the groff names of the character.
65 .I font
66 is the name of the groff font file.
67 The groff font file is written to
68 .IR font .
69 .LP
70 The
71 .B \-s
72 option should be given if the font is special
73 (a font is
74 .I special
75 if
76 .B troff
77 should search it whenever
78 a character is not found in the current font.)
79 If the font is special,
80 it should be listed in the
81 .B fonts
82 command in the DESC file;
83 if it is not special, there is no need to list it, since
84 .B troff
85 can automatically mount it when it's first used.
86 .LP
87 If the
88 .B \-i
89 option is used,
90 .B hpftodit
91 will automatically generate an italic correction,
92 a left italic correction and a subscript correction
93 for each character
94 (the significance of these parameters is explained in
95 .BR groff_font (@MAN5EXT@)).
96 .SH OPTIONS
97 .TP
98 .B \-v
99 Print the version number.
100 .TP
101 .B \-s
102 The font is special.
103 The effect of this option is to add the
104 .B special
105 command to the font file.
106 .TP
107 .BI \-i n
108 Generate an italic correction for each character so that 
109 the character's width plus the character's italic correction
110 is equal to
111 .I n
112 design units
113 plus the amount by which the right edge of the character's bounding
114 is to the right of the character's origin.
115 If this would result in a negative italic correction, use a zero
116 italic correction instead.
117 There are 8782 design units per em for Intellifont fonts.
118 .IP
119 Also generate a subscript correction equal to the 
120 product of the tangent of the slant of the font and
121 four fifths of the x-height of the font.
122 If this would result in a subscript correction greater than the italic
123 correction, use a subscript correction equal to the italic correction
124 instead.
125 .IP
126 Also generate a left italic correction for each character
127 equal to
128 .I n
129 design units
130 plus the amount by which the left edge of the character's bounding box
131 is to the left of the character's origin.
132 The left italic correction may be negative.
133 .IP
134 This option is normally needed only with italic (or oblique) fonts.
135 .SH FILES
136 .Tp \w'\fB@FONTDIR@/devlj4/DESC'u+2n
137 .B @FONTDIR@/devlj4/DESC
138 Device description file.
139 .TP
140 .BI @FONTDIR@/devlj4/ F
141 Font description file for font
142 .IR F .
143 .SH BUGS
144 .LP
145 This program was written without the benefit of complete, official
146 documentation on the tagged font metric format.
147 It is therefore likely that it will fail to work on tfm files that are
148 dissimilar to those for the internal fonts on the Laserjet 4,
149 with which it was tested:
150 .LP
151 TrueType tfm files are not supported.
152 .SH "SEE ALSO"
153 .BR groff (@MAN1EXT@),
154 .BR grolj4 (@MAN1EXT@),
155 .BR groff_font (@MAN5EXT@)
156 .
157 .\" Local Variables:
158 .\" mode: nroff
159 .\" End: