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