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
27 .Dd September 24, 2019
32 .Nd manipulate the EFI Boot Manager
70 manipulates how UEFI Boot Managers boot the system.
71 Methods of booting can be created and destroyed.
72 Boot methods can be activated or deactivated.
73 The order of boot methods tried can be changed.
74 Temporary boot methods can override the usual booting methods.
76 The UEFI standard defines how hosts may control what is used to
78 Each method is encapsulated within a persistent UEFI variable, stored
79 by the UEFI BIOS of the form
81 These variables are numbered, describe where to load the bootstrap
82 program from, and whether or not the method is active.
83 The boot order of these methods is controlled by another variable
85 The currently booting method is communicated using
87 A global timeout can also be set.
90 requires that the kernel efirt module be loaded to get and set these
91 non-volatile variables.
93 The following options are available:
98 boot entry, or the new entry when used with
104 .It Fl b -bootnum Ar bootnum
105 When creating or modifying an entry, use
108 When creating a new entry, fail if it already exists.
118 Process but do not change any variables.
122 path to the ESP device, derived from the EFI variables
126 This is the ESP partition used by UEFI to boot the current
127 instance of the system.
130 is specified, the UEFI device path to the ESP is reported instead.
133 is specified, the mount point of the ESP is reported instead.
134 .It Fl k -kernel Ar kernel
135 The path to and name of the kernel.
136 .It Fl l -loader Ar loader
137 The path to and name of the loader.
138 .It Fl L -label Ar label
139 An optional description for the entry.
146 .It Fl N -delete-bootnext
150 .It Fl o -bootorder Ar bootorder
153 variable to the given comma delimited set of
155 The numbers are in hex to match
156 .Cm Boot Ns Em XXXX ,
157 but may omit leading zeros.
158 .It Fl t -set-timeout Ar timeout
159 Set the bootmenu timeout value.
160 .It Fl T -del-timeout
165 Display the device path of boot entries in the output.
168 To display the current
170 related variables in the system:
174 This will display the optional
178 or currently booted bootnum, followed by the optional
182 that may be set, followed finally by all currently defined
184 variables, active or not.
185 The verbose flag will augment this output with the disk partition uuids,
186 size/offset and device-path of the variable.
190 program can be used to create new EFI boot variables.
191 To create a new boot var pointing to an installation with its EFI partition
194 the given loader and a label
197 .Dl efibootmgr -c -l /mnt/EFI/freebsd/loader.efi -L FreeBSD-11
199 This will result in the next available bootnum being assigned to a
200 new UEFI boot variable, and given the label
204 .Dl Boot0009 FreeBSD-11
206 Note newly created boot entries are created inactive.
207 The active state is denoted by an '*' following the
210 They are also inserted into the first position of current
212 variable if it exists.
213 They must first be set to active before being considered available to attempt
214 booting from, else they are ignored.
216 .Dl efibootmgr -B -b 0009
218 Will delete the given boot entry Boot0009.
220 To set a given newly created boot entry active use:
222 .Dl efibootmgr -a -b 0009
224 To set a given boot entry to be used as the
226 variable, irrespective of its active state, use:
228 .Dl efibootmgr -n -b 0009
232 for the next reboot use:
234 .Dl efibootmgr -o 0009,0003,...