2 .\" Copyright (c) 2017-2018 Netflix, Inc.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
7 .\" 1. Redistributions of source code must retain the above copyright
8 .\" notice, this list of conditions and the following disclaimer.
9 .\" 2. Redistributions in binary form must reproduce the above copyright
10 .\" notice, this list of conditions and the following disclaimer in the
11 .\" documentation and/or other materials provided with the distribution.
13 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
14 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
15 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
16 .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
17 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
18 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
19 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
20 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
21 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
22 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
32 .Nd manipulate the EFI Boot Manager
76 program manipulates how UEFI Boot Managers boot the system.
77 It can create and destroy methods for booting along with activating or
79 It can also change the defined order of boot methods.
80 It can create a temporary boot (BootNext) variable that references a
81 boot method to be tried once upon the next boot.
83 The UEFI standard defines how hosts may control what is used to
85 Each method is encapsulated within a persistent UEFI variable, stored
86 by the UEFI BIOS of the form
88 (where XXXX are uppercase hexadecimal digits).
89 These variables are numbered, each describing where to load the bootstrap
90 program from, and whether or not the method is active (used for booting,
91 otherwise the method will be skipped).
92 The order of these methods is controlled by another variable,
94 The currently booted method is communicated using
96 A global timeout can also be set.
99 requires that the kernel module
101 module be present or loaded to get and set these
102 non-volatile variables.
104 The following options are available:
109 boot entry, or the new entry when used with
115 .It Fl b -bootnum Ar bootnum
116 When creating or modifying an entry, use
119 When creating a new entry, fail if it already exists.
127 variable (aka method or entry).
129 Process but do not change any variables.
133 path to the ESP device, derived from the EFI variables
137 This is the ESP partition used by UEFI to boot the current
138 instance of the system.
141 is specified, the UEFI device path to the ESP is reported instead.
144 is specified, the mount point of the ESP is reported instead.
145 .It Fl f -fw-ui , Fl F -no-fw-ui
146 Set or clear the request to the system firmware to stop in its user
147 interface on the next boot.
148 .It Fl k -kernel Ar kernel
149 The path to and name of the kernel.
150 .It Fl l -loader Ar loader
151 The path to and name of the loader.
152 .It Fl L -label Ar label
153 An optional description for the method.
160 .It Fl N -delete-bootnext
164 .It Fl o -bootorder Ar bootorder
167 variable to the given comma delimited set of
169 The numbers are in hex to match
170 .Cm Boot Ns Em XXXX ,
171 but may omit leading zeros.
172 .It Fl t -set-timeout Ar timeout
173 Set the bootmenu timeout value.
174 .It Fl T -del-timeout
178 .It Fl u -efidev Ar unix-path
179 Displays the UEFI device path of
182 Display the device path of boot entries in the output.
185 To display the current
187 related variables in the system:
191 This will display the optional
195 (currently booted method), followed by the optional
199 that may be set, followed finally by all currently defined
201 variables, active or not.
204 augments this output with the disk partition uuids,
205 size/offset and device-path of the variable.
206 The flag will also include any unreferenced (by BootOrder) variables.
210 program can be used to create new EFI boot variables.
211 The following command may be used to create a new boot method, using
212 the EFI partition mounted under
214 mark the method active, using
215 the given loader and label the method
218 .Dl efibootmgr -a -c -l /boot/efi/EFI/freebsd/loader.efi -L FreeBSD-11
220 This will result in the next available bootnum being assigned to a
221 new UEFI boot variable, and given the label
225 .Dl Boot0009 FreeBSD-11
227 Note newly created boot entries are, by default, created inactive, hence
230 flag is specified above so that it will be considered for booting.
231 The active state is denoted by a '*' following the
234 They are also inserted into the first position of current
236 variable if it exists.
237 They must first be set to active before being considered available to attempt
238 booting from, else they are ignored.
240 .Dl efibootmgr -B -b 0009
242 Will delete the given boot entry Boot0009.
244 To set the given boot entry active:
246 .Dl efibootmgr -a -b 0009
248 To set a given boot entry to be used as the
250 variable, irrespective of its active state, use:
252 .Dl efibootmgr -n -b 0009
256 for the next reboot use:
258 .Dl efibootmgr -o 0009,0003,...
265 The Unified Extensible Firmware Interface Specification is available