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

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since a8a8b9e was 427015f, checked in by Chris Staub <chris@…>, 16 years ago

Update lists of installed programs

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