source: BOOK/final-system/common/groff.xml @ 84e402e

clfs-1.2clfs-2.1clfs-3.0.0-systemdclfs-3.0.0-sysvinitsystemdsysvinit
Last change on this file since 84e402e was e1153ea, checked in by Jim Gifford <clfs@…>, 18 years ago

r3371@server (orig r1554): chris | 2006-05-10 14:03:44 -0700
Removed dependency info from individual package instructions

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