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

clfs-3.0.0-systemd clfs-3.0.0-sysvinit systemd sysvinit
Last change on this file since 6351195 was 0ade8e4, checked in by Chris Staub <chris@…>, 11 years ago

Remove creation of obsolete symlinks

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