grub.xml 13 KB

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