trunk/grubby/grubby.8

.TH GRUBBY 8 "Tue Jan 18 2005"

.SH NAME

grubby \- command line tool used to configure bootloader menu entries across multiple architectures

.SH SYNOPSIS

\fBgrubby\fR [\fIOPTIONS...\fR]

.SH DESCRIPTION

.SS General Information

\fBgrubby\fR is a command line tool for updating and displaying information
about the configuration files for various architecture specific bootloaders.
It is primarily designed to be used from scripts which install new kernels
and need to find information about the current boot environment.

.SS Architecture Support

The \fBgrubby\fR executable has full support for the \fBgrub2\fR
bootloader on \fBx86_64\fR systems using legacy BIOS or modern
UEFI firmware and \fBppc64\fR and \fBppc64le\fR hardware using
OPAL or SLOF as firmware.

Legacy \fBs390\fR and the current \fBs390x\fR architectures
and their \fBzipl\fR bootloader are fully supported.

Support for \fByaboot\fR has been deprecated as all ppc architecture
hardware since the Power8 system uses \fBgrub2\fR or petitboot
which both use the grub2 configuration file format.

Legacy bootloaders \fBLILO\fR, \fBSILO\fR, and \fBELILO\fR
are deprecated in favor of previously mentioned bootloaders. The
\fBSILO\fR bootloader should also be considered unsupported.

.SS Default Behavior

The default architecture is chosen at compile time. The grubby executable
has a series of built in assumptions about what bootloader is being used and
where its configuration file lives. If no output format option is specified
on the command line then grubby will use these default settings to first
search for an existing configuration and, if it is not found, assume that
it should be placed in the standard location. These default assumptions are
listed in the table below.

.TS
allbox;
lbw6 lbw10 lbw18
l l l.
 Arch	Bootloader	Configuration File
 x86_64 [BIOS]	grub2	/boot/grub2/grub.cfg
 x86_64 [UEFI]	grub2	/boot/efi/EFI/redhat/grub.cfg
 i386	grub2	/boot/grub2/grub.cfg
 ia64	elilo	/boot/efi/EFI/redhat/elilo.conf
 ppc [>=Power8]	grub2	/boot/grub2/grub.cfg
 ppc [<=Power7]	yaboot	/etc/yaboot.conf
 s390	zipl	/etc/zipl.conf
 s390x	zipl	/etc/zipl.conf
.TE


.SS Special Arguments

There are a number of ways to specify the kernel used for \fB-\-info\fR,
\fB-\-remove-kernel\fR, and \fB-\-update-kernel\fR. Specifying \fBDEFAULT\fR
or \fBALL\fR selects the default entry and all of the entries, respectively.
If a comma separated list of numbers is given, the boot entries indexed
by those numbers are selected. Finally, the title of a boot entry may
be specified by using \fBTITLE=\fItitle\fR as the argument; all entries
with that title are used.

.SH OPTIONS

.SS Basic Options

.TP
\fB-\-add-kernel\fR=\fIkernel-path\fR
Add a new boot entry for the kernel located at \fIkernel-path\fR. A title for
the boot entry must be set using \fB-\-title\fR. Most invocations should also
include \fB-\-initrd\fR with memtest86 as a notable exception.

The \fB-\-update-kernel\fR
option may not be used in the same invocation. 

.TP
\fB-\-remove-kernel\fR=\fIkernel-path\fR
Removes all boot entries which match \fIkernel-path\fR. This may be used
along with \fB-\-add-kernel\fR, in which case the new kernel being added will
never be removed.

.TP
\fB-\-update-kernel\fR=\fIkernel-path\fR
The entries for kernels matching \fRkernel-path\fR are updated. Currently
the only items that can be updated is the kernel argument list, which is
modified via the \fB-\-args\fR and \fB-\-remove-args\fR options.

