chapter06/groff.xml

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