2 |
|
|
3 |
.SH NAME |
.SH NAME |
4 |
|
|
5 |
grubby \- command line tool used to configure bootloader menu entries across multiple architectures |
grubby \- command line tool used to configure bootloader menu entries across |
6 |
|
multiple architectures |
7 |
|
|
8 |
.SH SYNOPSIS |
.SH SYNOPSIS |
9 |
|
|
10 |
\fBgrubby\fR [\fIOPTIONS...\fR] |
\fBgrubby\fR [\fIOPTIONS\fR] |
11 |
|
|
12 |
.SH DESCRIPTION |
.SH DESCRIPTION |
13 |
|
|
29 |
and their \fBzipl\fR bootloader are fully supported. |
and their \fBzipl\fR bootloader are fully supported. |
30 |
|
|
31 |
Support for \fByaboot\fR has been deprecated as all ppc architecture |
Support for \fByaboot\fR has been deprecated as all ppc architecture |
32 |
hardware since the Power8 system uses \fBgrub2\fR or petitboot |
hardware since the Power8 uses \fBgrub2\fR or petitboot |
33 |
which both use the grub2 configuration file format. |
which both use the grub2 configuration file format. |
34 |
|
|
35 |
Legacy bootloaders \fBLILO\fR, \fBSILO\fR, and \fBELILO\fR |
Legacy bootloaders \fBLILO\fR, \fBSILO\fR, and \fBELILO\fR |
36 |
are deprecated in favor of previously mentioned bootloaders. The |
are deprecated and no longer receiving active support in favor of |
37 |
\fBSILO\fR bootloader should also be considered unsupported. |
previously mentioned bootloaders. |
38 |
|
|
39 |
.SS Default Behavior |
.SS Default Behavior |
40 |
|
|
41 |
The default architecture is chosen at compile time. The grubby executable |
The default bootloader target is primarily determined by the architecture |
42 |
has a series of built in assumptions about what bootloader is being used and |
for which grubby has been built. Each architecture has a preferred |
43 |
where its configuration file lives. If no output format option is specified |
bootloader, and each bootloader has its own configuration file. If no |
44 |
on the command line then grubby will use these default settings to first |
bootloader is selected on the command line, grubby will use these default |
45 |
search for an existing configuration and, if it is not found, assume that |
settings to search for an existing configuration. If no bootloader |
46 |
it should be placed in the standard location. These default assumptions are |
configuration file is found, grubby will use the default value for that |
47 |
listed in the table below. |
architecture. These defaults are listed in the table below. |
48 |
|
|
49 |
.TS |
.TS |
50 |
allbox; |
allbox; |
82 |
the boot entry must be set using \fB-\-title\fR. Most invocations should also |
the boot entry must be set using \fB-\-title\fR. Most invocations should also |
83 |
include \fB-\-initrd\fR with memtest86 as a notable exception. |
include \fB-\-initrd\fR with memtest86 as a notable exception. |
84 |
|
|
85 |
The \fB-\-update-kernel\fR |
The \fB-\-update-kernel\fR option may not be used in the same invocation. |
|
option may not be used in the same invocation. |
|
86 |
|
|
87 |
.TP |
.TP |
88 |
\fB-\-remove-kernel\fR=\fIkernel-path\fR |
\fB-\-remove-kernel\fR=\fIkernel-path\fR |
89 |
Removes all boot entries which match \fIkernel-path\fR. This may be used |
Remove all boot entries which match \fIkernel-path\fR. This may be used |
90 |
along with \fB-\-add-kernel\fR, in which case the new kernel being added will |
along with \fB-\-add-kernel\fR, in which case the new entry being added will |
91 |
never be removed. |
not be removed. |
92 |
|
|
93 |
.TP |
.TP |
94 |
\fB-\-update-kernel\fR=\fIkernel-path\fR |
\fB-\-update-kernel\fR=\fIkernel-path\fR |
95 |
The entries for kernels matching \fRkernel-path\fR are updated. Currently |
Update the entries for kernels matching \fRkernel-path\fR. Currently |
96 |
the only items that can be updated is the kernel argument list, which is |
the only item that can be updated is the kernel argument list, which is |
97 |
modified via the \fB-\-args\fR and \fB-\-remove-args\fR options. |
modified via the \fB-\-args\fR and \fB-\-remove-args\fR options. |
98 |
|
|
99 |
.TP |
.TP |
135 |
|
|
136 |
.TP |
.TP |
137 |
\fB-\-efi\fR |
\fB-\-efi\fR |
138 |
Use linuxefi and initrdefi when constructing bootloader stanzas instead of linux and initrd. |
Use appropriate bootloader commands for EFI on this architecture. |
139 |
|
|
140 |
.TP |
.TP |
141 |
\fB-\-set-default\fR=\fIkernel-path\fR |
\fB-\-set-default\fR=\fIkernel-path\fR |
188 |
|
|
189 |
.TP |
.TP |
190 |
\fB-\-bootloader-probe\fR |
\fB-\-bootloader-probe\fR |
191 |
|
Attempt to probe for installed bootloaders. If this option is specified, |
192 |
\fBgrubby\fR tries to determine if \fBgrub\fR or \fBlilo\fR is currently |
\fBgrubby\fR tries to determine if \fBgrub\fR or \fBlilo\fR is currently |
193 |
installed. When one of those bootloaders is found the name of that bootloader |
installed. When one of those bootloaders is found the name of that |
194 |
is displayed on stdout. Both could be installed (on different devices), and |
bootloader is displayed on stdout. Both could be installed (on different |
195 |
grubby will print out the names of both bootloaders, one per line. The probe |
devices), and grubby will print out the names of both bootloaders, one per |
196 |
for \fBgrub\fR requires a commented out boot directive \fBgrub.conf\fR |
line. The probe for \fBgrub\fR requires a commented out boot directive |
197 |
identical to the standard directive in the lilo configuration file. If this |
\fBgrub.conf\fR identical to the standard directive in the lilo |
198 |
is not present \fBgrubby\fR will assume grub is not installed (note |
configuration file. If this is not present \fBgrubby\fR will assume grub is |
199 |
that \fBanaconda\fR places this directive in \fBgrub.conf\fR files it creates). |
not installed (note that \fBanaconda\fR places this directive in |
200 |
|
\fBgrub.conf\fR files it creates). |
201 |
|
|
202 |
\fIThis option is only available on i386 platforms.\fR |
\fIThis option is only available on x86 BIOS platforms.\fR |
203 |
|
|
204 |
.TP |
.TP |
205 |
\fB-v\fR, \fB-\-version\fR |
\fB-v\fR, \fB-\-version\fR |
215 |
|
|
216 |
.TP |
.TP |
217 |
\fB-\-elilo\fR |
\fB-\-elilo\fR |
218 |
Use an \fBelilo\fR style configuration file. This is the default on ia64 platforms. This format is deprecated. |
Use an \fBelilo\fR style configuration file. This is the default on ia64 |
219 |
|
platforms. This format is deprecated. |
220 |
|
|
221 |
.TP |
.TP |
222 |
\fB-\-extlinux\fR |
\fB-\-extlinux\fR |
224 |
|
|
225 |
.TP |
.TP |
226 |
\fB-\-grub\fR |
\fB-\-grub\fR |
227 |
Use a \fBgrub\fR style configuration file. This is the default on ia32 platforms. |
Use a \fBgrub\fR style configuration file. This is the default on the i386 |
228 |
|
architecture. |
229 |
|
|
230 |
.TP |
.TP |
231 |
\fB-\-grub2\fR |
\fB-\-grub2\fR |
232 |
Use a \fBgrub2\fR style configuration file. This is the default on \fBx86_64\fR |
Use a \fBgrub2\fR style configuration file. This is the default on |
233 |
architecture as well as the \fBppc64\fR and \fBppc64le\fR architectures |
\fBx86_64\fR architecture as well as the \fBppc64\fR and \fBppc64le\fR |
234 |
running on Power8 or later hardware. |
architectures running on Power8 or later hardware. |
235 |
|
|
236 |
.TP |
.TP |
237 |
\fB-\-lilo\fR |
\fB-\-lilo\fR |
239 |
|
|
240 |
.TP |
.TP |
241 |
\fB-\-silo\fR |
\fB-\-silo\fR |
242 |
Use a \fBsilo\fR style configuration file. This is the default on SPARC systems. This format is legacy, deprecated, and unsupported. |
Use a \fBsilo\fR style configuration file. This is the default on SPARC |
243 |
|
systems. This format is legacy, deprecated, and unsupported. |
244 |
|
|
245 |
.TP |
.TP |
246 |
\fB-\-yaboot\fR |
\fB-\-yaboot\fR |
291 |
|
|
292 |
.TP |
.TP |
293 |
\fB-\-devtreedir\fR=\fIfile_path\fR |
\fB-\-devtreedir\fR=\fIfile_path\fR |
294 |
Use the specified \fIfile path\fR to load the devicetree definition. This is for |
Use the specified \fIfile path\fR to load the devicetree definition. This is |
295 |
platforms where a flat file is used instead of firmware to instruct the kernel |
for platforms where a flat file is used instead of firmware to instruct the |
296 |
how to communicate with devices. |
kernel how to communicate with devices. |
297 |
|
|
298 |
.SS Multiboot Options |
.SS Multiboot Options |
299 |
|
|
346 |
menu_index Index number of a menu entry |
menu_index Index number of a menu entry |
347 |
.TE |
.TE |
348 |
|
|
349 |
The examples below quote strings that may have spaces or other whitespace in them. It is also |
The examples below quote strings that may have spaces or other whitespace in |
350 |
perfectly valid to backslash escape these strings if that is more convenient. |
them. It is also perfectly valid to backslash escape these strings if that |
351 |
|
is more convenient. |
352 |
|
|
353 |
.PP |
.PP |
354 |
Add a new kernel entry and copy all options from the current default kernel. This is the behavior |
Add a new kernel entry and copy all options from the current default kernel. |
355 |
that most users will want. |
This is the behavior that most users will want. |
356 |
.IP |
.IP |
357 |
\fBgrubby\fR --add-kernel=\fInew_kernel\fR --title="\fIentry_title\fR" --initrd="\fInew_initrd\fR" --copy-default |
\fBgrubby\fR --add-kernel=\fInew_kernel\fR --title="\fIentry_title\fR" --initrd="\fInew_initrd\fR" --copy-default |
358 |
.PP |
.PP |
364 |
.IP |
.IP |
365 |
\fBgrubby\fR --remove-kernel=\fIold_kernel\fR |
\fBgrubby\fR --remove-kernel=\fIold_kernel\fR |
366 |
.PP |
.PP |
367 |
Target a single menu entry to remove without targetting other entries with the same kernel. |
Target a single menu entry to remove without targetting other entries with |
368 |
|
the same kernel. |
369 |
.IP |
.IP |
370 |
\fBgrubby\fR --info=\fIold_kernel\fR |
\fBgrubby\fR --info=\fIold_kernel\fR |
371 |
|
|
372 |
\fBgrubby\fR --remove-kernel=\fImenu_index\fR |
\fBgrubby\fR --remove-kernel=\fImenu_index\fR |
373 |
.PP |
.PP |
374 |
Update the arguments for all entries of a specific kernel. New arguments get added while existing arguments get updated values. |
Update the arguments for all entries of a specific kernel. New arguments get |
375 |
|
added while existing arguments get updated values. |
376 |
.IP |
.IP |
377 |
\fBgrubby\fR --update-kernel=\fIcurrent_kernel\fR --args="\fIkernel_args\fR" |
\fBgrubby\fR --update-kernel=\fIcurrent_kernel\fR --args="\fIkernel_args\fR" |
378 |
.PP |
.PP |