.TP
\fB-\-args\fR=\fIkernel-args\fR
When a new kernel is added, this specifies the command line arguments
which should be passed to the kernel by default (note they are merged
with the arguments from the template if \fB-\-copy-default\fR is used).
When \fB-\-update-kernel\fR is used, this specifies new arguments to add
to the argument list. Multiple, space separated arguments may be used. If
an argument already exists the new value replaces the old values. The
\fBroot=\fR kernel argument gets special handling if the configuration
file has special handling for specifying the root filesystem (like
lilo.conf does).

.TP
\fB-\-remove-args\fR=\fIkernel-args\fR
The arguments specified by \fIkernel-args\fR are removed from the
kernels specified by \fB-\-update-kernel\fR. The \fBroot\fR argument
gets special handling for configuration files that support separate root
filesystem configuration.

.TP
\fB-\-copy-default\fR
\fBgrubby\fR will copy as much information (such as kernel arguments and
root device) as possible from the current default kernel. The kernel path
and initrd path will never be copied.

.TP
\fB-\-title\fR=\fIentry-title\fR
When a new kernel entry is added \fIentry-title\fR is used as the title
(\fBlilo\fR label) for the entry. If \fIentry-title\fR is longer then maximum
length allowed by the bootloader (15 for lilo, unlimited for grub and elilo)
the title is shortened to a (unique) entry.

.TP
\fB-\-initrd\fR=\fIinitrd-path\fR
Use \fIinitrd-path\fR as the path to an initial ram disk for a new kernel
being added.

.TP
\fB-\-efi\fR
Use linuxefi and initrdefi when constructing bootloader stanzas instead of linux and initrd.

.TP
\fB-\-set-default\fR=\fIkernel-path\fR
The first entry which boots the specified kernel is made the default
boot entry. This may not be invoked with \fB-\-set-default-index\fR.

.TP
\fB-\-set-default-index\fR=\fIentry-index\fR
Makes the given entry number the default boot entry. This may not
be invoked with \fB-\-set-default\fR.

.TP
\fB-\-make-default\fR
Make the new kernel entry being added the default entry.

.TP
\fB-\-set-index\fR=\fIentry-index\fR
Set the position at which to add a new entry created with \fB-\-add-kernel\fR.

.TP
\fB-\-debug\fR
Display extra debugging information for failures.

.TP
\fB-i\fR, \fB-\-extra-initrd\fR=\fIinitrd-path\fR
Use \fIinitrd-path\fR as the path for an auxiliary initrd image.

.SS Display Options

Passing the display option to grubby will cause it to print out the
requested information about the current bootloader configuration and
then immediately exit.  These options should not be used in any
script intended to update the bootloader configuration.

.TP
\fB-\-default-kernel\fR
Display the full path to the current default kernel and exit.

.TP
\fB-\-default-index\fR
Display the numeric index of the current default boot entry and exit.

.TP
\fB-\-default-title\fR
Display the title of the current default boot entry and exit.

.TP
\fB-\-info\fR=\fIkernel-path\fR
Display information on all boot entries which match \fIkernel-path\fR. I

.TP
\fB-\-bootloader-probe\fR
\fBgrubby\fR tries to determine if \fBgrub\fR or \fBlilo\fR is currently
installed. When one of those bootloaders is found the name of that bootloader
is displayed on stdout.  Both could be installed (on different devices), and
grubby will print out the names of both bootloaders, one per line. The probe
for \fBgrub\fR requires a commented out boot directive \fBgrub.conf\fR
identical to the standard directive in the lilo configuration file. If this
is not present \fBgrubby\fR will assume grub is not installed (note
that \fBanaconda\fR places this directive in \fBgrub.conf\fR files it creates).

\fIThis option is only available on i386 platforms.\fR

.TP
\fB-v\fR, \fB-\-version\fR
Display the version of \fBgrubby\fR being run and then exit immediately.

.SS Output Format Options

Sane default options for the current platform are compiled into grubby on
a per platform basis. These defaults determine the format and layout of
the generated bootloader configuration file. A different configuration file
format may be specified on the command line if the system uses a supported
alternative bootloader.

.TP
\fB-\-elilo\fR
Use an \fBelilo\fR style configuration file. This is the default on ia64 platforms. This format is deprecated.

