source: chapter06/groff.xml@ 2fa7965

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.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 2fa7965 was 2fa7965, checked in by Matthew Burgess <matthew@…>, 15 years ago

Remove the --enable-multibyte switch from Groff's configure command as it isn't required as of Groff-1.20.1.

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