source: chapter08/groff.xml@ 95789f1

11.3 11.3-rc1 12.0 12.0-rc1 12.1 12.1-rc1 bdubbs/gcc13 multilib renodr/libudev-from-systemd trunk xry111/arm64 xry111/arm64-12.0 xry111/clfs-ng 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 95789f1 was 7b3f5a4, checked in by Xi Ruoyao <xry111@…>, 22 months ago

groff: remove -j1

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