[673b0d8] | 1 | <?xml version="1.0" encoding="ISO-8859-1"?>
|
---|
[1770019] | 2 | <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [
|
---|
[673b0d8] | 3 | <!ENTITY % general-entities SYSTEM "../general.ent">
|
---|
| 4 | %general-entities;
|
---|
| 5 | ]>
|
---|
[81fd230] | 6 | <sect1 id="ch-system-groff" role="wrap">
|
---|
[673b0d8] | 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>
|
---|
[6370fa6] | 11 |
|
---|
[a001133] | 12 | <sect2 role="package"><title/>
|
---|
[81fd230] | 13 | <para>The Groff package contains programs for processing and formatting text.</para>
|
---|
[5888299] | 14 |
|
---|
[a001133] | 15 | <segmentedlist>
|
---|
| 16 | <segtitle>&buildtime;</segtitle>
|
---|
| 17 | <segtitle>&diskspace;</segtitle>
|
---|
[fc1024a] | 18 | <seglistitem><seg>0.5 SBU</seg><seg>38.7 MB</seg></seglistitem>
|
---|
[a001133] | 19 | </segmentedlist>
|
---|
| 20 |
|
---|
[81fd230] | 21 | <segmentedlist>
|
---|
[45992ae] | 22 | <segtitle>&dependencies;</segtitle>
|
---|
[81fd230] | 23 | <seglistitem><seg>Bash, Binutils, Coreutils, Diffutils,
|
---|
| 24 | Gawk, GCC, Glibc, Grep, Make, and Sed</seg></seglistitem>
|
---|
| 25 | </segmentedlist>
|
---|
[a001133] | 26 | </sect2>
|
---|
[73aedd1d] | 27 |
|
---|
[a001133] | 28 | <sect2 role="installation">
|
---|
[73aedd1d] | 29 | <title>Installation of Groff</title>
|
---|
| 30 |
|
---|
[81fd230] | 31 | <para>Groff expects the environment variable <envar>PAGE</envar>
|
---|
| 32 | to contain the default paper size. For users in the United States,
|
---|
| 33 | <parameter>PAGE=letter</parameter> is appropriate. Elsewhere,
|
---|
| 34 | <parameter>PAGE=A4</parameter> may be more suitable.</para>
|
---|
| 35 |
|
---|
[73aedd1d] | 36 | <para>Prepare Groff for compilation:</para>
|
---|
| 37 |
|
---|
[ba7d4fd] | 38 | <screen><userinput>PAGE=<replaceable>[paper_size]</replaceable> ./configure --prefix=/usr</userinput></screen>
|
---|
[73aedd1d] | 39 |
|
---|
| 40 | <para>Compile the package:</para>
|
---|
| 41 |
|
---|
| 42 | <screen><userinput>make</userinput></screen>
|
---|
| 43 |
|
---|
[81fd230] | 44 | <para>Install the package:</para>
|
---|
[73aedd1d] | 45 |
|
---|
| 46 | <screen><userinput>make install</userinput></screen>
|
---|
| 47 |
|
---|
[81fd230] | 48 | <para>Some documentation programs, such as <command>xman</command>,
|
---|
| 49 | will not work properly without the following symlinks:</para>
|
---|
[73aedd1d] | 50 |
|
---|
| 51 | <screen><userinput>ln -s soelim /usr/bin/zsoelim
|
---|
| 52 | ln -s eqn /usr/bin/geqn
|
---|
| 53 | ln -s tbl /usr/bin/gtbl</userinput></screen>
|
---|
| 54 |
|
---|
| 55 | </sect2>
|
---|
[6370fa6] | 56 |
|
---|
[5888299] | 57 |
|
---|
[c6cb3aa] | 58 | <sect2 id="contents-groff" role="content"><title>Contents of Groff</title>
|
---|
[673b0d8] | 59 |
|
---|
[81fd230] | 60 | <segmentedlist>
|
---|
| 61 | <segtitle>Installed programs</segtitle>
|
---|
| 62 | <seglistitem><seg>addftinfo, afmtodit, eqn, eqn2graph, geqn (link to eqn), grn,
|
---|
| 63 | grodvi, groff, groffer, grog, grolbp, grolj4, grops, grotty, gtbl (link to tbl), hpftodit,
|
---|
| 64 | indxbib, lkbib, lookbib, mmroff, neqn, nroff, pfbtops, pic, pic2graph, post-grohtml,
|
---|
| 65 | pre-grohtml, refer, soelim, tbl, tfmtodit, troff, and zsoelim (link to soelim)</seg></seglistitem>
|
---|
| 66 | </segmentedlist>
|
---|
| 67 |
|
---|
| 68 | <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead>
|
---|
| 69 | <?dbfo list-presentation="list"?>
|
---|
[8f97096] | 70 | <?dbhtml list-presentation="table"?>
|
---|
[81fd230] | 71 |
|
---|
| 72 | <varlistentry id="addftinfo">
|
---|
| 73 | <term><command>addftinfo</command></term>
|
---|
| 74 | <listitem>
|
---|
| 75 | <para>Reads a troff font file and adds some
|
---|
| 76 | additional font-metric information that is used by the <command>groff</command> system</para>
|
---|
| 77 | <indexterm zone="ch-system-groff addftinfo"><primary sortas="b-addftinfo">addftinfo</primary></indexterm>
|
---|
| 78 | </listitem>
|
---|
| 79 | </varlistentry>
|
---|
| 80 |
|
---|
| 81 | <varlistentry id="afmtodit">
|
---|
| 82 | <term><command>afmtodit</command></term>
|
---|
| 83 | <listitem>
|
---|
| 84 | <para>Creates a font file for use with <command>groff</command> and <command>grops</command></para>
|
---|
| 85 | <indexterm zone="ch-system-groff afmtodit"><primary sortas="b-afmtodit">afmtodit</primary></indexterm>
|
---|
| 86 | </listitem>
|
---|
| 87 | </varlistentry>
|
---|
| 88 |
|
---|
| 89 | <varlistentry id="eqn">
|
---|
| 90 | <term><command>eqn</command></term>
|
---|
| 91 | <listitem>
|
---|
| 92 | <para>Compiles descriptions of equations embedded
|
---|
| 93 | within troff input files into commands that are understood by <command>troff</command></para>
|
---|
| 94 | <indexterm zone="ch-system-groff eqn"><primary sortas="b-eqn">eqn</primary></indexterm>
|
---|
| 95 | </listitem>
|
---|
| 96 | </varlistentry>
|
---|
| 97 |
|
---|
| 98 | <varlistentry id="eqn2graph">
|
---|
| 99 | <term><command>eqn2graph</command></term>
|
---|
| 100 | <listitem>
|
---|
| 101 | <para>Converts a troff EQN (equation) into a cropped image</para>
|
---|
| 102 | <indexterm zone="ch-system-groff eqn2graph"><primary sortas="b-eqn2graph">eqn2graph</primary></indexterm>
|
---|
| 103 | </listitem>
|
---|
| 104 | </varlistentry>
|
---|
| 105 |
|
---|
| 106 | <varlistentry id="geqn">
|
---|
[90b56f5] | 107 | <term><command>geqn</command></term>
|
---|
[81fd230] | 108 | <listitem>
|
---|
| 109 | <para>A link to <command>eqn</command></para>
|
---|
| 110 | <indexterm zone="ch-system-groff geqn"><primary sortas="b-geqn">geqn</primary></indexterm>
|
---|
| 111 | </listitem>
|
---|
| 112 | </varlistentry>
|
---|
| 113 |
|
---|
| 114 | <varlistentry id="grn">
|
---|
| 115 | <term><command>grn</command></term>
|
---|
| 116 | <listitem>
|
---|
| 117 | <para>A <command>groff</command> preprocessor for gremlin files</para>
|
---|
| 118 | <indexterm zone="ch-system-groff grn"><primary sortas="b-grn">grn</primary></indexterm>
|
---|
| 119 | </listitem>
|
---|
| 120 | </varlistentry>
|
---|
| 121 |
|
---|
| 122 | <varlistentry id="grodvi">
|
---|
| 123 | <term><command>grodvi</command></term>
|
---|
| 124 | <listitem>
|
---|
| 125 | <para>A driver for <command>groff</command> that produces TeX dvi format</para>
|
---|
| 126 | <indexterm zone="ch-system-groff grodvi"><primary sortas="b-grodvi">grodvi</primary></indexterm>
|
---|
| 127 | </listitem>
|
---|
| 128 | </varlistentry>
|
---|
| 129 |
|
---|
| 130 | <varlistentry id="groff">
|
---|
| 131 | <term><command>groff</command></term>
|
---|
| 132 | <listitem>
|
---|
| 133 | <para>A front-end to the groff document
|
---|
| 134 | formatting system; normally, it runs the <command>troff</command> program and a post-processor
|
---|
| 135 | appropriate for the selected device</para>
|
---|
| 136 | <indexterm zone="ch-system-groff groff"><primary sortas="b-groff">groff</primary></indexterm>
|
---|
| 137 | </listitem>
|
---|
| 138 | </varlistentry>
|
---|
| 139 |
|
---|
| 140 | <varlistentry id="groffer">
|
---|
| 141 | <term><command>groffer</command></term>
|
---|
| 142 | <listitem>
|
---|
| 143 | <para>Displays groff files and man pages on X and tty terminals</para>
|
---|
| 144 | <indexterm zone="ch-system-groff groffer"><primary sortas="b-groffer">groffer</primary></indexterm>
|
---|
| 145 | </listitem>
|
---|
| 146 | </varlistentry>
|
---|
| 147 |
|
---|
| 148 | <varlistentry id="grog">
|
---|
| 149 | <term><command>grog</command></term>
|
---|
| 150 | <listitem>
|
---|
| 151 | <para>Reads files and guesses which of the <command>groff</command>
|
---|
| 152 | options <parameter>-e</parameter>, <parameter>-man</parameter>,
|
---|
| 153 | <parameter>-me</parameter>, <parameter>-mm</parameter>,
|
---|
| 154 | <parameter>-ms</parameter>, <parameter>-p</parameter>, <parameter>-s</parameter>,
|
---|
| 155 | and <parameter>-t</parameter> are required for printing
|
---|
| 156 | files, and reports the <command>groff</command> command including those options</para>
|
---|
| 157 | <indexterm zone="ch-system-groff grog"><primary sortas="b-grog">grog</primary></indexterm>
|
---|
| 158 | </listitem>
|
---|
| 159 | </varlistentry>
|
---|
| 160 |
|
---|
| 161 | <varlistentry id="grolbp">
|
---|
| 162 | <term><command>grolbp</command></term>
|
---|
| 163 | <listitem>
|
---|
| 164 | <para>Is a <command>groff</command> driver for Canon CAPSL printers
|
---|
| 165 | (LBP-4 and LBP-8 series laser printers)</para>
|
---|
| 166 | <indexterm zone="ch-system-groff grolbp"><primary sortas="b-grolbp">grolbp</primary></indexterm>
|
---|
| 167 | </listitem>
|
---|
| 168 | </varlistentry>
|
---|
| 169 |
|
---|
| 170 | <varlistentry id="grolj4">
|
---|
| 171 | <term><command>grolj4</command></term>
|
---|
| 172 | <listitem>
|
---|
| 173 | <para>Is a driver for <command>groff</command> that produces output
|
---|
[373a708] | 174 | in PCL5 format suitable for an HP LaserJet 4 printer</para>
|
---|
[81fd230] | 175 | <indexterm zone="ch-system-groff grolj4"><primary sortas="b-grolj4">grolj4</primary></indexterm>
|
---|
| 176 | </listitem>
|
---|
| 177 | </varlistentry>
|
---|
| 178 |
|
---|
| 179 | <varlistentry id="grops">
|
---|
| 180 | <term><command>grops</command></term>
|
---|
| 181 | <listitem>
|
---|
| 182 | <para>Translates the output of GNU <command>troff</command> to PostScript</para>
|
---|
| 183 | <indexterm zone="ch-system-groff grops"><primary sortas="b-grops">grops</primary></indexterm>
|
---|
| 184 | </listitem>
|
---|
| 185 | </varlistentry>
|
---|
| 186 |
|
---|
| 187 | <varlistentry id="grotty">
|
---|
| 188 | <term><command>grotty</command></term>
|
---|
| 189 | <listitem>
|
---|
| 190 | <para>Translates the output of GNU <command>troff</command> into
|
---|
| 191 | a form suitable for typewriter-like devices</para>
|
---|
| 192 | <indexterm zone="ch-system-groff grotty"><primary sortas="b-grotty">grotty</primary></indexterm>
|
---|
| 193 | </listitem>
|
---|
| 194 | </varlistentry>
|
---|
| 195 |
|
---|
| 196 | <varlistentry id="gtbl">
|
---|
| 197 | <term><command>gtbl</command></term>
|
---|
| 198 | <listitem>
|
---|
[90b56f5] | 199 | <para>A link to <command>tbl</command></para>
|
---|
[81fd230] | 200 | <indexterm zone="ch-system-groff gtbl"><primary sortas="b-gtbl">gtbl</primary></indexterm>
|
---|
| 201 | </listitem>
|
---|
| 202 | </varlistentry>
|
---|
| 203 |
|
---|
| 204 | <varlistentry id="hpftodit">
|
---|
| 205 | <term><command>hpftodit</command></term>
|
---|
| 206 | <listitem>
|
---|
| 207 | <para>Creates a font file for use with
|
---|
| 208 | <command>groff -Tlj4</command> from an HP-tagged font metric file</para>
|
---|
| 209 | <indexterm zone="ch-system-groff hpftodit"><primary sortas="b-hpftodit">hpftodit</primary></indexterm>
|
---|
| 210 | </listitem>
|
---|
| 211 | </varlistentry>
|
---|
| 212 |
|
---|
| 213 | <varlistentry id="indxbib">
|
---|
| 214 | <term><command>indxbib</command></term>
|
---|
| 215 | <listitem>
|
---|
| 216 | <para>Creates an inverted index for the bibliographic databases with a specified file for
|
---|
| 217 | use with <command>refer</command>, <command>lookbib</command>, and <command>lkbib</command></para>
|
---|
| 218 | <indexterm zone="ch-system-groff indxbib"><primary sortas="b-indxbib">indxbib</primary></indexterm>
|
---|
| 219 | </listitem>
|
---|
| 220 | </varlistentry>
|
---|
| 221 |
|
---|
| 222 | <varlistentry id="lkbib">
|
---|
| 223 | <term><command>lkbib</command></term>
|
---|
| 224 | <listitem>
|
---|
| 225 | <para>Searches bibliographic databases for references that contain
|
---|
| 226 | specified keys and reports any references found</para>
|
---|
| 227 | <indexterm zone="ch-system-groff lkbib"><primary sortas="b-lkbib">lkbib</primary></indexterm>
|
---|
| 228 | </listitem>
|
---|
| 229 | </varlistentry>
|
---|
| 230 |
|
---|
| 231 | <varlistentry id="lookbib">
|
---|
| 232 | <term><command>lookbib</command></term>
|
---|
| 233 | <listitem>
|
---|
| 234 | <para>Prints a prompt on the standard error (unless the standard input
|
---|
| 235 | is not a terminal), reads a line containing a
|
---|
| 236 | set of keywords from the standard input, searches the bibliographic databases in a specified
|
---|
| 237 | file for references containing those keywords, prints any references
|
---|
| 238 | found on the standard output, and repeats this process until the end
|
---|
| 239 | of input</para>
|
---|
| 240 | <indexterm zone="ch-system-groff lookbib"><primary sortas="b-lookbib">lookbib</primary></indexterm>
|
---|
| 241 | </listitem>
|
---|
| 242 | </varlistentry>
|
---|
| 243 |
|
---|
| 244 | <varlistentry id="mmroff">
|
---|
| 245 | <term><command>mmroff</command></term>
|
---|
| 246 | <listitem>
|
---|
| 247 | <para>A simple preprocessor for <command>groff</command></para>
|
---|
| 248 | <indexterm zone="ch-system-groff mmroff"><primary sortas="b-mmroff">mmroff</primary></indexterm>
|
---|
| 249 | </listitem>
|
---|
| 250 | </varlistentry>
|
---|
| 251 |
|
---|
| 252 | <varlistentry id="neqn">
|
---|
| 253 | <term><command>neqn</command></term>
|
---|
| 254 | <listitem>
|
---|
| 255 | <para>Formats equations for American Standard Code for Information
|
---|
| 256 | Interchange (ASCII) output</para>
|
---|
| 257 | <indexterm zone="ch-system-groff neqn"><primary sortas="b-neqn">neqn</primary></indexterm>
|
---|
| 258 | </listitem>
|
---|
| 259 | </varlistentry>
|
---|
| 260 |
|
---|
| 261 | <varlistentry id="nroff">
|
---|
| 262 | <term><command>nroff</command></term>
|
---|
| 263 | <listitem>
|
---|
| 264 | <para>A script that emulates the <command>nroff</command> command using <command>groff</command></para>
|
---|
| 265 | <indexterm zone="ch-system-groff nroff"><primary sortas="b-nroff">nroff</primary></indexterm>
|
---|
| 266 | </listitem>
|
---|
| 267 | </varlistentry>
|
---|
| 268 |
|
---|
| 269 | <varlistentry id="pfbtops">
|
---|
| 270 | <term><command>pfbtops</command></term>
|
---|
| 271 | <listitem>
|
---|
| 272 | <para>Translates a PostScript font in <filename class="extension">.pfb</filename> format to ASCII</para>
|
---|
| 273 | <indexterm zone="ch-system-groff pfbtops"><primary sortas="b-pfbtops">pfbtops</primary></indexterm>
|
---|
| 274 | </listitem>
|
---|
| 275 | </varlistentry>
|
---|
| 276 |
|
---|
| 277 | <varlistentry id="pic">
|
---|
| 278 | <term><command>pic</command></term>
|
---|
| 279 | <listitem>
|
---|
| 280 | <para>Compiles descriptions of pictures embedded
|
---|
| 281 | within troff or TeX input files into commands understood by TeX or <command>troff</command></para>
|
---|
| 282 | <indexterm zone="ch-system-groff pic"><primary sortas="b-pic">pic</primary></indexterm>
|
---|
| 283 | </listitem>
|
---|
| 284 | </varlistentry>
|
---|
| 285 |
|
---|
| 286 | <varlistentry id="pic2graph">
|
---|
| 287 | <term><command>pic2graph</command></term>
|
---|
| 288 | <listitem>
|
---|
| 289 | <para>Converts a PIC diagram into a cropped image</para>
|
---|
| 290 | <indexterm zone="ch-system-groff pic2graph"><primary sortas="b-pic2graph">pic2graph</primary></indexterm>
|
---|
| 291 | </listitem>
|
---|
| 292 | </varlistentry>
|
---|
| 293 |
|
---|
| 294 | <varlistentry id="post-grohtml">
|
---|
| 295 | <term><command>post-grohtml</command></term>
|
---|
| 296 | <listitem>
|
---|
[373a708] | 297 | <para>Translates the output of GNU <command>troff</command> to HTML</para>
|
---|
[81fd230] | 298 | <indexterm zone="ch-system-groff post-grohtml"><primary sortas="b-post-grohtml">post-grohtml</primary></indexterm>
|
---|
| 299 | </listitem>
|
---|
| 300 | </varlistentry>
|
---|
| 301 |
|
---|
| 302 | <varlistentry id="pre-grohtml">
|
---|
| 303 | <term><command>pre-grohtml </command></term>
|
---|
| 304 | <listitem>
|
---|
[373a708] | 305 | <para>Translates the output of GNU <command>troff</command> to HTML</para>
|
---|
[81fd230] | 306 | <indexterm zone="ch-system-groff pre-grohtml"><primary sortas="b-pre-grohtml">pre-grohtml</primary></indexterm>
|
---|
| 307 | </listitem>
|
---|
| 308 | </varlistentry>
|
---|
| 309 |
|
---|
| 310 | <varlistentry id="refer">
|
---|
| 311 | <term><command>refer</command></term>
|
---|
| 312 | <listitem>
|
---|
| 313 | <para>Copies the contents of a file to the standard output, except
|
---|
| 314 | that lines between <emphasis>.[</emphasis> and <emphasis>.]</emphasis>
|
---|
| 315 | are interpreted as citations, and lines between
|
---|
| 316 | <emphasis>.R1</emphasis> and <emphasis>.R2</emphasis> are interpreted
|
---|
| 317 | as commands for how citations are to be processed</para>
|
---|
| 318 | <indexterm zone="ch-system-groff refer"><primary sortas="b-refer">refer</primary></indexterm>
|
---|
| 319 | </listitem>
|
---|
| 320 | </varlistentry>
|
---|
| 321 |
|
---|
| 322 | <varlistentry id="soelim">
|
---|
| 323 | <term><command>soelim</command></term>
|
---|
| 324 | <listitem>
|
---|
| 325 | <para>Reads files and replaces lines of the form
|
---|
| 326 | <emphasis>.so file</emphasis> by the contents of the mentioned
|
---|
| 327 | <emphasis>file</emphasis></para>
|
---|
| 328 | <indexterm zone="ch-system-groff soelim"><primary sortas="b-soelim">soelim</primary></indexterm>
|
---|
| 329 | </listitem>
|
---|
| 330 | </varlistentry>
|
---|
| 331 |
|
---|
| 332 | <varlistentry id="tbl">
|
---|
| 333 | <term><command>tbl</command></term>
|
---|
| 334 | <listitem>
|
---|
| 335 | <para>Compiles descriptions of tables embedded
|
---|
| 336 | within troff input files into commands that are understood by <command>troff</command></para>
|
---|
| 337 | <indexterm zone="ch-system-groff tbl"><primary sortas="b-tbl">tbl</primary></indexterm>
|
---|
| 338 | </listitem>
|
---|
| 339 | </varlistentry>
|
---|
| 340 |
|
---|
| 341 | <varlistentry id="tfmtodit">
|
---|
| 342 | <term><command>tfmtodit</command></term>
|
---|
| 343 | <listitem>
|
---|
| 344 | <para>Creates a font file for use with <command>groff -Tdvi</command></para>
|
---|
| 345 | <indexterm zone="ch-system-groff tfmtodit"><primary sortas="b-tfmtodit">tfmtodit</primary></indexterm>
|
---|
| 346 | </listitem>
|
---|
| 347 | </varlistentry>
|
---|
| 348 |
|
---|
| 349 | <varlistentry id="troff">
|
---|
| 350 | <term><command>troff</command></term>
|
---|
| 351 | <listitem>
|
---|
| 352 | <para>Is highly compatible with Unix <command>troff</command>; it
|
---|
| 353 | should usually be invoked using the
|
---|
| 354 | <command>groff</command> command, which will also run preprocessors and post-processors in the
|
---|
| 355 | appropriate order and with the appropriate options</para>
|
---|
| 356 | <indexterm zone="ch-system-groff troff"><primary sortas="b-troff">troff</primary></indexterm>
|
---|
| 357 | </listitem>
|
---|
| 358 | </varlistentry>
|
---|
| 359 |
|
---|
| 360 | <varlistentry id="zsoelim">
|
---|
| 361 | <term><command>zsoelim</command></term>
|
---|
| 362 | <listitem>
|
---|
[90b56f5] | 363 | <para>A link to <command>soelim</command></para>
|
---|
[81fd230] | 364 | <indexterm zone="ch-system-groff zsoelim"><primary sortas="b-zsoelim">zsoelim</primary></indexterm>
|
---|
| 365 | </listitem>
|
---|
| 366 | </varlistentry>
|
---|
| 367 | </variablelist>
|
---|
[673b0d8] | 368 |
|
---|
| 369 | </sect2>
|
---|
| 370 |
|
---|
| 371 | </sect1>
|
---|
[81fd230] | 372 |
|
---|