source: chapter06/groff.xml@ 0445a3d

10.0 10.0-rc1 10.1 10.1-rc1 11.0 11.0-rc1 11.0-rc2 11.0-rc3 11.1 11.1-rc1 11.2 11.2-rc1 11.3 11.3-rc1 12.0 12.0-rc1 12.1 12.1-rc1 6.4 6.5 6.6 6.7 6.8 7.0 7.1 7.2 7.3 7.4 7.5 7.5-systemd 7.6 7.6-systemd 7.7 7.7-systemd 7.8 7.8-systemd 7.9 7.9-systemd 8.0 8.1 8.2 8.3 8.4 9.0 9.1 arm bdubbs/gcc13 ml-11.0 multilib renodr/libudev-from-systemd s6-init trunk xry111/arm64 xry111/arm64-12.0 xry111/clfs-ng xry111/lfs-next xry111/loongarch xry111/loongarch-12.0 xry111/loongarch-12.1 xry111/mips64el xry111/pip3 xry111/rust-wip-20221008 xry111/update-glibc
Last change on this file since 0445a3d was 0445a3d, checked in by Manuel Canales Esparcia <manuel@…>, 17 years ago

Added remap attributes to userinput tags in packages pages.

git-svn-id: http://svn.linuxfromscratch.org/LFS/trunk/BOOK@8389 4aa44e1e-78dd-0310-a6d2-fbcd4c07a689

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