source: chapter06/groff.xml@ 86d2775

10.0 10.0-rc1 10.1 10.1-rc1 11.0 11.0-rc1 11.0-rc2 11.0-rc3 11.1 11.1-rc1 11.2 11.2-rc1 11.3 11.3-rc1 12.0 12.0-rc1 12.1 12.1-rc1 6.3 6.4 6.5 6.6 6.7 6.8 7.0 7.1 7.2 7.3 7.4 7.5 7.5-systemd 7.6 7.6-systemd 7.7 7.7-systemd 7.8 7.8-systemd 7.9 7.9-systemd 8.0 8.1 8.2 8.3 8.4 9.0 9.1 arm bdubbs/gcc13 ml-11.0 multilib renodr/libudev-from-systemd s6-init trunk xry111/arm64 xry111/arm64-12.0 xry111/clfs-ng xry111/lfs-next xry111/loongarch xry111/loongarch-12.0 xry111/loongarch-12.1 xry111/mips64el xry111/pip3 xry111/rust-wip-20221008 xry111/update-glibc
Last change on this file since 86d2775 was 86d2775, checked in by Archaic <archaic@…>, 18 years ago

Replaced the debian-specific groff patch with an LFS-style patch.

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

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