/[magellan-source]/tags/grubby-8_40_20170706/grubby.8

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

Parent Directory | Revision Log | View Patch Patch

-revision 1332 by niro,
Fri Jun  3 20:32:19 2011 UTC
+revision 3012 by niro,
Tue Jun 27 14:32:57 2017 UTC
 Line 1
  .TH GRUBBY 8 "Tue Jan 18 2005"
  .SH NAME
- grubby \- command line tool for configuring grub, lilo, and elilo
+ grubby \- command line tool for configuring grub, lilo, elilo, yaboot and zipl
  .SH SYNOPSIS
- \fBgrubby\fR [--add-kernel=\fIkernel-path\fR] [--args=\fIargs\fR]
-        [--bad-image-okay] [--boot-filesystem=\fIbootfs\fR]
+ \fBgrubby\fR [--add-kernel=\fIkernel-path\fR] [--args=\fIargs\fR]
-        [--bootloader-probe] [--config-file \fIpath\fR]
+        [--bad-image-okay] [--boot-filesystem=\fIbootfs\fR]
-        [--copy-default] [--default-kernel]
+        [--bootloader-probe] [--config-file \fIpath\fR] [--copy-default]
+        [--debug] [--default-kernel] [--default-index] [--default-title]
+        [--devtree=\fIdevicetree.dtb\fR] [--set-index=\fIentry-index\fR]
         [--grub] [--lilo] [--yaboot] [--silo] [--zipl]
         [--info=\fIkernel-path\fR] [--initrd=\fIinitrd-path\fR]
         [--make-default] [-o path] [--version]
         [--remove-kernel=\fIkernel-path\fR] [--remove-args=\fIargs\fR]
-        [--set-default=\fIkernel-path\fR] [--title=entry-title]
+        [--set-default=\fIkernel-path\fR] [--set-default-index=\fIentry-index\fR]
-        [--add-multiboot=\fImultiboot-path\fR] [--mbargs=\fIargs\fR]
+        [--title=entry-title] [--add-multiboot=\fImultiboot-path\fR]
-        [--remove-multiboot=\fImultiboot-path\fR] [--remove-mbargs=\fIargs\fR]
+        [--mbargs=\fIargs\fR] [--remove-multiboot=\fImultiboot-path\fR]
+        [--remove-mbargs=\fIargs\fR]
  .SH DESCRIPTION
+ .SS General Information
  \fBgrubby\fR is a command line tool for updating and displaying information
  about the configuration files for the \fBgrub\fR, \fBlilo\fR, \fBelilo\fR
  (ia64), \fByaboot\fR (powerpc) and \fBzipl\fR (s390) boot loaders. It
  is primarily designed to be used from scripts which install new
  kernels and need to find information about the current boot environment.
- On Intel x86 platforms, \fBgrub\fR is the default bootloader and the
+ .SS Architecture Support
- configuration file is in \fB/boot/grub/grub.conf\fR. On Intel ia64 platforms,
- \fBelilo\fR mode is used and the default location for the configuration file
+ On BIOS-based Intel x86 platforms, \fBgrub2\fR is the default bootloader and
- is \fB/boot/grub/grub.conf\fR. On PowerPC platforms, \fByaboot\fR parsing
+ the configuration file is in \fB/boot/grub2/grub.cfg\fR.  On UEFI-based Intel
- is used and the configuration file should be in \fB/etc/yaboot.conf\fR.
+ x86 platforms, \fBgrub2\fR is the default bootloader, and the configuration
+ file is in \fB/boot/efi/EFI/redhat/grub.cfg\fR.  On Intel ia64 platforms,
+ \fBelilo\fR mode is used and the default location for the configuration file
+ is \fB/boot/efi/EFI/redhat/elilo.conf\fR. On PowerPC platforms, systems based
+ on Power8 now support \fBgrub2\fR as a bootloader and store using a default
+ config stored in \fB/boot/grub2/grub.cfg\fR. The earlier Power7 systems use \fByaboot\fR
+ parsing and the configuration file should be in \fB/etc/yaboot.conf\fR.  On
+ s390 platforms the \fBzipl bootloader\fR will read from \fB/etc/zipl.conf\fR.
+ .SS Special Arguments
  There are a number of ways to specify the kernel used for \fB-\-info\fR,
  \fB-\-remove-kernel\fR, and \fB-\-update-kernel\fR. Specificying \fBDEFAULT\fR
