Magellan Linux

Contents of /tags/grubby-8_15/grubby.8

Parent Directory Parent Directory | Revision Log Revision Log


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