.TP
\fB-\-extlinux\fR
Use an \fBextlinux\fR style configuration file. This format is deprecated.

.TP
\fB-\-grub\fR
Use a \fBgrub\fR style configuration file. This is the default on ia32 platforms.

.TP
\fB-\-grub2\fR
Use a \fBgrub2\fR style configuration file. This is the default on \fBx86_64\fR
architecture as well as the \fBppc64\fR and \fBppc64le\fR architectures
running on Power8 or later hardware.

.TP
\fB-\-lilo\fR
Use a \fBlilo\fR style configuration file.

.TP
\fB-\-silo\fR
Use a \fBsilo\fR style configuration file. This is the default on SPARC systems. This format is legacy, deprecated, and unsupported.

.TP
\fB-\-yaboot\fR
Use a \fByaboot\fR style configuration file. This is the default for
the \fBppc\fR architecture on on Power7 and earlier hardware.

.TP
\fB-\-zipl\fR
Use a \fBzipl\fR style configuration file. This is the default on the
legacy s390 and current s390x architectures.

.SS Override Options

.TP
\fB-\-bad-image-okay\fR
When \fBgrubby\fR is looking for a entry to use for something (such
as a template or a default boot entry) it uses sanity checks, such as
ensuring that the kernel exists in the filesystem, to make sure
entries that obviously won't work aren't selected. This option overrides
that behavior, and is designed primarily for testing.

.TP
\fB-\-boot-filesystem\fR=\fIbootfs\fR
The \fBgrub\fR boot loader expects file paths listed in its configuration
path to be relative to the top of the filesystem they are on, rather then
relative to the current root filesystem. By default \fBgrubby\fR searches
the list of currently mounted filesystems to determine this. If this option
is given \fBgrubby\fR acts as if the specified filesystem was the filesystem
containing the kernel (this option is designed primarily for testing).

.TP
\fB-\-env\fR=\fIpath\fR
Path for the file where grub environment data is stored.

.TP
\fB-c\fR, \fB-\-config-file\fR=\fIpath\fR
Use \fIpath\fR as the configuration file rather then the default.

.TP
\fB-o\fR, \fB-\-output-file\fR=\fIfile_path\fR
The destination path for the updated configuration file. Use "-" to
send it to stdout.

.TP
\fB-\-devtree\fR=\fIfile_path\fR
Use \fIpath\fR for device tree path in place of the path of any devicetree
directive found in the template stanza.

.TP
\fB-\-devtreedir\fR=\fIfile_path\fR
Use the specified \fIfile path\fR to load the devicetree definition. This is for
platforms where a flat file is used instead of firmware to instruct the kernel
how to communicate with devices.

.SS Multiboot Options

The Multiboot Specification provides a generic interface for boot
loaders and operating systems.  It is supported by the GRUB bootloader.

.TP
\fB-\-add-multiboot\fR=\fImultiboot-path\fR
Add a new boot entry for the multiboot kernel located at
\fImultiboot-path\fR.  Note that this is generally accompanied with a
\fB--add-kernel\fR option.

.TP
\fB-\-remove-multiboot\fR=\fImultiboot-path\fR
Removes all boot entries which match \fImultiboot-path\fR.

.TP
\fB-\-mbargs\fR=\fImultiboot-args\fR
When a new multiboot kernel is added, this specifies the command line
arguments which should be passed to that kernel by default
When \fB-\-update-kernel\fR is used, this specifies new arguments to add
to the argument list. Multiple, space separated arguments may be used. If
an argument already exists the new value replaces the old values.

.TP
\fB-\-remove-mbargs\fR=\fImultiboot-args\fR
The arguments specified by \fImultiboot-args\fR are removed from the
kernels specified by \fB-\-update-kernel\fR.

.SH "BUGS"

The command line syntax is more than a little baroque. This probably
won't be fixed as \fBgrubby\fR is only intended to be called from shell
scripts which can get it right.

.SH EXAMPLE

The following examples assume the following:

