| 1 |
.TH pdfroff 1 "3 June 2025" "groff 1.23.0" |
| 2 |
.SH Name |
| 3 |
pdfroff \- construct files in Portable Document Format using |
| 4 |
.I groff |
| 5 |
. |
| 6 |
. |
| 7 |
.\" ==================================================================== |
| 8 |
.\" Legal Terms |
| 9 |
.\" ==================================================================== |
| 10 |
.\" |
| 11 |
.\" Copyright (C) 2005-2020 Free Software Foundation, Inc. |
| 12 |
.\" |
| 13 |
.\" This file is part of groff, the GNU roff type-setting system. |
| 14 |
.\" |
| 15 |
.\" Permission is granted to copy, distribute and/or modify this |
| 16 |
.\" document under the terms of the GNU Free Documentation License, |
| 17 |
.\" Version 1.3 or any later version published by the Free Software |
| 18 |
.\" Foundation; with no Invariant Sections, with no Front-Cover Texts, |
| 19 |
.\" and with no Back-Cover Texts. |
| 20 |
.\" |
| 21 |
.\" A copy of the Free Documentation License is included as a file |
| 22 |
.\" called FDL in the main directory of the groff source package. |
| 23 |
.\" |
| 24 |
.\" A copy of the GNU Free Documentation License is also available in this |
| 25 |
.\" Debian package as /usr/share/doc/groff/copyright. |
| 26 |
. |
| 27 |
. |
| 28 |
.\" Save and disable compatibility mode (for, e.g., Solaris 10/11). |
| 29 |
.do nr *groff_pdfroff_1_man_C \n[.cp] |
| 30 |
.cp 0 |
| 31 |
. |
| 32 |
.\" Define fallback for groff 1.23's MR macro if the system lacks it. |
| 33 |
.nr do-fallback 0 |
| 34 |
.if !\n(.f .nr do-fallback 1 \" mandoc |
| 35 |
.if \n(.g .if !d MR .nr do-fallback 1 \" older groff |
| 36 |
.if !\n(.g .nr do-fallback 1 \" non-groff *roff |
| 37 |
.if \n[do-fallback] \{\ |
| 38 |
. de MR |
| 39 |
. ie \\n(.$=1 \ |
| 40 |
. I \%\\$1 |
| 41 |
. el \ |
| 42 |
. IR \%\\$1 (\\$2)\\$3 |
| 43 |
. . |
| 44 |
.\} |
| 45 |
.rr do-fallback |
| 46 |
. |
| 47 |
. |
| 48 |
.\" ==================================================================== |
| 49 |
.SH Synopsis |
| 50 |
.\" ==================================================================== |
| 51 |
. |
| 52 |
.SY pdfroff |
| 53 |
.RI [ groff-option ] |
| 54 |
.RB [ \-\-emit\-ps ] |
| 55 |
.RB [ \-\-no\-toc\-relocation ] |
| 56 |
.RB [ \-\-no\-kill\-null\-pages ] |
| 57 |
.RB [ \-\-stylesheet=\c |
| 58 |
.IR name ] |
| 59 |
.RB [ \-\-no\-pdf\-output ] |
| 60 |
.RB [ \-\-pdf\-output=\c |
| 61 |
.IR name ] |
| 62 |
.RB [ \-\-no\-reference\-dictionary ] |
| 63 |
.RB [ \-\-reference\-dictionary=\c |
| 64 |
.IR name ] |
| 65 |
.RB [ \-\-report\-progress ] |
| 66 |
.RB [ \-\-keep\-temporary\-files ] |
| 67 |
.RI [ file\~ .\|.\|.] |
| 68 |
.YS |
| 69 |
. |
| 70 |
. |
| 71 |
.SY pdfroff |
| 72 |
.B \-h |
| 73 |
. |
| 74 |
.SY pdfroff |
| 75 |
.B \-\-help |
| 76 |
.YS |
| 77 |
. |
| 78 |
. |
| 79 |
.SY pdfroff |
| 80 |
.B \-v |
| 81 |
.RI [ groff-option |
| 82 |
\&.\|.\|.\&] |
| 83 |
. |
| 84 |
.SY pdfroff |
| 85 |
.B \-\-version |
| 86 |
.RI [ groff-option |
| 87 |
\&.\|.\|.\&] |
| 88 |
.YS |
| 89 |
. |
| 90 |
. |
| 91 |
.P |
| 92 |
.I groff-option |
| 93 |
is any short option supported by |
| 94 |
.MR groff 1 |
| 95 |
except for |
| 96 |
.BR \-h , |
| 97 |
.BR \-T , |
| 98 |
and |
| 99 |
.BR \-v ; |
| 100 |
see section \[lq]Usage\[rq] below. |
| 101 |
. |
| 102 |
. |
| 103 |
.\" ==================================================================== |
| 104 |
.SH Description |
| 105 |
.\" ==================================================================== |
| 106 |
. |
| 107 |
.I pdfroff |
| 108 |
is a wrapper program for the GNU text processing system, |
| 109 |
.IR groff . |
| 110 |
. |
| 111 |
It transparently handles the mechanics of multiple pass |
| 112 |
.I groff |
| 113 |
processing, |
| 114 |
when applied to suitably marked up |
| 115 |
.I groff |
| 116 |
source files, |
| 117 |
such that tables of contents and body text are formatted separately, |
| 118 |
and are subsequently combined in the correct order, |
| 119 |
for final publication as a single PDF document. |
| 120 |
. |
| 121 |
A further optional \[lq]style sheet\[rq] capability is provided; |
| 122 |
this allows for the definition of content which is required to precede |
| 123 |
the table of contents, |
| 124 |
in the published document. |
| 125 |
. |
| 126 |
. |
| 127 |
.P |
| 128 |
For each invocation of |
| 129 |
.IR pdfroff , |
| 130 |
the ultimate |
| 131 |
.I groff |
| 132 |
output stream is post-processed by the Ghostscript |
| 133 |
.MR gs 1 |
| 134 |
interpreter to produce a finished PDF document. |
| 135 |
. |
| 136 |
. |
| 137 |
.P |
| 138 |
.I pdfroff |
| 139 |
makes no assumptions about, |
| 140 |
and imposes no restrictions on, |
| 141 |
the use of any |
| 142 |
.I groff |
| 143 |
macro packages which the user may choose to employ, |
| 144 |
in order to achieve a desired document format; |
| 145 |
however, |
| 146 |
it |
| 147 |
.I does |
| 148 |
include specific built in support for the |
| 149 |
.I \%pdfmark |
| 150 |
macro package, |
| 151 |
should the user choose to employ it. |
| 152 |
. |
| 153 |
Specifically, |
| 154 |
if the |
| 155 |
.I pdfhref |
| 156 |
macro, |
| 157 |
defined in the |
| 158 |
.I \%pdfmark.tmac |
| 159 |
package, |
| 160 |
is used to define public reference marks, |
| 161 |
or dynamic links to such reference marks, |
| 162 |
then |
| 163 |
.I pdfroff |
| 164 |
performs as many preformatting |
| 165 |
.I groff |
| 166 |
passes as required, |
| 167 |
up to a maximum limit of |
| 168 |
.IR four , |
| 169 |
in order to compile a document reference dictionary, |
| 170 |
to resolve |
| 171 |
references, |
| 172 |
and to expand the dynamically defined content of links. |
| 173 |
. |
| 174 |
. |
| 175 |
.\" ==================================================================== |
| 176 |
.SH Usage |
| 177 |
.\" ==================================================================== |
| 178 |
. |
| 179 |
The command line is parsed in accordance with normal GNU conventions, |
| 180 |
but with one exception\(emwhen specifying any short form option |
| 181 |
(i.e., |
| 182 |
a single character option introduced by a single hyphen), |
| 183 |
and if that option expects an argument, |
| 184 |
then it |
| 185 |
.I must |
| 186 |
be specified independently |
| 187 |
(i.e., |
| 188 |
it may |
| 189 |
.I not |
| 190 |
be appended to any group of other single character short form options). |
| 191 |
. |
| 192 |
. |
| 193 |
.P |
| 194 |
Long form option names |
| 195 |
(i.e., |
| 196 |
those introduced by a double hyphen) |
| 197 |
may |
| 198 |
be abbreviated to their minimum length unambiguous initial substring. |
| 199 |
. |
| 200 |
. |
| 201 |
.P |
| 202 |
Otherwise, |
| 203 |
.I pdfroff |
| 204 |
usage closely mirrors that of |
| 205 |
.I groff |
| 206 |
itself. |
| 207 |
. |
| 208 |
Indeed, |
| 209 |
with the exception of the |
| 210 |
.BR \-h , |
| 211 |
.BR \-v , |
| 212 |
and |
| 213 |
.BI \-T \ dev |
| 214 |
short form options, |
| 215 |
and all long form options, |
| 216 |
which are parsed |
| 217 |
internally by |
| 218 |
.IR pdfroff , |
| 219 |
all options and file name arguments specified on the command line are |
| 220 |
passed on to |
| 221 |
.IR groff , |
| 222 |
to control the formatting of the PDF document. |
| 223 |
. |
| 224 |
Consequently, |
| 225 |
.I pdfroff |
| 226 |
accepts all options and arguments, |
| 227 |
as specified in |
| 228 |
.MR groff 1 , |
| 229 |
which may also be considered as the definitive reference for all |
| 230 |
standard |
| 231 |
.I pdfroff |
| 232 |
options and argument usage. |
| 233 |
. |
| 234 |
. |
| 235 |
.\" ==================================================================== |
| 236 |
.SH Options |
| 237 |
.\" ==================================================================== |
| 238 |
. |
| 239 |
.I pdfroff |
| 240 |
accepts all of the short form options |
| 241 |
(i.e., |
| 242 |
those introduced by a |
| 243 |
single hyphen), |
| 244 |
which are available with |
| 245 |
.I groff |
| 246 |
itself. |
| 247 |
. |
| 248 |
In most cases, |
| 249 |
these are simply passed transparently to |
| 250 |
.IR groff ; |
| 251 |
the following, |
| 252 |
however, |
| 253 |
are handled specially by |
| 254 |
.IR pdfroff . |
| 255 |
. |
| 256 |
. |
| 257 |
.TP |
| 258 |
.B \-h |
| 259 |
Same as |
| 260 |
.BR \-\-help ; |
| 261 |
see below. |
| 262 |
. |
| 263 |
. |
| 264 |
.TP |
| 265 |
.B \-i |
| 266 |
Process standard input, |
| 267 |
after all other specified input files. |
| 268 |
. |
| 269 |
This is passed transparently to |
| 270 |
.IR groff , |
| 271 |
but, |
| 272 |
if grouped with other options, |
| 273 |
it |
| 274 |
.I must |
| 275 |
be the first in the group. |
| 276 |
. |
| 277 |
Hiding it within a group breaks standard input processing, |
| 278 |
in the multiple-pass |
| 279 |
.I groff |
| 280 |
processing context of |
| 281 |
.IR pdfroff . |
| 282 |
. |
| 283 |
. |
| 284 |
.TP |
| 285 |
.BI \-T \ dev |
| 286 |
Only |
| 287 |
.B \-T\ ps |
| 288 |
is supported by |
| 289 |
.IR pdfroff . |
| 290 |
. |
| 291 |
Attempting to specify any other device causes |
| 292 |
.I pdfroff |
| 293 |
to abort. |
| 294 |
. |
| 295 |
. |
| 296 |
.TP |
| 297 |
.B \-v |
| 298 |
Same as |
| 299 |
.BR \-\-version ; |
| 300 |
see below. |
| 301 |
. |
| 302 |
. |
| 303 |
.P |
| 304 |
See |
| 305 |
.MR groff 1 |
| 306 |
for a description of all other short form options, |
| 307 |
which are |
| 308 |
transparently passed through |
| 309 |
.I pdfroff |
| 310 |
to |
| 311 |
.IR groff . |
| 312 |
. |
| 313 |
. |
| 314 |
.P |
| 315 |
All long form options |
| 316 |
(i.e., |
| 317 |
those introduced by a double hyphen) |
| 318 |
are interpreted locally by |
| 319 |
.IR pdfroff ; |
| 320 |
they are |
| 321 |
.I not |
| 322 |
passed on to |
| 323 |
.IR groff , |
| 324 |
unless otherwise stated below. |
| 325 |
. |
| 326 |
. |
| 327 |
.TP |
| 328 |
.B \-\-help |
| 329 |
Causes |
| 330 |
.I pdfroff |
| 331 |
to display a summary of the its usage syntax, |
| 332 |
and supported options, |
| 333 |
and then exit. |
| 334 |
. |
| 335 |
. |
| 336 |
.TP |
| 337 |
.B \-\-emit\-ps |
| 338 |
Suppresses the final output conversion step, |
| 339 |
causing |
| 340 |
.I pdfroff |
| 341 |
to emit PostScript output instead of PDF. |
| 342 |
. |
| 343 |
This may be useful to capture intermediate PostScript output when using |
| 344 |
a specialised postprocessor, |
| 345 |
such as |
| 346 |
.I gpresent |
| 347 |
for example, |
| 348 |
in place of the default Ghostscript PDF writer. |
| 349 |
. |
| 350 |
. |
| 351 |
.TP |
| 352 |
.B \-\-keep\-temporary\-files |
| 353 |
Suppresses the deletion of temporary files, |
| 354 |
which normally occurs |
| 355 |
after |
| 356 |
.I pdfroff |
| 357 |
has completed PDF document formatting; |
| 358 |
this may be useful when debugging formatting problems. |
| 359 |
. |
| 360 |
. |
| 361 |
.IP |
| 362 |
See section \[lq]Files\[rq] below for a description of the temporary |
| 363 |
files used by |
| 364 |
.IR pdfroff . |
| 365 |
. |
| 366 |
. |
| 367 |
.TP |
| 368 |
.B \-\-no\-pdf\-output |
| 369 |
May be used with the |
| 370 |
.BI \%\-\-reference\-dictionary= name |
| 371 |
option |
| 372 |
(described below) |
| 373 |
to eliminate the overhead of PDF formatting when running |
| 374 |
.I pdfroff |
| 375 |
to create a reference dictionary for use in a different document. |
| 376 |
. |
| 377 |
. |
| 378 |
.TP |
| 379 |
.B \-\-no\-reference\-dictionary |
| 380 |
May be used to eliminate the overhead of creating a reference |
| 381 |
dictionary, |
| 382 |
when it is known that the target PDF document contains no public |
| 383 |
references, |
| 384 |
created by the |
| 385 |
.B pdfhref |
| 386 |
macro. |
| 387 |
. |
| 388 |
. |
| 389 |
.TP |
| 390 |
.B \-\-no\-toc\-relocation |
| 391 |
May be used to eliminate the extra |
| 392 |
.I groff |
| 393 |
processing pass, |
| 394 |
which is required to generate a table of contents, |
| 395 |
and relocate it to the start of the PDF document, |
| 396 |
when processing any document which lacks an automatically |
| 397 |
generated table of contents. |
| 398 |
. |
| 399 |
. |
| 400 |
.TP |
| 401 |
.B \-\-no\-kill\-null\-pages |
| 402 |
While preparing for simulation of the manual collation step, |
| 403 |
which is traditionally required to relocate a |
| 404 |
.I "table of contents" |
| 405 |
to the start of a document, |
| 406 |
.I pdfroff |
| 407 |
accumulates a number of empty page descriptions |
| 408 |
into the intermediate PostScript output stream. |
| 409 |
. |
| 410 |
During the final collation step, |
| 411 |
these empty pages are normally discarded from the finished document; |
| 412 |
this option forces |
| 413 |
.I pdfroff |
| 414 |
to leave them in place. |
| 415 |
. |
| 416 |
. |
| 417 |
.TP |
| 418 |
.BI \-\-pdf\-output= name |
| 419 |
Specifies the name to be used for the resultant PDF document; |
| 420 |
if unspecified, |
| 421 |
the PDF output is written to standard output. |
| 422 |
. |
| 423 |
A future version of |
| 424 |
.I pdfroff |
| 425 |
may use this option, |
| 426 |
to encode the document name in a generated reference dictionary. |
| 427 |
. |
| 428 |
. |
| 429 |
.TP |
| 430 |
.BI \-\-reference\-dictionary= name |
| 431 |
Specifies the name to be used for the generated reference dictionary |
| 432 |
file; |
| 433 |
if unspecified, |
| 434 |
the reference dictionary is created in a temporary file, |
| 435 |
which is deleted when |
| 436 |
.I pdfroff |
| 437 |
completes processing of the current document. |
| 438 |
. |
| 439 |
This option |
| 440 |
.I must |
| 441 |
be specified, |
| 442 |
if it is desired to save the reference dictionary, |
| 443 |
for use in references placed in other PDF documents. |
| 444 |
. |
| 445 |
. |
| 446 |
.TP |
| 447 |
.B \-\-report\-progress |
| 448 |
Causes |
| 449 |
.I pdfroff |
| 450 |
to display an informational message on standard error, |
| 451 |
at the start of each |
| 452 |
.I groff |
| 453 |
processing pass. |
| 454 |
. |
| 455 |
. |
| 456 |
.TP |
| 457 |
.BI \-\-stylesheet= name |
| 458 |
Specifies the name of an |
| 459 |
.IR "input file" , |
| 460 |
to be used as a style sheet for formatting of content, |
| 461 |
which is to be placed |
| 462 |
.I before |
| 463 |
the table of contents, |
| 464 |
in the formatted PDF document. |
| 465 |
. |
| 466 |
. |
| 467 |
.TP |
| 468 |
.B \-\-version |
| 469 |
Causes |
| 470 |
.I pdfroff |
| 471 |
to display a version identification message. |
| 472 |
. |
| 473 |
The entire command line is then passed transparently to |
| 474 |
.IR groff , |
| 475 |
in a |
| 476 |
.I one |
| 477 |
pass operation |
| 478 |
.IR only , |
| 479 |
in order to display the associated |
| 480 |
.I groff |
| 481 |
version information, |
| 482 |
before exiting. |
| 483 |
. |
| 484 |
. |
| 485 |
.\" ==================================================================== |
| 486 |
.SH Environment |
| 487 |
.\" ==================================================================== |
| 488 |
. |
| 489 |
The following environment variables may be set, |
| 490 |
and exported, |
| 491 |
to modify the behaviour of |
| 492 |
.IR pdfroff . |
| 493 |
. |
| 494 |
. |
| 495 |
.TP |
| 496 |
.I PDFROFF_COLLATE |
| 497 |
Specifies the program to be used |
| 498 |
for collation of the finished PDF document. |
| 499 |
. |
| 500 |
. |
| 501 |
.IP |
| 502 |
This collation step may be required to move |
| 503 |
.I tables of contents |
| 504 |
to the start of the finished PDF document, |
| 505 |
when formatting with traditional macro packages, |
| 506 |
which print them at the end. |
| 507 |
. |
| 508 |
However, |
| 509 |
users should not normally need to specify |
| 510 |
.IR \%PDFROFF_COLLATE , |
| 511 |
(and indeed, |
| 512 |
are not encouraged to do so). |
| 513 |
. |
| 514 |
If unspecified, |
| 515 |
.I pdfroff |
| 516 |
uses |
| 517 |
.MR sed 1 |
| 518 |
by default, |
| 519 |
which normally suffices. |
| 520 |
. |
| 521 |
. |
| 522 |
.IP |
| 523 |
If |
| 524 |
.I \%PDFROFF_COLLATE |
| 525 |
.I is |
| 526 |
specified, |
| 527 |
then it must act as a filter, |
| 528 |
accepting a list of file name arguments, |
| 529 |
and write its output to the standard output stream, |
| 530 |
whence it is piped to the |
| 531 |
.IR \%PDFROFF_POSTPROCESSOR_COMMAND , |
| 532 |
to produce the finished PDF output. |
| 533 |
. |
| 534 |
. |
| 535 |
.IP |
| 536 |
When specifying |
| 537 |
.IR \%PDFROFF_COLLATE , |
| 538 |
it is normally necessary to also specify |
| 539 |
.IR \%PDFROFF_KILL_NULL_PAGES . |
| 540 |
. |
| 541 |
. |
| 542 |
.IP |
| 543 |
.I \%PDFROFF_COLLATE |
| 544 |
is ignored, |
| 545 |
if |
| 546 |
.I pdfroff |
| 547 |
is invoked with the |
| 548 |
.B \%\-\-no\-kill\-null\-pages |
| 549 |
option. |
| 550 |
. |
| 551 |
. |
| 552 |
.TP |
| 553 |
.I PDFROFF_KILL_NULL_PAGES |
| 554 |
Specifies options to be passed to the |
| 555 |
.I \%PDFROFF_COLLATE |
| 556 |
program. |
| 557 |
. |
| 558 |
. |
| 559 |
.IP |
| 560 |
It should not normally be necessary to specify |
| 561 |
.IR \%PDFROFF_KILL_NULL_PAGES . |
| 562 |
. |
| 563 |
The internal default is a |
| 564 |
.MR sed 1 |
| 565 |
script, |
| 566 |
which is intended to remove completely blank pages |
| 567 |
from the collated output stream, |
| 568 |
and which should be appropriate in most applications of |
| 569 |
.IR pdfroff . |
| 570 |
. |
| 571 |
However, |
| 572 |
if any alternative to |
| 573 |
.MR sed 1 |
| 574 |
is specified for |
| 575 |
.IR \%PDFROFF_COLLATE , |
| 576 |
then it is likely that a corresponding alternative specification for |
| 577 |
.I \%PDFROFF_KILL_NULL_PAGES |
| 578 |
is required. |
| 579 |
. |
| 580 |
. |
| 581 |
.IP |
| 582 |
As in the case of |
| 583 |
.IR \%PDFROFF_COLLATE , |
| 584 |
.I \%PDFROFF_KILL_NULL_PAGES |
| 585 |
is ignored, |
| 586 |
if |
| 587 |
.I pdfroff |
| 588 |
is invoked with the |
| 589 |
.B \%\-\-no\-kill\-null\-pages |
| 590 |
option. |
| 591 |
. |
| 592 |
. |
| 593 |
.TP |
| 594 |
.I PDFROFF_POSTPROCESSOR_COMMAND |
| 595 |
Specifies the command to be used for the final document conversion |
| 596 |
from PostScript intermediate output to PDF. |
| 597 |
. |
| 598 |
It must behave as a filter, |
| 599 |
writing its output to the standard output stream, |
| 600 |
and must accept an arbitrary number of |
| 601 |
.I files .\|.\|.\& |
| 602 |
arguments, |
| 603 |
with the special case of |
| 604 |
.RB \[lq] \- \[rq] |
| 605 |
representing the standard input stream. |
| 606 |
. |
| 607 |
. |
| 608 |
.IP |
| 609 |
If unspecified, |
| 610 |
.I \%PDFROFF_POSTPROCESSOR_COMMAND |
| 611 |
defaults to |
| 612 |
. |
| 613 |
.RS 12n |
| 614 |
.EX |
| 615 |
gs \-dBATCH \-dQUIET \-dNOPAUSE \-dSAFER \-sDEVICE=pdfwrite \e |
| 616 |
\-sOutputFile=\- |
| 617 |
.EE |
| 618 |
.RE |
| 619 |
. |
| 620 |
. |
| 621 |
.TP |
| 622 |
.I GROFF_TMPDIR |
| 623 |
Identifies the directory in which |
| 624 |
.I pdfroff |
| 625 |
should create temporary files. |
| 626 |
. |
| 627 |
If |
| 628 |
.I \%GROFF_TMPDIR |
| 629 |
is |
| 630 |
.I not |
| 631 |
specified, |
| 632 |
then the variables |
| 633 |
.IR TMPDIR , |
| 634 |
.I TMP |
| 635 |
and |
| 636 |
.I TEMP |
| 637 |
are considered in turn as possible temporary file repositories. |
| 638 |
. |
| 639 |
If none of these are set, |
| 640 |
then temporary files are created |
| 641 |
in the current directory. |
| 642 |
. |
| 643 |
. |
| 644 |
.TP |
| 645 |
.I GROFF_GHOSTSCRIPT_INTERPRETER |
| 646 |
Specifies the program to be invoked when |
| 647 |
.I pdfroff |
| 648 |
converts |
| 649 |
.I groff |
| 650 |
PostScript output to PDF. |
| 651 |
. |
| 652 |
If |
| 653 |
.I \%PDFROFF_POSTPROCESSOR_COMMAND |
| 654 |
is specified, |
| 655 |
then the command name it specifies is |
| 656 |
.I implicitly |
| 657 |
assigned to |
| 658 |
.IR \%GROFF_GHOSTSCRIPT_INTERPRETER , |
| 659 |
overriding any explicit setting specified in the environment. |
| 660 |
. |
| 661 |
If |
| 662 |
.I \%GROFF_GHOSTSCRIPT_INTERPRETER |
| 663 |
is not specified, |
| 664 |
then |
| 665 |
.I pdfroff |
| 666 |
searches the process |
| 667 |
.IR PATH , |
| 668 |
looking for a program with any of the well known names |
| 669 |
for the Ghostscript interpreter; |
| 670 |
if no Ghostscript interpreter can be found, |
| 671 |
.I pdfroff |
| 672 |
aborts. |
| 673 |
. |
| 674 |
. |
| 675 |
.TP |
| 676 |
.I GROFF_AWK_INTERPRETER |
| 677 |
Specifies the program to be invoked when |
| 678 |
.I pdfroff |
| 679 |
is extracting reference dictionary entries from a |
| 680 |
.I groff |
| 681 |
intermediate message stream. |
| 682 |
. |
| 683 |
If |
| 684 |
.I \%GROFF_AWK_INTERPRETER |
| 685 |
is not specified, |
| 686 |
then |
| 687 |
.I pdfroff |
| 688 |
searches the process |
| 689 |
.IR PATH , |
| 690 |
looking for any of the preferred programs, |
| 691 |
.IR gawk , |
| 692 |
.IR mawk , |
| 693 |
.IR nawk , |
| 694 |
and |
| 695 |
.IR awk , |
| 696 |
in that order; |
| 697 |
if none of these are found, |
| 698 |
.I pdfroff |
| 699 |
issues a warning message, |
| 700 |
and continue processing; |
| 701 |
however, |
| 702 |
in this case, |
| 703 |
no reference dictionary is created. |
| 704 |
. |
| 705 |
. |
| 706 |
.TP |
| 707 |
.I OSTYPE |
| 708 |
Typically defined automatically by the operating system, |
| 709 |
.I \%OSTYPE |
| 710 |
is used on Microsoft Win32/MS-DOS platforms |
| 711 |
.IR only , |
| 712 |
to infer the default |
| 713 |
.I \%PATH_SEPARATOR |
| 714 |
character, |
| 715 |
which is used when parsing the process |
| 716 |
.I PATH |
| 717 |
to search for external helper programs. |
| 718 |
. |
| 719 |
. |
| 720 |
.TP |
| 721 |
.I PATH_SEPARATOR |
| 722 |
If set, |
| 723 |
.I \%PATH_SEPARATOR |
| 724 |
overrides the default separator character, |
| 725 |
(\[oq]:\[cq] on POSIX/Unix systems, |
| 726 |
inferred from |
| 727 |
.I \%OSTYPE |
| 728 |
on Microsoft Win32/MS-DOS), |
| 729 |
which is used when parsing the process |
| 730 |
.I PATH |
| 731 |
to search for external helper programs. |
| 732 |
. |
| 733 |
. |
| 734 |
.TP |
| 735 |
.I SHOW_PROGRESS |
| 736 |
If this is set to a non-empty value, |
| 737 |
then |
| 738 |
.I pdfroff |
| 739 |
always behaves as if the |
| 740 |
.B \%\-\-report\-progress |
| 741 |
option is specified on the command line. |
| 742 |
. |
| 743 |
. |
| 744 |
.\" ==================================================================== |
| 745 |
.SH Files |
| 746 |
.\" ==================================================================== |
| 747 |
. |
| 748 |
Input and output files for |
| 749 |
.I pdfroff |
| 750 |
may be named according to any convention of the user's choice. |
| 751 |
. |
| 752 |
Typically, |
| 753 |
input files may be named according to the choice of the principal |
| 754 |
normatting macro package, |
| 755 |
e.g., |
| 756 |
.RI file .ms |
| 757 |
might be an input file for formatting using the |
| 758 |
.I ms |
| 759 |
macros |
| 760 |
.RI ( s.tmac ); |
| 761 |
normally, |
| 762 |
the final output file should be named |
| 763 |
.RI file .pdf . |
| 764 |
. |
| 765 |
. |
| 766 |
.P |
| 767 |
Temporary files created by |
| 768 |
.I pdfroff |
| 769 |
are placed in the file system hierarchy, |
| 770 |
in or below the directory specified by environment variables |
| 771 |
(see section \[lq]Environment\[rq] above). |
| 772 |
. |
| 773 |
If |
| 774 |
.MR mktemp 1 |
| 775 |
is available, |
| 776 |
it is invoked to create a private subdirectory of |
| 777 |
the nominated temporary files directory, |
| 778 |
(with subdirectory name derived from the template |
| 779 |
.IR pdfroff\-XXXXXXXXXX ); |
| 780 |
if this subdirectory is successfully created, |
| 781 |
the temporary files will be placed within it, |
| 782 |
otherwise they will be placed directly in the directory |
| 783 |
nominated in the environment. |
| 784 |
. |
| 785 |
. |
| 786 |
.P |
| 787 |
All temporary files themselves |
| 788 |
are named according to the convention |
| 789 |
.IR pdf $$ . *, |
| 790 |
where |
| 791 |
.I $$ |
| 792 |
is the standard shell variable representing the process identifier of |
| 793 |
the |
| 794 |
.I pdfroff |
| 795 |
process itself, |
| 796 |
and |
| 797 |
.I * |
| 798 |
represents any of the extensions used by |
| 799 |
.I pdfroff |
| 800 |
to identify the following temporary and intermediate files. |
| 801 |
. |
| 802 |
. |
| 803 |
.TP |
| 804 |
.IR pdf $$ .tmp |
| 805 |
A scratch pad file, |
| 806 |
used to capture reference data emitted by |
| 807 |
.IR groff , |
| 808 |
during the |
| 809 |
.I reference dictionary |
| 810 |
compilation phase. |
| 811 |
. |
| 812 |
. |
| 813 |
.TP |
| 814 |
.IR pdf $$ .ref |
| 815 |
The |
| 816 |
.IR "reference dictionary" , |
| 817 |
as compiled in the last but one pass of the |
| 818 |
.I reference dictionary |
| 819 |
compilation phase; |
| 820 |
(at the start of the first pass, |
| 821 |
this file is created empty; |
| 822 |
in successive passes, |
| 823 |
it contains the |
| 824 |
.I reference dictionary |
| 825 |
entries, |
| 826 |
as collected in the preceding pass). |
| 827 |
. |
| 828 |
. |
| 829 |
.IP |
| 830 |
If the |
| 831 |
.BR \%\-\-reference\-dictionary =\c |
| 832 |
.I name |
| 833 |
option is specified, |
| 834 |
this intermediate file becomes permanent, |
| 835 |
and is named |
| 836 |
.IR name , |
| 837 |
rather than |
| 838 |
.IR pdf $$ .ref . |
| 839 |
. |
| 840 |
. |
| 841 |
.TP |
| 842 |
.IR pdf $$ .cmp |
| 843 |
Used to collect |
| 844 |
.I reference dictionary |
| 845 |
entries during the active pass of the |
| 846 |
.I reference dictionary |
| 847 |
compilation phase. |
| 848 |
. |
| 849 |
At the end of any pass, |
| 850 |
when the content of |
| 851 |
.IR pdf $$ .cmp |
| 852 |
compares as identical to |
| 853 |
.IR pdf $$ .ref , |
| 854 |
(or the corresponding file named by the |
| 855 |
.BR \%\-\-reference\-dictionary =\c |
| 856 |
.I name |
| 857 |
option), |
| 858 |
then |
| 859 |
.I reference dictionary |
| 860 |
compilation is terminated, |
| 861 |
and the |
| 862 |
.I document reference map |
| 863 |
is appended to this intermediate file, |
| 864 |
for inclusion in the final formatting passes. |
| 865 |
. |
| 866 |
. |
| 867 |
.TP |
| 868 |
.IR pdf $$ .tc |
| 869 |
An intermediate |
| 870 |
.I PostScript |
| 871 |
file, |
| 872 |
in which \[lq]Table of Contents\[rq] entries are collected, |
| 873 |
to facilitate relocation before the body text, |
| 874 |
on ultimate output to the |
| 875 |
.I Ghostscript |
| 876 |
postprocessor. |
| 877 |
. |
| 878 |
. |
| 879 |
.TP |
| 880 |
.IR pdf $$ .ps |
| 881 |
An intermediate |
| 882 |
.I PostScript |
| 883 |
file, |
| 884 |
in which the body text is collected prior to ultimate output to the |
| 885 |
.I Ghostscript |
| 886 |
postprocessor, |
| 887 |
in the proper sequence, |
| 888 |
.I after |
| 889 |
.IR pdf $$ .tc . |
| 890 |
. |
| 891 |
. |
| 892 |
.\" ==================================================================== |
| 893 |
.SH Authors |
| 894 |
.\" ==================================================================== |
| 895 |
. |
| 896 |
.I pdfroff |
| 897 |
was written by |
| 898 |
.MT keith\:.d\:.marshall@\:ntlworld\:.com |
| 899 |
Keith Marshall |
| 900 |
.ME , |
| 901 |
who maintains it at |
| 902 |
.UR https://\:osdn\:.net/\:users/\:keith/\:pf/\:\%groff-pdfmark/\ |
| 903 |
\:wiki/\:\%FrontPage |
| 904 |
his |
| 905 |
.I groff-pdfmark |
| 906 |
OSDN site |
| 907 |
.UE . |
| 908 |
. |
| 909 |
.IR groff 's |
| 910 |
version may be withdrawn in a future release. |
| 911 |
. |
| 912 |
. |
| 913 |
.\" ==================================================================== |
| 914 |
.SH "See also" |
| 915 |
.\" ==================================================================== |
| 916 |
. |
| 917 |
.IR "Groff: The GNU Implementation of troff" , |
| 918 |
by Trent A.\& Fisher and Werner Lemberg, |
| 919 |
is the primary |
| 920 |
.I groff |
| 921 |
manual. |
| 922 |
. |
| 923 |
You can browse it interactively with \[lq]info groff\[rq]. |
| 924 |
. |
| 925 |
. |
| 926 |
.P |
| 927 |
Since |
| 928 |
.I pdfroff |
| 929 |
provides a superset of all |
| 930 |
.I groff |
| 931 |
capabilities, |
| 932 |
the above manual, |
| 933 |
or its terser reference page, |
| 934 |
.MR groff 7 |
| 935 |
may also be considered definitive references to all |
| 936 |
.I standard |
| 937 |
capabilities of |
| 938 |
.IR pdfroff , |
| 939 |
with this document providing the reference to |
| 940 |
.IR pdfroff 's |
| 941 |
extended features. |
| 942 |
. |
| 943 |
. |
| 944 |
.P |
| 945 |
While |
| 946 |
.I pdfroff |
| 947 |
imposes neither any restriction on, |
| 948 |
nor any requirement for, |
| 949 |
the use of any specific |
| 950 |
.I groff |
| 951 |
macro package, |
| 952 |
a number of supplied macro packages, |
| 953 |
and in particular those associated with the package |
| 954 |
.IR \%pdfmark.tmac , |
| 955 |
are best suited for use with |
| 956 |
.I pdfroff |
| 957 |
as the preferred formatter. |
| 958 |
. |
| 959 |
. |
| 960 |
.TP |
| 961 |
.I /usr/\:\%share/\:\%doc/\:\%groff\-base/\:\%pdf/\:\%pdfmark.pdf.gz |
| 962 |
\[lq]Portable Document Format Publishing with GNU |
| 963 |
.IR Troff \[rq], |
| 964 |
by Keith Marshall, |
| 965 |
offers detailed documentation on the use of these packages. |
| 966 |
. |
| 967 |
This file, |
| 968 |
together with its source, |
| 969 |
.IR \%pdfmark.ms , |
| 970 |
is part of the |
| 971 |
.I groff |
| 972 |
distribution. |
| 973 |
. |
| 974 |
. |
| 975 |
.\" Restore compatibility mode (for, e.g., Solaris 10/11). |
| 976 |
.cp \n[*groff_pdfroff_1_man_C] |
| 977 |
.do rr *groff_pdfroff_1_man_C |
| 978 |
. |
| 979 |
. |
| 980 |
.\" Local Variables: |
| 981 |
.\" fill-column: 72 |
| 982 |
.\" mode: nroff |
| 983 |
.\" End: |
| 984 |
.\" vim: set filetype=groff textwidth=72: |