-Line 37 
 be specified by using \fBTITLE=\fItitle\
+Line 54 
 be specified by using \fBTITLE=\fItitle\
  with that title are used.
  .SH OPTIONS
+ .SS Basic Options
  .TP
  \fB-\-add-kernel\fR=\fIkernel-path\fR
  Add a new boot entry for the kernel located at \fIkernel-path\fR.
  .TP
+ \fB-\-remove-kernel\fR=\fIkernel-path\fR
+ Removes all boot entries which match \fIkernel-path\fR. This may be used
+ along with -\-add-kernel, in which case the new kernel being added will
+ never be removed.
+ .TP
+ \fB-\-update-kernel\fR=\fIkernel-path\fR
+ The entries for kernels matching \fRkernel-path\fR are updated. Currently
+ the only items that can be updated is the kernel argument list, which is
+ modified via the \fB-\-args\fR and \fB-\-remove-args\fR options.
+ .TP
  \fB-\-args\fR=\fIkernel-args\fR
  When a new kernel is added, this specifies the command line arguments
  which should be passed to the kernel by default (note they are merged
-Line 54 
 file has special handling for specifying
+Line 86 
 file has special handling for specifying
  lilo.conf does).
  .TP
- \fB-\-bad-image-okay\fR
+ \fB-\-remove-args\fR=\fIkernel-args\fR
- When \fBgrubby\fR is looking for a entry to use for something (such
+ The arguments specified by \fIkernel-args\fR are removed from the
- as a template or a default boot entry) it uses sanity checks, such as
+ kernels specified by \fB-\-update-kernel\fR. The \fBroot\fR argument
- ensuring that the kernel exists in the filesystem, to make sure
+ gets special handling for configuration files that support separate root
- entries that obviously won't work aren't selected. This option overrides
+ filesystem configuration.
- that behavior, and is designed primarily for testing.
- .TP
- \fB-\-boot-filesystem\fR=\fIbootfs\fR
- The \fBgrub\fR boot loader expects file paths listed in it's configuration
- path to be relative to the top of the filesystem they are on, rather then
- relative to the current root filesystem. By default \fBgrubby\fR searches
- the list of currently mounted filesystems to determine this. If this option
- is given \fBgrubby\fR acts as if the specified filesystem was the filesystem
- containing the kernel (this option is designed primarily for testing).
- .TP
- \fB-\-bootloader-probe\fR
- \fBgrubby\fR tries to determine if \fBgrub\fR or \fBlilo\fR is currently
- installed. When one of those bootloaders is found the name of that bootloader
- is displayed on stdout.  Both could be installed (on different devices), and
- grubby will print out the names of both bootloaders, one per line. The probe
- for \fBgrub\fR requires a commented out boot directive \fBgrub.conf\fR
- identical to the standard directive in the lilo configuration file. If this
- is not present \fBgrubby\fR will assume grub is not installed (note
- that \fBanaconda\fR places this directive in \fBgrub.conf\fR files it creates).
- This option is only available on ia32 platforms.
- .TP
- \fB-\-config-file\fR=\fIpath\fR
- Use \fIpath\fR as the configuration file rather then the default.
  .TP
  \fB-\-copy-default\fR
-Line 94 
 root device) as possible from the curren
+Line 99 
 root device) as possible from the curren
  and initrd path will never be copied.
  .TP
