source: BOOK/final-system/common/groff.xml@ 1b69e8f

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since 1b69e8f was 1ab60d4, checked in by Jim Gifford <clfs@…>, 16 years ago

Fixed issue with New Groff 1.20

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