source: chapter06/groff.xml@ f7104b2

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 f7104b2 was f7104b2, checked in by Matthew Burgess <matthew@…>, 18 years ago

Upgrade to gcc-4.1.1

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

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