MANIFEST

   1 MANIFEST
   2
   3 Last update: 10 May 2004
   4
   5 This file is part of groff, the GNU roff type-setting system.
   6
   7 Copyright (C) 2001, 2003, 2004 Free Software Foundation, Inc.
   8 written by Bernd Warken <bwarken@mayn.de>
   9 maintained by Werner Lemberg <wl@gnu.org>
  10
  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.
  16
  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.
  19
  20 ########################################################################
  21
  22 This file gives an overview of the directories and the main files of
  23 the groff source distribution.
  24
  25
  26 1) The top directory.
  27
  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   LICENSE       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.CVS    Development build information.
  42   README.MinGW  Build information for MinGW.
  43   TODO          Things planned for future groff versions.
  44
  45   All other files in the top directory are related to the configuration,
  46   compilation, and install processes.
  47
  48
  49 2) The directory structure
  50
  51 ./arch          Data that is special for different architectures.
  52   djgpp         Data special for the 32-bit DOS compiler djgpp.
  53   misc          Data needed for various platforms.
  54
  55 ./contrib       Part of groff, but maintained by other people.
  56   eqn2graph     Convert equations created with EQN into different
  57                 graphical formats.
  58   grap2graph    Convert grap diagraps into different graphical formats.
  59   groffer       A wrapper to conveniently view roff files.
  60   mm            The groff mm macro package.
  61   mom           The groff mom macro package.
  62   pic2graph     Convert PIC diagrams into different graphical formats.
  63
  64 ./doc           Manuals and tutorials to groff aspects.
  65
  66 ./font          Device information and fonts.
  67   devX100       100dpi device for X Window System.
  68   devX100-12    100dpi device with narrower font (for 12pt base font).
  69   devX75        75dpi device for X Window System.
  70   devX75-12     75dpi device with narrower font (for 12pt base font).
  71   devascii      Text device for ASCII output.
  72   devcp1047     EBCDIC device.
  73   devdvi        TeX DVI device.
  74   devhtml       HTML device.
  75   devlatin1     Text device for latin-1 (ISO 8859-1) output.
  76   devlbp        Device for Canon CAPSL laser printers.
  77   devlj4        Device for HP Laserjet 4, PCL 5, and compatible printers.
  78   devps         PostScript device.
  79   devutf8       Text device for Unicode output.
  80
  81 ./man           Some groff manual pages of more general character.
  82
  83 ./src           Everything written in programming languages.
  84
  85 ./src/devices   The postprocessors.
  86   grodvi        TeX DVI output.
  87   grohtml       HTML output.
  88   grolbp        Canon printers.
  89   grolj4        HP Laserjet 4, PCL 5, and compatible printers.
  90   grops         PostScript output.
  91   grotty        Text output.
  92
  93 ./src/include   The *.h C/C++ include files.
  94
  95 ./src/libs      C++ code common to several parts of the groff sources.
  96   libbib        Library of bibliographic functions.
  97   libdriver     Parser for intermediate output and postprocessor code.
  98   libgroff      Library for general support functions used everywhere.
  99   snprintf      An implementation of snprintf() and friends.
 100
 101 ./src/preproc   Preprocessors.
 102   eqn           Mathematical formulae.
 103   grn           Gremlin pictures.
 104   html          The preprocessor part of grohtml.
 105   pic           Diagram drawer.
 106   refer         Bibliographic references.
 107   soelim        File inclusion using tmac path.
 108   tbl           Tables.
 109
 110 ./src/roff      Front-end programs.
 111   groff         Wrapper around troff.  This is the main user program.
 112   grog          Guess groff command line options.
 113   nroff         Emulate classical nroff text formatter.
 114   troff         Main roff formatter program.
 115
 116 ./src/utils     Utility programs around groff.
 117   addftinfo     Add information to old troff font files for use with groff.
 118   afmtodit      Create font description files for the PostScript device.
 119   hpftodit      Create font description files for the LJ4 device.
 120   indxbib       Make inverted index for bibliographic databases.
 121   lkbib         Search bibliographic databases.
 122   lookbib       Interactively search bibliographic databases.
 123   pfbtops       Translate a PostScript font in PFB format to PFA.
 124   tfmtodit      Create font description files for TeX DVI device.
 125
 126 ./src/xditview  A groff (pre)viewer for the X Window System.
 127
 128 ./tmac          Macro files.
 129
 130
 131 3) Documentation
 132
 133 The groff documentation is scattered upon several places.
 134
 135 - The main directory contains documents related to the groff source.
 136   The README file contains the information needed to get the groff
 137   package, report bugs, and contact the developers.
 138
 139 - The man-page of each program (section 1) is kept in the source
 140   directory of the program.
 141
 142 - The man-pages for the other sections are found in `src/man'.
 143
 144 - Documentation in other formats are located in the `doc' directory,
 145   including the groff info file, tutorials, and manuals.
 146
 147
 148 4) The roff parser
 149
 150 The parsing of the roff language is done by troff.  The input is converted
 151 to tokens in `src/roff/troff/input.cpp' and transformed into `nodes' by
 152 `src/roff/troff/env.cpp' and `src/roff/troff/node.cpp'.  From these, the
 153 intermediate output is generated (also in `node.cpp').
 154
 155
 156 5) Postprocessing
 157
 158 The parser for the intermediate output and the postprocessing is in
 159 `src/libs/libdriver/input.cpp'.  This is used by all postprocessors.