source: clfs-sysroot/BOOK/final-system/common/groff.xml @ 15029fa1

Last change on this file since 15029fa1 was 15029fa1, checked in by Joe Ciccone <jciccone@…>, 13 years ago

Changed the make command for groff in the final-system to the make command specified in doc/Makefile.in

  • Property mode set to 100644
File size: 17.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 TROFFBIN=troff GROFFBIN=groff GROFF_BIN_PATH=</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, gdiffmk, geqn (link to eqn),
62        grap2graph, grn, grodvi, groff, groffer, grog, grolbp, grolj4, grops,
63        grotty, gtbl (link to tbl), hpftodit, indxbib, lkbib, lookbib, mmroff,
64        neqn, nroff, pdfroff, 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="gdiffmk">
119        <term><command>gdiffmk</command></term>
120        <listitem>
121          <para>Marks differences between groff/nroff/troff files</para>
122          <indexterm zone="ch-system-groff gdiffmk">
123            <primary sortas="b-gdiffmk">gdiffmk</primary>
124          </indexterm>
125        </listitem>
126      </varlistentry>
127
128      <varlistentry id="geqn">
129        <term><command>geqn</command></term>
130        <listitem>
131          <para>A link to <command>eqn</command></para>
132          <indexterm zone="ch-system-groff geqn">
133            <primary sortas="b-geqn">geqn</primary>
134          </indexterm>
135        </listitem>
136      </varlistentry>
137
138      <varlistentry id="grap2graph">
139        <term><command>grap2graph</command></term>
140        <listitem>
141          <para>Converts a grap diagram into a cropped bitmap image</para>
142          <indexterm zone="ch-system-groff grap2graph">
143            <primary sortas="b-grap2graph">grap2graph</primary>
144          </indexterm>
145        </listitem>
146      </varlistentry>
147
148      <varlistentry id="grn">
149        <term><command>grn</command></term>
150        <listitem>
151          <para>A <command>groff</command> preprocessor for gremlin files</para>
152          <indexterm zone="ch-system-groff grn">
153            <primary sortas="b-grn">grn</primary>
154          </indexterm>
155        </listitem>
156      </varlistentry>
157
158      <varlistentry id="grodvi">
159        <term><command>grodvi</command></term>
160        <listitem>
161          <para>A driver for <command>groff</command> that produces TeX dvi
162          format</para>
163          <indexterm zone="ch-system-groff grodvi">
164            <primary sortas="b-grodvi">grodvi</primary>
165          </indexterm>
166        </listitem>
167      </varlistentry>
168
169      <varlistentry id="groff">
170        <term><command>groff</command></term>
171        <listitem>
172          <para>A front-end to the groff document formatting system; normally, it
173          runs the <command>troff</command> program and a post-processor
174          appropriate for the selected device</para>
175          <indexterm zone="ch-system-groff groff">
176            <primary sortas="b-groff">groff</primary>
177          </indexterm>
178        </listitem>
179      </varlistentry>
180
181      <varlistentry id="groffer">
182        <term><command>groffer</command></term>
183        <listitem>
184          <para>Displays groff files and man pages on X and tty terminals</para>
185          <indexterm zone="ch-system-groff groffer">
186            <primary sortas="b-groffer">groffer</primary>
187          </indexterm>
188        </listitem>
189      </varlistentry>
190
191      <varlistentry id="grog">
192        <term><command>grog</command></term>
193        <listitem>
194          <para>Reads files and guesses which of the <command>groff</command>
195          options <option>-e</option>, <option>-man</option>, <option>-me</option>,
196          <option>-mm</option>, <option>-ms</option>, <option>-p</option>,
197          <option>-s</option>, and <option>-t</option> are required for printing
198          files, and reports the <command>groff</command> command including those
199          options</para>
200          <indexterm zone="ch-system-groff grog">
201            <primary sortas="b-grog">grog</primary>
202          </indexterm>
203        </listitem>
204      </varlistentry>
205
206      <varlistentry id="grolbp">
207        <term><command>grolbp</command></term>
208        <listitem>
209          <para>Is a <command>groff</command> driver for Canon CAPSL printers
210          (LBP-4 and LBP-8 series laser printers)</para>
211          <indexterm zone="ch-system-groff grolbp">
212            <primary sortas="b-grolbp">grolbp</primary>
213          </indexterm>
214        </listitem>
215      </varlistentry>
216
217      <varlistentry id="grolj4">
218        <term><command>grolj4</command></term>
219        <listitem>
220          <para>Is a driver for <command>groff</command> that produces output
221          in PCL5 format suitable for an HP LaserJet 4 printer</para>
222          <indexterm zone="ch-system-groff grolj4">
223            <primary sortas="b-grolj4">grolj4</primary>
224          </indexterm>
225        </listitem>
226      </varlistentry>
227
228      <varlistentry id="grops">
229        <term><command>grops</command></term>
230        <listitem>
231          <para>Translates the output of GNU <command>troff</command> to
232          PostScript</para>
233          <indexterm zone="ch-system-groff grops">
234            <primary sortas="b-grops">grops</primary>
235          </indexterm>
236        </listitem>
237      </varlistentry>
238
239      <varlistentry id="grotty">
240        <term><command>grotty</command></term>
241        <listitem>
242          <para>Translates the output of GNU <command>troff</command> into
243          a form suitable for typewriter-like devices</para>
244          <indexterm zone="ch-system-groff grotty">
245            <primary sortas="b-grotty">grotty</primary>
246          </indexterm>
247        </listitem>
248      </varlistentry>
249
250      <varlistentry id="gtbl">
251        <term><command>gtbl</command></term>
252        <listitem>
253          <para>A link to <command>tbl</command></para>
254          <indexterm zone="ch-system-groff gtbl">
255            <primary sortas="b-gtbl">gtbl</primary>
256          </indexterm>
257        </listitem>
258      </varlistentry>
259
260      <varlistentry id="hpftodit">
261        <term><command>hpftodit</command></term>
262        <listitem>
263          <para>Creates a font file for use with <command>groff -Tlj4</command>
264          from an HP-tagged font metric file</para>
265          <indexterm zone="ch-system-groff hpftodit">
266            <primary sortas="b-hpftodit">hpftodit</primary>
267          </indexterm>
268        </listitem>
269      </varlistentry>
270
271      <varlistentry id="indxbib">
272        <term><command>indxbib</command></term>
273        <listitem>
274          <para>Creates an inverted index for the bibliographic databases with a
275          specified file for use with <command>refer</command>,
276          <command>lookbib</command>, and <command>lkbib</command></para>
277          <indexterm zone="ch-system-groff indxbib">
278            <primary sortas="b-indxbib">indxbib</primary>
279          </indexterm>
280        </listitem>
281      </varlistentry>
282
283      <varlistentry id="lkbib">
284        <term><command>lkbib</command></term>
285        <listitem>
286          <para>Searches bibliographic databases for references that contain
287          specified keys and reports any references found</para>
288          <indexterm zone="ch-system-groff lkbib">
289            <primary sortas="b-lkbib">lkbib</primary>
290          </indexterm>
291        </listitem>
292      </varlistentry>
293
294      <varlistentry id="lookbib">
295        <term><command>lookbib</command></term>
296        <listitem>
297          <para>Prints a prompt on the standard error (unless the standard input
298          is not a terminal), reads a line containing a set of keywords from the
299          standard input, searches the bibliographic databases in a specified file
300          for references containing those keywords, prints any references found
301          on the standard output, and repeats this process until the end of
302          input</para>
303          <indexterm zone="ch-system-groff lookbib">
304            <primary sortas="b-lookbib">lookbib</primary>
305          </indexterm>
306        </listitem>
307      </varlistentry>
308
309      <varlistentry id="mmroff">
310        <term><command>mmroff</command></term>
311        <listitem>
312          <para>A simple preprocessor for <command>groff</command></para>
313          <indexterm zone="ch-system-groff mmroff">
314            <primary sortas="b-mmroff">mmroff</primary>
315          </indexterm>
316        </listitem>
317      </varlistentry>
318
319      <varlistentry id="neqn">
320        <term><command>neqn</command></term>
321        <listitem>
322          <para>Formats equations for American Standard Code for Information
323          Interchange (ASCII) output</para>
324          <indexterm zone="ch-system-groff neqn">
325            <primary sortas="b-neqn">neqn</primary>
326          </indexterm>
327        </listitem>
328      </varlistentry>
329
330      <varlistentry id="nroff">
331        <term><command>nroff</command></term>
332        <listitem>
333          <para>A script that emulates the <command>nroff</command> command
334          using <command>groff</command></para>
335          <indexterm zone="ch-system-groff nroff">
336            <primary sortas="b-nroff">nroff</primary>
337          </indexterm>
338        </listitem>
339      </varlistentry>
340
341      <varlistentry id="pdfroff">
342        <term><command>pdfroff</command></term>
343        <listitem>
344          <para>Creates pdf documents using groff</para>
345          <indexterm zone="ch-system-groff pdfroff">
346            <primary sortas="b-pdfroff">pdfroff</primary>
347          </indexterm>
348        </listitem>
349      </varlistentry>
350
351      <varlistentry id="pfbtops">
352        <term><command>pfbtops</command></term>
353        <listitem>
354          <para>Translates a PostScript font in <filename
355          class="extension">.pfb</filename> format to ASCII</para>
356          <indexterm zone="ch-system-groff pfbtops">
357            <primary sortas="b-pfbtops">pfbtops</primary>
358          </indexterm>
359        </listitem>
360      </varlistentry>
361
362      <varlistentry id="pic">
363        <term><command>pic</command></term>
364        <listitem>
365          <para>Compiles descriptions of pictures embedded within troff or
366          TeX input files into commands understood by TeX or
367          <command>troff</command></para>
368          <indexterm zone="ch-system-groff pic">
369            <primary sortas="b-pic">pic</primary>
370          </indexterm>
371        </listitem>
372      </varlistentry>
373
374      <varlistentry id="pic2graph">
375        <term><command>pic2graph</command></term>
376        <listitem>
377          <para>Converts a PIC diagram into a cropped image</para>
378          <indexterm zone="ch-system-groff pic2graph">
379            <primary sortas="b-pic2graph">pic2graph</primary>
380          </indexterm>
381        </listitem>
382      </varlistentry>
383
384      <varlistentry id="post-grohtml">
385        <term><command>post-grohtml</command></term>
386        <listitem>
387          <para>Translates the output of GNU <command>troff</command> to
388          HTML</para>
389          <indexterm zone="ch-system-groff post-grohtml">
390            <primary sortas="b-post-grohtml">post-grohtml</primary>
391          </indexterm>
392        </listitem>
393      </varlistentry>
394
395      <varlistentry id="pre-grohtml">
396        <term><command>pre-grohtml </command></term>
397        <listitem>
398          <para>Translates the output of GNU <command>troff</command> to
399          HTML</para>
400          <indexterm zone="ch-system-groff pre-grohtml">
401            <primary sortas="b-pre-grohtml">pre-grohtml</primary>
402          </indexterm>
403        </listitem>
404      </varlistentry>
405
406      <varlistentry id="refer">
407        <term><command>refer</command></term>
408        <listitem>
409          <para>Copies the contents of a file to the standard output, except
410          that lines between <emphasis>.[</emphasis> and <emphasis>.]</emphasis>
411          are interpreted as citations, and lines between <emphasis>.R1</emphasis>
412          and <emphasis>.R2</emphasis> are interpreted as commands for how
413          citations are to be processed</para>
414          <indexterm zone="ch-system-groff refer">
415            <primary sortas="b-refer">refer</primary>
416          </indexterm>
417        </listitem>
418      </varlistentry>
419
420      <varlistentry id="soelim">
421        <term><command>soelim</command></term>
422        <listitem>
423          <para>Reads files and replaces lines of the form <emphasis>.so
424          file</emphasis> by the contents of the mentioned
425          <emphasis>file</emphasis></para>
426          <indexterm zone="ch-system-groff soelim">
427            <primary sortas="b-soelim">soelim</primary>
428          </indexterm>
429        </listitem>
430      </varlistentry>
431
432      <varlistentry id="tbl">
433        <term><command>tbl</command></term>
434        <listitem>
435          <para>Compiles descriptions of tables embedded within troff input
436          files into commands that are understood by
437          <command>troff</command></para>
438          <indexterm zone="ch-system-groff tbl">
439            <primary sortas="b-tbl">tbl</primary>
440          </indexterm>
441        </listitem>
442      </varlistentry>
443
444      <varlistentry id="tfmtodit">
445        <term><command>tfmtodit</command></term>
446        <listitem>
447          <para>Creates a font file for use with <command>groff
448          -Tdvi</command></para>
449          <indexterm zone="ch-system-groff tfmtodit">
450            <primary sortas="b-tfmtodit">tfmtodit</primary>
451          </indexterm>
452        </listitem>
453      </varlistentry>
454
455      <varlistentry id="troff">
456        <term><command>troff</command></term>
457        <listitem>
458          <para>Is highly compatible with Unix <command>troff</command>; it
459          should usually be invoked using the <command>groff</command> command,
460          which will also run preprocessors and post-processors in the
461          appropriate order and with the appropriate options</para>
462          <indexterm zone="ch-system-groff troff">
463            <primary sortas="b-troff">troff</primary>
464          </indexterm>
465        </listitem>
466      </varlistentry>
467
468      <varlistentry id="zsoelim">
469        <term><command>zsoelim</command></term>
470        <listitem>
471          <para>A link to <command>soelim</command></para>
472          <indexterm zone="ch-system-groff zsoelim">
473            <primary sortas="b-zsoelim">zsoelim</primary>
474          </indexterm>
475        </listitem>
476      </varlistentry>
477
478    </variablelist>
479
480  </sect2>
481
482</sect1>
Note: See TracBrowser for help on using the repository browser.