diff options
Diffstat (limited to 'chapter06/groff.xml')
| -rw-r--r-- | chapter06/groff.xml | 311 |
1 files changed, 2 insertions, 309 deletions
diff --git a/chapter06/groff.xml b/chapter06/groff.xml index 3f921d651..1039bd319 100644 --- a/chapter06/groff.xml +++ b/chapter06/groff.xml @@ -10,7 +10,6 @@ <indexterm zone="ch-system-groff"><primary sortas="a-Groff">Groff</primary></indexterm> <sect2 role="package"><title/> -<para>The Groff package contains programs for processing and formatting text.</para> <segmentedlist> <segtitle>&buildtime;</segtitle> @@ -18,21 +17,11 @@ <seglistitem><seg>0.5 SBU</seg><seg>43 MB</seg></seglistitem> </segmentedlist> -<segmentedlist> -<segtitle>Groff installation depends on</segtitle> -<seglistitem><seg>Bash, Binutils, Coreutils, Diffutils, -Gawk, GCC, Glibc, Grep, Make, Sed</seg></seglistitem> -</segmentedlist> </sect2> <sect2 role="installation"> <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=<replaceable>[paper_size]</replaceable> ./configure --prefix=/usr</userinput></screen> @@ -45,8 +34,7 @@ live elsewhere, you may want to change <emphasis>PAGE=letter</emphasis> to <screen><userinput>make install</userinput></screen> -<para>Some documentation programs, such as <command>xman</command>, -will not work properly without the following symlinks:</para> +<para>Create the following symlinks:</para> <screen><userinput>ln -s soelim /usr/bin/zsoelim ln -s eqn /usr/bin/geqn @@ -57,302 +45,7 @@ ln -s tbl /usr/bin/gtbl</userinput></screen> <sect2 id="contents-groff" role="content"><title>Contents of Groff</title> -<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> - -<variablelist><title>Short descriptions</title> - -<varlistentry id="addftinfo"> -<term><command>addftinfo</command></term> -<listitem> -<indexterm zone="ch-system-groff addftinfo"><primary sortas="b-addftinfo">addftinfo</primary></indexterm> -<para>reads a troff font file and adds some -additional font-metric information that is used by the <command>groff</command> system.</para> -</listitem> -</varlistentry> - -<varlistentry id="afmtodit"> -<term><command>afmtodit</command></term> -<listitem> -<indexterm zone="ch-system-groff afmtodit"><primary sortas="b-afmtodit">afmtodit</primary></indexterm> -<para>creates a font file for use with <command>groff</command> and <command>grops</command>.</para> -</listitem> -</varlistentry> - -<varlistentry id="eqn"> -<term><command>eqn</command></term> -<listitem> -<indexterm zone="ch-system-groff eqn"><primary sortas="b-eqn">eqn</primary></indexterm> -<para>compiles descriptions of equations embedded -within troff input files into commands that are understood by <command>troff</command>.</para> -</listitem> -</varlistentry> - -<varlistentry id="eqn2graph"> -<term><command>eqn2graph</command></term> -<listitem> -<indexterm zone="ch-system-groff eqn2graph"><primary sortas="b-eqn2graph">eqn2graph</primary></indexterm> -<para>converts an EQN equation into a cropped image.</para> -</listitem> -</varlistentry> - -<varlistentry id="grn"> -<term><command>grn</command></term> -<listitem> -<indexterm zone="ch-system-groff grn"><primary sortas="b-grn">grn</primary></indexterm> -<para>is a <command>groff</command> preprocessor for gremlin files.</para> -</listitem> -</varlistentry> - -<varlistentry id="grodvi"> -<term><command>grodvi</command></term> -<listitem> -<indexterm zone="ch-system-groff grodvi"><primary sortas="b-grodvi">grodvi</primary></indexterm> -<para>is a driver for <command>groff</command> that produces TeX dvi format.</para> -</listitem> -</varlistentry> - -<varlistentry id="groff"> -<term><command>groff</command></term> -<listitem> -<indexterm zone="ch-system-groff groff"><primary sortas="b-groff">groff</primary></indexterm> -<para>is a front-end to the groff document -formatting system. Normally it runs the <command>troff</command> program and a post-processor -appropriate for the selected device.</para> -</listitem> -</varlistentry> - -<varlistentry id="groffer"> -<term><command>groffer</command></term> -<listitem> -<indexterm zone="ch-system-groff groffer"><primary sortas="b-groffer">groffer</primary></indexterm> -<para>displays groff files and man pages on X and tty terminals.</para> -</listitem> -</varlistentry> - -<varlistentry id="grog"> -<term><command>grog</command></term> -<listitem> -<indexterm zone="ch-system-groff grog"><primary sortas="b-grog">grog</primary></indexterm> -<para>reads files and guesses which of the <command>groff</command> -options <parameter>-e</parameter>, <parameter>-man</parameter>, -<parameter>-me</parameter>, <parameter>-mm</parameter>, -<parameter>-ms</parameter>, <parameter>-p</parameter>, <parameter>-s</parameter>, -and <parameter>-t</parameter> are required for printing -files, and reports the <command>groff</command> command including those options.</para> -</listitem> -</varlistentry> - -<varlistentry id="grolbp"> -<term><command>grolbp</command></term> -<listitem> -<indexterm zone="ch-system-groff grolbp"><primary sortas="b-grolbp">grolbp</primary></indexterm> -<para>is a <command>groff</command> driver for Canon CAPSL printers -(LBP-4 and LBP-8 series laser printers).</para> -</listitem> -</varlistentry> - -<varlistentry id="grolj4"> -<term><command>grolj4</command></term> -<listitem> -<indexterm zone="ch-system-groff grolj4"><primary sortas="b-grolj4">grolj4</primary></indexterm> -<para>is a driver for <command>groff</command> that produces output -in PCL5 format suitable for an HP Laserjet 4 printer.</para> -</listitem> -</varlistentry> - -<varlistentry id="grops"> -<term><command>grops</command></term> -<listitem> -<indexterm zone="ch-system-groff grops"><primary sortas="b-grops">grops</primary></indexterm> -<para>translates the output of GNU <command>troff</command> to PostScript.</para> -</listitem> -</varlistentry> - -<varlistentry id="grotty"> -<term><command>grotty</command></term> -<listitem> -<indexterm zone="ch-system-groff grotty"><primary sortas="b-grotty">grotty</primary></indexterm> -<para>translates the output of GNU <command>troff</command> into -a form suitable for typewriter-like devices.</para> -</listitem> -</varlistentry> - -<varlistentry id="gtbl"> -<term><command>gtbl</command></term> -<listitem> -<indexterm zone="ch-system-groff gtbl"><primary sortas="b-gtbl">gtbl</primary></indexterm> -<para>is the GNU implementation of <command>tbl</command>.</para> -</listitem> -</varlistentry> - -<varlistentry id="hpftodit"> -<term><command>hpftodit</command></term> -<listitem> -<indexterm zone="ch-system-groff hpftodit"><primary sortas="b-hpftodit">hpftodit</primary></indexterm> -<para>creates a font file for use with -<command>groff -Tlj4</command> from an HP-tagged font metric file.</para> -</listitem> -</varlistentry> - -<varlistentry id="indxbib"> -<term><command>indxbib</command></term> -<listitem> -<indexterm zone="ch-system-groff indxbib"><primary sortas="b-indxbib">indxbib</primary></indexterm> -<para>makes an inverted index for the bibliographic databases a specified file for -use with <command>refer</command>, <command>lookbib</command>, and <command>lkbib</command>.</para> -</listitem> -</varlistentry> - -<varlistentry id="lkbib"> -<term><command>lkbib</command></term> -<listitem> -<indexterm zone="ch-system-groff lkbib"><primary sortas="b-lkbib">lkbib</primary></indexterm> -<para>searches bibliographic databases for -references that contain specified keys and reports any references found.</para> -</listitem> -</varlistentry> - -<varlistentry id="lookbib"> -<term><command>lookbib</command></term> -<listitem> -<indexterm zone="ch-system-groff lookbib"><primary sortas="b-lookbib">lookbib</primary></indexterm> -<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 id="mmroff"> -<term><command>mmroff</command></term> -<listitem> -<indexterm zone="ch-system-groff mmroff"><primary sortas="b-mmroff">mmroff</primary></indexterm> -<para>is a simple preprocessor for <command>groff</command>.</para> -</listitem> -</varlistentry> - -<varlistentry id="neqn"> -<term><command>neqn</command></term> -<listitem> -<indexterm zone="ch-system-groff neqn"><primary sortas="b-neqn">neqn</primary></indexterm> -<para>formats equations for ASCII (American Standard Code for Information -Interchange) output.</para> -</listitem> -</varlistentry> - -<varlistentry id="nroff"> -<term><command>nroff</command></term> -<listitem> -<indexterm zone="ch-system-groff nroff"><primary sortas="b-nroff">nroff</primary></indexterm> -<para>is a script that emulates the <command>nroff</command> command using <command>groff</command>.</para> -</listitem> -</varlistentry> - -<varlistentry id="pfbtops"> -<term><command>pfbtops</command></term> -<listitem> -<indexterm zone="ch-system-groff pfbtops"><primary sortas="b-pfbtops">pfbtops</primary></indexterm> -<para>translates a PostScript font in <filename class="extension">.pfb</filename> format to ASCII.</para> -</listitem> -</varlistentry> - -<varlistentry id="pic"> -<term><command>pic</command></term> -<listitem> -<indexterm zone="ch-system-groff pic"><primary sortas="b-pic">pic</primary></indexterm> -<para>compiles descriptions of pictures embedded -within troff or TeX input files into commands understood by TeX or <command>troff</command>.</para> -</listitem> -</varlistentry> - -<varlistentry id="pic2graph"> -<term><command>pic2graph</command></term> -<listitem> -<indexterm zone="ch-system-groff pic2graph"><primary sortas="b-pic2graph">pic2graph</primary></indexterm> -<para>converts a PIC diagram into a cropped image.</para> -</listitem> -</varlistentry> - -<varlistentry id="pre-grohtml"> -<term><command>pre-grohtml </command></term> -<listitem> -<indexterm zone="ch-system-groff pre-grohtml"><primary sortas="b-pre-grohtml">pre-grohtml</primary></indexterm> -<para>translates the output of GNU <command>troff</command> to html.</para> -</listitem> -</varlistentry> - -<varlistentry id="post-grohtml"> -<term><command>post-grohtml</command></term> -<listitem> -<indexterm zone="ch-system-groff post-grohtml"><primary sortas="b-post-grohtml">post-grohtml</primary></indexterm> -<para>translates the output of GNU <command>troff</command> to html.</para> -</listitem> -</varlistentry> - -<varlistentry id="refer"> -<term><command>refer</command></term> -<listitem> -<indexterm zone="ch-system-groff refer"><primary sortas="b-refer">refer</primary></indexterm> -<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 id="soelim"> -<term><command>soelim</command></term> -<listitem> -<indexterm zone="ch-system-groff soelim"><primary sortas="b-soelim">soelim</primary></indexterm> -<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 id="tbl"> -<term><command>tbl</command></term> -<listitem> -<indexterm zone="ch-system-groff tbl"><primary sortas="b-tbl">tbl</primary></indexterm> -<para>compiles descriptions of tables embedded -within troff input files into commands that are understood by <command>troff</command>.</para> -</listitem> -</varlistentry> - -<varlistentry id="tfmtodit"> -<term><command>tfmtodit</command></term> -<listitem> -<indexterm zone="ch-system-groff tfmtodit"><primary sortas="b-tfmtodit">tfmtodit</primary></indexterm> -<para>creates a font file for use with <command>groff -Tdvi</command>.</para> -</listitem> -</varlistentry> - -<varlistentry id="troff"> -<term><command>troff</command></term> -<listitem> -<indexterm zone="ch-system-groff troff"><primary sortas="b-troff">troff</primary></indexterm> -<para>is highly compatible with Unix <command>troff</command>. Usually it should be invoked using the -<command>groff</command> command, which will also run preprocessors and post-processors in the -appropriate order and with the appropriate options.</para> -</listitem> -</varlistentry> - -<varlistentry id="zsoelim"> -<term><command>zsoelim</command></term> -<listitem> -<indexterm zone="ch-system-groff zsoelim"><primary sortas="b-zsoelim">zsoelim</primary></indexterm> -<para>is the GNU implementation of <command>soelim</command>.</para> -</listitem> -</varlistentry> -</variablelist> +<para>See testing</para> </sect2> |