Magellan Linux

  • Back to homepage
    • /[magellan-source]/tags/grubby-8_40_20170706/grubby.8

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

    Parent Directory Parent Directory | Revision Log Revision Log

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