source: clfs-sysroot/BOOK/final-system/common/groff.xml@ 29cd472

Last change on this file since 29cd472 was 12e6567, checked in by Joe Ciccone <jciccone@…>, 16 years ago

Added a sysroot wrapper.
Updated the build variables section of the book, each package uses its own.

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