source: chapter06/groff.xml@ 79f9e00

10.0 10.0-rc1 10.1 10.1-rc1 11.0 11.0-rc1 11.0-rc2 11.0-rc3 11.1 11.1-rc1 11.2 11.2-rc1 11.3 11.3-rc1 12.0 12.0-rc1 12.1 12.1-rc1 6.6 6.7 6.8 7.0 7.1 7.2 7.3 7.4 7.5 7.5-systemd 7.6 7.6-systemd 7.7 7.7-systemd 7.8 7.8-systemd 7.9 7.9-systemd 8.0 8.1 8.2 8.3 8.4 9.0 9.1 arm bdubbs/gcc13 ml-11.0 multilib renodr/libudev-from-systemd s6-init trunk xry111/arm64 xry111/arm64-12.0 xry111/clfs-ng xry111/lfs-next xry111/loongarch xry111/loongarch-12.0 xry111/loongarch-12.1 xry111/mips64el xry111/pip3 xry111/rust-wip-20221008 xry111/update-glibc
Last change on this file since 79f9e00 was 79f9e00, checked in by Matthew Burgess <matthew@…>, 15 years ago

Update list of installed programs for various packages. Fixes #2494.

git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@9074 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689

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