1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.3//EN" "http://www.oasis-open.org/docbook/xml/4.3/docbookx.dtd" [
|
---|
3 | <!ENTITY % general-entities SYSTEM "../general.ent">
|
---|
4 | %general-entities;
|
---|
5 | ]>
|
---|
6 | <sect1 id="ch-system-groff" xreflabel="Groff">
|
---|
7 | <title>Groff-&groff-version;</title>
|
---|
8 | <?dbhtml filename="groff.html"?>
|
---|
9 |
|
---|
10 | <indexterm zone="ch-system-groff"><primary sortas="a-Groff">Groff</primary></indexterm>
|
---|
11 |
|
---|
12 | <para>The Groff package contains programs for processing and formatting text.</para>
|
---|
13 |
|
---|
14 | <screen>&buildtime; 0.5 SBU
|
---|
15 | &diskspace; 43 MB</screen>
|
---|
16 |
|
---|
17 | <para>Groff installation depends on: Bash, Binutils, Coreutils, Diffutils,
|
---|
18 | Gawk, GCC, Glibc, Grep, Make, Sed.</para>
|
---|
19 |
|
---|
20 |
|
---|
21 |
|
---|
22 | <sect2>
|
---|
23 | <title>Installation of Groff</title>
|
---|
24 |
|
---|
25 | <para>Groff expects the environment variable PAGE to contain the default paper
|
---|
26 | size. For those in the United States, the command below is appropriate. If you
|
---|
27 | live elsewhere, you may want to change <emphasis>PAGE=letter</emphasis> to
|
---|
28 | <emphasis>PAGE=A4</emphasis>.</para>
|
---|
29 |
|
---|
30 | <para>Prepare Groff for compilation:</para>
|
---|
31 |
|
---|
32 | <screen><userinput>PAGE=letter ./configure --prefix=/usr</userinput></screen>
|
---|
33 |
|
---|
34 | <para>Compile the package:</para>
|
---|
35 |
|
---|
36 | <screen><userinput>make</userinput></screen>
|
---|
37 |
|
---|
38 | <para>Now install it:</para>
|
---|
39 |
|
---|
40 | <screen><userinput>make install</userinput></screen>
|
---|
41 |
|
---|
42 | <para>Some documentation programs, such as <command>xman</command>,
|
---|
43 | will not work properly without the following symlinks:</para>
|
---|
44 |
|
---|
45 | <screen><userinput>ln -s soelim /usr/bin/zsoelim
|
---|
46 | ln -s eqn /usr/bin/geqn
|
---|
47 | ln -s tbl /usr/bin/gtbl</userinput></screen>
|
---|
48 |
|
---|
49 | </sect2>
|
---|
50 |
|
---|
51 |
|
---|
52 | <sect2 id="contents-groff"><title>Contents of Groff</title>
|
---|
53 |
|
---|
54 | <para><emphasis>Installed programs</emphasis>: addftinfo, afmtodit, eqn,
|
---|
55 | eqn2graph, geqn (link to eqn), grn, grodvi, groff, groffer, grog, grolbp,
|
---|
56 | grolj4, grops, grotty, gtbl (link to tbl), hpftodit, indxbib, lkbib,
|
---|
57 | lookbib, mmroff, neqn, nroff, pfbtops, pic, pic2graph, post-grohtml,
|
---|
58 | pre-grohtml, refer, soelim, tbl, tfmtodit, troff and zsoelim (link to
|
---|
59 | soelim)</para>
|
---|
60 |
|
---|
61 | </sect2>
|
---|
62 |
|
---|
63 | <sect2><title>Short descriptions</title>
|
---|
64 |
|
---|
65 | <indexterm zone="ch-system-groff addftinfo"><primary sortas="b-addftinfo">addftinfo</primary></indexterm>
|
---|
66 | <para id="addftinfo"><command>addftinfo</command> reads a troff font file and adds some
|
---|
67 | additional font-metric information that is used by the groff system.</para>
|
---|
68 |
|
---|
69 | <indexterm zone="ch-system-groff afmtodit"><primary sortas="b-afmtodit">afmtodit</primary></indexterm>
|
---|
70 | <para id="afmtodit"><command>afmtodit</command> creates a font file for use with
|
---|
71 | groff and grops.</para>
|
---|
72 |
|
---|
73 | <indexterm zone="ch-system-groff eqn"><primary sortas="b-eqn">eqn</primary></indexterm>
|
---|
74 | <para id="eqn"><command>eqn</command> compiles descriptions of equations embedded
|
---|
75 | within troff input files into commands that are understood by troff.</para>
|
---|
76 |
|
---|
77 | <indexterm zone="ch-system-groff eqn2graph"><primary sortas="b-eqn2graph">eqn2graph</primary></indexterm>
|
---|
78 | <para id="eqn2graph"><command>eqn2graph</command> converts an EQN equation into a cropped
|
---|
79 | image.</para>
|
---|
80 |
|
---|
81 | <indexterm zone="ch-system-groff grn"><primary sortas="b-grn">grn</primary></indexterm>
|
---|
82 | <para id="grn"><command>grn</command> is a groff preprocessor for gremlin files.</para>
|
---|
83 |
|
---|
84 | <indexterm zone="ch-system-groff grodvi"><primary sortas="b-grodvi">grodvi</primary></indexterm>
|
---|
85 | <para id="grodvi"><command>grodvi</command> is a driver for groff that produces TeX dvi format.</para>
|
---|
86 |
|
---|
87 | <indexterm zone="ch-system-groff groff"><primary sortas="b-groff">groff</primary></indexterm>
|
---|
88 | <para id="groff"><command>groff</command> is a front-end to the groff document
|
---|
89 | formatting system. Normally it runs the troff program and a post-processor
|
---|
90 | appropriate for the selected device.</para>
|
---|
91 |
|
---|
92 | <indexterm zone="ch-system-groff groffer"><primary sortas="b-groffer">groffer</primary></indexterm>
|
---|
93 | <para id="groffer"><command>groffer</command> displays groff files and man pages on X
|
---|
94 | and tty terminals.</para>
|
---|
95 |
|
---|
96 | <indexterm zone="ch-system-groff grog"><primary sortas="b-grog">grog</primary></indexterm>
|
---|
97 | <para id="grog"><command>grog</command> reads files and guesses which of the groff
|
---|
98 | options -e, -man, -me, -mm, -ms, -p, -s, and -t are required for printing
|
---|
99 | files, and reports the groff command including those options.</para>
|
---|
100 |
|
---|
101 | <indexterm zone="ch-system-groff grolbp"><primary sortas="b-grolbp">grolbp</primary></indexterm>
|
---|
102 | <para id="grolbp"><command>grolbp</command> is a groff driver for Canon CAPSL printers
|
---|
103 | (LBP-4 and LBP-8 series laser printers).</para>
|
---|
104 |
|
---|
105 | <indexterm zone="ch-system-groff grolj4"><primary sortas="b-grolj4">grolj4</primary></indexterm>
|
---|
106 | <para id="grolj4"><command>grolj4</command> is a driver for groff that produces output
|
---|
107 | in PCL5 format suitable for an HP Laserjet 4 printer.</para>
|
---|
108 |
|
---|
109 | <indexterm zone="ch-system-groff grops"><primary sortas="b-grops">grops</primary></indexterm>
|
---|
110 | <para id="grops"><command>grops</command> translates the output of GNU troff to
|
---|
111 | Postscript.</para>
|
---|
112 |
|
---|
113 | <indexterm zone="ch-system-groff grotty"><primary sortas="b-grotty">grotty</primary></indexterm>
|
---|
114 | <para id="grotty"><command>grotty</command> translates the output of GNU troff into
|
---|
115 | a form suitable for typewriter-like devices.</para>
|
---|
116 |
|
---|
117 | <indexterm zone="ch-system-groff gtbl"><primary sortas="b-gtbl">gtbl</primary></indexterm>
|
---|
118 | <para id="gtbl"><command>gtbl</command> is the GNU implementation of tbl.</para>
|
---|
119 |
|
---|
120 | <indexterm zone="ch-system-groff hpftodit"><primary sortas="b-hpftodit">hpftodit</primary></indexterm>
|
---|
121 | <para id="hpftodit"><command>hpftodit</command> creates a font file for use with
|
---|
122 | groff -Tlj4 from an HP-tagged font metric file.</para>
|
---|
123 |
|
---|
124 | <indexterm zone="ch-system-groff indxbib"><primary sortas="b-indxbib">indxbib</primary></indexterm>
|
---|
125 | <para id="indxbib"><command>indxbib</command> makes an inverted index for the
|
---|
126 | bibliographic databases a specified file for use with refer, lookbib,
|
---|
127 | and lkbib.</para>
|
---|
128 |
|
---|
129 | <indexterm zone="ch-system-groff lkbib"><primary sortas="b-lkbib">lkbib</primary></indexterm>
|
---|
130 | <para id="lkbib"><command>lkbib</command> searches bibliographic databases for
|
---|
131 | references that contain specified keys and reports any references found.</para>
|
---|
132 |
|
---|
133 | <indexterm zone="ch-system-groff lookbib"><primary sortas="b-lookbib">lookbib</primary></indexterm>
|
---|
134 | <para id="lookbib"><command>lookbib</command> prints a prompt on the standard error
|
---|
135 | (unless the standard input is not a terminal), reads from the standard input
|
---|
136 | a line containing a set of keywords, searches the bibliographic databases in
|
---|
137 | a specified file for references containing those keywords, prints any
|
---|
138 | references found on the standard output and repeats this process until the
|
---|
139 | end of input.</para>
|
---|
140 |
|
---|
141 | <indexterm zone="ch-system-groff mmroff"><primary sortas="b-mmroff">mmroff</primary></indexterm>
|
---|
142 | <para id="mmroff"><command>mmroff</command> is a simple preprocessor for groff.</para>
|
---|
143 |
|
---|
144 | <indexterm zone="ch-system-groff neqn"><primary sortas="b-neqn">neqn</primary></indexterm>
|
---|
145 | <para id="neqn"><command>neqn</command> formats equations for ASCII (American Standard Code for Information Interchange) output.</para>
|
---|
146 |
|
---|
147 | <indexterm zone="ch-system-groff nroff"><primary sortas="b-nroff">nroff</primary></indexterm>
|
---|
148 | <para id="nroff"><command>nroff</command> is a script that emulates the nroff command
|
---|
149 | using groff.</para>
|
---|
150 |
|
---|
151 | <indexterm zone="ch-system-groff pfbtops"><primary sortas="b-pfbtops">pfbtops</primary></indexterm>
|
---|
152 | <para id="pfbtops"><command>pfbtops</command> translates a Postscript font in .pfb
|
---|
153 | format to ASCII.</para>
|
---|
154 |
|
---|
155 | <indexterm zone="ch-system-groff pic"><primary sortas="b-pic">pic</primary></indexterm>
|
---|
156 | <para id="pic"><command>pic</command> compiles descriptions of pictures embedded
|
---|
157 | within troff or TeX input files into commands understood by TeX or troff.</para>
|
---|
158 |
|
---|
159 | <indexterm zone="ch-system-groff pic2graph"><primary sortas="b-pic2graph">pic2graph</primary></indexterm>
|
---|
160 | <para id="pic2graph"><command>pic2graph</command> converts a PIC diagram into a cropped
|
---|
161 | image.</para>
|
---|
162 |
|
---|
163 | <indexterm zone="ch-system-groff pre-grohtml"><primary sortas="b-pre-grohtml">pre-grohtml</primary></indexterm>
|
---|
164 | <para id="pre-grohtml"><command>pre-grohtml </command> translates the output of GNU troff
|
---|
165 | to html.</para>
|
---|
166 |
|
---|
167 | <indexterm zone="ch-system-groff post-grohtml"><primary sortas="b-post-grohtml">post-grohtml</primary></indexterm>
|
---|
168 | <para id="post-grohtml"><command>post-grohtml</command> translates the output of GNU troff
|
---|
169 | to html.</para>
|
---|
170 |
|
---|
171 | <indexterm zone="ch-system-groff refer"><primary sortas="b-refer">refer</primary></indexterm>
|
---|
172 | <para id="refer"><command>refer</command> copies the contents of a file to the
|
---|
173 | standard output, except that lines between .[ and .] are interpreted as
|
---|
174 | citations, and lines between .R1 and .R2 are interpreted as commands about
|
---|
175 | how citations are to be processed.</para>
|
---|
176 |
|
---|
177 | <indexterm zone="ch-system-groff soelim"><primary sortas="b-soelim">soelim</primary></indexterm>
|
---|
178 | <para id="soelim"><command>soelim</command> reads files and replaces lines of the form
|
---|
179 | <emphasis>.so file</emphasis> by the contents of the mentioned
|
---|
180 | <emphasis>file</emphasis>.</para>
|
---|
181 |
|
---|
182 | <indexterm zone="ch-system-groff tbl"><primary sortas="b-tbl">tbl</primary></indexterm>
|
---|
183 | <para id="tbl"><command>tbl</command> compiles descriptions of tables embedded
|
---|
184 | within troff input files into commands that are understood by troff.</para>
|
---|
185 |
|
---|
186 | <indexterm zone="ch-system-groff tfmtodit"><primary sortas="b-tfmtodit">tfmtodit</primary></indexterm>
|
---|
187 | <para id="tfmtodit"><command>tfmtodit</command> creates a font file for use with
|
---|
188 | groff -Tdvi.</para>
|
---|
189 |
|
---|
190 | <indexterm zone="ch-system-groff troff"><primary sortas="b-troff">troff</primary></indexterm>
|
---|
191 | <para id="troff"><command>troff</command> is highly compatible with Unix troff.
|
---|
192 | Usually it should be invoked using the groff command, which will also run
|
---|
193 | preprocessors and post-processors in the appropriate order and with the
|
---|
194 | appropriate options.</para>
|
---|
195 |
|
---|
196 | <indexterm zone="ch-system-groff zsoelim"><primary sortas="b-zsoelim">zsoelim</primary></indexterm>
|
---|
197 | <para id="zsoelim"><command>zsoelim</command> is the GNU implementation of soelim.</para>
|
---|
198 |
|
---|
199 | </sect2>
|
---|
200 |
|
---|
201 |
|
---|
202 |
|
---|
203 | </sect1>
|
---|