source: BOOK/final-system/common/groff.xml@ 3d00c1ed

clfs-1.2 clfs-2.1 clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since 3d00c1ed was 909e1129, checked in by Jim Gifford <clfs@…>, 16 years ago

Added --enable-multibyte to groff

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