4 Last update: 01 Jul 2005
6 Copyright (C) 1989, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
7 Rewritten in 2002 by Bernd Warken <bwarken@mayn.de>
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.
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.
22 .\" --------------------------------------------------------------------
24 .\" --------------------------------------------------------------------
31 .\" set adjust to both
34 .\" fonts of fixed length
46 .\" --------------------------------------------------------------------
47 .\" String definitions
52 .ds Ellipsis .\|.\|.\"
55 .\" --------------------------------------------------------------------
56 .\" Begin of macro definitions
58 .\" this is like a comment request when escape mechanism is off
62 .c --------------------------------------------------------------------
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.
72 . ie \n[.$]=0:((0\$1)*2u>(\n.lu-\n(.iu)) .TP
75 .c --------------------------------------------------------------------
79 .c --------------------------------------------------------------------
82 . nr @old_indent \n[.i]
84 . in +\w'\f[B]\*[@arg1]\0'u
90 .c --------------------------------------------------------------------
95 .c --------------------------------------------------------------------
96 .c ShortOpt[] (name [arg])
98 .c short option in synopsis
106 . Text \f[R][\f[]\f[CB]\*[@-]\*[@opt]\f[]\f[R]]\f[]
108 . Text \f[R][\f[]\f[CB]\*[@-]\*[@opt]\~\f[]\f[I]\/\$*\f[]\f[R]]\f[]
111 .c --------------------------------------------------------------------
112 .c Option in synopsis (short option)
119 . Text \f[R][\f[]\f[CB]\*[@-]\*[@opt]\f[]\f[R]]\f[]
121 . Text \f[R][\f[]\f[CB]\*[@-]\*[@opt]\~\f[]\f[I]\/\$*\f[]\f[R]]\f[]
124 .c --------------------------------------------------------------------
125 .c ShortOpt ([char [punct]])
127 .c `-c' somewhere in the text
128 .c second arg is punctuation
133 . Text \f[CB]\*[@-]\*[@opt]\f[]\/\$*
136 .c --------------------------------------------------------------------
137 .c LongOpt ([name [punct]])
139 .c `--name' somewhere in the text
140 .c second arg is punctuation
145 . Text \f[CB]\*[@--]\f[]\f[B]\*[@opt]\f[]\/\$*
148 .c --------------------------------------------------------------------
149 .c OptDef (shortopt [longopt [argument]])
151 .c option documentation
152 .c args : `shortopt', `longopt' can be ""
161 . ds @short "\f[CB]\*[@-]\*[@arg1]\f[]\"
163 . if !'\*[@short]'' \
164 . as @short \f[CW]\0\f[]
167 . ds @long "\f[CB]\*[@--]\f[]\f[B]\*[@arg2]\f[]\"
176 . IP "\f[R]\*[@short]\*[@long]\*[@arg]\f[]"
183 .c --------------------------------------------------------------------
184 .c Continuation of an OptDef header.
190 .c --------------------------------------------------------------------
191 .c Environment variable
196 .c --------------------------------------------------------------------
197 .c a shell command line
200 . c replace argument separator by unbreakable space
203 . while (\n[.$]>0) \{\
204 . ds @args \*[@args]\~\$1
210 . Text \f[I]sh#\h'1m'\f[P]\f[CR]\*[@args]\f[P]\&\"
220 .c --------------------------------------------------------------------
227 .c --------------------------------------------------------------------
228 .c End of macro definitions
232 .\" --------------------------------------------------------------------
234 .\" --------------------------------------------------------------------
236 .TH GROFF @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
238 groff \- front-end for the groff document formatting system
241 .\" --------------------------------------------------------------------
243 .\" --------------------------------------------------------------------
247 .ShortOpt[] abcegilpstzCEGNRSUVXZ
281 The command line is parsed according to the usual GNU convention.
283 The whitespace between a command line option and its argument is
286 Options can be grouped behind a single
292 (minus character) denotes the standard input.
295 .\" --------------------------------------------------------------------
297 .\" --------------------------------------------------------------------
299 This document describes the
301 program, the main front-end for the
303 document formatting system.
307 program and macro suite is the implementation of a
309 system within the free software collection
310 .URL http://\:www.gnu.org "GNU" .
314 system has all features of the classical
316 but adds many extensions.
321 program allows to control the whole
323 system by command line options.
325 This is a great simplification in comparison to the classical case (which
329 .\" --------------------------------------------------------------------
331 .\" --------------------------------------------------------------------
335 is a wrapper program for
337 both programs share a set of options.
341 program has some additional, native options and gives a new meaning to
346 On the other hand, not all
348 options can be fed into
352 .\" --------------------------------------------------------------------
353 .SS Native groff Options
354 .\" --------------------------------------------------------------------
356 The following options either do not exist for
358 or are differently interpreted by
378 Print a help message.
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
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
402 Send the output to a spooler program for printing.
404 The command that should be used for this is specified by the
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
421 to the spooler program.
422 Several arguments should be passed with a separate
429 .ShortOpt\" just a minus sign
432 before passing it to the spooler program.
436 Don't allow newlines within
440 This is the same as the
451 .OptDef P "" "\*[@-]option"
452 .OptDef+ P "" "\*[@-]option \f[CB]\*[@-]P\f[] arg"
457 to the postprocessor.
459 The option must be specified with the necessary preceding minus
464 because groff does not prepend any dashes before passing it to the
467 For example, to pass a title to the \%gxditview postprocessor, the shell
470 .ShellCommand groff \*[@-]X \*[@-]P \*[@-]title \*[@-]P 'groff it' \f[I]foo\f[]
474 .ShellCommand groff \*[@-]X \*[@-]Z \f[I]foo\f[] | \
475 gxditview \*[@-]title 'groff it' \*[@-]
482 No mechanism is provided for passing arguments to
486 options have equivalent language elements that can be specified within
490 .BR \%@g@refer (@MAN1EXT@)
506 and disable the following
515 For security reasons, safer mode is enabled by default.
532 .BR \%groff_out (@MAN5EXT@).
536 calls a postprocessor to convert
538 .I intermediate output
548 TeX DVI format (postprocessor is
551 HTML output (preprocessors are
556 .BR \%post-grohtml ).
558 Canon CAPSL printers (\%LBP-4 and \%LBP-8 series laser printers;
562 HP LaserJet4 compatible (or other PCL5 compatible) printers (postprocessor
566 PostScript output (postprocessor is
572 For the following TTY output devices (postprocessor is always
575 selects the output encoding:
581 \%Latin-1 character set for EBCDIC hosts.
585 Unicode character set in \%UTF-8 encoding.
590 The following arguments select
592 as the `postprocessor' (it is rather a viewing program):
597 75dpi resolution, 10pt document base font.
599 75dpi resolution, 12pt document base font.
601 100dpi resolution, 10pt document base font.
603 100dpi resolution, 12pt document base font.
608 The default device is
615 Reverts to the (old) unsafe behaviour; see option
620 Output version information of
622 and of all programs that are run by it; that is, the given command line
623 is parsed in the usual way, passing
629 Output the pipeline that would be run by
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.
639 instead of using the usual postprocessor to (pre)view a document.
641 The printing spooler behavior as outlined with options
646 .BR \%gxditview (@MAN1EXT@)
647 by determining an argument for the
648 .B \*[@-]printCommand
650 .BR \%gxditview (@MAN1EXT@).
652 This sets the default
654 action and the corresponding menu entry to that value.
657 only produces good results with
665 The default resolution for previewing
667 output is 75\|dpi; this can be changed by passing the
674 .ShellCommand groff \*[@-]X \*[@-]P\*[@-]resolution \*[@-]P100 \*[@-]man foo.1
678 Suppress output generated by
680 Only error messages will be printed.
685 .I groff intermediate output
686 to standard output; see
687 .BR \%groff_out (@MAN5EXT@).
690 calls automatically a postprocessor.
692 With this option, the output of
694 for the device, the so-called
695 .I intermediate output
696 is issued without postprocessing.
699 .\" --------------------------------------------------------------------
700 .SS Transparent Options
701 .\" --------------------------------------------------------------------
703 The following options are transparently handed over to the formatter
706 that is called by groff subsequently.
708 These options are described in more detail in
709 .BR @g@troff (@MAN1EXT@).
712 ascii approximation of output.
715 backtrace on error or warning.
718 disable color output.
721 .BR \%grotty (@MAN1EXT@)
722 man page for more details.
725 enable compatibility mode.
737 set default font family.
740 set path for font DESC files.
743 process standard input after the specified input files.
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@).
751 path for macro files.
754 number the first page
774 .\" --------------------------------------------------------------------
776 .\" --------------------------------------------------------------------
780 implements the infrastructure of classical roff; see
782 for a survey on how a roff system works in general.
784 Due to the front-end programs available within the groff system, using
787 .IR "classical roff" .
789 This section gives an overview of the parts that constitute the groff
794 with groff-specific features.
796 This section can be regarded as a guide to the documentation around
800 .\" --------------------------------------------------------------------
802 .\" --------------------------------------------------------------------
808 to format the input is controlled globally with the requests
814 .BR groff_tmac (@MAN5EXT@)
815 for the `papersize' macro package which provides a convenient interface.
820 paper size, giving the actual dimensions of the paper sheets, is
821 controlled by output devices like
823 with the command line options
828 .BR groff_font (@MAN5EXT@)
829 and the man pages of the output devices for more details.
831 uses the command line option
833 to pass options to output devices; for example, the following selects
834 A4 paper in landscape orientation for the PS device:
838 groff -Tps -P-pa4 -P-l .\|.\|.
842 .\" --------------------------------------------------------------------
844 .\" --------------------------------------------------------------------
848 program is a wrapper around the
849 .BR @g@troff (@MAN1EXT@)
852 It allows to specify the preprocessors by command line options and
853 automatically runs the postprocessor that is appropriate for the
856 Doing so, the sometimes tedious piping mechanism of classical
863 program can be used for guessing the correct groff command line to
868 .BR \%groffer (@MAN1EXT@)
869 program is an allround-viewer for groff files and man pages.
872 .\" --------------------------------------------------------------------
874 .\" --------------------------------------------------------------------
876 The groff preprocessors are reimplementations of the classical
877 preprocessors with moderate extensions.
879 The preprocessors distributed with the
884 .BR @g@eqn (@MAN1EXT@)
885 for mathematical formul\(ae,
887 .BR @g@grn (@MAN1EXT@)
892 .BR @g@pic (@MAN1EXT@)
893 for drawing diagrams,
895 .BR \%@g@refer (@MAN1EXT@)
896 for bibliographic references,
898 .BR \%@g@soelim (@MAN1EXT@)
899 for including macro files from standard locations,
904 .BR @g@tbl (@MAN1EXT@)
908 Besides these, there are some internal preprocessors that are
909 automatically run with some devices.
911 These aren't visible to the user.
914 .\" --------------------------------------------------------------------
916 .\" --------------------------------------------------------------------
918 Macro packages can be included by option
921 The groff system implements and extends all classical macro packages
922 in a compatible way and adds some packages of its own.
924 Actually, the following macro packages come with
929 The traditional man page format; see
930 .BR \%groff_man (@MAN7EXT@).
931 It can be specified on the command line as
939 The general package for man pages; it automatically recognizes
940 whether the documents uses the
944 format and branches to the corresponding macro package.
946 It can be specified on the command line as
954 The BSD-style man page format; see
955 .BR \%groff_mdoc (@MAN7EXT@).
956 It can be specified on the command line as
967 .BR \%groff_me (@MAN7EXT@).
968 It can be specified on the command line as
979 .BR \%groff_mm (@MAN7EXT@).
980 It can be specified on the command line as
991 .BR \%groff_ms (@MAN7EXT@).
992 It can be specified on the command line as
1000 HTML-like macros for inclusion in arbitrary groff documents; see
1001 .BR \%groff_www (@MAN7EXT@).
1004 Details on the naming of macro files and their placement can be found
1006 .BR \%groff_tmac (@MAN5EXT@);
1007 this man page also documents some other, minor auxiliary macro packages
1011 .\" --------------------------------------------------------------------
1012 .SS "Programming Language"
1013 .\" --------------------------------------------------------------------
1015 General concepts common to all roff programming languages are
1017 .BR roff (@MAN7EXT@).
1020 The groff extensions to the classical troff language are documented in
1021 .BR \%groff_diff (@MAN7EXT@).
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@).
1030 .\" --------------------------------------------------------------------
1032 .\" --------------------------------------------------------------------
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.
1039 The command line option
1044 .I "compatibility mode"
1045 which tries to emulate classical roff as much as possible.
1048 There is a shell script
1049 .BR @g@nroff (@MAN1EXT@)
1050 that emulates the behavior of classical nroff.
1052 It tries to automatically select the proper output encoding, according to
1056 The formatter program generates
1057 .IR "intermediate output" ;
1059 .BR \%groff_out (@MAN7EXT@).
1062 .\" --------------------------------------------------------------------
1064 .\" --------------------------------------------------------------------
1066 In roff, the output targets are called
1068 A device can be a piece of hardware, e.g. a printer, or a software
1071 A device is specified by the option
1073 The groff devices are as follows.
1077 Text output using the
1083 Text output using the EBCDIC code page IBM cp1047 (e.g. OS/390 Unix).
1095 Text output using the ISO \%Latin-1 (ISO \%8859-1) character set; see
1096 .BR \%iso_8859_1 (7).
1100 Text output using the Russian KOI8-R character set.
1104 Output for Canon CAPSL printers (\%LBP-4 and \%LBP-8 series laser printers).
1108 HP LaserJet4-compatible (or other PCL5-compatible) printers.
1112 PostScript output; suitable for printers and previewers like
1117 Text output using the Unicode (ISO 10646) character set with \%UTF-8
1123 75dpi X Window System output suitable for the previewers
1126 .BR \%gxditview (@MAN1EXT@).
1127 A variant for a 12\|pt document base font is
1132 100dpi X Window System output suitable for the previewers
1135 .BR \%gxditview (@MAN1EXT@).
1136 A variant for a 12\|pt document base font is
1140 The postprocessor to be used for a device is specified by the
1142 command in the device description file; see
1143 .BR \%groff_font (@MAN5EXT@).
1145 This can be overridden with the
1150 The default device is
1154 .\" --------------------------------------------------------------------
1156 .\" --------------------------------------------------------------------
1158 groff provides 3\~hardware postprocessors:
1161 .BR \%grolbp (@MAN1EXT@)
1162 for some Canon printers,
1164 .BR \%grolj4 (@MAN1EXT@)
1165 for printers compatible to the HP LaserJet\~4 and PCL5,
1167 .BR \%grotty (@MAN1EXT@)
1168 for text output using various encodings, e.g. on text-oriented
1169 terminals or line-printers.
1172 Today, most printing or drawing hardware is handled by the operating
1173 system, by device drivers, or by software interfaces, usually accepting
1176 Consequently, there isn't an urgent need for more hardware device
1180 The groff software devices for conversion into other document file
1184 .BR \%grodvi (@MAN1EXT@)
1187 .BR \%grohtml (@MAN1EXT@)
1190 .BR grops (@MAN1EXT@)
1194 Combined with the many existing free conversion tools this should
1195 be sufficient to convert a troff document into virtually any existing
1199 .\" --------------------------------------------------------------------
1201 .\" --------------------------------------------------------------------
1203 The following utility programs around groff are available.
1206 .BR \%addftinfo (@MAN1EXT@)
1207 Add information to troff font description files for use with groff.
1210 .BR \%afmtodit (@MAN1EXT@)
1211 Create font description files for PostScript device.
1214 .BR \%groffer (@MAN1EXT@)
1215 General viewer program for groff files and man pages.
1218 .BR \%gxditview (@MAN1EXT@)
1219 The groff X viewer, the GNU version of xditview.
1222 .BR \%hpftodit (@MAN1EXT@)
1223 Create font description files for lj4 device.
1226 .BR \%indxbib (@MAN1EXT@)
1227 Make inverted index for bibliographic databases.
1230 .BR lkbib (@MAN1EXT@)
1231 Search bibliographic databases.
1234 .BR \%lookbib (@MAN1EXT@)
1235 Interactively search bibliographic databases.
1238 .BR \%pfbtops (@MAN1EXT@)
1239 Translate a PostScript font in .pfb format to ASCII.
1242 .BR \%tfmtodit (@MAN1EXT@)
1243 Create font description files for TeX DVI device.
1247 roff viewer distributed with X window.
1250 .\" --------------------------------------------------------------------
1252 .\" --------------------------------------------------------------------
1254 Normally, the path separator in the following environment variables is the
1255 colon; this may vary depending on the operating system.
1257 For example, DOS and Windows use a semicolon instead.
1260 .EnvVar GROFF_BIN_PATH
1261 This search path, followed by
1263 will be used for commands that are executed by
1266 If it is not set then the directory where the groff binaries were
1267 installed is prepended to
1271 .EnvVar GROFF_COMMAND_PREFIX
1272 When there is a need to run different roff implementations at the same
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).
1278 Historically, this prefix was the character
1280 but it can be anything.
1294 .EnvVar GROFF_COMMAND_PREFIX
1295 to different values, the different roff installations can be
1298 More exactly, if it is set to prefix
1302 as a wrapper program will internally call
1306 This also applies to the preprocessors
1313 and to the utilities
1318 This feature does not apply to any programs different from the ones
1321 itself) since they are unique to the groff package.
1325 .EnvVar GROFF_FONT_PATH
1326 A list of directories in which to search for the
1328 directory in addition to the default ones.
1331 .BR @g@troff (@MAN1EXT@)
1333 .BR \%groff_font (@MAN5EXT@)
1338 .EnvVar GROFF_TMAC_PATH
1339 A list of directories in which to search for macro files in addition to
1340 the default directories.
1343 .BR @g@troff (@MAN1EXT@)
1345 .BR \%groff_tmac (@MAN5EXT@)
1350 .EnvVar GROFF_TMPDIR
1351 The directory in which temporary files will be created.
1353 If this is not set but the environment variable
1355 instead, temporary files will be created in the directory
1357 On MS-DOS and Windows\ 32 platforms, the environment variables
1361 (in that order) are searched also, after
1362 .EnvVar GROFF_TMPDIR
1366 Otherwise, temporary files will be created in
1369 .BR \%@g@refer (@MAN1EXT@),
1370 .BR \%groffer (@MAN1EXT@),
1371 .BR \%grohtml (@MAN1EXT@),
1373 .BR grops (@MAN1EXT@)
1374 commands use temporary files.
1378 .EnvVar GROFF_TYPESETTER
1379 Preset the default device.
1381 If this is not set the
1383 device is used as default.
1385 This device name is overwritten by the option
1389 .\" --------------------------------------------------------------------
1391 .\" --------------------------------------------------------------------
1393 There are some directories in which
1395 installs all of its data files.
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.
1402 .\" --------------------------------------------------------------------
1403 .SS "groff Macro Directory"
1404 .\" --------------------------------------------------------------------
1406 This contains all information related to macro packages.
1408 Note that more than a single directory is searched for those files
1410 .BR \%groff_tmac (@MAN5EXT@).
1412 For the groff installation corresponding to this document, it is
1416 The following files contained in the
1417 .I groff macro directory
1418 have a special meaning:
1423 Initialization file for troff.
1425 This is interpreted by
1427 before reading the macro sets and any input.
1432 Final startup file for troff, it is parsed after all macro sets have
1440 Macro file for macro package
1444 .\" --------------------------------------------------------------------
1445 .SS "groff Font Directory"
1446 .\" --------------------------------------------------------------------
1448 This contains all information related to output devices.
1450 Note that more than a single directory is searched for those files; see
1451 .BR @g@troff (@MAN1EXT@).
1453 For the groff installation corresponding to this document, it is
1457 The following files contained in the
1458 .I groff font directory
1459 have a special meaning:
1464 Device description file for device
1467 .BR \%groff_font (@MAN5EXT@).
1478 .\" --------------------------------------------------------------------
1480 .\" --------------------------------------------------------------------
1482 The following example illustrates the power of the
1484 program as a wrapper around
1488 To process a roff file using the preprocessors
1494 macro set, classical troff had to be called by
1497 .ShellCommand pic foo.me | tbl | troff \*[@-]me \*[@-]Tlatin1 | grotty
1502 this pipe can be shortened to the equivalent command
1504 .ShellCommand groff \*[@-]p \*[@-]t \*[@-]me \*[@-]T latin1 foo.me
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)
1512 .ShellCommand \`grog \*[@-]Tlatin1 foo.me\`
1515 The simplest way is to view the contents in an automated way by
1519 .ShellCommand groffer foo.me
1522 .\" --------------------------------------------------------------------
1524 .\" --------------------------------------------------------------------
1527 On EBCDIC hosts (e.g. OS/390 Unix), output devices
1533 Similarly, output for EBCDIC code page
1535 is not available on ASCII based operating systems.
1538 Report bugs to bug-groff@gnu.org.
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.
1544 .\" --------------------------------------------------------------------
1546 .\" --------------------------------------------------------------------
1548 Information on how to get groff and related information is available
1550 .URL http://\:www.gnu.org/\:software/\:groff "GNU website" .
1551 The most recent released version of groff is available for anonymous
1553 .URL ftp://ftp.ffii.org/\:pub/\:groff/\:devel/\:groff-current.tar.gz \
1554 "groff development site" .
1557 Three groff mailing lists are available:
1559 .MTO bug-groff@gnu.org
1564 for general discussion of groff,
1567 .MTO groff-commit@ffii.org
1568 a read-only list showing logs of commitments to the CVS repository.
1571 Details on CVS access and much more can be found in the file
1573 at the top directory of the groff source package.
1576 There is a free implementation of the
1578 preprocessor, written by
1579 .MTO faber@lunabase.org " Ted Faber" .
1581 The actual version can be found at the
1583 .URL http://\:www.lunabase.org/\:~faber/\:Vault/\:software/\:grap/ \
1585 This is the only grap version supported by groff.
1588 .\" --------------------------------------------------------------------
1590 .\" --------------------------------------------------------------------
1592 Copyright \(co 1989, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
1595 This document is distributed under the terms of the FDL (GNU Free
1596 Documentation License) version 1.1 or later.
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" .
1603 This document is based on the original groff man page written by
1604 .MTO jjc@jclark.com "James Clark" .
1606 It was rewritten, enhanced, and put under the FDL license by
1607 \m[blue]Bernd Warken\m[].
1610 .MTO wl@gnu.org "Werner Lemberg" .
1614 is a GNU free software project.
1618 are protected by GNU copyleft licenses.
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).
1625 .\" --------------------------------------------------------------------
1627 .\" --------------------------------------------------------------------
1630 .IR "groff info file"
1631 contains all information on the groff system within a single document.
1633 Beneath the detailed documentation of all aspects, it provides
1634 examples and background information.
1641 Due to its complex structure, the groff system has many man pages.
1643 They can be read with
1646 .BR \%groffer (@MAN1EXT@).
1649 Introduction, history and further readings:
1650 .BR roff (@MAN7EXT@).
1653 Viewer for groff files:
1654 .BR \%groffer (@MAN1EXT@),
1655 .BR \%gxditview (@MAN1EXT@),
1656 .BR \%xditview (1x).
1659 Wrapper programs for formatters:
1660 .BR \%groff (@MAN1EXT@),
1661 .BR \%grog (@MAN1EXT@).
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@),
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@).
1681 Roff formatter programs:
1682 .BR \%@g@nroff (@MAN1EXT@),
1683 .BR \%@g@troff (@MAN1EXT@),
1684 .BR ditroff (@MAN7EXT@).
1688 .I intermediate output
1690 .BR \%groff_out (@MAN7EXT@).
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@).
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@).
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@).
1733 .\" --------------------------------------------------------------------
1735 .\" --------------------------------------------------------------------
1737 .\" Local Variables: