| 1 |
.TH groff_font 5 "2026-04-22" "groff 1.24.1" |
| 2 |
.SH Name |
| 3 |
groff_font \- GNU |
| 4 |
.I roff |
| 5 |
device and font description files |
| 6 |
. |
| 7 |
. |
| 8 |
.\" ==================================================================== |
| 9 |
.\" Legal Terms |
| 10 |
.\" ==================================================================== |
| 11 |
.\" |
| 12 |
.\" Copyright 1989-2025 Free Software Foundation, Inc. |
| 13 |
.\" |
| 14 |
.\" This file is part of groff, the GNU roff typesetting system. |
| 15 |
.\" |
| 16 |
.\" Permission is granted to copy, distribute and/or modify this |
| 17 |
.\" document under the terms of the GNU Free Documentation License, |
| 18 |
.\" Version 1.3 or any later version published by the Free Software |
| 19 |
.\" Foundation; with no Invariant Sections, with no Front-Cover Texts, |
| 20 |
.\" and with no Back-Cover Texts. |
| 21 |
.\" |
| 22 |
.\" A copy of the Free Documentation License is included as a file |
| 23 |
.\" called FDL in the main directory of the groff source package. |
| 24 |
. |
| 25 |
. |
| 26 |
.\" Save and disable compatibility mode (for, e.g., Solaris 10/11). |
| 27 |
.do nr *groff_groff_font_5_man_C \n[.cp] |
| 28 |
.cp 0 |
| 29 |
. |
| 30 |
.\" Define fallback for groff 1.23's MR macro if the system lacks it. |
| 31 |
.nr do-fallback 0 |
| 32 |
.if !\n(.f .nr do-fallback 1 \" mandoc |
| 33 |
.if \n(.g .if !d MR .nr do-fallback 1 \" older groff |
| 34 |
.if !\n(.g .nr do-fallback 1 \" non-groff *roff |
| 35 |
.if \n[do-fallback] \{\ |
| 36 |
. de MR |
| 37 |
. ie \\n(.$=1 \ |
| 38 |
. I \%\\$1 |
| 39 |
. el \ |
| 40 |
. IR \%\\$1 (\\$2)\\$3 |
| 41 |
. . |
| 42 |
.\} |
| 43 |
.rr do-fallback |
| 44 |
. |
| 45 |
. |
| 46 |
.\" ==================================================================== |
| 47 |
.SH Description |
| 48 |
.\" ==================================================================== |
| 49 |
. |
| 50 |
.\" BEGIN Keep parallel with groff.texi node "Device and Font |
| 51 |
.\" Description Files". |
| 52 |
The |
| 53 |
.I groff |
| 54 |
font and output device description formats are slight |
| 55 |
extensions of those used by AT&T device-independent |
| 56 |
.IR troff . \" AT&T |
| 57 |
. |
| 58 |
In distinction to the AT&T implementation, |
| 59 |
.I groff |
| 60 |
lacks a binary format; |
| 61 |
all files are text files. |
| 62 |
. |
| 63 |
(Plan\~9 |
| 64 |
.I troff \" Plan 9 |
| 65 |
has also abandoned the binary format.) |
| 66 |
. |
| 67 |
The device and font description files for a device |
| 68 |
.I name |
| 69 |
are stored in a |
| 70 |
.IR dev name |
| 71 |
directory. |
| 72 |
. |
| 73 |
The device description file is called |
| 74 |
.IR DESC , |
| 75 |
and, |
| 76 |
for each font supported by the device, |
| 77 |
a font description file is |
| 78 |
.RI called\~ f, |
| 79 |
where |
| 80 |
.IR f \~is |
| 81 |
usually an abbreviation of a font's name and/or style. |
| 82 |
. |
| 83 |
For example, |
| 84 |
the |
| 85 |
.B ps |
| 86 |
(PostScript) |
| 87 |
device has |
| 88 |
.I groff |
| 89 |
font description files for Times roman |
| 90 |
.RB ( TR ) |
| 91 |
and Zapf Chancery Medium italic |
| 92 |
.RB ( ZCMI ), |
| 93 |
among many others, |
| 94 |
while the |
| 95 |
.B utf8 |
| 96 |
device |
| 97 |
(for terminals) |
| 98 |
has font descriptions for the roman, |
| 99 |
italic, |
| 100 |
bold, |
| 101 |
and bold-italic styles |
| 102 |
.RB ( R , |
| 103 |
.BR I , |
| 104 |
.BR B , |
| 105 |
and |
| 106 |
.BR BI , |
| 107 |
respectively). |
| 108 |
. |
| 109 |
. |
| 110 |
.P |
| 111 |
Device and font description files are read by the formatter, |
| 112 |
.IR \%troff , |
| 113 |
and by output drivers. |
| 114 |
. |
| 115 |
The programs typically delegate these files' processing to an internal |
| 116 |
library, |
| 117 |
.IR libgroff , |
| 118 |
ensuring their consistent interpretation. |
| 119 |
. |
| 120 |
. |
| 121 |
.\" ==================================================================== |
| 122 |
.SH "\f[I]DESC\f[] file format" |
| 123 |
.\" ==================================================================== |
| 124 |
. |
| 125 |
The |
| 126 |
.I DESC |
| 127 |
file contains a series of directives; |
| 128 |
each begins a line. |
| 129 |
. |
| 130 |
Their order is not important, |
| 131 |
with two exceptions: |
| 132 |
(1) the |
| 133 |
.B res |
| 134 |
directive must precede any |
| 135 |
.B \%papersize |
| 136 |
directive; |
| 137 |
and |
| 138 |
(2) the |
| 139 |
.B charset |
| 140 |
directive must come last |
| 141 |
(if at all). |
| 142 |
. |
| 143 |
If a directive name is repeated, |
| 144 |
later entries in the file override previous ones |
| 145 |
(except that the paper dimensions are computed based on the |
| 146 |
.B res |
| 147 |
directive last seen when |
| 148 |
.B \%papersize |
| 149 |
is encountered). |
| 150 |
. |
| 151 |
Spaces and/or tabs separate words and are ignored at line boundaries. |
| 152 |
. |
| 153 |
Comments start with the |
| 154 |
.RB \[lq] # \[rq] |
| 155 |
character and extend to the end of a line. |
| 156 |
. |
| 157 |
Empty lines are ignored. |
| 158 |
. |
| 159 |
. |
| 160 |
.TP 8n \" "vert n" + 2n |
| 161 |
.BI family\~ fam |
| 162 |
The default font family is |
| 163 |
.IR fam . |
| 164 |
. |
| 165 |
. |
| 166 |
.TP |
| 167 |
.BI fonts\~ "n F1"\~\c |
| 168 |
.RI .\|.\|.\&\~ Fn |
| 169 |
Fonts |
| 170 |
.IR F1 ", \|.\|.\|.\|, " Fn |
| 171 |
are mounted at font positions |
| 172 |
.IR m "\|+\|1, \|.\|.\|., " m \|+\| n |
| 173 |
where |
| 174 |
.I m |
| 175 |
is the number of |
| 176 |
.B styles |
| 177 |
(see below). |
| 178 |
. |
| 179 |
This directive may extend over more than one line. |
| 180 |
. |
| 181 |
A font name |
| 182 |
.RB of\~ 0 |
| 183 |
causes no font to be mounted at the corresponding position. |
| 184 |
. |
| 185 |
. |
| 186 |
.TP |
| 187 |
.BI hor\~ n |
| 188 |
The horizontal motion quantum is |
| 189 |
.IR n \~basic |
| 190 |
units. |
| 191 |
. |
| 192 |
Horizontal measurements round to multiples |
| 193 |
.RI of\~ n. |
| 194 |
. |
| 195 |
. |
| 196 |
.TP |
| 197 |
.BI image_generator\~ program |
| 198 |
Use |
| 199 |
.I program |
| 200 |
to generate PNG images from PostScript input. |
| 201 |
. |
| 202 |
Under GNU/Linux, |
| 203 |
this is usually |
| 204 |
.MR gs 1 , |
| 205 |
but under other systems |
| 206 |
(notably Cygwin) |
| 207 |
it might be set to another name. |
| 208 |
. |
| 209 |
The |
| 210 |
.MR grohtml 1 |
| 211 |
driver uses this directive. |
| 212 |
. |
| 213 |
. |
| 214 |
.TP |
| 215 |
.BI paperlength\~ n |
| 216 |
The vertical dimension of the output medium is |
| 217 |
.IR n \~basic |
| 218 |
units |
| 219 |
(deprecated: |
| 220 |
use |
| 221 |
.B \%papersize |
| 222 |
instead). |
| 223 |
. |
| 224 |
. |
| 225 |
.TP |
| 226 |
.BI papersize\~ format-or-dimension-pair-or-file-name\c |
| 227 |
\~.\|.\|. |
| 228 |
The dimensions of the output medium are as according to the |
| 229 |
argument, |
| 230 |
which is either |
| 231 |
a standard paper format, |
| 232 |
a pair of dimensions, |
| 233 |
or the name of a plain text file containing either of the foregoing. |
| 234 |
. |
| 235 |
Recognized paper formats are the ISO and DIN formats |
| 236 |
.BR A0 \[en] A7 , |
| 237 |
.BR B0 \[en] B7 , |
| 238 |
.BR C0 \[en] C7 , |
| 239 |
and |
| 240 |
.BR D0 \[en] D7 ; |
| 241 |
.\" XXX: tmac/papersize.tmac does not support [ABCD]7. |
| 242 |
the U.S.\& formats |
| 243 |
.BR letter , |
| 244 |
.BR legal , |
| 245 |
.BR tabloid , |
| 246 |
.BR ledger , |
| 247 |
.BR statement , |
| 248 |
and |
| 249 |
.BR executive ; |
| 250 |
and the envelope formats |
| 251 |
.BR com10 , |
| 252 |
.BR monarch , |
| 253 |
and |
| 254 |
.BR DL . |
| 255 |
. |
| 256 |
Matching is performed without regard for lettercase. |
| 257 |
. |
| 258 |
. |
| 259 |
.IP |
| 260 |
Alternatively, |
| 261 |
the argument can be a custom paper format |
| 262 |
.IB length , width |
| 263 |
(with no spaces before or after the comma). |
| 264 |
. |
| 265 |
Both |
| 266 |
.I length |
| 267 |
and |
| 268 |
.I width |
| 269 |
must have a unit appended; |
| 270 |
valid units are |
| 271 |
.RB \[lq] i \[rq] |
| 272 |
for inches, |
| 273 |
.RB \[lq] c \[rq] |
| 274 |
for centimeters, |
| 275 |
.RB \[lq] p \[rq] |
| 276 |
for points, |
| 277 |
and |
| 278 |
.RB \[lq] P \[rq] |
| 279 |
for picas. |
| 280 |
. |
| 281 |
Example: |
| 282 |
.RB \[lq] 12c,235p \[rq]. |
| 283 |
. |
| 284 |
An argument that starts with a digit is always treated as a custom paper |
| 285 |
format. |
| 286 |
. |
| 287 |
. |
| 288 |
.IP |
| 289 |
Finally, |
| 290 |
the argument can be a file name |
| 291 |
(e.g., |
| 292 |
.IR /etc/papersize ); |
| 293 |
if the file can be opened, |
| 294 |
the first line is read and a match attempted against each other form. |
| 295 |
. |
| 296 |
No comment syntax is supported. |
| 297 |
. |
| 298 |
. |
| 299 |
.IP |
| 300 |
More than one argument can be specified; |
| 301 |
each is scanned in turn and the first valid paper specification used. |
| 302 |
. |
| 303 |
. |
| 304 |
.TP |
| 305 |
.BI paperwidth\~ n |
| 306 |
The horizontal dimension of the output medium is |
| 307 |
.IR n \~basic |
| 308 |
units |
| 309 |
(deprecated: |
| 310 |
use |
| 311 |
.B \%papersize |
| 312 |
instead). |
| 313 |
. |
| 314 |
. |
| 315 |
.TP |
| 316 |
.B pass_filenames |
| 317 |
Direct |
| 318 |
.I \%troff |
| 319 |
to emit the name of the source file being processed. |
| 320 |
. |
| 321 |
This is achieved with the intermediate output command |
| 322 |
.RB \[lq] "x F" \[rq], |
| 323 |
which |
| 324 |
.I \%grohtml |
| 325 |
interprets. |
| 326 |
. |
| 327 |
. |
| 328 |
.TP |
| 329 |
.BI postpro\~ program |
| 330 |
Use |
| 331 |
.I program |
| 332 |
as the postprocessor. |
| 333 |
. |
| 334 |
. |
| 335 |
.TP |
| 336 |
.BI prepro\~ program |
| 337 |
Use |
| 338 |
.I program |
| 339 |
as a preprocessor. |
| 340 |
. |
| 341 |
The |
| 342 |
.B html |
| 343 |
and |
| 344 |
.B xhtml |
| 345 |
output devices use this directive. |
| 346 |
. |
| 347 |
. |
| 348 |
.TP |
| 349 |
.BI print\~ program |
| 350 |
Use |
| 351 |
.I program |
| 352 |
as the print spooler. |
| 353 |
. |
| 354 |
If omitted, |
| 355 |
.IR groff 's |
| 356 |
.B \-l |
| 357 |
and |
| 358 |
.B \-L |
| 359 |
options are ignored. |
| 360 |
. |
| 361 |
. |
| 362 |
.TP |
| 363 |
.BI res\~ n |
| 364 |
The device resolution is |
| 365 |
.I n |
| 366 |
basic units per inch. |
| 367 |
. |
| 368 |
. |
| 369 |
.TP |
| 370 |
.BI sizes\~ s1\~\c |
| 371 |
.RI .\|.\|.\&\~ sn\~\c |
| 372 |
.B 0 |
| 373 |
The device has fonts at |
| 374 |
.IR s1 , |
| 375 |
\&.\|.\|., |
| 376 |
.I sn |
| 377 |
scaled points |
| 378 |
(see below). |
| 379 |
. |
| 380 |
The list of sizes must be terminated by |
| 381 |
.RB a\~ 0 . |
| 382 |
. |
| 383 |
Each |
| 384 |
.I si |
| 385 |
can also be a range of sizes |
| 386 |
.IR m \[en] n . |
| 387 |
. |
| 388 |
The list can extend over more than one line. |
| 389 |
. |
| 390 |
. |
| 391 |
.TP |
| 392 |
.BI sizescale\~ n |
| 393 |
A typographical point |
| 394 |
is subdivided into |
| 395 |
.IR n \~scaled |
| 396 |
points. |
| 397 |
. |
| 398 |
The default |
| 399 |
.RB is\~ 1 . |
| 400 |
. |
| 401 |
. |
| 402 |
.TP |
| 403 |
.BI styles\~ S1\~\c |
| 404 |
.RI .\|.\|.\&\~ Sm |
| 405 |
The |
| 406 |
.RI first\~ m |
| 407 |
font mounting positions are associated with styles |
| 408 |
.IR S1 , |
| 409 |
\&.\|.\|., |
| 410 |
.IR Sm . |
| 411 |
. |
| 412 |
. |
| 413 |
.TP |
| 414 |
.B tcommand |
| 415 |
The postprocessor can handle the |
| 416 |
.B t |
| 417 |
.RB and\~ u |
| 418 |
intermediate output commands. |
| 419 |
. |
| 420 |
. |
| 421 |
.TP |
| 422 |
.B unicode |
| 423 |
The output device supports the complete Unicode repertoire. |
| 424 |
. |
| 425 |
This directive is useful only for devices which produce character |
| 426 |
entities instead of glyphs. |
| 427 |
. |
| 428 |
. |
| 429 |
.IP |
| 430 |
If |
| 431 |
.B unicode |
| 432 |
is present, |
| 433 |
no |
| 434 |
.B charset |
| 435 |
section is required in the font description files since the Unicode |
| 436 |
handling built into |
| 437 |
.I groff |
| 438 |
is used. |
| 439 |
. |
| 440 |
However, |
| 441 |
if there are entries in a font description file's |
| 442 |
.B charset |
| 443 |
section, |
| 444 |
they either override the default mappings for those particular |
| 445 |
characters or add new mappings |
| 446 |
(normally for composite characters). |
| 447 |
. |
| 448 |
. |
| 449 |
.IP |
| 450 |
The |
| 451 |
.BR utf8 , |
| 452 |
.BR html , |
| 453 |
and |
| 454 |
.B xhtml |
| 455 |
output devices use this directive. |
| 456 |
. |
| 457 |
. |
| 458 |
.TP |
| 459 |
.BI unitwidth\~ n |
| 460 |
Arbitrary basis with respect to which font metrics are proportionally |
| 461 |
scaled when rendering glyphs at a type size of one point. |
| 462 |
. |
| 463 |
. |
| 464 |
.TP |
| 465 |
.B unscaled_charwidths |
| 466 |
Make the font handling module always return unscaled glyph widths. |
| 467 |
. |
| 468 |
The |
| 469 |
.I \%grohtml |
| 470 |
driver uses this directive. |
| 471 |
. |
| 472 |
. |
| 473 |
.\" XXX: Savannah #63074 is trying to make this obsolescent. |
| 474 |
.TP |
| 475 |
.B use_charnames_in_special |
| 476 |
.I \%troff |
| 477 |
should encode special characters in arguments to device extension |
| 478 |
commands. |
| 479 |
. |
| 480 |
The |
| 481 |
.I \%grohtml |
| 482 |
driver uses this directive. |
| 483 |
. |
| 484 |
. |
| 485 |
.TP |
| 486 |
.BI vert\~ n |
| 487 |
The vertical motion quantum is |
| 488 |
.IR n \~basic |
| 489 |
units. |
| 490 |
. |
| 491 |
Vertical measurements round to multiples |
| 492 |
.RI of\~ n. |
| 493 |
. |
| 494 |
. |
| 495 |
.TP |
| 496 |
.B charset |
| 497 |
This directive and the rest of the file are ignored. |
| 498 |
. |
| 499 |
It is recognized for compatibility with other |
| 500 |
.I troff \" generic |
| 501 |
implementations. |
| 502 |
. |
| 503 |
In GNU |
| 504 |
.IR troff , \" GNU |
| 505 |
character set repertoire is described on a per-font basis. |
| 506 |
. |
| 507 |
. |
| 508 |
.P |
| 509 |
.I \%troff |
| 510 |
recognizes but ignores the directives |
| 511 |
.BR spare1 , |
| 512 |
.BR spare2 , |
| 513 |
and |
| 514 |
.BR biggestfont . |
| 515 |
. |
| 516 |
. |
| 517 |
.P |
| 518 |
The |
| 519 |
.BR res , |
| 520 |
.BR unitwidth , |
| 521 |
.BR fonts , |
| 522 |
and |
| 523 |
.B sizes |
| 524 |
lines are mandatory. |
| 525 |
. |
| 526 |
Directives not listed above are ignored by |
| 527 |
.I \%troff |
| 528 |
but may be used by postprocessors to obtain further information about |
| 529 |
the device. |
| 530 |
. |
| 531 |
. |
| 532 |
.\" ==================================================================== |
| 533 |
.SH "Font description file format" |
| 534 |
.\" ==================================================================== |
| 535 |
. |
| 536 |
On typesetting output devices, |
| 537 |
each font is typically available at multiple sizes. |
| 538 |
. |
| 539 |
While paper measurements in the device description file are in absolute |
| 540 |
units, |
| 541 |
measurements applicable to fonts must be proportional to the type size. |
| 542 |
. |
| 543 |
The font's |
| 544 |
.I "unit width" |
| 545 |
establishes a numerical basis |
| 546 |
that permits all of its metrics to be expressed as integers |
| 547 |
if rendered at one point. |
| 548 |
. |
| 549 |
When the formatter configures a type size, |
| 550 |
it scales the metrics linearly relative to that basis. |
| 551 |
. |
| 552 |
The unit width has no inherent relationship to the device resolution, |
| 553 |
and the same division procedure applies to all font metrics. |
| 554 |
. |
| 555 |
Observe that whatever unit might one select for the unit width, |
| 556 |
the division operation implied by scaling cancels it out, |
| 557 |
leaving a dimensionless quantity. |
| 558 |
. |
| 559 |
. |
| 560 |
.P |
| 561 |
For instance, |
| 562 |
.IR groff 's |
| 563 |
.B lbp |
| 564 |
device uses a |
| 565 |
.B \%unitwidth |
| 566 |
directive with an argument of\~800. |
| 567 |
Its Times roman font |
| 568 |
.B TR |
| 569 |
has a |
| 570 |
.B \%spacewidth |
| 571 |
of\~833; |
| 572 |
this is also the width of its comma, |
| 573 |
period, |
| 574 |
centered period, |
| 575 |
and mathematical asterisk, |
| 576 |
while its |
| 577 |
.RB \[lq] M \[rq] |
| 578 |
has a width of 2,963. |
| 579 |
Thus, |
| 580 |
an |
| 581 |
.RB \[lq] M \[rq] |
| 582 |
on the |
| 583 |
.B lbp |
| 584 |
device is 2,963 \[tdi] 800 times the unit width, |
| 585 |
or approximately 3.7. |
| 586 |
At a type size of 10 points, |
| 587 |
a Times roman |
| 588 |
.RB \[lq] M \[rq] |
| 589 |
is therefore 37 units wide. |
| 590 |
. |
| 591 |
. |
| 592 |
.P |
| 593 |
A font description file has two sections. |
| 594 |
. |
| 595 |
The first is a sequence of directives, |
| 596 |
and is parsed similarly to the |
| 597 |
.I DESC |
| 598 |
file described above. |
| 599 |
. |
| 600 |
Except for the directive names that begin the second section, |
| 601 |
their ordering is immaterial. |
| 602 |
. |
| 603 |
Later directives of the same name override earlier ones, |
| 604 |
spaces and tabs are handled in the same way, |
| 605 |
and the same comment syntax is supported. |
| 606 |
. |
| 607 |
Empty lines are ignored throughout. |
| 608 |
. |
| 609 |
. |
| 610 |
.TP 8n \" "name F" + 2n |
| 611 |
.BI name\~ F |
| 612 |
The name of the font |
| 613 |
.RI is\~ F . |
| 614 |
. |
| 615 |
.RB \[lq] DESC \[rq] |
| 616 |
is an invalid font name. |
| 617 |
. |
| 618 |
Simple integers are valid, |
| 619 |
but their use is discouraged. |
| 620 |
. |
| 621 |
.RI ( groff |
| 622 |
requests and escape sequences interpret non-negative integers as |
| 623 |
mounting positions instead. |
| 624 |
. |
| 625 |
Further, |
| 626 |
a font named |
| 627 |
.RB \[lq] 0 \[rq] |
| 628 |
cannot be automatically mounted by the |
| 629 |
.B fonts |
| 630 |
directive of a |
| 631 |
.I DESC |
| 632 |
file.) |
| 633 |
. |
| 634 |
. |
| 635 |
.TP |
| 636 |
.BI spacewidth\~ n |
| 637 |
The width of an unadjusted inter-word space is |
| 638 |
.IR n , |
| 639 |
relative to the device's unit width. |
| 640 |
. |
| 641 |
. |
| 642 |
.P |
| 643 |
The directives above must appear in the first section; |
| 644 |
those below are optional. |
| 645 |
. |
| 646 |
. |
| 647 |
.TP |
| 648 |
.BI slant\~ n |
| 649 |
The font's glyphs have a slant of |
| 650 |
.IR n \~degrees; |
| 651 |
a positive |
| 652 |
.I n |
| 653 |
slants in the direction of text flow. |
| 654 |
. |
| 655 |
. |
| 656 |
.TP |
| 657 |
.BI ligatures\~ lig1\~\c |
| 658 |
.RI .\|.\|.\&\~ lign\~\c |
| 659 |
.RB [ 0 ] |
| 660 |
Glyphs |
| 661 |
.IR lig1 , |
| 662 |
\&.\|.\|., |
| 663 |
.I lign |
| 664 |
are ligatures; |
| 665 |
possible ligatures are |
| 666 |
.BR f\&f , |
| 667 |
.BR f\&i , |
| 668 |
.BR f\&l , |
| 669 |
.BR f\&f\&i , |
| 670 |
and |
| 671 |
.BR f\&f\&l . |
| 672 |
. |
| 673 |
For compatibility with other |
| 674 |
.I troff |
| 675 |
implementations, |
| 676 |
the list of ligatures may be terminated with |
| 677 |
.RB a\~ 0 . |
| 678 |
. |
| 679 |
The list of ligatures must not extend over more than one line. |
| 680 |
. |
| 681 |
. |
| 682 |
.TP |
| 683 |
.B special |
| 684 |
The font is |
| 685 |
.IR special : |
| 686 |
when the document attempts to format a glyph |
| 687 |
that is not present in the formatter's currently selected font, |
| 688 |
the glyph is sought in any mounted fonts that bear this property. |
| 689 |
Often, |
| 690 |
such fonts are |
| 691 |
.IR unstyled , |
| 692 |
having no heavy (bold) or slanted |
| 693 |
(italic or oblique) |
| 694 |
variants. |
| 695 |
. |
| 696 |
. |
| 697 |
.P |
| 698 |
Other directives in this section are ignored by GNU |
| 699 |
.IR troff , \" GNU |
| 700 |
but may be used by postprocessors to obtain further information about |
| 701 |
the font. |
| 702 |
. |
| 703 |
. |
| 704 |
.P |
| 705 |
The second section contains one to three subsections, |
| 706 |
which can appear in any order, |
| 707 |
and any of which starts the second section. |
| 708 |
. |
| 709 |
Each starts with a directive on a line by itself. |
| 710 |
. |
| 711 |
A |
| 712 |
.B charset |
| 713 |
subsection is mandatory unless the associated |
| 714 |
.I DESC |
| 715 |
file contains the |
| 716 |
.B \%unicode |
| 717 |
directive. |
| 718 |
. |
| 719 |
Another subsection, |
| 720 |
.BR \%kernpairs , |
| 721 |
is optional. |
| 722 |
. |
| 723 |
. |
| 724 |
.P |
| 725 |
The directive |
| 726 |
.B charset |
| 727 |
starts the character set subsection. |
| 728 |
. |
| 729 |
(On typesetters, |
| 730 |
this directive is misnamed since it starts a list of glyphs, |
| 731 |
not characters.) |
| 732 |
. |
| 733 |
It precedes a series of glyph descriptions, |
| 734 |
one per line. |
| 735 |
. |
| 736 |
Each such glyph description comprises a set of fields separated by |
| 737 |
spaces or tabs and organized as follows. |
| 738 |
. |
| 739 |
. |
| 740 |
.IP |
| 741 |
.I name metrics type index |
| 742 |
.RI [ entity-name ] |
| 743 |
.RB [ \-\- |
| 744 |
.IR comment ] |
| 745 |
. |
| 746 |
. |
| 747 |
.P |
| 748 |
.I name |
| 749 |
identifies the glyph: |
| 750 |
a printable |
| 751 |
.RI character\~ c |
| 752 |
corresponds to the |
| 753 |
.I troff \" generic |
| 754 |
ordinary |
| 755 |
.RI character\~ c , |
| 756 |
and a multi-character sequence not beginning with |
| 757 |
.BR \[rs] , |
| 758 |
corresponds to the GNU |
| 759 |
.I troff \" GNU |
| 760 |
special character escape sequence |
| 761 |
\[lq]\c |
| 762 |
.BI \[rs][ name ]\c |
| 763 |
\[rq]. |
| 764 |
. |
| 765 |
A name consisting of three minus signs, |
| 766 |
.RB \[lq] \-\-\- \[rq], |
| 767 |
indicates that the glyph is unnamed: |
| 768 |
such glyphs can be accessed only by the |
| 769 |
.B \[rs]N |
| 770 |
escape sequence in |
| 771 |
.IR troff . \" generic; \N is portable |
| 772 |
. |
| 773 |
A special character named |
| 774 |
.RB \[lq] \-\-\- \[rq] |
| 775 |
can still be defined using |
| 776 |
.B .char |
| 777 |
and similar requests. |
| 778 |
. |
| 779 |
The |
| 780 |
.I name |
| 781 |
.RB \[lq] \[rs]\- \[rq] |
| 782 |
defines the minus sign glyph. |
| 783 |
. |
| 784 |
.\" TODO: Withdraw support for this. No one seems to use it. |
| 785 |
Finally, |
| 786 |
.I name |
| 787 |
can be the horizontal motion escape sequences, |
| 788 |
.B \[rs]| |
| 789 |
and |
| 790 |
.B \[rs]\[ha] |
| 791 |
(\[lq]thin\[rq] and \[lq]hair\[rq] spaces, |
| 792 |
respectively), |
| 793 |
in which case only the width metric described below is applied; |
| 794 |
a font can thus customize the widths of these spaces. |
| 795 |
.\" XXX: For exhaustivity purposes...you can define "\whatever", which |
| 796 |
.\" has to be accessed with \C'\\whatever' or \[\\whatever], but the |
| 797 |
.\" parser matches predefined escape sequences before looking up special |
| 798 |
.\" characters. Most such definitions are inaccessible from the |
| 799 |
.\" language, because nearly every '\x', where 'x' is a Unicode basic |
| 800 |
.\" Latin character, is a predefined groff escape sequence. |
| 801 |
. |
| 802 |
. |
| 803 |
.br |
| 804 |
.ne 4v \" Keep next paragraph together with (possibly 2-line) synopsis. |
| 805 |
.P |
| 806 |
The form of the |
| 807 |
.I metrics |
| 808 |
field is as follows |
| 809 |
(on one line; |
| 810 |
it may be broken here for readability). |
| 811 |
. |
| 812 |
. |
| 813 |
.IP |
| 814 |
.\" XXX: Turning off adjustment is ugly; thanks to meter-long specimens |
| 815 |
.\" like this, we need an escape sequence that selectively disables |
| 816 |
.\" adjustment at the end of a word. |
| 817 |
.na |
| 818 |
.I width\/\c |
| 819 |
.RI [\fB,\fP[ \:height\/\c |
| 820 |
.RI [\fB,\fP[ \:depth\/\c |
| 821 |
.RI [\fB,\fP[ \:\%italic-correction\/\c |
| 822 |
.RI [\fB,\fP[ \:\%left-italic-correction\/\c |
| 823 |
.RI [\fB,\fP[ \:\%subscript-correction ]]]]]]]]]] |
| 824 |
.\" XXX: cringe |
| 825 |
.ie d AD .ad \*[AD] |
| 826 |
.el .ad b |
| 827 |
. |
| 828 |
. |
| 829 |
.P |
| 830 |
Spaces, |
| 831 |
tabs, |
| 832 |
and newlines are prohibited |
| 833 |
between these |
| 834 |
.I subfields, |
| 835 |
which are expressed as decimal integers. |
| 836 |
. |
| 837 |
The unit of measure is that established by the |
| 838 |
.B \%unitwidth |
| 839 |
directive and scaled to the type size. |
| 840 |
. |
| 841 |
Unspecified subfields default to\~0. |
| 842 |
. |
| 843 |
Since there is no associated binary format, |
| 844 |
these values are not required to fit |
| 845 |
into the C language data type |
| 846 |
.I char |
| 847 |
as they are in AT&T device-independent |
| 848 |
.IR troff . \" AT&T |
| 849 |
. |
| 850 |
. |
| 851 |
.P |
| 852 |
The |
| 853 |
.I width |
| 854 |
subfield gives the width of the glyph. |
| 855 |
. |
| 856 |
The |
| 857 |
.I height |
| 858 |
subfield gives the height of the glyph |
| 859 |
(upward is positive); |
| 860 |
if a glyph does not extend above the baseline, |
| 861 |
give it a zero height, |
| 862 |
not a negative height. |
| 863 |
. |
| 864 |
The |
| 865 |
.I depth |
| 866 |
subfield gives the depth of the glyph\[em]\c |
| 867 |
that is, |
| 868 |
the distance below the baseline to which the glyph extends |
| 869 |
(downward is positive); |
| 870 |
if a glyph does not extend below the baseline, |
| 871 |
give it a zero depth, |
| 872 |
not a negative depth. |
| 873 |
. |
| 874 |
Italic corrections apply when upright and slanted |
| 875 |
(italic or oblique) |
| 876 |
styles are typeset adjacently. |
| 877 |
. |
| 878 |
The |
| 879 |
.I italic-correction |
| 880 |
is the amount of space |
| 881 |
to add after a slanted glyph |
| 882 |
to be followed immediately by an upright glyph. |
| 883 |
. |
| 884 |
The |
| 885 |
.I left-italic-correction |
| 886 |
is the amount of space |
| 887 |
to add before a slanted glyph |
| 888 |
to be preceded immediately by an upright glyph. |
| 889 |
. |
| 890 |
The |
| 891 |
.I |
| 892 |
subscript-correction |
| 893 |
is the amount of space |
| 894 |
to add after a slanted glyph |
| 895 |
to be followed by a subscript; |
| 896 |
it should be less than the italic correction. |
| 897 |
. |
| 898 |
. |
| 899 |
.P |
| 900 |
For fonts used with typesetters, |
| 901 |
the |
| 902 |
.I type |
| 903 |
field gives a featural description of the glyph: |
| 904 |
it is a bit mask recording whether the glyph is an ascender, |
| 905 |
descender, |
| 906 |
both, |
| 907 |
or neither. |
| 908 |
. |
| 909 |
When a |
| 910 |
.B \[rs]w |
| 911 |
escape sequence is interpolated, |
| 912 |
these values are bitwise or-ed together |
| 913 |
for each glyph |
| 914 |
and stored in the |
| 915 |
.B ct |
| 916 |
register. |
| 917 |
. |
| 918 |
In font descriptions for terminals, |
| 919 |
all glyphs might have a type of zero, |
| 920 |
regardless of their appearance. |
| 921 |
. |
| 922 |
. |
| 923 |
.TP |
| 924 |
0 |
| 925 |
means the glyph lies entirely between the baseline and |
| 926 |
a horizontal line at the \[lq]x-height\[rq] of the font, |
| 927 |
as with \[lq]a\[rq], |
| 928 |
\[lq]c\[rq], |
| 929 |
and |
| 930 |
\[lq]x\[rq]; |
| 931 |
. |
| 932 |
. |
| 933 |
.TP |
| 934 |
1 |
| 935 |
means the glyph descends below the baseline, |
| 936 |
like \[lq]p\[rq]; |
| 937 |
. |
| 938 |
. |
| 939 |
.TP |
| 940 |
2 |
| 941 |
means the glyph ascends above the font's x-height, |
| 942 |
like \[lq]A\[rq] or |
| 943 |
\[lq]b\[rq]); |
| 944 |
and |
| 945 |
. |
| 946 |
. |
| 947 |
.TP |
| 948 |
3 |
| 949 |
means the glyph is both an ascender and a descender\[em]this is true of |
| 950 |
parentheses in some fonts. |
| 951 |
. |
| 952 |
. |
| 953 |
.P |
| 954 |
The |
| 955 |
.I index |
| 956 |
field is an integer that uniquely identifies a glyph within the font; |
| 957 |
any integer is accepted as input, |
| 958 |
(that is, |
| 959 |
any integer parsable |
| 960 |
by the C standard library's |
| 961 |
.MR strtol 3 |
| 962 |
function) |
| 963 |
but no practical font employs all possible values. |
| 964 |
. |
| 965 |
An |
| 966 |
.I index |
| 967 |
is limited to the range of the system's C language data type |
| 968 |
.IR int . |
| 969 |
. |
| 970 |
In a |
| 971 |
.I troff \" generic |
| 972 |
document, |
| 973 |
use the indexed character escape sequence |
| 974 |
.B \[rs]N |
| 975 |
to specify a glyph by index. |
| 976 |
. |
| 977 |
. |
| 978 |
.P |
| 979 |
The |
| 980 |
.I entity-name |
| 981 |
field defines an identifier for the glyph that the postprocessor |
| 982 |
uses to print the |
| 983 |
.I \%troff |
| 984 |
glyph |
| 985 |
.IR name . |
| 986 |
. |
| 987 |
This field is optional; |
| 988 |
it was introduced so that the |
| 989 |
.I \%grohtml |
| 990 |
output driver could encode its character set. |
| 991 |
. |
| 992 |
For example, |
| 993 |
the glyph |
| 994 |
.B \[rs][Po] |
| 995 |
is represented by |
| 996 |
.RB \[lq] £ \[rq] |
| 997 |
in HTML 4.0. |
| 998 |
. |
| 999 |
For efficiency, |
| 1000 |
these data are now compiled directly into |
| 1001 |
.IR \%grohtml . |
| 1002 |
. |
| 1003 |
.I grops |
| 1004 |
uses the field to build sub-encoding arrays for PostScript fonts |
| 1005 |
containing more than 256 glyphs. |
| 1006 |
. |
| 1007 |
. |
| 1008 |
.P |
| 1009 |
Anything on the line after the |
| 1010 |
.I entity-name |
| 1011 |
field or |
| 1012 |
.RB \[lq] \-\- \[rq] |
| 1013 |
is ignored. |
| 1014 |
. |
| 1015 |
When |
| 1016 |
.I afmtodit |
| 1017 |
generates font description files for |
| 1018 |
.MR gropdf 1 |
| 1019 |
and |
| 1020 |
.MR grops 1 , |
| 1021 |
it writes the UTF-16 code for the character to the comment field. |
| 1022 |
. |
| 1023 |
. |
| 1024 |
.P |
| 1025 |
A line in the |
| 1026 |
.B charset |
| 1027 |
section can also have the form |
| 1028 |
. |
| 1029 |
.RS |
| 1030 |
.IB name\~ \[dq] |
| 1031 |
.RE |
| 1032 |
. |
| 1033 |
identifying |
| 1034 |
.I name |
| 1035 |
as another name for the glyph mentioned in the preceding line. |
| 1036 |
. |
| 1037 |
Such aliases can be chained. |
| 1038 |
. |
| 1039 |
. |
| 1040 |
.P |
| 1041 |
A |
| 1042 |
.B \%charset\-range |
| 1043 |
subsection works like the |
| 1044 |
.B charset |
| 1045 |
directive except that the glyph descriptions use a |
| 1046 |
.I name |
| 1047 |
of the form |
| 1048 |
.BI u AAAA ..u FFFF\c |
| 1049 |
, |
| 1050 |
where |
| 1051 |
.I AAAA |
| 1052 |
and |
| 1053 |
.I FFFF |
| 1054 |
are hexadecimal digit sequences; |
| 1055 |
the specified metrics then apply identically |
| 1056 |
to all glyphs in the designated range. |
| 1057 |
. |
| 1058 |
. |
| 1059 |
.P |
| 1060 |
The directive |
| 1061 |
.B \%kernpairs |
| 1062 |
starts a list of kerning adjustments to be made to adjacent glyph pairs |
| 1063 |
from this font. |
| 1064 |
. |
| 1065 |
It contains a sequence of lines formatted as follows. |
| 1066 |
. |
| 1067 |
.RS |
| 1068 |
.I g1 g2 n |
| 1069 |
.RE |
| 1070 |
. |
| 1071 |
The foregoing means that when glyph |
| 1072 |
.I g1 |
| 1073 |
is typeset immediately before |
| 1074 |
.IR g2 , |
| 1075 |
the space between them should be increased |
| 1076 |
.RI by\~ n . |
| 1077 |
. |
| 1078 |
The unit of measure is that established by the |
| 1079 |
.B \%unitwidth |
| 1080 |
directive and scaled to the type size. |
| 1081 |
. |
| 1082 |
Most kerning pairs should have a negative value |
| 1083 |
.RI for\~ n . |
| 1084 |
.\" END Keep parallel with groff.texi node "Device and Font Description |
| 1085 |
.\" Files". |
| 1086 |
. |
| 1087 |
. |
| 1088 |
.br |
| 1089 |
.ne 4v |
| 1090 |
.\" ==================================================================== |
| 1091 |
.SH Files |
| 1092 |
.\" ==================================================================== |
| 1093 |
. |
| 1094 |
.TP |
| 1095 |
.IR /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%font/\:\%dev name /\:DESC |
| 1096 |
describes the output device |
| 1097 |
.IR name . |
| 1098 |
. |
| 1099 |
. |
| 1100 |
.TP |
| 1101 |
.IR /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%font/\:\%dev name / F |
| 1102 |
describes the font known |
| 1103 |
.RI as\~ F |
| 1104 |
on device |
| 1105 |
.IR name . |
| 1106 |
. |
| 1107 |
. |
| 1108 |
.\" ==================================================================== |
| 1109 |
.SH "See also" |
| 1110 |
.\" ==================================================================== |
| 1111 |
. |
| 1112 |
.IR "Groff: The GNU Implementation of troff" , |
| 1113 |
by Trent A.\& Fisher and Werner Lemberg, |
| 1114 |
is the primary |
| 1115 |
.I groff |
| 1116 |
manual. |
| 1117 |
. |
| 1118 |
You can browse it interactively with \[lq]info groff\[rq]. |
| 1119 |
. |
| 1120 |
. |
| 1121 |
.P |
| 1122 |
\[lq]Troff User's Manual\[rq] |
| 1123 |
by Joseph F.\& Ossanna, |
| 1124 |
1976 |
| 1125 |
(revised by Brian W.\& Kernighan, |
| 1126 |
1992), |
| 1127 |
AT&T Bell Laboratories Computing Science Technical Report No.\& 54, |
| 1128 |
widely called simply \[lq]CSTR\~#54\[rq], |
| 1129 |
documents the language, |
| 1130 |
device and font description file formats, |
| 1131 |
and device-independent page description language |
| 1132 |
referred to collectively in |
| 1133 |
.I groff |
| 1134 |
documentation as |
| 1135 |
.RI \[lq]AT&T\~ troff \[rq]. |
| 1136 |
. |
| 1137 |
. |
| 1138 |
.P |
| 1139 |
\[lq]A Typesetter-independent TROFF\[rq] |
| 1140 |
by Brian W.\& Kernighan, |
| 1141 |
1982, |
| 1142 |
AT&T Bell Laboratories Computing Science Technical Report No.\& 97, |
| 1143 |
provides additional insights into the |
| 1144 |
device and font description file formats |
| 1145 |
and device-independent page description language. |
| 1146 |
. |
| 1147 |
. |
| 1148 |
.P |
| 1149 |
.MR groff 1 , |
| 1150 |
subsection \[lq]Utilities\[rq], |
| 1151 |
lists programs available for describing fonts in a variety of formats |
| 1152 |
such that |
| 1153 |
.I groff |
| 1154 |
output drivers can use them. |
| 1155 |
. |
| 1156 |
. |
| 1157 |
.P |
| 1158 |
.MR \%troff 1 |
| 1159 |
documents the default device and font description file search path. |
| 1160 |
. |
| 1161 |
. |
| 1162 |
.P |
| 1163 |
.MR groff_out 5 , |
| 1164 |
.MR addftinfo 1 |
| 1165 |
. |
| 1166 |
. |
| 1167 |
.\" Restore compatibility mode (for, e.g., Solaris 10/11). |
| 1168 |
.cp \n[*groff_groff_font_5_man_C] |
| 1169 |
.do rr *groff_groff_font_5_man_C |
| 1170 |
. |
| 1171 |
. |
| 1172 |
.\" Local Variables: |
| 1173 |
.\" fill-column: 72 |
| 1174 |
.\" mode: nroff |
| 1175 |
.\" End: |
| 1176 |
.\" vim: set filetype=groff textwidth=72: |