MANIFEST

   1     Copyright 2001-2006, 2009-2013
   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   hdtbl         A sophisticated table macro package.
  50   mm            The groff mm macro package.
  51   mom           The groff mom macro package.
  52   pdfmark       A package to add PDF marks to groff documents, together
  53                 with a shell script (pdfroff) for easy creation of PDF
  54                 documents.
  55   pic2graph     Convert PIC diagrams into different graphical formats.
  56
  57 ./doc           Manuals and tutorials to groff aspects.
  58
  59 ./font          Device information and fonts.
  60   devX100       100dpi device for X Window System.
  61   devX100-12    100dpi device with narrower font (for 12pt base font).
  62   devX75        75dpi device for X Window System.
  63   devX75-12     75dpi device with narrower font (for 12pt base font).
  64   devascii      Text device for ASCII output.
  65   devcp1047     EBCDIC device.
  66   devdvi        TeX DVI device.
  67   devhtml       HTML device.
  68   devlatin1     Text device for latin-1 (ISO 8859-1) output.
  69   devlbp        Device for Canon CAPSL laser printers.
  70   devlj4        Device for HP Laserjet 4, PCL 5, and compatible printers.
  71   devps         PostScript device.
  72   devpdf        PDF device.
  73   devutf8       Text device for Unicode output.
  74   util          Utility programs.
  75
  76 ./m4            M4 macro files used creating the configure script.
  77
  78 ./man           Some groff manual pages of more general character.
  79
  80 ./src           Everything written in programming languages.
  81
  82 ./src/devices   The postprocessors.
  83   grodvi        TeX DVI output.
  84   grohtml       HTML output.
  85   grolbp        Canon printers.
  86   grolj4        HP Laserjet 4, PCL 5, and compatible printers.
  87   grops         PostScript output.
  88   gropdf        PDF output.
  89   grotty        Text output.
  90   xditview      A groff (pre)viewer for the X Window system.
  91
  92 ./src/include   The *.h C/C++ include files.
  93
  94 ./src/libs      C++ code common to several parts of the groff sources.
  95   gnulib        Auxiliary functions copied from the `gnulib' repository.
  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   libxutil      Utility functions for xditview and xtotroff.
 100   snprintf      An implementation of snprintf() and friends.
 101
 102 ./src/preproc   Preprocessors.
 103   eqn           Mathematical formulae.
 104   grn           Gremlin pictures.
 105   html          The preprocessor part of grohtml.
 106   pic           Diagram drawer.
 107   preconv       Input encoding conversion.
 108   refer         Bibliographic references.
 109   soelim        File inclusion using tmac path.
 110   tbl           Tables.
 111
 112 ./src/roff      Front-end programs.
 113   groff         Wrapper around troff.  This is the main user program.
 114   grog          Guess groff command line options.
 115   nroff         Emulate classical nroff text formatter.
 116   troff         Main roff formatter program.
 117
 118 ./src/utils     Utility programs around groff.
 119   addftinfo     Add information to old troff font files for use with groff.
 120   afmtodit      Create font description files for the PostScript device.
 121   hpftodit      Create font description files for the LJ4 device.
 122   indxbib       Make inverted index for bibliographic databases.
 123   lkbib         Search bibliographic databases.
 124   lookbib       Interactively search bibliographic databases.
 125   pfbtops       Translate a PostScript font in PFB format to PFA.
 126   tfmtodit      Create font description files for TeX DVI device.
 127   xtotroff      Create font description files for xditview.
 128
 129 ./tmac          Macro files.
 130
 131
 132 3) Documentation
 133
 134 The groff documentation is scattered upon several places.
 135
 136 - The main directory contains documents related to the groff source.
 137   The README file contains the information needed to get the groff
 138   package, report bugs, and contact the developers.
 139
 140 - The man-page of each program (section 1) is kept in the source
 141   directory of the program.
 142
 143 - The man-pages for the other sections are found in `src/man'.
 144
 145 - Documentation in other formats are located in the `doc' directory,
 146   including the groff info file, tutorials, and manuals.
 147
 148 Man-pages have source files ending in `.man'.  Running `make' processes
 149 the files and uses `.n' as the new file extension.  In both cases it is
 150 difficult to quickly decide into which section the man-page shall go.
 151 Here is a shell command (to be called from the top directory of the
 152 groff source tree) that finds all man-pages and writes the section
 153 number after each file name:
 154
 155   find -type f \
 156   | grep '[.]man$' \
 157   | sort \
 158   | xargs grep -e '^[.]TH ' \
 159   | sed -e 's/^\(.\+\): *\.TH.*@MAN\(.*\)EXT@.*$/\1 \2/'
 160
 161
 162 4) The roff parser
 163
 164 The parsing of the roff language is done by troff.  The input is converted
 165 to tokens in `src/roff/troff/input.cpp' and transformed into `nodes' by
 166 `src/roff/troff/env.cpp' and `src/roff/troff/node.cpp'.  From these, the
 167 intermediate output is generated (also in `node.cpp').
 168
 169
 170 5) Postprocessing
 171
 172 The parser for the intermediate output and the postprocessing is in
 173 `src/libs/libdriver/input.cpp'.  This is used by all postprocessors.