source: chapter06/groff.xml@ 4bd82f59

Last change on this file since 4bd82f59 was 28b40e2, checked in by Manuel Canales Esparcia <manuel@…>, 18 years ago

Finished the PDF fixes.

git-svn-id: http://svn.linuxfromscratch.org/LFS/branches/6.2/BOOK@7737 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689

  • Property mode set to 100644
File size: 16.9 KB
Line 
1<?xml version="1.0" encoding="ISO-8859-1"?>
2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN"
3 "http://www.oasis-open.org/docbook/xml/4.4/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 <title>Groff-&groff-version;</title>
12
13 <indexterm zone="ch-system-groff">
14 <primary sortas="a-Groff">Groff</primary>
15 </indexterm>
16
17 <sect2 role="package">
18 <title/>
19
20 <para>The Groff package contains programs for processing and formatting
21 text.</para>
22
23 <segmentedlist>
24 <segtitle>&buildtime;</segtitle>
25 <segtitle>&diskspace;</segtitle>
26
27 <seglistitem>
28 <seg>&groff-ch6-sbu;</seg>
29 <seg>&groff-ch6-du;</seg>
30 </seglistitem>
31 </segmentedlist>
32
33 </sect2>
34
35 <sect2 role="installation">
36 <title>Installation of Groff</title>
37
38 <para>Apply the patch that adds the <quote>ascii8</quote> and
39 <quote>nippon</quote> devices to Groff:</para>
40
41<screen><userinput>patch -Np1 -i ../&groff-debian-patch;</userinput></screen>
42
43 <note>
44 <para>These devices are used by Man-DB when formatting non-English manual
45 pages that are not in the ISO-8859-1 encoding. Currently, there is no
46 working patch for Groff-1.19.x that adds this functionality.</para>
47 <!-- Details: http://bugs.debian.org/196762 -->
48 </note>
49
50 <para>Many screen fonts don't have Unicode single quotes and dashes in them.
51 Tell Groff to use the ASCII equivalents instead:</para>
52
53<screen><userinput>sed -i -e 's/2010/002D/' -e 's/2212/002D/' \
54 -e 's/2018/0060/' -e 's/2019/0027/' font/devutf8/R.proto</userinput></screen>
55
56 <para>Groff expects the environment variable <envar>PAGE</envar> to
57 contain the default paper size. For users in the United States,
58 <parameter>PAGE=letter</parameter> is appropriate. Elsewhere,
59 <parameter>PAGE=A4</parameter> may be more suitable. While the default
60 paper size is configured during compilation, it can be overridden later
61 by echoing either <quote>A4</quote> or <quote>letter</quote> to the
62 <filename>/etc/papersize</filename> file.</para>
63
64 <para>Prepare Groff for compilation:</para>
65
66<screen><userinput>PAGE=<replaceable>&lt;paper_size&gt;</replaceable> ./configure --prefix=/usr --enable-multibyte</userinput></screen>
67
68 <para>Compile the package:</para>
69
70<screen><userinput>make</userinput></screen>
71
72 <para>This package does not come with a test suite.</para>
73
74 <para>Install the package:</para>
75
76<screen><userinput>make install</userinput></screen>
77
78 <para>Some documentation programs, such as <command>xman</command>,
79 will not work properly without the following symlinks:</para>
80
81<screen><userinput>ln -sv eqn /usr/bin/geqn
82ln -sv tbl /usr/bin/gtbl</userinput></screen>
83
84 <beginpage/>
85
86 </sect2>
87
88 <sect2 id="contents-groff" role="content">
89 <title>Contents of Groff</title>
90
91 <segmentedlist>
92 <segtitle>Installed programs</segtitle>
93
94 <seglistitem>
95 <seg>addftinfo, afmtodit, eqn, eqn2graph, geqn (link to eqn), grn,
96 grodvi, groff, groffer, grog, grolbp, grolj4, grops, grotty, gtbl
97 (link to tbl), hpftodit, indxbib, lkbib, lookbib, mmroff, neqn,
98 nroff, pfbtops, pic, pic2graph, post-grohtml, pre-grohtml, refer,
99 soelim, tbl, tfmtodit, and troff</seg>
100 </seglistitem>
101 </segmentedlist>
102
103 <variablelist>
104 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
105 <?dbfo list-presentation="list"?>
106 <?dbhtml list-presentation="table"?>
107
108 <varlistentry id="addftinfo">
109 <term><command>addftinfo</command></term>
110 <listitem>
111 <para>Reads a troff font file and adds some additional font-metric
112 information that is used by the <command>groff</command> system</para>
113 <indexterm zone="ch-system-groff addftinfo">
114 <primary sortas="b-addftinfo">addftinfo</primary>
115 </indexterm>
116 </listitem>
117 </varlistentry>
118
119 <varlistentry id="afmtodit">
120 <term><command>afmtodit</command></term>
121 <listitem>
122 <para>Creates a font file for use with <command>groff</command> and
123 <command>grops</command></para>
124 <indexterm zone="ch-system-groff afmtodit">
125 <primary sortas="b-afmtodit">afmtodit</primary>
126 </indexterm>
127 </listitem>
128 </varlistentry>
129
130 <varlistentry id="eqn">
131 <term><command>eqn</command></term>
132 <listitem>
133 <para>Compiles descriptions of equations embedded within troff
134 input files into commands that are understood by
135 <command>troff</command></para>
136 <indexterm zone="ch-system-groff eqn">
137 <primary sortas="b-eqn">eqn</primary>
138 </indexterm>
139 </listitem>
140 </varlistentry>
141
142 <varlistentry id="eqn2graph">
143 <term><command>eqn2graph</command></term>
144 <listitem>
145 <para>Converts a troff EQN (equation) into a cropped image</para>
146 <indexterm zone="ch-system-groff eqn2graph">
147 <primary sortas="b-eqn2graph">eqn2graph</primary>
148 </indexterm>
149 </listitem>
150 </varlistentry>
151
152 <varlistentry id="geqn">
153 <term><command>geqn</command></term>
154 <listitem>
155 <para>A link to <command>eqn</command></para>
156 <indexterm zone="ch-system-groff geqn">
157 <primary sortas="b-geqn">geqn</primary>
158 </indexterm>
159 </listitem>
160 </varlistentry>
161
162 <varlistentry id="grn">
163 <term><command>grn</command></term>
164 <listitem>
165 <para>A <command>groff</command> preprocessor for gremlin files</para>
166 <indexterm zone="ch-system-groff grn">
167 <primary sortas="b-grn">grn</primary>
168 </indexterm>
169 </listitem>
170 </varlistentry>
171
172 <varlistentry id="grodvi">
173 <term><command>grodvi</command></term>
174 <listitem>
175 <para>A driver for <command>groff</command> that produces TeX dvi
176 format</para>
177 <indexterm zone="ch-system-groff grodvi">
178 <primary sortas="b-grodvi">grodvi</primary>
179 </indexterm>
180 </listitem>
181 </varlistentry>
182
183 <varlistentry id="groff">
184 <term><command>groff</command></term>
185 <listitem>
186 <para>A front-end to the groff document formatting system; normally, it
187 runs the <command>troff</command> program and a post-processor
188 appropriate for the selected device</para>
189 <indexterm zone="ch-system-groff groff">
190 <primary sortas="b-groff">groff</primary>
191 </indexterm>
192 </listitem>
193 </varlistentry>
194
195 <varlistentry id="groffer">
196 <term><command>groffer</command></term>
197 <listitem>
198 <para>Displays groff files and man pages on X and tty terminals</para>
199 <indexterm zone="ch-system-groff groffer">
200 <primary sortas="b-groffer">groffer</primary>
201 </indexterm>
202 </listitem>
203 </varlistentry>
204
205 <varlistentry id="grog">
206 <term><command>grog</command></term>
207 <listitem>
208 <para>Reads files and guesses which of the <command>groff</command>
209 options <option>-e</option>, <option>-man</option>, <option>-me</option>,
210 <option>-mm</option>, <option>-ms</option>, <option>-p</option>,
211 <option>-s</option>, and <option>-t</option> are required for printing
212 files, and reports the <command>groff</command> command including those
213 options</para>
214 <indexterm zone="ch-system-groff grog">
215 <primary sortas="b-grog">grog</primary>
216 </indexterm>
217 </listitem>
218 </varlistentry>
219
220 <varlistentry id="grolbp">
221 <term><command>grolbp</command></term>
222 <listitem>
223 <para>Is a <command>groff</command> driver for Canon CAPSL printers
224 (LBP-4 and LBP-8 series laser printers)</para>
225 <indexterm zone="ch-system-groff grolbp">
226 <primary sortas="b-grolbp">grolbp</primary>
227 </indexterm>
228 </listitem>
229 </varlistentry>
230
231 <varlistentry id="grolj4">
232 <term><command>grolj4</command></term>
233 <listitem>
234 <para>Is a driver for <command>groff</command> that produces output
235 in PCL5 format suitable for an HP LaserJet 4 printer</para>
236 <indexterm zone="ch-system-groff grolj4">
237 <primary sortas="b-grolj4">grolj4</primary>
238 </indexterm>
239 </listitem>
240 </varlistentry>
241
242 <varlistentry id="grops">
243 <term><command>grops</command></term>
244 <listitem>
245 <para>Translates the output of GNU <command>troff</command> to
246 PostScript</para>
247 <indexterm zone="ch-system-groff grops">
248 <primary sortas="b-grops">grops</primary>
249 </indexterm>
250 </listitem>
251 </varlistentry>
252
253 <varlistentry id="grotty">
254 <term><command>grotty</command></term>
255 <listitem>
256 <para>Translates the output of GNU <command>troff</command> into
257 a form suitable for typewriter-like devices</para>
258 <indexterm zone="ch-system-groff grotty">
259 <primary sortas="b-grotty">grotty</primary>
260 </indexterm>
261 </listitem>
262 </varlistentry>
263
264 <varlistentry id="gtbl">
265 <term><command>gtbl</command></term>
266 <listitem>
267 <para>A link to <command>tbl</command></para>
268 <indexterm zone="ch-system-groff gtbl">
269 <primary sortas="b-gtbl">gtbl</primary>
270 </indexterm>
271 </listitem>
272 </varlistentry>
273
274 <varlistentry id="hpftodit">
275 <term><command>hpftodit</command></term>
276 <listitem>
277 <para>Creates a font file for use with <command>groff -Tlj4</command>
278 from an HP-tagged font metric file</para>
279 <indexterm zone="ch-system-groff hpftodit">
280 <primary sortas="b-hpftodit">hpftodit</primary>
281 </indexterm>
282 </listitem>
283 </varlistentry>
284
285 <varlistentry id="indxbib">
286 <term><command>indxbib</command></term>
287 <listitem>
288 <para>Creates an inverted index for the bibliographic databases with a
289 specified file for use with <command>refer</command>,
290 <command>lookbib</command>, and <command>lkbib</command></para>
291 <indexterm zone="ch-system-groff indxbib">
292 <primary sortas="b-indxbib">indxbib</primary>
293 </indexterm>
294 </listitem>
295 </varlistentry>
296
297 <varlistentry id="lkbib">
298 <term><command>lkbib</command></term>
299 <listitem>
300 <para>Searches bibliographic databases for references that contain
301 specified keys and reports any references found</para>
302 <indexterm zone="ch-system-groff lkbib">
303 <primary sortas="b-lkbib">lkbib</primary>
304 </indexterm>
305 </listitem>
306 </varlistentry>
307
308 <varlistentry id="lookbib">
309 <term><command>lookbib</command></term>
310 <listitem>
311 <para>Prints a prompt on the standard error (unless the standard input
312 is not a terminal), reads a line containing a set of keywords from the
313 standard input, searches the bibliographic databases in a specified file
314 for references containing those keywords, prints any references found
315 on the standard output, and repeats this process until the end of
316 input</para>
317 <indexterm zone="ch-system-groff lookbib">
318 <primary sortas="b-lookbib">lookbib</primary>
319 </indexterm>
320 </listitem>
321 </varlistentry>
322
323 <varlistentry id="mmroff">
324 <term><command>mmroff</command></term>
325 <listitem>
326 <para>A simple preprocessor for <command>groff</command></para>
327 <indexterm zone="ch-system-groff mmroff">
328 <primary sortas="b-mmroff">mmroff</primary>
329 </indexterm>
330 </listitem>
331 </varlistentry>
332
333 <varlistentry id="neqn">
334 <term><command>neqn</command></term>
335 <listitem>
336 <para>Formats equations for American Standard Code for Information
337 Interchange (ASCII) output</para>
338 <indexterm zone="ch-system-groff neqn">
339 <primary sortas="b-neqn">neqn</primary>
340 </indexterm>
341 </listitem>
342 </varlistentry>
343
344 <varlistentry id="nroff">
345 <term><command>nroff</command></term>
346 <listitem>
347 <para>A script that emulates the <command>nroff</command> command
348 using <command>groff</command></para>
349 <indexterm zone="ch-system-groff nroff">
350 <primary sortas="b-nroff">nroff</primary>
351 </indexterm>
352 </listitem>
353 </varlistentry>
354
355 <varlistentry id="pfbtops">
356 <term><command>pfbtops</command></term>
357 <listitem>
358 <para>Translates a PostScript font in <filename
359 class="extension">.pfb</filename> format to ASCII</para>
360 <indexterm zone="ch-system-groff pfbtops">
361 <primary sortas="b-pfbtops">pfbtops</primary>
362 </indexterm>
363 </listitem>
364 </varlistentry>
365
366 <varlistentry id="pic">
367 <term><command>pic</command></term>
368 <listitem>
369 <para>Compiles descriptions of pictures embedded within troff or
370 TeX input files into commands understood by TeX or
371 <command>troff</command></para>
372 <indexterm zone="ch-system-groff pic">
373 <primary sortas="b-pic">pic</primary>
374 </indexterm>
375 </listitem>
376 </varlistentry>
377
378 <varlistentry id="pic2graph">
379 <term><command>pic2graph</command></term>
380 <listitem>
381 <para>Converts a PIC diagram into a cropped image</para>
382 <indexterm zone="ch-system-groff pic2graph">
383 <primary sortas="b-pic2graph">pic2graph</primary>
384 </indexterm>
385 </listitem>
386 </varlistentry>
387
388 <varlistentry id="post-grohtml">
389 <term><command>post-grohtml</command></term>
390 <listitem>
391 <para>Translates the output of GNU <command>troff</command> to
392 HTML</para>
393 <indexterm zone="ch-system-groff post-grohtml">
394 <primary sortas="b-post-grohtml">post-grohtml</primary>
395 </indexterm>
396 </listitem>
397 </varlistentry>
398
399 <varlistentry id="pre-grohtml">
400 <term><command>pre-grohtml </command></term>
401 <listitem>
402 <para>Translates the output of GNU <command>troff</command> to
403 HTML</para>
404 <indexterm zone="ch-system-groff pre-grohtml">
405 <primary sortas="b-pre-grohtml">pre-grohtml</primary>
406 </indexterm>
407 </listitem>
408 </varlistentry>
409
410 <varlistentry id="refer">
411 <term><command>refer</command></term>
412 <listitem>
413 <para>Copies the contents of a file to the standard output, except
414 that lines between <emphasis>.[</emphasis> and <emphasis>.]</emphasis>
415 are interpreted as citations, and lines between <emphasis>.R1</emphasis>
416 and <emphasis>.R2</emphasis> are interpreted as commands for how
417 citations are to be processed</para>
418 <indexterm zone="ch-system-groff refer">
419 <primary sortas="b-refer">refer</primary>
420 </indexterm>
421 </listitem>
422 </varlistentry>
423
424 <varlistentry id="soelim">
425 <term><command>soelim</command></term>
426 <listitem>
427 <para>Reads files and replaces lines of the form <emphasis>.so
428 file</emphasis> by the contents of the mentioned
429 <emphasis>file</emphasis></para>
430 <indexterm zone="ch-system-groff soelim">
431 <primary sortas="b-soelim">soelim</primary>
432 </indexterm>
433 </listitem>
434 </varlistentry>
435
436 <varlistentry id="tbl">
437 <term><command>tbl</command></term>
438 <listitem>
439 <para>Compiles descriptions of tables embedded within troff input
440 files into commands that are understood by
441 <command>troff</command></para>
442 <indexterm zone="ch-system-groff tbl">
443 <primary sortas="b-tbl">tbl</primary>
444 </indexterm>
445 </listitem>
446 </varlistentry>
447
448 <varlistentry id="tfmtodit">
449 <term><command>tfmtodit</command></term>
450 <listitem>
451 <para>Creates a font file for use with <command>groff
452 -Tdvi</command></para>
453 <indexterm zone="ch-system-groff tfmtodit">
454 <primary sortas="b-tfmtodit">tfmtodit</primary>
455 </indexterm>
456 </listitem>
457 </varlistentry>
458
459 <varlistentry id="troff">
460 <term><command>troff</command></term>
461 <listitem>
462 <para>Is highly compatible with Unix <command>troff</command>; it
463 should usually be invoked using the <command>groff</command> command,
464 which will also run preprocessors and post-processors in the
465 appropriate order and with the appropriate options</para>
466 <indexterm zone="ch-system-groff troff">
467 <primary sortas="b-troff">troff</primary>
468 </indexterm>
469 </listitem>
470 </varlistentry>
471
472 </variablelist>
473
474 </sect2>
475
476</sect1>
Note: See TracBrowser for help on using the repository browser.