source: final-system/common/groff.xml@ ee3f926

Last change on this file since ee3f926 was 1e3f8a7, checked in by Jim Gifford <clfs@…>, 19 years ago

r3912@server (orig r1760): chris | 2006-06-09 23:52:26 -0700
Updated lists of installed programs for several packages

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