man/src-roff.1.in

   1 .ig
   2 @ @L_ROFF@.1
   3
   4 Copyright (c) 2014 - 2017 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
   5
   6 Copyright (C) 1989, 2002 - 2008
   7 Free Software Foundation, Inc.
   8 Rewritten in 2002 by Bernd Warken <bwarken@mayn.de>
   9
  10 Permission is granted to copy, distribute and/or modify this document
  11 under the terms of the GNU Free Documentation License, Version 1.1 or
  12 any later version published by the Free Software Foundation; with the
  13 Invariant Sections being this .ig-section and AUTHOR, with no
  14 Front-Cover Texts, and with no Back-Cover Texts.
  15
  16 You should have received a copy of the Free Documentation License
  17 as part of the file COPYING; also located in the main directory of the
  18 source package of this program.
  19 ..
  20 .
  21 .do nr __compat \n[.C]
  22 .cp 0
  23 .
  24 .\" Environment variable
  25 .de EnvVar
  26 .  SM
  27 .  BR \%\\$1 \\$2
  28 ..
  29 .\" `char or string'
  30 .de Quoted
  31 .  ft CR
  32 \[oq]\\$*\[cq]
  33 .  ft
  34 ..
  35 .
  36 .
  37 .TH @U_ROFF@ @MAN1EXT@ "@MDATE@" "@T_ROFF@ v@VERSION@"
  38 .
  39 .
  40 .\"
  41 .SH NAME
  42 @L_ROFF@ \- front-end for the @T_ROFF@ document formatting system
  43 .
  44 .\"
  45 .SH SYNOPSIS
  46 .
  47 .SY @L_ROFF@
  48 .OP \-abcegiklpstzCEGNRSUVZ
  49 .OP \-d cs
  50 .OP \-D arg
  51 .OP \-f fam
  52 .OP \-F dir
  53 .OP \-I dir
  54 .OP \-K arg
  55 .OP \-L arg
  56 .OP \-m name
  57 .OP \-M dir
  58 .OP \-n num
  59 .OP \-o list
  60 .OP \-P arg
  61 .OP \-r cn
  62 .OP \-T dev
  63 .OP \-w name
  64 .OP \-W name
  65 .RI [ file\~ .\|.\|.]
  66 .
  67 .SY @L_ROFF@
  68 .B \-h
  69 |
  70 .B \-\-help
  71 .
  72 .SY @L_ROFF@
  73 .B \-v
  74 |
  75 .B \-\-version
  76 .RI [ option\~ .\|.\|.]
  77 .YS
  78 .
  79 .\"
  80 .SH DESCRIPTION
  81 .
  82 This document describes the
  83 .B @L_ROFF@
  84 program, the main front-end for the
  85 .I @T_ROFF@
  86 document formatting system, which is a
  87 .BR @L_ROFF@ (@MAN7EXT@)
  88 implementation that has all features of the classical
  89 .IR roff ,
  90 but also adds extensions.
  91 .
  92 .P
  93 The
  94 .B @L_ROFF@
  95 program allows to control the whole
  96 .I @T_ROFF@
  97 system by command line options.
  98 .
  99 .\"
 100 .SH OPTIONS
 101 .
 102 Whitespace between a command line option and its argument is
 103 optional.
 104 .
 105 Options can be grouped behind a single `\-' (minus character).
 106 .
 107 A filename of
 108 .B \-
 109 (minus character) denotes the standard input.
 110 .
 111 .\"
 112 .SS Native @L_ROFF@ Options
 113 .
 114 The following options either do not exist for
 115 .B @L_TROFF@
 116 or are differently interpreted by
 117 .BR @L_ROFF@ .
 118 .
 119 .TP
 120 .BI \-D\  arg
 121 Set default input encoding used by
 122 .B @L_P_PRECONV@
 123 to
 124 .IR arg .
 125 Implies
 126 .BR \-k .
 127 .
 128 .TP
 129 .B \-e
 130 Preprocess with
 131 .BR @L_P_EQN@ .
 132 .
 133 .TP
 134 .B \-g
 135 Preprocess with
 136 .BR @L_P_GRN@ .
 137 .
 138 .TP
 139 .B \-G
 140 Preprocess with
 141 .BR grap .
 142 .
 143 .TP
 144 .B \-h
 145 .TQ
 146 .B \-\-help
 147 Print a help message.
 148 .
 149 .TP
 150 .BI \-I\  dir
 151 This option may be used to specify a directory to search for
 152 files (both those on the command line and those named in
 153 .B .psbb
 154 and
 155 .B .so
 156 requests, and
 157 .B \eX'ps: import'
 158 and
 159 .B \eX'ps: file'
 160 escapes).
 161 The current directory is always searched first.
 162 This option may be specified more than once;
 163 the directories are searched in the order specified.
 164 No directory search is performed for files specified using an absolute path.
 165 This option implies the
 166 .B \-s
 167 option.
 168 .
 169 .TP
 170 .B \-k
 171 Preprocess with
 172 .BR @L_P_PRECONV@ .
 173 This is run before any other preprocessor.
 174 .
 175 Please refer to
 176 .BR @L_P_PRECONV@ 's
 177 manual page for its behaviour if no
 178 .B \-K
 179 (or
 180 .BR \-D )
 181 option is specified.
 182 .
 183 .TP
 184 .BI \-K\  arg
 185 Set input encoding used by
 186 .B @L_P_PRECONV@
 187 to
 188 .IR arg .
 189 Implies
 190 .BR \-k .
 191 .
 192 .TP
 193 .B \-l
 194 Send the output to a spooler program for printing.
 195 The command that should be used for this is specified by the
 196 .B print
 197 command in the device description file, see
 198 .BR \%@L_ROFF@-font (@MAN5EXT@).
 199 If this command is not present, the output is piped into the
 200 .BR lpr (1)
 201 program by default.
 202 See options
 203 .B \-L
 204 and
 205 .BR \-X .
 206 .
 207 .TP
 208 .BI \-L\  arg
 209 Pass
 210 .I arg
 211 to the spooler program.
 212 Several arguments should be passed with a separate
 213 -L
 214 option each.
 215 Note that
 216 .B @L_ROFF@
 217 does not prepend
 218 `-'
 219 (a minus sign) to
 220 .I arg
 221 before passing it to the spooler program.
 222 .
 223 .TP
 224 .B \-N
 225 Don't allow newlines within
 226 .I @L_P_EQN@
 227 delimiters.
 228 This is the same as the
 229 .B \-N
 230 option in
 231 .BR @L_P_EQN@ .
 232 .
 233 .TP
 234 .B \-p
 235 Preprocess with
 236 .BR @L_P_PIC@ .
 237 .
 238 .TP
 239 .BI \-P\  \-option
 240 .TQ
 241 .BI \-P\  \-option \ \-P\  arg
 242 Pass
 243 .I \-option
 244 or
 245 .I "\-option\~arg"
 246 to the postprocessor.
 247 The option must be specified with the necessary preceding minus
 248 sign(s)
 249 .Quoted -
 250 or
 251 .Quoted --
 252 because
 253 .B @L_ROFF@
 254 does not prepend any dashes before passing it to the postprocessor.
 255 .
 256 .TP
 257 .B \-R
 258 Preprocess with
 259 .BR @L_P_REFER@ .
 260 .
 261 No mechanism is provided for passing arguments to
 262 .B @L_P_REFER@
 263 because most
 264 .B @L_P_REFER@
 265 options have equivalent language elements that can be specified within
 266 the document.
 267 See
 268 .BR \%@L_P_REFER@ (@MAN1EXT@)
 269 for more details.
 270 .
 271 .TP
 272 .B \-s
 273 Preprocess with
 274 .BR @L_P_SOELIM@ .
 275 .
 276 .TP
 277 .B \-S
 278 Safer mode.
 279 Pass the
 280 .B \-S
 281 option to
 282 .B @L_P_PIC@
 283 and disable the following
 284 .B @L_TROFF@
 285 requests:
 286 .BR .open ,
 287 .BR .opena ,
 288 .BR .pso ,
 289 .BR .sy ,
 290 and
 291 .BR .pi .
 292 For security reasons, safer mode is enabled by default.
 293 .
 294 .TP
 295 .B \-t
 296 Preprocess with
 297 .BR @L_P_TBL@ .
 298 .
 299 .TP
 300 .BI \-T\  dev
 301 Set output device to
 302 .IR dev .
 303 For this device,
 304 .B @L_TROFF@
 305 generates the
 306 .I intermediate
 307 .IR output ;
 308 see
 309 .BR \%@L_ROFF@-out (@MAN5EXT@).
 310 Then
 311 .B @L_ROFF@
 312 calls a postprocessor to convert
 313 .BR @L_TROFF@ 's
 314 .I intermediate output
 315 to its final format.
 316 Real devices in
 317 .B @L_ROFF@
 318 are
 319 .
 320 .RS
 321 .RS
 322 .TP
 323 dvi
 324 TeX DVI format (postprocessor is
 325 .BR @L_D_DVI@ ).
 326 .
 327 .TP
 328 html
 329 .TQ
 330 xhtml
 331 HTML and XHTML output (preprocessors are
 332 .B @L_P_SOELIM@
 333 and
 334 .BR \%@L_D_PREHTML@ ,
 335 postprocessor is
 336 .BR \%@L_D_POSTHTML@ ).
 337 .
 338 .TP
 339 ps
 340 PostScript output (postprocessor is
 341 .BR @L_D_PS@ ).
 342 .RE
 343 .RE
 344 .
 345 .IP
 346 For the following TTY output devices (postprocessor is always
 347 .BR @L_D_TTY@ ),
 348 .B \-T
 349 selects the output encoding:
 350 .
 351 .RS
 352 .RS
 353 .TP
 354 ascii
 355 7bit \f[CR]ASCII\f[].
 356 .
 357 .TP
 358 cp1047
 359 \%Latin-1 character set for EBCDIC hosts.
 360 .
 361 .TP
 362 latin1
 363 ISO \%8859-1.
 364 .
 365 .TP
 366 utf8
 367 Unicode character set in \%UTF-8 encoding.
 368 .RE
 369 .RE
 370 .
 371 .IP
 372 The default device is
 373 .BR @DEVICE@ .
 374 .
 375 .TP
 376 .B \-U
 377 Unsafe mode.
 378 .
 379 Reverts to the (old) unsafe behaviour; see option
 380 .BR \-S .
 381 .
 382 .TP
 383 .B \-v
 384 .TQ
 385 .B \-\-version
 386 Output version information (of all programs that would be run by the
 387 specified pipeline).
 388 .
 389 .TP
 390 .B \-V
 391 Output the pipeline that would be run on the standard output, but do not
 392 execute it.
 393 If given more than once,
 394 the commands are both printed on the standard error and run.
 395 .
 396 .TP
 397 .B \-z
 398 Suppress output generated by
 399 .BR @L_TROFF@ .
 400 Only error messages are printed.
 401 .
 402 .TP
 403 .B \-Z
 404 Do not automatically postprocess intermediate output in the usual manner.
 405 This will cause
 406 .B @L_TROFF@
 407 output to appear on standard output,
 408 replacing the usual postprocessor output; see
 409 .BR \%@L_ROFF@-out (@MAN5EXT@).
 410 .
 411 .\"
 412 .SS Transparent Options
 413 .
 414 The following options are transparently handed over to the formatter
 415 program
 416 .B @L_TROFF@ .
 417 These options are described in more detail in
 418 .BR @L_TROFF@ (@MAN1EXT@).
 419 .
 420 .TP
 421 .B \-a
 422 \f[CR]ASCII\f[] approximation of output.
 423 .
 424 .TP
 425 .B \-b
 426 Backtrace on error or warning.
 427 .
 428 .TP
 429 .B \-c
 430 Disable color output.
 431 .
 432 Please consult the
 433 .BR \%@L_D_TTY@ (@MAN1EXT@)
 434 man page for more details.
 435 .
 436 .TP
 437 .B \-C
 438 Enable compatibility mode.
 439 .
 440 .TP
 441 .BI \-d\  cs
 442 .TQ
 443 .BI \-d\  name = s
 444 Define string.
 445 .
 446 .TP
 447 .B \-E
 448 Disable
 449 .B @L_TROFF@
 450 error messages.
 451 .
 452 .TP
 453 .BI \-f\  fam
 454 Set default font family.
 455 .
 456 .TP
 457 .BI \-F\  dir
 458 Set path for font DESC files.
 459 .
 460 .TP
 461 .B \-i
 462 Process standard input after the specified input files.
 463 .
 464 .TP
 465 .BI \-m\  name
 466 Include macro file
 467 .IB name .tmac
 468 (or
 469 .BI tmac. name\c
 470 ); see also
 471 .BR \%@L_ROFF@-tmac (@MAN5EXT@).
 472 .
 473 .TP
 474 .BI \-M\  dir
 475 Path for macro files.
 476 .
 477 .TP
 478 .BI \-n\  num
 479 Number the first page
 480 .IR num .
 481 .
 482 .TP
 483 .BI \-o\  list
 484 Output only pages in
 485 .IR list .
 486 .
 487 .TP
 488 .BI \-r\  cn
 489 .TQ
 490 .BI \-r\  name = n
 491 Set number register.
 492 .
 493 .TP
 494 .BI \-w\  name
 495 Enable warning
 496 .IR name .
 497 .
 498 .TP
 499 .BI \-W\  name
 500 disable warning
 501 .IR name .
 502 .
 503 .
 504 .\"
 505 .SH "USING @U_ROFF@"
 506 .
 507 The
 508 .I @T_ROFF@ system
 509 implements the infrastructure of classical
 510 .IR roff;
 511 see
 512 .BR @L_ROFF@ (@MAN7EXT@)
 513 for a survey on how a
 514 .I roff
 515 system works in general.
 516 @T_ROFF@ adds front-end programs and other facilities which make using
 517 it easier than
 518 .IR "classical roff"
 519 with its pipeline approach.
 520 This section gives an overview of those added parts and complements
 521 .BR @L_ROFF@ (@MAN7EXT@).
 522 .
 523 .\"
 524 .SS Paper Size
 525 .
 526 The
 527 .I virtual
 528 paper size used by
 529 .B troff
 530 to format the input is controlled globally with the requests
 531 .BR .po ,
 532 .BR .pl ,
 533 and
 534 .BR .ll .
 535 See
 536 .BR @L_ROFF@-tmac (@MAN5EXT@)
 537 for the `papersize' macro package which provides a convenient interface.
 538 .
 539 .P
 540 The
 541 .I physical
 542 paper size, giving the actual dimensions of the paper sheets, is
 543 controlled by output devices like
 544 .BR @L_D_PS@
 545 with the command line options
 546 .B \-p
 547 and
 548 .BR \-l .
 549 See
 550 .BR @L_ROFF@-font (@MAN5EXT@)
 551 and the man pages of the output devices for more details.
 552 .B @L_ROFF@
 553 uses the command line option
 554 .B \-P
 555 to pass options to output devices; for example, the following selects
 556 A4 paper in landscape orientation for the PS device:
 557 .
 558 .IP
 559 .EX
 560 @L_ROFF@ -Tps -P-pa4 -P-l ...
 561 .EE
 562 .
 563 .\"
 564 .SS Front-ends
 565 .
 566 @L_ROFF@ allows to specify the preprocessors by command line options,
 567 and automatically runs the postprocessor that is appropriate for the
 568 selected device after processing the data with @L_TROFF@.
 569 @L_ROFF@ therefore acts as a replacement for the necessity to manually
 570 specify the processor pipeline as is required by classical
 571 .BR roff " ("
 572 .BR @L_ROFF@ (@MAN7EXT@)).
 573 .
 574 .\"
 575 .SS Preprocessors
 576 .
 577 The standard preprocessors distributed along with
 578 .I @T_ROFF@
 579 are
 580 .
 581 .TP
 582 .BR \%@L_P_EQN@ (@MAN1EXT@)
 583 for mathematical formul\(ae,
 584 .
 585 .TP
 586 .BR \%@L_P_GRN@ (@MAN1EXT@)
 587 for including
 588 .BR gremlin (1)
 589 pictures,
 590 .
 591 .TP
 592 .BR \%@L_P_PIC@ (@MAN1EXT@)
 593 for drawing diagrams,
 594 .
 595 .TP
 596 .BR \%@L_P_REFER@ (@MAN1EXT@)
 597 for bibliographic references,
 598 .
 599 .TP
 600 .BR \%@L_P_SOELIM@ (@MAN1EXT@)
 601 for including macro files from standard locations,
 602 .
 603 .TP
 604 .BR @L_P_TABLES (@MAN1EXT@)
 605 for tables.
 606 .
 607 .P
 608 A new preprocessor is
 609 .BR \%@L_P_PRECONV@ (@MAN1EXT@)
 610 which converts various input encodings to something
 611 .B @L_ROFF@
 612 can understand.
 613 It is always run first before any other preprocessor.
 614 .
 615 .\"
 616 .SS "Macro Packages"
 617 .
 618 Macro packages can be included by option
 619 .BR \-m .
 620 .
 621 The
 622 .I @T_ROFF@
 623 system implements and extends all classical macro packages in a
 624 compatible way and adds some packages of its own.
 625 .
 626 Actually, the following macro packages are included:
 627 .
 628 .TP
 629 .B man
 630 The traditional man page format; see
 631 .BR \%@L_ROFF@-man (@MAN7EXT@).
 632 It can be specified on the command line as
 633 .B \-man
 634 or
 635 .BR \-m\~man .
 636 .
 637 .TP
 638 .B mandoc
 639 The general package for man pages; it automatically recognizes
 640 whether the documents uses the
 641 .I man
 642 or the
 643 .I mdoc
 644 format and branches to the corresponding macro package.
 645 .
 646 It can be specified on the command line as
 647 .B \%\-mandoc
 648 or
 649 .BR \-m\~\%mandoc .
 650 .
 651 .TP
 652 .B mdoc
 653 The \f[CR]BSD\f[]-style man page format; see
 654 .BR \%@L_ROFF@-mdoc (@MAN7EXT@).
 655 It can be specified on the command line as
 656 .B \-mdoc
 657 or
 658 .BR \-m\~mdoc .
 659 .
 660 .TP
 661 .B me
 662 The classical
 663 .I me
 664 document format; see
 665 .BR \%@L_ROFF@-me (@MAN7EXT@).
 666 It can be specified on the command line as
 667 .B \-me
 668 or
 669 .BR \-m\~me .
 670 .
 671 .TP
 672 .B ms
 673 The classical
 674 .I ms
 675 document format; see
 676 .BR \%@L_ROFF@-ms (@MAN7EXT@).
 677 It can be specified on the command line as
 678 .B \-ms
 679 or
 680 .BR \-m\~ms .
 681 .
 682 .TP
 683 .B www
 684 HTML-like macros for inclusion in arbitrary
 685 .I groff
 686 documents; see
 687 .BR \%@L_ROFF@-www (@MAN7EXT@).
 688 .
 689 .P
 690 Details on the naming of macro files and their placement can be found
 691 in
 692 .BR \%@L_ROFF@-tmac (@MAN5EXT@);
 693 this man page also documents some other, minor auxiliary macro packages
 694 not mentioned here.
 695 .
 696 .\"
 697 .SS "Programming Language"
 698 .
 699 General concepts common to all
 700 .I roff
 701 programming languages are described in
 702 .BR @L_ROFF@ (@MAN7EXT@).
 703 .
 704 .P
 705 The
 706 .I @T_ROFF@
 707 extensions to the classical
 708 .I troff
 709 language are documented in
 710 .BR \%@L_ROFF@-diff (@MAN7EXT@).
 711 In here you find also differences in between GNU troff and @T_ROFF@.
 712 .
 713 .P
 714 The
 715 .I @T_ROFF@
 716 language as a whole is described in
 717 .BR @L_ROFF@ (@MAN7EXT@).
 718 .
 719 .\"
 720 .SS Formatters
 721 .
 722 The central
 723 .I roff
 724 formatter within the
 725 .I @T_ROFF@
 726 system is
 727 .BR @L_TROFF@ (@MAN1EXT@).
 728 It provides the features of both the classical
 729 .I troff
 730 and
 731 .IR nroff ,
 732 as well as the
 733 .I @T_ROFF@
 734 extensions.
 735 .
 736 The command line option
 737 .B \-C
 738 switches
 739 .B @L_TROFF@
 740 into
 741 .I "compatibility mode"
 742 which tries to emulate classical
 743 .I roff
 744 as much as possible.
 745 .
 746 .P
 747 There is a shell script
 748 .BR @L_NROFF@ (@MAN1EXT@)
 749 that emulates the behavior of classical
 750 .BR nroff .
 751 It tries to automatically select the proper output encoding, according to
 752 the current locale.
 753 .
 754 .P
 755 The formatter program generates
 756 .IR "intermediate output" ;
 757 see
 758 .BR \%@L_ROFF@-out (@MAN7EXT@).
 759 .
 760 .\"
 761 .SS Devices
 762 .
 763 In
 764 .IR roff ,
 765 the output targets are called
 766 .IR devices .
 767 A device can be a piece of hardware, e.g., a printer, or a software
 768 file format.
 769 .
 770 A device is specified by the option
 771 .BR \-T .
 772 The following devices are included:
 773 .
 774 .TP
 775 .B ascii
 776 Text output using the
 777 .BR ascii (7)
 778 character set.
 779 .
 780 .TP
 781 .B cp1047
 782 Text output using the EBCDIC code page IBM cp1047 (e.g., OS/390 Unix).
 783 .
 784 .TP
 785 .B dvi
 786 TeX DVI format.
 787 .
 788 .TP
 789 .B html
 790 HTML output.
 791 .
 792 .TP
 793 .B latin1
 794 Text output using the ISO \%Latin-1 (ISO \%8859-1) character set; see
 795 .BR \%iso_8859_1 (7).
 796 .
 797 .TP
 798 .B ps
 799 PostScript output; suitable for printers and previewers like
 800 .BR gv (1).
 801 .
 802 .TP
 803 .B utf8
 804 Text output using the Unicode (ISO 10646) character set with \%UTF-8
 805 encoding; see
 806 .BR unicode (7).
 807 .
 808 .TP
 809 .B xhtml
 810 XHTML output.
 811 .
 812 .P
 813 The postprocessor to be used for a device is specified by the
 814 .B postpro
 815 command in the device description file; see
 816 .BR \%@L_ROFF@-font (@MAN5EXT@).
 817 .
 818 .P
 819 The default device is
 820 .BR @DEVICE@ .
 821 .
 822 .\"
 823 .SS Postprocessors
 824 .
 825 .I @L_ROFF@
 826 provides 3\~hardware postprocessors:
 827 .
 828 .TP
 829 .BR \%@L_D_TTY@ (@MAN1EXT@)
 830 for text output using various encodings, e.g., on text-oriented
 831 terminals or line-printers.
 832 .
 833 .P
 834 Today, most printing or drawing hardware is handled by the operating
 835 system, by device drivers, or by software interfaces, usually accepting
 836 PostScript.
 837 Consequently, there isn't an urgent need for more hardware device
 838 postprocessors.
 839 .
 840 .P
 841 The software devices for conversion into other document file formats are:
 842 .
 843 .TP
 844 .BR \%@L_D_DVI@ (@MAN1EXT@)
 845 for the DVI format,
 846 .
 847 .TP
 848 .BR \%@L_D_HTML@ (@MAN1EXT@)
 849 for HTML and XHTML formats,
 850 .
 851 .TP
 852 .BR \%@L_D_PS@ (@MAN1EXT@)
 853 for PostScript.
 854 .
 855 .P
 856 Combined with the many existing free conversion tools this should
 857 be sufficient to convert a
 858 .I troff
 859 document into virtually any existing data format.
 860 .
 861 .\"
 862 .SS Utilities
 863 .
 864 The following utility programs around are available:
 865 .
 866 .TP
 867 .BR \%@L_ADDFTINFO@ (@MAN1EXT@)
 868 Add information to
 869 .I troff
 870 font description files for use with
 871 .IR @T_ROFF@ .
 872 .
 873 .TP
 874 .BR \%@L_AFMTODIT@ (@MAN1EXT@)
 875 Create font description files for PostScript device.
 876 .
 877 .TP
 878 .BR \%@L_INDXBIB@ (@MAN1EXT@)
 879 Make inverted index for bibliographic databases.
 880 .
 881 .TP
 882 .BR \%@L_LKBIB@ (@MAN1EXT@)
 883 Search bibliographic databases.
 884 .
 885 .TP
 886 .BR \%@L_LOOKBIB@ (@MAN1EXT@)
 887 Interactively search bibliographic databases.
 888 .
 889 .TP
 890 .BR \%@L_PDFROFF@ (@MAN1EXT@)
 891 Create PDF documents.
 892 .
 893 .TP
 894 .BR \%@L_PFBTOPS@ (@MAN1EXT@)
 895 Translate a PostScript font in .pfb format to \f[CR]ASCII\f[].
 896 .
 897 .TP
 898 .BR \%@L_TFMTODIT@ (@MAN1EXT@)
 899 Create font description files for TeX DVI device.
 900 .
 901 .\"
 902 .SH ENVIRONMENT
 903 .
 904 Normally, the path separator in the following environment variables is the
 905 colon; this may vary depending on the operating system.
 906 For example, DOS and Windows use a semicolon instead.
 907 .
 908 .TP
 909 .EnvVar @U_ROFF@_BIN_PATH
 910 This search path, followed by
 911 .EnvVar $PATH ,
 912 is used for commands that are executed by
 913 .BR @T_ROFF@ .
 914 If it is not set then the directory where the
 915 .I @T_ROFF@
 916 binaries were installed is prepended to
 917 .EnvVar PATH .
 918 .
 919 .TP
 920 .EnvVar @U_ROFF@_COMMAND_PREFIX
 921 When there is a need to run different
 922 .I roff
 923 implementations at the same time
 924 .I @T_ROFF@
 925 provides the facility to prepend a prefix to most of its programs that
 926 could provoke name clashings at run time (default is to have none).
 927 .
 928 More exactly, if it is set to prefix
 929 .I xxx
 930 then
 931 .B @L_ROFF@
 932 as a wrapper program internally calls
 933 .IB xxx @L_TROFF@
 934 instead of
 935 .BR @L_TROFF@ .
 936 This also applies to the preprocessors
 937 .BR \%@L_P_EQN@ ,
 938 .BR \%@L_P_GRN@ ,
 939 .BR \%@L_P_PIC@ ,
 940 .BR \%@L_P_REFER@ ,
 941 .BR \%@L_P_TBL@ ,
 942 .BR \%@L_P_SOELIM@ ,
 943 and to the utilities
 944 .B \%@L_INDXBIB@
 945 and
 946 .BR \%@L_LOOKBIB@ .
 947 .
 948 This feature does not apply to any programs different from the ones
 949 above (most notably
 950 .B @L_ROFF@
 951 itself).
 952 .
 953 .TP
 954 .EnvVar @U_ROFF@_ENCODING
 955 The value of this environment value is passed to the
 956 .B @L_P_PRECONV@
 957 preprocessor to select the encoding of input files, i.e.,
 958 setting this option implies
 959 .BR @L_ROFF@ 's
 960 command line option
 961 .B \-k .
 962 If set to an empty value then the automatic character set guessing
 963 heuristics are used, as documented for
 964 .BR preconv (@MAN1EXT@).
 965 An explicit
 966 .B \-K
 967 command line option overrides the value of
 968 .EnvVar @U_ROFF@_ENCODING .
 969 .
 970 .TP
 971 .EnvVar @U_ROFF@_FONT_PATH
 972 A list of directories in which to search for the
 973 .BI dev name
 974 directory in addition to the default ones.
 975 See
 976 .BR @L_TROFF@ (@MAN1EXT@)
 977 and
 978 .BR \%@L_ROFF@-font (@MAN5EXT@)
 979 for more details.
 980 .
 981 .TP
 982 .EnvVar @U_ROFF@_TMAC_PATH
 983 A list of directories in which to search for macro files in addition to
 984 the default directories.
 985 See
 986 .BR @L_TROFF@ (@MAN1EXT@)
 987 and
 988 .BR \%@L_ROFF@-tmac (@MAN5EXT@)
 989 for more details.
 990 .
 991 .TP
 992 .EnvVar @U_ROFF@_TMPDIR
 993 The directory in which temporary files are created.
 994 If this is not set but the environment variable
 995 .EnvVar TMPDIR
 996 instead, temporary files are created in the directory
 997 .EnvVar $TMPDIR .
 998 On MS-DOS and Windows\~32 platforms, the environment variables
 999 .EnvVar TMP
1000 and
1001 .EnvVar TEMP
1002 (in that order) are searched also, after
1003 .EnvVar @U_ROFF@_TMPDIR
1004 and
1005 .EnvVar TMPDIR .
1006 Otherwise, temporary files are created in
1007 .BR /tmp .
1008 The
1009 .BR \%@L_P_REFER@ (@MAN1EXT@),
1010 .BR \%@L_D_HTML@ (@MAN1EXT@),
1011 and
1012 .BR \%@L_D_PS@ (@MAN1EXT@)
1013 commands use temporary files.
1014 .
1015 .TP
1016 .EnvVar @U_ROFF@_TYPESETTER
1017 Preset the default device.
1018 If this is not set the
1019 .B @DEVICE@
1020 device is used as default.
1021 This device name is overwritten by the option
1022 .BR \-T .
1023 .
1024 .\"
1025 .SH FILES
1026 .
1027 There are some directories in which
1028 .I @T_ROFF@
1029 installs all of its data files.
1030 Due to different installation habits on different operating systems,
1031 their locations are not absolutely fixed, but their function is
1032 clearly defined and coincides on all systems.
1033 .
1034 .\"
1035 .SS "groff Macro Directory"
1036 .
1037 This contains all information related to macro packages;
1038 in the @T_ROFF@ system installation this directory is
1039 .IR @MACRODIR@ .
1040 Note that more than a single directory is searched for those files
1041 as documented in
1042 .BR \%@L_ROFF@-tmac (@MAN5EXT@)
1043 .
1044 .P
1045 The following files contained in the
1046 .I macro directory
1047 have a special meaning:
1048 .
1049 .TP
1050 .B troffrc
1051 Initialization file for
1052 .IR @L_TROFF@ .
1053 This is interpreted by
1054 .B @L_TROFF@
1055 before reading the macro sets and any input.
1056 .
1057 .TP
1058 .B troffrc-end
1059 Final startup file for
1060 .IR @L_TROFF@ .
1061 It is parsed after all macro sets have been read.
1062 .
1063 .TP
1064 .IB name .tmac
1065 .TQ
1066 .BI tmac. name
1067 Macro file for macro package
1068 .IR name .
1069 .
1070 .\"
1071 .SS "groff Font Directory"
1072 .
1073 This contains all information related to output devices;
1074 in the @T_ROFF@ system installation this directory is
1075 .IR @FONTDIR@ .
1076 Note that more than a single directory is searched for those files; see
1077 .BR @L_TROFF@ (@MAN1EXT@).
1078 .
1079 .P
1080 The following files contained in the
1081 .I font directory
1082 have a special meaning:
1083 .
1084 .TP
1085 .BI dev name /DESC
1086 Device description file for device
1087 .IR name ,
1088 see
1089 .BR \%@L_ROFF@-font (@MAN5EXT@).
1090 .
1091 .TP
1092 .BI dev name / F
1093 Font file for font
1094 .I F
1095 of device
1096 .IR name .
1097 .
1098 .\"
1099 .SH BUGS
1100 .
1101 .P
1102 On \f[CR]EBCDIC\f[] hosts (e.g., \f[CR]OS/390 Unix\f[]), output
1103 devices
1104 .B ascii
1105 and
1106 .B latin1
1107 aren't available.
1108 Similarly, output for \f[CR]EBCDIC\f[] code page
1109 .B cp1047
1110 is not available on \f[CR]ASCII\f[] based operating systems.
1111 .
1112 .P
1113 Report bugs to the
1114 .MT @BUGMAIL@
1115 mailing list
1116 .ME .
1117 .
1118 .\"
1119 .SH AUTHORS
1120 Copyright (c) 2014 - 2017 Steffen (Daode) Nurpmeso <steffen@sdaoden.eu>.
1121 .
1122 Copyright \(co 1989, 2002 - 2008
1123 Free Software Foundation, Inc.
1124 .
1125 .P
1126 This document is distributed under the terms of the \f[CR]FDL\f[]
1127 (\f[CR]GNU Free Documentation License\f[]) version 1.1 or later.
1128 .
1129 You should have received a copy of the \f[CR]FDL\f[] on your system,
1130 it is also available on-line at the
1131 .UR http://\:www.gnu.org/\:copyleft/\:fdl.html
1132 GNU copyleft site
1133 .UE .
1134 .
1135 .P
1136 This document is based on the original
1137 .I groff
1138 man page written by
1139 .MT jjc@jclark.com
1140 James Clark
1141 .UE .
1142 .
1143 It was rewritten, enhanced, and put under the FDL license by
1144 Bernd Warken.
1145 .
1146 It is maintained by
1147 .MT wl@gnu.org
1148 Werner Lemberg
1149 .ME .
1150 .
1151 .\"
1152 .SH "SEE ALSO"
1153 .
1154 .TP
1155 Introduction, history and further readings:
1156 .BR \%@L_ROFF@-history (@MAN7EXT@).
1157 .
1158 .TP
1159 Wrapper programs for formatters:
1160 .BR \%@L_ROFF@ (@MAN1EXT@).
1161 .
1162 .TP
1163 Roff preprocessors:
1164 .BR \%@L_P_EQN@ (@MAN1EXT@),
1165 .BR \%@L_P_GRN@ (@MAN1EXT@),
1166 .BR \%@L_P_PIC@ (@MAN1EXT@),
1167 .BR \%@L_P_PRECONV@ (@MAN1EXT@),
1168 .BR \%@L_P_REFER@ (@MAN1EXT@),
1169 .BR \%@L_P_SOELIM@ (@MAN1EXT@),
1170 .BR \%@L_P_TBL@ (@MAN1EXT@),
1171 .BR grap (1).
1172 .
1173 .TP
1174 Roff language with the groff extensions:
1175 .BR \%@L_ROFF@ (@MAN7EXT@),
1176 .BR \%@L_ROFF@-char (@MAN7EXT@),
1177 .BR \%@L_ROFF@-diff (@MAN7EXT@),
1178 .BR \%@L_ROFF@-font (@MAN5EXT@).
1179 .
1180 .TP
1181 Roff formatter programs:
1182 .BR \%@L_NROFF@ (@MAN1EXT@),
1183 .BR \%@L_TROFF@ (@MAN1EXT@),
1184 .BR \%@L_DITROFF@ (@MAN7EXT@).
1185 .
1186 .TP
1187 The intermediate output language:
1188 .BR \%@L_ROFF@-out (@MAN7EXT@).
1189 .
1190 .TP
1191 Postprocessors for the output devices:
1192 .BR \%@L_D_DVI@ (@MAN1EXT@),
1193 .BR \%@L_D_HTML@ (@MAN1EXT@),
1194 .BR \%@L_D_PS@ (@MAN1EXT@),
1195 .BR \%@L_D_TTY@ (@MAN1EXT@).
1196 .
1197 .TP
1198 Groff macro packages and macro-specific utilities:
1199 .BR \%@L_ROFF@-tmac (@MAN5EXT@),
1200 .BR \%@L_ROFF@-man (@MAN7EXT@),
1201 .BR \%@L_ROFF@-mdoc (@MAN7EXT@),
1202 .BR \%@L_ROFF@-me (@MAN7EXT@),
1203 .BR \%@L_ROFF@-ms (@MAN7EXT@),
1204 .BR \%@L_ROFF@-www (@MAN7EXT@),
1205 .BR \%@L_ROFF@-trace (@MAN7EXT@),
1206 .
1207 .TP
1208 The following utilities are available:
1209 .BR \%@L_ADDFTINFO@ (@MAN1EXT@),
1210 .BR \%@L_AFMTODIT@ (@MAN1EXT@),
1211 .BR \%@L_INDXBIB@ (@MAN1EXT@),
1212 .BR \%@L_LKBIB@ (@MAN1EXT@),
1213 .BR \%@L_LOOKBIB@ (@MAN1EXT@),
1214 .BR \%@L_PDFROFF@ (@MAN1EXT@),
1215 .BR \%@L_PFBTOPS@ (@MAN1EXT@),
1216 .BR \%@L_TFMTODIT@ (@MAN1EXT@),
1217 .
1218 .cp \n[__compat]
1219 .rr __compat
1220 .
1221 .\" s-ts-mode