src/roff/groff/groff.man

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