contrib/groff/src/roff/groff/groff.man

   1 .ig
   2 groff.man
   3
   4 Last update: 01 Jul 2005
   5
   6 Copyright (C) 1989, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
   7 Rewritten in 2002 by Bernd Warken <bwarken@mayn.de>
   8
   9 Permission is granted to copy, distribute and/or modify this document
  10 under the terms of the GNU Free Documentation License, Version 1.1 or
  11 any later version published by the Free Software Foundation; with the
  12 Invariant Sections being this .ig-section and AUTHOR, with no
  13 Front-Cover Texts, and with no Back-Cover Texts.
  14
  15 A copy of the Free Documentation License is included as a file called
  16 FDL in the main directory of the groff source package.
  17
  18 $FreeBSD$
  19
  20 ..
  21 .
  22 .\" --------------------------------------------------------------------
  23 .\" Setup
  24 .\" --------------------------------------------------------------------
  25 .
  26 .do nr groff_C \n[.C]
  27 .cp 0
  28 .
  29 .mso www.tmac
  30 .
  31 .\" set adjust to both
  32 .ad b
  33 .
  34 .\" fonts of fixed length
  35 .
  36 .if n \{\
  37 .  mso tty-char.tmac
  38 .  ftr CR R
  39 .  ftr CI I
  40 .  ftr CB B
  41 .\}
  42 .
  43 .if '\*[.T]'dvi' \
  44 .  ftr CB CW
  45 .
  46 .\" --------------------------------------------------------------------
  47 .\" String definitions
  48 .
  49 .ds @- "\-\"
  50 .ds @-- "\-\^\-\"
  51 .
  52 .ds Ellipsis .\|.\|.\"
  53 .
  54 .
  55 .\" --------------------------------------------------------------------
  56 .\" Begin of macro definitions
  57 .de c
  58 .\" this is like a comment request when escape mechanism is off
  59 ..
  60 .eo
  61 .
  62 .c --------------------------------------------------------------------
  63 .de TP+
  64 .br
  65 .ns
  66 .TP \$1
  67 ..
  68 .c --------------------------------------------------------------------
  69 .c Like TP, but if specified indent is more than half
  70 .c the current line-length - indent, use the default indent.
  71 .de Tp
  72 .  ie \n[.$]=0:((0\$1)*2u>(\n.lu-\n(.iu)) .TP
  73 .  el .TP "\$1"
  74 ..
  75 .c --------------------------------------------------------------------
  76 .de Text
  77 .  nop \)\$*
  78 ..
  79 .c --------------------------------------------------------------------
  80 .de Synopsis
  81 .  ds @arg1 \$1\"
  82 .  nr @old_indent \n[.i]
  83 .  ad l
  84 .  in +\w'\f[B]\*[@arg1]\0'u
  85 .  ti \n[@old_indent]u
  86 .  B \*[@arg1]\0\c
  87 .  rr @old_indent
  88 .  rm @arg1
  89 ..
  90 .c --------------------------------------------------------------------
  91 .de EndSynopsis
  92 .  ad
  93 .  in
  94 ..
  95 .c --------------------------------------------------------------------
  96 .c ShortOpt[]  (name [arg])
  97 .c
  98 .c short option in synopsis
  99 .c
 100 .de ShortOpt[]
 101 .  if \n[.$]=0 \
 102 .    return
 103 .  ds @opt \$1\"
 104 .  shift
 105 .  ie \n[.$]=0 \
 106 .    Text \f[R][\f[]\f[CB]\*[@-]\*[@opt]\f[]\f[R]]\f[]
 107 .  el \
 108 .    Text \f[R][\f[]\f[CB]\*[@-]\*[@opt]\~\f[]\f[I]\/\$*\f[]\f[R]]\f[]
 109 .  rm @opt
 110 ..
 111 .c --------------------------------------------------------------------
 112 .c Option in synopsis (short option)
 113 .de SynOpt
 114 .  if \n[.$]=0 \
 115 .    return
 116 .  ds @opt \$1\"
 117 .  shift
 118 .  ie \n[.$]=0 \
 119 .    Text \f[R][\f[]\f[CB]\*[@-]\*[@opt]\f[]\f[R]]\f[]
 120 .  el \
 121 .    Text \f[R][\f[]\f[CB]\*[@-]\*[@opt]\~\f[]\f[I]\/\$*\f[]\f[R]]\f[]
 122 .  rm @opt
 123 ..
 124 .c --------------------------------------------------------------------
 125 .c ShortOpt ([char [punct]])
 126 .c
 127 .c `-c' somewhere in the text
 128 .c second arg is punctuation
 129 .c
 130 .de ShortOpt
 131 .  ds @opt \$1\"
 132 .  shift
 133 .  Text \f[CB]\*[@-]\*[@opt]\f[]\/\$*
 134 .  rm @opt
 135 ..
 136 .c --------------------------------------------------------------------
 137 .c LongOpt  ([name [punct]])
 138 .c
 139 .c `--name' somewhere in the text
 140 .c second arg is punctuation
 141 .c
 142 .de LongOpt
 143 .  ds @opt \$1\"
 144 .  shift
 145 .  Text \f[CB]\*[@--]\f[]\f[B]\*[@opt]\f[]\/\$*
 146 .  rm @opt
 147 ..
 148 .c --------------------------------------------------------------------
 149 .c OptDef  (shortopt [longopt [argument]])
 150 .c
 151 .c option documentation
 152 .c args : `shortopt', `longopt' can be ""
 153 .c
 154 .de OptDef
 155 .  ds @short
 156 .  ds @long
 157 .  ds @arg
 158 .  if \n[.$]>=1 \{\
 159 .    ds @arg1 "\$1\"
 160 .    if !'\*[@arg1]'' \
 161 .      ds @short "\f[CB]\*[@-]\*[@arg1]\f[]\"
 162 .    if \n[.$]>=2 \{\
 163 .      if !'\*[@short]'' \
 164 .        as @short \f[CW]\0\f[]
 165 .      ds @arg2 "\$2\"
 166 .      if !'\*[@arg2]'' \
 167 .        ds @long "\f[CB]\*[@--]\f[]\f[B]\*[@arg2]\f[]\"
 168 .      if \n[.$]>=3 \{\
 169 .        if !'\*[@long]'' \
 170 .          as @long \|=\|\"
 171 .        shift 2
 172 .        ds @arg \f[I]\$*\"
 173 .      \}
 174 .    \}
 175 .  \}
 176 .  IP "\f[R]\*[@short]\*[@long]\*[@arg]\f[]"
 177 .  rm @arg
 178 .  rm @arg1
 179 .  rm @arg2
 180 .  rm @short
 181 .  rm @long
 182 ..
 183 .c --------------------------------------------------------------------
 184 .c Continuation of an OptDef header.
 185 .de OptDef+
 186 .  br
 187 .  ns
 188 .  OptDef \$@
 189 ..
 190 .c --------------------------------------------------------------------
 191 .c Environment variable
 192 .de EnvVar
 193 .  SM
 194 .  BR \%\$1 \$2
 195 ..
 196 .c --------------------------------------------------------------------
 197 .c a shell command line
 198 .de ShellCommand
 199 .  nr @font \n[.f]
 200 .  c replace argument separator by unbreakable space
 201 .  ds @args \$1\""
 202 .  shift
 203 .  while (\n[.$]>0) \{\
 204 .    ds @args \*[@args]\~\$1
 205 .    shift
 206 .  \}
 207 .  br
 208 .  ad l
 209 .  nh
 210 .  Text \f[I]sh#\h'1m'\f[P]\f[CR]\*[@args]\f[P]\&\"
 211 .  ft R
 212 .  ft P
 213 .  hy
 214 .  ad
 215 .  ft \n[@font]
 216 .  br
 217 .  rr @font
 218 .  rm @args
 219 ..
 220 .c --------------------------------------------------------------------
 221 .c `char or string'
 222 .de Quoted
 223 .  ft CR
 224 .  Text \[oq]\$*\[cq]
 225 .  ft
 226 ..
 227 .c --------------------------------------------------------------------
 228 .c End of macro definitions
 229 .ec
 230 .
 231 .
 232 .\" --------------------------------------------------------------------
 233 .\" Title
 234 .\" --------------------------------------------------------------------
 235 .
 236 .TH GROFF @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
 237 .SH NAME
 238 groff \- front-end for the groff document formatting system
 239 .
 240 .
 241 .\" --------------------------------------------------------------------
 242 .SH SYNOPSIS
 243 .\" --------------------------------------------------------------------
 244 .
 245 .ad l
 246 .Synopsis groff
 247 .ShortOpt[] abcegilpstzCEGNRSUVXZ
 248 .ShortOpt[] d cs
 249 .ShortOpt[] f fam
 250 .ShortOpt[] F dir
 251 .ShortOpt[] I dir
 252 .ShortOpt[] L arg
 253 .ShortOpt[] m name
 254 .ShortOpt[] M dir
 255 .ShortOpt[] n num
 256 .ShortOpt[] o list
 257 .ShortOpt[] P arg
 258 .ShortOpt[] r cn
 259 .ShortOpt[] T dev
 260 .ShortOpt[] w name
 261 .ShortOpt[] W name
 262 .RI [ file
 263 .Text \*[Ellipsis]]
 264 .EndSynopsis
 265 .
 266 .Synopsis groff
 267 .ShortOpt h
 268 |
 269 .LongOpt help
 270 .EndSynopsis
 271 .
 272 .Synopsis groff
 273 .ShortOpt v
 274 |
 275 .LongOpt version
 276 .RI [ option
 277 .Text \*[Ellipsis]]
 278 .EndSynopsis
 279 .
 280 .P
 281 The command line is parsed according to the usual GNU convention.
 282 .
 283 The whitespace between a command line option and its argument is
 284 optional.
 285 .
 286 Options can be grouped behind a single
 287 .ShortOpt
 288 (minus character).
 289 .
 290 A filename of
 291 .ShortOpt
 292 (minus character) denotes the standard input.
 293 .
 294 .
 295 .\" --------------------------------------------------------------------
 296 .SH DESCRIPTION
 297 .\" --------------------------------------------------------------------
 298 .
 299 This document describes the
 300 .B groff
 301 program, the main front-end for the
 302 .I groff
 303 document formatting system.
 304 .
 305 The
 306 .I groff
 307 program and macro suite is the implementation of a
 308 .BR roff (@MAN7EXT@)
 309 system within the free software collection
 310 .URL http://\:www.gnu.org "GNU" .
 311 .
 312 The
 313 .I groff
 314 system has all features of the classical
 315 .IR roff ,
 316 but adds many extensions.
 317 .
 318 .P
 319 The
 320 .B groff
 321 program allows to control the whole
 322 .I groff
 323 system by command line options.
 324 .
 325 This is a great simplification in comparison to the classical case (which
 326 uses pipes only).
 327 .
 328 .
 329 .\" --------------------------------------------------------------------
 330 .SH OPTIONS
 331 .\" --------------------------------------------------------------------
 332 .
 333 As
 334 .B groff
 335 is a wrapper program for
 336 .B @g@troff
 337 both programs share a set of options.
 338 .
 339 But the
 340 .B groff
 341 program has some additional, native options and gives a new meaning to
 342 some
 343 .B @g@troff
 344 options.
 345 .
 346 On the other hand, not all
 347 .B @g@troff
 348 options can be fed into
 349 .BR groff .
 350 .
 351 .
 352 .\" --------------------------------------------------------------------
 353 .SS Native groff Options
 354 .\" --------------------------------------------------------------------
 355 .
 356 The following options either do not exist for
 357 .B @g@troff
 358 or are differently interpreted by
 359 .BR groff .
 360 .
 361 .
 362 .OptDef e
 363 Preprocess with
 364 .BR @g@eqn .
 365 .
 366 .
 367 .OptDef g
 368 Preprocess with
 369 .BR @g@grn .
 370 .
 371 .
 372 .OptDef G
 373 Preprocess with
 374 .BR grap .
 375 .
 376 .
 377 .OptDef h help
 378 Print a help message.
 379 .
 380 .
 381 .OptDef I "" dir
 382 This option may be used to specify a directory to search for
 383 files (both those on the command line and those named in
 384 .B \&.psbb
 385 and
 386 .B \&.so
 387 requests, and
 388 .B \eX'ps: import'
 389 and
 390 .B \eX'ps: file'
 391 escapes).
 392 The current directory is always searched first.
 393 This option may be specified more than once;
 394 the directories will be searched in the order specified.
 395 No directory search is performed for files specified using an absolute path.
 396 This option implies the
 397 .ShortOpt s
 398 option.
 399 .
 400 .
 401 .OptDef l
 402 Send the output to a spooler program for printing.
 403 .
 404 The command that should be used for this is specified by the
 405 .B print
 406 command in the device description file, see
 407 .BR \%groff_font (@MAN5EXT@).
 408 If this command is not present, the output is piped into the
 409 .BR lpr (1)
 410 program by default.
 411 .
 412 See options
 413 .ShortOpt L
 414 and
 415 .ShortOpt X .
 416 .
 417 .
 418 .OptDef L "" arg
 419 Pass
 420 .I arg
 421 to the spooler program.
 422 Several arguments should be passed with a separate
 423 .ShortOpt L
 424 option each.
 425 .
 426 Note that
 427 .B groff
 428 does not prepend
 429 .ShortOpt\" just a minus sign
 430 (a minus sign) to
 431 .I arg
 432 before passing it to the spooler program.
 433 .
 434 .
 435 .OptDef N
 436 Don't allow newlines within
 437 .I eqn
 438 delimiters.
 439 .
 440 This is the same as the
 441 .ShortOpt N
 442 option in
 443 .BR @g@eqn .
 444 .
 445 .
 446 .OptDef p
 447 Preprocess with
 448 .BR @g@pic .
 449 .
 450 .
 451 .OptDef P "" "\*[@-]option"
 452 .OptDef+ P "" "\*[@-]option \f[CB]\*[@-]P\f[] arg"
 453 Pass
 454 .I \*[@-]option
 455 or
 456 .I \*[@-]option arg
 457 to the postprocessor.
 458 .
 459 The option must be specified with the necessary preceding minus
 460 sign(s)
 461 .Quoted \*[@-]
 462 or
 463 .Quoted \*[@--]
 464 because groff does not prepend any dashes before passing it to the
 465 postprocessor.
 466 .
 467 For example, to pass a title to the \%gxditview postprocessor, the shell
 468 command
 469 .IP
 470 .ShellCommand groff \*[@-]X \*[@-]P \*[@-]title \*[@-]P 'groff it' \f[I]foo\f[]
 471 .IP
 472 is equivalent to
 473 .IP
 474 .ShellCommand groff \*[@-]X \*[@-]Z \f[I]foo\f[] | \
 475 gxditview \*[@-]title 'groff it' \*[@-]
 476 .
 477 .
 478 .OptDef R
 479 Preprocess with
 480 .BR @g@refer .
 481 .
 482 No mechanism is provided for passing arguments to
 483 .B @g@refer
 484 because most
 485 .B @g@refer
 486 options have equivalent language elements that can be specified within
 487 the document.
 488 .
 489 See
 490 .BR \%@g@refer (@MAN1EXT@)
 491 for more details.
 492 .
 493 .
 494 .OptDef s
 495 Preprocess with
 496 .BR @g@soelim .
 497 .
 498 .
 499 .OptDef S
 500 Safer mode.
 501 .
 502 Pass the
 503 .ShortOpt S
 504 option to
 505 .B @g@pic
 506 and disable the following
 507 .B @g@troff
 508 requests:
 509 .BR .open ,
 510 .BR .opena ,
 511 .BR .pso ,
 512 .BR .sy ,
 513 and
 514 .BR .pi .
 515 For security reasons, safer mode is enabled by default.
 516 .
 517 .
 518 .OptDef t
 519 Preprocess with
 520 .BR @g@tbl .
 521 .
 522 .
 523 .OptDef T "" dev
 524 Set output device to
 525 .IR dev .
 526 For this device,
 527 .B @g@troff
 528 generates the
 529 .I intermediate
 530 .IR output ;
 531 see
 532 .BR \%groff_out (@MAN5EXT@).
 533 .
 534 Then
 535 .B groff
 536 calls a postprocessor to convert
 537 .BR @g@troff 's
 538 .I intermediate output
 539 to its final format.
 540 .
 541 Real devices in
 542 .B groff
 543 are
 544 .
 545 .RS
 546 .RS
 547 .IP dvi
 548 TeX DVI format (postprocessor is
 549 .BR grodvi ).
 550 .IP html
 551 HTML output (preprocessors are
 552 .B @g@soelim
 553 and
 554 .BR \%pre-grohtml ,
 555 postprocessor is
 556 .BR \%post-grohtml ).
 557 .IP lbp
 558 Canon CAPSL printers (\%LBP-4 and \%LBP-8 series laser printers;
 559 postprocessor is
 560 .BR grolbp ).
 561 .IP lj4
 562 HP LaserJet4 compatible (or other PCL5 compatible) printers (postprocessor
 563 is
 564 .BR grolj4 ).
 565 .IP ps
 566 PostScript output (postprocessor is
 567 .BR grops ).
 568 .RE
 569 .RE
 570 .
 571 .IP
 572 For the following TTY output devices (postprocessor is always
 573 .BR grotty ),
 574 .ShortOpt T
 575 selects the output encoding:
 576 .RS
 577 .RS
 578 .IP ascii
 579 7bit ASCII.
 580 .IP cp1047
 581 \%Latin-1 character set for EBCDIC hosts.
 582 .IP latin1
 583 ISO \%8859-1.
 584 .IP utf8
 585 Unicode character set in \%UTF-8 encoding.
 586 .RE
 587 .RE
 588 .
 589 .IP
 590 The following arguments select
 591 .B \%gxditview
 592 as the `postprocessor' (it is rather a viewing program):
 593 .
 594 .RS
 595 .RS
 596 .IP X75
 597 75dpi resolution, 10pt document base font.
 598 .IP X75-12
 599 75dpi resolution, 12pt document base font.
 600 .IP X100
 601 100dpi resolution, 10pt document base font.
 602 .IP X100-12
 603 100dpi resolution, 12pt document base font.
 604 .RE
 605 .RE
 606 .
 607 .IP
 608 The default device is
 609 .BR @DEVICE@ .
 610 .
 611 .
 612 .OptDef U
 613 Unsafe mode.
 614 .
 615 Reverts to the (old) unsafe behaviour; see option
 616 .ShortOpt S .
 617 .
 618 .
 619 .OptDef v version
 620 Output version information of
 621 .B groff
 622 and of all programs that are run by it; that is, the given command line
 623 is parsed in the usual way, passing
 624 .ShortOpt v
 625 to all subprograms.
 626 .
 627 .
 628 .OptDef V
 629 Output the pipeline that would be run by
 630 .BR groff
 631 (as a wrapper program) on the standard output, but do not execute it.
 632 If given more than once,
 633 the commands will be both printed on the standard error and run.
 634 .
 635 .
 636 .OptDef X
 637 Use
 638 .B \%gxditview
 639 instead of using the usual postprocessor to (pre)view a document.
 640 .
 641 The printing spooler behavior as outlined with options
 642 .ShortOpt l
 643 and
 644 .ShortOpt L
 645 is carried over to
 646 .BR \%gxditview (@MAN1EXT@)
 647 by determining an argument for the
 648 .B \*[@-]printCommand
 649 option of
 650 .BR \%gxditview (@MAN1EXT@).
 651 .
 652 This sets the default
 653 .B Print
 654 action and the corresponding menu entry to that value.
 655 .
 656 .ShortOpt X
 657 only produces good results with
 658 .ShortOpt Tps ,
 659 .ShortOpt TX75 ,
 660 .ShortOpt TX75-12 ,
 661 .ShortOpt TX100 ,
 662 and
 663 .ShortOpt TX100-12 .
 664 .
 665 The default resolution for previewing
 666 .ShortOpt Tps
 667 output is 75\|dpi; this can be changed by passing the
 668 .ShortOpt resolution
 669 option to
 670 .BR \%gxditview ,
 671 for example
 672 .
 673 .IP
 674 .ShellCommand groff \*[@-]X \*[@-]P\*[@-]resolution \*[@-]P100 \*[@-]man foo.1
 675 .
 676 .
 677 .OptDef z
 678 Suppress output generated by
 679 .BR @g@troff .
 680 Only error messages will be printed.
 681 .
 682 .
 683 .OptDef Z
 684 Print the
 685 .I groff intermediate output
 686 to standard output; see
 687 .BR \%groff_out (@MAN5EXT@).
 688 Normally
 689 .BR groff
 690 calls automatically a postprocessor.
 691 .
 692 With this option, the output of
 693 .B @g@troff
 694 for the device, the so-called
 695 .I intermediate output
 696 is issued without postprocessing.
 697 .
 698 .
 699 .\" --------------------------------------------------------------------
 700 .SS Transparent Options
 701 .\" --------------------------------------------------------------------
 702 .
 703 The following options are transparently handed over to the formatter
 704 program
 705 .B @g@troff
 706 that is called by groff subsequently.
 707 .
 708 These options are described in more detail in
 709 .BR @g@troff (@MAN1EXT@).
 710 .
 711 .OptDef a
 712 ascii approximation of output.
 713 .
 714 .OptDef b
 715 backtrace on error or warning.
 716 .
 717 .OptDef c
 718 disable color output.
 719 .
 720 Please consult the
 721 .BR \%grotty (@MAN1EXT@)
 722 man page for more details.
 723 .
 724 .OptDef C
 725 enable compatibility mode.
 726 .
 727 .OptDef d "" cs
 728 .OptDef+ d "" name=s
 729 define string.
 730 .
 731 .OptDef E
 732 disable
 733 .B @g@troff
 734 error messages.
 735 .
 736 .OptDef f "" fam
 737 set default font family.
 738 .
 739 .OptDef F "" dir
 740 set path for font DESC files.
 741 .
 742 .OptDef i
 743 process standard input after the specified input files.
 744 .
 745 .OptDef m "" name
 746 include macro file \f[I]name\f[]\f[B].tmac\f[] (or
 747 \f[B]tmac.\f[]\f[I]name\f[]); see also
 748 .BR \%groff_tmac (@MAN5EXT@).
 749 .
 750 .OptDef M "" dir
 751 path for macro files.
 752 .
 753 .OptDef n "" num
 754 number the first page
 755 .IR num .
 756 .
 757 .OptDef o "" list
 758 output only pages in
 759 .IR list .
 760 .
 761 .OptDef r "" cn
 762 .OptDef+ r "" name=n
 763 set number register.
 764 .
 765 .OptDef w "" name
 766 enable warning
 767 .IR name .
 768 .
 769 .OptDef W "" name
 770 disable warning
 771 .IR name .
 772 .
 773 .
 774 .\" --------------------------------------------------------------------
 775 .SH "USING GROFF"
 776 .\" --------------------------------------------------------------------
 777 .
 778 The
 779 .I groff system
 780 implements the infrastructure of classical roff; see
 781 .BR roff (@MAN7EXT@)
 782 for a survey on how a roff system works in general.
 783 .
 784 Due to the front-end programs available within the groff system, using
 785 .I groff
 786 is much easier than
 787 .IR "classical roff" .
 788 .
 789 This section gives an overview of the parts that constitute the groff
 790 system.
 791 .
 792 It complements
 793 .BR roff (@MAN7EXT@)
 794 with groff-specific features.
 795 .
 796 This section can be regarded as a guide to the documentation around
 797 the groff system.
 798 .
 799 .
 800 .\" --------------------------------------------------------------------
 801 .SS Paper Size
 802 .\" --------------------------------------------------------------------
 803 .
 804 The
 805 .I virtual
 806 paper size used by
 807 .B troff
 808 to format the input is controlled globally with the requests
 809 .BR .po ,
 810 .BR .pl ,
 811 and
 812 .BR .ll .
 813 See
 814 .BR groff_tmac (@MAN5EXT@)
 815 for the `papersize' macro package which provides a convenient interface.
 816 .
 817 .P
 818 The
 819 .I physical
 820 paper size, giving the actual dimensions of the paper sheets, is
 821 controlled by output devices like
 822 .BR grops
 823 with the command line options
 824 .B \-p
 825 and
 826 .BR \-l .
 827 See
 828 .BR groff_font (@MAN5EXT@)
 829 and the man pages of the output devices for more details.
 830 .B groff
 831 uses the command line option
 832 .B \-P
 833 to pass options to output devices; for example, the following selects
 834 A4 paper in landscape orientation for the PS device:
 835 .
 836 .RS
 837 .P
 838 groff -Tps -P-pa4 -P-l .\|.\|.
 839 .RE
 840 .
 841 .
 842 .\" --------------------------------------------------------------------
 843 .SS Front-ends
 844 .\" --------------------------------------------------------------------
 845 .
 846 The
 847 .B groff
 848 program is a wrapper around the
 849 .BR @g@troff (@MAN1EXT@)
 850 program.
 851 .
 852 It allows to specify the preprocessors by command line options and
 853 automatically runs the postprocessor that is appropriate for the
 854 selected device.
 855 .
 856 Doing so, the sometimes tedious piping mechanism of classical
 857 .BR roff (@MAN7EXT@)
 858 can be avoided.
 859 .
 860 .P
 861 The
 862 .BR grog (@MAN1EXT@)
 863 program can be used for guessing the correct groff command line to
 864 format a file.
 865 .
 866 .P
 867 The
 868 .BR \%groffer (@MAN1EXT@)
 869 program is an allround-viewer for groff files and man pages.
 870 .
 871 .
 872 .\" --------------------------------------------------------------------
 873 .SS Preprocessors
 874 .\" --------------------------------------------------------------------
 875 .
 876 The groff preprocessors are reimplementations of the classical
 877 preprocessors with moderate extensions.
 878 .
 879 The preprocessors distributed with the
 880 .I groff
 881 package are
 882 .
 883 .TP
 884 .BR @g@eqn (@MAN1EXT@)
 885 for mathematical formul\(ae,
 886 .TP
 887 .BR @g@grn (@MAN1EXT@)
 888 for including
 889 .BR gremlin (1)
 890 pictures,
 891 .TP
 892 .BR @g@pic (@MAN1EXT@)
 893 for drawing diagrams,
 894 .TP
 895 .BR \%@g@refer (@MAN1EXT@)
 896 for bibliographic references,
 897 .TP
 898 .BR \%@g@soelim (@MAN1EXT@)
 899 for including macro files from standard locations,
 900 .
 901 .P
 902 and
 903 .TP
 904 .BR @g@tbl (@MAN1EXT@)
 905 for tables.
 906 .
 907 .P
 908 Besides these, there are some internal preprocessors that are
 909 automatically run with some devices.
 910 .
 911 These aren't visible to the user.
 912 .
 913 .
 914 .\" --------------------------------------------------------------------
 915 .SS "Macro Packages"
 916 .\" --------------------------------------------------------------------
 917 .
 918 Macro packages can be included by option
 919 .ShortOpt m .
 920 .
 921 The groff system implements and extends all classical macro packages
 922 in a compatible way and adds some packages of its own.
 923 .
 924 Actually, the following macro packages come with
 925 .IR groff :
 926 .
 927 .TP
 928 .B man
 929 The traditional man page format; see
 930 .BR \%groff_man (@MAN7EXT@).
 931 It can be specified on the command line as
 932 .ShortOpt man
 933 or
 934 .ShortOpt m
 935 .BR man .
 936 .
 937 .TP
 938 .B mandoc
 939 The general package for man pages; it automatically recognizes
 940 whether the documents uses the
 941 .I man
 942 or the
 943 .I mdoc
 944 format and branches to the corresponding macro package.
 945 .
 946 It can be specified on the command line as
 947 .ShortOpt mandoc
 948 or
 949 .ShortOpt m
 950 .BR mandoc .
 951 .
 952 .TP
 953 .B mdoc
 954 The BSD-style man page format; see
 955 .BR \%groff_mdoc (@MAN7EXT@).
 956 It can be specified on the command line as
 957 .ShortOpt mdoc
 958 or
 959 .ShortOpt m
 960 .BR mdoc .
 961 .
 962 .TP
 963 .B me
 964 The classical
 965 .I me
 966 document format; see
 967 .BR \%groff_me (@MAN7EXT@).
 968 It can be specified on the command line as
 969 .ShortOpt me
 970 or
 971 .ShortOpt m
 972 .BR me .
 973 .
 974 .TP
 975 .B mm
 976 The classical
 977 .I mm
 978 document format; see
 979 .BR \%groff_mm (@MAN7EXT@).
 980 It can be specified on the command line as
 981 .ShortOpt mm
 982 or
 983 .ShortOpt m
 984 .BR mm .
 985 .
 986 .TP
 987 .B ms
 988 The classical
 989 .I ms
 990 document format; see
 991 .BR \%groff_ms (@MAN7EXT@).
 992 It can be specified on the command line as
 993 .ShortOpt ms
 994 or
 995 .ShortOpt m
 996 .BR ms .
 997 .
 998 .TP
 999 .B www
1000 HTML-like macros for inclusion in arbitrary groff documents; see
1001 .BR \%groff_www (@MAN7EXT@).
1002 .
1003 .P
1004 Details on the naming of macro files and their placement can be found
1005 in
1006 .BR \%groff_tmac (@MAN5EXT@);
1007 this man page also documents some other, minor auxiliary macro packages
1008 not mentioned here.
1009 .
1010 .
1011 .\" --------------------------------------------------------------------
1012 .SS "Programming Language"
1013 .\" --------------------------------------------------------------------
1014 .
1015 General concepts common to all roff programming languages are
1016 described in
1017 .BR roff (@MAN7EXT@).
1018 .
1019 .P
1020 The groff extensions to the classical troff language are documented in
1021 .BR \%groff_diff (@MAN7EXT@).
1022 .
1023 .P
1024 The groff language as a whole is described in the (still incomplete)
1025 .IR "groff info file" ;
1026 a short (but complete) reference can be found in
1027 .BR groff (@MAN7EXT@).
1028 .
1029 .
1030 .\" --------------------------------------------------------------------
1031 .SS Formatters
1032 .\" --------------------------------------------------------------------
1033 .
1034 The central roff formatter within the groff system is
1035 .BR @g@troff (@MAN1EXT@).
1036 It provides the features of both the classical troff and nroff, as
1037 well as the groff extensions.
1038 .
1039 The command line option
1040 .ShortOpt C
1041 switches
1042 .B @g@troff
1043 into
1044 .I "compatibility mode"
1045 which tries to emulate classical roff as much as possible.
1046 .
1047 .P
1048 There is a shell script
1049 .BR @g@nroff (@MAN1EXT@)
1050 that emulates the behavior of classical nroff.
1051 .
1052 It tries to automatically select the proper output encoding, according to
1053 the current locale.
1054 .
1055 .P
1056 The formatter program generates
1057 .IR "intermediate output" ;
1058 see
1059 .BR \%groff_out (@MAN7EXT@).
1060 .
1061 .
1062 .\" --------------------------------------------------------------------
1063 .SS Devices
1064 .\" --------------------------------------------------------------------
1065 .
1066 In roff, the output targets are called
1067 .IR devices .
1068 A device can be a piece of hardware, e.g. a printer, or a software
1069 file format.
1070 .
1071 A device is specified by the option
1072 .ShortOpt T .
1073 The groff devices are as follows.
1074 .
1075 .TP
1076 .B ascii
1077 Text output using the
1078 .BR ascii (7)
1079 character set.
1080 .
1081 .TP
1082 .B cp1047
1083 Text output using the EBCDIC code page IBM cp1047 (e.g. OS/390 Unix).
1084 .
1085 .TP
1086 .B dvi
1087 TeX DVI format.
1088 .
1089 .TP
1090 .B html
1091 HTML output.
1092 .
1093 .TP
1094 .B latin1
1095 Text output using the ISO \%Latin-1 (ISO \%8859-1) character set; see
1096 .BR \%iso_8859_1 (7).
1097 .
1098 .TP
1099 .B koi8-r
1100 Text output using the Russian KOI8-R character set.
1101 .
1102 .TP
1103 .B lbp
1104 Output for Canon CAPSL printers (\%LBP-4 and \%LBP-8 series laser printers).
1105 .
1106 .TP
1107 .B lj4
1108 HP LaserJet4-compatible (or other PCL5-compatible) printers.
1109 .
1110 .TP
1111 .B ps
1112 PostScript output; suitable for printers and previewers like
1113 .BR gv (1).
1114 .
1115 .TP
1116 .B utf8
1117 Text output using the Unicode (ISO 10646) character set with \%UTF-8
1118 encoding; see
1119 .BR unicode (7).
1120 .
1121 .TP
1122 .B X75
1123 75dpi X Window System output suitable for the previewers
1124 .BR \%xditview (1x)
1125 and
1126 .BR \%gxditview (@MAN1EXT@).
1127 A variant for a 12\|pt document base font is
1128 .BR \%X75-12 .
1129 .
1130 .TP
1131 .B X100
1132 100dpi X Window System output suitable for the previewers
1133 .BR \%xditview (1x)
1134 and
1135 .BR \%gxditview (@MAN1EXT@).
1136 A variant for a 12\|pt document base font is
1137 .BR \%X100-12 .
1138 .
1139 .P
1140 The postprocessor to be used for a device is specified by the
1141 .B postpro
1142 command in the device description file; see
1143 .BR \%groff_font (@MAN5EXT@).
1144 .
1145 This can be overridden with the
1146 .B \*[@-]X
1147 option.
1148 .
1149 .P
1150 The default device is
1151 .BR @DEVICE@ .
1152 .
1153 .
1154 .\" --------------------------------------------------------------------
1155 .SS Postprocessors
1156 .\" --------------------------------------------------------------------
1157 .
1158 groff provides 3\~hardware postprocessors:
1159 .
1160 .TP
1161 .BR \%grolbp (@MAN1EXT@)
1162 for some Canon printers,
1163 .TP
1164 .BR \%grolj4 (@MAN1EXT@)
1165 for printers compatible to the HP LaserJet\~4 and PCL5,
1166 .TP
1167 .BR \%grotty (@MAN1EXT@)
1168 for text output using various encodings, e.g. on text-oriented
1169 terminals or line-printers.
1170 .
1171 .P
1172 Today, most printing or drawing hardware is handled by the operating
1173 system, by device drivers, or by software interfaces, usually accepting
1174 PostScript.
1175 .
1176 Consequently, there isn't an urgent need for more hardware device
1177 postprocessors.
1178 .
1179 .P
1180 The groff software devices for conversion into other document file
1181 formats are
1182 .
1183 .TP
1184 .BR \%grodvi (@MAN1EXT@)
1185 for the DVI format,
1186 .TP
1187 .BR \%grohtml (@MAN1EXT@)
1188 for HTML format,
1189 .TP
1190 .BR grops (@MAN1EXT@)
1191 for PostScript.
1192 .
1193 .P
1194 Combined with the many existing free conversion tools this should
1195 be sufficient to convert a troff document into virtually any existing
1196 data format.
1197 .
1198 .
1199 .\" --------------------------------------------------------------------
1200 .SS Utilities
1201 .\" --------------------------------------------------------------------
1202 .
1203 The following utility programs around groff are available.
1204 .
1205 .TP
1206 .BR \%addftinfo (@MAN1EXT@)
1207 Add information to troff font description files for use with groff.
1208 .
1209 .TP
1210 .BR \%afmtodit (@MAN1EXT@)
1211 Create font description files for PostScript device.
1212 .
1213 .TP
1214 .BR \%groffer (@MAN1EXT@)
1215 General viewer program for groff files and man pages.
1216 .
1217 .TP
1218 .BR \%gxditview (@MAN1EXT@)
1219 The groff X viewer, the GNU version of xditview.
1220 .
1221 .TP
1222 .BR \%hpftodit (@MAN1EXT@)
1223 Create font description files for lj4 device.
1224 .
1225 .TP
1226 .BR \%indxbib (@MAN1EXT@)
1227 Make inverted index for bibliographic databases.
1228 .
1229 .TP
1230 .BR lkbib (@MAN1EXT@)
1231 Search bibliographic databases.
1232 .
1233 .TP
1234 .BR \%lookbib (@MAN1EXT@)
1235 Interactively search bibliographic databases.
1236 .
1237 .TP
1238 .BR \%pfbtops (@MAN1EXT@)
1239 Translate a PostScript font in .pfb format to ASCII.
1240 .
1241 .TP
1242 .BR \%tfmtodit (@MAN1EXT@)
1243 Create font description files for TeX DVI device.
1244 .
1245 .TP
1246 .BR \%xditview (1x)
1247 roff viewer distributed with X window.
1248 .
1249 .
1250 .\" --------------------------------------------------------------------
1251 .SH ENVIRONMENT
1252 .\" --------------------------------------------------------------------
1253 .
1254 Normally, the path separator in the following environment variables is the
1255 colon; this may vary depending on the operating system.
1256 .
1257 For example, DOS and Windows use a semicolon instead.
1258 .
1259 .TP
1260 .EnvVar GROFF_BIN_PATH
1261 This search path, followed by
1262 .EnvVar $PATH ,
1263 will be used for commands that are executed by
1264 .BR groff .
1265 .
1266 If it is not set then the directory where the groff binaries were
1267 installed is prepended to
1268 .EnvVar PATH .
1269 .
1270 .TP
1271 .EnvVar GROFF_COMMAND_PREFIX
1272 When there is a need to run different roff implementations at the same
1273 time
1274 .I groff
1275 provides the facility to prepend a prefix to most of its programs that
1276 could provoke name clashings at run time (default is to have none).
1277 .
1278 Historically, this prefix was the character
1279 .BR g ,
1280 but it can be anything.
1281 .
1282 For example,
1283 .BR gtroff
1284 stood for
1285 .IR groff 's
1286 .BR troff ,
1287 .BR gtbl
1288 for the
1289 .I groff
1290 version of
1291 .BR tbl .
1292 .
1293 By setting
1294 .EnvVar GROFF_COMMAND_PREFIX
1295 to different values, the different roff installations can be
1296 addressed.
1297 .
1298 More exactly, if it is set to prefix
1299 .I xxx
1300 then
1301 .B groff
1302 as a wrapper program will internally call
1303 .IB xxx troff
1304 instead of
1305 .BR troff .
1306 This also applies to the preprocessors
1307 .BR \%eqn ,
1308 .BR \%grn ,
1309 .BR \%pic ,
1310 .BR \%refer ,
1311 .BR \%tbl ,
1312 .BR \%soelim ,
1313 and to the utilities
1314 .B \%@g@indxbib
1315 and
1316 .BR \%@g@lookbib .
1317 .
1318 This feature does not apply to any programs different from the ones
1319 above (most notably
1320 .B groff
1321 itself) since they are unique to the groff package.
1322 .
1323 .
1324 .TP
1325 .EnvVar GROFF_FONT_PATH
1326 A list of directories in which to search for the
1327 .BI dev name
1328 directory in addition to the default ones.
1329 .
1330 See
1331 .BR @g@troff (@MAN1EXT@)
1332 and
1333 .BR \%groff_font (@MAN5EXT@)
1334 for more details.
1335 .
1336 .
1337 .TP
1338 .EnvVar GROFF_TMAC_PATH
1339 A list of directories in which to search for macro files in addition to
1340 the default directories.
1341 .
1342 See
1343 .BR @g@troff (@MAN1EXT@)
1344 and
1345 .BR \%groff_tmac (@MAN5EXT@)
1346 for more details.
1347 .
1348 .
1349 .TP
1350 .EnvVar GROFF_TMPDIR
1351 The directory in which temporary files will be created.
1352 .
1353 If this is not set but the environment variable
1354 .EnvVar TMPDIR
1355 instead, temporary files will be created in the directory
1356 .EnvVar $TMPDIR .
1357 On MS-DOS and Windows\ 32 platforms, the environment variables
1358 .EnvVar TMP
1359 and
1360 .EnvVar TEMP
1361 (in that order) are searched also, after
1362 .EnvVar GROFF_TMPDIR
1363 and
1364 .EnvVar TMPDIR .
1365 .
1366 Otherwise, temporary files will be created in
1367 .BR /tmp .
1368 The
1369 .BR \%@g@refer (@MAN1EXT@),
1370 .BR \%groffer (@MAN1EXT@),
1371 .BR \%grohtml (@MAN1EXT@),
1372 and
1373 .BR grops (@MAN1EXT@)
1374 commands use temporary files.
1375 .
1376 .
1377 .TP
1378 .EnvVar GROFF_TYPESETTER
1379 Preset the default device.
1380 .
1381 If this is not set the
1382 .B @DEVICE@
1383 device is used as default.
1384 .
1385 This device name is overwritten by the option
1386 .ShortOpt T .
1387 .
1388 .
1389 .\" --------------------------------------------------------------------
1390 .SH FILES
1391 .\" --------------------------------------------------------------------
1392 .
1393 There are some directories in which
1394 .I groff
1395 installs all of its data files.
1396 .
1397 Due to different installation habits on different operating systems,
1398 their locations are not absolutely fixed, but their function is
1399 clearly defined and coincides on all systems.
1400 .
1401 .
1402 .\" --------------------------------------------------------------------
1403 .SS "groff Macro Directory"
1404 .\" --------------------------------------------------------------------
1405 .
1406 This contains all information related to macro packages.
1407 .
1408 Note that more than a single directory is searched for those files
1409 as documented in
1410 .BR \%groff_tmac (@MAN5EXT@).
1411 .
1412 For the groff installation corresponding to this document, it is
1413 located at
1414 .IR @MACRODIR@ .
1415 .
1416 The following files contained in the
1417 .I groff macro directory
1418 have a special meaning:
1419 .
1420 .
1421 .TP
1422 .B troffrc
1423 Initialization file for troff.
1424 .
1425 This is interpreted by
1426 .B @g@troff
1427 before reading the macro sets and any input.
1428 .
1429 .
1430 .TP
1431 .B troffrc-end
1432 Final startup file for troff, it is parsed after all macro sets have
1433 been read.
1434 .
1435 .
1436 .TP
1437 .IB name .tmac
1438 .TP+
1439 .BI tmac. name
1440 Macro file for macro package
1441 .IR name .
1442 .
1443 .
1444 .\" --------------------------------------------------------------------
1445 .SS "groff Font Directory"
1446 .\" --------------------------------------------------------------------
1447 .
1448 This contains all information related to output devices.
1449 .
1450 Note that more than a single directory is searched for those files; see
1451 .BR @g@troff (@MAN1EXT@).
1452 .
1453 For the groff installation corresponding to this document, it is
1454 located at
1455 .IR @FONTDIR@ .
1456 .
1457 The following files contained in the
1458 .I groff font directory
1459 have a special meaning:
1460 .
1461 .
1462 .TP
1463 .BI dev name /DESC
1464 Device description file for device
1465 .IR name ,
1466 see
1467 .BR \%groff_font (@MAN5EXT@).
1468 .
1469 .
1470 .TP
1471 .BI dev name / F
1472 Font file for font
1473 .I F
1474 of device
1475 .IR name .
1476 .
1477 .
1478 .\" --------------------------------------------------------------------
1479 .SH EXAMPLES
1480 .\" --------------------------------------------------------------------
1481 .
1482 The following example illustrates the power of the
1483 .B groff
1484 program as a wrapper around
1485 .BR @g@troff .
1486 .
1487 .P
1488 To process a roff file using the preprocessors
1489 .B tbl
1490 and
1491 .B pic
1492 and the
1493 .B me
1494 macro set, classical troff had to be called by
1495 .
1496 .P
1497 .ShellCommand pic foo.me | tbl | troff \*[@-]me \*[@-]Tlatin1 | grotty
1498 .
1499 .P
1500 Using
1501 .BR groff ,
1502 this pipe can be shortened to the equivalent command
1503 .P
1504 .ShellCommand groff \*[@-]p \*[@-]t \*[@-]me \*[@-]T latin1 foo.me
1505 .
1506 .P
1507 An even easier way to call this is to use
1508 .BR grog (@MAN1EXT@)
1509 to guess the preprocessor and macro options and execute the generated
1510 command (by using backquotes to specify shell command substitution)
1511 .P
1512 .ShellCommand \`grog \*[@-]Tlatin1 foo.me\`
1513 .
1514 .P
1515 The simplest way is to view the contents in an automated way by
1516 calling
1517 .
1518 .P
1519 .ShellCommand groffer foo.me
1520 .
1521 .
1522 .\" --------------------------------------------------------------------
1523 .SH BUGS
1524 .\" --------------------------------------------------------------------
1525 .
1526 .P
1527 On EBCDIC hosts (e.g. OS/390 Unix), output devices
1528 .B ascii
1529 and
1530 .B latin1
1531 aren't available.
1532 .
1533 Similarly, output for EBCDIC code page
1534 .B cp1047
1535 is not available on ASCII based operating systems.
1536 .
1537 .P
1538 Report bugs to bug-groff@gnu.org.
1539 .
1540 Include a complete, self-contained example that will allow the bug to
1541 be reproduced, and say which version of groff you are using.
1542 .
1543 .
1544 .\" --------------------------------------------------------------------
1545 .SH AVAILABILITY
1546 .\" --------------------------------------------------------------------
1547 .
1548 Information on how to get groff and related information is available
1549 at the
1550 .URL http://\:www.gnu.org/\:software/\:groff "GNU website" .
1551 The most recent released version of groff is available for anonymous
1552 ftp at the
1553 .URL ftp://ftp.ffii.org/\:pub/\:groff/\:devel/\:groff-current.tar.gz \
1554      "groff development site" .
1555 .
1556 .P
1557 Three groff mailing lists are available:
1558 .TP
1559 .MTO bug-groff@gnu.org
1560 for reporting bugs,
1561 .
1562 .TP
1563 .MTO groff@gnu.org
1564 for general discussion of groff,
1565 .
1566 .TP
1567 .MTO groff-commit@ffii.org
1568 a read-only list showing logs of commitments to the CVS repository.
1569 .
1570 .P
1571 Details on CVS access and much more can be found in the file
1572 .B README
1573 at the top directory of the groff source package.
1574 .
1575 .P
1576 There is a free implementation of the
1577 .B grap
1578 preprocessor, written by
1579 .MTO faber@lunabase.org " Ted Faber" .
1580 .
1581 The actual version can be found at the
1582 .
1583 .URL http://\:www.lunabase.org/\:~faber/\:Vault/\:software/\:grap/ \
1584      "grap website" .
1585 This is the only grap version supported by groff.
1586 .
1587 .
1588 .\" --------------------------------------------------------------------
1589 .SH AUTHORS
1590 .\" --------------------------------------------------------------------
1591 .
1592 Copyright \(co 1989, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
1593 .
1594 .P
1595 This document is distributed under the terms of the FDL (GNU Free
1596 Documentation License) version 1.1 or later.
1597 .
1598 You should have received a copy of the FDL on your system, it is also
1599 available on-line at the
1600 .URL http://\:www.gnu.org/\:copyleft/\:fdl.html "GNU copyleft site" .
1601 .
1602 .P
1603 This document is based on the original groff man page written by
1604 .MTO jjc@jclark.com "James Clark" .
1605 .
1606 It was rewritten, enhanced, and put under the FDL license by
1607 \m[blue]Bernd Warken\m[].
1608 .
1609 It is maintained by
1610 .MTO wl@gnu.org "Werner Lemberg" .
1611 .
1612 .P
1613 .I groff
1614 is a GNU free software project.
1615 .
1616 All parts of the
1617 .I groff package
1618 are protected by GNU copyleft licenses.
1619 .
1620 The software files are distributed under the terms of the GNU General
1621 Public License (GPL), while the documentation files mostly use the GNU
1622 Free Documentation License (FDL).
1623 .
1624 .
1625 .\" --------------------------------------------------------------------
1626 .SH "SEE ALSO"
1627 .\" --------------------------------------------------------------------
1628 .
1629 The
1630 .IR "groff info file"
1631 contains all information on the groff system within a single document.
1632 .
1633 Beneath the detailed documentation of all aspects, it provides
1634 examples and background information.
1635 .
1636 See
1637 .BR info (1)
1638 on how to read it.
1639 .
1640 .P
1641 Due to its complex structure, the groff system has many man pages.
1642 .
1643 They can be read with
1644 .BR man (1)
1645 or
1646 .BR \%groffer (@MAN1EXT@).
1647 .
1648 .TP
1649 Introduction, history and further readings:
1650 .BR roff (@MAN7EXT@).
1651 .
1652 .TP
1653 Viewer for groff files:
1654 .BR \%groffer (@MAN1EXT@),
1655 .BR \%gxditview (@MAN1EXT@),
1656 .BR \%xditview (1x).
1657 .
1658 .TP
1659 Wrapper programs for formatters:
1660 .BR \%groff (@MAN1EXT@),
1661 .BR \%grog (@MAN1EXT@).
1662 .
1663 .TP
1664 Roff preprocessors:
1665 .BR \%@g@eqn (@MAN1EXT@),
1666 .BR \%@g@grn (@MAN1EXT@),
1667 .BR \%@g@pic (@MAN1EXT@),
1668 .BR \%@g@refer (@MAN1EXT@),
1669 .BR \%@g@soelim (@MAN1EXT@),
1670 .BR \%@g@tbl (@MAN1EXT@),
1671 .BR grap (1).
1672 .
1673 .TP
1674 Roff language with the groff extensions:
1675 .BR \%groff (@MAN7EXT@),
1676 .BR \%groff_char (@MAN7EXT@),
1677 .BR \%groff_diff (@MAN7EXT@),
1678 .BR \%groff_font (@MAN5EXT@).
1679 .
1680 .TP
1681 Roff formatter programs:
1682 .BR \%@g@nroff (@MAN1EXT@),
1683 .BR \%@g@troff (@MAN1EXT@),
1684 .BR ditroff (@MAN7EXT@).
1685 .
1686 .TP
1687 The
1688 .I intermediate output
1689 language:
1690 .BR \%groff_out (@MAN7EXT@).
1691 .
1692 .TP
1693 Postprocessors for the output devices:
1694 .BR \%grodvi (@MAN1EXT@),
1695 .BR \%grohtml (@MAN1EXT@),
1696 .BR \%grolbp (@MAN1EXT@),
1697 .BR \%grolj4 (@MAN1EXT@),
1698 .BR \%lj4_font (@MAN5EXT@),
1699 .BR \%grops (@MAN1EXT@),
1700 .BR \%grotty (@MAN1EXT@).
1701 .
1702 .TP
1703 Groff macro packages and macro-specific utilities:
1704 .BR \%groff_tmac (@MAN5EXT@),
1705 .BR \%groff_man (@MAN7EXT@),
1706 .BR \%groff_mdoc (@MAN7EXT@),
1707 .BR \%groff_me (@MAN7EXT@),
1708 .BR \%groff_mm (@MAN7EXT@),
1709 .BR \%groff_mmse (@MAN7EXT@),
1710 .BR \%groff_mom (@MAN7EXT@),
1711 .BR \%groff_ms (@MAN7EXT@),
1712 .BR \%groff_www (@MAN7EXT@),
1713 .BR \%groff_trace (@MAN7EXT@),
1714 .BR \%mmroff (@MAN7EXT@).
1715 .
1716 .TP
1717 The following utilities are available:
1718 .BR \%addftinfo (@MAN1EXT@),
1719 .BR \%afmtodit (@MAN1EXT@),
1720 .BR \%eqn2graph (@MAN1EXT@),
1721 .BR \%grap2graph (@MAN1EXT@),
1722 .BR \%groffer (@MAN1EXT@),
1723 .BR \%gxditview (@MAN1EXT@),
1724 .BR \%hpftodit (@MAN1EXT@),
1725 .BR \%@g@indxbib (@MAN1EXT@),
1726 .BR \%@g@lookbib (@MAN1EXT@),
1727 .BR \%pfbtops (@MAN1EXT@),
1728 .BR \%pic2graph (@MAN1EXT@),
1729 .BR \%tfmtodit (@MAN1EXT@).
1730 .
1731 .cp \n[groff_C]
1732 .
1733 .\" --------------------------------------------------------------------
1734 .\" Emacs setup
1735 .\" --------------------------------------------------------------------
1736 .
1737 .\" Local Variables:
1738 .\" mode: nroff
1739 .\" End: