Changeset 7350

Show
Ignore:
Timestamp:
02/05/06 04:42:02 (3 years ago)
Author:
manuel
Message:

Ported r7348 from trunk to alphabetical branch.

Files:

Legend:

Unmodified
Added
Removed
Modified
Copied
Moved

  • branches/alphabetical/BOOK/chapter06/groff.xml

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

  • branches/alphabetical/BOOK/chapter06/grub.xml

    r7137 r7350  
    11<?xml version="1.0" encoding="ISO-8859-1"?> 
    2 <!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 
     2<!DOCTYPE sect1 PUBLIC "-//OASIS//DTD DocBook XML V4.4//EN" 
     3  "http://www.oasis-open.org/docbook/xml/4.4/docbookx.dtd" [ 
    34  <!ENTITY % general-entities SYSTEM "../general.ent"> 
    45  %general-entities; 
    56]> 
     7 
    68<sect1 id="ch-system-grub" role="wrap"> 
    7 <title>GRUB-&grub-version;</title> 
    8 <?dbhtml filename="grub.html"?> 
     9  <?dbhtml filename="grub.html"?> 
    910 
    10 <indexterm zone="ch-system-grub"><primary sortas="a-Grub">GRUB</primary></indexterm> 
     11  <title>GRUB-&grub-version;</title> 
    1112 
    12 <sect2 role="package"><title/> 
    13 <para>The GRUB package contains the GRand Unified Bootloader.</para> 
     13  <indexterm zone="ch-system-grub"> 
     14    <primary sortas="a-Grub">GRUB</primary> 
     15  </indexterm> 
    1416 
    15 <segmentedlist> 
    16 <segtitle>&buildtime;</segtitle> 
    17 <segtitle>&diskspace;</segtitle> 
    18 <seglistitem><seg>0.2 SBU</seg><seg>10.0 MB</seg></seglistitem> 
    19 </segmentedlist> 
     17  <sect2 role="package"> 
     18    <title/> 
    2019 
    21 <segmentedlist> 
    22 <segtitle>&dependencies;</segtitle> 
    23 <seglistitem><seg>Bash, Binutils, Coreutils, Diffutils, 
    24 GCC, Glibc, Grep, Make, Ncurses, and Sed</seg></seglistitem> 
    25 </segmentedlist> 
    26 </sect2> 
     20    <para>The GRUB package contains the GRand Unified Bootloader.</para> 
    2721 
    28 <sect2 role="installation"> 
    29 <title>Installation of GRUB</title> 
     22    <segmentedlist> 
     23      <segtitle>&buildtime;</segtitle> 
     24      <segtitle>&diskspace;</segtitle> 
    3025 
    31 <para>This package is known to have issues when its default 
    32 optimization flags (including the <parameter>-march</parameter> and 
    33 <parameter>-mcpu</parameter> options) are changed. If any environment 
    34 variables that override default optimizations have been defined, such 
    35 as <envar>CFLAGS</envar> and <envar>CXXFLAGS</envar>, 
    36 unset them when building GRUB.</para> 
     26      <seglistitem> 
     27        <seg>0.2 SBU</seg> 
     28        <seg>10.0 MB</seg> 
     29      </seglistitem> 
     30    </segmentedlist> 
    3731 
    38 <para>Prepare GRUB for compilation:</para> 
     32    <segmentedlist> 
     33      <segtitle>&dependencies;</segtitle> 
     34 
     35      <seglistitem> 
     36        <seg>Bash, Binutils, Coreutils, Diffutils, GCC, Glibc, Grep, Make, 
     37        Ncurses, and Sed</seg> 
     38      </seglistitem> 
     39    </segmentedlist> 
     40 
     41  </sect2> 
     42 
     43  <sect2 role="installation"> 
     44    <title>Installation of GRUB</title> 
     45 
     46    <para>This package is known to have issues when its default 
     47    optimization flags (including the <parameter>-march</parameter> and 
     48    <parameter>-mcpu</parameter> options) are changed. If any environment 
     49    variables that override default optimizations have been defined, such 
     50    as <envar>CFLAGS</envar> and <envar>CXXFLAGS</envar>, 
     51    unset them when building GRUB.</para> 
     52 
     53    <para>Prepare GRUB for compilation:</para> 
    3954 
    4055<screen><userinput>./configure --prefix=/usr</userinput></screen> 
    4156 
    42 <para>Compile the package:</para> 
     57    <para>Compile the package:</para> 
    4358 
    4459<screen><userinput>make</userinput></screen> 
    4560 
    46 <para>To test the results, issue: 
    47 <userinput>make check</userinput>.</para> 
     61    <para>To test the results, issue: 
     62    <userinput>make check</userinput>.</para> 
    4863 
    49 <para>Install the package:</para> 
     64    <para>Install the package:</para> 
    5065 
    5166<screen><userinput>make install 
    …… 
    5368cp -v /usr/lib/grub/i386-pc/stage{1,2} /boot/grub</userinput></screen> 
    5469 
    55 <para>Replace <filename class="directory">i386-pc</filename> with whatever 
    56 directory is appropriate for the hardware in use.</para> 
     70    <para>Replace <filename class="directory">i386-pc</filename> with whatever 
     71    directory is appropriate for the hardware in use.</para> 
    5772 
    58 <para>The <filename class="directory">i386-pc</filename> directory 
    59 contains a number of <filename>*stage1_5</filename> files, different 
    60 ones for different file systems. Review the files available and copy 
    61 the appropriate ones to the <filename 
    62 class="directory">/boot/grub</filename> directory. Most users will 
    63 copy the <filename>e2fs_stage1_5</filename> and/or 
    64 <filename>reiserfs_stage1_5</filename> files.</para> 
     73    <para>The <filename class="directory">i386-pc</filename> directory 
     74    contains a number of <filename>*stage1_5</filename> files, different 
     75    ones for different file systems. Review the files available and copy 
     76    the appropriate ones to the <filename 
     77    class="directory">/boot/grub</filename> directory. Most users will 
     78    copy the <filename>e2fs_stage1_5</filename> and/or 
     79    <filename>reiserfs_stage1_5</filename> files.</para> 
    6580 
    66 </sect2> 
     81  </sect2> 
    6782 
     83  <sect2 id="contents-gRUB" role="content"> 
     84    <title>Contents of GRUB</title> 
    6885 
    69 <sect2 id="contents-gRUB" role="content"><title>Contents of GRUB</title> 
     86    <segmentedlist> 
     87      <segtitle>Installed programs</segtitle> 
    7088 
    71 <segmentedlist> 
    72 <segtitle>Installed programs</segtitle> 
    73 <seglistitem><seg>grub, grub-install, 
    74 grub-md5-crypt, grub-terminfo, and mbchk</seg></seglistitem> 
    75 </segmentedlist> 
     89      <seglistitem> 
     90        <seg>grub, grub-install, grub-md5-crypt, grub-terminfo, and mbchk</seg> 
     91      </seglistitem> 
     92    </segmentedlist> 
    7693 
    77 <variablelist><bridgehead renderas="sect3">Short Descriptions</bridgehead> 
    78 <?dbfo list-presentation="list"?> 
    79 <?dbhtml list-presentation="table"?> 
     94    <variablelist> 
     95      <bridgehead renderas="sect3">Short Descriptions</bridgehead> 
     96      <?dbfo list-presentation="list"?> 
     97      <?dbhtml list-presentation="table"?> 
    8098 
    81 <varlistentry id="grub"> 
    82 <term><command>grub</command></term> 
    83 <listitem> 
    84 <para>The Grand Unified Bootloader's command shell</para> 
    85 <indexterm zone="ch-system-grub grub"><primary sortas="b-grub">grub</primary></indexterm> 
    86 </listitem> 
    87 </varlistentry> 
     99      <varlistentry id="grub"> 
     100        <term><command>grub</command></term> 
     101        <listitem> 
     102          <para>The Grand Unified Bootloader's command shell</para> 
     103          <indexterm zone="ch-system-grub grub"> 
     104            <primary sortas="b-grub">grub</primary> 
     105          </indexterm> 
     106        </listitem> 
     107      </varlistentry> 
    88108 
    89 <varlistentry id="grub-install"> 
    90 <term><command>grub-install</command>&