source: clfs-sysroot/BOOK/final-system/common/groff.xml @ 59fb197

Last change on this file since 59fb197 was ddf299b, checked in by Jim Gifford <clfs@…>, 18 years ago

r3730@server (orig r1689): jciccone | 2006-05-29 17:33:52 -0700
Fixed the install commands for mktemp, patch, and groff.

  • Property mode set to 100644
File size: 16.2 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
4  <!ENTITY % general-entities SYSTEM "../../general.ent">
5  %general-entities;
6]>
7
8<sect1 id="ch-system-groff" role="wrap">
9  <?dbhtml filename="groff.html"?>
10
11  <title>Groff-&groff-version;</title>
12
13  <indexterm zone="ch-system-groff">
14    <primary sortas="a-Groff">Groff</primary>
15  </indexterm>
16
17  <sect2 role="package">
18    <title/>
19
20    <para>The Groff package contains programs for processing and formatting
21    text.</para>
22
23  </sect2>
24
25  <sect2 role="installation">
26    <title>Installation of Groff</title>
27
28    <para os="a">Groff expects the environment variable <envar>PAGE</envar>
29    to contain the default paper size. For users in the United States,
30    <parameter>PAGE=letter</parameter> is appropriate. Elsewhere,
31    <parameter>PAGE=A4</parameter> may be more suitable.</para>
32
33    <para os="b">Prepare Groff for compilation:</para>
34
35<screen os="c"><userinput>PAGE=<replaceable>[paper_size]</replaceable> ./configure --prefix=/usr --host=${LFS_TARGET}</userinput></screen>
36
37    <para os="d">Compile the package:</para>
38
39<screen os="e"><userinput>make GROFFBIN=groff GROFF_BIN_PATH= GROFF_BIN_DIR=</userinput></screen>
40
41    <para os="f">Install the package:</para>
42
43<screen os="g"><userinput>make prefix=${LFS}/usr install</userinput></screen>
44
45    <para os="h">Some documentation programs, such as <command>xman</command>,
46    will not work properly without the following symlinks:</para>
47
48<screen os="i"><userinput>ln -sv soelim ${LFS}/usr/bin/zsoelim
49ln -sv eqn ${LFS}/usr/bin/geqn
50ln -sv tbl ${LFS}/usr/bin/gtbl</userinput></screen>
51
52  </sect2>
53
54  <sect2 id="contents-groff" role="content">
55    <title>Contents of Groff</title>
56
57    <segmentedlist>
58      <segtitle>Installed programs</segtitle>
59
60      <seglistitem>
61        <seg>addftinfo, afmtodit, eqn, eqn2graph, geqn (link to eqn), grn,
62        grodvi, groff, groffer, grog, grolbp, grolj4, grops, grotty, gtbl
63        (link to tbl), hpftodit, indxbib, lkbib, lookbib, mmroff, neqn,
64        nroff, pfbtops, pic, pic2graph, post-grohtml, pre-grohtml, refer,
65        soelim, tbl, tfmtodit, troff, and zsoelim (link to soelim)</seg>
66      </seglistitem>
67    </segmentedlist>
68
69    <variablelist>
70      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
71      <?dbfo list-presentation="list"?>
72      <?dbhtml list-presentation="table"?>
73
74      <varlistentry id="addftinfo">
75        <term><command>addftinfo</command></term>
76        <listitem>
77          <para>Reads a troff font file and adds some additional font-metric
78          information that is used by the <command>groff</command> system</para>
79          <indexterm zone="ch-system-groff addftinfo">
80            <primary sortas="b-addftinfo">addftinfo</primary>
81          </indexterm>
82        </listitem>
83      </varlistentry>
84
85      <varlistentry id="afmtodit">
86        <term><command>afmtodit</command></term>
87        <listitem>
88          <para>Creates a font file for use with <command>groff</command> and
89          <command>grops</command></para>
90          <indexterm zone="ch-system-groff afmtodit">
91            <primary sortas="b-afmtodit">afmtodit</primary>
92          </indexterm>
93        </listitem>
94      </varlistentry>
95
96      <varlistentry id="eqn">
97        <term><command>eqn</command></term>
98        <listitem>
99          <para>Compiles descriptions of equations embedded within troff
100          input files into commands that are understood by
101          <command>troff</command></para>
102          <indexterm zone="ch-system-groff eqn">
103            <primary sortas="b-eqn">eqn</primary>
104          </indexterm>
105        </listitem>
106      </varlistentry>
107
108      <varlistentry id="eqn2graph">
109        <term><command>eqn2graph</command></term>
110        <listitem>
111          <para>Converts a troff EQN (equation) into a cropped image</para>
112          <indexterm zone="ch-system-groff eqn2graph">
113            <primary sortas="b-eqn2graph">eqn2graph</primary>
114          </indexterm>
115        </listitem>
116      </varlistentry>
117
118      <varlistentry id="geqn">
119        <term><command>geqn</command></term>
120        <listitem>
121          <para>A link to <command>eqn</command></para>
122          <indexterm zone="ch-system-groff geqn">
123            <primary sortas="b-geqn">geqn</primary>
124          </indexterm>
125        </listitem>
126      </varlistentry>
127
128      <varlistentry id="grn">
129        <term><command>grn</command></term>
130        <listitem>
131          <para>A <command>groff</command> preprocessor for gremlin files</para>
132          <indexterm zone="ch-system-groff grn">
133            <primary sortas="b-grn">grn</primary>
134          </indexterm>
135        </listitem>
136      </varlistentry>
137
138      <varlistentry id="grodvi">
139        <term><command>grodvi</command></term>
140        <listitem>
141          <para>A driver for <command>groff</command> that produces TeX dvi
142          format</para>
143          <indexterm zone="ch-system-groff grodvi">
144            <primary sortas="b-grodvi">grodvi</primary>
145          </indexterm>
146        </listitem>
147      </varlistentry>
148
149      <varlistentry id="groff">
150        <term><command>groff</command></term>
151        <listitem>
152          <para>A front-end to the groff document formatting system; normally, it
153          runs the <command>troff</command> program and a post-processor
154          appropriate for the selected device</para>
155          <indexterm zone="ch-system-groff groff">
156            <primary sortas="b-groff">groff</primary>
157          </indexterm>
158        </listitem>
159      </varlistentry>
160
161      <varlistentry id="groffer">
162        <term><command>groffer</command></term>
163        <listitem>
164          <para>Displays groff files and man pages on X and tty terminals</para>
165          <indexterm zone="ch-system-groff groffer">
166            <primary sortas="b-groffer">groffer</primary>
167          </indexterm>
168        </listitem>
169      </varlistentry>
170
171      <varlistentry id="grog">
172        <term><command>grog</command></term>
173        <listitem>
174          <para>Reads files and guesses which of the <command>groff</command>
175          options <option>-e</option>, <option>-man</option>, <option>-me</option>,
176          <option>-mm</option>, <option>-ms</option>, <option>-p</option>,
177          <option>-s</option>, and <option>-t</option> are required for printing
178          files, and reports the <command>groff</command> command including those
179          options</para>
180          <indexterm zone="ch-system-groff grog">
181            <primary sortas="b-grog">grog</primary>
182          </indexterm>
183        </listitem>
184      </varlistentry>
185
186      <varlistentry id="grolbp">
187        <term><command>grolbp</command></term>
188        <listitem>
189          <para>Is a <command>groff</command> driver for Canon CAPSL printers
190          (LBP-4 and LBP-8 series laser printers)</para>
191          <indexterm zone="ch-system-groff grolbp">
192            <primary sortas="b-grolbp">grolbp</primary>
193          </indexterm>
194        </listitem>
195      </varlistentry>
196
197      <varlistentry id="grolj4">
198        <term><command>grolj4</command></term>
199        <listitem>
200          <para>Is a driver for <command>groff</command> that produces output
201          in PCL5 format suitable for an HP LaserJet 4 printer</para>
202          <indexterm zone="ch-system-groff grolj4">
203            <primary sortas="b-grolj4">grolj4</primary>
204          </indexterm>
205        </listitem>
206      </varlistentry>
207
208      <varlistentry id="grops">
209        <term><command>grops</command></term>
210        <listitem>
211          <para>Translates the output of GNU <command>troff</command> to
212          PostScript</para>
213          <indexterm zone="ch-system-groff grops">
214            <primary sortas="b-grops">grops</primary>
215          </indexterm>
216        </listitem>
217      </varlistentry>
218
219      <varlistentry id="grotty">
220        <term><command>grotty</command></term>
221        <listitem>
222          <para>Translates the output of GNU <command>troff</command> into
223          a form suitable for typewriter-like devices</para>
224          <indexterm zone="ch-system-groff grotty">
225            <primary sortas="b-grotty">grotty</primary>
226          </indexterm>
227        </listitem>
228      </varlistentry>
229
230      <varlistentry id="gtbl">
231        <term><command>gtbl</command></term>
232        <listitem>
233          <para>A link to <command>tbl</command></para>
234          <indexterm zone="ch-system-groff gtbl">
235            <primary sortas="b-gtbl">gtbl</primary>
236          </indexterm>
237        </listitem>
238      </varlistentry>
239
240      <varlistentry id="hpftodit">
241        <term><command>hpftodit</command></term>
242        <listitem>
243          <para>Creates a font file for use with <command>groff -Tlj4</command>
244          from an HP-tagged font metric file</para>
245          <indexterm zone="ch-system-groff hpftodit">
246            <primary sortas="b-hpftodit">hpftodit</primary>
247          </indexterm>
248        </listitem>
249      </varlistentry>
250
251      <varlistentry id="indxbib">
252        <term><command>indxbib</command></term>
253        <listitem>
254          <para>Creates an inverted index for the bibliographic databases with a
255          specified file for use with <command>refer</command>,
256          <command>lookbib</command>, and <command>lkbib</command></para>
257          <indexterm zone="ch-system-groff indxbib">
258            <primary sortas="b-indxbib">indxbib</primary>
259          </indexterm>
260        </listitem>
261      </varlistentry>
262
263      <varlistentry id="lkbib">
264        <term><command>lkbib</command></term>
265        <listitem>
266          <para>Searches bibliographic databases for references that contain
267          specified keys and reports any references found</para>
268          <indexterm zone="ch-system-groff lkbib">
269            <primary sortas="b-lkbib">lkbib</primary>
270          </indexterm>
271        </listitem>
272      </varlistentry>
273
274      <varlistentry id="lookbib">
275        <term><command>lookbib</command></term>
276        <listitem>
277          <para>Prints a prompt on the standard error (unless the standard input
278          is not a terminal), reads a line containing a set of keywords from the
279          standard input, searches the bibliographic databases in a specified file
280          for references containing those keywords, prints any references found
281          on the standard output, and repeats this process until the end of
282          input</para>
283          <indexterm zone="ch-system-groff lookbib">
284            <primary sortas="b-lookbib">lookbib</primary>
285          </indexterm>
286        </listitem>
287      </varlistentry>
288
289      <varlistentry id="mmroff">
290        <term><command>mmroff</command></term>
291        <listitem>
292          <para>A simple preprocessor for <command>groff</command></para>
293          <indexterm zone="ch-system-groff mmroff">
294            <primary sortas="b-mmroff">mmroff</primary>
295          </indexterm>
296        </listitem>
297      </varlistentry>
298
299      <varlistentry id="neqn">
300        <term><command>neqn</command></term>
301        <listitem>
302          <para>Formats equations for American Standard Code for Information
303          Interchange (ASCII) output</para>
304          <indexterm zone="ch-system-groff neqn">
305            <primary sortas="b-neqn">neqn</primary>
306          </indexterm>
307        </listitem>
308      </varlistentry>
309
310      <varlistentry id="nroff">
311        <term><command>nroff</command></term>
312        <listitem>
313          <para>A script that emulates the <command>nroff</command> command
314          using <command>groff</command></para>
315          <indexterm zone="ch-system-groff nroff">
316            <primary sortas="b-nroff">nroff</primary>
317          </indexterm>
318        </listitem>
319      </varlistentry>
320
321      <varlistentry id="pfbtops">
322        <term><command>pfbtops</command></term>
323        <listitem>
324          <para>Translates a PostScript font in <filename
325          class="extension">.pfb</filename> format to ASCII</para>
326          <indexterm zone="ch-system-groff pfbtops">
327            <primary sortas="b-pfbtops">pfbtops</primary>
328          </indexterm>
329        </listitem>
330      </varlistentry>
331
332      <varlistentry id="pic">
333        <term><command>pic</command></term>
334        <listitem>
335          <para>Compiles descriptions of pictures embedded within troff or
336          TeX input files into commands understood by TeX or
337          <command>troff</command></para>
338          <indexterm zone="ch-system-groff pic">
339            <primary sortas="b-pic">pic</primary>
340          </indexterm>
341        </listitem>
342      </varlistentry>
343
344      <varlistentry id="pic2graph">
345        <term><command>pic2graph</command></term>
346        <listitem>
347          <para>Converts a PIC diagram into a cropped image</para>
348          <indexterm zone="ch-system-groff pic2graph">
349            <primary sortas="b-pic2graph">pic2graph</primary>
350          </indexterm>
351        </listitem>
352      </varlistentry>
353
354      <varlistentry id="post-grohtml">
355        <term><command>post-grohtml</command></term>
356        <listitem>
357          <para>Translates the output of GNU <command>troff</command> to
358          HTML</para>
359          <indexterm zone="ch-system-groff post-grohtml">
360            <primary sortas="b-post-grohtml">post-grohtml</primary>
361          </indexterm>
362        </listitem>
363      </varlistentry>
364
365      <varlistentry id="pre-grohtml">
366        <term><command>pre-grohtml </command></term>
367        <listitem>
368          <para>Translates the output of GNU <command>troff</command> to
369          HTML</para>
370          <indexterm zone="ch-system-groff pre-grohtml">
371            <primary sortas="b-pre-grohtml">pre-grohtml</primary>
372          </indexterm>
373        </listitem>
374      </varlistentry>
375
376      <varlistentry id="refer">
377        <term><command>refer</command></term>
378        <listitem>
379          <para>Copies the contents of a file to the standard output, except
380          that lines between <emphasis>.[</emphasis> and <emphasis>.]</emphasis>
381          are interpreted as citations, and lines between <emphasis>.R1</emphasis>
382          and <emphasis>.R2</emphasis> are interpreted as commands for how
383          citations are to be processed</para>
384          <indexterm zone="ch-system-groff refer">
385            <primary sortas="b-refer">refer</primary>
386          </indexterm>
387        </listitem>
388      </varlistentry>
389
390      <varlistentry id="soelim">
391        <term><command>soelim</command></term>
392        <listitem>
393          <para>Reads files and replaces lines of the form <emphasis>.so
394          file</emphasis> by the contents of the mentioned
395          <emphasis>file</emphasis></para>
396          <indexterm zone="ch-system-groff soelim">
397            <primary sortas="b-soelim">soelim</primary>
398          </indexterm>
399        </listitem>
400      </varlistentry>
401
402      <varlistentry id="tbl">
403        <term><command>tbl</command></term>
404        <listitem>
405          <para>Compiles descriptions of tables embedded within troff input
406          files into commands that are understood by
407          <command>troff</command></para>
408          <indexterm zone="ch-system-groff tbl">
409            <primary sortas="b-tbl">tbl</primary>
410          </indexterm>
411        </listitem>
412      </varlistentry>
413
414      <varlistentry id="tfmtodit">
415        <term><command>tfmtodit</command></term>
416        <listitem>
417          <para>Creates a font file for use with <command>groff
418          -Tdvi</command></para>
419          <indexterm zone="ch-system-groff tfmtodit">
420            <primary sortas="b-tfmtodit">tfmtodit</primary>
421          </indexterm>
422        </listitem>
423      </varlistentry>
424
425      <varlistentry id="troff">
426        <term><command>troff</command></term>
427        <listitem>
428          <para>Is highly compatible with Unix <command>troff</command>; it
429          should usually be invoked using the <command>groff</command> command,
430          which will also run preprocessors and post-processors in the
431          appropriate order and with the appropriate options</para>
432          <indexterm zone="ch-system-groff troff">
433            <primary sortas="b-troff">troff</primary>
434          </indexterm>
435        </listitem>
436      </varlistentry>
437
438      <varlistentry id="zsoelim">
439        <term><command>zsoelim</command></term>
440        <listitem>
441          <para>A link to <command>soelim</command></para>
442          <indexterm zone="ch-system-groff zsoelim">
443            <primary sortas="b-zsoelim">zsoelim</primary>
444          </indexterm>
445        </listitem>
446      </varlistentry>
447
448    </variablelist>
449
450  </sect2>
451
452</sect1>
Note: See TracBrowser for help on using the repository browser.