source: chapter06/groff.xml@ eceecd4

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.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 eceecd4 was eceecd4, checked in by Ken Moffat <ken@…>, 13 years ago

Update to groff-1.21.

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

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