source: BOOK/final-system/common/groff.xml

systemd
Last change on this file was 7cd7f99, checked in by Chris Staub <chris@…>, 8 years ago

Put one configure option per line

  • Property mode set to 100644
File size: 18.9 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 \
36    --prefix=/usr</userinput></screen>
37
38    <para os="d">Compile the package:</para>
39
40<screen os="e"><userinput>make</userinput></screen>
41
42    <para os="f">This package does not come with a test suite.</para>
43
44    <para os="g">Install the package:</para>
45
46<screen os="h"><userinput>make install</userinput></screen>
47
48  </sect2>
49
50  <sect2 id="contents-groff" role="content">
51    <title>Contents of Groff</title>
52
53    <segmentedlist>
54      <segtitle>Installed programs</segtitle>
55      <segtitle>Installed directories</segtitle>
56
57      <seglistitem>
58        <seg>addftinfo, afmtodit, chem, eqn, eqn2graph, gdiffmk, grap2graph,
59        grn, grodvi, groff, groffer, grog, grolbp, grolj4, grops, grotty,
60        hpftodit, indxbib, lkbib, lookbib, mmroff, neqn, nroff, pdfroff,
61        pfbtops, pic, pic2graph, post-grohtml, pre-grohtml, preconv, refer,
62        roff2dvi, roff2html, roff2pdf, roff2ps, roff2text, roff2x, soelim,
63        tbl, tfmtodit, troff</seg>
64        <seg>/usr/lib/groff, /usr/share/doc/groff-&groff-version;, /usr/share/groff</seg>
65      </seglistitem>
66    </segmentedlist>
67
68    <variablelist>
69      <bridgehead renderas="sect3">Short Descriptions</bridgehead>
70      <?dbfo list-presentation="list"?>
71      <?dbhtml list-presentation="table"?>
72
73      <varlistentry id="addftinfo">
74        <term><command>addftinfo</command></term>
75        <listitem>
76          <para>Reads a troff font file and adds some additional font-metric
77          information that is used by the <command>groff</command> system</para>
78          <indexterm zone="ch-system-groff addftinfo">
79            <primary sortas="b-addftinfo">addftinfo</primary>
80          </indexterm>
81        </listitem>
82      </varlistentry>
83
84      <varlistentry id="afmtodit">
85        <term><command>afmtodit</command></term>
86        <listitem>
87          <para>Creates a font file for use with <command>groff</command> and
88          <command>grops</command></para>
89          <indexterm zone="ch-system-groff afmtodit">
90            <primary sortas="b-afmtodit">afmtodit</primary>
91          </indexterm>
92        </listitem>
93      </varlistentry>
94
95      <varlistentry id="chem">
96        <term><command>chem</command></term>
97        <listitem>
98          <para>Groff preprocessor for producing chemical structure diagrams</para>
99          <indexterm zone="ch-system-groff chem">
100            <primary sortas="b-chem">chem</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="gdiffmk">
128        <term><command>gdiffmk</command></term>
129        <listitem>
130          <para>Marks differences between groff/nroff/troff files</para>
131          <indexterm zone="ch-system-groff gdiffmk">
132            <primary sortas="b-gdiffmk">gdiffmk</primary>
133          </indexterm>
134        </listitem>
135      </varlistentry>
136
137      <varlistentry id="grap2graph">
138        <term><command>grap2graph</command></term>
139        <listitem>
140          <para>Converts a grap diagram into a cropped bitmap image</para>
141          <indexterm zone="ch-system-groff grap2graph">
142            <primary sortas="b-grap2graph">grap2graph</primary>
143          </indexterm>
144        </listitem>
145      </varlistentry>
146
147      <varlistentry id="grn">
148        <term><command>grn</command></term>
149        <listitem>
150          <para>A <command>groff</command> preprocessor for gremlin files</para>
151          <indexterm zone="ch-system-groff grn">
152            <primary sortas="b-grn">grn</primary>
153          </indexterm>
154        </listitem>
155      </varlistentry>
156
157      <varlistentry id="grodvi">
158        <term><command>grodvi</command></term>
159        <listitem>
160          <para>A driver for <command>groff</command> that produces TeX dvi
161          format</para>
162          <indexterm zone="ch-system-groff grodvi">
163            <primary sortas="b-grodvi">grodvi</primary>
164          </indexterm>
165        </listitem>
166      </varlistentry>
167
168      <varlistentry id="groff">
169        <term><command>groff</command></term>
170        <listitem>
171          <para>A front-end to the groff document formatting system; normally, it
172          runs the <command>troff</command> program and a post-processor
173          appropriate for the selected device</para>
174          <indexterm zone="ch-system-groff groff">
175            <primary sortas="b-groff">groff</primary>
176          </indexterm>
177        </listitem>
178      </varlistentry>
179
180      <varlistentry id="groffer">
181        <term><command>groffer</command></term>
182        <listitem>
183          <para>Displays groff files and man pages on X and tty terminals</para>
184          <indexterm zone="ch-system-groff groffer">
185            <primary sortas="b-groffer">groffer</primary>
186          </indexterm>
187        </listitem>
188      </varlistentry>
189
190      <varlistentry id="grog">
191        <term><command>grog</command></term>
192        <listitem>
193          <para>Reads files and guesses which of the <command>groff</command>
194          options <option>-e</option>, <option>-man</option>, <option>-me</option>,
195          <option>-mm</option>, <option>-ms</option>, <option>-p</option>,
196          <option>-s</option>, and <option>-t</option> are required for printing
197          files, and reports the <command>groff</command> command including those
198          options</para>
199          <indexterm zone="ch-system-groff grog">
200            <primary sortas="b-grog">grog</primary>
201          </indexterm>
202        </listitem>
203      </varlistentry>
204
205      <varlistentry id="grolbp">
206        <term><command>grolbp</command></term>
207        <listitem>
208          <para>Is a <command>groff</command> driver for Canon CAPSL printers
209          (LBP-4 and LBP-8 series laser printers)</para>
210          <indexterm zone="ch-system-groff grolbp">
211            <primary sortas="b-grolbp">grolbp</primary>
212          </indexterm>
213        </listitem>
214      </varlistentry>
215
216      <varlistentry id="grolj4">
217        <term><command>grolj4</command></term>
218        <listitem>
219          <para>Is a driver for <command>groff</command> that produces output
220          in PCL5 format suitable for an HP LaserJet 4 printer</para>
221          <indexterm zone="ch-system-groff grolj4">
222            <primary sortas="b-grolj4">grolj4</primary>
223          </indexterm>
224        </listitem>
225      </varlistentry>
226
227      <varlistentry id="grops">
228        <term><command>grops</command></term>
229        <listitem>
230          <para>Translates the output of GNU <command>troff</command> to
231          PostScript</para>
232          <indexterm zone="ch-system-groff grops">
233            <primary sortas="b-grops">grops</primary>
234          </indexterm>
235        </listitem>
236      </varlistentry>
237
238      <varlistentry id="grotty">
239        <term><command>grotty</command></term>
240        <listitem>
241          <para>Translates the output of GNU <command>troff</command> into
242          a form suitable for typewriter-like devices</para>
243          <indexterm zone="ch-system-groff grotty">
244            <primary sortas="b-grotty">grotty</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="pdfroff">
331        <term><command>pdfroff</command></term>
332        <listitem>
333          <para>Creates pdf documents using groff</para>
334          <indexterm zone="ch-system-groff pdfroff">
335            <primary sortas="b-pdfroff">pdfroff</primary>
336          </indexterm>
337        </listitem>
338      </varlistentry>
339
340      <varlistentry id="pfbtops">
341        <term><command>pfbtops</command></term>
342        <listitem>
343          <para>Translates a PostScript font in <filename
344          class="extension">.pfb</filename> format to ASCII</para>
345          <indexterm zone="ch-system-groff pfbtops">
346            <primary sortas="b-pfbtops">pfbtops</primary>
347          </indexterm>
348        </listitem>
349      </varlistentry>
350
351      <varlistentry id="pic">
352        <term><command>pic</command></term>
353        <listitem>
354          <para>Compiles descriptions of pictures embedded within troff or
355          TeX input files into commands understood by TeX or
356          <command>troff</command></para>
357          <indexterm zone="ch-system-groff pic">
358            <primary sortas="b-pic">pic</primary>
359          </indexterm>
360        </listitem>
361      </varlistentry>
362
363      <varlistentry id="pic2graph">
364        <term><command>pic2graph</command></term>
365        <listitem>
366          <para>Converts a PIC diagram into a cropped image</para>
367          <indexterm zone="ch-system-groff pic2graph">
368            <primary sortas="b-pic2graph">pic2graph</primary>
369          </indexterm>
370        </listitem>
371      </varlistentry>
372
373      <varlistentry id="post-grohtml">
374        <term><command>post-grohtml</command></term>
375        <listitem>
376          <para>Translates the output of GNU <command>troff</command> to
377          HTML</para>
378          <indexterm zone="ch-system-groff post-grohtml">
379            <primary sortas="b-post-grohtml">post-grohtml</primary>
380          </indexterm>
381        </listitem>
382      </varlistentry>
383
384      <varlistentry id="pre-grohtml">
385        <term><command>pre-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 pre-grohtml">
390            <primary sortas="b-pre-grohtml">pre-grohtml</primary>
391          </indexterm>
392        </listitem>
393      </varlistentry>
394
395      <varlistentry id="preconv">
396        <term><command>preconv</command></term>
397        <listitem>
398          <para>Converts encoding of input files to something GNU
399          <command>troff</command> understands</para>
400          <indexterm zone="ch-system-groff preconv">
401            <primary sortas="b-preconv">preconv</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="roff2dvi">
421        <term><command>roff2dvi</command></term>
422        <listitem>
423          <para>Transforms roff files into other formats</para>
424          <indexterm zone="ch-system-groff roff2dvi">
425            <primary sortas="b-roff2dvi">roff2dvi</primary>
426          </indexterm>
427        </listitem>
428      </varlistentry>
429
430      <varlistentry id="roff2html">
431        <term><command>roff2html</command></term>
432        <listitem>
433          <para>Transforms roff files into other formats</para>
434          <indexterm zone="ch-system-groff roff2html">
435            <primary sortas="b-roff2html">roff2html</primary>
436          </indexterm>
437        </listitem>
438      </varlistentry>
439
440      <varlistentry id="roff2pdf">
441        <term><command>roff2pdf</command></term>
442        <listitem>
443          <para>Transforms roff files into other formats</para>
444          <indexterm zone="ch-system-groff roff2pdf">
445            <primary sortas="b-roff2pdf">roff2pdf</primary>
446          </indexterm>
447        </listitem>
448      </varlistentry>
449
450      <varlistentry id="roff2ps">
451        <term><command>roff2ps</command></term>
452        <listitem>
453          <para>Transforms roff files into other formats</para>
454          <indexterm zone="ch-system-groff roff2ps">
455            <primary sortas="b-roff2ps">roff2ps</primary>
456          </indexterm>
457        </listitem>
458      </varlistentry>
459
460      <varlistentry id="roff2text">
461        <term><command>roff2text</command></term>
462        <listitem>
463          <para>Transforms roff files into other formats</para>
464          <indexterm zone="ch-system-groff roff2text">
465            <primary sortas="b-roff2text">roff2text</primary>
466          </indexterm>
467        </listitem>
468      </varlistentry>
469
470      <varlistentry id="roff2x">
471        <term><command>roff2x</command></term>
472        <listitem>
473          <para>Transforms roff files into other formats</para>
474          <indexterm zone="ch-system-groff roff2x">
475            <primary sortas="b-roff2x">roff2x</primary>
476          </indexterm>
477        </listitem>
478      </varlistentry>
479
480      <varlistentry id="soelim">
481        <term><command>soelim</command></term>
482        <listitem>
483          <para>Reads files and replaces lines of the form <emphasis>.so
484          file</emphasis> by the contents of the mentioned
485          <emphasis>file</emphasis></para>
486          <indexterm zone="ch-system-groff soelim">
487            <primary sortas="b-soelim">soelim</primary>
488          </indexterm>
489        </listitem>
490      </varlistentry>
491
492      <varlistentry id="tbl">
493        <term><command>tbl</command></term>
494        <listitem>
495          <para>Compiles descriptions of tables embedded within troff input
496          files into commands that are understood by
497          <command>troff</command></para>
498          <indexterm zone="ch-system-groff tbl">
499            <primary sortas="b-tbl">tbl</primary>
500          </indexterm>
501        </listitem>
502      </varlistentry>
503
504      <varlistentry id="tfmtodit">
505        <term><command>tfmtodit</command></term>
506        <listitem>
507          <para>Creates a font file for use with <command>groff
508          -Tdvi</command></para>
509          <indexterm zone="ch-system-groff tfmtodit">
510            <primary sortas="b-tfmtodit">tfmtodit</primary>
511          </indexterm>
512        </listitem>
513      </varlistentry>
514
515      <varlistentry id="troff">
516        <term><command>troff</command></term>
517        <listitem>
518          <para>Is highly compatible with Unix <command>troff</command>; it
519          should usually be invoked using the <command>groff</command> command,
520          which will also run preprocessors and post-processors in the
521          appropriate order and with the appropriate options</para>
522          <indexterm zone="ch-system-groff troff">
523            <primary sortas="b-troff">troff</primary>
524          </indexterm>
525        </listitem>
526      </varlistentry>
527
528    </variablelist>
529
530  </sect2>
531
532</sect1>
Note: See TracBrowser for help on using the repository browser.