Magellan Linux

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

Parent Directory Parent Directory | Revision Log Revision Log | View Patch Patch

trunk/grubby/grubby.8 revision 3013 by niro, Tue Jun 27 14:33:29 2017 UTC tags/grubby-8_40_20170706/grubby.8 revision 3047 by niro, Thu Jul 6 12:20:52 2017 UTC
# Line 2  Line 2 
2    
3  .SH NAME  .SH NAME
4    
5  grubby \- command line tool used to configure bootloader menu entries across multiple architectures  grubby \- command line tool used to configure bootloader menu entries across
6    multiple architectures
7    
8  .SH SYNOPSIS  .SH SYNOPSIS
9    
10  \fBgrubby\fR [\fIOPTIONS...\fR]  \fBgrubby\fR [\fIOPTIONS\fR]
11    
12  .SH DESCRIPTION  .SH DESCRIPTION
13    
# Line 28  Legacy \fBs390\fR and the current \fBs39 Line 29  Legacy \fBs390\fR and the current \fBs39
29  and their \fBzipl\fR bootloader are fully supported.  and their \fBzipl\fR bootloader are fully supported.
30    
31  Support for \fByaboot\fR has been deprecated as all ppc architecture  Support for \fByaboot\fR has been deprecated as all ppc architecture
32  hardware since the Power8 system uses \fBgrub2\fR or petitboot  hardware since the Power8 uses \fBgrub2\fR or petitboot
33  which both use the grub2 configuration file format.  which both use the grub2 configuration file format.
34    
35  Legacy bootloaders \fBLILO\fR, \fBSILO\fR, and \fBELILO\fR  Legacy bootloaders \fBLILO\fR, \fBSILO\fR, and \fBELILO\fR
36  are deprecated in favor of previously mentioned bootloaders. The  are deprecated and no longer receiving active support in favor of
37  \fBSILO\fR bootloader should also be considered unsupported.  previously mentioned bootloaders.
38    
39  .SS Default Behavior  .SS Default Behavior
40    
41  The default architecture is chosen at compile time. The grubby executable  The default bootloader target is primarily determined by the architecture
42  has a series of built in assumptions about what bootloader is being used and  for which grubby has been built.  Each architecture has a preferred
43  where its configuration file lives. If no output format option is specified  bootloader, and each bootloader has its own configuration file.  If no
44  on the command line then grubby will use these default settings to first  bootloader is selected on the command line, grubby will use these default
45  search for an existing configuration and, if it is not found, assume that  settings to search for an existing configuration.  If no bootloader
46  it should be placed in the standard location. These default assumptions are  configuration file is found, grubby will use the default value for that
47  listed in the table below.  architecture.  These defaults are listed in the table below.
48    
49  .TS  .TS
50  allbox;  allbox;
# Line 81  Add a new boot entry for the kernel loca Line 82  Add a new boot entry for the kernel loca
82  the boot entry must be set using \fB-\-title\fR. Most invocations should also  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.  include \fB-\-initrd\fR with memtest86 as a notable exception.
84    
85  The \fB-\-update-kernel\fR  The \fB-\-update-kernel\fR option may not be used in the same invocation.
 option may not be used in the same invocation.  
