source: chapter08/groff.xml@ 49f74ce

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/update-glibc
Last change on this file since 49f74ce was 49f74ce, checked in by Ken Moffat <ken@…>, 13 months ago

Typo reported by rhubarbpieguy.

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