.TS
allbox;
rbw15 l.
cfg_file	Full path to bootloader config file
new_kernel	Full path to kernel image to be installed
old_kernel	Full path to old kernel image to be removed
current_kernel	Full path to a currently installed kernel
entry_title	Title that appears on bootloader menu
new_initrd	Full path to initrd for a new kernel
kernel_args	Set of arguments for the kernel
menu_index	Index number of a menu entry
.TE

The examples below quote strings that may have spaces or other whitespace in them. It is also
perfectly valid to backslash escape these strings if that is more convenient.

.PP
Add a new kernel entry and copy all options from the current default kernel. This is the behavior
that most users will want.
.IP
\fBgrubby\fR --add-kernel=\fInew_kernel\fR --title="\fIentry_title\fR" --initrd="\fInew_initrd\fR" --copy-default
.PP
Add a new kernel entry with custom arguments
.IP
\fBgrubby\fR --add-kernel=\fInew_kernel\fR --title="\fIentry_title\fR" --initrd="\fInew_initrd\fR" --args=\fIkernel_args\fR
.PP
Remove \fBall menu entries\fR for a specified kernel.
.IP
\fBgrubby\fR --remove-kernel=\fIold_kernel\fR
.PP
Target a single menu entry to remove without targetting other entries with the same kernel.
.IP
\fBgrubby\fR --info=\fIold_kernel\fR

\fBgrubby\fR --remove-kernel=\fImenu_index\fR
.PP
Update the arguments for all entries of a specific kernel. New arguments get added while existing arguments get updated values.
.IP
\fBgrubby\fR --update-kernel=\fIcurrent_kernel\fR --args="\fIkernel_args\fR"
.PP
Remove the arguments for a single entry of a specific kernel.
.IP
\fBgrubby\fR --info=\fIcurrent_kernel\fR

\fBgrubby\fR --remove-args=\fImenu_index\fR --args="\fIkernel_args\fR"

.SH "SEE ALSO"

.BR grub (8),
.BR lilo (8),
.BR yaboot (8),
.BR zipl (8),
.BR dracut (8),
.BR mkinitrd (8)

.SH AUTHORS

