git.gag.com Git - debian/efibootmgr/blob - src/man/man8/efibootmgr.8.docbook

   1
   2 <!doctype refentry PUBLIC "-//OASIS//DTD DocBook V4.1//EN" [
   3
   4 <!-- This manpage was compiled by dann frazier <email>dannf@debian.org</email>,
   5      and was based on an example constructed by Colin Watson
   6      <email>cjwatson@debian.org</email>, which was based on a man page template
   7      provided by Tom Christiansen <email>tchrist@jhereg.perl.com</email>
   8      and a DocBook man page example by Craig Small
   9      <email>csmall@debian.org</email>.
  10
  11      The content was mostly taken from the efibootmgr README file in the
  12      Debian package, which was written by Matt Domsch
  13      <email>Matt_Domsch@dell.com</email>.
  14   -->
  15
  16   <!-- Fill in the various UPPER CASE things here. -->
  17   <!ENTITY manfirstname "<firstname>dann</firstname>">
  18   <!ENTITY mansurname   "<surname>frazier</surname>">
  19   <!-- Please adjust the date whenever revising the manpage. -->
  20   <!ENTITY mandate      "<date>2003-08-11</date>">
  21   <!-- SECTION should be 1-8, maybe with subsection. Other parameters are
  22        allowed: see man(7), man(1). -->
  23   <!ENTITY mansection   "<manvolnum>8</manvolnum>">
  24   <!ENTITY manemail     "<email>dannf@debian.org</email>">
  25   <!ENTITY manusername  "dann frazier">
  26   <!ENTITY manucpackage "<refentrytitle>EFIBOOTMGR</refentrytitle>">
  27   <!ENTITY manpackage   "efibootmgr">
  28 ]>
  29
  30 <refentry>
  31   <refentryinfo>
  32     <address>
  33       &manemail;
  34     </address>
  35     <author>
  36       &manfirstname;
  37       &mansurname;
  38     </author>
  39     <copyright>
  40       <year>2002, 2003</year>
  41       <holder>&manusername;</holder>
  42     </copyright>
  43     &mandate;
  44   </refentryinfo>
  45   <refmeta>
  46     &manucpackage;
  47
  48     &mansection;
  49   </refmeta>
  50   <refnamediv>
  51     <refname>&manpackage;</refname>
  52
  53     <refpurpose>manipulate the EFI Boot Manager</refpurpose>
  54   </refnamediv>
  55   <refsynopsisdiv>
  56     <cmdsynopsis>
  57       <command>&manpackage;</command>
  58
  59         <arg>-a</arg>
  60         <arg>-A</arg>
  61         <arg>-b <replaceable>XXXX</replaceable></arg>
  62         <arg>-B <replaceable>XXXX</replaceable></arg>
  63         <arg>-c</arg>
  64         <arg>-d <replaceable>DISK</replaceable></arg>
  65         <arg>-e <replaceable>1|3|-1</replaceable></arg>
  66         <arg>-E <replaceable>NUM</replaceable></arg>
  67         <arg>-g</arg>
  68         <arg>-H <replaceable>XXXX</replaceable></arg>
  69         <arg>-i <replaceable>NAME</replaceable></arg>
  70         <arg>-l <replaceable>NAME</replaceable></arg>
  71         <arg>-L <replaceable>LABEL</replaceable></arg>
  72         <arg>-n <replaceable>XXXX</replaceable></arg>
  73         <arg>-N</arg>
  74         <arg rep="repeat">-o <replaceable>XXXX</replaceable>,<replaceable>YYYY</replaceable>,<replaceable>ZZZZ</replaceable></arg>
  75         <arg>-O</arg>
  76         <arg>-p <replaceable>PART</replaceable></arg>
  77         <arg>-q</arg>
  78         <arg>-t</arg>
  79         <arg>-u</arg>
  80         <arg>-U <replaceable>XXXX</replaceable></arg>
  81         <arg>-v</arg>
  82         <arg>-V</arg>
  83         <arg>-w</arg>
  84     </cmdsynopsis>
  85   </refsynopsisdiv>
  86   <refsect1>
  87     <title>DESCRIPTION</title>
  88
  89     <para><command>&manpackage;</command> is a userspace application used to
  90       modify the Intel Extensible Firmware Interface (EFI) Boot Manager.  This
  91       application can create and destroy boot entries, change the boot order,
  92       change the next running boot option, and more.</para>
  93
  94     <para>
  95       Details on the EFI Boot Manager are available from the EFI
  96       Specification, v1.02 or later, available from:
  97       <ulink url="http://developer.intel.com"></ulink>
  98     </para>
  99
 100     <note>
 101       <para>
 102         &manpackage; requires that the kernel support access to EFI
 103         non-volatile variables (through <filename>/proc/efi/vars</filename>).
 104         <command>modprobe efivars</command> should do the trick.
 105       </para>
 106     </note>
 107   </refsect1>
 108   <refsect1>
 109     <title>OPTIONS</title>
 110
 111     <para>The following is a list of options accepted by &manpackage;:</para>
 112
 113     <variablelist>
 114       <varlistentry>
 115         <term><option>-a</option> | <option>--active</option></term>
 116         <listitem>
 117           <para>Sets bootnum active</para>
 118         </listitem>
 119       </varlistentry>
 120       <varlistentry>
 121         <term><option>-A</option> | <option>--inactive</option></term>
 122         <listitem>
 123           <para>Sets bootnum inactive</para>
 124         </listitem>
 125       </varlistentry>
 126       <varlistentry>
 127         <term><option>-b</option> | <option>--bootnum</option> <replaceable>XXXX</replaceable></term>
 128         <listitem>
 129           <para>Modify Boot<replaceable>XXXX</replaceable> (hex)</para>
 130         </listitem>
 131       </varlistentry>
 132       <varlistentry>
 133         <term><option>-B</option> | <option>--delete-bootnum</option></term>
 134         <listitem>
 135           <para>Delete bootnum (hex)</para>
 136         </listitem>
 137       </varlistentry>
 138       <varlistentry>
 139         <term><option>-c</option> | <option>--create</option></term>
 140         <listitem>
 141           <para>Create new variable bootnum and add to bootorder</para>
 142         </listitem>
 143       </varlistentry>
 144       <varlistentry>
 145         <term><option>-d</option> | <option>--disk</option> <replaceable>DISK</replaceable></term>
 146         <listitem>
 147           <para>The disk containing the loader (defaults to
 148             <filename>/dev/sda</filename>)</para>
 149         </listitem>
 150       </varlistentry>
 151       <varlistentry>
 152         <term><option>-e</option> | <option>--edd</option> <replaceable>1|3|-1</replaceable></term>
 153         <listitem>
 154           <para>Force EDD 1.0 or 3.0 creation variables, or guess.</para>
 155         </listitem>
 156       </varlistentry>
 157       <varlistentry>
 158         <term><option>-E</option> | <option>--device</option> <replaceable>NUM</replaceable></term>
 159         <listitem>
 160           <para>EDD 1.0 device number (defaults to 0x80)</para>
 161         </listitem>
 162       </varlistentry>
 163       <varlistentry>
 164         <term><option>-g</option> | <option>--gpt</option></term>
 165         <listitem>
 166           <para>Force disk with invalid PMBR to be treated as GPT</para>
 167         </listitem>
 168       </varlistentry>
 169       <varlistentry>
 170         <term><option>-H</option> | <option>--acpi_hid</option> <replaceable>XXXX</replaceable></term>
 171         <listitem>
 172           <para>set the ACPI HID (used with <option>-i</option>)</para>
 173         </listitem>
 174       </varlistentry>
 175       <varlistentry>
 176         <term><option>-i</option> | <option>--iface</option> <replaceable>NAME</replaceable></term>
 177         <listitem>
 178           <para>create a netboot entry for the named interface</para>
 179         </listitem>
 180       </varlistentry>
 181       <varlistentry>
 182         <term><option>-l</option> | <option>--loader</option> <replaceable>NAME</replaceable></term>
 183         <listitem>
 184           <para>Specify a loader (defaults to <filename>\\elilo.efi</filename>)
 185             </para>
 186         </listitem>
 187       </varlistentry>
 188       <varlistentry>
 189         <term><option>-L</option> | <option>--label</option> <replaceable>LABEL</replaceable></term>
 190         <listitem>
 191           <para>Boot manager display label (defaults to "Linux")</para>
 192         </listitem>
 193       </varlistentry>
 194       <varlistentry>
 195         <term><option>-n</option> | <option>--bootnext</option> <replaceable>XXXX</replaceable></term>
 196         <listitem>
 197           <para>Set BootNext to XXXX (hex)</para>
 198         </listitem>
 199       </varlistentry>
 200       <varlistentry>
 201         <term><option>-N</option> | <option>--delete-bootnext</option></term>
 202         <listitem>
 203           <para>Delete BootNext</para>
 204         </listitem>
 205       </varlistentry>
 206       <varlistentry>
 207         <term><option>-o</option> | <option>--bootorder</option> <replaceable>XXXX</replaceable>,<replaceable>YYYY</replaceable>,<replaceable>ZZZZ</replaceable></term>
 208         <listitem>
 209           <para>Explicitly set BootOrder (hex)</para>
 210         </listitem>
 211       </varlistentry>
 212       <varlistentry>
 213         <term><option>-O</option> | <option>--delete-bootorder</option></term>
 214         <listitem>
 215           <para>Delete BootOrder</para>
 216         </listitem>
 217       </varlistentry>
 218       <varlistentry>
 219         <term><option>-p</option> | <option>--part</option> <replaceable>PART</replaceable></term>
 220         <listitem>
 221           <para>Partition number containing the bootloader (defaults to 1)</para>
 222         </listitem>
 223       </varlistentry>
 224       <varlistentry>
 225         <term><option>-q</option> | <option>--quiet</option></term>
 226         <listitem>
 227           <para>Quiet mode - supresses output.</para>
 228         </listitem>
 229       </varlistentry>
 230       <varlistentry>
 231         <term><option>-t</option> | <option>--test</option> <replaceable>filename</replaceable></term>
 232         <listitem>
 233           <para>Don't write to NVRAM, write to <replaceable>filename</replaceable>.</para>
 234         </listitem>
 235       </varlistentry>
 236       <varlistentry>
 237         <term><option>-u</option> | <option>--unicode</option> | <option>--UCS-2</option> </term>
 238         <listitem>
 239           <para>pass extra command line arguments as UCS-2 (default is
 240           ASCII)</para>
 241         </listitem>
 242       </varlistentry>
 243       <varlistentry>
 244         <term><option>-U</option> | <option>--acpi_uid</option> <replaceable>XXXX</replaceable></term>
 245         <listitem>
 246           <para>set the ACPI UID (used with <option>-i</option>)</para>
 247         </listitem>
 248       </varlistentry>
 249       <varlistentry>
 250         <term><option>-v</option> | <option>--verbose</option></term>
 251         <listitem>
 252           <para>Verbose mode - prints additional information</para>
 253         </listitem>
 254       </varlistentry>
 255       <varlistentry>
 256         <term><option>-V</option> | <option>--version</option></term>
 257         <listitem>
 258           <para>Just print version string and exit.</para>
 259         </listitem>
 260       </varlistentry>
 261       <varlistentry>
 262         <term><option>-w</option> | <option>--write-signature</option></term>
 263         <listitem>
 264           <para>write unique signature to the MBR if needed</para>
 265         </listitem>
 266       </varlistentry>
 267     </variablelist>
 268   </refsect1>
 269
 270   <refsect1>
 271     <title>EXAMPLES</title>
 272     <orderedlist>
 273       <listitem>
 274         <example>
 275           <title>Displaying the current settings (must be root).</title>
 276
 277           <para>
 278             <computeroutput>
 279   [root@localhost ~]# efibootmgr
 280   BootCurrent: 0004
 281   BootNext: 0003
 282   BootOrder: 0004,0000,0001,0002,0003
 283   Boot0000* Diskette Drive(device:0)
 284   Boot0001* CD-ROM Drive(device:FF)
 285   Boot0002* Hard Drive(Device:80)/HD(Part1,Sig00112233)
 286   Boot0003* PXE Boot: MAC(00D0B7C15D91)
 287   Boot0004* Linux
 288             </computeroutput>
 289           </para>
 290           <para>This shows:</para>
 291           <itemizedlist>
 292             <listitem>
 293               <para>BootCurrent - the boot entry used to start the currently
 294                  running system</para>
 295             </listitem>
 296             <listitem>
 297               <para>
 298                 BootOrder - the boot order as would appear in the boot manager.
 299                 The boot manager tries to boot the first active entry in this
 300                 list.  If unsuccessful, it tries the next entry, and so on.
 301               </para>
 302             </listitem>
 303             <listitem>
 304               <para>
 305                 BootNext - the boot entry which is scheduled to be run on next
 306                 boot.  This supercedes BootOrder for one boot only, and is
 307                 deleted by the boot manager after first use.  This allows you
 308                 to change the next boot behavior without changing BootOrder.
 309               </para>
 310             </listitem>
 311             <listitem>
 312               <para>
 313                 Five boot entries (0000 - 0004), along with the active/inactive
 314                 flag (* means active) and the name displayed on the screen.
 315               </para>
 316             </listitem>
 317           </itemizedlist>
 318         </example>
 319       </listitem>
 320       <listitem>
 321         <example>
 322         <title>Creating a new boot option</title>
 323         <para>
 324           An OS installer would call <command>&manpackage; -c</command>.
 325           This assumes that <filename>/boot/efi</filename> is your EFI System
 326           Partition, and is mounted at <filename>/dev/sda1</filename>.  This
 327           creates a new boot option, called "Linux", and puts it at the top of
 328           the boot order list.  Options may be passed to modify the default
 329           behavior.  The default OS Loader is <filename>elilo.efi</filename>.
 330         </para>
 331       </example>
 332     </listitem>
 333     <listitem>
 334       <example>
 335         <title>Changing the Boot Order</title>
 336         <para>
 337           Assuming the configuration in Example #1,
 338           <command>&manpackage; -o 3,4</command> could be called to specify
 339           PXE boot first, then Linux boot.
 340         </para>
 341       </example>
 342     </listitem>
 343     <listitem>
 344       <example>
 345         <title>Changing the Boot Order for the Next Boot Only</title>
 346         <para>
 347           Assuming the configuration in Example #1,
 348           <command>&manpackage; -n 4</command> could be called to specify
 349           that the Linux entry be taken on next boot.
 350         </para>
 351       </example>
 352     </listitem>
 353     <listitem>
 354       <example>
 355         <title>Deleting a boot option</title>
 356         <para>
 357           Assuming the configuration in Example #1,
 358           <command>&manpackage; -b 4 -B</command> could be called to delete
 359           entry 4 and remove it from the BootOrder.
 360         </para>
 361       </example>
 362     </listitem>
 363     <listitem>
 364       <example>
 365         <title>Creating network boot entries</title>
 366         <para>
 367    A system administrator wants to create a boot option to network
 368    boot (PXE).  Unfortunately, this requires knowing a little more
 369    information about your system than can be easily found by
 370    efibootmgr, so you've got to pass additional information - the ACPI
 371    HID and UID values.  These can generally be found by using the EFI
 372    Boot Manager (in the EFI environment) to create a network boot
 373    entry, then using efibootmgr to print it verbosely.  Here's one example:
 374    <computeroutput>
 375      Boot003* Acpi(PNP0A03,0)/PCI(5|0)/Mac(00D0B7F9F510) \
 376         ACPI(a0341d0,0)PCI(0,5)MAC(00d0b7f9f510,0)
 377
 378    In this case, the ACPI HID is "0A0341d0" and the UID is "0".
 379    For the zx2000 gigE, the HID is "222F" and the UID is "500".
 380    For the rx2000 gigE, the HID is "0002" and the UID is "100".
 381    </computeroutput>
 382    You create the boot entry with:
 383    <command>efibootmgr -c -i eth0 -H 222F -U 500 -L netboot</command>
 384         </para>
 385       </example>
 386     </listitem>
 387    </orderedlist>
 388   </refsect1>
 389
 390   <refsect1>
 391     <title>BUGS</title>
 392
 393     <para>Please direct any bugs, features, patches, etc. to Matt Domsch
 394       <email>Matt_Domsch@dell.com</email>.
 395     </para>
 396   </refsect1>
 397
 398   <refsect1>
 399     <title>AUTHOR</title>
 400       <para>This man page was generated by dann frazier &manemail; for the
 401         Debian GNU/Linux operating system, but may be used by others.</para>
 402   </refsect1>
 403
 404   <refsect1>
 405     <title>SEE ALSO</title>
 406
 407     <para>elilo(1)</para>
 408   </refsect1>
 409 </refentry>
 410
 411 <!-- Keep this comment at the end of the file
 412 Local variables:
 413 mode: sgml
 414 sgml-omittag:t
 415 sgml-shorttag:t
 416 sgml-minimize-attributes:nil
 417 sgml-always-quote-attributes:t
 418 sgml-indent-step:2
 419 sgml-indent-data:t
 420 sgml-parent-document:nil
 421 sgml-default-dtd-file:nil
 422 sgml-exposed-tags:nil
 423 sgml-local-catalogs:nil
 424 sgml-local-ecat-files:nil
 425 End:
 426 -->