src/roff/groff/groff.1.man

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