.nf
Erik Troan
Jeremy Katz
Peter Jones
Robert Marshall
.fi
1	niro	532	.TH GRUBBY 8 "Tue Jan 18 2005"
2	niro	3012
3	niro	532	.SH NAME
4	niro	3012
5	niro	3013	grubby \- command line tool used to configure bootloader menu entries across multiple architectures
6	niro	532
7			.SH SYNOPSIS
8	niro	3012
9	niro	3013	\fBgrubby\fR [\fIOPTIONS...\fR]
10	niro	532
11			.SH DESCRIPTION
12	niro	3012
13			.SS General Information
14
15	niro	532	\fBgrubby\fR is a command line tool for updating and displaying information
16	niro	3013	about the configuration files for various architecture specific bootloaders.
17			It is primarily designed to be used from scripts which install new kernels
18			and need to find information about the current boot environment.
19	niro	532
20	niro	3012	.SS Architecture Support
21
22	niro	3013	The \fBgrubby\fR executable has full support for the \fBgrub2\fR
23			bootloader on \fBx86_64\fR systems using legacy BIOS or modern
24			UEFI firmware and \fBppc64\fR and \fBppc64le\fR hardware using
25			OPAL or SLOF as firmware.
26	niro	532
27	niro	3013	Legacy \fBs390\fR and the current \fBs390x\fR architectures
28			and their \fBzipl\fR bootloader are fully supported.
29
30			Support for \fByaboot\fR has been deprecated as all ppc architecture
31			hardware since the Power8 system uses \fBgrub2\fR or petitboot
32			which both use the grub2 configuration file format.
33
34			Legacy bootloaders \fBLILO\fR, \fBSILO\fR, and \fBELILO\fR
35			are deprecated in favor of previously mentioned bootloaders. The
36			\fBSILO\fR bootloader should also be considered unsupported.
37
38			.SS Default Behavior
39
40			The default architecture is chosen at compile time. The grubby executable
41			has a series of built in assumptions about what bootloader is being used and
42			where its configuration file lives. If no output format option is specified
43			on the command line then grubby will use these default settings to first
44			search for an existing configuration and, if it is not found, assume that
45			it should be placed in the standard location. These default assumptions are
46			listed in the table below.
47
48			.TS
49			allbox;
50			lbw6 lbw10 lbw18
51			l l l.
52			Arch Bootloader Configuration File
53			x86_64 [BIOS] grub2 /boot/grub2/grub.cfg
54			x86_64 [UEFI] grub2 /boot/efi/EFI/redhat/grub.cfg
55			i386 grub2 /boot/grub2/grub.cfg
56			ia64 elilo /boot/efi/EFI/redhat/elilo.conf
57			ppc [>=Power8] grub2 /boot/grub2/grub.cfg
58			ppc [<=Power7] yaboot /etc/yaboot.conf
59			s390 zipl /etc/zipl.conf
60			s390x zipl /etc/zipl.conf
61			.TE
62
63
64	niro	3012	.SS Special Arguments
65
66	niro	532	There are a number of ways to specify the kernel used for \fB-\-info\fR,
67	niro	3013	\fB-\-remove-kernel\fR, and \fB-\-update-kernel\fR. Specifying \fBDEFAULT\fR
68	niro	532	or \fBALL\fR selects the default entry and all of the entries, respectively.
69			If a comma separated list of numbers is given, the boot entries indexed
70			by those numbers are selected. Finally, the title of a boot entry may
71			be specified by using \fBTITLE=\fItitle\fR as the argument; all entries
72			with that title are used.
73
74			.SH OPTIONS
75	niro	3012
76			.SS Basic Options
77
78	niro	532	.TP
79			\fB-\-add-kernel\fR=\fIkernel-path\fR
80	niro	3013	Add a new boot entry for the kernel located at \fIkernel-path\fR. A title for
81			the boot entry must be set using \fB-\-title\fR. Most invocations should also
82			include \fB-\-initrd\fR with memtest86 as a notable exception.
83	niro	532
84	niro	3013	The \fB-\-update-kernel\fR
85			option may not be used in the same invocation.
86
87	niro	532	.TP
88	niro	3012	\fB-\-remove-kernel\fR=\fIkernel-path\fR
89			Removes all boot entries which match \fIkernel-path\fR. This may be used
90	niro	3013	along with \fB-\-add-kernel\fR, in which case the new kernel being added will
91	niro	3012	never be removed.
92	niro	3007
93			.TP
94	niro	3012	\fB-\-update-kernel\fR=\fIkernel-path\fR
95			The entries for kernels matching \fRkernel-path\fR are updated. Currently
96			the only items that can be updated is the kernel argument list, which is
97			modified via the \fB-\-args\fR and \fB-\-remove-args\fR options.
98
99			.TP
100	niro	532	\fB-\-args\fR=\fIkernel-args\fR
101			When a new kernel is added, this specifies the command line arguments
102			which should be passed to the kernel by default (note they are merged
103			with the arguments from the template if \fB-\-copy-default\fR is used).
104			When \fB-\-update-kernel\fR is used, this specifies new arguments to add
105			to the argument list. Multiple, space separated arguments may be used. If
106			an argument already exists the new value replaces the old values. The
107			\fBroot=\fR kernel argument gets special handling if the configuration
108			file has special handling for specifying the root filesystem (like
109			lilo.conf does).
110
111			.TP
112	niro	3012	\fB-\-remove-args\fR=\fIkernel-args\fR
113			The arguments specified by \fIkernel-args\fR are removed from the
114			kernels specified by \fB-\-update-kernel\fR. The \fBroot\fR argument
115			gets special handling for configuration files that support separate root
116			filesystem configuration.
117	niro	532
118			.TP
119	niro	3012	\fB-\-copy-default\fR
120			\fBgrubby\fR will copy as much information (such as kernel arguments and
121			root device) as possible from the current default kernel. The kernel path
122			and initrd path will never be copied.
123	niro	532
124			.TP
125	niro	3012	\fB-\-title\fR=\fIentry-title\fR
126			When a new kernel entry is added \fIentry-title\fR is used as the title
127			(\fBlilo\fR label) for the entry. If \fIentry-title\fR is longer then maximum
128			length allowed by the bootloader (15 for lilo, unlimited for grub and elilo)
129			the title is shortened to a (unique) entry.
130	niro	532
131	niro	3012	.TP
132			\fB-\-initrd\fR=\fIinitrd-path\fR
133			Use \fIinitrd-path\fR as the path to an initial ram disk for a new kernel
134			being added.
135	niro	532
136			.TP
137	niro	3013	\fB-\-efi\fR
138			Use linuxefi and initrdefi when constructing bootloader stanzas instead of linux and initrd.
139
140			.TP
141	niro	3012	\fB-\-set-default\fR=\fIkernel-path\fR
142			The first entry which boots the specified kernel is made the default
143	niro	3013	boot entry. This may not be invoked with \fB-\-set-default-index\fR.
144	niro	532
145			.TP
146	niro	3012	\fB-\-set-default-index\fR=\fIentry-index\fR
147	niro	3013	Makes the given entry number the default boot entry. This may not
148			be invoked with \fB-\-set-default\fR.
149	niro	532
150			.TP
151	niro	3012	\fB-\-make-default\fR
152			Make the new kernel entry being added the default entry.
153
154			.TP
155			\fB-\-set-index\fR=\fIentry-index\fR
156			Set the position at which to add a new entry created with \fB-\-add-kernel\fR.
157
158			.TP
159	niro	1736	\fB-\-debug\fR
160			Display extra debugging information for failures.
161
162	niro	3013	.TP
163			\fB-i\fR, \fB-\-extra-initrd\fR=\fIinitrd-path\fR
164			Use \fIinitrd-path\fR as the path for an auxiliary initrd image.
165
166	niro	3012	.SS Display Options
167
168	niro	3013	Passing the display option to grubby will cause it to print out the
169			requested information about the current bootloader configuration and
170			then immediately exit. These options should not be used in any
171			script intended to update the bootloader configuration.
172
173	niro	1736	.TP
174	niro	532	\fB-\-default-kernel\fR
175			Display the full path to the current default kernel and exit.
176
177			.TP
178	niro	1720	\fB-\-default-index\fR
179			Display the numeric index of the current default boot entry and exit.
180
181			.TP
182	niro	1721	\fB-\-default-title\fR
183			Display the title of the current default boot entry and exit.
184
185			.TP
186	niro	3012	\fB-\-info\fR=\fIkernel-path\fR
187			Display information on all boot entries which match \fIkernel-path\fR. I
188	niro	2685
189			.TP
190	niro	3012	\fB-\-bootloader-probe\fR
191			\fBgrubby\fR tries to determine if \fBgrub\fR or \fBlilo\fR is currently
192			installed. When one of those bootloaders is found the name of that bootloader
193			is displayed on stdout. Both could be installed (on different devices), and
194			grubby will print out the names of both bootloaders, one per line. The probe
195			for \fBgrub\fR requires a commented out boot directive \fBgrub.conf\fR
196			identical to the standard directive in the lilo configuration file. If this
197			is not present \fBgrubby\fR will assume grub is not installed (note
198			that \fBanaconda\fR places this directive in \fBgrub.conf\fR files it creates).
199
200	niro	3013	\fIThis option is only available on i386 platforms.\fR
201
202	niro	3012	.TP
203	niro	3013	\fB-v\fR, \fB-\-version\fR
204	niro	3012	Display the version of \fBgrubby\fR being run and then exit immediately.
205
206			.SS Output Format Options
207
208	niro	3013	Sane default options for the current platform are compiled into grubby on
209			a per platform basis. These defaults determine the format and layout of
210			the generated bootloader configuration file. A different configuration file
211			format may be specified on the command line if the system uses a supported
212			alternative bootloader.
213
214	niro	3012	.TP
215	niro	532	\fB-\-elilo\fR
216	niro	3013	Use an \fBelilo\fR style configuration file. This is the default on ia64 platforms. This format is deprecated.
217	niro	532
218			.TP
219	niro	3013	\fB-\-extlinux\fR
220			Use an \fBextlinux\fR style configuration file. This format is deprecated.
221
222			.TP
223	niro	532	\fB-\-grub\fR
224	niro	3013	Use a \fBgrub\fR style configuration file. This is the default on ia32 platforms.
225	niro	532
226			.TP
227	niro	3013	\fB-\-grub2\fR
228			Use a \fBgrub2\fR style configuration file. This is the default on \fBx86_64\fR
229			architecture as well as the \fBppc64\fR and \fBppc64le\fR architectures
230			running on Power8 or later hardware.
231
232			.TP
233	niro	532	\fB-\-lilo\fR
234			Use a \fBlilo\fR style configuration file.
235
236			.TP
237	niro	3013	\fB-\-silo\fR
238			Use a \fBsilo\fR style configuration file. This is the default on SPARC systems. This format is legacy, deprecated, and unsupported.
239
240			.TP
241	niro	3012	\fB-\-yaboot\fR
242	niro	3013	Use a \fByaboot\fR style configuration file. This is the default for
243			the \fBppc\fR architecture on on Power7 and earlier hardware.
244	niro	532
245			.TP
246	niro	3012	\fB-\-zipl\fR
247	niro	3013	Use a \fBzipl\fR style configuration file. This is the default on the
248			legacy s390 and current s390x architectures.
249	niro	532
250	niro	3012	.SS Override Options
251	niro	532
252			.TP
253	niro	3012	\fB-\-bad-image-okay\fR
254			When \fBgrubby\fR is looking for a entry to use for something (such
255			as a template or a default boot entry) it uses sanity checks, such as
256			ensuring that the kernel exists in the filesystem, to make sure
257			entries that obviously won't work aren't selected. This option overrides
258			that behavior, and is designed primarily for testing.
259	niro	532
260			.TP
261	niro	3012	\fB-\-boot-filesystem\fR=\fIbootfs\fR
262	niro	3013	The \fBgrub\fR boot loader expects file paths listed in its configuration
263	niro	3012	path to be relative to the top of the filesystem they are on, rather then
264			relative to the current root filesystem. By default \fBgrubby\fR searches
265			the list of currently mounted filesystems to determine this. If this option
266			is given \fBgrubby\fR acts as if the specified filesystem was the filesystem
267			containing the kernel (this option is designed primarily for testing).
268	niro	1859
269			.TP
270	niro	3013	\fB-\-env\fR=\fIpath\fR
271			Path for the file where grub environment data is stored.
272
273			.TP
274			\fB-c\fR, \fB-\-config-file\fR=\fIpath\fR
275	niro	3012	Use \fIpath\fR as the configuration file rather then the default.
276	niro	532
277	niro	3013	.TP
278			\fB-o\fR, \fB-\-output-file\fR=\fIfile_path\fR
279			The destination path for the updated configuration file. Use "-" to
280			send it to stdout.
281
282			.TP
283			\fB-\-devtree\fR=\fIfile_path\fR
284	niro	3012	Use \fIpath\fR for device tree path in place of the path of any devicetree
285			directive found in the template stanza.
286	niro	532
287	niro	3013	.TP
288			\fB-\-devtreedir\fR=\fIfile_path\fR
289			Use the specified \fIfile path\fR to load the devicetree definition. This is for
290			platforms where a flat file is used instead of firmware to instruct the kernel
291			how to communicate with devices.
292
293	niro	3012	.SS Multiboot Options
294	niro	532
295	niro	3013	The Multiboot Specification provides a generic interface for boot
296	niro	532	loaders and operating systems. It is supported by the GRUB bootloader.
297
298			.TP
299			\fB-\-add-multiboot\fR=\fImultiboot-path\fR
300			Add a new boot entry for the multiboot kernel located at
301			\fImultiboot-path\fR. Note that this is generally accompanied with a
302	niro	3013	\fB--add-kernel\fR option.
303	niro	532
304			.TP
305			\fB-\-remove-multiboot\fR=\fImultiboot-path\fR
306	niro	3012	Removes all boot entries which match \fImultiboot-path\fR.
307	niro	532
308			.TP
309			\fB-\-mbargs\fR=\fImultiboot-args\fR
310	niro	3012	When a new multiboot kernel is added, this specifies the command line
311			arguments which should be passed to that kernel by default
312	niro	532	When \fB-\-update-kernel\fR is used, this specifies new arguments to add
313			to the argument list. Multiple, space separated arguments may be used. If
314	niro	3012	an argument already exists the new value replaces the old values.
315	niro	532
316			.TP
317			\fB-\-remove-mbargs\fR=\fImultiboot-args\fR
318	niro	3012	The arguments specified by \fImultiboot-args\fR are removed from the
319			kernels specified by \fB-\-update-kernel\fR.
320	niro	532
321	niro	3012	.SH "BUGS"
322	niro	532
323	niro	1152	The command line syntax is more than a little baroque. This probably
324	niro	532	won't be fixed as \fBgrubby\fR is only intended to be called from shell
325			scripts which can get it right.
326
327	niro	3013	.SH EXAMPLE
328
329			The following examples assume the following:
330
331			.TS
332			allbox;
333			rbw15 l.
334			cfg_file Full path to bootloader config file
335			new_kernel Full path to kernel image to be installed
336			old_kernel Full path to old kernel image to be removed
337			current_kernel Full path to a currently installed kernel
338			entry_title Title that appears on bootloader menu
339			new_initrd Full path to initrd for a new kernel
340			kernel_args Set of arguments for the kernel
341			menu_index Index number of a menu entry
342			.TE
343
344			The examples below quote strings that may have spaces or other whitespace in them. It is also
345			perfectly valid to backslash escape these strings if that is more convenient.
346
347			.PP
348			Add a new kernel entry and copy all options from the current default kernel. This is the behavior
349			that most users will want.
350			.IP
351			\fBgrubby\fR --add-kernel=\fInew_kernel\fR --title="\fIentry_title\fR" --initrd="\fInew_initrd\fR" --copy-default
352			.PP
353			Add a new kernel entry with custom arguments
354			.IP
355			\fBgrubby\fR --add-kernel=\fInew_kernel\fR --title="\fIentry_title\fR" --initrd="\fInew_initrd\fR" --args=\fIkernel_args\fR
356			.PP
357			Remove \fBall menu entries\fR for a specified kernel.
358			.IP
359			\fBgrubby\fR --remove-kernel=\fIold_kernel\fR
360			.PP
361			Target a single menu entry to remove without targetting other entries with the same kernel.
362			.IP
363			\fBgrubby\fR --info=\fIold_kernel\fR
364
365			\fBgrubby\fR --remove-kernel=\fImenu_index\fR
366			.PP
367			Update the arguments for all entries of a specific kernel. New arguments get added while existing arguments get updated values.
368			.IP
369			\fBgrubby\fR --update-kernel=\fIcurrent_kernel\fR --args="\fIkernel_args\fR"
370			.PP
371			Remove the arguments for a single entry of a specific kernel.
372			.IP
373			\fBgrubby\fR --info=\fIcurrent_kernel\fR
374
375			\fBgrubby\fR --remove-args=\fImenu_index\fR --args="\fIkernel_args\fR"
376
377	niro	532	.SH "SEE ALSO"
378	niro	3012
379	niro	532	.BR grub (8),
380			.BR lilo (8),
381			.BR yaboot (8),
382	niro	3013	.BR zipl (8),
383			.BR dracut (8),
384	niro	532	.BR mkinitrd (8)
385
386			.SH AUTHORS
387	niro	3012
388	niro	532	.nf
389	niro	1306	Erik Troan
390			Jeremy Katz
391			Peter Jones
392	niro	3013	Robert Marshall
393	niro	532	.fi