source: chapter06/groff.xml@ d659bf4

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.5 7.6 7.7 7.8 7.9 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 d659bf4 was d659bf4, checked in by Bruce Dubbs <bdubbs@…>, 10 years ago

Minor editorial changes

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

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