* Fixed problem when BASEDIR paths were given without a trailing '/'.

[linux_from_scratch.git] / newxml / chapter06 / groff.xml

<?xml version="1.0" encoding="ISO-8859-1"?>
<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
  <!ENTITY % general-entities SYSTEM "../general.ent">
  %general-entities;
]>
<sect1 id="ch-system-groff" xreflabel="Groff">
<title>Groff-&groff-version;</title>
<?dbhtml filename="groff.html"?>

<indexterm zone="ch-system-groff"><primary sortas="a-Groff">Groff</primary></indexterm>

<para>The Groff package contains programs for processing and formatting text.</para>

<screen>&buildtime; 0.5 SBU
&diskspace; 43 MB</screen>

<para>Groff installation depends on: Bash, Binutils, Coreutils, Diffutils,
Gawk, GCC, Glibc, Grep, Make, Sed.</para>



<sect2>
<title>Installation of Groff</title>

<para>Groff expects the environment variable PAGE to contain the default paper
size. For those in the United States, the command below is appropriate. If you
live elsewhere, you may want to change <emphasis>PAGE=letter</emphasis> to
<emphasis>PAGE=A4</emphasis>.</para>

<para>Prepare Groff for compilation:</para>

<screen><userinput>PAGE=letter ./configure --prefix=/usr</userinput></screen>

<para>Compile the package:</para>

<screen><userinput>make</userinput></screen>

<para>Now install it:</para>

<screen><userinput>make install</userinput></screen>

<para>Some documentation programs, such as <command>xman</command>,
will not work properly without the following symlinks:</para>

<screen><userinput>ln -s soelim /usr/bin/zsoelim
ln -s eqn /usr/bin/geqn
ln -s tbl /usr/bin/gtbl</userinput></screen>

</sect2>


<sect2 id="contents-groff"><title>Contents of Groff</title>

<para><emphasis>Installed programs</emphasis>: addftinfo, afmtodit, eqn,
eqn2graph, geqn (link to eqn), grn, grodvi, groff, groffer, grog, grolbp,
grolj4, grops, grotty, gtbl (link to tbl), hpftodit, indxbib, lkbib,
lookbib, mmroff, neqn, nroff, pfbtops, pic, pic2graph, post-grohtml,
pre-grohtml, refer, soelim, tbl, tfmtodit, troff and zsoelim (link to
soelim)</para>

</sect2>

<sect2><title>Short descriptions</title>

<indexterm zone="ch-system-groff addftinfo"><primary sortas="b-addftinfo">addftinfo</primary></indexterm>
<para id="addftinfo"><command>addftinfo</command> reads a troff font file and adds some
additional font-metric information that is used by the groff system.</para>

<indexterm zone="ch-system-groff afmtodit"><primary sortas="b-afmtodit">afmtodit</primary></indexterm>
<para id="afmtodit"><command>afmtodit</command> creates a font file for use with
groff and grops.</para>

<indexterm zone="ch-system-groff eqn"><primary sortas="b-eqn">eqn</primary></indexterm>
<para id="eqn"><command>eqn</command> compiles descriptions of equations embedded
within troff input files into commands that are understood by troff.</para>

<indexterm zone="ch-system-groff eqn2graph"><primary sortas="b-eqn2graph">eqn2graph</primary></indexterm>
<para id="eqn2graph"><command>eqn2graph</command> converts an EQN equation into a cropped
image.</para>

<indexterm zone="ch-system-groff grn"><primary sortas="b-grn">grn</primary></indexterm>
<para id="grn"><command>grn</command> is a groff preprocessor for gremlin files.</para>

<indexterm zone="ch-system-groff grodvi"><primary sortas="b-grodvi">grodvi</primary></indexterm>
<para id="grodvi"><command>grodvi</command> is a driver for groff that produces TeX dvi format.</para>

<indexterm zone="ch-system-groff groff"><primary sortas="b-groff">groff</primary></indexterm>
<para id="groff"><command>groff</command> 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>

<indexterm zone="ch-system-groff groffer"><primary sortas="b-groffer">groffer</primary></indexterm>
<para id="groffer"><command>groffer</command> displays groff files and man pages on X
and tty terminals.</para>

<indexterm zone="ch-system-groff grog"><primary sortas="b-grog">grog</primary></indexterm>
<para id="grog"><command>grog</command> reads files and guesses which of the groff
options -e, -man, -me, -mm, -ms, -p, -s, and -t are required for printing
files, and reports the groff command including those options.</para>

<indexterm zone="ch-system-groff grolbp"><primary sortas="b-grolbp">grolbp</primary></indexterm>
<para id="grolbp"><command>grolbp</command> is a groff driver for Canon CAPSL printers
(LBP-4 and LBP-8 series laser printers).</para>

<indexterm zone="ch-system-groff grolj4"><primary sortas="b-grolj4">grolj4</primary></indexterm>
<para id="grolj4"><command>grolj4</command> is a driver for groff that produces output
in PCL5 format suitable for an HP Laserjet 4 printer.</para>

