tags/grubby-8_31/grubby.8

.TH GRUBBY 8 "Tue Jan 18 2005"
.SH NAME
grubby \- command line tool for configuring grub, lilo, elilo, yaboot and zipl

.SH SYNOPSIS
\fBgrubby\fR [--add-kernel=\fIkernel-path\fR] [--args=\fIargs\fR] 
       [--bad-image-okay] [--boot-filesystem=\fIbootfs\fR] 
       [--bootloader-probe] [--config-file \fIpath\fR] [--copy-default]
       [--debug] [--default-kernel] [--default-index] [--default-title]
       [--devtree=\fIdevicetree.dtb\fR]
       [--grub] [--lilo] [--yaboot] [--silo] [--zipl]
       [--info=\fIkernel-path\fR] [--initrd=\fIinitrd-path\fR] 
       [--make-default] [-o path] [--version]
       [--remove-kernel=\fIkernel-path\fR] [--remove-args=\fIargs\fR]
       [--set-default=\fIkernel-path\fR] [--set-default-index=\fientry-index\fR]
       [--title=entry-title] [--add-multiboot=\fImultiboot-path\fR]
       [--mbargs=\fIargs\fR] [--remove-multiboot=\fImultiboot-path\fR]
       [--remove-mbargs=\fIargs\fR]

.SH DESCRIPTION
\fBgrubby\fR is a command line tool for updating and displaying information
about the configuration files for the \fBgrub\fR, \fBlilo\fR, \fBelilo\fR 
(ia64), \fByaboot\fR (powerpc) and \fBzipl\fR (s390) boot loaders. It
is primarily designed to be used from scripts which install new
kernels and need to find information about the current boot environment.

On Intel x86 platforms, \fBgrub\fR is the default bootloader and the
configuration file is in \fB/boot/grub/grub.conf\fR. On Intel ia64 platforms, 
\fBelilo\fR mode is used and the default location for the configuration file 
is \fB/boot/grub/grub.conf\fR. On PowerPC platforms, \fByaboot\fR parsing
is used and the configuration file should be in \fB/etc/yaboot.conf\fR.

There are a number of ways to specify the kernel used for \fB-\-info\fR,
\fB-\-remove-kernel\fR, and \fB-\-update-kernel\fR. Specificying \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
.TP
\fB-\-add-kernel\fR=\fIkernel-path\fR
Add a new boot entry for the kernel located at \fIkernel-path\fR.

.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-\-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 it's 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-\-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).
This option is only available on ia32 platforms. 


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

.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-\-debug\fR
Display extra debugging information for failures.

.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-\-devtree\fR=\fIpath\fR
Use \fIpath\fR for device tree path in place of the path of any devicetree
directive found in the template stanza.

.TP
\fB-\-elilo\fR
Use an \fBelilo\fR style configuration file.

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

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

.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-\-lilo\fR
Use a \fBlilo\fR style configuration file.

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

.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-\-remove-kernel\fR=\fIkernel-path\fR
Removes all boot entries which match \fIkernel-path\fR. This may be used
along with -\-add-kernel, in which case the new kernel being added will
never be removed.

.TP
\fB-\-set-default\fR=\fIkernel-path\fR
The first entry which boots the specified kernel is made the default
boot entry.

.TP
\fB-\-set-default-index\fR=\fIentry-index\fR
Makes the given entry number the default boot entry.

.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-\-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-\-version\fR
Display the version of \fBgrubby\fR being run and then exit immediately.

.TP
\fB-\-yaboot\fR
Use an \fByaboot\fR style configuration file.

.TP
\fB-\-zipl\fR
Use an \fBzipl\fR style configuration file.

.SH MULTIBOOT OPTIONS
The Multiboot Specification provides a genreic 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
\fI--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 "SEE ALSO"
.BR grub (8),
.BR lilo (8),
.BR yaboot (8),
.BR mkinitrd (8)

