diff options
author | Gerard Beekmans <gerard@linuxfromscratch.org> | 2005-02-19 22:16:42 +0000 |
---|---|---|
committer | Gerard Beekmans <gerard@linuxfromscratch.org> | 2005-02-19 22:16:42 +0000 |
commit | 81fd230419b0cfd052b08fc1ed352bb7d49975df (patch) | |
tree | 24c98d2876e5b457dcb88d39e7cca4905f58691a /chapter06/groff.xml | |
parent | 2f9131f8390243dbc350fe2eeb9e1d58f0264888 (diff) |
Trunk is now identical to Testing
git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@4648 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689
Diffstat (limited to 'chapter06/groff.xml')
-rw-r--r-- | chapter06/groff.xml | 327 |
1 files changed, 323 insertions, 4 deletions
diff --git a/chapter06/groff.xml b/chapter06/groff.xml index eae23fc23..5289367b8 100644 --- a/chapter06/groff.xml +++ b/chapter06/groff.xml @@ -3,13 +3,14 @@ <!ENTITY % general-entities SYSTEM "../general.ent"> %general-entities; ]> -<sect1 id="ch-system-groff" xreflabel="Groff" role="wrap"> +<sect1 id="ch-system-groff" role="wrap"> <title>Groff-&groff-version;</title> <?dbhtml filename="groff.html"?> <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> @@ -17,11 +18,21 @@ <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, and Sed</seg></seglistitem> +</segmentedlist> </sect2> <sect2 role="installation"> <title>Installation of Groff</title> +<para>Groff expects the environment variable <envar>PAGE</envar> +to contain the default paper size. For users in the United States, +<parameter>PAGE=letter</parameter> is appropriate. Elsewhere, +<parameter>PAGE=A4</parameter> may be more suitable.</para> + <para>Prepare Groff for compilation:</para> <screen><userinput>PAGE=<replaceable>[paper_size]</replaceable> ./configure --prefix=/usr</userinput></screen> @@ -30,11 +41,12 @@ <screen><userinput>make</userinput></screen> -<para>Now install it:</para> +<para>Install the package:</para> <screen><userinput>make install</userinput></screen> -<para>Create the following symlinks:</para> +<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 @@ -45,8 +57,315 @@ ln -s tbl /usr/bin/gtbl</userinput></screen> <sect2 id="contents-groff" role="content"><title>Contents of Groff</title> -<para>See testing</para> +<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><bridgehead renderas="sect3">Short Descriptions</bridgehead> +<?dbfo list-presentation="list"?> + +<varlistentry id="addftinfo"> +<term><command>addftinfo</command></term> +<listitem> +<para>Reads a troff font file and adds some +additional font-metric information that is used by the <command>groff</command> system</para> +<indexterm zone="ch-system-groff addftinfo"><primary sortas="b-addftinfo">addftinfo</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="afmtodit"> +<term><command>afmtodit</command></term> +<listitem> +<para>Creates a font file for use with <command>groff</command> and <command>grops</command></para> +<indexterm zone="ch-system-groff afmtodit"><primary sortas="b-afmtodit">afmtodit</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="eqn"> +<term><command>eqn</command></term> +<listitem> +<para>Compiles descriptions of equations embedded +within troff input files into commands that are understood by <command>troff</command></para> +<indexterm zone="ch-system-groff eqn"><primary sortas="b-eqn">eqn</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="eqn2graph"> +<term><command>eqn2graph</command></term> +<listitem> +<para>Converts a troff EQN (equation) into a cropped image</para> +<indexterm zone="ch-system-groff eqn2graph"><primary sortas="b-eqn2graph">eqn2graph</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="geqn"> +<term><command>eqn</command></term> +<listitem> +<para>A link to <command>eqn</command></para> +<indexterm zone="ch-system-groff geqn"><primary sortas="b-geqn">geqn</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="grn"> +<term><command>grn</command></term> +<listitem> +<para>A <command>groff</command> preprocessor for gremlin files</para> +<indexterm zone="ch-system-groff grn"><primary sortas="b-grn">grn</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="grodvi"> +<term><command>grodvi</command></term> +<listitem> +<para>A driver for <command>groff</command> that produces TeX dvi format</para> +<indexterm zone="ch-system-groff grodvi"><primary sortas="b-grodvi">grodvi</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="groff"> +<term><command>groff</command></term> +<listitem> +<para>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> +<indexterm zone="ch-system-groff groff"><primary sortas="b-groff">groff</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="groffer"> +<term><command>groffer</command></term> +<listitem> +<para>Displays groff files and man pages on X and tty terminals</para> +<indexterm zone="ch-system-groff groffer"><primary sortas="b-groffer">groffer</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="grog"> +<term><command>grog</command></term> +<listitem> +<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> +<indexterm zone="ch-system-groff grog"><primary sortas="b-grog">grog</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="grolbp"> +<term><command>grolbp</command></term> +<listitem> +<para>Is a <command>groff</command> driver for Canon CAPSL printers +(LBP-4 and LBP-8 series laser printers)</para> +<indexterm zone="ch-system-groff grolbp"><primary sortas="b-grolbp">grolbp</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="grolj4"> +<term><command>grolj4</command></term> +<listitem> +<para>Is a driver for <command>groff</command> that produces output +in PCL5 format suitable for an HP Laserjet 4 printer</para> +<indexterm zone="ch-system-groff grolj4"><primary sortas="b-grolj4">grolj4</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="grops"> +<term><command>grops</command></term> +<listitem> +<para>Translates the output of GNU <command>troff</command> to PostScript</para> +<indexterm zone="ch-system-groff grops"><primary sortas="b-grops">grops</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="grotty"> +<term><command>grotty</command></term> +<listitem> +<para>Translates the output of GNU <command>troff</command> into +a form suitable for typewriter-like devices</para> +<indexterm zone="ch-system-groff grotty"><primary sortas="b-grotty">grotty</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="gtbl"> +<term><command>gtbl</command></term> +<listitem> +<para>Is the GNU implementation of <command>tbl</command></para> +<indexterm zone="ch-system-groff gtbl"><primary sortas="b-gtbl">gtbl</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="hpftodit"> +<term><command>hpftodit</command></term> +<listitem> +<para>Creates a font file for use with +<command>groff -Tlj4</command> from an HP-tagged font metric file</para> +<indexterm zone="ch-system-groff hpftodit"><primary sortas="b-hpftodit">hpftodit</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="indxbib"> +<term><command>indxbib</command></term> +<listitem> +<para>Creates an inverted index for the bibliographic databases with a specified file for +use with <command>refer</command>, <command>lookbib</command>, and <command>lkbib</command></para> +<indexterm zone="ch-system-groff indxbib"><primary sortas="b-indxbib">indxbib</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="lkbib"> +<term><command>lkbib</command></term> +<listitem> +<para>Searches bibliographic databases for references that contain +specified keys and reports any references found</para> +<indexterm zone="ch-system-groff lkbib"><primary sortas="b-lkbib">lkbib</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="lookbib"> +<term><command>lookbib</command></term> +<listitem> +<para>Prints a prompt on the standard error (unless the standard input +is not a terminal), reads a line containing a +set of keywords from the standard input, 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 lookbib"><primary sortas="b-lookbib">lookbib</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="mmroff"> +<term><command>mmroff</command></term> +<listitem> +<para>A simple preprocessor for <command>groff</command></para> +<indexterm zone="ch-system-groff mmroff"><primary sortas="b-mmroff">mmroff</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="neqn"> +<term><command>neqn</command></term> +<listitem> +<para>Formats equations for American Standard Code for Information +Interchange (ASCII) output</para> +<indexterm zone="ch-system-groff neqn"><primary sortas="b-neqn">neqn</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="nroff"> +<term><command>nroff</command></term> +<listitem> +<para>A script that emulates the <command>nroff</command> command using <command>groff</command></para> +<indexterm zone="ch-system-groff nroff"><primary sortas="b-nroff">nroff</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="pfbtops"> +<term><command>pfbtops</command></term> +<listitem> +<para>Translates a PostScript font in <filename class="extension">.pfb</filename> format to ASCII</para> +<indexterm zone="ch-system-groff pfbtops"><primary sortas="b-pfbtops">pfbtops</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="pic"> +<term><command>pic</command></term> +<listitem> +<para>Compiles descriptions of pictures embedded +within troff or TeX input files into commands understood by TeX or <command>troff</command></para> +<indexterm zone="ch-system-groff pic"><primary sortas="b-pic">pic</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="pic2graph"> +<term><command>pic2graph</command></term> +<listitem> +<para>Converts a PIC diagram into a cropped image</para> +<indexterm zone="ch-system-groff pic2graph"><primary sortas="b-pic2graph">pic2graph</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="post-grohtml"> +<term><command>post-grohtml</command></term> +<listitem> +<para>Translates the output of GNU <command>troff</command> to html</para> +<indexterm zone="ch-system-groff post-grohtml"><primary sortas="b-post-grohtml">post-grohtml</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="pre-grohtml"> +<term><command>pre-grohtml </command></term> +<listitem> +<para>Translates the output of GNU <command>troff</command> to html</para> +<indexterm zone="ch-system-groff pre-grohtml"><primary sortas="b-pre-grohtml">pre-grohtml</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="refer"> +<term><command>refer</command></term> +<listitem> +<para>Copies the contents of a file to the standard output, except +that lines between <emphasis>.[</emphasis> and <emphasis>.]</emphasis> +are interpreted as citations, and lines between +<emphasis>.R1</emphasis> and <emphasis>.R2</emphasis> are interpreted +as commands for how citations are to be processed</para> +<indexterm zone="ch-system-groff refer"><primary sortas="b-refer">refer</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="soelim"> +<term><command>soelim</command></term> +<listitem> +<para>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 soelim"><primary sortas="b-soelim">soelim</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="tbl"> +<term><command>tbl</command></term> +<listitem> +<para>Compiles descriptions of tables embedded +within troff input files into commands that are understood by <command>troff</command></para> +<indexterm zone="ch-system-groff tbl"><primary sortas="b-tbl">tbl</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="tfmtodit"> +<term><command>tfmtodit</command></term> +<listitem> +<para>Creates a font file for use with <command>groff -Tdvi</command></para> +<indexterm zone="ch-system-groff tfmtodit"><primary sortas="b-tfmtodit">tfmtodit</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="troff"> +<term><command>troff</command></term> +<listitem> +<para>Is highly compatible with Unix <command>troff</command>; it +should usually 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> +<indexterm zone="ch-system-groff troff"><primary sortas="b-troff">troff</primary></indexterm> +</listitem> +</varlistentry> + +<varlistentry id="zsoelim"> +<term><command>zsoelim</command></term> +<listitem> +<para>Is the GNU implementation of <command>soelim</command></para> +<indexterm zone="ch-system-groff zsoelim"><primary sortas="b-zsoelim">zsoelim</primary></indexterm> +</listitem> +</varlistentry> +</variablelist> </sect2> </sect1> + |