chapter06/grub.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-grub" role="wrap">
   9   <?dbhtml filename="grub.html"?>
  10
  11   <sect1info condition="script">
  12     <productname>grub</productname>
  13     <productnumber>&grub-version;</productnumber>
  14     <address>&grub-url;</address>
  15   </sect1info>
  16
  17   <title>GRUB-&grub-version;</title>
  18
  19   <indexterm zone="ch-system-grub">
  20     <primary sortas="a-Grub">GRUB</primary>
  21   </indexterm>
  22
  23   <sect2 role="package">
  24     <title/>
  25
  26     <para>The GRUB package contains the GRand Unified Bootloader.</para>
  27
  28     <segmentedlist>
  29       <segtitle>&buildtime;</segtitle>
  30       <segtitle>&diskspace;</segtitle>
  31
  32       <seglistitem>
  33         <seg>&grub-ch6-sbu;</seg>
  34         <seg>&grub-ch6-du;</seg>
  35       </seglistitem>
  36     </segmentedlist>
  37
  38   </sect2>
  39
  40   <sect2 role="installation">
  41     <title>Installation of GRUB</title>
  42
  43     <para>Prepare GRUB for compilation:</para>
  44
  45 <screen><userinput remap="configure">./configure --prefix=/usr          \
  46             --sbindir=/sbin        \
  47             --sysconfdir=/etc      \
  48             --disable-grub-emu-usb \
  49             --disable-efiemu       \
  50             --disable-werror</userinput></screen>
  51
  52     <variablelist>
  53       <title>The meaning of the new configure options:</title>
  54
  55       <varlistentry>
  56         <term><parameter>--disable-werror</parameter></term>
  57         <listitem>
  58           <para>This allows the build to complete with warnings introduced
  59           by more recent Flex versions.</para>
  60         </listitem>
  61       </varlistentry>
  62
  63       <varlistentry>
  64         <term><parameter>--disable-grub-emu-usb --disable-efiemu</parameter></term>
  65         <listitem>
  66           <para>These options minimize what is built by disabling features and
  67           testing programs not needed for LFS.</para>
  68         </listitem>
  69       </varlistentry>
  70
  71     </variablelist>
  72
  73     <para>Compile the package:</para>
  74
  75 <screen><userinput remap="make">make</userinput></screen>
  76
  77     <para>This package does not come with a test suite.</para>
  78
  79     <para>Install the package:</para>
  80
  81 <screen><userinput remap="install">make install</userinput></screen>
  82
  83   <para>Using GRUB to make your LFS system bootable will be discussed in
  84   <xref linkend="ch-bootable-grub"/>.</para>
  85
  86   </sect2>
  87
  88   <sect2 id="contents-gRUB" role="content">
  89     <title>Contents of GRUB</title>
  90
  91     <segmentedlist>
  92       <segtitle>Installed programs</segtitle>
  93       <segtitle>Installed directories</segtitle>
  94
  95       <seglistitem>
  96
  97        <seg>                      grub-bios-setup, grub-editenv,     grub-fstest,
  98             grub-install,         grub-kbdcomp,    grub-menulst2cfg, grub-mkconfig,
  99                                   grub-mkimage,    grub-mklayout,    grub-mknetdir,
 100             grub-mkpasswd-pbkdf2, grub-mkrelpath,  grub-mkrescue,    grub-mkstandalone,
 101             grub-ofpathname,      grub-probe,      grub-reboot,      grub-script-check,
 102             grub-set-default,                      grub-sparc64-setup </seg>
 103
 104         <seg>/usr/lib/grub, /etc/grub.d, /usr/share/grub, /boot/grub</seg>
 105       </seglistitem>
 106     </segmentedlist>
 107
 108     <variablelist>
 109       <bridgehead renderas="sect3">Short Descriptions</bridgehead>
 110       <?dbfo list-presentation="list"?>
 111       <?dbhtml list-presentation="table"?>
 112
 113       <varlistentry id="grub-bios-setup">
 114         <term><command>grub-bios-setup</command></term>
 115         <listitem>
 116           <para>Is a helper program for grub-install</para>
 117           <indexterm zone="ch-system-grub grub-bios-setup">
 118             <primary sortas="b-grub-bios-setup">grub-bios-setup</primary>
 119           </indexterm>
 120         </listitem>
 121       </varlistentry>
 122
 123       <varlistentry id="grub-editenv">
 124         <term><command>grub-editenv</command></term>
 125         <listitem>
 126           <para>A tool to edit the environment block</para>
 127           <indexterm zone="ch-system-grub grub-editenv">
 128             <primary sortas="b-grub-editenv">grub-editenv</primary>
 129           </indexterm>
 130         </listitem>
 131       </varlistentry>
 132
 133       <varlistentry id="grub-fstest">
 134         <term><command>grub-fstest</command></term>
 135         <listitem>
 136           <para>Tool to debug the filesystem driver</para>
 137           <indexterm zone="ch-system-grub grub-fstest">
 138             <primary sortas="b-grub-fstest">grub-fstest</primary>
 139           </indexterm>
 140         </listitem>
 141       </varlistentry>
 142
 143       <varlistentry id="grub-install">
 144         <term><command>grub-install</command></term>
 145         <listitem>
 146           <para>Install GRUB on your drive</para>
 147           <indexterm zone="ch-system-grub grub-install">
 148             <primary sortas="b-grub-install">grub-install</primary>
 149           </indexterm>
 150         </listitem>
 151       </varlistentry>
 152
 153       <varlistentry id="grub-kbdcomp">
 154         <term><command>grub-kbdcomp</command></term>
 155         <listitem>
 156           <para>Script that converts an xkb layout into one recognized by
 157           GRUB</para>
 158           <indexterm zone="ch-system-grub grub-kbdcomp">
 159             <primary sortas="b-grub-kbdcomp">grub-kbdcomp</primary>
 160           </indexterm>
 161         </listitem>
 162       </varlistentry>
 163
 164       <varlistentry id="grub-menulst2cfg">
 165         <term><command>grub-menulst2cfg</command></term>
 166         <listitem>
 167           <para>Converts a GRUB Legacy <filename>menu.lst</filename>
 168           into a <filename>grub.cfg</filename> for use with GRUB 2</para>
 169           <indexterm zone="ch-system-grub grub-menulst2cfg">
 170             <primary sortas="b-grub-menulst2cfg">grub-menulst2cfg</primary>
 171           </indexterm>
 172         </listitem>
 173       </varlistentry>
 174
 175       <varlistentry id="grub-mkconfig">
 176         <term><command>grub-mkconfig</command></term>
 177         <listitem>
 178           <para>Generate a grub config file</para>
 179           <indexterm zone="ch-system-grub grub-mkconfig">
 180             <primary sortas="b-grub-mkconfig">grub-mkconfig</primary>
 181           </indexterm>
 182         </listitem>
 183       </varlistentry>
 184
 185       <varlistentry id="grub-mkimage">
 186         <term><command>grub-mkimage</command></term>
 187         <listitem>
 188           <para>Make a bootable image of GRUB</para>
 189           <indexterm zone="ch-system-grub grub-mkimage">
 190             <primary sortas="b-grub-mkimage">grub-mkimage</primary>
 191           </indexterm>
 192         </listitem>
 193       </varlistentry>
 194
 195       <varlistentry id="grub-mklayout">
 196         <term><command>grub-mklayout</command></term>
 197         <listitem>
 198           <para>Generates a GRUB keyboard layout file</para>
 199           <indexterm zone="ch-system-grub grub-mklayout">
 200             <primary sortas="b-grub-mklayout">grub-mklayout</primary>
 201           </indexterm>
 202         </listitem>
 203       </varlistentry>
 204
 205       <varlistentry id="grub-mknetdir">
 206         <term><command>grub-mknetdir</command></term>
 207         <listitem>
 208           <para>Prepares a GRUB netboot directory</para>
 209           <indexterm zone="ch-system-grub grub-mknetdir">
 210             <primary sortas="b-grub-mknetdir">grub-mknetdir</primary>
 211           </indexterm>
 212         </listitem>
 213       </varlistentry>
 214
 215       <varlistentry id="grub-mkpasswd-pbkdf2">
 216         <term><command>grub-mkpasswd-pbkdf2</command></term>
 217         <listitem>
 218           <para>Generates an encrypted PBKDF2 password for use in the boot
 219           menu</para>
 220           <indexterm zone="ch-system-grub grub-mkpasswd-pbkdf2">
 221             <primary sortas="b-grub-mkpasswd-pbkdf2">grub-mkpasswd-pbkdf2</primary>
 222           </indexterm>
 223         </listitem>
 224       </varlistentry>
 225
 226       <varlistentry id="grub-mkrelpath">
 227         <term><command>grub-mkrelpath</command></term>
 228         <listitem>
 229           <para>Makes a system pathname relative to its root</para>
 230           <indexterm zone="ch-system-grub grub-mkrelpath">
 231             <primary sortas="b-grub-mkrelpath">grub-mkrelpath</primary>
 232           </indexterm>
 233         </listitem>
 234       </varlistentry>
 235
 236       <varlistentry id="grub-mkrescue">
 237         <term><command>grub-mkrescue</command></term>
 238         <listitem>
 239           <para>Make a bootable image of GRUB suitable for a floppy disk or CDROM/DVD</para>
 240           <indexterm zone="ch-system-grub grub-mkrescue">
 241             <primary sortas="b-grub-mkrescue">grub-mkrescue</primary>
 242           </indexterm>
 243         </listitem>
 244       </varlistentry>
 245
 246       <varlistentry id="grub-mkstandalone">
 247         <term><command>grub-mkstandalone</command></term>
 248         <listitem>
 249           <para>Generates a standalone image</para>
 250           <indexterm zone="ch-system-grub grub-mkstandalone">
 251             <primary sortas="b-grub-mkstandalone">grub-mkstandalone</primary>
 252           </indexterm>
 253         </listitem>
 254       </varlistentry>
 255
 256       <varlistentry id="grub-ofpathname">
 257         <term><command>grub-ofpathname</command></term>
 258         <listitem>
 259           <para>Is a helper program that prints the path of a GRUB device</para>
 260           <indexterm zone="ch-system-grub grub-ofpathname">
 261             <primary sortas="b-grub-ofpathname">grub-ofpathname</primary>
 262           </indexterm>
 263         </listitem>
 264       </varlistentry>
 265
 266       <varlistentry id="grub-probe">
 267         <term><command>grub-probe</command></term>
 268         <listitem>
 269           <para>Probe device information for a given path or device</para>
 270           <indexterm zone="ch-system-grub grub-probe">
 271             <primary sortas="b-grub-probe">grub-probe</primary>
 272           </indexterm>
 273         </listitem>
 274       </varlistentry>
 275
 276       <varlistentry id="grub-reboot">
 277         <term><command>grub-reboot</command></term>
 278         <listitem>
 279           <para>Sets the default boot entry for GRUB for the next boot only</para>
 280           <indexterm zone="ch-system-grub grub-reboot">
 281             <primary sortas="b-grub-reboot">grub-reboot</primary>
 282           </indexterm>
 283         </listitem>
 284       </varlistentry>
 285
 286       <varlistentry id="grub-script-check">
 287         <term><command>grub-script-check</command></term>
 288         <listitem>
 289           <para>Checks GRUB configuration script for syntax errors</para>
 290           <indexterm zone="ch-system-grub grub-script-check">
 291             <primary sortas="b-grub-script-check">grub-script-check</primary>
 292           </indexterm>
 293         </listitem>
 294       </varlistentry>
 295
 296       <varlistentry id="grub-set-default">
 297         <term><command>grub-set-default</command></term>
 298         <listitem>
 299           <para>Sets the default boot entry for GRUB</para>
 300           <indexterm zone="ch-system-grub grub-set-default">
 301             <primary sortas="b-grub-set-default">grub-set-default</primary>
 302           </indexterm>
 303         </listitem>
 304       </varlistentry>
 305
 306       <varlistentry id="grub-sparc64-setup">
 307         <term><command>grub-sparc64-setup</command></term>
 308         <listitem>
 309           <para>Is a helper program for grub-setup</para>
 310           <indexterm zone="ch-system-grub grub-sparc64-setup">
 311             <primary sortas="b-grub-sparc64-setup">grub-setup</primary>
 312           </indexterm>
 313         </listitem>
 314       </varlistentry>
 315
 316     </variablelist>
 317
 318   </sect2>
 319
 320 </sect1>