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

   1 .\" This manpage has been automatically generated by docbook2man
   2 .\" from a DocBook document.  This tool can be found at:
   3 .\" <http://shell.ipoline.com/~elmert/comp/docbook2X/>
   4 .\" Please send any bug reports, improvements, comments, patches,
   5 .\" etc. to Steve Cheng <steve@ggi-project.org>.
   6 .TH "EFIBOOTMGR" "8" "11 August 2003" "" ""
   7 .SH NAME
   8 efibootmgr \- manipulate the EFI Boot Manager
   9 .SH SYNOPSIS
  10
  11 \fBefibootmgr\fR [ \fB-a\fR]  [ \fB-A\fR]  [ \fB-b \fIXXXX\fB\fR]  [ \fB-B \fIXXXX\fB\fR]  [ \fB-c\fR]  [ \fB-d \fIDISK\fB\fR]  [ \fB-e \fI1|3|-1\fB\fR]  [ \fB-E \fINUM\fB\fR]  [ \fB-g\fR]  [ \fB-H \fIXXXX\fB\fR]  [ \fB-i \fINAME\fB\fR]  [ \fB-l \fINAME\fB\fR]  [ \fB-L \fILABEL\fB\fR]  [ \fB-n \fIXXXX\fB\fR]  [ \fB-N\fR]  [ \fB-o \fIXXXX\fB,\fIYYYY\fB,\fIZZZZ\fB\fR\fI ...\fR]  [ \fB-O\fR]  [ \fB-p \fIPART\fB\fR]  [ \fB-q\fR]  [ \fB-t\fR]  [ \fB-u\fR]  [ \fB-U \fIXXXX\fB\fR]  [ \fB-v\fR]  [ \fB-V\fR]  [ \fB-w\fR]
  12
  13 .SH "DESCRIPTION"
  14 .PP
  15 \fBefibootmgr\fR is a userspace application used to
  16 modify the Intel Extensible Firmware Interface (EFI) Boot Manager.  This
  17 application can create and destroy boot entries, change the boot order,
  18 change the next running boot option, and more.
  19 .PP
  20 Details on the EFI Boot Manager are available from the EFI
  21 Specification, v1.02 or later, available from:
  22  <URL:http://developer.intel.com>
  23 .sp
  24 .RS
  25 .B "Note:"
  26 efibootmgr requires that the kernel support access to EFI
  27 non-volatile variables (through \fI/proc/efi/vars\fR).
  28 \fBmodprobe efivars\fR should do the trick.
  29 .RE
  30 .SH "OPTIONS"
  31 .PP
  32 The following is a list of options accepted by efibootmgr:
  33 .TP
  34 \fB-a | --active\fR
  35 Sets bootnum active
  36 .TP
  37 \fB-A | --inactive\fR
  38 Sets bootnum inactive
  39 .TP
  40 \fB-b | --bootnum \fIXXXX\fB\fR
  41 Modify Boot\fIXXXX\fR (hex)
  42 .TP
  43 \fB-B | --delete-bootnum\fR
  44 Delete bootnum (hex)
  45 .TP
  46 \fB-c | --create\fR
  47 Create new variable bootnum and add to bootorder
  48 .TP
  49 \fB-d | --disk \fIDISK\fB\fR
  50 The disk containing the loader (defaults to
  51 \fI/dev/sda\fR)
  52 .TP
  53 \fB-e | --edd \fI1|3|-1\fB\fR
  54 Force EDD 1.0 or 3.0 creation variables, or guess.
  55 .TP
  56 \fB-E | --device \fINUM\fB\fR
  57 EDD 1.0 device number (defaults to 0x80)
  58 .TP
  59 \fB-g | --gpt\fR
  60 Force disk with invalid PMBR to be treated as GPT
  61 .TP
  62 \fB-H | --acpi_hid \fIXXXX\fB\fR
  63 set the ACPI HID (used with \fB-i\fR)
  64 .TP
  65 \fB-i | --iface \fINAME\fB\fR
  66 create a netboot entry for the named interface
  67 .TP
  68 \fB-l | --loader \fINAME\fB\fR
  69 Specify a loader (defaults to \fI\\\\elilo.efi\fR)
  70 .TP
  71 \fB-L | --label \fILABEL\fB\fR
  72 Boot manager display label (defaults to "Linux")
  73 .TP
  74 \fB-n | --bootnext \fIXXXX\fB\fR
  75 Set BootNext to XXXX (hex)
  76 .TP
  77 \fB-N | --delete-bootnext\fR
  78 Delete BootNext
  79 .TP
  80 \fB-o | --bootorder \fIXXXX\fB,\fIYYYY\fB,\fIZZZZ\fB\fR
  81 Explicitly set BootOrder (hex)
  82 .TP
  83 \fB-O | --delete-bootorder\fR
  84 Delete BootOrder
  85 .TP
  86 \fB-p | --part \fIPART\fB\fR
  87 Partition number containing the bootloader (defaults to 1)
  88 .TP
  89 \fB-q | --quiet\fR
  90 Quiet mode - supresses output.
  91 .TP
  92 \fB-t | --test \fIfilename\fB\fR
  93 Don't write to NVRAM, write to \fIfilename\fR.
  94 .TP
  95 \fB-u | --unicode | --UCS-2 \fR
  96 pass extra command line arguments as UCS-2 (default is
  97 ASCII)
  98 .TP
  99 \fB-U | --acpi_uid \fIXXXX\fB\fR
 100 set the ACPI UID (used with \fB-i\fR)
 101 .TP
 102 \fB-v | --verbose\fR
 103 Verbose mode - prints additional information
 104 .TP
 105 \fB-V | --version\fR
 106 Just print version string and exit.
 107 .TP
 108 \fB-w | --write-signature\fR
 109 write unique signature to the MBR if needed
 110 .SH "EXAMPLES"
 111 .TP 1.
 112 .SS "DISPLAYING THE CURRENT SETTINGS (MUST BE ROOT)."
 113 .PP
 114 [root@localhost ~]# efibootmgr
 115 BootCurrent: 0004
 116 BootNext: 0003
 117 BootOrder: 0004,0000,0001,0002,0003
 118 Boot0000* Diskette Drive(device:0)
 119 Boot0001* CD-ROM Drive(device:FF)
 120 Boot0002* Hard Drive(Device:80)/HD(Part1,Sig00112233)
 121 Boot0003* PXE Boot: MAC(00D0B7C15D91)
 122 Boot0004* Linux
 123 .PP
 124 This shows:
 125 .RS
 126 .TP 0.2i
 127 \(bu
 128 BootCurrent - the boot entry used to start the currently
 129 running system
 130 .TP 0.2i
 131 \(bu
 132 BootOrder - the boot order as would appear in the boot manager.
 133 The boot manager tries to boot the first active entry in this
 134 list.  If unsuccessful, it tries the next entry, and so on.
 135 .TP 0.2i
 136 \(bu
 137 BootNext - the boot entry which is scheduled to be run on next
 138 boot.  This supercedes BootOrder for one boot only, and is
 139 deleted by the boot manager after first use.  This allows you
 140 to change the next boot behavior without changing BootOrder.
 141 .TP 0.2i
 142 \(bu
 143 Five boot entries (0000 - 0004), along with the active/inactive
 144 flag (* means active) and the name displayed on the screen.
 145 .RE
 146 .TP 2.
 147 .SS "CREATING A NEW BOOT OPTION"
 148 .PP
 149 An OS installer would call \fBefibootmgr -c\fR.
 150 This assumes that \fI/boot/efi\fR is your EFI System
 151 Partition, and is mounted at \fI/dev/sda1\fR.  This
 152 creates a new boot option, called "Linux", and puts it at the top of
 153 the boot order list.  Options may be passed to modify the default
 154 behavior.  The default OS Loader is \fIelilo.efi\fR.
 155 .TP 3.
 156 .SS "CHANGING THE BOOT ORDER"
 157 .PP
 158 Assuming the configuration in Example #1,
 159 \fBefibootmgr -o 3,4\fR could be called to specify
 160 PXE boot first, then Linux boot.
 161 .TP 4.
 162 .SS "CHANGING THE BOOT ORDER FOR THE NEXT BOOT ONLY"
 163 .PP
 164 Assuming the configuration in Example #1,
 165 \fBefibootmgr -n 4\fR could be called to specify
 166 that the Linux entry be taken on next boot.
 167 .TP 5.
 168 .SS "DELETING A BOOT OPTION"
 169 .PP
 170 Assuming the configuration in Example #1,
 171 \fBefibootmgr -b 4 -B\fR could be called to delete
 172 entry 4 and remove it from the BootOrder.
 173 .TP 6.
 174 .SS "CREATING NETWORK BOOT ENTRIES"
 175 .PP
 176 A system administrator wants to create a boot option to network
 177 boot (PXE).  Unfortunately, this requires knowing a little more
 178 information about your system than can be easily found by
 179 efibootmgr, so you've got to pass additional information - the ACPI
 180 HID and UID values.  These can generally be found by using the EFI
 181 Boot Manager (in the EFI environment) to create a network boot
 182 entry, then using efibootmgr to print it verbosely.  Here's one example:
 183 Boot003* Acpi(PNP0A03,0)/PCI(5|0)/Mac(00D0B7F9F510) \\
 184 ACPI(a0341d0,0)PCI(0,5)MAC(00d0b7f9f510,0)
 185 In this case, the ACPI HID is "0A0341d0" and the UID is "0".
 186 For the zx2000 gigE, the HID is "222F" and the UID is "500".
 187 For the rx2000 gigE, the HID is "0002" and the UID is "100".
 188 You create the boot entry with:
 189 \fBefibootmgr -c -i eth0 -H 222F -U 500 -L netboot\fR
 190 .SH "BUGS"
 191 .PP
 192 Please direct any bugs, features, patches, etc. to Matt Domsch
 193 <Matt_Domsch@dell.com>.
 194 .SH "AUTHOR"
 195 .PP
 196 This man page was generated by dann frazier <dannf@debian.org> for the
 197 Debian GNU/Linux operating system, but may be used by others.
 198 .SH "SEE ALSO"
 199 .PP
 200 elilo(1)