source: BOOK/final-system/common/groff.xml @ 61ad0b7f

clfs-1.2clfs-2.1clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since 61ad0b7f was 61ad0b7f, checked in by Chris Staub <chris@…>, 14 years ago

Added installed directory info for a number of packages

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