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

Last change on this file since ad74173 was 394cdeb, checked in by Joe Ciccone <jciccone@…>, 17 years ago

Keep all the link commands consistant.

  • 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 <sect2 role="installation">
26 <title>Installation of Groff</title>
27
28 <para os="a">Groff expects the environment variable <envar>PAGE</envar>
29 to contain the default paper size. For users in the United States,
30 <parameter>PAGE=letter</parameter> is appropriate. Elsewhere,
31 <parameter>PAGE=A4</parameter> may be more suitable.</para>
32
33 <para os="b">Prepare Groff for compilation:</para>
34
35<screen os="c"><userinput>PAGE=<replaceable>[paper_size]</replaceable> ./configure --build=${CLFS_HOST} --host=${CLFS_TARGET} \
36 --prefix=/usr</userinput></screen>
37
38 <para os="d">Compile the package:</para>
39
40<screen os="e"><userinput>make TROFFBIN=troff GROFFBIN=groff GROFF_BIN_PATH=</userinput></screen>
41
42 <para os="f">Install the package:</para>
43
44<screen os="g"><userinput>make prefix=${CLFS}/usr install</userinput></screen>
45
46 <para os="h">Some documentation programs, such as <command>xman</command>,
47 will not work properly without the following symlinks:</para>
48
49<screen os="i"><userinput>ln -sfv soelim ${CLFS}/usr/bin/zsoelim
50ln -sfv eqn ${CLFS}/usr/bin/geqn
51ln -sfv tbl ${CLFS}/usr/bin/gtbl</userinput></screen>
52
53 </sect2>
54
55 <sect2 id="contents-groff" role="content">
56 <title>Contents of Groff</title>
57
58 <segmentedlist>
59 <segtitle>Installed programs</segtitle>
60
61 <seglistitem>
62 <seg>addftinfo, afmtodit, eqn, eqn2graph, gdiffmk, geqn (link to eqn),
63 grap2graph, grn, grodvi, groff, groffer, grog, grolbp, grolj4, grops,
64 grotty, gtbl (link to tbl), hpftodit, indxbib, lkbib, lookbib, mmroff,
65 neqn, nroff, pdfroff, pfbtops, pic, pic2graph, post-grohtml, pre-grohtml, refer,
66 soelim, tbl, tfmtodit, troff, and zsoelim (link to soelim)</seg>
67 </seglistitem>
68 </segmentedlist>
69
70 <variablelist>
71 <bridgehead renderas="sect3">Short Descriptions</bridgehead>
72 <?dbfo list-presentation="list"?>
73 <?dbhtml list-presentation="table"?>
74
75 <varlistentry id="addftinfo">
76 <term><command>addftinfo</command></term>
77 <listitem>
78 <para>Reads a troff font file and adds some additional font-metric
79 information that is used by the <command>groff</command> system</para>
80 <indexterm zone="ch-system-groff addftinfo">
81 <primary sortas="b-addftinfo">addftinfo</primary>
82 </indexterm>
83 </listitem>
84 </varlistentry>
85
86 <varlistentry id="afmtodit">
87 <term><command>afmtodit</command></term>
88 <listitem>
89 <para>Creates a font file for use with <command>groff</command> and
90 <command>grops</command></para>
91 <indexterm zone="ch-system-groff afmtodit">
92 <primary sortas="b-afmtodit">afmtodit</primary>
93 </indexterm>
94 </listitem>
95 </varlistentry>
96
97 <varlistentry id="eqn">
98 <term><command>eqn</command></term>
99 <listitem>
100 <para>Compiles descriptions of equations embedded within troff
101 input files into commands that are understood by
102 <command>troff</command></para>
103 <indexterm zone="ch-system-groff eqn">
104 <primary sortas="b-eqn">eqn</primary>
105 </indexterm>
106 </listitem>
107 </varlistentry>
108
109 <varlistentry id="eqn2graph">
110 <term><command>eqn2graph</command></term>
111 <listitem>
112 <para>Converts a troff EQN (equation) into a cropped image</para>
113 <indexterm zone="ch-system-groff eqn2graph">
114 <primary sortas="b-eqn2graph">eqn2graph</primary>
115 </indexterm>
116 </listitem>
117 </varlistentry>
118
119 <varlistentry id="gdiffmk">
120 <term><command>gdiffmk</command></term>
121 <listitem>
122 <para>Marks differences between groff/nroff/troff files</para>
123 <indexterm zone="ch-system-groff gdiffmk">
124 <primary sortas="b-gdiffmk">gdiffmk</primary>
125 </indexterm>
126 </listitem>
127 </varlistentry>
128
129 <varlistentry id="geqn">
130 <term><command>geqn</command></term>
131 <listitem>
132 <para>A link to <command>eqn</command></para>
133 <indexterm zone="ch-system-groff geqn">
134 <primary sortas="b-geqn">geqn</primary>
135 </indexterm>
136 </listitem>
137 </varlistentry>
138
139 <varlistentry id="grap2graph">
140 <term><command>grap2graph</command></term>
141 <listitem>
142 <para>Converts a grap diagram into a cropped bitmap image</para>
143 <indexterm zone="ch-system-groff grap2graph">
144 <primary sortas="b-grap2graph">grap2graph</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="pdfroff">
343 <term><command>pdfroff</command></term>
344 <listitem>
345 <para>Creates pdf documents using groff</para>
346 <indexterm zone="ch-system-groff pdfroff">
347 <primary sortas="b-pdfroff">pdfroff</primary>
348 </indexterm>
349 </listitem>
350 </varlistentry>
351
352 <varlistentry id="pfbtops">
353 <term><command>pfbtops</command></term>
354 <listitem>
355 <para>Translates a PostScript font in <filename
356 class="extension">.pfb</filename> format to ASCII</para>
357 <indexterm zone="ch-system-groff pfbtops">
358 <primary sortas="b-pfbtops">pfbtops</primary>
359 </indexterm>
360 </listitem>
361 </varlistentry>
362
363 <varlistentry id="pic">
364 <term><command>pic</command></term>
365 <listitem>
366 <para>Compiles descriptions of pictures embedded within troff or
367 TeX input files into commands understood by TeX or
368 <command>troff</command></para>
369 <indexterm zone="ch-system-groff pic">
370 <primary sortas="b-pic">pic</primary>
371 </indexterm>
372 </listitem>
373 </varlistentry>
374
375 <varlistentry id="pic2graph">
376 <term><command>pic2graph</command></term>
377 <listitem>
378 <para>Converts a PIC diagram into a cropped image</para>
379 <indexterm zone="ch-system-groff pic2graph">
380 <primary sortas="b-pic2graph">pic2graph</primary>
381 </indexterm>
382 </listitem>
383 </varlistentry>
384
385 <varlistentry id="post-grohtml">
386 <term><command>post-grohtml</command></term>
387 <listitem>
388 <para>Translates the output of GNU <command>troff</command> to
389 HTML</para>
390 <indexterm zone="ch-system-groff post-grohtml">
391 <primary sortas="b-post-grohtml">post-grohtml</primary>
392 </indexterm>
393 </listitem>
394 </varlistentry>
395
396 <varlistentry id="pre-grohtml">
397 <term><command>pre-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 pre-grohtml">
402 <primary sortas="b-pre-grohtml">pre-grohtml</primary>
403 </indexterm>
404 </listitem>
405 </varlistentry>
406
407 <varlistentry id="refer">
408 <term><command>refer</command></term>
409 <listitem>
410 <para>Copies the contents of a file to the standard output, except
411 that lines between <emphasis>.[</emphasis> and <emphasis>.]</emphasis>
412 are interpreted as citations, and lines between <emphasis>.R1</emphasis>
413 and <emphasis>.R2</emphasis> are interpreted as commands for how
414 citations are to be processed</para>
415 <indexterm zone="ch-system-groff refer">
416 <primary sortas="b-refer">refer</primary>
417 </indexterm>
418 </listitem>
419 </varlistentry>
420
421 <varlistentry id="soelim">
422 <term><command>soelim</command></term>
423 <listitem>
424 <para>Reads files and replaces lines of the form <emphasis>.so
425 file</emphasis> by the contents of the mentioned
426 <emphasis>file</emphasis></para>
427 <indexterm zone="ch-system-groff soelim">
428 <primary sortas="b-soelim">soelim</primary>
429 </indexterm>
430 </listitem>
431 </varlistentry>
432
433 <varlistentry id="tbl">
434 <term><command>tbl</command></term>
435 <listitem>
436 <para>Compiles descriptions of tables embedded within troff input
437 files into commands that are understood by
438 <command>troff</command></para>
439 <indexterm zone="ch-system-groff tbl">
440 <primary sortas="b-tbl">tbl</primary>
441 </indexterm>
442 </listitem>
443 </varlistentry>
444
445 <varlistentry id="tfmtodit">
446 <term><command>tfmtodit</command></term>
447 <listitem>
448 <para>Creates a font file for use with <command>groff
449 -Tdvi</command></para>
450 <indexterm zone="ch-system-groff tfmtodit">
451 <primary sortas="b-tfmtodit">tfmtodit</primary>
452 </indexterm>
453 </listitem>
454 </varlistentry>
455
456 <varlistentry id="troff">
457 <term><command>troff</command></term>
458 <listitem>
459 <para>Is highly compatible with Unix <command>troff</command>; it
460 should usually be invoked using the <command>groff</command> command,
461 which will also run preprocessors and post-processors in the
462 appropriate order and with the appropriate options</para>
463 <indexterm zone="ch-system-groff troff">
464 <primary sortas="b-troff">troff</primary>
465 </indexterm>
466 </listitem>
467 </varlistentry>
468
469 <varlistentry id="zsoelim">
470 <term><command>zsoelim</command></term>
471 <listitem>
472 <para>A link to <command>soelim</command></para>
473 <indexterm zone="ch-system-groff zsoelim">
474 <primary sortas="b-zsoelim">zsoelim</primary>
475 </indexterm>
476 </listitem>
477 </varlistentry>
478
479 </variablelist>
480
481 </sect2>
482
483</sect1>
Note: See TracBrowser for help on using the repository browser.