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>Compile the package:</para>
  57
  58 <screen><userinput remap="make">make</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,
  77         geqn (link to eqn), grap2graph, grn, grodvi, groff, groffer, grog,
  78         grolbp, grolj4, grops, grotty, gtbl (link to tbl), hpftodit,
  79         indxbib, lkbib, lookbib, mmroff, neqn, nroff, pdfroff, pfbtops, pic,
  80         pic2graph, post-grohtml, preconv, pre-grohtml, refer, roff2dvi,
  81         roff2html, roff2pdf, roff2ps, roff2text, roff2x, soelim, tbl, tfmtodit,
  82         and 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="geqn">
 158         <term><command>geqn</command></term>
 159         <listitem>
 160           <para>A link to <command>eqn</command></para>
 161           <indexterm zone="ch-system-groff geqn">
 162             <primary sortas="b-geqn">geqn</primary>
 163           </indexterm>
 164         </listitem>
 165       </varlistentry>
 166
 167       <varlistentry id="grap2graph">
 168         <term><command>grap2graph</command></term>
 169         <listitem>
 170           <para>Converts a grap diagram into a cropped bitmap image</para>
 171           <indexterm zone="ch-system-groff grap2graph">
 172             <primary sortas="b-grap2graph">grap2graph</primary>
 173           </indexterm>
 174         </listitem>
 175       </varlistentry>
 176
 177       <varlistentry id="grn">
 178         <term><command>grn</command></term>
 179         <listitem>
 180           <para>A <command>groff</command> preprocessor for gremlin files</para>
 181           <indexterm zone="ch-system-groff grn">
 182             <primary sortas="b-grn">grn</primary>
 183           </indexterm>
 184         </listitem>
 185       </varlistentry>
 186
 187       <varlistentry id="grodvi">
 188         <term><command>grodvi</command></term>
 189         <listitem>
 190           <para>A driver for <command>groff</command> that produces TeX dvi
 191           format</para>
 192           <indexterm zone="ch-system-groff grodvi">
 193             <primary sortas="b-grodvi">grodvi</primary>
 194           </indexterm>
 195         </listitem>
 196       </varlistentry>
 197
 198       <varlistentry id="groff">
 199         <term><command>groff</command></term>
 200         <listitem>
 201           <para>A front-end to the groff document formatting system; normally, it
 202           runs the <command>troff</command> program and a post-processor
 203           appropriate for the selected device</para>
 204           <indexterm zone="ch-system-groff groff">
 205             <primary sortas="b-groff">groff</primary>
 206           </indexterm>
 207         </listitem>
 208       </varlistentry>
 209
 210       <varlistentry id="groffer">
 211         <term><command>groffer</command></term>
 212         <listitem>
 213           <para>Displays groff files and man pages on X and tty terminals</para>
 214           <indexterm zone="ch-system-groff groffer">
 215             <primary sortas="b-groffer">groffer</primary>
 216           </indexterm>
 217         </listitem>
 218       </varlistentry>
 219
 220       <varlistentry id="grog">
 221         <term><command>grog</command></term>
 222         <listitem>
 223           <para>Reads files and guesses which of the <command>groff</command>
 224           options <option>-e</option>, <option>-man</option>, <option>-me</option>,
 225           <option>-mm</option>, <option>-ms</option>, <option>-p</option>,
 226           <option>-s</option>, and <option>-t</option> are required for printing
 227           files, and reports the <command>groff</command> command including those
 228           options</para>
 229           <indexterm zone="ch-system-groff grog">
 230             <primary sortas="b-grog">grog</primary>
 231           </indexterm>
 232         </listitem>
 233       </varlistentry>
 234
 235       <varlistentry id="grolbp">
 236         <term><command>grolbp</command></term>
 237         <listitem>
 238           <para>Is a <command>groff</command> driver for Canon CAPSL printers
 239           (LBP-4 and LBP-8 series laser printers)</para>
 240           <indexterm zone="ch-system-groff grolbp">
 241             <primary sortas="b-grolbp">grolbp</primary>
 242           </indexterm>
 243         </listitem>
 244       </varlistentry>
 245
 246       <varlistentry id="grolj4">
 247         <term><command>grolj4</command></term>
 248         <listitem>
 249           <para>Is a driver for <command>groff</command> that produces output
 250           in PCL5 format suitable for an HP LaserJet 4 printer</para>
 251           <indexterm zone="ch-system-groff grolj4">
 252             <primary sortas="b-grolj4">grolj4</primary>
 253           </indexterm>
 254         </listitem>
 255       </varlistentry>
 256
 257       <varlistentry id="grops">
 258         <term><command>grops</command></term>
 259         <listitem>
 260           <para>Translates the output of GNU <command>troff</command> to
 261           PostScript</para>
 262           <indexterm zone="ch-system-groff grops">
 263             <primary sortas="b-grops">grops</primary>
 264           </indexterm>
 265         </listitem>
 266       </varlistentry>
 267
 268       <varlistentry id="grotty">
 269         <term><command>grotty</command></term>
 270         <listitem>
 271           <para>Translates the output of GNU <command>troff</command> into
 272           a form suitable for typewriter-like devices</para>
 273           <indexterm zone="ch-system-groff grotty">
 274             <primary sortas="b-grotty">grotty</primary>
 275           </indexterm>
 276         </listitem>
 277       </varlistentry>
 278
 279       <varlistentry id="gtbl">
 280         <term><command>gtbl</command></term>
 281         <listitem>
 282           <para>A link to <command>tbl</command></para>
 283           <indexterm zone="ch-system-groff gtbl">
 284             <primary sortas="b-gtbl">gtbl</primary>
 285           </indexterm>
 286         </listitem>
 287       </varlistentry>
 288
 289       <varlistentry id="hpftodit">
 290         <term><command>hpftodit</command></term>
 291         <listitem>
 292           <para>Creates a font file for use with <command>groff -Tlj4</command>
 293           from an HP-tagged font metric file</para>
 294           <indexterm zone="ch-system-groff hpftodit">
 295             <primary sortas="b-hpftodit">hpftodit</primary>
 296           </indexterm>
 297         </listitem>
 298       </varlistentry>
 299
 300       <varlistentry id="indxbib">
 301         <term><command>indxbib</command></term>
 302         <listitem>
 303           <para>Creates an inverted index for the bibliographic databases with a
 304           specified file for use with <command>refer</command>,
 305           <command>lookbib</command>, and <command>lkbib</command></para>
 306           <indexterm zone="ch-system-groff indxbib">
 307             <primary sortas="b-indxbib">indxbib</primary>
 308           </indexterm>
 309         </listitem>
 310       </varlistentry>
 311
 312       <varlistentry id="lkbib">
 313         <term><command>lkbib</command></term>
 314         <listitem>
 315           <para>Searches bibliographic databases for references that contain
 316           specified keys and reports any references found</para>
 317           <indexterm zone="ch-system-groff lkbib">
 318             <primary sortas="b-lkbib">lkbib</primary>
 319           </indexterm>
 320         </listitem>
 321       </varlistentry>
 322
 323       <varlistentry id="lookbib">
 324         <term><command>lookbib</command></term>
 325         <listitem>
 326           <para>Prints a prompt on the standard error (unless the standard input
 327           is not a terminal), reads a line containing a set of keywords from the
 328           standard input, searches the bibliographic databases in a specified file
 329           for references containing those keywords, prints any references found
 330           on the standard output, and repeats this process until the end of
 331           input</para>
 332           <indexterm zone="ch-system-groff lookbib">
 333             <primary sortas="b-lookbib">lookbib</primary>
 334           </indexterm>
 335         </listitem>
 336       </varlistentry>
 337
 338       <varlistentry id="mmroff">
 339         <term><command>mmroff</command></term>
 340         <listitem>
 341           <para>A simple preprocessor for <command>groff</command></para>
 342           <indexterm zone="ch-system-groff mmroff">
 343             <primary sortas="b-mmroff">mmroff</primary>
 344           </indexterm>
 345         </listitem>
 346       </varlistentry>
 347
 348       <varlistentry id="neqn">
 349         <term><command>neqn</command></term>
 350         <listitem>
 351           <para>Formats equations for American Standard Code for Information
 352           Interchange (ASCII) output</para>
 353           <indexterm zone="ch-system-groff neqn">
 354             <primary sortas="b-neqn">neqn</primary>
 355           </indexterm>
 356         </listitem>
 357       </varlistentry>
 358
 359       <varlistentry id="nroff">
 360         <term><command>nroff</command></term>
 361         <listitem>
 362           <para>A script that emulates the <command>nroff</command> command
 363           using <command>groff</command></para>
 364           <indexterm zone="ch-system-groff nroff">
 365             <primary sortas="b-nroff">nroff</primary>
 366           </indexterm>
 367         </listitem>
 368       </varlistentry>
 369
 370       <varlistentry id="pdfroff">
 371         <term><command>pdfroff</command></term>
 372         <listitem>
 373           <para>Creates pdf documents using groff</para>
 374           <indexterm zone="ch-system-groff pdfroff">
 375             <primary sortas="b-pdfroff">pdfroff</primary>
 376           </indexterm>
 377         </listitem>
 378       </varlistentry>
 379
 380       <varlistentry id="pfbtops">
 381         <term><command>pfbtops</command></term>
 382         <listitem>
 383           <para>Translates a PostScript font in <filename
 384           class="extension">.pfb</filename> format to ASCII</para>
 385           <indexterm zone="ch-system-groff pfbtops">
 386             <primary sortas="b-pfbtops">pfbtops</primary>
 387           </indexterm>
 388         </listitem>
 389       </varlistentry>
 390
 391       <varlistentry id="pic">
 392         <term><command>pic</command></term>
 393         <listitem>
 394           <para>Compiles descriptions of pictures embedded within troff or
 395           TeX input files into commands understood by TeX or
 396           <command>troff</command></para>
 397           <indexterm zone="ch-system-groff pic">
 398             <primary sortas="b-pic">pic</primary>
 399           </indexterm>
 400         </listitem>
 401       </varlistentry>
 402
 403       <varlistentry id="pic2graph">
 404         <term><command>pic2graph</command></term>
 405         <listitem>
 406           <para>Converts a PIC diagram into a cropped image</para>
 407           <indexterm zone="ch-system-groff pic2graph">
 408             <primary sortas="b-pic2graph">pic2graph</primary>
 409           </indexterm>
 410         </listitem>
 411       </varlistentry>
 412
 413       <varlistentry id="post-grohtml">
 414         <term><command>post-grohtml</command></term>
 415         <listitem>
 416           <para>Translates the output of GNU <command>troff</command> to
 417           HTML</para>
 418           <indexterm zone="ch-system-groff post-grohtml">
 419             <primary sortas="b-post-grohtml">post-grohtml</primary>
 420           </indexterm>
 421         </listitem>
 422       </varlistentry>
 423
 424       <varlistentry id="preconv">
 425         <term><command>preconv</command></term>
 426         <listitem>
 427           <para>Converts encoding of input files to something GNU
 428           <command>troff</command> understands</para>
 429           <indexterm zone="ch-system-groff preconv">
 430             <primary sortas="b-preconv">preconv</primary>
 431           </indexterm>
 432         </listitem>
 433       </varlistentry>
 434
 435       <varlistentry id="pre-grohtml">
 436         <term><command>pre-grohtml </command></term>
 437         <listitem>
 438           <para>Translates the output of GNU <command>troff</command> to
 439           HTML</para>
 440           <indexterm zone="ch-system-groff pre-grohtml">
 441             <primary sortas="b-pre-grohtml">pre-grohtml</primary>
 442           </indexterm>
 443         </listitem>
 444       </varlistentry>
 445
 446       <varlistentry id="refer">
 447         <term><command>refer</command></term>
 448         <listitem>
 449           <para>Copies the contents of a file to the standard output, except
 450           that lines between <emphasis>.[</emphasis> and <emphasis>.]</emphasis>
 451           are interpreted as citations, and lines between <emphasis>.R1</emphasis>
 452           and <emphasis>.R2</emphasis> are interpreted as commands for how
 453           citations are to be processed</para>
 454           <indexterm zone="ch-system-groff refer">
 455             <primary sortas="b-refer">refer</primary>
 456           </indexterm>
 457         </listitem>
 458       </varlistentry>
 459
 460       <varlistentry id="roff2dvi">
 461         <term><command>roff2dvi</command></term>
 462         <listitem>
 463           <para>Transforms roff files into DVI format</para>
 464           <indexterm zone="ch-system-groff roff2dvi">
 465             <primary sortas="b-roff2dvi">roff2dvi</primary>
 466           </indexterm>
 467         </listitem>
 468       </varlistentry>
 469
 470       <varlistentry id="roff2html">
 471         <term><command>roff2html</command></term>
 472         <listitem>
 473           <para>Transforms roff files into HTML format</para>
 474           <indexterm zone="ch-system-groff roff2html">
 475             <primary sortas="b-roff2html">roff2html</primary>
 476           </indexterm>
 477         </listitem>
 478       </varlistentry>
 479
 480       <varlistentry id="roff2pdf">
 481         <term><command>roff2pdf</command></term>
 482         <listitem>
 483           <para>Transforms roff files into PDFs</para>
 484           <indexterm zone="ch-system-groff roff2pdf">
 485             <primary sortas="b-roff2pdf">roff2pdf</primary>
 486           </indexterm>
 487         </listitem>
 488       </varlistentry>
 489
 490       <varlistentry id="roff2ps">
 491         <term><command>roff2ps</command></term>
 492         <listitem>
 493           <para>Transforms roff files into ps files</para>
 494           <indexterm zone="ch-system-groff roff2ps">
 495             <primary sortas="b-roff2ps">roff2ps</primary>
 496           </indexterm>
 497         </listitem>
 498       </varlistentry>
 499
 500       <varlistentry id="roff2text">
 501         <term><command>roff2text</command></term>
 502         <listitem>
 503           <para>Transforms roff files into text files</para>
 504           <indexterm zone="ch-system-groff roff2text">
 505             <primary sortas="b-roff2text">roff2text</primary>
 506           </indexterm>
 507         </listitem>
 508       </varlistentry>
 509
 510       <varlistentry id="roff2x">
 511         <term><command>roff2x</command></term>
 512         <listitem>
 513           <para>Transforms roff files into other formats</para>
 514           <indexterm zone="ch-system-groff roff2x">
 515             <primary sortas="b-roff2x">roff2x</primary>
 516           </indexterm>
 517         </listitem>
 518       </varlistentry>
 519
 520       <varlistentry id="soelim">
 521         <term><command>soelim</command></term>
 522         <listitem>
 523           <para>Reads files and replaces lines of the form <emphasis>.so
 524           file</emphasis> by the contents of the mentioned
 525           <emphasis>file</emphasis></para>
 526           <indexterm zone="ch-system-groff soelim">
 527             <primary sortas="b-soelim">soelim</primary>
 528           </indexterm>
 529         </listitem>
 530       </varlistentry>
 531
 532       <varlistentry id="tbl">
 533         <term><command>tbl</command></term>
 534         <listitem>
 535           <para>Compiles descriptions of tables embedded within troff input
 536           files into commands that are understood by
 537           <command>troff</command></para>
 538           <indexterm zone="ch-system-groff tbl">
 539             <primary sortas="b-tbl">tbl</primary>
 540           </indexterm>
 541         </listitem>
 542       </varlistentry>
 543
 544       <varlistentry id="tfmtodit">
 545         <term><command>tfmtodit</command></term>
 546         <listitem>
 547           <para>Creates a font file for use with <command>groff
 548           -Tdvi</command></para>
 549           <indexterm zone="ch-system-groff tfmtodit">
 550             <primary sortas="b-tfmtodit">tfmtodit</primary>
 551           </indexterm>
 552         </listitem>
 553       </varlistentry>
 554
 555       <varlistentry id="troff">
 556         <term><command>troff</command></term>
 557         <listitem>
 558           <para>Is highly compatible with Unix <command>troff</command>; it
 559           should usually be invoked using the <command>groff</command> command,
 560           which will also run preprocessors and post-processors in the
 561           appropriate order and with the appropriate options</para>
 562           <indexterm zone="ch-system-groff troff">
 563             <primary sortas="b-troff">troff</primary>
 564           </indexterm>
 565         </listitem>
 566       </varlistentry>
 567
 568     </variablelist>
 569
 570   </sect2>
 571
 572 </sect1>