source: chapter06/groff.xml@ 668f94d7

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 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 668f94d7 was 668f94d7, checked in by Matthew Burgess <matthew@…>, 11 years ago

Upgrade to Groff-1.22.1. Fixes #3266.

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

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