source: BOOK/final-system/common/groff.xml@ 6950fcb

clfs-3.0.0-sysvinit sysvinit
Last change on this file since 6950fcb was 4ae91bb, checked in by William Harrington <kb0iic@…>, 11 years ago

Remove link command and description for zsoelim as man-db has that now, and remove content entry for zsoelim.

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