source: final-system/common/groff.xml@ be205bc2

Last change on this file since be205bc2 was bf8c11f, checked in by Jim Gifford <clfs@…>, 19 years ago

r627@server (orig r625): jim | 2005-10-31 12:59:34 -0800
Import of Cross-LFS Book

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