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