3 Last update: 18 Dec 2005
5 This file is part of groff, the GNU roff type-setting system.
7 Copyright (C) 2001, 2003, 2004, 2005 Free Software Foundation, Inc.
8 written by Bernd Warken <bwarken@mayn.de>
9 maintained by Werner Lemberg <wl@gnu.org>
11 Permission is granted to copy, distribute and/or modify this document
12 under the terms of the GNU Free Documentation License, Version 1.1 or
13 any later version published by the Free Software Foundation; with the
14 Invariant Sections being this .ig-section and AUTHORS, with no
15 Front-Cover Texts, and with no Back-Cover Texts.
17 A copy of the Free Documentation License is included as a file called
18 FDL in the main directory of the groff source package.
20 ########################################################################
22 This file gives an overview of the directories and the main files of
23 the groff source distribution.
28 BUG-REPORT A template for bug-reports.
29 ChangeLog Log of the changes in the different groff versions.
30 COPYING The GNU General Public License (GPL).
31 FDL The Free Documentation License (FDL).
32 INSTALL Information on compiling and installing groff.
33 INSTALL.gen Generic information on configuration and compiling.
34 LICENSES Licensing information.
35 MANIFEST The file you are reading.
36 MORE.STUFF Useful stuff in other packages.
37 NEWS Recent user-visible changes in groff.
38 PROBLEMS Tips to handle known critical situations.
39 PROJECTS Long-term additions to groff.
40 README Availability and contact information for groff.
41 README.MinGW Build information for MinGW.
42 TODO Things planned for future groff versions.
44 All other files in the top directory are related to the configuration,
45 compilation, and install processes.
48 2) The directory structure
50 ./arch Data that is special for different architectures.
51 djgpp Data special for the 32-bit DOS compiler djgpp.
52 misc Data needed for various platforms.
54 ./contrib Part of groff, but maintained by other people.
55 chem A preprocessor (for pic) to produce chemical structure
57 eqn2graph Convert equations created with EQN into different
59 gdiffmk An improved implementation of the diffmk command to mark
60 differences between groff/nroff/troff files.
61 grap2graph Convert grap diagraps into different graphical formats.
62 groffer A wrapper to conveniently view roff files.
63 mm The groff mm macro package.
64 mom The groff mom macro package.
65 pdfmark A package to add PDF marks to groff documents, together
66 with a shell script (pdfroff) for easy creation of PDF
68 pic2graph Convert PIC diagrams into different graphical formats.
70 ./doc Manuals and tutorials to groff aspects.
72 ./font Device information and fonts.
73 devX100 100dpi device for X Window System.
74 devX100-12 100dpi device with narrower font (for 12pt base font).
75 devX75 75dpi device for X Window System.
76 devX75-12 75dpi device with narrower font (for 12pt base font).
77 devascii Text device for ASCII output.
78 devcp1047 EBCDIC device.
79 devdvi TeX DVI device.
81 devlatin1 Text device for latin-1 (ISO 8859-1) output.
82 devlbp Device for Canon CAPSL laser printers.
83 devlj4 Device for HP Laserjet 4, PCL 5, and compatible printers.
84 devps PostScript device.
85 devutf8 Text device for Unicode output.
87 ./man Some groff manual pages of more general character.
89 ./src Everything written in programming languages.
91 ./src/devices The postprocessors.
92 grodvi TeX DVI output.
94 grolbp Canon printers.
95 grolj4 HP Laserjet 4, PCL 5, and compatible printers.
96 grops PostScript output.
98 xditview A groff (pre)viewer for the X Window system.
100 ./src/include The *.h C/C++ include files.
102 ./src/libs C++ code common to several parts of the groff sources.
103 libbib Library of bibliographic functions.
104 libdriver Parser for intermediate output and postprocessor code.
105 libgroff Library for general support functions used everywhere.
106 libxutil Utility functions for xditview and xtotroff.
107 snprintf An implementation of snprintf() and friends.
109 ./src/preproc Preprocessors.
110 preconv Input encoding conversion.
111 eqn Mathematical formulae.
112 grn Gremlin pictures.
113 html The preprocessor part of grohtml.
115 refer Bibliographic references.
116 soelim File inclusion using tmac path.
119 ./src/roff Front-end programs.
120 groff Wrapper around troff. This is the main user program.
121 grog Guess groff command line options.
122 nroff Emulate classical nroff text formatter.
123 troff Main roff formatter program.
125 ./src/utils Utility programs around groff.
126 addftinfo Add information to old troff font files for use with groff.
127 afmtodit Create font description files for the PostScript device.
128 hpftodit Create font description files for the LJ4 device.
129 indxbib Make inverted index for bibliographic databases.
130 lkbib Search bibliographic databases.
131 lookbib Interactively search bibliographic databases.
132 pfbtops Translate a PostScript font in PFB format to PFA.
133 tfmtodit Create font description files for TeX DVI device.
134 xtotroff Create font description files for xditview.
141 The groff documentation is scattered upon several places.
143 - The main directory contains documents related to the groff source.
144 The README file contains the information needed to get the groff
145 package, report bugs, and contact the developers.
147 - The man-page of each program (section 1) is kept in the source
148 directory of the program.
150 - The man-pages for the other sections are found in `src/man'.
152 - Documentation in other formats are located in the `doc' directory,
153 including the groff info file, tutorials, and manuals.
158 The parsing of the roff language is done by troff. The input is converted
159 to tokens in `src/roff/troff/input.cpp' and transformed into `nodes' by
160 `src/roff/troff/env.cpp' and `src/roff/troff/node.cpp'. From these, the
161 intermediate output is generated (also in `node.cpp').
166 The parser for the intermediate output and the postprocessing is in
167 `src/libs/libdriver/input.cpp'. This is used by all postprocessors.