MANIFEST

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