source: chapter08/groff.xml@ 76ef88ee

xry111/loongarch xry111/loongarch-12.0 xry111/loongarch-12.1
Last change on this file since 76ef88ee was d9247b9, checked in by Xi Ruoyao <xry111@…>, 13 months ago

loongarch: groff: Update config.{guess,sub}

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