source: BOOK/final-system/common/groff.xml @ 07891d2

clfs-1.2clfs-2.1clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since 07891d2 was 07891d2, checked in by Joe Ciccone <jciccone@…>, 15 years ago

Remove Unknown option from the groff installation.

  • Property mode set to 100644
File size: 20.1 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.5//EN"
3  "http://www.oasis-open.org/docbook/xml/4.5/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</userinput></screen>
36
37    <para os="d">Compile the package:</para>
38
39<screen os="e"><userinput>make</userinput></screen>
40
41    <para os="f">This package does not come with a test suite.</para>
42
43    <para os="g">Install the package:</para>
44
45<screen os="h"><userinput>make install</userinput></screen>
46
47    <para os="i">Some documentation programs, such as <command>xman</command>,
48    will not work properly without the following symlinks:</para>
49
50<screen os="j"><userinput>ln -sv soelim /usr/bin/zsoelim
51ln -sv eqn /usr/bin/geqn
52ln -sv tbl /usr/bin/gtbl</userinput></screen>
53
54  </sect2>
55
56  <sect2 id="contents-groff" role="content">
57    <title>Contents of Groff</title>
58
59    <segmentedlist>
60      <segtitle>Installed programs</segtitle>
61
62      <seglistitem>
63        <seg>addftinfo, afmtodit, chem, eqn, eqn2graph, gdiffmk,
64        geqn (link to eqn), grap2graph, grn, grodvi, groff, groffer, grog,
65        grolbp, grolj4, grops, grotty, gtbl (link to tbl), hpftodit, indxbib,
66        lkbib, lookbib, mmroff, neqn, nroff, pdfroff, pfbtops, pic, pic2graph,
67        post-grohtml, pre-grohtml, preconv, refer, roff2dvi, roff2html,
68        roff2pdf, roff2ps, roff2text, roff2x, soelim, tbl, tfmtodit, troff,
69        and zsoelim (link to soelim)</seg>
70      </seglistitem>
71    </segmentedlist>
72
73    <variablelist>
74      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
75      <?dbfo list-presentation="list"?>
76      <?dbhtml list-presentation="table"?>
77
78      <varlistentry id="addftinfo">
79        <term><command>addftinfo</command></term>
80        <listitem>
81          <para>Reads a troff font file and adds some additional font-metric
82          information that is used by the <command>groff</command> system</para>
83          <indexterm zone="ch-system-groff addftinfo">
84            <primary sortas="b-addftinfo">addftinfo</primary>
85          </indexterm>
86        </listitem>
87      </varlistentry>
88
89      <varlistentry id="afmtodit">
90        <term><command>afmtodit</command></term>
91        <listitem>
92          <para>Creates a font file for use with <command>groff</command> and
93          <command>grops</command></para>
94          <indexterm zone="ch-system-groff afmtodit">
95            <primary sortas="b-afmtodit">afmtodit</primary>
96          </indexterm>
97        </listitem>
98      </varlistentry>
99
100      <varlistentry id="chem">
101        <term><command>chem</command></term>
102        <listitem>
103          <para>Groff preprocessor for producing chemical structure diagrams</para>
104          <indexterm zone="ch-system-groff chem">
105            <primary sortas="b-chem">chem</primary>
106          </indexterm>
107        </listitem>
108      </varlistentry>
109
110      <varlistentry id="eqn">
111        <term><command>eqn</command></term>
112        <listitem>
113          <para>Compiles descriptions of equations embedded within troff
114          input files into commands that are understood by
115          <command>troff</command></para>
116          <indexterm zone="ch-system-groff eqn">
117            <primary sortas="b-eqn">eqn</primary>
118          </indexterm>
119        </listitem>
120      </varlistentry>
121
122      <varlistentry id="eqn2graph">
123        <term><command>eqn2graph</command></term>
124        <listitem>
125          <para>Converts a troff EQN (equation) into a cropped image</para>
126          <indexterm zone="ch-system-groff eqn2graph">
127            <primary sortas="b-eqn2graph">eqn2graph</primary>
128          </indexterm>
129        </listitem>
130      </varlistentry>
131
132      <varlistentry id="gdiffmk">
133        <term><command>gdiffmk</command></term>
134        <listitem>
135          <para>Marks differences between groff/nroff/troff files</para>
136          <indexterm zone="ch-system-groff gdiffmk">
137            <primary sortas="b-gdiffmk">gdiffmk</primary>
138          </indexterm>
139        </listitem>
140      </varlistentry>
141
142      <varlistentry id="geqn">
143        <term><command>geqn</command></term>
144        <listitem>
145          <para>A link to <command>eqn</command></para>
146          <indexterm zone="ch-system-groff geqn">
147            <primary sortas="b-geqn">geqn</primary>
148          </indexterm>
149        </listitem>
150      </varlistentry>
151
152      <varlistentry id="grap2graph">
153        <term><command>grap2graph</command></term>
154        <listitem>
155          <para>Converts a grap diagram into a cropped bitmap image</para>
156          <indexterm zone="ch-system-groff grap2graph">
157            <primary sortas="b-grap2graph">grap2graph</primary>
158          </indexterm>
159        </listitem>
160      </varlistentry>
161
162      <varlistentry id="grn">
163        <term><command>grn</command></term>
164        <listitem>
165          <para>A <command>groff</command> preprocessor for gremlin files</para>
166          <indexterm zone="ch-system-groff grn">
167            <primary sortas="b-grn">grn</primary>
168          </indexterm>
169        </listitem>
170      </varlistentry>
171
172      <varlistentry id="grodvi">
173        <term><command>grodvi</command></term>
174        <listitem>
175          <para>A driver for <command>groff</command> that produces TeX dvi
176          format</para>
177          <indexterm zone="ch-system-groff grodvi">
178            <primary sortas="b-grodvi">grodvi</primary>
179          </indexterm>
180        </listitem>
181      </varlistentry>
182
183      <varlistentry id="groff">
184        <term><command>groff</command></term>
185        <listitem>
186          <para>A front-end to the groff document formatting system; normally, it
187          runs the <command>troff</command> program and a post-processor
188          appropriate for the selected device</para>
189          <indexterm zone="ch-system-groff groff">
190            <primary sortas="b-groff">groff</primary>
191          </indexterm>
192        </listitem>
193      </varlistentry>
194
195      <varlistentry id="groffer">
196        <term><command>groffer</command></term>
197        <listitem>
198          <para>Displays groff files and man pages on X and tty terminals</para>
199          <indexterm zone="ch-system-groff groffer">
200            <primary sortas="b-groffer">groffer</primary>
201          </indexterm>
202        </listitem>
203      </varlistentry>
204
205      <varlistentry id="grog">
206        <term><command>grog</command></term>
207        <listitem>
208          <para>Reads files and guesses which of the <command>groff</command>
209          options <option>-e</option>, <option>-man</option>, <option>-me</option>,
210          <option>-mm</option>, <option>-ms</option>, <option>-p</option>,
211          <option>-s</option>, and <option>-t</option> are required for printing
212          files, and reports the <command>groff</command> command including those
213          options</para>
214          <indexterm zone="ch-system-groff grog">
215            <primary sortas="b-grog">grog</primary>
216          </indexterm>
217        </listitem>
218      </varlistentry>
219
220      <varlistentry id="grolbp">
221        <term><command>grolbp</command></term>
222        <listitem>
223          <para>Is a <command>groff</command> driver for Canon CAPSL printers
224          (LBP-4 and LBP-8 series laser printers)</para>
225          <indexterm zone="ch-system-groff grolbp">
226            <primary sortas="b-grolbp">grolbp</primary>
227          </indexterm>
228        </listitem>
229      </varlistentry>
230
231      <varlistentry id="grolj4">
232        <term><command>grolj4</command></term>
233        <listitem>
234          <para>Is a driver for <command>groff</command> that produces output
235          in PCL5 format suitable for an HP LaserJet 4 printer</para>
236          <indexterm zone="ch-system-groff grolj4">
237            <primary sortas="b-grolj4">grolj4</primary>
238          </indexterm>
239        </listitem>
240      </varlistentry>
241
242      <varlistentry id="grops">
243        <term><command>grops</command></term>
244        <listitem>
245          <para>Translates the output of GNU <command>troff</command> to
246          PostScript</para>
247          <indexterm zone="ch-system-groff grops">
248            <primary sortas="b-grops">grops</primary>
249          </indexterm>
250        </listitem>
251      </varlistentry>
252
253      <varlistentry id="grotty">
254        <term><command>grotty</command></term>
255        <listitem>
256          <para>Translates the output of GNU <command>troff</command> into
257          a form suitable for typewriter-like devices</para>
258          <indexterm zone="ch-system-groff grotty">
259            <primary sortas="b-grotty">grotty</primary>
260          </indexterm>
261        </listitem>
262      </varlistentry>
263
264      <varlistentry id="gtbl">
265        <term><command>gtbl</command></term>
266        <listitem>
267          <para>A link to <command>tbl</command></para>
268          <indexterm zone="ch-system-groff gtbl">
269            <primary sortas="b-gtbl">gtbl</primary>
270          </indexterm>
271        </listitem>
272      </varlistentry>
273
274      <varlistentry id="hpftodit">
275        <term><command>hpftodit</command></term>
276        <listitem>
277          <para>Creates a font file for use with <command>groff -Tlj4</command>
278          from an HP-tagged font metric file</para>
279          <indexterm zone="ch-system-groff hpftodit">
280            <primary sortas="b-hpftodit">hpftodit</primary>
281          </indexterm>
282        </listitem>
283      </varlistentry>
284
285      <varlistentry id="indxbib">
286        <term><command>indxbib</command></term>
287        <listitem>
288          <para>Creates an inverted index for the bibliographic databases with a
289          specified file for use with <command>refer</command>,
290          <command>lookbib</command>, and <command>lkbib</command></para>
291          <indexterm zone="ch-system-groff indxbib">
292            <primary sortas="b-indxbib">indxbib</primary>
293          </indexterm>
294        </listitem>
295      </varlistentry>
296
297      <varlistentry id="lkbib">
298        <term><command>lkbib</command></term>
299        <listitem>
300          <para>Searches bibliographic databases for references that contain
301          specified keys and reports any references found</para>
302          <indexterm zone="ch-system-groff lkbib">
303            <primary sortas="b-lkbib">lkbib</primary>
304          </indexterm>
305        </listitem>
306      </varlistentry>
307
308      <varlistentry id="lookbib">
309        <term><command>lookbib</command></term>
310        <listitem>
311          <para>Prints a prompt on the standard error (unless the standard input
312          is not a terminal), reads a line containing a set of keywords from the
313          standard input, searches the bibliographic databases in a specified file
314          for references containing those keywords, prints any references found
315          on the standard output, and repeats this process until the end of
316          input</para>
317          <indexterm zone="ch-system-groff lookbib">
318            <primary sortas="b-lookbib">lookbib</primary>
319          </indexterm>
320        </listitem>
321      </varlistentry>
322
323      <varlistentry id="mmroff">
324        <term><command>mmroff</command></term>
325        <listitem>
326          <para>A simple preprocessor for <command>groff</command></para>
327          <indexterm zone="ch-system-groff mmroff">
328            <primary sortas="b-mmroff">mmroff</primary>
329          </indexterm>
330        </listitem>
331      </varlistentry>
332
333      <varlistentry id="neqn">
334        <term><command>neqn</command></term>
335        <listitem>
336          <para>Formats equations for American Standard Code for Information
337          Interchange (ASCII) output</para>
338          <indexterm zone="ch-system-groff neqn">
339            <primary sortas="b-neqn">neqn</primary>
340          </indexterm>
341        </listitem>
342      </varlistentry>
343
344      <varlistentry id="nroff">
345        <term><command>nroff</command></term>
346        <listitem>
347          <para>A script that emulates the <command>nroff</command> command
348          using <command>groff</command></para>
349          <indexterm zone="ch-system-groff nroff">
350            <primary sortas="b-nroff">nroff</primary>
351          </indexterm>
352        </listitem>
353      </varlistentry>
354
355      <varlistentry id="pdfroff">
356        <term><command>pdfroff</command></term>
357        <listitem>
358          <para>Creates pdf documents using groff</para>
359          <indexterm zone="ch-system-groff pdfroff">
360            <primary sortas="b-pdfroff">pdfroff</primary>
361          </indexterm>
362        </listitem>
363      </varlistentry>
364
365      <varlistentry id="pfbtops">
366        <term><command>pfbtops</command></term>
367        <listitem>
368          <para>Translates a PostScript font in <filename
369          class="extension">.pfb</filename> format to ASCII</para>
370          <indexterm zone="ch-system-groff pfbtops">
371            <primary sortas="b-pfbtops">pfbtops</primary>
372          </indexterm>
373        </listitem>
374      </varlistentry>
375
376      <varlistentry id="pic">
377        <term><command>pic</command></term>
378        <listitem>
379          <para>Compiles descriptions of pictures embedded within troff or
380          TeX input files into commands understood by TeX or
381          <command>troff</command></para>
382          <indexterm zone="ch-system-groff pic">
383            <primary sortas="b-pic">pic</primary>
384          </indexterm>
385        </listitem>
386      </varlistentry>
387
388      <varlistentry id="pic2graph">
389        <term><command>pic2graph</command></term>
390        <listitem>
391          <para>Converts a PIC diagram into a cropped image</para>
392          <indexterm zone="ch-system-groff pic2graph">
393            <primary sortas="b-pic2graph">pic2graph</primary>
394          </indexterm>
395        </listitem>
396      </varlistentry>
397
398      <varlistentry id="post-grohtml">
399        <term><command>post-grohtml</command></term>
400        <listitem>
401          <para>Translates the output of GNU <command>troff</command> to
402          HTML</para>
403          <indexterm zone="ch-system-groff post-grohtml">
404            <primary sortas="b-post-grohtml">post-grohtml</primary>
405          </indexterm>
406        </listitem>
407      </varlistentry>
408
409      <varlistentry id="pre-grohtml">
410        <term><command>pre-grohtml</command></term>
411        <listitem>
412          <para>Translates the output of GNU <command>troff</command> to
413          HTML</para>
414          <indexterm zone="ch-system-groff pre-grohtml">
415            <primary sortas="b-pre-grohtml">pre-grohtml</primary>
416          </indexterm>
417        </listitem>
418      </varlistentry>
419
420      <varlistentry id="preconv">
421        <term><command>preconv</command></term>
422        <listitem>
423          <para>Converts encoding of input files to something GNU
424          <command>troff</command> understands</para>
425          <indexterm zone="ch-system-groff preconv">
426            <primary sortas="b-pdfroff">preconv</primary>
427          </indexterm>
428        </listitem>
429      </varlistentry>
430
431      <varlistentry id="refer">
432        <term><command>refer</command></term>
433        <listitem>
434          <para>Copies the contents of a file to the standard output, except
435          that lines between <emphasis>.[</emphasis> and <emphasis>.]</emphasis>
436          are interpreted as citations, and lines between <emphasis>.R1</emphasis>
437          and <emphasis>.R2</emphasis> are interpreted as commands for how
438          citations are to be processed</para>
439          <indexterm zone="ch-system-groff refer">
440            <primary sortas="b-refer">refer</primary>
441          </indexterm>
442        </listitem>
443      </varlistentry>
444
445      <varlistentry id="roff2dvi">
446        <term><command>roff2dvi</command></term>
447        <listitem>
448          <para>Transforms roff files into other formats</para>
449          <indexterm zone="ch-system-groff roff2dvi">
450            <primary sortas="b-roff2dvi">roff2dvi</primary>
451          </indexterm>
452        </listitem>
453      </varlistentry>
454
455      <varlistentry id="roff2html">
456        <term><command>roff2html</command></term>
457        <listitem>
458          <para>Transforms roff files into other formats</para>
459          <indexterm zone="ch-system-groff roff2html">
460            <primary sortas="b-roff2html">roff2html</primary>
461          </indexterm>
462        </listitem>
463      </varlistentry>
464
465      <varlistentry id="roff2pdf">
466        <term><command>roff2pdf</command></term>
467        <listitem>
468          <para>Transforms roff files into other formats</para>
469          <indexterm zone="ch-system-groff roff2pdf">
470            <primary sortas="b-roff2pdf">roff2pdf</primary>
471          </indexterm>
472        </listitem>
473      </varlistentry>
474
475      <varlistentry id="roff2ps">
476        <term><command>roff2ps</command></term>
477        <listitem>
478          <para>Transforms roff files into other formats</para>
479          <indexterm zone="ch-system-groff roff2ps">
480            <primary sortas="b-roff2ps">roff2ps</primary>
481          </indexterm>
482        </listitem>
483      </varlistentry>
484
485      <varlistentry id="roff2text">
486        <term><command>roff2text</command></term>
487        <listitem>
488          <para>Transforms roff files into other formats</para>
489          <indexterm zone="ch-system-groff roff2text">
490            <primary sortas="b-roff2text">roff2text</primary>
491          </indexterm>
492        </listitem>
493      </varlistentry>
494
495      <varlistentry id="roff2x">
496        <term><command>roff2x</command></term>
497        <listitem>
498          <para>Transforms roff files into other formats</para>
499          <indexterm zone="ch-system-groff roff2x">
500            <primary sortas="b-roff2x">roff2x</primary>
501          </indexterm>
502        </listitem>
503      </varlistentry>
504
505      <varlistentry id="soelim">
506        <term><command>soelim</command></term>
507        <listitem>
508          <para>Reads files and replaces lines of the form <emphasis>.so
509          file</emphasis> by the contents of the mentioned
510          <emphasis>file</emphasis></para>
511          <indexterm zone="ch-system-groff soelim">
512            <primary sortas="b-soelim">soelim</primary>
513          </indexterm>
514        </listitem>
515      </varlistentry>
516
517      <varlistentry id="tbl">
518        <term><command>tbl</command></term>
519        <listitem>
520          <para>Compiles descriptions of tables embedded within troff input
521          files into commands that are understood by
522          <command>troff</command></para>
523          <indexterm zone="ch-system-groff tbl">
524            <primary sortas="b-tbl">tbl</primary>
525          </indexterm>
526        </listitem>
527      </varlistentry>
528
529      <varlistentry id="tfmtodit">
530        <term><command>tfmtodit</command></term>
531        <listitem>
532          <para>Creates a font file for use with <command>groff
533          -Tdvi</command></para>
534          <indexterm zone="ch-system-groff tfmtodit">
535            <primary sortas="b-tfmtodit">tfmtodit</primary>
536          </indexterm>
537        </listitem>
538      </varlistentry>
539
540      <varlistentry id="troff">
541        <term><command>troff</command></term>
542        <listitem>
543          <para>Is highly compatible with Unix <command>troff</command>; it
544          should usually be invoked using the <command>groff</command> command,
545          which will also run preprocessors and post-processors in the
546          appropriate order and with the appropriate options</para>
547          <indexterm zone="ch-system-groff troff">
548            <primary sortas="b-troff">troff</primary>
549          </indexterm>
550        </listitem>
551      </varlistentry>
552
553      <varlistentry id="zsoelim">
554        <term><command>zsoelim</command></term>
555        <listitem>
556          <para>A link to <command>soelim</command></para>
557          <indexterm zone="ch-system-groff zsoelim">
558            <primary sortas="b-zsoelim">zsoelim</primary>
559          </indexterm>
560        </listitem>
561      </varlistentry>
562
563    </variablelist>
564
565  </sect2>
566
567</sect1>
Note: See TracBrowser for help on using the repository browser.