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