.SH AUTHORS
.nf
Erik Troan
Jeremy Katz
Peter Jones
.fi
1	niro	532	.TH GRUBBY 8 "Tue Jan 18 2005"
2			.SH NAME
3	niro	1862	grubby \- command line tool for configuring grub, lilo, elilo, yaboot and zipl
4	niro	532
5			.SH SYNOPSIS
6			\fBgrubby\fR [--add-kernel=\fIkernel-path\fR] [--args=\fIargs\fR]
7			[--bad-image-okay] [--boot-filesystem=\fIbootfs\fR]
8	niro	1720	[--bootloader-probe] [--config-file \fIpath\fR] [--copy-default]
9	niro	1736	[--debug] [--default-kernel] [--default-index] [--default-title]
10	niro	2685	[--devtree=\fIdevicetree.dtb\fR]
11	niro	532	[--grub] [--lilo] [--yaboot] [--silo] [--zipl]
12			[--info=\fIkernel-path\fR] [--initrd=\fIinitrd-path\fR]
13			[--make-default] [-o path] [--version]
14			[--remove-kernel=\fIkernel-path\fR] [--remove-args=\fIargs\fR]
15	niro	1859	[--set-default=\fIkernel-path\fR] [--set-default-index=\fientry-index\fR]
16			[--title=entry-title] [--add-multiboot=\fImultiboot-path\fR]
17			[--mbargs=\fIargs\fR] [--remove-multiboot=\fImultiboot-path\fR]
18			[--remove-mbargs=\fIargs\fR]
19	niro	532
20			.SH DESCRIPTION
21			\fBgrubby\fR is a command line tool for updating and displaying information
22			about the configuration files for the \fBgrub\fR, \fBlilo\fR, \fBelilo\fR
23			(ia64), \fByaboot\fR (powerpc) and \fBzipl\fR (s390) boot loaders. It
24			is primarily designed to be used from scripts which install new
25			kernels and need to find information about the current boot environment.
26
27			On Intel x86 platforms, \fBgrub\fR is the default bootloader and the
28			configuration file is in \fB/boot/grub/grub.conf\fR. On Intel ia64 platforms,
29			\fBelilo\fR mode is used and the default location for the configuration file
30			is \fB/boot/grub/grub.conf\fR. On PowerPC platforms, \fByaboot\fR parsing
31			is used and the configuration file should be in \fB/etc/yaboot.conf\fR.
32
33			There are a number of ways to specify the kernel used for \fB-\-info\fR,
34			\fB-\-remove-kernel\fR, and \fB-\-update-kernel\fR. Specificying \fBDEFAULT\fR
35			or \fBALL\fR selects the default entry and all of the entries, respectively.
36			If a comma separated list of numbers is given, the boot entries indexed
37			by those numbers are selected. Finally, the title of a boot entry may
38			be specified by using \fBTITLE=\fItitle\fR as the argument; all entries
39			with that title are used.
40
41			.SH OPTIONS
42			.TP
43			\fB-\-add-kernel\fR=\fIkernel-path\fR
44			Add a new boot entry for the kernel located at \fIkernel-path\fR.
45
46			.TP
47			\fB-\-args\fR=\fIkernel-args\fR
48			When a new kernel is added, this specifies the command line arguments
49			which should be passed to the kernel by default (note they are merged
50			with the arguments from the template if \fB-\-copy-default\fR is used).
51			When \fB-\-update-kernel\fR is used, this specifies new arguments to add
52			to the argument list. Multiple, space separated arguments may be used. If
53			an argument already exists the new value replaces the old values. The
54			\fBroot=\fR kernel argument gets special handling if the configuration
55			file has special handling for specifying the root filesystem (like
56			lilo.conf does).
57
58			.TP
59			\fB-\-bad-image-okay\fR
60			When \fBgrubby\fR is looking for a entry to use for something (such
61			as a template or a default boot entry) it uses sanity checks, such as
62			ensuring that the kernel exists in the filesystem, to make sure
63			entries that obviously won't work aren't selected. This option overrides
64			that behavior, and is designed primarily for testing.
65
66			.TP
67			\fB-\-boot-filesystem\fR=\fIbootfs\fR
68			The \fBgrub\fR boot loader expects file paths listed in it's configuration
69			path to be relative to the top of the filesystem they are on, rather then
70			relative to the current root filesystem. By default \fBgrubby\fR searches
71			the list of currently mounted filesystems to determine this. If this option
72			is given \fBgrubby\fR acts as if the specified filesystem was the filesystem
73			containing the kernel (this option is designed primarily for testing).
74
75			.TP
76			\fB-\-bootloader-probe\fR
77			\fBgrubby\fR tries to determine if \fBgrub\fR or \fBlilo\fR is currently
78			installed. When one of those bootloaders is found the name of that bootloader
79			is displayed on stdout. Both could be installed (on different devices), and
80			grubby will print out the names of both bootloaders, one per line. The probe
81			for \fBgrub\fR requires a commented out boot directive \fBgrub.conf\fR
82			identical to the standard directive in the lilo configuration file. If this
83			is not present \fBgrubby\fR will assume grub is not installed (note
84			that \fBanaconda\fR places this directive in \fBgrub.conf\fR files it creates).
85			This option is only available on ia32 platforms.
86
87
88			.TP
89			\fB-\-config-file\fR=\fIpath\fR
90			Use \fIpath\fR as the configuration file rather then the default.
91
92			.TP
93			\fB-\-copy-default\fR
94			\fBgrubby\fR will copy as much information (such as kernel arguments and
95			root device) as possible from the current default kernel. The kernel path
96			and initrd path will never be copied.
97
98			.TP
99	niro	1736	\fB-\-debug\fR
100			Display extra debugging information for failures.
101
102			.TP
103	niro	532	\fB-\-default-kernel\fR
104			Display the full path to the current default kernel and exit.
105
106			.TP
107	niro	1720	\fB-\-default-index\fR
108			Display the numeric index of the current default boot entry and exit.
109
110			.TP
111	niro	1721	\fB-\-default-title\fR
112			Display the title of the current default boot entry and exit.
113
114			.TP
115	niro	2685	\fB-\-devtree\fR=\fIpath\fR
116			Use \fIpath\fR for device tree path in place of the path of any devicetree
117			directive found in the template stanza.
118
119			.TP
120	niro	532	\fB-\-elilo\fR
121			Use an \fBelilo\fR style configuration file.
122
123			.TP
124			\fB-\-grub\fR
125			Use a \fBgrub\fR style configuration file instead of \fBlilo\fR style. This
126			is the default on ia32 platforms.
127
128			.TP
129			\fB-\-info\fR=\fIkernel-path\fR
130			Display information on all boot entries which match \fIkernel-path\fR. I
131
132			.TP
133			\fB-\-initrd\fR=\fIinitrd-path\fR
134			Use \fIinitrd-path\fR as the path to an initial ram disk for a new kernel
135			being added.
136
137			.TP
138			\fB-\-lilo\fR
139			Use a \fBlilo\fR style configuration file.
140
141			.TP
142			\fB-\-make-default\fR
143			Make the new kernel entry being added the default entry.
144
145			.TP
146			\fB-\-remove-args\fR=\fIkernel-args\fR
147			The arguments specified by \fIkernel-args\fR are removed from the
148			kernels specified by \fB-\-update-kernel\fR. The \fBroot\fR argument
149			gets special handling for configuration files that support separate root
150			filesystem configuration.
151
152			.TP
153			\fB-\-remove-kernel\fR=\fIkernel-path\fR
154			Removes all boot entries which match \fIkernel-path\fR. This may be used
155			along with -\-add-kernel, in which case the new kernel being added will
156			never be removed.
157
158			.TP
159			\fB-\-set-default\fR=\fIkernel-path\fR
160			The first entry which boots the specified kernel is made the default
161			boot entry.
162
163			.TP
164	niro	1859	\fB-\-set-default-index\fR=\fIentry-index\fR
165			Makes the given entry number the default boot entry.
166
167			.TP
168	niro	532	\fB-\-title\fR=\fIentry-title\fR
169			When a new kernel entry is added \fIentry-title\fR is used as the title
170			(\fBlilo\fR label) for the entry. If \fIentry-title\fR is longer then maximum
171			length allowed by the bootloader (15 for lilo, unlimited for grub and elilo)
172			the title is shortened to a (unique) entry.
173
174			.TP
175			\fB-\-update-kernel\fR=\fIkernel-path\fR
176			The entries for kernels matching \fRkernel-path\fR are updated. Currently
177			the only items that can be updated is the kernel argument list, which is
178			modified via the \fB-\-args\fR and \fB-\-remove-args\fR options.
179
180			.TP
181			\fB-\-version\fR
182			Display the version of \fBgrubby\fR being run and then exit immediately.
183
184			.TP
185			\fB-\-yaboot\fR
186			Use an \fByaboot\fR style configuration file.
187
188			.TP
189			\fB-\-zipl\fR
190			Use an \fBzipl\fR style configuration file.
191
192			.SH MULTIBOOT OPTIONS
193			The Multiboot Specification provides a genreic interface for boot
194			loaders and operating systems. It is supported by the GRUB bootloader.
195
196			.TP
197			\fB-\-add-multiboot\fR=\fImultiboot-path\fR
198			Add a new boot entry for the multiboot kernel located at
199			\fImultiboot-path\fR. Note that this is generally accompanied with a
200			\fI--add-kernel\fR option.
201
202			.TP
203			\fB-\-remove-multiboot\fR=\fImultiboot-path\fR
204			Removes all boot entries which match \fImultiboot-path\fR.
205
206			.TP
207			\fB-\-mbargs\fR=\fImultiboot-args\fR
208			When a new multiboot kernel is added, this specifies the command line
209			arguments which should be passed to that kernel by default
210			When \fB-\-update-kernel\fR is used, this specifies new arguments to add
211			to the argument list. Multiple, space separated arguments may be used. If
212			an argument already exists the new value replaces the old values.
213
214			.TP
215			\fB-\-remove-mbargs\fR=\fImultiboot-args\fR
216			The arguments specified by \fImultiboot-args\fR are removed from the
217			kernels specified by \fB-\-update-kernel\fR.
218
219
220			.SH "BUGS"
221	niro	1152	The command line syntax is more than a little baroque. This probably
222	niro	532	won't be fixed as \fBgrubby\fR is only intended to be called from shell
223			scripts which can get it right.
224
225			.SH "SEE ALSO"
226			.BR grub (8),
227			.BR lilo (8),
228			.BR yaboot (8),
229			.BR mkinitrd (8)
230
231			.SH AUTHORS
232			.nf
233	niro	1306	Erik Troan
234			Jeremy Katz
235			Peter Jones
236	niro	532	.fi