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