Debian Codegraph @

upstream/debian-unstable/man1/hpftodit.1

raw
1 .TH hpftodit 1 "2026-04-22" "groff 1.24.1"
2 .SH Name
3 hpftodit \- create font description files for use with
4 .I groff
5 and
6 .I grolj4
7 .
8 .
9 .\" ====================================================================
10 .\" Legal Terms
11 .\" ====================================================================
12 .\"
13 .\" Copyright (C) 1994-2024 Free Software Foundation, Inc.
14 .\"
15 .\" Permission is granted to make and distribute verbatim copies of this
16 .\" manual provided the copyright notice and this permission notice are
17 .\" preserved on all copies.
18 .\"
19 .\" Permission is granted to copy and distribute modified versions of
20 .\" this manual under the conditions for verbatim copying, provided that
21 .\" the entire resulting derived work is distributed under the terms of
22 .\" a permission notice identical to this one.
23 .\"
24 .\" Permission is granted to copy and distribute translations of this
25 .\" manual into another language, under the above conditions for
26 .\" modified versions, except that this permission notice may be
27 .\" included in translations approved by the Free Software Foundation
28 .\" instead of in the original English.
29 .
30 .
31 .\" Save and disable compatibility mode (for, e.g., Solaris 10/11).
32 .do nr *groff_hpftodit_1_man_C \n[.cp]
33 .cp 0
34 .
35 .\" Define fallback for groff 1.23's MR macro if the system lacks it.
36 .nr do-fallback 0
37 .if !\n(.f .nr do-fallback 1 \" mandoc
38 .if \n(.g .if !d MR .nr do-fallback 1 \" older groff
39 .if !\n(.g .nr do-fallback 1 \" non-groff *roff
40 .if \n[do-fallback] \{\
41 . de MR
42 . ie \\n(.$=1 \
43 . I \%\\$1
44 . el \
45 . IR \%\\$1 (\\$2)\\$3
46 . .
47 .\}
48 .rr do-fallback
49 .
50 .
51 .\" ====================================================================
52 .SH Synopsis
53 .\" ====================================================================
54 .
55 .SY hpftodit
56 .RB [ \-aqs ]
57 .RB [ \-i\~\c
58 .IR n ]
59 .I tfm-file
60 .I map-file
61 .I font-description
62 .YS
63 .
64 .
65 .P
66 .SY hpftodit
67 .B \-d
68 .I tfm-file
69 .RI [ map-file ]
70 .YS
71 .
72 .
73 .P
74 .SY hpftodit
75 .B \-\-help
76 .YS
77 .
78 .
79 .P
80 .SY hpftodit
81 .B \-v
82 .YS
83 .
84 .SY hpftodit
85 .B \%\-\-version
86 .YS
87 .
88 .
89 .\" ====================================================================
90 .SH Description
91 .\" ====================================================================
92 .
93 .I hpftodit
94 creates a font description file for use with a Hewlett-Packard
95 LaserJet\~4-\%series
96 (or newer)
97 printer and the
98 .MR grolj4 1
99 output driver of
100 .MR groff 1 ,
101 using data from an HP tagged font metric (TFM) file.
102 .
103 .I tfm-file
104 is the name of the font's TFM file;
105 Intellifont and TrueType TFM files are supported,
106 but symbol set TFM files are not.
107 .
108 .I map-file
109 is a file giving the
110 .I groff
111 special character identifiers for glyphs in the font;
112 this file should consist of a sequence of lines of the form
113 .RS
114 .EX
115 .IR "m u c1 c2 " "\&.\|.\|.\& [#" " comment" "]"
116 .EE
117 .RE
118 where
119 .I m
120 is a decimal integer giving the glyph's MSL
121 (Master Symbol List)
122 number,
123 .I u
124 is a hexadecimal integer giving its Unicode character code,
125 and
126 .IR c1 ,
127 .IR c2 ", .\|.\|."
128 are its
129 .I groff
130 glyph names
131 (see
132 .MR groff_char 7
133 for a list).
134 .
135 The values can be separated by any number of spaces and/or tabs.
136 .
137 The Unicode value must use uppercase hexadecimal digits A\^\[en]\^F,
138 and must lack a leading
139 .RB \[lq] 0x \[rq],
140 .RB \[lq] u \[rq],
141 or
142 .RB \[lq] U+ \[rq].
143 .
144 Unicode values corresponding to composite glyphs are decomposed;
145 that is
146 .RB \[lq] u00C0 \[rq]
147 becomes
148 .RB \[lq] u0041_0300 \[rq].
149 .
150 A glyph without a
151 .I groff
152 special character identifier may be named
153 .BI u XXXX
154 if the glyph corresponds to a Unicode value,
155 or as an unnamed glyph
156 .RB \[lq] \-\-\- \[rq].
157 .
158 If the given Unicode value is in the Private Use Area (PUA)
159 (0xE000\^\[en]\^0xF8FF),
160 the glyph is included as an unnamed glyph.
161 .
162 Refer to
163 .MR groff_diff 1
164 for additional information about unnamed glyphs and how to access them.
165 .
166 .
167 .P
168 Blank lines and lines beginning with
169 .RB \[lq] # \[rq]
170 are ignored.
171 .
172 A
173 .RB \[lq] # \[rq]
174 following one or more
175 .I groff
176 names begins a comment.
177 .
178 Because
179 .RB \[lq] # \[rq]
180 is a valid
181 .I groff
182 name,
183 it must appear first in a list of
184 .I groff
185 names if a comment is included,
186 as in
187 .
188 .RS
189 .EX
190 3 0023 # # number sign
191 .EE
192 .RE
193 .
194 or
195 .
196 .RS
197 .EX
198 3 0023 # sh # number sign
199 .EE
200 .RE
201 .
202 whereas in
203 .
204 .RS
205 .EX
206 3 0023 sh # # number sign
207 .EE
208 .RE
209 .
210 the first
211 .RB \[lq] # \[rq]
212 is interpreted as the beginning of the comment.
213 .
214 .
215 .P
216 .I hpftodit
217 writes output to
218 .I font-description,
219 a file named for the intended
220 .I groff
221 font name;
222 if this operand is
223 .RB \[lq] \- \[rq],
224 .I hpftodit
225 writes to the standard output stream.
226 .
227 The
228 .B \-i
229 option directs
230 .I hpftodit
231 to automatically generate an italic correction,
232 a left italic correction,
233 and a subscript correction for each glyph.
234 .
235 See
236 .MR groff_font 5 .
237 .
238 .
239 .\" ====================================================================
240 .SH Options
241 .\" ====================================================================
242 .
243 .B \-\-help
244 displays a usage message,
245 while
246 .B \-v
247 and
248 .B \%\-\-version
249 show version information;
250 all exit afterward.
251 .
252 .
253 .TP
254 .B \-a
255 Include glyphs in the TFM file that are not included in
256 .IR map-file .
257 .
258 A glyph with corresponding Unicode value is given the name
259 .RI u XXXX ;
260 a glyph without a Unicode value is included as an unnamed glyph
261 \[lq]\-\^\-\^\-\[rq].
262 .
263 A glyph with a Unicode value in the Private Use Area
264 (0xE000\^\[en]\^0xF8FF)
265 is also included as an unnamed glyph.
266 .
267 .
268 .IP
269 This option provides a simple means of adding Unicode-named and
270 unnamed glyphs to a font without including them in the map file,
271 but it affords little control over which glyphs are placed in a regular
272 font and which are placed in a special font.
273 .
274 The presence or absence of the
275 .B \-s
276 option has some effect on which glyphs are included:
277 without it,
278 only the \[lq]text\[rq] symbol sets are searched for matching glyphs;
279 with it,
280 only the \[lq]mathematical\[rq] symbol sets are searched.
281 .
282 Nonetheless,
283 restricting the symbol sets searched isn't very selective\[em]many
284 glyphs are placed in both regular and special fonts.
285 .
286 Normally,
287 .B \-a
288 should be used only as a last resort.
289 .
290 .
291 .TP
292 .B \-d
293 Dump information about the TFM file to the standard output stream;
294 use this to ensure that a TFM file is a proper match for a font,
295 and that its contents are suitable.
296 .
297 The information includes the values of important TFM tags and a listing
298 (by MSL number for Intellifont TFM files or by Unicode value for
299 TrueType TFM files)
300 of the glyphs included in the TFM file.
301 .
302 The unit of measure \[lq]DU\[rq] for some tags indicates design units;
303 there are 8782\~design units per em for Intellifont fonts,
304 and 2048\~design units per em for TrueType fonts.
305 .
306 Note that the accessibility of a glyph depends on its inclusion in a
307 symbol set;
308 some TFM files list many glyphs but only a few symbol sets.
309 .
310 .
311 .IP
312 The glyph listing includes the glyph index within the TFM file,
313 the MSL or Unicode value,
314 and the symbol set and character code that will be used to print the
315 glyph.
316 .
317 If
318 .I map-file
319 is given,
320 .I groff
321 names are given for matching glyphs.
322 .
323 If only the glyph index and MSL or Unicode value are given,
324 the glyph does not appear in any supported symbol set and cannot be
325 printed.
326 .
327 .
328 .IP
329 With the
330 .B \-d
331 option,
332 .I map-file
333 is optional,
334 and
335 .I output-font
336 is ignored if given.
337 .
338 .
339 .TP
340 .BI \-i\~ n
341 Generate an italic correction for each glyph so that its width plus its
342 italic correction is equal to
343 .I n
344 thousandths of an em plus the amount by which the right edge of the
345 glyphs's bounding box is to the right of its origin.
346 .
347 The minimum value
348 .I hpftodit
349 will write is zero.
350 .
351 .
352 .IP
353 Also generate a subscript correction equal to the product of the tangent
354 of the slant of the font and four fifths of the x-height of the font.
355 .
356 If a subscript correction greater than the italic correction would
357 result,
358 use a subscript correction equal to the italic correction instead.
359 .
360 .
361 .IP
362 Also generate a left italic correction for each glyph equal to
363 .I n
364 thousandths of an em plus the amount by which the left edge of the
365 glyphs's bounding box is to the left of its origin.
366 .
367 The left italic correction may be negative.
368 .
369 .
370 .IP
371 This option normally is needed only with italic or oblique fonts;
372 a value of 50
373 (0.05\~em)
374 usually is a reasonable choice.
375 .
376 .
377 .TP
378 .B \-q
379 Suppress warnings about glyphs in the map file that were not found in
380 the TFM file.
381 .
382 Warnings never are given for unnamed glyphs or by glyphs named by their
383 Unicode values.
384 .
385 This option is useful when sending the output of
386 .I hpftodit
387 to the standard output stream.
388 .
389 .
390 .TP
391 .B \-s
392 Add the
393 .B special
394 directive to the font description file,
395 affecting the order in which HP symbol sets are searched for each glyph.
396 .
397 Without this option,
398 the \[lq]text\[rq] sets are searched before the \[lq]mathematical\[rq]
399 symbol sets.
400 .
401 With it,
402 the search order is reversed.
403 .
404 .
405 .\" ====================================================================
406 .SH "Exit status"
407 .\" ====================================================================
408 .
409 .I \%hpftodit
410 exits with
411 .RB status\~ 0
412 on successful operation,
413 .RB status\~ 2
414 if the program cannot interpret its command-line arguments,
415 and
416 .RB status\~ 1
417 if it encounters an error during operation.
418 .
419 .
420 .\" ====================================================================
421 .SH Files
422 .\" ====================================================================
423 .
424 .TP
425 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%font/\:\%devlj4/\:DESC
426 describes the
427 .B lj4
428 output device.
429 .
430 .
431 .TP
432 .IR /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%font/\:\%devlj4/ F
433 describes the font known
434 .RI as\~ F
435 on device
436 .BR lj4 .
437 .
438 .
439 .TP
440 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%font/\:\%devlj4/\:\%generate/\:\%Makefile
441 is a
442 .MR make 1
443 script that uses
444 .MR hpftodit 1
445 to prepare the
446 .I groff
447 font description files above from HP TFM data;
448 it can be used to regenerate them in the event the TFM files are
449 updated.
450 .
451 .
452 .TP
453 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%font/\:\%devlj4/\:\%generate/\:\%special\:.awk
454 is an
455 .MR awk 1
456 script that corrects the Intellifont-based height metrics for several
457 glyphs in the
458 .B S
459 (special) font for TrueType CG Times used in the HP LaserJet\~4000 and
460 later.
461 .
462 .
463 .TP
464 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%font/\:\%devlj4/\:\%generate/\:\%special\:.map
465 .TQ
466 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%font/\:\%devlj4/\:\%generate/\:\%symbol\:.map
467 .TQ
468 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%font/\:\%devlj4/\:\%generate/\:text\:.map
469 .TQ
470 .I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%font/\:\%devlj4/\:\%generate/\:\%wingdings.map
471 map MSL indices and HP Unicode PUA assignments to
472 .I groff
473 special character identifiers.
474 .
475 .
476 .\" ====================================================================
477 .SH "See also"
478 .\" ====================================================================
479 .
480 .MR groff 1 ,
481 .MR groff_diff 1 ,
482 .MR grolj4 1 ,
483 .MR groff_font 5
484 .
485 .
486 .\" Restore compatibility mode (for, e.g., Solaris 10/11).
487 .cp \n[*groff_hpftodit_1_man_C]
488 .do rr *groff_hpftodit_1_man_C
489 .
490 .
491 .\" Local Variables:
492 .\" fill-column: 72
493 .\" mode: nroff
494 .\" End:
495 .\" vim: set filetype=groff textwidth=72: