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