86    
87  .TP  .TP
88  \fB-\-remove-kernel\fR=\fIkernel-path\fR  \fB-\-remove-kernel\fR=\fIkernel-path\fR
89  Removes all boot entries which match \fIkernel-path\fR. This may be used  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 kernel being added will  along with \fB-\-add-kernel\fR, in which case the new entry being added will
91  never be removed.  not be removed.
92    
93  .TP  .TP
94  \fB-\-update-kernel\fR=\fIkernel-path\fR  \fB-\-update-kernel\fR=\fIkernel-path\fR
95  The entries for kernels matching \fRkernel-path\fR are updated. Currently  Update the entries for kernels matching \fRkernel-path\fR. Currently
96  the only items that can be updated is the kernel argument list, which is  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.  modified via the \fB-\-args\fR and \fB-\-remove-args\fR options.
98    
99  .TP  .TP
# Line 135  being added. Line 135  being added.
135    
136  .TP  .TP
137  \fB-\-efi\fR  \fB-\-efi\fR
138  Use linuxefi and initrdefi when constructing bootloader stanzas instead of linux and initrd.  Use appropriate bootloader commands for EFI on this architecture.
139    
140  .TP  .TP
141  \fB-\-set-default\fR=\fIkernel-path\fR  \fB-\-set-default\fR=\fIkernel-path\fR
# Line 144  boot entry. This may not be invoked with Line 144  boot entry. This may not be invoked with
144    
145  .TP  .TP
146  \fB-\-set-default-index\fR=\fIentry-index\fR  \fB-\-set-default-index\fR=\fIentry-index\fR
147  Makes the given entry number the default boot entry. This may not  Makes the given entry number the default boot entry. This may not be invoked
148  be invoked with \fB-\-set-default\fR.  with \fB-\-set-default\fR.  The given value represents the index in the
149    post-modification boot entry list.
150    
151  .TP  .TP
152  \fB-\-make-default\fR  \fB-\-make-default\fR
# Line 188  Display information on all boot entries Line 189  Display information on all boot entries
189    
190  .TP  .TP
191  \fB-\-bootloader-probe\fR  \fB-\-bootloader-probe\fR
192    Attempt to probe for installed bootloaders.  If this option is specified,
193  \fBgrubby\fR tries to determine if \fBgrub\fR or \fBlilo\fR is currently  \fBgrubby\fR tries to determine if \fBgrub\fR or \fBlilo\fR is currently
194  installed. When one of those bootloaders is found the name of that bootloader  installed. When one of those bootloaders is found the name of that
195  is displayed on stdout.  Both could be installed (on different devices), and  bootloader is displayed on stdout.  Both could be installed (on different
196  grubby will print out the names of both bootloaders, one per line. The probe  devices), and grubby will print out the names of both bootloaders, one per
197  for \fBgrub\fR requires a commented out boot directive \fBgrub.conf\fR  line. The probe for \fBgrub\fR requires a commented out boot directive
198  identical to the standard directive in the lilo configuration file. If this  \fBgrub.conf\fR identical to the standard directive in the lilo
199  is not present \fBgrubby\fR will assume grub is not installed (note  configuration file. If this is not present \fBgrubby\fR will assume grub is
200  that \fBanaconda\fR places this directive in \fBgrub.conf\fR files it creates).  not installed (note that \fBanaconda\fR places this directive in
201    \fBgrub.conf\fR files it creates).
202    
203  \fIThis option is only available on i386 platforms.\fR  \fIThis option is only available on x86 BIOS platforms.\fR
204    
205  .TP  .TP
206  \fB-v\fR, \fB-\-version\fR  \fB-v\fR, \fB-\-version\fR
# Line 213  alternative bootloader. Line 216  alternative bootloader.
216    
217  .TP  .TP
218  \fB-\-elilo\fR  \fB-\-elilo\fR
219  Use an \fBelilo\fR style configuration file. This is the default on ia64 platforms. This format is deprecated.  Use an \fBelilo\fR style configuration file. This is the default on ia64
220    platforms. This format is deprecated.
221    
222  .TP  .TP
223  \fB-\-extlinux\fR  \fB-\-extlinux\fR
# Line 221  Use an \fBextlinux\fR style configuratio Line 225  Use an \fBextlinux\fR style configuratio
225    
226  .TP  .TP
227  \fB-\-grub\fR  \fB-\-grub\fR
228  Use a \fBgrub\fR style configuration file. This is the default on ia32 platforms.  Use a \fBgrub\fR style configuration file. This is the default on the i386
229    architecture.
230    
231  .TP  .TP
232  \fB-\-grub2\fR  \fB-\-grub2\fR
233  Use a \fBgrub2\fR style configuration file. This is the default on \fBx86_64\fR  Use a \fBgrub2\fR style configuration file. This is the default on
234  architecture as well as the \fBppc64\fR and \fBppc64le\fR architectures  \fBx86_64\fR architecture as well as the \fBppc64\fR and \fBppc64le\fR
235  running on Power8 or later hardware.  architectures running on Power8 or later hardware.
236    
237  .TP  .TP
238  \fB-\-lilo\fR  \fB-\-lilo\fR
# Line 235  Use a \fBlilo\fR style configuration fil Line 240  Use a \fBlilo\fR style configuration fil
240    
241  .TP  .TP
242  \fB-\-silo\fR  \fB-\-silo\fR
243  Use a \fBsilo\fR style configuration file. This is the default on SPARC systems. This format is legacy, deprecated, and unsupported.  Use a \fBsilo\fR style configuration file. This is the default on SPARC
244    systems. This format is legacy, deprecated, and unsupported.
245    
246  .TP  .TP
247  \fB-\-yaboot\fR  \fB-\-yaboot\fR
# Line 286  directive found in the template stanza. Line 292  directive found in the template stanza.
292    
293  .TP  .TP
294  \fB-\-devtreedir\fR=\fIfile_path\fR  \fB-\-devtreedir\fR=\fIfile_path\fR
295  Use the specified \fIfile path\fR to load the devicetree definition. This is for  Use the specified \fIfile path\fR to load the devicetree definition. This is
296  platforms where a flat file is used instead of firmware to instruct the kernel  for platforms where a flat file is used instead of firmware to instruct the
297  how to communicate with devices.  kernel how to communicate with devices.
298    
299  .SS Multiboot Options  .SS Multiboot Options
300    
# Line 341  kernel_args Set of arguments for the ker Line 347  kernel_args Set of arguments for the ker
347  menu_index Index number of a menu entry  menu_index Index number of a menu entry
348  .TE  .TE
349    
350  The examples below quote strings that may have spaces or other whitespace in them. It is also  The examples below quote strings that may have spaces or other whitespace in
351  perfectly valid to backslash escape these strings if that is more convenient.  them. It is also perfectly valid to backslash escape these strings if that
352    is more convenient.
353    
354  .PP  .PP
355  Add a new kernel entry and copy all options from the current default kernel. This is the behavior  Add a new kernel entry and copy all options from the current default kernel.
356  that most users will want.  This is the behavior that most users will want.
357  .IP  .IP
358  \fBgrubby\fR --add-kernel=\fInew_kernel\fR --title="\fIentry_title\fR" --initrd="\fInew_initrd\fR" --copy-default  \fBgrubby\fR --add-kernel=\fInew_kernel\fR --title="\fIentry_title\fR" --initrd="\fInew_initrd\fR" --copy-default
359  .PP  .PP
# Line 358  Remove \fBall menu entries\fR for a spec Line 365  Remove \fBall menu entries\fR for a spec
365  .IP  .IP
366  \fBgrubby\fR --remove-kernel=\fIold_kernel\fR  \fBgrubby\fR --remove-kernel=\fIold_kernel\fR
367  .PP  .PP
368  Target a single menu entry to remove without targetting other entries with the same kernel.  Target a single menu entry to remove without targetting other entries with
369    the same kernel.
370  .IP  .IP
371  \fBgrubby\fR --info=\fIold_kernel\fR  \fBgrubby\fR --info=\fIold_kernel\fR
372    
373  \fBgrubby\fR --remove-kernel=\fImenu_index\fR  \fBgrubby\fR --remove-kernel=\fImenu_index\fR
374  .PP  .PP
375  Update the arguments for all entries of a specific kernel. New arguments get added while existing arguments get updated values.  Update the arguments for all entries of a specific kernel. New arguments get
376    added while existing arguments get updated values.
377  .IP  .IP
378  \fBgrubby\fR --update-kernel=\fIcurrent_kernel\fR --args="\fIkernel_args\fR"  \fBgrubby\fR --update-kernel=\fIcurrent_kernel\fR --args="\fIkernel_args\fR"
379  .PP  .PP

Legend:
Removed from v.3013  
changed lines
  Added in v.3047