source: appendixa/groff-desc.xml@ 713cffb

<sect2>
<title>Contents</title>

<para>
The Groff packages contains the addftinfo, afmtodit, eqn, grodvi, groff,
grog, grohtml, grolj4, grops, grotty, hpftodit, indxbib, lkbib, lookbib,
neqn, nroff, pfbtops, pic, psbb, refer, soelim, tbl, tfmtodit and troff
programs.
</para>

</sect2>

<sect2><title>Description</title>

<sect3><title>addftinfo</title>

<para>
addftinfo reads a troff font file and adds some additional font-metric 
information that is used by the groff system.
</para>

</sect3>

<sect3><title>afmtodit</title>

<para>
afmtodit creates a font file for use with groff and grops.
</para>

</sect3>

<sect3><title>eqn</title>

<para>
eqn compiles descriptions of equations embedded within troff input files 
into commands that are understood by troff.
</para>

</sect3>

<sect3><title>grodvi</title>

<para>
grodvi is a driver for groff that produces TeX dvi format.
</para>

</sect3>

<sect3><title>groff</title>

<para>
groff is a front-end to the groff document formatting system. Normally it 
runs the troff program and a post-processor appropriate for the selected 
device.
</para>

</sect3>

<sect3><title>grog</title>

<para>
grog reads files and guesses which of the groff options -e, -man, -me, -mm, 
-ms, -p, -s, and -t are required for printing files, and prints the groff
command including those options on the standard output.
</para>

</sect3>

<sect3><title>grohtml</title>

<para>
grohtml translates the output of GNU troff to html
</para>

</sect3>

<sect3><title>grolj4</title>

<para>
grolj4 is a driver for groff that produces output in PCL5 format suitable 
for an HP Laserjet 4 printer.
</para>

</sect3>

<sect3><title>grops</title>

<para>
grops translates the output of GNU troff to Postscript.
</para>

</sect3>

<sect3><title>grotty</title>

<para>
grotty translates the output of GNU troff into a form suitable for 
typewriter-like  devices.
</para>

</sect3>

<sect3><title>hpftodit</title>

<para>
hpftodit creates a font file for use with groff -Tlj4 from an  HP
tagged font metric file.
</para>

</sect3>

<sect3><title>indxbib</title>

<para>
indxbib makes an inverted index for the bibliographic databases a
specified file for use with refer, lookbib, and lkbib.
</para>

</sect3>

<sect3><title>lkbib</title>

<para>
lkbib searches bibliographic databases for references that contain 
specified keys and prints any references found on the standard output.
</para>

</sect3>

<sect3><title>lookbib</title>

<para>
lookbib prints a prompt on the standard error (unless the standard input 
is not a terminal), reads from the standard input a line containing a set 
of keywords, searches the bibliographic databases in a specified file for  
references containing those keywords, prints any references found on the
standard output, and repeats this process until the end of input.
</para>

</sect3>

<sect3><title>neqn</title>

<para>
It is currently not known what neqn is and what it does.
</para>

</sect3>

<sect3><title>nroff</title>

<para>
The nroff script emulates the nroff command using groff.
</para>

</sect3>

<sect3><title>pfbtops</title>

<para>
pfbtops translates a Postscript font in .pfb format to ASCII.
</para>

</sect3>

<sect3><title>pic</title>

<para>
pic compiles descriptions of pictures embedded within troff or TeX input 
files into commands that are understood by TeX or  troff.
</para>

</sect3>

<sect3><title>psbb</title>

<para>
psbb reads a file which should be a Postscript document conforming to the 
Document Structuring conventions and looks for a %%BoundingBox comment.
</para>

</sect3>

<sect3><title>refer</title>

<para>
refer copies the contents of a file to the standard output, except that 
lines between .[ and .] are interpreted as citations, and lines between .R1 
and  .R2  are  interpreted as commands about how citations are to be 
processed.
</para>

</sect3>

<sect3><title>soelim</title>

<para>
soelim reads files and replaces lines of the form 
<emphasis>.so file</emphasis> by  the  contents of
<emphasis>file</emphasis>.
</para>

</sect3>

<sect3><title>tbl</title>

<para>
tbl compiles descriptions of tables embedded within troff input files 
into commands that are understood  by  troff.
</para>

</sect3>

<sect3><title>tfmtodit</title>

<para>
tfmtodit creates a font file for use with <userinput>groff
-Tdvi</userinput>
</para>

</sect3>

<sect3><title>troff</title>

<para>
troff is highly compatible with Unix troff. Usually it should be invoked 
using the groff command, which will also run preprocessors and 
post-processors in the appropriate order and with the appropriate options.
</para>

</sect3>

</sect2>