Added a few comments here and there
[linux_from_scratch.git] / newxml / appendixa / groff.xml
blobaf7a4a3f48e162036f79d2b2d4d32d255b0248b7
1 <?xml version="1.0" encoding="ISO-8859-1"?>
2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3CR2//EN" "http://www.docbook.org/xml/4.3CR2/docbookx.dtd" [
3   <!ENTITY % groff-entities SYSTEM "../ent/groff.ent">
4   %groff-entities;
5 ]>
6 <sect1 id="aa-groff" xreflabel="Groff">
7 <title>Groff</title>
8 <?dbhtml filename="groff.html"?>
10 <para>For installation instructions see <xref linkend="ch06-groff"/>.</para>
12 <sect2><title>Official Download Location</title>
14 <literallayout>Groff (&groff-version;): 
15 <ulink url="ftp://ftp.gnu.org/gnu/groff/"/></literallayout>
16 </sect2>
18 <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="groff-contents.xml"/>
21 <sect2><title>Short descriptions</title>
23 <para><command>addftinfo</command> reads a troff font file and adds some
24 additional font-metric information that is used by the groff system.</para>
26 <para><command>afmtodit</command> creates a font file for use with
27 groff and grops.</para>
29 <para><command>eqn</command> compiles descriptions of equations embedded
30 within troff input files into commands that are understood by troff.</para>
32 <para><command>eqn2graph</command> converts an EQN equation into a cropped
33 image.</para>
35 <para><command>grn</command> is a groff preprocessor for gremlin files.</para>
37 <para><command>grodvi</command> is a driver for groff that produces TeX dvi format.</para>
39 <para><command>groff</command> is a front-end to the groff document
40 formatting system. Normally it runs the troff program and a post-processor
41 appropriate for the selected device.</para>
43 <para><command>groffer</command> displays groff files and man pages on X
44 and tty.</para>
45 <para><command>grog</command> reads files and guesses which of the groff
46 options -e, -man, -me, -mm, -ms, -p, -s, and -t are required for printing
47 files, and reports the groff command including those options.</para>
49 <para><command>grolbp</command> is a groff driver for Canon CAPSL printers
50 (LBP-4 and LBP-8 series laser printers).</para>
52 <para><command>grolj4</command> is a driver for groff that produces output
53 in PCL5 format suitable for an HP Laserjet 4 printer.</para>
55 <para><command>grops</command> translates the output of GNU troff to
56 Postscript.</para>
58 <para><command>grotty</command> translates the output of GNU troff into
59 a form suitable for typewriter-like devices.</para>
61 <para><command>gtbl</command> is the GNU implementation of tbl.</para>
63 <para><command>hpftodit</command> creates a font file for use with
64 groff -Tlj4 from an HP-tagged font metric file.</para>
66 <para><command>indxbib</command> makes an inverted index for the
67 bibliographic databases a specified file for use with refer, lookbib,
68 and lkbib.</para>
70 <para><command>lkbib</command> searches bibliographic databases for
71 references that contain specified keys and reports any references found.</para>
73 <para><command>lookbib</command> prints a prompt on the standard error
74 (unless the standard input is not a terminal), reads from the standard input
75 a line containing a set of keywords, searches the bibliographic databases in
76 a specified file for references containing those keywords, prints any
77 references found on the standard output and repeats this process until the
78 end of input.</para>
80 <para><command>mmroff</command> is a simple preprocessor for groff.</para>
82 <para><command>neqn</command> formats equations for ascii output.</para>
84 <para><command>nroff</command> is a script that emulates the nroff command
85 using groff.</para>
87 <para><command>pfbtops</command> translates a Postscript font in .pfb
88 format to ASCII.</para>
90 <para><command>pic</command> compiles descriptions of pictures embedded
91 within troff or TeX input files into commands understood by TeX or troff.</para>
93 <para><command>pic2graph</command> converts a PIC diagram into a cropped
94 image.</para>
96 <para><command>pre-grohtml </command> translates  the output of GNU troff
97 to html.</para>
99 <para><command>post-grohtml</command> translates the output of GNU troff
100 to html.</para>
102 <para><command>refer</command> copies the contents of a file to the
103 standard output, except that lines between .[ and .] are interpreted as
104 citations, and lines between .R1 and .R2 are interpreted as commands about
105 how citations are to be processed.</para>
107 <para><command>soelim</command> reads files and replaces lines of the form
108 <emphasis>.so file</emphasis> by the contents of the mentioned
109 <emphasis>file</emphasis>.</para>
111 <para><command>tbl</command> compiles descriptions of tables embedded
112 within troff input files into commands that are understood by troff.</para>
114 <para><command>tfmtodit</command> creates a font file for use with
115 groff -Tdvi.</para>
117 <para><command>troff</command> is highly compatible with Unix troff.
118 Usually it should be invoked using the groff command, which will also run
119 preprocessors and post-processors in the appropriate order and with the
120 appropriate options.</para>
122 <para><command>zsoelim</command> is the GNU implementation of soelim.</para>
124 </sect2>
128 <xi:include xmlns:xi="http://www.w3.org/2003/XInclude" href="groff-deps.xml"/>
132 </sect1>