MANIFEST

   1 MANIFEST
   2
   3 Last update: 21 Dec 2001
   4
   5 This file is part of groff, the GNU roff type-setting system.
   6
   7 Copyright (C) 2001 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   MANIFEST      The file you are reading.
  35   MORE.STUFF    Useful stuff in other packages.
  36   NEWS          Recent user-visible changes in groff.
  37   PROBLEMS      Tips to handle known critical situations.
  38   PROJECTS      Long-term additions to groff.
  39   README        Availability and contact information for groff.
  40   README.WIN32  Documentation of the Win32 port of groff.
  41   TODO          Things planned for future groff versions.
  42
  43   All other files in the top directory are related to the configuration,
  44   compilation, and install processes.
  45
  46
  47 2) The directory structure
  48
  49 ./arch          Data that is special for different architectures.
  50   djgpp         Data special for the 32-bit DOS compiler djgpp.
  51
  52 ./contrib       Part of groff, but maintained by other people.
  53   mm            The groff mm macro package.
  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
  85 ./src/include   The *.h C/C++ include files.
  86
  87 ./src/libs      C++ code common to several parts of the groff sources.
  88   libbib        Library of bibliographic functions.
  89   libdriver     Parser for intermediate output and postprocessor code.
  90   libgroff      Library for general support functions used everywhere.
  91   snprintf      An implementation of snprintf() and friends.
  92
  93 ./src/preproc   Preprocessors.
  94   eqn           Mathematical formulae.
  95   grn           Gremlin pictures.
  96   html          The preprocessor part of grohtml.
  97   pic           Diagram drawer.
  98   refer         Bibliographic references.
  99   soelim        File inclusion using tmac path.
 100   tbl           Tables.
 101
 102 ./src/roff      Front-end programs.
 103   groff         Wrapper around troff.  This is the main user program.
 104   grog          Guess groff command line options.
 105   nroff         Emulate classical nroff text formatter.
 106   troff         Main roff formatter program.
 107
 108 ./src/xditview  A groff (pre)viewer for the X Window System.
 109
 110 ./src/utils     Utility programs around groff.
 111   addftinfo     Add information to old troff font files for use with groff.
 112   afmtodit      Create font description files for the PostScript device.
 113   hpftodit      Create font description files for the LJ4 device.
 114   indxbib       Make inverted index for bibliographic databases.
 115   lkbib         Search bibliographic databases.
 116   lookbib       Interactively search bibliographic databases.
 117   pfbtops       Translate a PostScript font in .pfb format to ASCII.
 118   tfmtodit      Create font description files for TeX DVI device.
 119
 120 ./tmac          Macro files.
 121
 122
 123 3) Documentation
 124
 125 The groff documentation is scattered upon several places.
 126
 127 - The main directory contains documents related to the groff source.
 128   The README file contains the information needed to get the groff
 129   package, report bugs, and contact the developers.
 130
 131 - The man-page of each program (section 1) is kept in the source
 132   directory of the program.
 133
 134 - The man-pages for the other sections are found in `src/man'.
 135
 136 - Documentation in other formats are located in the `doc' directory,
 137   including the groff info file, tutorials, and manuals.
 138
 139
 140 4) The roff parser
 141
 142 The parsing of the roff language is done by troff.  The input is
 143 transformed into "nodes" by `src/roff/troff/node.cc'.  From these, the
 144 intermediate output is generated.
 145
 146
 147 5) Postprocessing
 148
 149 The parser for the intermediate output and the postprocessing is in
 150 `src/libs/libdriver/input.cc'.  This is used by all postprocessors.