source: chapter08/groff.xml

trunk
Last change on this file was 7152faa, checked in by Pierre Labastie <pierre.labastie@…>, 3 months ago

Change all xml files to utf-8 encoding

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