| 1 |
'\" t |
| 2 |
.TH \%troff 1 "2026-04-22" "groff 1.24.1" |
| 3 |
.SH Name |
| 4 |
\%troff \- GNU |
| 5 |
.I roff |
| 6 |
typesetter and document formatter |
| 7 |
. |
| 8 |
. |
| 9 |
.\" ==================================================================== |
| 10 |
.\" Legal Terms |
| 11 |
.\" ==================================================================== |
| 12 |
.\" |
| 13 |
.\" Copyright 1989-2024 Free Software Foundation, Inc. |
| 14 |
.\" 2020-2025 G. Branden Robinson |
| 15 |
.\" |
| 16 |
.\" This file is part of groff, the GNU roff typesetting system. |
| 17 |
.\" |
| 18 |
.\" Permission is granted to copy, distribute and/or modify this |
| 19 |
.\" document under the terms of the GNU Free Documentation License, |
| 20 |
.\" Version 1.3 or any later version published by the Free Software |
| 21 |
.\" Foundation; with no Invariant Sections, with no Front-Cover Texts, |
| 22 |
.\" and with no Back-Cover Texts. |
| 23 |
.\" |
| 24 |
.\" A copy of the Free Documentation License is included as a file |
| 25 |
.\" called FDL in the main directory of the groff source package. |
| 26 |
.\" |
| 27 |
.\" A copy of the GNU Free Documentation License is also available in this |
| 28 |
.\" Debian package as /usr/share/doc/groff-base/copyright. |
| 29 |
. |
| 30 |
. |
| 31 |
.\" Save and disable compatibility mode (for, e.g., Solaris 10/11). |
| 32 |
.do nr *groff_troff_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 \%troff |
| 56 |
.RB [ \-abcCEiRSUz ] |
| 57 |
.RB [ \-d\~\c |
| 58 |
.IR ctext ] |
| 59 |
.RB [ \-d\~\c |
| 60 |
.IB string =\c |
| 61 |
.IR text ] |
| 62 |
.RB [ \-f\~\c |
| 63 |
.IR font-family ] |
| 64 |
.RB [ \-F\~\c |
| 65 |
.IR font-directory ] |
| 66 |
.RB [ \-I\~\c |
| 67 |
.IR inclusion-directory ] |
| 68 |
.RB [ \-m\~\c |
| 69 |
.IR macro-package ] |
| 70 |
.RB [ \-M\~\c |
| 71 |
.IR macro-directory ] |
| 72 |
.RB [ \-n\~\c |
| 73 |
.IR page-number ] |
| 74 |
.RB [ \-o\~\c |
| 75 |
.IR page-list ] |
| 76 |
.RB [ \-r\~\c |
| 77 |
.IR cnumeric-expression ] |
| 78 |
.RB [ \-r\~\c |
| 79 |
.IB register =\c |
| 80 |
.IR numeric-expression ] |
| 81 |
.RB [ \-T\~\c |
| 82 |
.IR output-device ] |
| 83 |
.RB [ \-w\~\c |
| 84 |
.IR warning-category ] |
| 85 |
.RB [ \-W\~\c |
| 86 |
.IR warning-category ] |
| 87 |
.RI [ file\~ .\|.\|.] |
| 88 |
.YS |
| 89 |
. |
| 90 |
. |
| 91 |
.P |
| 92 |
.SY \%troff |
| 93 |
.B \-\-help |
| 94 |
.YS |
| 95 |
. |
| 96 |
. |
| 97 |
.P |
| 98 |
.SY \%troff |
| 99 |
.B \-v |
| 100 |
.YS |
| 101 |
. |
| 102 |
.SY \%troff |
| 103 |
.B \%\-\-version |
| 104 |
.YS |
| 105 |
. |
| 106 |
. |
| 107 |
.\" ==================================================================== |
| 108 |
.SH Description |
| 109 |
.\" ==================================================================== |
| 110 |
. |
| 111 |
GNU |
| 112 |
.I troff \" GNU |
| 113 |
transforms |
| 114 |
.MR groff 7 |
| 115 |
language input into the device-independent page description language |
| 116 |
detailed in |
| 117 |
.MR groff_out 5 ; |
| 118 |
.I \%troff |
| 119 |
is thus the heart of the GNU |
| 120 |
.I roff |
| 121 |
document formatting system. |
| 122 |
. |
| 123 |
If no |
| 124 |
.I file |
| 125 |
operands are present, |
| 126 |
or if |
| 127 |
.I file |
| 128 |
is |
| 129 |
.RB \[lq] \- \[rq], |
| 130 |
.I \%troff |
| 131 |
reads the standard input stream. |
| 132 |
. |
| 133 |
. |
| 134 |
.P |
| 135 |
GNU |
| 136 |
.I troff \" GNU |
| 137 |
is functionally compatible with the AT&T |
| 138 |
.I troff \" AT&T |
| 139 |
typesetter and features numerous extensions. |
| 140 |
. |
| 141 |
Many people prefer to use the |
| 142 |
.MR groff 1 |
| 143 |
command, |
| 144 |
a front end which also runs preprocessors and output drivers in the |
| 145 |
appropriate order and with appropriate options. |
| 146 |
. |
| 147 |
. |
| 148 |
.\" ==================================================================== |
| 149 |
.SH Options |
| 150 |
.\" ==================================================================== |
| 151 |
. |
| 152 |
.B \-h |
| 153 |
and |
| 154 |
.B \-\-help |
| 155 |
display a usage message, |
| 156 |
while |
| 157 |
.B \-v |
| 158 |
and |
| 159 |
.B \%\-\-version |
| 160 |
show version information; |
| 161 |
all exit afterward. |
| 162 |
. |
| 163 |
. |
| 164 |
.TP 9n \" "-m mac" + 2n + hand-tuned for PDF |
| 165 |
.B \-a |
| 166 |
Generate a plain text approximation of the typeset output. |
| 167 |
. |
| 168 |
The read-only register |
| 169 |
.B .A |
| 170 |
is set to\~1. |
| 171 |
. |
| 172 |
This option produces a sort of abstract preview of the formatted output. |
| 173 |
. |
| 174 |
. |
| 175 |
.RS |
| 176 |
.IP \[bu] 3n |
| 177 |
Page breaks are marked by a phrase in angle brackets; |
| 178 |
for example, |
| 179 |
\[lq]<beginning of page>\[rq]. |
| 180 |
. |
| 181 |
. |
| 182 |
.IP \[bu] |
| 183 |
Lines are broken where they would be in formatted output. |
| 184 |
. |
| 185 |
. |
| 186 |
.IP \[bu] |
| 187 |
Vertical motion, |
| 188 |
apart from that implied by a break, |
| 189 |
is not represented. |
| 190 |
. |
| 191 |
. |
| 192 |
.IP \[bu] |
| 193 |
A horizontal motion of any size is represented as one space. |
| 194 |
. |
| 195 |
Adjacent horizontal motions are not combined. |
| 196 |
. |
| 197 |
Supplemental inter-sentence space |
| 198 |
(configured by the second argument to the |
| 199 |
.B .ss |
| 200 |
request) |
| 201 |
is not represented. |
| 202 |
. |
| 203 |
. |
| 204 |
.IP \[bu] |
| 205 |
A special character is rendered as its identifier between angle |
| 206 |
brackets; |
| 207 |
for example, |
| 208 |
a hyphen appears as \[lq]<hy>\[rq]. |
| 209 |
.RE |
| 210 |
. |
| 211 |
. |
| 212 |
.IP |
| 213 |
The above description should not be considered a specification; |
| 214 |
the details of |
| 215 |
.B \-a |
| 216 |
output are subject to change. |
| 217 |
. |
| 218 |
. |
| 219 |
.TP |
| 220 |
.B \-b |
| 221 |
Write a backtrace reporting the state of |
| 222 |
.IR \%troff 's |
| 223 |
input parser to the standard error stream with each diagnostic message. |
| 224 |
. |
| 225 |
The line numbers given in the backtrace might not always be correct, |
| 226 |
because |
| 227 |
.IR \%troff 's |
| 228 |
idea of line numbers can be confused by requests that append to |
| 229 |
.\" strings or (??? strings never contain newlines) |
| 230 |
macros. |
| 231 |
. |
| 232 |
. |
| 233 |
.TP |
| 234 |
.B \-c |
| 235 |
Disable multi-color output and |
| 236 |
.RB \[lq] color \[rq] |
| 237 |
request's ability to enable it. |
| 238 |
. |
| 239 |
. |
| 240 |
.TP |
| 241 |
.B \-C |
| 242 |
Enable AT&T |
| 243 |
.I troff \" AT&T |
| 244 |
compatibility mode; |
| 245 |
implies |
| 246 |
.BR \-c . |
| 247 |
. |
| 248 |
See |
| 249 |
.MR groff_diff 7 . |
| 250 |
. |
| 251 |
. |
| 252 |
.TP |
| 253 |
.BI \-d\~ ctext |
| 254 |
.TQ |
| 255 |
.BI \-d\~ string = text |
| 256 |
Define |
| 257 |
.I roff |
| 258 |
.RI string\~ c |
| 259 |
or |
| 260 |
.I string |
| 261 |
as |
| 262 |
.I text. |
| 263 |
. |
| 264 |
.IR c \~must |
| 265 |
be a one-character identifier; |
| 266 |
.I string |
| 267 |
can be of arbitrary length. |
| 268 |
. |
| 269 |
Such assignments happen before any macro file is loaded, |
| 270 |
including the startup file. |
| 271 |
. |
| 272 |
Due to |
| 273 |
.MR getopt_long 3 |
| 274 |
limitations, |
| 275 |
.IR c\~ cannot |
| 276 |
be, |
| 277 |
and |
| 278 |
.I string |
| 279 |
cannot contain, |
| 280 |
an equals sign, |
| 281 |
even though that is a valid character in a |
| 282 |
.I roff |
| 283 |
identifier. |
| 284 |
. |
| 285 |
. |
| 286 |
.TP |
| 287 |
.B \-E |
| 288 |
Inhibit |
| 289 |
.I \%troff |
| 290 |
error messages; |
| 291 |
implies |
| 292 |
.BR \-Ww . |
| 293 |
. |
| 294 |
This option does |
| 295 |
.I not |
| 296 |
suppress messages sent to the standard error stream by documents or |
| 297 |
macro packages using |
| 298 |
.B tm |
| 299 |
or related requests. |
| 300 |
. |
| 301 |
. |
| 302 |
.TP |
| 303 |
.BI \-f\~ fam |
| 304 |
Use |
| 305 |
.I fam |
| 306 |
as the default font family. |
| 307 |
. |
| 308 |
. |
| 309 |
.TP |
| 310 |
.BI \-F\~ dir |
| 311 |
Search in directory |
| 312 |
.I dir |
| 313 |
for the selected output device's directory of device and font |
| 314 |
description files. |
| 315 |
. |
| 316 |
See the description of |
| 317 |
.I GROFF_FONT_PATH |
| 318 |
in section \[lq]Environment\[rq] below for the default search locations |
| 319 |
and ordering. |
| 320 |
. |
| 321 |
. |
| 322 |
.TP |
| 323 |
.B \-i |
| 324 |
Read the standard input stream after all named input files have been |
| 325 |
processed. |
| 326 |
. |
| 327 |
. |
| 328 |
.TP |
| 329 |
.BI \-I\~ dir |
| 330 |
Search the directory |
| 331 |
.I dir |
| 332 |
for files |
| 333 |
(those named on the command line; |
| 334 |
in |
| 335 |
.BR psbb , |
| 336 |
.BR so , |
| 337 |
and |
| 338 |
.B soquiet |
| 339 |
requests; |
| 340 |
and in |
| 341 |
.RB \[lq] "\[rs]X\[aq]ps: import\[aq]" \[rq], |
| 342 |
.RB \[lq] "\[rs]X\[aq]ps: file\[aq]" \[rq], |
| 343 |
and |
| 344 |
.RB \[lq] "\[rs]X\[aq]pdf: pdfpic\[aq]" \[rq] |
| 345 |
device extension escape sequences). |
| 346 |
. |
| 347 |
.B \-I |
| 348 |
may be specified more than once; |
| 349 |
each |
| 350 |
.I dir |
| 351 |
is searched in the given order. |
| 352 |
. |
| 353 |
To search the current working directory before others, |
| 354 |
add |
| 355 |
.RB \[lq] "\-I .\&" \[rq] |
| 356 |
at the desired place; |
| 357 |
it is otherwise searched last. |
| 358 |
. |
| 359 |
.B \-I |
| 360 |
works similarly to, |
| 361 |
and is named for, |
| 362 |
the \[lq]include\[rq] |
| 363 |
option of Unix C compilers. |
| 364 |
. |
| 365 |
. |
| 366 |
.TP |
| 367 |
.BI \-m\~ mac |
| 368 |
Search for the macro package |
| 369 |
.RI mac .tmac |
| 370 |
and read it prior to any input. |
| 371 |
. |
| 372 |
If not found, |
| 373 |
.IR tmac. mac |
| 374 |
is attempted. |
| 375 |
. |
| 376 |
See the description of |
| 377 |
.I GROFF_TMAC_PATH |
| 378 |
in section \[lq]Environment\[rq] below for the default search locations |
| 379 |
and ordering. |
| 380 |
. |
| 381 |
. |
| 382 |
.TP |
| 383 |
.BI \-M\~ dir |
| 384 |
Search directory |
| 385 |
.I dir |
| 386 |
for macro files. |
| 387 |
. |
| 388 |
See the description of |
| 389 |
.I GROFF_TMAC_PATH |
| 390 |
in section \[lq]Environment\[rq] below for the default search locations |
| 391 |
and ordering. |
| 392 |
. |
| 393 |
. |
| 394 |
.TP |
| 395 |
.BI \-n\~ num |
| 396 |
Begin numbering pages at |
| 397 |
.I num. |
| 398 |
. |
| 399 |
The default |
| 400 |
.RB is\~ 1 . |
| 401 |
. |
| 402 |
. |
| 403 |
.TP |
| 404 |
.BI \-o\~ list |
| 405 |
Output only pages in |
| 406 |
.I list, |
| 407 |
which is a comma-separated list of inclusive page ranges; |
| 408 |
.I n |
| 409 |
means page |
| 410 |
.I n, |
| 411 |
.IB m \- n |
| 412 |
means every page |
| 413 |
.RI between\~ m |
| 414 |
.RI and\~ n , |
| 415 |
.BI \- n |
| 416 |
means every page up |
| 417 |
.RI to\~ n , |
| 418 |
and |
| 419 |
.IB n \- |
| 420 |
means every page from |
| 421 |
.IR n \~on. |
| 422 |
. |
| 423 |
.I \%troff |
| 424 |
stops processing and exits after formatting the last page enumerated in |
| 425 |
.I list. |
| 426 |
. |
| 427 |
. |
| 428 |
.TP |
| 429 |
.BI \-r\~ cnumeric-expression |
| 430 |
.TQ |
| 431 |
.BI \-r\~ register = numeric-expression |
| 432 |
Define |
| 433 |
.I roff |
| 434 |
.RI register\~ c |
| 435 |
or |
| 436 |
.I register |
| 437 |
as |
| 438 |
.I numeric-expression. |
| 439 |
. |
| 440 |
.IR c \~must |
| 441 |
be a one-character identifier; |
| 442 |
.I register |
| 443 |
can be of arbitrary length. |
| 444 |
. |
| 445 |
Such assignments happen before any macro file is loaded, |
| 446 |
including the startup file. |
| 447 |
. |
| 448 |
Due to |
| 449 |
.MR getopt_long 3 |
| 450 |
limitations, |
| 451 |
.IR c\~ cannot |
| 452 |
be, |
| 453 |
and |
| 454 |
.I register |
| 455 |
cannot contain, |
| 456 |
an equals sign, |
| 457 |
even though that is a valid character in a |
| 458 |
.I roff |
| 459 |
identifier. |
| 460 |
. |
| 461 |
. |
| 462 |
.TP |
| 463 |
.B \-R |
| 464 |
Prevent loading of |
| 465 |
.I troffrc |
| 466 |
and |
| 467 |
.IR troffrc\-end ; |
| 468 |
this option can be useful for troubleshooting. |
| 469 |
. |
| 470 |
. |
| 471 |
.TP |
| 472 |
.B \-S |
| 473 |
Enable safer mode and ignore any subsequent |
| 474 |
.B \-U |
| 475 |
option. |
| 476 |
. |
| 477 |
. |
| 478 |
.TP |
| 479 |
.BI \-T\~ dev |
| 480 |
Prepare output for device |
| 481 |
.I dev. |
| 482 |
. |
| 483 |
The default is |
| 484 |
.BR \%ps ; |
| 485 |
see |
| 486 |
.MR groff 1 . |
| 487 |
. |
| 488 |
. |
| 489 |
.TP |
| 490 |
.B \-U |
| 491 |
Operate in |
| 492 |
.I unsafe mode, |
| 493 |
enabling the |
| 494 |
.BR cf , |
| 495 |
.BR open , |
| 496 |
.BR opena , |
| 497 |
.BR pi , |
| 498 |
.BR pso , |
| 499 |
and |
| 500 |
.B sy |
| 501 |
requests, |
| 502 |
which are disabled by default because they |
| 503 |
allow an untrusted input document to run arbitrary commands, |
| 504 |
put arbitrary content into |
| 505 |
.I troff \" generic |
| 506 |
output, |
| 507 |
or write to arbitrary file names. |
| 508 |
. |
| 509 |
(GNU |
| 510 |
.I troff \" GNU |
| 511 |
does not, |
| 512 |
however, |
| 513 |
accept newlines |
| 514 |
(line feeds) |
| 515 |
in file names supplied as arguments to requests.) |
| 516 |
.\" ...nor other characters invalid as input; Savannah #65108. |
| 517 |
. |
| 518 |
This option also adds the current directory to the macro package search |
| 519 |
path; |
| 520 |
see the |
| 521 |
.B \-m |
| 522 |
and |
| 523 |
.B \-M |
| 524 |
options above. |
| 525 |
. |
| 526 |
. |
| 527 |
.TP |
| 528 |
.BI \-w\~ cat |
| 529 |
.TQ |
| 530 |
.BI \-W\~ cat |
| 531 |
Enable and inhibit, |
| 532 |
respectively, |
| 533 |
warnings in category |
| 534 |
.I cat. |
| 535 |
. |
| 536 |
See section \[lq]Warnings\[rq] below. |
| 537 |
. |
| 538 |
. |
| 539 |
.TP |
| 540 |
.B \-z |
| 541 |
Suppress formatted output. |
| 542 |
. |
| 543 |
. |
| 544 |
.\" ==================================================================== |
| 545 |
.SH Warnings |
| 546 |
.\" ==================================================================== |
| 547 |
. |
| 548 |
.\" BEGIN Keep parallel with groff.texi node "Warnings". |
| 549 |
.\" Caveat: the Texinfo manual sorts them by number, not name. |
| 550 |
GNU |
| 551 |
.I troff \" GNU |
| 552 |
divides its warning diagnostics into named, |
| 553 |
numbered categories. |
| 554 |
The |
| 555 |
.B \-w |
| 556 |
and |
| 557 |
.B \-W |
| 558 |
options use the associated names. |
| 559 |
. |
| 560 |
A power of two characterizes each category; |
| 561 |
the |
| 562 |
.B warn |
| 563 |
request and the |
| 564 |
.B .warn |
| 565 |
register respectively set and report the sum of enabled category codes. |
| 566 |
. |
| 567 |
Warnings of each category are produced under the following |
| 568 |
circumstances. |
| 569 |
. |
| 570 |
. |
| 571 |
.P |
| 572 |
.TS |
| 573 |
tab(@), center, box; |
| 574 |
C C C | C C C |
| 575 |
R Ri Lb | R Ri Lb. |
| 576 |
Bit@Code@Category@Bit@Code@Category |
| 577 |
_ |
| 578 |
0@1@char@10@1024@reg |
| 579 |
1@2@\fIunused\fP@11@2048@tab |
| 580 |
2@4@break@12@4096@\fIunused\fP |
| 581 |
3@8@delim@13@8192@missing |
| 582 |
4@16@\fIunused\fP@14@16384@input |
| 583 |
5@32@scale@15@32768@escape |
| 584 |
6@64@range@16@65536@space |
| 585 |
7@128@syntax@17@131072@font |
| 586 |
8@256@di@18@262144@ig |
| 587 |
9@512@mac@19@524288@color |
| 588 |
@@@20@1048576@file |
| 589 |
.TE |
| 590 |
.\" Give the table bottom extra breathing room on typesetters. |
| 591 |
.if t .sp \n[PD]u |
| 592 |
. |
| 593 |
. |
| 594 |
.P |
| 595 |
.TS |
| 596 |
Lb N Lx. |
| 597 |
break 4 T{ |
| 598 |
A filled output line could not be |
| 599 |
broken such that its length was less than or equal to, |
| 600 |
or |
| 601 |
adjusted such that its length was exactly equal to, |
| 602 |
the output line length |
| 603 |
.RB \[lq] \[rs]n[.l] \[rq]. |
| 604 |
. |
| 605 |
GNU |
| 606 |
.I troff \" GNU |
| 607 |
reports the amount of overset or underset in the scaling unit configured |
| 608 |
by the |
| 609 |
.B \%warnscale |
| 610 |
request in |
| 611 |
.B troff \" mode |
| 612 |
mode, |
| 613 |
and in ens |
| 614 |
.RB (\[oq] n \[cq]; |
| 615 |
character cells) |
| 616 |
in |
| 617 |
.B nroff \" mode |
| 618 |
mode. |
| 619 |
. |
| 620 |
This category is enabled by default. |
| 621 |
T} |
| 622 |
. |
| 623 |
. |
| 624 |
.sp \n[PD]u |
| 625 |
char 1 T{ |
| 626 |
No user-defined character of the requested name or index exists |
| 627 |
and no mounted font defines a glyph for it, |
| 628 |
or input could not be encoded for device-independent output. |
| 629 |
. |
| 630 |
This category is enabled by default. |
| 631 |
T} |
| 632 |
. |
| 633 |
. |
| 634 |
.sp \n[PD]u |
| 635 |
color 524288 T{ |
| 636 |
An undefined color name was selected, |
| 637 |
an attempt was made to define a color using an unrecognized color space, |
| 638 |
an invalid channel value in a color definition was encountered, |
| 639 |
or an attempt was made to redefine a default color. |
| 640 |
T} |
| 641 |
. |
| 642 |
. |
| 643 |
.sp \n[PD]u |
| 644 |
delim 8 T{ |
| 645 |
The selected delimiter character was ambiguous |
| 646 |
because it is also meaningful when beginning a numeric expression, |
| 647 |
or |
| 648 |
the closing delimiter in an escape sequence was missing or mismatched. |
| 649 |
. |
| 650 |
. |
| 651 |
.sp \n[PD]u |
| 652 |
A future |
| 653 |
.I groff |
| 654 |
release may reject ambiguous delimiters. |
| 655 |
. |
| 656 |
In compatibility mode, |
| 657 |
ambiguous delimiters are accepted without warning. |
| 658 |
T} |
| 659 |
. |
| 660 |
. |
| 661 |
.sp \n[PD]u |
| 662 |
di 256 T{ |
| 663 |
A |
| 664 |
.BR di , |
| 665 |
.BR da , |
| 666 |
.BR box , |
| 667 |
or |
| 668 |
.B boxa |
| 669 |
request was invoked without an argument when there was no current |
| 670 |
diversion. |
| 671 |
T} |
| 672 |
. |
| 673 |
. |
| 674 |
.\" .TP |
| 675 |
.\" .BR el "\t16" |
| 676 |
.\" The |
| 677 |
.\" .B el |
| 678 |
.\" request was encountered with no prior corresponding |
| 679 |
.\" .B ie |
| 680 |
.\" request. |
| 681 |
. |
| 682 |
. |
| 683 |
.sp \n[PD]u |
| 684 |
escape 32768 T{ |
| 685 |
An unsupported escape sequence was encountered. |
| 686 |
T} |
| 687 |
. |
| 688 |
. |
| 689 |
.sp \n[PD]u |
| 690 |
file 1048576 T{ |
| 691 |
An attempt was made to read a file that does not exist. |
| 692 |
or a stream remained open at formatter exit. |
| 693 |
. |
| 694 |
This category is enabled by default. |
| 695 |
T} |
| 696 |
. |
| 697 |
. |
| 698 |
.sp \n[PD]u |
| 699 |
font 131072 T{ |
| 700 |
A non-existent font was selected. |
| 701 |
. |
| 702 |
This category is enabled by default. |
| 703 |
T} |
| 704 |
. |
| 705 |
. |
| 706 |
.sp \n[PD]u |
| 707 |
ig 262144 T{ |
| 708 |
An invalid escape sequence occurred in input ignored using the |
| 709 |
.B ig |
| 710 |
request. |
| 711 |
. |
| 712 |
This warning category diagnoses a condition that is an error when it |
| 713 |
occurs in non-ignored input. |
| 714 |
T} |
| 715 |
. |
| 716 |
. |
| 717 |
.sp \n[PD]u |
| 718 |
input 16384 T{ |
| 719 |
An invalid character occurred on the input stream. |
| 720 |
T} |
| 721 |
. |
| 722 |
. |
| 723 |
.sp \n[PD]u |
| 724 |
mac 512 T{ |
| 725 |
An undefined string, |
| 726 |
macro, |
| 727 |
or diversion was used. |
| 728 |
. |
| 729 |
When such an object is dereferenced, |
| 730 |
an empty one of that name is automatically created. |
| 731 |
. |
| 732 |
So, |
| 733 |
unless it is later deleted, |
| 734 |
.I \%troff |
| 735 |
issues at most one warning for each. |
| 736 |
. |
| 737 |
. |
| 738 |
.sp \n[PD]u |
| 739 |
.I \%troff |
| 740 |
also uses this category to warn of an attempt to move an unplanted trap |
| 741 |
macro. |
| 742 |
. |
| 743 |
In such cases, |
| 744 |
the unplanted macro is |
| 745 |
.I not |
| 746 |
dereferenced, |
| 747 |
so it is not created if it does not exist. |
| 748 |
T} |
| 749 |
. |
| 750 |
. |
| 751 |
.sp \n[PD]u |
| 752 |
missing 8192 T{ |
| 753 |
A request was invoked with a mandatory argument absent. |
| 754 |
T} |
| 755 |
. |
| 756 |
. |
| 757 |
.\" .sp \n[PD]u |
| 758 |
.\" number 2 T{ |
| 759 |
.\" An invalid numeric expression was encountered. |
| 760 |
.\" . |
| 761 |
.\" This category is enabled by default. |
| 762 |
.\" T} |
| 763 |
. |
| 764 |
. |
| 765 |
.sp \n[PD]u |
| 766 |
range 64 T{ |
| 767 |
A numeric expression was out of range for its context. |
| 768 |
T} |
| 769 |
. |
| 770 |
. |
| 771 |
.sp \n[PD]u |
| 772 |
reg 1024 T{ |
| 773 |
An undefined register was used. |
| 774 |
. |
| 775 |
When an undefined register is dereferenced, |
| 776 |
the formatter automatically defines it with a value of\~0. |
| 777 |
. |
| 778 |
So, |
| 779 |
unless it is later deleted, |
| 780 |
GNU |
| 781 |
.I troff \" GNU |
| 782 |
issues at most one warning for each. |
| 783 |
T} |
| 784 |
. |
| 785 |
. |
| 786 |
.\" .sp \n[PD]u |
| 787 |
.\" right\-brace 4096 T{ |
| 788 |
.\" A right brace escape sequence |
| 789 |
.\" .B \[rs]} |
| 790 |
.\" was encountered where a number was expected. |
| 791 |
.\" T} |
| 792 |
. |
| 793 |
. |
| 794 |
.sp \n[PD]u |
| 795 |
scale 32 T{ |
| 796 |
A scaling unit inappropriate to its context was used in a numeric |
| 797 |
expression. |
| 798 |
T} |
| 799 |
. |
| 800 |
. |
| 801 |
.sp \n[PD]u |
| 802 |
space 65536 T{ |
| 803 |
A space was missing between a request or macro and its argument. |
| 804 |
. |
| 805 |
This warning is produced when an undefined name longer than two |
| 806 |
characters is encountered and the first two characters of the name |
| 807 |
constitute a defined name. |
| 808 |
. |
| 809 |
No request is invoked, |
| 810 |
no macro called, |
| 811 |
and an empty macro is not defined. |
| 812 |
. |
| 813 |
This category is enabled by default. |
| 814 |
. |
| 815 |
It never occurs in compatibility mode. |
| 816 |
T} |
| 817 |
. |
| 818 |
. |
| 819 |
.sp \n[PD]u |
| 820 |
syntax 128 T{ |
| 821 |
A self-contradictory hyphenation mode or character flags were requested; |
| 822 |
an empty or incomplete numeric expression was encountered; |
| 823 |
an operand to a numeric operator was missing; |
| 824 |
an attempt was made to format characters or spaces on an input line |
| 825 |
after an output line continuation escape sequence; |
| 826 |
a recognized but inapposite escape sequence |
| 827 |
or unprintable character code |
| 828 |
was used in a device extension command; |
| 829 |
an attempt was made to define a recursive, |
| 830 |
empty, |
| 831 |
or nonsensical character class; |
| 832 |
or a |
| 833 |
.I groff |
| 834 |
extension escape sequence |
| 835 |
or conditional expression operator |
| 836 |
was used while in compatibility mode. |
| 837 |
T} |
| 838 |
. |
| 839 |
. |
| 840 |
.sp \n[PD]u |
| 841 |
tab 2048 T{ |
| 842 |
A tab character appeared |
| 843 |
in a parameterized escape sequence, |
| 844 |
in an unquoted macro argument, |
| 845 |
or where a request expected a numeric expression argument. |
| 846 |
T} |
| 847 |
.TE |
| 848 |
. |
| 849 |
. |
| 850 |
.P |
| 851 |
Two warning names group other warning categories for convenience. |
| 852 |
. |
| 853 |
. |
| 854 |
.TP |
| 855 |
.B all |
| 856 |
All warning categories except |
| 857 |
.BR di , |
| 858 |
.BR mac , |
| 859 |
and |
| 860 |
.BR reg . |
| 861 |
. |
| 862 |
This shorthand is intended to produce all warnings that are useful with |
| 863 |
macro packages and documents written for AT&T |
| 864 |
.I troff \" AT&T |
| 865 |
and its descendants, |
| 866 |
which have less fastidious diagnostics than GNU |
| 867 |
.IR troff . \" GNU |
| 868 |
. |
| 869 |
. |
| 870 |
.TP |
| 871 |
.B w |
| 872 |
All warning categories. |
| 873 |
. |
| 874 |
Authors of documents and macro packages targeting |
| 875 |
.I groff |
| 876 |
are encouraged to use this setting. |
| 877 |
.\" END Keep parallel with groff.texi node "Warnings". |
| 878 |
. |
| 879 |
. |
| 880 |
.\" ==================================================================== |
| 881 |
.SH "Exit status" |
| 882 |
.\" ==================================================================== |
| 883 |
. |
| 884 |
.I \%troff |
| 885 |
exits with |
| 886 |
.RB status\~ 0 |
| 887 |
on successful operation, |
| 888 |
.RB status\~ 2 |
| 889 |
if the program cannot interpret its command-line arguments, |
| 890 |
and |
| 891 |
.RB status\~ 1 |
| 892 |
if it encounters a fatal error during operation, |
| 893 |
or is directed to abort by the input. |
| 894 |
. |
| 895 |
. |
| 896 |
.\" ==================================================================== |
| 897 |
.SH Environment |
| 898 |
.\" ==================================================================== |
| 899 |
. |
| 900 |
.I GROFF_FONT_PATH |
| 901 |
and |
| 902 |
.I GROFF_TMAC_PATH |
| 903 |
each accept a search path of directories; |
| 904 |
that is, |
| 905 |
a list of directory names separated by the system's path component |
| 906 |
separator character. |
| 907 |
. |
| 908 |
On Unix systems, |
| 909 |
this character is a colon (:); |
| 910 |
on Windows systems, |
| 911 |
it is a semicolon (;). |
| 912 |
. |
| 913 |
. |
| 914 |
.TP |
| 915 |
.I GROFF_FONT_PATH |
| 916 |
A list of directories in which to seek the selected output device's |
| 917 |
directory of device and font description files. |
| 918 |
. |
| 919 |
.I \%troff |
| 920 |
will scan directories given as arguments to any specified |
| 921 |
.B \-F |
| 922 |
options before these, |
| 923 |
then in a site-specific directory |
| 924 |
.RI ( /usr/\:\%share/\:\%groff/\:\%site\-font ), |
| 925 |
a standard location |
| 926 |
.RI ( /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%font ), |
| 927 |
and a compatibility directory |
| 928 |
.RI ( /usr/\:\%lib/\:\%font ) |
| 929 |
after them. |
| 930 |
. |
| 931 |
. |
| 932 |
.TP |
| 933 |
.I GROFF_TMAC_PATH |
| 934 |
A list of directories in which to search for macro files. |
| 935 |
. |
| 936 |
.I \%troff |
| 937 |
will scan directories given as arguments to any specified |
| 938 |
.B \-M |
| 939 |
options before these, |
| 940 |
then the current directory |
| 941 |
(only if in unsafe mode), |
| 942 |
the user's home directory, |
| 943 |
.if !'no'no' \{\ |
| 944 |
a platform-specific directory |
| 945 |
.RI ( /usr/\:\%lib/\:\%groff/\:\%site\-tmac ), |
| 946 |
.\} |
| 947 |
a site-specific directory |
| 948 |
.RI ( /usr/\:\%share/\:\%groff/\:\%site\-tmac ), |
| 949 |
and a standard location |
| 950 |
.RI ( /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac ) |
| 951 |
after them. |
| 952 |
. |
| 953 |
. |
| 954 |
.TP |
| 955 |
.I GROFF_TYPESETTER |
| 956 |
Set the default output device. |
| 957 |
. |
| 958 |
If empty or not set, |
| 959 |
.B \%ps |
| 960 |
is used. |
| 961 |
. |
| 962 |
The |
| 963 |
.B \-T |
| 964 |
option overrides |
| 965 |
.IR \%GROFF_TYPESETTER . |
| 966 |
. |
| 967 |
. |
| 968 |
.TP |
| 969 |
.I SOURCE_DATE_EPOCH |
| 970 |
A timestamp |
| 971 |
(expressed as seconds since the Unix epoch) |
| 972 |
to use as the output creation timestamp in place of the current time. |
| 973 |
. |
| 974 |
The time is converted to human-readable form using |
| 975 |
.MR gmtime 3 |
| 976 |
and |
| 977 |
.MR asctime 3 |
| 978 |
when the formatter starts up and stored in registers usable by documents |
| 979 |
and macro packages. |
| 980 |
. |
| 981 |
. |
| 982 |
.TP |
| 983 |
.I TZ |
| 984 |
The time zone to use when converting the current time to human-readable form; |
| 985 |
see |
| 986 |
.MR tzset 3 . |
| 987 |
If |
| 988 |
.I SOURCE_DATE_EPOCH |
| 989 |
is used, it is always converted to human-readable form using UTC. |
| 990 |
. |
| 991 |
. |
| 992 |
.\" ==================================================================== |
| 993 |
.SH Files |
| 994 |
.\" ==================================================================== |
| 995 |
. |
| 996 |
.TP |
| 997 |
.I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/\:\%troffrc |
| 998 |
is an initialization macro file loaded before any macro packages |
| 999 |
specified with |
| 1000 |
.B \-m |
| 1001 |
options. |
| 1002 |
. |
| 1003 |
. |
| 1004 |
.TP |
| 1005 |
.I /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/\:\%troffrc\-end |
| 1006 |
is an initialization macro file loaded after all macro packages |
| 1007 |
specified with |
| 1008 |
.B \-m |
| 1009 |
options. |
| 1010 |
. |
| 1011 |
. |
| 1012 |
.TP |
| 1013 |
.IR /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%tmac/\: name \:.tmac |
| 1014 |
are macro files distributed with |
| 1015 |
.IR groff . |
| 1016 |
. |
| 1017 |
. |
| 1018 |
.TP |
| 1019 |
.IR /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%font/\:\%dev name /\:DESC |
| 1020 |
describes the output device |
| 1021 |
.IR name . |
| 1022 |
. |
| 1023 |
. |
| 1024 |
.TP |
| 1025 |
.IR /usr/\:\%share/\:\%groff/\:\%1.24.1/\:\%font/\:\%dev name / F |
| 1026 |
describes the font |
| 1027 |
.I F |
| 1028 |
of device |
| 1029 |
.I name. |
| 1030 |
. |
| 1031 |
. |
| 1032 |
.P |
| 1033 |
.I troffrc |
| 1034 |
and |
| 1035 |
.I troffrc\-end |
| 1036 |
are sought neither in the current nor the home directory by default for |
| 1037 |
security reasons, |
| 1038 |
even if the |
| 1039 |
.B \-U |
| 1040 |
option is specified. |
| 1041 |
. |
| 1042 |
Use the |
| 1043 |
.B \-M |
| 1044 |
command-line option or the |
| 1045 |
.I GROFF_TMAC_PATH |
| 1046 |
environment variable to add these directories to the search path if |
| 1047 |
necessary. |
| 1048 |
. |
| 1049 |
. |
| 1050 |
.\" ==================================================================== |
| 1051 |
.SH Authors |
| 1052 |
.\" ==================================================================== |
| 1053 |
. |
| 1054 |
The GNU version of |
| 1055 |
.I troff \" generic |
| 1056 |
was originally written by James Clark; |
| 1057 |
he also wrote the original version of this document, |
| 1058 |
which was updated by |
| 1059 |
.MT wl@\:gnu\:.org |
| 1060 |
Werner Lemberg |
| 1061 |
.ME , |
| 1062 |
.MT groff\-bernd\:.warken\-72@\:web\:.de |
| 1063 |
Bernd Warken |
| 1064 |
.ME , |
| 1065 |
and |
| 1066 |
.MT g.branden\:.robinson@\:gmail\:.com |
| 1067 |
G.\& Branden Robinson |
| 1068 |
.ME . |
| 1069 |
. |
| 1070 |
. |
| 1071 |
.\" ==================================================================== |
| 1072 |
.SH "See also" |
| 1073 |
.\" ==================================================================== |
| 1074 |
. |
| 1075 |
.IR "Groff: The GNU Implementation of troff" , |
| 1076 |
by Trent A.\& Fisher and Werner Lemberg, |
| 1077 |
is the primary |
| 1078 |
.I groff |
| 1079 |
manual. |
| 1080 |
. |
| 1081 |
You can browse it interactively with \[lq]info groff\[rq]. |
| 1082 |
. |
| 1083 |
. |
| 1084 |
.TP |
| 1085 |
.MR groff 1 |
| 1086 |
offers an overview of the GNU |
| 1087 |
.I roff |
| 1088 |
system |
| 1089 |
and describes its front end executable. |
| 1090 |
. |
| 1091 |
. |
| 1092 |
.TP |
| 1093 |
.MR groff 7 |
| 1094 |
details the |
| 1095 |
.I groff |
| 1096 |
language, |
| 1097 |
including a short but complete reference of all predefined requests, |
| 1098 |
registers, |
| 1099 |
and escape sequences. |
| 1100 |
. |
| 1101 |
. |
| 1102 |
.TP |
| 1103 |
.MR groff_char 7 |
| 1104 |
explains the syntax of |
| 1105 |
.I groff |
| 1106 |
special character escape sequences, |
| 1107 |
and lists all special characters predefined by the language. |
| 1108 |
. |
| 1109 |
. |
| 1110 |
.TP |
| 1111 |
.MR groff_diff 7 |
| 1112 |
enumerates the differences between |
| 1113 |
AT&T device-independent |
| 1114 |
.I troff \" AT&T |
| 1115 |
and |
| 1116 |
.IR groff . |
| 1117 |
. |
| 1118 |
. |
| 1119 |
.TP |
| 1120 |
.MR groff_font 5 |
| 1121 |
covers the format of |
| 1122 |
.I groff |
| 1123 |
device and font description files. |
| 1124 |
. |
| 1125 |
. |
| 1126 |
.TP |
| 1127 |
.MR groff_out 5 |
| 1128 |
describes the format of |
| 1129 |
.IR \%troff 's |
| 1130 |
output. |
| 1131 |
. |
| 1132 |
. |
| 1133 |
.TP |
| 1134 |
.MR groff_tmac 5 |
| 1135 |
includes information about macro files that ship with |
| 1136 |
.IR groff . |
| 1137 |
. |
| 1138 |
. |
| 1139 |
.TP |
| 1140 |
.MR roff 7 |
| 1141 |
supplies background on |
| 1142 |
.I roff |
| 1143 |
systems in general, |
| 1144 |
including pointers to further related documentation. |
| 1145 |
. |
| 1146 |
. |
| 1147 |
.\" Restore compatibility mode (for, e.g., Solaris 10/11). |
| 1148 |
.cp \n[*groff_troff_1_man_C] |
| 1149 |
.do rr *groff_troff_1_man_C |
| 1150 |
. |
| 1151 |
. |
| 1152 |
.\" Local Variables: |
| 1153 |
.\" fill-column: 72 |
| 1154 |
.\" mode: nroff |
| 1155 |
.\" End: |
| 1156 |
.\" vim: set filetype=groff textwidth=72: |