- \fB-\-default-kernel\fR
+ \fB-\-title\fR=\fIentry-title\fR
- Display the full path to the current default kernel and exit.
+ When a new kernel entry is added \fIentry-title\fR is used as the title
+ (\fBlilo\fR label) for the entry. If \fIentry-title\fR is longer then maximum
+ length allowed by the bootloader (15 for lilo, unlimited for grub and elilo)
+ the title is shortened to a (unique) entry.
  .TP
- \fB-\-elilo\fR
+ \fB-\-initrd\fR=\fIinitrd-path\fR
- Use an \fBelilo\fR style configuration file.
+ Use \fIinitrd-path\fR as the path to an initial ram disk for a new kernel
+ being added.
  .TP
- \fB-\-grub\fR
+ \fB-\-set-default\fR=\fIkernel-path\fR
- Use a \fBgrub\fR style configuration file instead of \fBlilo\fR style. This
+ The first entry which boots the specified kernel is made the default
- is the default on ia32 platforms.
+ boot entry.
  .TP
- \fB-\-info\fR=\fIkernel-path\fR
+ \fB-\-set-default-index\fR=\fIentry-index\fR
- Display information on all boot entries which match \fIkernel-path\fR. I
+ Makes the given entry number the default boot entry.
  .TP
- \fB-\-initrd\fR=\fIinitrd-path\fR
+ \fB-\-make-default\fR
- Use \fIinitrd-path\fR as the path to an initial ram disk for a new kernel
+ Make the new kernel entry being added the default entry.
- being added.
  .TP
- \fB-\-lilo\fR
+ \fB-\-set-index\fR=\fIentry-index\fR
- Use a \fBlilo\fR style configuration file.
+ Set the position at which to add a new entry created with \fB-\-add-kernel\fR.
  .TP
- \fB-\-make-default\fR
+ \fB-\-debug\fR
- Make the new kernel entry being added the default entry.
+ Display extra debugging information for failures.
+ .SS Display Options
  .TP
- \fB-\-remove-args\fR=\fIkernel-args\fR
+ \fB-\-default-kernel\fR
- The arguments specified by \fIkernel-args\fR are removed from the
+ Display the full path to the current default kernel and exit.
- kernels specified by \fB-\-update-kernel\fR. The \fBroot\fR argument
- gets special handling for configuration files that support separate root
- filesystem configuration.
  .TP
- \fB-\-remove-kernel\fR=\fIkernel-path\fR
+ \fB-\-default-index\fR
- Removes all boot entries which match \fIkernel-path\fR. This may be used
+ Display the numeric index of the current default boot entry and exit.
- along with -\-add-kernel, in which case the new kernel being added will
- never be removed.
  .TP
- \fB-\-set-default\fR=\fIkernel-path\fR
+ \fB-\-default-title\fR
- The first entry which boots the specified kernel is made the default
+ Display the title of the current default boot entry and exit.
- boot entry.
  .TP
- \fB-\-title\fR=\fIentry-title\fR
+ \fB-\-info\fR=\fIkernel-path\fR
- When a new kernel entry is added \fIentry-title\fR is used as the title
+ Display information on all boot entries which match \fIkernel-path\fR. I
- (\fBlilo\fR label) for the entry. If \fIentry-title\fR is longer then maximum
- length allowed by the bootloader (15 for lilo, unlimited for grub and elilo)
- the title is shortened to a (unique) entry.
  .TP
- \fB-\-update-kernel\fR=\fIkernel-path\fR
+ \fB-\-bootloader-probe\fR
- The entries for kernels matching \fRkernel-path\fR are updated. Currently
+ \fBgrubby\fR tries to determine if \fBgrub\fR or \fBlilo\fR is currently
- the only items that can be updated is the kernel argument list, which is
+ installed. When one of those bootloaders is found the name of that bootloader
- modified via the \fB-\-args\fR and \fB-\-remove-args\fR options.
+ is displayed on stdout.  Both could be installed (on different devices), and
+ grubby will print out the names of both bootloaders, one per line. The probe
+ for \fBgrub\fR requires a commented out boot directive \fBgrub.conf\fR
+ identical to the standard directive in the lilo configuration file. If this
+ is not present \fBgrubby\fR will assume grub is not installed (note
+ that \fBanaconda\fR places this directive in \fBgrub.conf\fR files it creates).
+ This option is only available on ia32 platforms.
  .TP
  \fB-\-version\fR
  Display the version of \fBgrubby\fR being run and then exit immediately.
