source: BOOK/final-system/common/groff.xml @ 6aad380

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

r677@server (orig r675): manuel | 2005-11-10 03:13:57 -0800
Including patches.ent from general.ent

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