source: chapter08/groff.xml@ 60acb09

xry111/loongarch xry111/loongarch-12.0 xry111/loongarch-12.1
Last change on this file since 60acb09 was e869bbea, checked in by Xi Ruoyao <xry111@…>, 12 months ago

Merge remote-tracking branch 'origin/trunk' into xry111/loongarch

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