<indexterm zone="ch-system-groff grops"><primary sortas="b-grops">grops</primary></indexterm>
<para id="grops"><command>grops</command> translates the output of GNU troff to
Postscript.</para>

<indexterm zone="ch-system-groff grotty"><primary sortas="b-grotty">grotty</primary></indexterm>
<para id="grotty"><command>grotty</command> translates the output of GNU troff into
a form suitable for typewriter-like devices.</para>

<indexterm zone="ch-system-groff gtbl"><primary sortas="b-gtbl">gtbl</primary></indexterm>
<para id="gtbl"><command>gtbl</command> is the GNU implementation of tbl.</para>

<indexterm zone="ch-system-groff hpftodit"><primary sortas="b-hpftodit">hpftodit</primary></indexterm>
<para id="hpftodit"><command>hpftodit</command> creates a font file for use with
groff -Tlj4 from an HP-tagged font metric file.</para>

<indexterm zone="ch-system-groff indxbib"><primary sortas="b-indxbib">indxbib</primary></indexterm>
<para id="indxbib"><command>indxbib</command> makes an inverted index for the
bibliographic databases a specified file for use with refer, lookbib,
and lkbib.</para>

<indexterm zone="ch-system-groff lkbib"><primary sortas="b-lkbib">lkbib</primary></indexterm>
<para id="lkbib"><command>lkbib</command> searches bibliographic databases for
references that contain specified keys and reports any references found.</para>

<indexterm zone="ch-system-groff lookbib"><primary sortas="b-lookbib">lookbib</primary></indexterm>
<para id="lookbib"><command>lookbib</command> 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>

<indexterm zone="ch-system-groff mmroff"><primary sortas="b-mmroff">mmroff</primary></indexterm>
<para id="mmroff"><command>mmroff</command> is a simple preprocessor for groff.</para>

<indexterm zone="ch-system-groff neqn"><primary sortas="b-neqn">neqn</primary></indexterm>
<para id="neqn"><command>neqn</command> formats equations for ASCII (American Standard Code for Information Interchange) output.</para>

<indexterm zone="ch-system-groff nroff"><primary sortas="b-nroff">nroff</primary></indexterm>
<para id="nroff"><command>nroff</command> is a script that emulates the nroff command
using groff.</para>

<indexterm zone="ch-system-groff pfbtops"><primary sortas="b-pfbtops">pfbtops</primary></indexterm>
<para id="pfbtops"><command>pfbtops</command> translates a Postscript font in .pfb
format to ASCII.</para>

<indexterm zone="ch-system-groff pic"><primary sortas="b-pic">pic</primary></indexterm>
<para id="pic"><command>pic</command> compiles descriptions of pictures embedded
within troff or TeX input files into commands understood by TeX or troff.</para>

<indexterm zone="ch-system-groff pic2graph"><primary sortas="b-pic2graph">pic2graph</primary></indexterm>
<para id="pic2graph"><command>pic2graph</command> converts a PIC diagram into a cropped
image.</para>

<indexterm zone="ch-system-groff pre-grohtml"><primary sortas="b-pre-grohtml">pre-grohtml</primary></indexterm>
<para id="pre-grohtml"><command>pre-grohtml </command> translates the output of GNU troff
to html.</para>

<indexterm zone="ch-system-groff post-grohtml"><primary sortas="b-post-grohtml">post-grohtml</primary></indexterm>
<para id="post-grohtml"><command>post-grohtml</command> translates the output of GNU troff
to html.</para>

<indexterm zone="ch-system-groff refer"><primary sortas="b-refer">refer</primary></indexterm>
<para id="refer"><command>refer</command> 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>

<indexterm zone="ch-system-groff soelim"><primary sortas="b-soelim">soelim</primary></indexterm>
<para id="soelim"><command>soelim</command> reads files and replaces lines of the form
<emphasis>.so file</emphasis> by the contents of the mentioned
<emphasis>file</emphasis>.</para>

<indexterm zone="ch-system-groff tbl"><primary sortas="b-tbl">tbl</primary></indexterm>
<para id="tbl"><command>tbl</command> compiles descriptions of tables embedded
within troff input files into commands that are understood by troff.</para>

<indexterm zone="ch-system-groff tfmtodit"><primary sortas="b-tfmtodit">tfmtodit</primary></indexterm>
<para id="tfmtodit"><command>tfmtodit</command> creates a font file for use with
groff -Tdvi.</para>

<indexterm zone="ch-system-groff troff"><primary sortas="b-troff">troff</primary></indexterm>
<para id="troff"><command>troff</command> 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>

<indexterm zone="ch-system-groff zsoelim"><primary sortas="b-zsoelim">zsoelim</primary></indexterm>
<para id="zsoelim"><command>zsoelim</command> is the GNU implementation of soelim.</para>

</sect2>



</sect1>