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