2003-06-30 21:51:41 +04:00
|
|
|
MANIFEST
|
|
|
|
|
|
2006-02-06 21:10:27 +03:00
|
|
|
Last update: 26 May 2005
|
2003-06-30 21:51:41 +04:00
|
|
|
|
|
|
|
|
This file is part of groff, the GNU roff type-setting system.
|
|
|
|
|
|
2006-02-06 21:10:27 +03:00
|
|
|
Copyright (C) 2001, 2003, 2004, 2005 Free Software Foundation, Inc.
|
2003-06-30 21:51:41 +04:00
|
|
|
written by Bernd Warken <bwarken@mayn.de>
|
|
|
|
|
maintained by Werner Lemberg <wl@gnu.org>
|
|
|
|
|
|
|
|
|
|
Permission is granted to copy, distribute and/or modify this document
|
|
|
|
|
under the terms of the GNU Free Documentation License, Version 1.1 or
|
|
|
|
|
any later version published by the Free Software Foundation; with the
|
|
|
|
|
Invariant Sections being this .ig-section and AUTHORS, with no
|
|
|
|
|
Front-Cover Texts, and with no Back-Cover Texts.
|
|
|
|
|
|
|
|
|
|
A copy of the Free Documentation License is included as a file called
|
|
|
|
|
FDL in the main directory of the groff source package.
|
|
|
|
|
|
|
|
|
|
########################################################################
|
|
|
|
|
|
|
|
|
|
This file gives an overview of the directories and the main files of
|
|
|
|
|
the groff source distribution.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
1) The top directory.
|
|
|
|
|
|
|
|
|
|
BUG-REPORT A template for bug-reports.
|
|
|
|
|
ChangeLog Log of the changes in the different groff versions.
|
|
|
|
|
COPYING The GNU General Public License (GPL).
|
|
|
|
|
FDL The Free Documentation License (FDL).
|
|
|
|
|
INSTALL Information on compiling and installing groff.
|
|
|
|
|
INSTALL.gen Generic information on configuration and compiling.
|
Import groff-1.19.1. Changes since 1.19:
Groff
-----
o The argument of the command line option `-I' is now also passed to troff
and grops, specifying a directory to search for files on the command line,
files named in `so' and `psbb' requests, and files named in \X'ps: file'
and \X'ps: import' escapes.
o If option `-V' is used more than once, the commands will be both printed
on standard error and run.
Troff
-----
o Two new read-only, string-valued registers `.m' and `.M' return the
name of the current drawing and background color, respectively.
o New read-only register `.U' which is set to 1 if in safer mode and set
to 0 if in unsafe mode.
o An input encoding file for latin-5 (a.k.a. ISO 8859-9) has been added.
Example use:
groff -Tdvi -mlatin5 my_file > my_file.dvi
Note that some output devices don't support all glyphs of this encoding.
o If the `return' request is called with an argument, it exits twice,
namely the current macro and the macro one level higher. This is
used to define a wrapper macro for `return' in trace.tmac.
o For completeness, two new requests have been added: `dei1' and `ami1'.
They are equivalent to `dei' and `ami', respectively, but the macros
are executed with compatibility mode off (similar to `de1' and `am1').
o New command line option `-I' to specify a directory for files (both
those on the command line and those named in `psbb' requests). This is
also handled by the groff wrapper program.
o Since version 1.19 you can say `.vs 0'. Older versions emit a warning
and convert this to `.vs \n[.V]'.
This hasn't been documented properly. Note that `.vs 0' isn't saved in a
diversion since it doesn't result in vertical motion.
Pic
___
o Dashed and dotted ellipses have been implemented.
Tbl
---
o New key character `x' to make tbl call a user-defined macro on a table
cell. Patch by Heinz-Jürgen Oertel <hj.oertel@surfeu.de>.
Grohtml
-------
o New option `-j' to emit output splitted into multiple files.
Grops
-----
o New command line option `-I' to specify a directory to search for files
on the command line and files named in \X'ps: import' and \X'ps: file'
escapes. This is also handled by the groff wrapper program.
o The default value for the `broken' keyword in the DESC file is now 0.
Grolj4
------
o A new man page `lj4_font(5)' documents how fonts are accessed with
grolj4.
o The built-in fonts for LJ4 and newer PCL 5 devices have been completely
revised, mainly to access as much glyphs as possible. The provided
metric files should be compatible with recent PCL 5 printers also.
Additionally, font description files have been added for the Arial and
Times New Roman family, the MS symbol, and Wingdings fonts.
Hpftodit
--------
o Completely revised to handle HP TrueType metric files also. See the
hpftodit manual page for more details.
Macro Packages
--------------
o www.tmac: New macro `JOBNAME' to split output into multiple files.
o In mdoc, multiple calls to `.Lb' are now supported in the LIBRARY
section.
2004-07-30 18:44:08 +04:00
|
|
|
LICENSE Licensing information.
|
2003-06-30 21:51:41 +04:00
|
|
|
MANIFEST The file you are reading.
|
|
|
|
|
MORE.STUFF Useful stuff in other packages.
|
|
|
|
|
NEWS Recent user-visible changes in groff.
|
|
|
|
|
PROBLEMS Tips to handle known critical situations.
|
|
|
|
|
PROJECTS Long-term additions to groff.
|
|
|
|
|
README Availability and contact information for groff.
|
Import groff-1.19.1. Changes since 1.19:
Groff
-----
o The argument of the command line option `-I' is now also passed to troff
and grops, specifying a directory to search for files on the command line,
files named in `so' and `psbb' requests, and files named in \X'ps: file'
and \X'ps: import' escapes.
o If option `-V' is used more than once, the commands will be both printed
on standard error and run.
Troff
-----
o Two new read-only, string-valued registers `.m' and `.M' return the
name of the current drawing and background color, respectively.
o New read-only register `.U' which is set to 1 if in safer mode and set
to 0 if in unsafe mode.
o An input encoding file for latin-5 (a.k.a. ISO 8859-9) has been added.
Example use:
groff -Tdvi -mlatin5 my_file > my_file.dvi
Note that some output devices don't support all glyphs of this encoding.
o If the `return' request is called with an argument, it exits twice,
namely the current macro and the macro one level higher. This is
used to define a wrapper macro for `return' in trace.tmac.
o For completeness, two new requests have been added: `dei1' and `ami1'.
They are equivalent to `dei' and `ami', respectively, but the macros
are executed with compatibility mode off (similar to `de1' and `am1').
o New command line option `-I' to specify a directory for files (both
those on the command line and those named in `psbb' requests). This is
also handled by the groff wrapper program.
o Since version 1.19 you can say `.vs 0'. Older versions emit a warning
and convert this to `.vs \n[.V]'.
This hasn't been documented properly. Note that `.vs 0' isn't saved in a
diversion since it doesn't result in vertical motion.
Pic
___
o Dashed and dotted ellipses have been implemented.
Tbl
---
o New key character `x' to make tbl call a user-defined macro on a table
cell. Patch by Heinz-Jürgen Oertel <hj.oertel@surfeu.de>.
Grohtml
-------
o New option `-j' to emit output splitted into multiple files.
Grops
-----
o New command line option `-I' to specify a directory to search for files
on the command line and files named in \X'ps: import' and \X'ps: file'
escapes. This is also handled by the groff wrapper program.
o The default value for the `broken' keyword in the DESC file is now 0.
Grolj4
------
o A new man page `lj4_font(5)' documents how fonts are accessed with
grolj4.
o The built-in fonts for LJ4 and newer PCL 5 devices have been completely
revised, mainly to access as much glyphs as possible. The provided
metric files should be compatible with recent PCL 5 printers also.
Additionally, font description files have been added for the Arial and
Times New Roman family, the MS symbol, and Wingdings fonts.
Hpftodit
--------
o Completely revised to handle HP TrueType metric files also. See the
hpftodit manual page for more details.
Macro Packages
--------------
o www.tmac: New macro `JOBNAME' to split output into multiple files.
o In mdoc, multiple calls to `.Lb' are now supported in the LIBRARY
section.
2004-07-30 18:44:08 +04:00
|
|
|
README.MinGW Build information for MinGW.
|
2003-06-30 21:51:41 +04:00
|
|
|
TODO Things planned for future groff versions.
|
|
|
|
|
|
|
|
|
|
All other files in the top directory are related to the configuration,
|
|
|
|
|
compilation, and install processes.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
2) The directory structure
|
|
|
|
|
|
|
|
|
|
./arch Data that is special for different architectures.
|
|
|
|
|
djgpp Data special for the 32-bit DOS compiler djgpp.
|
Import groff-1.19.1. Changes since 1.19:
Groff
-----
o The argument of the command line option `-I' is now also passed to troff
and grops, specifying a directory to search for files on the command line,
files named in `so' and `psbb' requests, and files named in \X'ps: file'
and \X'ps: import' escapes.
o If option `-V' is used more than once, the commands will be both printed
on standard error and run.
Troff
-----
o Two new read-only, string-valued registers `.m' and `.M' return the
name of the current drawing and background color, respectively.
o New read-only register `.U' which is set to 1 if in safer mode and set
to 0 if in unsafe mode.
o An input encoding file for latin-5 (a.k.a. ISO 8859-9) has been added.
Example use:
groff -Tdvi -mlatin5 my_file > my_file.dvi
Note that some output devices don't support all glyphs of this encoding.
o If the `return' request is called with an argument, it exits twice,
namely the current macro and the macro one level higher. This is
used to define a wrapper macro for `return' in trace.tmac.
o For completeness, two new requests have been added: `dei1' and `ami1'.
They are equivalent to `dei' and `ami', respectively, but the macros
are executed with compatibility mode off (similar to `de1' and `am1').
o New command line option `-I' to specify a directory for files (both
those on the command line and those named in `psbb' requests). This is
also handled by the groff wrapper program.
o Since version 1.19 you can say `.vs 0'. Older versions emit a warning
and convert this to `.vs \n[.V]'.
This hasn't been documented properly. Note that `.vs 0' isn't saved in a
diversion since it doesn't result in vertical motion.
Pic
___
o Dashed and dotted ellipses have been implemented.
Tbl
---
o New key character `x' to make tbl call a user-defined macro on a table
cell. Patch by Heinz-Jürgen Oertel <hj.oertel@surfeu.de>.
Grohtml
-------
o New option `-j' to emit output splitted into multiple files.
Grops
-----
o New command line option `-I' to specify a directory to search for files
on the command line and files named in \X'ps: import' and \X'ps: file'
escapes. This is also handled by the groff wrapper program.
o The default value for the `broken' keyword in the DESC file is now 0.
Grolj4
------
o A new man page `lj4_font(5)' documents how fonts are accessed with
grolj4.
o The built-in fonts for LJ4 and newer PCL 5 devices have been completely
revised, mainly to access as much glyphs as possible. The provided
metric files should be compatible with recent PCL 5 printers also.
Additionally, font description files have been added for the Arial and
Times New Roman family, the MS symbol, and Wingdings fonts.
Hpftodit
--------
o Completely revised to handle HP TrueType metric files also. See the
hpftodit manual page for more details.
Macro Packages
--------------
o www.tmac: New macro `JOBNAME' to split output into multiple files.
o In mdoc, multiple calls to `.Lb' are now supported in the LIBRARY
section.
2004-07-30 18:44:08 +04:00
|
|
|
misc Data needed for various platforms.
|
2003-06-30 21:51:41 +04:00
|
|
|
|
|
|
|
|
./contrib Part of groff, but maintained by other people.
|
|
|
|
|
eqn2graph Convert equations created with EQN into different
|
|
|
|
|
graphical formats.
|
2006-02-06 21:10:27 +03:00
|
|
|
gdiffmk An improved implementation of the diffmk command to mark
|
|
|
|
|
differences between groff/nroff/troff files.
|
Import groff-1.19.1. Changes since 1.19:
Groff
-----
o The argument of the command line option `-I' is now also passed to troff
and grops, specifying a directory to search for files on the command line,
files named in `so' and `psbb' requests, and files named in \X'ps: file'
and \X'ps: import' escapes.
o If option `-V' is used more than once, the commands will be both printed
on standard error and run.
Troff
-----
o Two new read-only, string-valued registers `.m' and `.M' return the
name of the current drawing and background color, respectively.
o New read-only register `.U' which is set to 1 if in safer mode and set
to 0 if in unsafe mode.
o An input encoding file for latin-5 (a.k.a. ISO 8859-9) has been added.
Example use:
groff -Tdvi -mlatin5 my_file > my_file.dvi
Note that some output devices don't support all glyphs of this encoding.
o If the `return' request is called with an argument, it exits twice,
namely the current macro and the macro one level higher. This is
used to define a wrapper macro for `return' in trace.tmac.
o For completeness, two new requests have been added: `dei1' and `ami1'.
They are equivalent to `dei' and `ami', respectively, but the macros
are executed with compatibility mode off (similar to `de1' and `am1').
o New command line option `-I' to specify a directory for files (both
those on the command line and those named in `psbb' requests). This is
also handled by the groff wrapper program.
o Since version 1.19 you can say `.vs 0'. Older versions emit a warning
and convert this to `.vs \n[.V]'.
This hasn't been documented properly. Note that `.vs 0' isn't saved in a
diversion since it doesn't result in vertical motion.
Pic
___
o Dashed and dotted ellipses have been implemented.
Tbl
---
o New key character `x' to make tbl call a user-defined macro on a table
cell. Patch by Heinz-Jürgen Oertel <hj.oertel@surfeu.de>.
Grohtml
-------
o New option `-j' to emit output splitted into multiple files.
Grops
-----
o New command line option `-I' to specify a directory to search for files
on the command line and files named in \X'ps: import' and \X'ps: file'
escapes. This is also handled by the groff wrapper program.
o The default value for the `broken' keyword in the DESC file is now 0.
Grolj4
------
o A new man page `lj4_font(5)' documents how fonts are accessed with
grolj4.
o The built-in fonts for LJ4 and newer PCL 5 devices have been completely
revised, mainly to access as much glyphs as possible. The provided
metric files should be compatible with recent PCL 5 printers also.
Additionally, font description files have been added for the Arial and
Times New Roman family, the MS symbol, and Wingdings fonts.
Hpftodit
--------
o Completely revised to handle HP TrueType metric files also. See the
hpftodit manual page for more details.
Macro Packages
--------------
o www.tmac: New macro `JOBNAME' to split output into multiple files.
o In mdoc, multiple calls to `.Lb' are now supported in the LIBRARY
section.
2004-07-30 18:44:08 +04:00
|
|
|
grap2graph Convert grap diagraps into different graphical formats.
|
2003-06-30 21:51:41 +04:00
|
|
|
groffer A wrapper to conveniently view roff files.
|
|
|
|
|
mm The groff mm macro package.
|
|
|
|
|
mom The groff mom macro package.
|
2006-02-06 21:10:27 +03:00
|
|
|
pdfmark A package to add PDF marks to groff documents, together
|
|
|
|
|
with a shell script (pdfroff) for easy creation of PDF
|
|
|
|
|
documents.
|
2003-06-30 21:51:41 +04:00
|
|
|
pic2graph Convert PIC diagrams into different graphical formats.
|
|
|
|
|
|
|
|
|
|
./doc Manuals and tutorials to groff aspects.
|
|
|
|
|
|
|
|
|
|
./font Device information and fonts.
|
|
|
|
|
devX100 100dpi device for X Window System.
|
|
|
|
|
devX100-12 100dpi device with narrower font (for 12pt base font).
|
|
|
|
|
devX75 75dpi device for X Window System.
|
|
|
|
|
devX75-12 75dpi device with narrower font (for 12pt base font).
|
|
|
|
|
devascii Text device for ASCII output.
|
|
|
|
|
devcp1047 EBCDIC device.
|
|
|
|
|
devdvi TeX DVI device.
|
|
|
|
|
devhtml HTML device.
|
|
|
|
|
devlatin1 Text device for latin-1 (ISO 8859-1) output.
|
|
|
|
|
devlbp Device for Canon CAPSL laser printers.
|
|
|
|
|
devlj4 Device for HP Laserjet 4, PCL 5, and compatible printers.
|
|
|
|
|
devps PostScript device.
|
|
|
|
|
devutf8 Text device for Unicode output.
|
|
|
|
|
|
|
|
|
|
./man Some groff manual pages of more general character.
|
|
|
|
|
|
|
|
|
|
./src Everything written in programming languages.
|
|
|
|
|
|
|
|
|
|
./src/devices The postprocessors.
|
|
|
|
|
grodvi TeX DVI output.
|
|
|
|
|
grohtml HTML output.
|
|
|
|
|
grolbp Canon printers.
|
|
|
|
|
grolj4 HP Laserjet 4, PCL 5, and compatible printers.
|
|
|
|
|
grops PostScript output.
|
|
|
|
|
grotty Text output.
|
2006-02-06 21:10:27 +03:00
|
|
|
xditview A groff (pre)viewer for the X Window system.
|
2003-06-30 21:51:41 +04:00
|
|
|
|
|
|
|
|
./src/include The *.h C/C++ include files.
|
|
|
|
|
|
|
|
|
|
./src/libs C++ code common to several parts of the groff sources.
|
|
|
|
|
libbib Library of bibliographic functions.
|
|
|
|
|
libdriver Parser for intermediate output and postprocessor code.
|
|
|
|
|
libgroff Library for general support functions used everywhere.
|
2006-02-06 21:10:27 +03:00
|
|
|
libxutil Utility functions for xditview and xtotroff.
|
2003-06-30 21:51:41 +04:00
|
|
|
snprintf An implementation of snprintf() and friends.
|
|
|
|
|
|
|
|
|
|
./src/preproc Preprocessors.
|
|
|
|
|
eqn Mathematical formulae.
|
|
|
|
|
grn Gremlin pictures.
|
|
|
|
|
html The preprocessor part of grohtml.
|
|
|
|
|
pic Diagram drawer.
|
|
|
|
|
refer Bibliographic references.
|
|
|
|
|
soelim File inclusion using tmac path.
|
|
|
|
|
tbl Tables.
|
|
|
|
|
|
|
|
|
|
./src/roff Front-end programs.
|
|
|
|
|
groff Wrapper around troff. This is the main user program.
|
|
|
|
|
grog Guess groff command line options.
|
|
|
|
|
nroff Emulate classical nroff text formatter.
|
|
|
|
|
troff Main roff formatter program.
|
|
|
|
|
|
|
|
|
|
./src/utils Utility programs around groff.
|
|
|
|
|
addftinfo Add information to old troff font files for use with groff.
|
|
|
|
|
afmtodit Create font description files for the PostScript device.
|
|
|
|
|
hpftodit Create font description files for the LJ4 device.
|
|
|
|
|
indxbib Make inverted index for bibliographic databases.
|
|
|
|
|
lkbib Search bibliographic databases.
|
|
|
|
|
lookbib Interactively search bibliographic databases.
|
|
|
|
|
pfbtops Translate a PostScript font in PFB format to PFA.
|
|
|
|
|
tfmtodit Create font description files for TeX DVI device.
|
2006-02-06 21:10:27 +03:00
|
|
|
xtotroff Create font description files for xditview.
|
2003-06-30 21:51:41 +04:00
|
|
|
|
|
|
|
|
./tmac Macro files.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
3) Documentation
|
|
|
|
|
|
|
|
|
|
The groff documentation is scattered upon several places.
|
|
|
|
|
|
|
|
|
|
- The main directory contains documents related to the groff source.
|
|
|
|
|
The README file contains the information needed to get the groff
|
|
|
|
|
package, report bugs, and contact the developers.
|
|
|
|
|
|
|
|
|
|
- The man-page of each program (section 1) is kept in the source
|
|
|
|
|
directory of the program.
|
|
|
|
|
|
|
|
|
|
- The man-pages for the other sections are found in `src/man'.
|
|
|
|
|
|
|
|
|
|
- Documentation in other formats are located in the `doc' directory,
|
|
|
|
|
including the groff info file, tutorials, and manuals.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
4) The roff parser
|
|
|
|
|
|
|
|
|
|
The parsing of the roff language is done by troff. The input is converted
|
|
|
|
|
to tokens in `src/roff/troff/input.cpp' and transformed into `nodes' by
|
|
|
|
|
`src/roff/troff/env.cpp' and `src/roff/troff/node.cpp'. From these, the
|
|
|
|
|
intermediate output is generated (also in `node.cpp').
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
5) Postprocessing
|
|
|
|
|
|
|
|
|
|
The parser for the intermediate output and the postprocessing is in
|
|
|
|
|
`src/libs/libdriver/input.cpp'. This is used by all postprocessors.
|