Diff of /tags/grubby-8_40_20170706/grubby.8

Parent Directory | Revision Log | Patch

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

---

Colored Diff Long Colored Diff Full Colored Diff Unidiff Context Diff Side by Side

Legend: Removed from v.1306   changed lines   Added in v.3016