diff options
Diffstat (limited to 'chapter06/groff.xml')
| -rw-r--r-- | chapter06/groff.xml | 271 |
1 files changed, 209 insertions, 62 deletions
diff --git a/chapter06/groff.xml b/chapter06/groff.xml index 5ad0f34b0..f580255ba 100644 --- a/chapter06/groff.xml +++ b/chapter06/groff.xml @@ -55,155 +55,302 @@ ln -s tbl /usr/bin/gtbl</userinput></screen> </sect2> -<sect2 id="contents-groff"><title>Contents of Groff</title> +<sect2 id="contents-groff" role="content"><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> +<segmentedlist> +<segtitle>Installed programs</segtitle> +<seglistitem><seg>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)</seg></seglistitem> +</segmentedlist> -<sect2><title>Short descriptions</title> +<variablelist><title>Short descriptions</title> +<varlistentry> +<term id="addftinfo"><command>addftinfo</command></term> +<listitem> <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 +<para>reads a troff font file and adds some additional font-metric information that is used by the groff system.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="afmtodit"><command>afmtodit</command></term> +<listitem> <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> +<para>creates a font file for use with groff and grops.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="eqn"><command>eqn</command></term> +<listitem> <indexterm zone="ch-system-groff eqn"><primary sortas="b-eqn">eqn</primary></indexterm> -<para id="eqn"><command>eqn</command> compiles descriptions of equations embedded +<para>compiles descriptions of equations embedded within troff input files into commands that are understood by troff.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="eqn2graph"><command>eqn2graph</command></term> +<listitem> <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> +<para>converts an EQN equation into a cropped image.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grn"><command>grn</command></term> +<listitem> <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> +<para>is a groff preprocessor for gremlin files.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grodvi"><command>grodvi</command></term> +<listitem> <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> +<para>is a driver for groff that produces TeX dvi format.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="groff"><command>groff</command></term> +<listitem> <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 +<para>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> +</listitem> +</varlistentry> +<varlistentry> +<term id="groffer"><command>groffer</command></term> +<listitem> <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> +<para>displays groff files and man pages on X and tty terminals.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grog"><command>grog</command></term> +<listitem> <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 +<para>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> +</listitem> +</varlistentry> +<varlistentry> +<term id="grolbp"><command>grolbp</command></term> +<listitem> <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 +<para>is a groff driver for Canon CAPSL printers (LBP-4 and LBP-8 series laser printers).</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grolj4"><command>grolj4</command></term> +<listitem> <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 +<para>is a driver for groff that produces output in PCL5 format suitable for an HP Laserjet 4 printer.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grops"><command>grops</command></term> +<listitem> <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> +<para>translates the output of GNU troff to Postscript.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="grotty"><command>grotty</command></term> +<listitem> <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 +<para>translates the output of GNU troff into a form suitable for typewriter-like devices.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="gtbl"><command>gtbl</command></term> +<listitem> <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> +<para>is the GNU implementation of tbl.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="hpftodit"><command>hpftodit</command></term> +<listitem> <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 +<para>creates a font file for use with groff -Tlj4 from an HP-tagged font metric file.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="indxbib"><command>indxbib</command></term> +<listitem> <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> - +<para>makes an inverted index for the bibliographic databases a specified file for +use with refer, lookbib, and lkbib.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="lkbib"><command>lkbib</command></term> +<listitem> <indexterm zone="ch-system-groff lkbib"><primary sortas="b-lkbib">lkbib</primary></indexterm> -<para id="lkbib"><command>lkbib</command> searches bibliographic databases for +<para>searches bibliographic databases for references that contain specified keys and reports any references found.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="lookbib"><command>lookbib</command></term> +<listitem> <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 +<para>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> +</listitem> +</varlistentry> +<varlistentry> +<term id="mmroff"><command>mmroff</command></term> +<listitem> <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> +<para>is a simple preprocessor for groff.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="neqn"><command>neqn</command></term> +<listitem> <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> - +<para>formats equations for ASCII (American Standard Code for Information +Interchange) output.</para> +</listitem> +</varlistentry> + +<varlistentry> +<term id="nroff"><command>nroff</command></term> +<listitem> <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> +<para>is a script that emulates the nroff command using groff.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pfbtops"><command>pfbtops</command></term> +<listitem> <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> +<para>translates a Postscript font in .pfb format to ASCII.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pic"><command>pic</command></term> +<listitem> <indexterm zone="ch-system-groff pic"><primary sortas="b-pic">pic</primary></indexterm> -<para id="pic"><command>pic</command> compiles descriptions of pictures embedded +<para>compiles descriptions of pictures embedded within troff or TeX input files into commands understood by TeX or troff.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pic2graph"><command>pic2graph</command></term> +<listitem> <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> +<para>converts a PIC diagram into a cropped image.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="pre-grohtml"><command>pre-grohtml </command></term> +<listitem> <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> +<para>translates the output of GNU troff to html.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="post-grohtml"><command>post-grohtml</command></term> +<listitem> <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> +<para>translates the output of GNU troff to html.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="refer"><command>refer</command></term> +<listitem> <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 +<para>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> +</listitem> +</varlistentry> +<varlistentry> +<term id="soelim"><command>soelim</command></term> +<listitem> <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 +<para>reads files and replaces lines of the form <emphasis>.so file</emphasis> by the contents of the mentioned <emphasis>file</emphasis>.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tbl"><command>tbl</command></term> +<listitem> <indexterm zone="ch-system-groff tbl"><primary sortas="b-tbl">tbl</primary></indexterm> -<para id="tbl"><command>tbl</command> compiles descriptions of tables embedded +<para>compiles descriptions of tables embedded within troff input files into commands that are understood by troff.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="tfmtodit"><command>tfmtodit</command></term> +<listitem> <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> +<para>creates a font file for use with groff -Tdvi.</para> +</listitem> +</varlistentry> +<varlistentry> +<term id="troff"><command>troff</command></term> +<listitem> <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> - +<para>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> +</listitem> +</varlistentry> + +<varlistentry> +<term id="zsoelim"><command>zsoelim</command></term> +<listitem> <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> +<para>is the GNU implementation of soelim.</para> +</listitem> +</varlistentry> +</variablelist> </sect2> - - </sect1> |