+ .SS Output Format Options
+ .TP
+ \fB-\-elilo\fR
+ Use an \fBelilo\fR style configuration file.
+ .TP
+ \fB-\-grub\fR
+ Use a \fBgrub\fR style configuration file instead of \fBlilo\fR style. This
+ is the default on ia32 platforms.
+ .TP
+ \fB-\-lilo\fR
+ Use a \fBlilo\fR style configuration file.
  .TP
  \fB-\-yaboot\fR
  Use an \fByaboot\fR style configuration file.
-Line 166 
 Use an \fByaboot\fR style configuration
+Line 188 
 Use an \fByaboot\fR style configuration
  \fB-\-zipl\fR
  Use an \fBzipl\fR style configuration file.
- .SH MULTIBOOT OPTIONS
+ .SS Override Options
+ .TP
+ \fB-\-bad-image-okay\fR
+ When \fBgrubby\fR is looking for a entry to use for something (such
+ as a template or a default boot entry) it uses sanity checks, such as
+ ensuring that the kernel exists in the filesystem, to make sure
+ entries that obviously won't work aren't selected. This option overrides
+ that behavior, and is designed primarily for testing.
+ .TP
+ \fB-\-boot-filesystem\fR=\fIbootfs\fR
+ The \fBgrub\fR boot loader expects file paths listed in it's configuration
+ path to be relative to the top of the filesystem they are on, rather then
+ relative to the current root filesystem. By default \fBgrubby\fR searches
+ the list of currently mounted filesystems to determine this. If this option
+ is given \fBgrubby\fR acts as if the specified filesystem was the filesystem
+ containing the kernel (this option is designed primarily for testing).
+ .TP
+ \fB-\-config-file\fR=\fIpath\fR
+ Use \fIpath\fR as the configuration file rather then the default.
+ \fB-\-devtree\fR=\fIpath\fR
+ Use \fIpath\fR for device tree path in place of the path of any devicetree
+ directive found in the template stanza.
+ .SS Multiboot Options
  The Multiboot Specification provides a genreic interface for boot
  loaders and operating systems.  It is supported by the GRUB bootloader.
-Line 178 
 Add a new boot entry for the multiboot k
+Line 228 
 Add a new boot entry for the multiboot k
  .TP
  \fB-\-remove-multiboot\fR=\fImultiboot-path\fR
  Removes all boot entries which match \fImultiboot-path\fR.
  .TP
  \fB-\-mbargs\fR=\fImultiboot-args\fR
  When a new multiboot kernel is added, this specifies the command line
  arguments which should be passed to that kernel by default
  When \fB-\-update-kernel\fR is used, this specifies new arguments to add
  to the argument list. Multiple, space separated arguments may be used. If
  an argument already exists the new value replaces the old values.
  .TP
  \fB-\-remove-mbargs\fR=\fImultiboot-args\fR
  The arguments specified by \fImultiboot-args\fR are removed from the
  kernels specified by \fB-\-update-kernel\fR.
  .SH "BUGS"
  The command line syntax is more than a little baroque. This probably
  won't be fixed as \fBgrubby\fR is only intended to be called from shell
  scripts which can get it right.
  .SH "SEE ALSO"
  .BR grub (8),
  .BR lilo (8),
  .BR yaboot (8),
  .BR mkinitrd (8)
  .SH AUTHORS
  .nf
  Erik Troan
  Jeremy Katz

 Legend:



Removed from v.1332
 


changed lines


 
Added in v.3012
 Legend:



Removed from v.1332
 


changed lines


 
Added in v.3012
-Removed from v.1332
+Added in v.3012