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.
19 .\" --------------------------------------------------------------------
21 .\" --------------------------------------------------------------------
28 .\" set adjust to both
31 .\" fonts of fixed length
43 .\" --------------------------------------------------------------------
44 .\" String definitions
49 .ds Ellipsis .\|.\|.\"
52 .\" --------------------------------------------------------------------
53 .\" Begin of macro definitions
55 .\" this is like a comment request when escape mechanism is off
59 .c --------------------------------------------------------------------
65 .c --------------------------------------------------------------------
66 .c Like TP, but if specified indent is more than half
67 .c the current line-length - indent, use the default indent.
69 . ie \n[.$]=0:((0\$1)*2u>(\n.lu-\n(.iu)) .TP
72 .c --------------------------------------------------------------------
76 .c --------------------------------------------------------------------
79 . nr @old_indent \n[.i]
81 . in +\w'\f[B]\*[@arg1]\0'u
87 .c --------------------------------------------------------------------
92 .c --------------------------------------------------------------------
93 .c ShortOpt[] (name [arg])
95 .c short option in synopsis
103 . Text \f[R][\f[]\f[CB]\*[@-]\*[@opt]\f[]\f[R]]\f[]
105 . Text \f[R][\f[]\f[CB]\*[@-]\*[@opt]\~\f[]\f[I]\/\$*\f[]\f[R]]\f[]
108 .c --------------------------------------------------------------------
109 .c Option in synopsis (short option)
116 . Text \f[R][\f[]\f[CB]\*[@-]\*[@opt]\f[]\f[R]]\f[]
118 . Text \f[R][\f[]\f[CB]\*[@-]\*[@opt]\~\f[]\f[I]\/\$*\f[]\f[R]]\f[]
121 .c --------------------------------------------------------------------
122 .c ShortOpt ([char [punct]])
124 .c `-c' somewhere in the text
125 .c second arg is punctuation
130 . Text \f[CB]\*[@-]\*[@opt]\f[]\/\$*
133 .c --------------------------------------------------------------------
134 .c LongOpt ([name [punct]])
136 .c `--name' somewhere in the text
137 .c second arg is punctuation
142 . Text \f[CB]\*[@--]\f[]\f[B]\*[@opt]\f[]\/\$*
145 .c --------------------------------------------------------------------
146 .c OptDef (shortopt [longopt [argument]])
148 .c option documentation
149 .c args : `shortopt', `longopt' can be ""
158 . ds @short "\f[CB]\*[@-]\*[@arg1]\f[]\"
160 . if !'\*[@short]'' \
161 . as @short \f[CW]\0\f[]
164 . ds @long "\f[CB]\*[@--]\f[]\f[B]\*[@arg2]\f[]\"
173 . IP "\f[R]\*[@short]\*[@long]\*[@arg]\f[]"
180 .c --------------------------------------------------------------------
181 .c Continuation of an OptDef header.
187 .c --------------------------------------------------------------------
188 .c Environment variable
193 .c --------------------------------------------------------------------
194 .c a shell command line
197 . c replace argument separator by unbreakable space
200 . while (\n[.$]>0) \{\
201 . ds @args \*[@args]\~\$1
207 . Text \f[I]sh#\h'1m'\f[P]\f[CR]\*[@args]\f[P]\&\"
217 .c --------------------------------------------------------------------
224 .c --------------------------------------------------------------------
225 .c End of macro definitions
229 .\" --------------------------------------------------------------------
231 .\" --------------------------------------------------------------------
233 .TH GROFF @MAN1EXT@ "@MDATE@" "Groff Version @VERSION@"
235 groff \- front-end for the groff document formatting system
238 .\" --------------------------------------------------------------------
240 .\" --------------------------------------------------------------------
244 .ShortOpt[] abcegilpstzCEGNRSUVXZ
278 The command line is parsed according to the usual GNU convention.
280 The whitespace between a command line option and its argument is
283 Options can be grouped behind a single
289 (minus character) denotes the standard input.
292 .\" --------------------------------------------------------------------
294 .\" --------------------------------------------------------------------
296 This document describes the
298 program, the main front-end for the
300 document formatting system.
304 program and macro suite is the implementation of a
306 system within the free software collection
307 .URL http://\:www.gnu.org "GNU" .
311 system has all features of the classical
313 but adds many extensions.
318 program allows to control the whole
320 system by command line options.
322 This is a great simplification in comparison to the classical case (which
326 .\" --------------------------------------------------------------------
328 .\" --------------------------------------------------------------------
332 is a wrapper program for
334 both programs share a set of options.
338 program has some additional, native options and gives a new meaning to
343 On the other hand, not all
345 options can be fed into
349 .\" --------------------------------------------------------------------
350 .SS Native groff Options
351 .\" --------------------------------------------------------------------
353 The following options either do not exist for
355 or are differently interpreted by
375 Print a help message.
379 This option may be used to specify a directory to search for
380 files (both those on the command line and those named in
389 The current directory is always searched first.
390 This option may be specified more than once;
391 the directories will be searched in the order specified.
392 No directory search is performed for files specified using an absolute path.
393 This option implies the
399 Send the output to a spooler program for printing.
401 The command that should be used for this is specified by the
403 command in the device description file, see
404 .BR \%groff_font (@MAN5EXT@).
405 If this command is not present, the output is piped into the
418 to the spooler program.
419 Several arguments should be passed with a separate
426 .ShortOpt\" just a minus sign
429 before passing it to the spooler program.
433 Don't allow newlines within
437 This is the same as the
448 .OptDef P "" "\*[@-]option"
449 .OptDef+ P "" "\*[@-]option \f[CB]\*[@-]P\f[] arg"
454 to the postprocessor.
456 The option must be specified with the necessary preceding minus
461 because groff does not prepend any dashes before passing it to the
464 For example, to pass a title to the \%gxditview postprocessor, the shell
467 .ShellCommand groff \*[@-]X \*[@-]P \*[@-]title \*[@-]P 'groff it' \f[I]foo\f[]
471 .ShellCommand groff \*[@-]X \*[@-]Z \f[I]foo\f[] | \
472 gxditview \*[@-]title 'groff it' \*[@-]
479 No mechanism is provided for passing arguments to
483 options have equivalent language elements that can be specified within
487 .BR \%@g@refer (@MAN1EXT@)
503 and disable the following
512 For security reasons, safer mode is enabled by default.
529 .BR \%groff_out (@MAN5EXT@).
533 calls a postprocessor to convert
535 .I intermediate output
545 TeX DVI format (postprocessor is
548 HTML output (preprocessors are
553 .BR \%post-grohtml ).
555 Canon CAPSL printers (\%LBP-4 and \%LBP-8 series laser printers;
559 HP LaserJet4 compatible (or other PCL5 compatible) printers (postprocessor
563 PostScript output (postprocessor is
569 For the following TTY output devices (postprocessor is always
572 selects the output encoding:
578 \%Latin-1 character set for EBCDIC hosts.
582 Unicode character set in \%UTF-8 encoding.
587 The following arguments select
589 as the `postprocessor' (it is rather a viewing program):
594 75dpi resolution, 10pt document base font.
596 75dpi resolution, 12pt document base font.
598 100dpi resolution, 10pt document base font.
600 100dpi resolution, 12pt document base font.
605 The default device is
612 Reverts to the (old) unsafe behaviour; see option
617 Output version information of
619 and of all programs that are run by it; that is, the given command line
620 is parsed in the usual way, passing
626 Output the pipeline that would be run by
628 (as a wrapper program) on the standard output, but do not execute it.
629 If given more than once,
630 the commands will be both printed on the standard error and run.
636 instead of using the usual postprocessor to (pre)view a document.
638 The printing spooler behavior as outlined with options
643 .BR \%gxditview (@MAN1EXT@)
644 by determining an argument for the
645 .B \*[@-]printCommand
647 .BR \%gxditview (@MAN1EXT@).
649 This sets the default
651 action and the corresponding menu entry to that value.
654 only produces good results with
662 The default resolution for previewing
664 output is 75\|dpi; this can be changed by passing the
671 .ShellCommand groff \*[@-]X \*[@-]P\*[@-]resolution \*[@-]P100 \*[@-]man foo.1
675 Suppress output generated by
677 Only error messages will be printed.
682 .I groff intermediate output
683 to standard output; see
684 .BR \%groff_out (@MAN5EXT@).
687 calls automatically a postprocessor.
689 With this option, the output of
691 for the device, the so-called
692 .I intermediate output
693 is issued without postprocessing.
696 .\" --------------------------------------------------------------------
697 .SS Transparent Options
698 .\" --------------------------------------------------------------------
700 The following options are transparently handed over to the formatter
703 that is called by groff subsequently.
705 These options are described in more detail in
706 .BR @g@troff (@MAN1EXT@).
709 ascii approximation of output.
712 backtrace on error or warning.
715 disable color output.
718 .BR \%grotty (@MAN1EXT@)
719 man page for more details.
722 enable compatibility mode.
734 set default font family.
737 set path for font DESC files.
740 process standard input after the specified input files.
743 include macro file \f[I]name\f[]\f[B].tmac\f[] (or
744 \f[B]tmac.\f[]\f[I]name\f[]); see also
745 .BR \%groff_tmac (@MAN5EXT@).
748 path for macro files.
751 number the first page
771 .\" --------------------------------------------------------------------
773 .\" --------------------------------------------------------------------
777 implements the infrastructure of classical roff; see
779 for a survey on how a roff system works in general.
781 Due to the front-end programs available within the groff system, using
784 .IR "classical roff" .
786 This section gives an overview of the parts that constitute the groff
791 with groff-specific features.
793 This section can be regarded as a guide to the documentation around
797 .\" --------------------------------------------------------------------
799 .\" --------------------------------------------------------------------
805 to format the input is controlled globally with the requests
811 .BR groff_tmac (@MAN5EXT@)
812 for the `papersize' macro package which provides a convenient interface.
817 paper size, giving the actual dimensions of the paper sheets, is
818 controlled by output devices like
820 with the command line options
825 .BR groff_font (@MAN5EXT@)
826 and the man pages of the output devices for more details.
828 uses the command line option
830 to pass options to output devices; for example, the following selects
831 A4 paper in landscape orientation for the PS device:
835 groff -Tps -P-pa4 -P-l .\|.\|.
839 .\" --------------------------------------------------------------------
841 .\" --------------------------------------------------------------------
845 program is a wrapper around the
846 .BR @g@troff (@MAN1EXT@)
849 It allows to specify the preprocessors by command line options and
850 automatically runs the postprocessor that is appropriate for the
853 Doing so, the sometimes tedious piping mechanism of classical
860 program can be used for guessing the correct groff command line to
865 .BR \%groffer (@MAN1EXT@)
866 program is an allround-viewer for groff files and man pages.
869 .\" --------------------------------------------------------------------
871 .\" --------------------------------------------------------------------
873 The groff preprocessors are reimplementations of the classical
874 preprocessors with moderate extensions.
876 The preprocessors distributed with the
881 .BR @g@eqn (@MAN1EXT@)
882 for mathematical formul\(ae,
884 .BR @g@grn (@MAN1EXT@)
889 .BR @g@pic (@MAN1EXT@)
890 for drawing diagrams,
892 .BR \%@g@refer (@MAN1EXT@)
893 for bibliographic references,
895 .BR \%@g@soelim (@MAN1EXT@)
896 for including macro files from standard locations,
901 .BR @g@tbl (@MAN1EXT@)
905 Besides these, there are some internal preprocessors that are
906 automatically run with some devices.
908 These aren't visible to the user.
911 .\" --------------------------------------------------------------------
913 .\" --------------------------------------------------------------------
915 Macro packages can be included by option
918 The groff system implements and extends all classical macro packages
919 in a compatible way and adds some packages of its own.
921 Actually, the following macro packages come with
926 The traditional man page format; see
927 .BR \%groff_man (@MAN7EXT@).
928 It can be specified on the command line as
936 The general package for man pages; it automatically recognizes
937 whether the documents uses the
941 format and branches to the corresponding macro package.
943 It can be specified on the command line as
951 The BSD-style man page format; see
952 .BR \%groff_mdoc (@MAN7EXT@).
953 It can be specified on the command line as
964 .BR \%groff_me (@MAN7EXT@).
965 It can be specified on the command line as
976 .BR \%groff_mm (@MAN7EXT@).
977 It can be specified on the command line as
988 .BR \%groff_ms (@MAN7EXT@).
989 It can be specified on the command line as
997 HTML-like macros for inclusion in arbitrary groff documents; see
998 .BR \%groff_www (@MAN7EXT@).
1001 Details on the naming of macro files and their placement can be found
1003 .BR \%groff_tmac (@MAN5EXT@);
1004 this man page also documents some other, minor auxiliary macro packages
1008 .\" --------------------------------------------------------------------
1009 .SS "Programming Language"
1010 .\" --------------------------------------------------------------------
1012 General concepts common to all roff programming languages are
1014 .BR roff (@MAN7EXT@).
1017 The groff extensions to the classical troff language are documented in
1018 .BR \%groff_diff (@MAN7EXT@).
1021 The groff language as a whole is described in the (still incomplete)
1022 .IR "groff info file" ;
1023 a short (but complete) reference can be found in
1024 .BR groff (@MAN7EXT@).
1027 .\" --------------------------------------------------------------------
1029 .\" --------------------------------------------------------------------
1031 The central roff formatter within the groff system is
1032 .BR @g@troff (@MAN1EXT@).
1033 It provides the features of both the classical troff and nroff, as
1034 well as the groff extensions.
1036 The command line option
1041 .I "compatibility mode"
1042 which tries to emulate classical roff as much as possible.
1045 There is a shell script
1046 .BR @g@nroff (@MAN1EXT@)
1047 that emulates the behavior of classical nroff.
1049 It tries to automatically select the proper output encoding, according to
1053 The formatter program generates
1054 .IR "intermediate output" ;
1056 .BR \%groff_out (@MAN7EXT@).
1059 .\" --------------------------------------------------------------------
1061 .\" --------------------------------------------------------------------
1063 In roff, the output targets are called
1065 A device can be a piece of hardware, e.g. a printer, or a software
1068 A device is specified by the option
1070 The groff devices are as follows.
1074 Text output using the
1080 Text output using the EBCDIC code page IBM cp1047 (e.g. OS/390 Unix).
1092 Text output using the ISO \%Latin-1 (ISO \%8859-1) character set; see
1093 .BR \%iso_8859_1 (7).
1097 Output for Canon CAPSL printers (\%LBP-4 and \%LBP-8 series laser printers).
1101 HP LaserJet4-compatible (or other PCL5-compatible) printers.
1105 PostScript output; suitable for printers and previewers like
1110 Text output using the Unicode (ISO 10646) character set with \%UTF-8
1116 75dpi X Window System output suitable for the previewers
1119 .BR \%gxditview (@MAN1EXT@).
1120 A variant for a 12\|pt document base font is
1125 100dpi X Window System output suitable for the previewers
1128 .BR \%gxditview (@MAN1EXT@).
1129 A variant for a 12\|pt document base font is
1133 The postprocessor to be used for a device is specified by the
1135 command in the device description file; see
1136 .BR \%groff_font (@MAN5EXT@).
1138 This can be overridden with the
1143 The default device is
1147 .\" --------------------------------------------------------------------
1149 .\" --------------------------------------------------------------------
1151 groff provides 3\~hardware postprocessors:
1154 .BR \%grolbp (@MAN1EXT@)
1155 for some Canon printers,
1157 .BR \%grolj4 (@MAN1EXT@)
1158 for printers compatible to the HP LaserJet\~4 and PCL5,
1160 .BR \%grotty (@MAN1EXT@)
1161 for text output using various encodings, e.g. on text-oriented
1162 terminals or line-printers.
1165 Today, most printing or drawing hardware is handled by the operating
1166 system, by device drivers, or by software interfaces, usually accepting
1169 Consequently, there isn't an urgent need for more hardware device
1173 The groff software devices for conversion into other document file
1177 .BR \%grodvi (@MAN1EXT@)
1180 .BR \%grohtml (@MAN1EXT@)
1183 .BR grops (@MAN1EXT@)
1187 Combined with the many existing free conversion tools this should
1188 be sufficient to convert a troff document into virtually any existing
1192 .\" --------------------------------------------------------------------
1194 .\" --------------------------------------------------------------------
1196 The following utility programs around groff are available.
1199 .BR \%addftinfo (@MAN1EXT@)
1200 Add information to troff font description files for use with groff.
1203 .BR \%afmtodit (@MAN1EXT@)
1204 Create font description files for PostScript device.
1207 .BR \%groffer (@MAN1EXT@)
1208 General viewer program for groff files and man pages.
1211 .BR \%gxditview (@MAN1EXT@)
1212 The groff X viewer, the GNU version of xditview.
1215 .BR \%hpftodit (@MAN1EXT@)
1216 Create font description files for lj4 device.
1219 .BR \%indxbib (@MAN1EXT@)
1220 Make inverted index for bibliographic databases.
1223 .BR lkbib (@MAN1EXT@)
1224 Search bibliographic databases.
1227 .BR \%lookbib (@MAN1EXT@)
1228 Interactively search bibliographic databases.
1231 .BR \%pfbtops (@MAN1EXT@)
1232 Translate a PostScript font in .pfb format to ASCII.
1235 .BR \%tfmtodit (@MAN1EXT@)
1236 Create font description files for TeX DVI device.
1240 roff viewer distributed with X window.
1243 .\" --------------------------------------------------------------------
1245 .\" --------------------------------------------------------------------
1247 Normally, the path separator in the following environment variables is the
1248 colon; this may vary depending on the operating system.
1250 For example, DOS and Windows use a semicolon instead.
1253 .EnvVar GROFF_BIN_PATH
1254 This search path, followed by
1256 will be used for commands that are executed by
1259 If it is not set then the directory where the groff binaries were
1260 installed is prepended to
1264 .EnvVar GROFF_COMMAND_PREFIX
1265 When there is a need to run different roff implementations at the same
1268 provides the facility to prepend a prefix to most of its programs that
1269 could provoke name clashings at run time (default is to have none).
1271 Historically, this prefix was the character
1273 but it can be anything.
1287 .EnvVar GROFF_COMMAND_PREFIX
1288 to different values, the different roff installations can be
1291 More exactly, if it is set to prefix
1295 as a wrapper program will internally call
1299 This also applies to the preprocessors
1306 and to the utilities
1311 This feature does not apply to any programs different from the ones
1314 itself) since they are unique to the groff package.
1318 .EnvVar GROFF_FONT_PATH
1319 A list of directories in which to search for the
1321 directory in addition to the default ones.
1324 .BR @g@troff (@MAN1EXT@)
1326 .BR \%groff_font (@MAN5EXT@)
1331 .EnvVar GROFF_TMAC_PATH
1332 A list of directories in which to search for macro files in addition to
1333 the default directories.
1336 .BR @g@troff (@MAN1EXT@)
1338 .BR \%groff_tmac (@MAN5EXT@)
1343 .EnvVar GROFF_TMPDIR
1344 The directory in which temporary files will be created.
1346 If this is not set but the environment variable
1348 instead, temporary files will be created in the directory
1350 On MS-DOS and Windows\ 32 platforms, the environment variables
1354 (in that order) are searched also, after
1355 .EnvVar GROFF_TMPDIR
1359 Otherwise, temporary files will be created in
1362 .BR \%@g@refer (@MAN1EXT@),
1363 .BR \%groffer (@MAN1EXT@),
1364 .BR \%grohtml (@MAN1EXT@),
1366 .BR grops (@MAN1EXT@)
1367 commands use temporary files.
1371 .EnvVar GROFF_TYPESETTER
1372 Preset the default device.
1374 If this is not set the
1376 device is used as default.
1378 This device name is overwritten by the option
1382 .\" --------------------------------------------------------------------
1384 .\" --------------------------------------------------------------------
1386 There are some directories in which
1388 installs all of its data files.
1390 Due to different installation habits on different operating systems,
1391 their locations are not absolutely fixed, but their function is
1392 clearly defined and coincides on all systems.
1395 .\" --------------------------------------------------------------------
1396 .SS "groff Macro Directory"
1397 .\" --------------------------------------------------------------------
1399 This contains all information related to macro packages.
1401 Note that more than a single directory is searched for those files
1403 .BR \%groff_tmac (@MAN5EXT@).
1405 For the groff installation corresponding to this document, it is
1409 The following files contained in the
1410 .I groff macro directory
1411 have a special meaning:
1416 Initialization file for troff.
1418 This is interpreted by
1420 before reading the macro sets and any input.
1425 Final startup file for troff, it is parsed after all macro sets have
1433 Macro file for macro package
1437 .\" --------------------------------------------------------------------
1438 .SS "groff Font Directory"
1439 .\" --------------------------------------------------------------------
1441 This contains all information related to output devices.
1443 Note that more than a single directory is searched for those files; see
1444 .BR @g@troff (@MAN1EXT@).
1446 For the groff installation corresponding to this document, it is
1450 The following files contained in the
1451 .I groff font directory
1452 have a special meaning:
1457 Device description file for device
1460 .BR \%groff_font (@MAN5EXT@).
1471 .\" --------------------------------------------------------------------
1473 .\" --------------------------------------------------------------------
1475 The following example illustrates the power of the
1477 program as a wrapper around
1481 To process a roff file using the preprocessors
1487 macro set, classical troff had to be called by
1490 .ShellCommand pic foo.me | tbl | troff \*[@-]me \*[@-]Tlatin1 | grotty
1495 this pipe can be shortened to the equivalent command
1497 .ShellCommand groff \*[@-]p \*[@-]t \*[@-]me \*[@-]T latin1 foo.me
1500 An even easier way to call this is to use
1501 .BR grog (@MAN1EXT@)
1502 to guess the preprocessor and macro options and execute the generated
1503 command (by using backquotes to specify shell command substitution)
1505 .ShellCommand \`grog \*[@-]Tlatin1 foo.me\`
1508 The simplest way is to view the contents in an automated way by
1512 .ShellCommand groffer foo.me
1515 .\" --------------------------------------------------------------------
1517 .\" --------------------------------------------------------------------
1520 On EBCDIC hosts (e.g. OS/390 Unix), output devices
1526 Similarly, output for EBCDIC code page
1528 is not available on ASCII based operating systems.
1531 Report bugs to bug-groff@gnu.org.
1533 Include a complete, self-contained example that will allow the bug to
1534 be reproduced, and say which version of groff you are using.
1537 .\" --------------------------------------------------------------------
1539 .\" --------------------------------------------------------------------
1541 Information on how to get groff and related information is available
1543 .URL http://\:www.gnu.org/\:software/\:groff "GNU website" .
1544 The most recent released version of groff is available for anonymous
1546 .URL ftp://ftp.ffii.org/\:pub/\:groff/\:devel/\:groff-current.tar.gz \
1547 "groff development site" .
1550 Three groff mailing lists are available:
1552 .MTO bug-groff@gnu.org
1557 for general discussion of groff,
1560 .MTO groff-commit@ffii.org
1561 a read-only list showing logs of commitments to the CVS repository.
1564 Details on CVS access and much more can be found in the file
1566 at the top directory of the groff source package.
1569 There is a free implementation of the
1571 preprocessor, written by
1572 .MTO faber@lunabase.org " Ted Faber" .
1574 The actual version can be found at the
1576 .URL http://\:www.lunabase.org/\:~faber/\:Vault/\:software/\:grap/ \
1578 This is the only grap version supported by groff.
1581 .\" --------------------------------------------------------------------
1583 .\" --------------------------------------------------------------------
1585 Copyright \(co 1989, 2002, 2003, 2004, 2005 Free Software Foundation, Inc.
1588 This document is distributed under the terms of the FDL (GNU Free
1589 Documentation License) version 1.1 or later.
1591 You should have received a copy of the FDL on your system, it is also
1592 available on-line at the
1593 .URL http://\:www.gnu.org/\:copyleft/\:fdl.html "GNU copyleft site" .
1596 This document is based on the original groff man page written by
1597 .MTO jjc@jclark.com "James Clark" .
1599 It was rewritten, enhanced, and put under the FDL license by
1600 \m[blue]Bernd Warken\m[].
1603 .MTO wl@gnu.org "Werner Lemberg" .
1607 is a GNU free software project.
1611 are protected by GNU copyleft licenses.
1613 The software files are distributed under the terms of the GNU General
1614 Public License (GPL), while the documentation files mostly use the GNU
1615 Free Documentation License (FDL).
1618 .\" --------------------------------------------------------------------
1620 .\" --------------------------------------------------------------------
1623 .IR "groff info file"
1624 contains all information on the groff system within a single document.
1626 Beneath the detailed documentation of all aspects, it provides
1627 examples and background information.
1634 Due to its complex structure, the groff system has many man pages.
1636 They can be read with
1639 .BR \%groffer (@MAN1EXT@).
1642 Introduction, history and further readings:
1643 .BR roff (@MAN7EXT@).
1646 Viewer for groff files:
1647 .BR \%groffer (@MAN1EXT@),
1648 .BR \%gxditview (@MAN1EXT@),
1649 .BR \%xditview (1x).
1652 Wrapper programs for formatters:
1653 .BR \%groff (@MAN1EXT@),
1654 .BR \%grog (@MAN1EXT@).
1658 .BR \%@g@eqn (@MAN1EXT@),
1659 .BR \%@g@grn (@MAN1EXT@),
1660 .BR \%@g@pic (@MAN1EXT@),
1661 .BR \%@g@refer (@MAN1EXT@),
1662 .BR \%@g@soelim (@MAN1EXT@),
1663 .BR \%@g@tbl (@MAN1EXT@),
1667 Roff language with the groff extensions:
1668 .BR \%groff (@MAN7EXT@),
1669 .BR \%groff_char (@MAN7EXT@),
1670 .BR \%groff_diff (@MAN7EXT@),
1671 .BR \%groff_font (@MAN5EXT@).
1674 Roff formatter programs:
1675 .BR \%@g@nroff (@MAN1EXT@),
1676 .BR \%@g@troff (@MAN1EXT@),
1677 .BR ditroff (@MAN7EXT@).
1681 .I intermediate output
1683 .BR \%groff_out (@MAN7EXT@).
1686 Postprocessors for the output devices:
1687 .BR \%grodvi (@MAN1EXT@),
1688 .BR \%grohtml (@MAN1EXT@),
1689 .BR \%grolbp (@MAN1EXT@),
1690 .BR \%grolj4 (@MAN1EXT@),
1691 .BR \%lj4_font (@MAN5EXT@),
1692 .BR \%grops (@MAN1EXT@),
1693 .BR \%grotty (@MAN1EXT@).
1696 Groff macro packages and macro-specific utilities:
1697 .BR \%groff_tmac (@MAN5EXT@),
1698 .BR \%groff_man (@MAN7EXT@),
1699 .BR \%groff_mdoc (@MAN7EXT@),
1700 .BR \%groff_me (@MAN7EXT@),
1701 .BR \%groff_mm (@MAN7EXT@),
1702 .BR \%groff_mmse (@MAN7EXT@),
1703 .BR \%groff_mom (@MAN7EXT@),
1704 .BR \%groff_ms (@MAN7EXT@),
1705 .BR \%groff_www (@MAN7EXT@),
1706 .BR \%groff_trace (@MAN7EXT@),
1707 .BR \%mmroff (@MAN7EXT@).
1710 The following utilities are available:
1711 .BR \%addftinfo (@MAN1EXT@),
1712 .BR \%afmtodit (@MAN1EXT@),
1713 .BR \%eqn2graph (@MAN1EXT@),
1714 .BR \%grap2graph (@MAN1EXT@),
1715 .BR \%groffer (@MAN1EXT@),
1716 .BR \%gxditview (@MAN1EXT@),
1717 .BR \%hpftodit (@MAN1EXT@),
1718 .BR \%@g@indxbib (@MAN1EXT@),
1719 .BR \%@g@lookbib (@MAN1EXT@),
1720 .BR \%pfbtops (@MAN1EXT@),
1721 .BR \%pic2graph (@MAN1EXT@),
1722 .BR \%tfmtodit (@MAN1EXT@).
1726 .\" --------------------------------------------------------------------
1728 .\" --------------------------------------------------------------------
1730 .\" Local Variables: