GNU GRUB manual ¶

5.1.1 How to boot an OS directly with GRUB ¶

Multiboot (see Motivation in The Multiboot Specification) is the native format supported by GRUB. For the sake of convenience, there is also support for Linux, FreeBSD, NetBSD and OpenBSD. If you want to boot other operating systems, you will have to chain-load them (see Chain-loading an OS).

FIXME: this section is incomplete.

1. Run the command boot (see boot).

However, DOS and Windows have some deficiencies, so you might have to use more complicated instructions. See DOS/Windows, for more information.

5.1.2 Kexec with grub2-emu ¶

GRUB can be run in userspace by invoking the grub2-emu tool. It will read all configuration scripts as if booting directly (see How to boot an OS directly with GRUB). With the --kexec flag, and kexec(8) support from the operating system, the linux command will directly boot the target image. For systems that lack working systemctl(1) support for kexec, passing the --kexec flag twice will fallback to invoking kexec(8) directly; note however that this fallback may be unsafe outside read-only environments, as it does not invoke shutdown machinery.

5.1.3 Chain-loading an OS ¶

Operating systems that do not support Multiboot and do not have specific support in GRUB (specific support is available for Linux, FreeBSD, NetBSD and OpenBSD) must be chain-loaded, which involves loading another boot loader and jumping to it in real mode or via the firmware.

The chainloader command (see chainloader) is used to set this up. It is normally also necessary to load some GRUB modules and set the appropriate root device. Putting this together, we get something like this, for a Windows system on the first partition of the first hard disk:

menuentry "Windows" {
	insmod chain
	insmod ntfs
	set root=(hd0,1)
	chainloader +1
}

On systems with multiple hard disks, an additional workaround may be required. See DOS/Windows.

Chain-loading is only supported on PC BIOS and EFI platforms.

5.4.1 GNU/Hurd ¶

Since GNU/Hurd is Multiboot-compliant, it is easy to boot it; there is nothing special about it. But do not forget that you have to specify a root partition to the kernel.

1. Set GRUB’s root device to the same drive as GNU/Hurd’s. The command search --set=root --file /boot/gnumach.gz or similar may help you (see search).
2. Load the kernel and the modules, like this:

   grub> multiboot /boot/gnumach.gz root=device:hd0s1
   grub> module  /hurd/ext2fs.static ext2fs --readonly \
                      --multiboot-command-line='${kernel-command-line}' \
                      --host-priv-port='${host-port}' \
                      --device-master-port='${device-port}' \
                      --exec-server-task='${exec-task}' -T typed '${root}' \
                      '$(task-create)' '$(task-resume)'
   grub> module /lib/ld.so.1 exec /hurd/exec '$(exec-task=task-create)'
   

3. Finally, run the command boot (see boot).

5.4.2 GNU/Linux ¶

It is relatively easy to boot GNU/Linux from GRUB, because it somewhat resembles to boot a Multiboot-compliant OS.

1. Set GRUB’s root device to the same drive as GNU/Linux’s. The command search --set=root --file /vmlinuz or similar may help you (see search).
2. Load the kernel using the command linux (see linux):

   grub> linux /vmlinuz root=/dev/sda1
   

   If you need to specify some kernel parameters, just append them to the command. For example, to set acpi to ‘off’, do this:

   grub> linux /vmlinuz root=/dev/sda1 acpi=off
   

   See the documentation in the Linux source tree for complete information on the available options.

   With linux GRUB uses 32-bit protocol. Some BIOS services like APM or EDD aren’t available with this protocol. In this case you need to use linux16

   grub> linux16 /vmlinuz root=/dev/sda1 acpi=off
   

3. If you use an initrd, execute the command initrd (see initrd) after linux:

   grub> initrd /initrd
   

   If you used linux16 you need to use initrd16:

   grub> initrd16 /initrd
   

4. Finally, run the command boot (see boot).

5.4.3 NetBSD ¶

Booting a NetBSD kernel from GRUB is also relatively easy: first set GRUB’s root device, then load the kernel and the modules, and finally run boot.

1. Set GRUB’s root device to the partition holding the NetBSD root file system. For a disk with a NetBSD disk label, this is usually the first partition (a:). In that case, and assuming that the partition is on the first hard disk, set GRUB’s root device as follows:

   grub> insmod part_bsd
   grub> set root=(hd0,netbsd1)
   

   For a disk with a GUID Partition Table (GPT), and assuming that the NetBSD root partition is the third GPT partition, do this:

   grub> insmod part_gpt
   grub> set root=(hd0,gpt3)
   

2. Load the kernel using the command knetbsd:

   grub> knetbsd /netbsd
   

   Various options may be given to knetbsd. These options are, for the most part, the same as in the NetBSD boot loader. For instance, to boot the system in single-user mode and with verbose messages, do this:

   grub> knetbsd /netbsd -s -v
   

3. If needed, load kernel modules with the command knetbsd_module_elf. A typical example is the module for the root file system:

   grub> knetbsd_module_elf /stand/amd64/6.0/modules/ffs/ffs.kmod
   

4. Finally, run the command boot (see boot).

5.4.4 DOS/Windows ¶

GRUB cannot boot DOS or Windows directly, so you must chain-load them (see Chain-loading an OS). However, their boot loaders have some critical deficiencies, so it may not work to just chain-load them. To overcome the problems, GRUB provides you with two helper functions.

If you have installed DOS (or Windows) on a non-first hard disk, you have to use the disk swapping technique, because that OS cannot boot from any disks but the first one. The workaround used in GRUB is the command drivemap (see drivemap), like this:

drivemap -s (hd0) (hd1)

This performs a virtual swap between your first and second hard drive.

Caution: This is effective only if DOS (or Windows) uses BIOS to access the swapped disks. If that OS uses a special driver for the disks, this probably won’t work.

Another problem arises if you installed more than one set of DOS/Windows onto one disk, because they could be confused if there are more than one primary partitions for DOS/Windows. Certainly you should avoid doing this, but there is a solution if you do want to do so. Use the partition hiding/unhiding technique.

If GRUB hides a DOS (or Windows) partition (see parttool), DOS (or Windows) will ignore the partition. If GRUB unhides a DOS (or Windows) partition, DOS (or Windows) will detect the partition. Thus, if you have installed DOS (or Windows) on the first and the second partition of the first hard disk, and you want to boot the copy on the first partition, do the following:

parttool (hd0,1) hidden-
parttool (hd0,2) hidden+
set root=(hd0,1)
chainloader +1
parttool ${root} boot+
boot

7.2.1 Colors ¶

Colors can be specified in several ways:

• HTML-style “#RRGGBB” or “#RGB” format, where *R*, *G*, and *B* are hexadecimal digits (e.g., “#8899FF”)
• as comma-separated decimal RGB values (e.g., “128, 128, 255”)
• with “SVG 1.0 color names” (e.g., “cornflowerblue”) which must be specified in lowercase.

7.2.2 Fonts ¶

The fonts GRUB uses “PFF2 font format” bitmap fonts. Fonts are specified with full font names. Currently there is no provision for a preference list of fonts, or deriving one font from another. Fonts are loaded with the “loadfont” command in GRUB (loadfont). To see the list of loaded fonts, execute the “lsfonts” command (lsfonts). If there are too many fonts to fit on screen, do “set pager=1” before executing “lsfonts”.

7.2.3 Progress Bar ¶

Progress bars are used to display the remaining time before GRUB boots the default menu entry. To create a progress bar that will display the remaining time before automatic boot, simply create a “progress_bar” component with the id “__timeout__”. This indicates to GRUB that the progress bar should be updated as time passes, and it should be made invisible if the countdown to automatic boot is interrupted by the user.

Progress bars may optionally have text displayed on them. This text is controlled by variable “text” which contains a printf template with the only argument %d is the number of seconds remaining. Additionally special values “@TIMEOUT_NOTIFICATION_SHORT@”, “@TIMEOUT_NOTIFICATION_MIDDLE@”, “@TIMEOUT_NOTIFICATION_LONG@” are replaced with standard and translated templates.

7.2.4 Circular Progress Indicator ¶

The circular progress indicator functions similarly to the progress bar. When given an id of “__timeout__”, GRUB updates the circular progress indicator’s value to indicate the time remaining. For the circular progress indicator, there are two images used to render it: the *center* image, and the *tick* image. The center image is rendered in the center of the component, while the tick image is used to render each mark along the circumference of the indicator.

7.2.5 Labels ¶

Text labels can be placed on the boot screen. The font, color, and horizontal alignment can be specified for labels. If a label is given the id “__timeout__”, then the “text” property for that label is also updated with a message informing the user of the number of seconds remaining until automatic boot. This is useful in case you want the text displayed somewhere else instead of directly on the progress bar.

7.2.6 Boot Menu ¶

The boot menu where GRUB displays the menu entries from the “grub.cfg” file. It is a list of items, where each item has a title and an optional icon. The icon is selected based on the *classes* specified for the menu entry. If there is a PNG file named “myclass.png” in the “grub/themes/icons” directory, it will be displayed for items which have the class *myclass*. The boot menu can be customized in several ways, such as the font and color used for the menu entry title, and by specifying styled boxes for the menu itself and for the selected item highlight.

7.2.7 Styled Boxes ¶

One of the most important features for customizing the layout is the use of *styled boxes*. A styled box is composed of 9 rectangular (and potentially empty) regions, which are used to seamlessly draw the styled box on screen:

To support any size of box on screen, the center slice and the slices for the top, bottom, and sides are all scaled to the correct size for the component on screen, using the following rules:

1. The edge slices (north, south, east, and west) are scaled in the direction of the edge they are adjacent to. For instance, the west slice is scaled vertically.
2. The corner slices (northwest, northeast, southeast, and southwest) are not scaled.
3. The center slice is scaled to fill the remaining space in the middle.

As an example of how an image might be sliced up, consider the styled box used for a terminal view.

7.2.8 Creating Styled Box Images ¶

The Inkscape_ scalable vector graphics editor is a very useful tool for creating styled box images. One process that works well for slicing a drawing into the necessary image slices is:

1. Create or open the drawing you’d like use.
2. Create a new layer on the top of the layer stack. Make it visible. Select this layer as the current layer.
3. Draw 9 rectangles on your drawing where you’d like the slices to be. Clear the fill option, and set the stroke to 1 pixel wide solid stroke. The corners of the slices must meet precisely; if it is off by a single pixel, it will probably be evident when the styled box is rendered in the GRUB menu. You should probably go to File | Document Properties | Grids and enable a grid or create a guide (click on one of the rulers next to the drawing and drag over the drawing; release the mouse button to place the guide) to help place the rectangles precisely.
4. Right click on the center slice rectangle and choose Object Properties. Change the "Id" to “slice_c“ and click Set. Repeat this for the remaining 8 rectangles, giving them Id values of “slice_n“, “slice_ne“, “slice_e“, and so on according to the location.
5. Save the drawing.
6. Select all the slice rectangles. With the slice layer selected, you can simply press Ctrl+A to select all rectangles. The status bar should indicate that 9 rectangles are selected.
7. Click the layer hide icon for the slice layer in the layer palette. The rectangles will remain selected, even though they are hidden.
8. Choose File | Export Bitmap and check the *Batch export 9 selected objects* box. Make sure that *Hide all except selected* is unchecked. click *Export*. This will create PNG files in the same directory as the drawing, named after the slices. These can now be used for a styled box in a GRUB theme.

7.3.1 Global Properties ¶

7.3.2 Format ¶

Global properties are specified with the simple format:

• name1: value1
• name2: "value which may contain spaces"
• name3: #88F

In this example, name3 is assigned a color value.

7.3.3 Global Property List ¶

7.3.4 Component Construction ¶

Greater customizability comes is provided by components. A tree of components forms the user interface. *Containers* are components that can contain other components, and there is always a single root component which is an instance of a *canvas* container.

Components are created in the theme file by prefixing the type of component with a ’+’ sign:

+ label { text="GRUB" font="aqui 11" color="#8FF" }

properties of a component are specified as "name = value" (whitespace surrounding tokens is optional and is ignored) where *value* may be:

• a single word (e.g., “align = center“, “color = #FF8080“),
• a quoted string (e.g., “text = "Hello, World!"“), or
• a tuple (e.g., “preferred_size = (120, 80)“).

7.3.5 Component List ¶

The following is a list of the components and the properties they support.

• label A label displays a line of text.

  Properties:

  id	Set to “__timeout__“ to display the time elapsed to an automatical boot of the default entry.
  text	The text to display. If “id“ is set to “__timeout__“ and no “text“ property is set then the amount of seconds will be shown. If set to “@KEYMAP_SHORT@“, “@KEYMAP_MIDDLE@“ or “@KEYMAP_LONG@“ then predefined hotkey information will be shown.
  font	The font to use for text display.
  color	The color of the text.
  align	The horizontal alignment of the text within the component. Options are “left“, “center“ and “right“.
  visible	Set to “false“ to hide the label.

• image A component that displays an image. The image is scaled to fit the component.

  Properties:

  file	The full path to the image file to load.

• progress_bar Displays a horizontally oriented progress bar. It can be rendered using simple solid filled rectangles, or using a pair of pixmap styled boxes.

  Properties:

  id	Set to “__timeout__“ to display the time elapsed to an automatical boot of the default entry.
  fg_color	The foreground color for plain solid color rendering.
  bg_color	The background color for plain solid color rendering.
  border_color	The border color for plain solid color rendering.
  text_color	The text color.
  bar_style	The styled box specification for the frame of the progress bar. Example: “progress_frame_*.png“ If the value is equal to “highlight_style“ then no styled boxes will be shown.
  highlight_style	The styled box specification for the highlighted region of the progress bar. This box will be used to paint just the highlighted region of the bar, and will be increased in size as the bar nears completion. Example: “progress_hl_*.png“. If the value is equal to “bar_style“ then no styled boxes will be shown.
  highlight_overlay	If this option is set to “true“ then the highlight box side slices (every slice except the center slice) will overlay the frame box side slices. And the center slice of the highlight box can move all the way (from top to bottom), being drawn on the center slice of the frame box. That way we can make a progress bar with round-shaped edges so there won’t be a free space from the highlight to the frame in top and bottom scrollbar positions. Default is “false“.
  font	The font to use for progress bar.
  text	The text to display on the progress bar. If the progress bar’s ID is set to “__timeout__“ and the value of this property is set to “@TIMEOUT_NOTIFICATION_SHORT@“, “@TIMEOUT_NOTIFICATION_MIDDLE@“ or “@TIMEOUT_NOTIFICATION_LONG@“, then GRUB will update this property with an informative message as the timeout approaches.

• circular_progress Displays a circular progress indicator. The appearance of this component is determined by two images: the *center* image and the *tick* image. The center image is generally larger and will be drawn in the center of the component. Around the circumference of a circle within the component, the tick image will be drawn a certain number of times, depending on the properties of the component.

  Properties:

  id	Set to “__timeout__“ to display the time elapsed to an automatical boot of the default entry.
  center_bitmap	The file name of the image to draw in the center of the component.
  tick_bitmap	The file name of the image to draw for the tick marks.
  num_ticks	The number of ticks that make up a full circle.
  ticks_disappear	Boolean value indicating whether tick marks should progressively appear, or progressively disappear as *value* approaches *end*. Specify “true“ or “false“. Default is “false“.
  start_angle	The position of the first tick mark to appear or disappear. Measured in "parrots", 1 "parrot" = 1 / 256 of the full circle. Use values “xxx deg“ or “xxx \xc2\xb0“ to set the angle in degrees.

• boot_menu Displays the GRUB boot menu. It allows selecting items and executing them.

  Properties:

  item_font	The font to use for the menu item titles.
  selected_item_font	The font to use for the selected menu item, or “inherit“ (the default) to use “item_font“ for the selected menu item as well.
  item_color	The color to use for the menu item titles.
  selected_item_color	The color to use for the selected menu item, or “inherit“ (the default) to use “item_color“ for the selected menu item as well.
  icon_width	The width of menu item icons. Icons are scaled to the specified size.
  icon_height	The height of menu item icons.
  item_height	The height of each menu item in pixels.
  item_padding	The amount of space in pixels to leave on each side of the menu item contents.
  item_icon_space	The space between an item’s icon and the title text, in pixels.
  item_spacing	The amount of space to leave between menu items, in pixels.
  menu_pixmap_style	The image file pattern for the menu frame styled box. Example: “menu_*.png“ (this will use images such as “menu_c.png“, “menu_w.png“, ‘menu_nw.png“, etc.)
  item_pixmap_style	The image file pattern for the item styled box.
  selected_item_pixmap_style	The image file pattern for the selected item highlight styled box.
  scrollbar	Boolean value indicating whether the scroll bar should be drawn if the frame and thumb styled boxes are configured.
  scrollbar_frame	The image file pattern for the entire scroll bar. Example: “scrollbar_*.png“
  scrollbar_thumb	The image file pattern for the scroll bar thumb (the part of the scroll bar that moves as scrolling occurs). Example: “scrollbar_thumb_*.png“
  scrollbar_thumb_overlay	If this option is set to “true“ then the scrollbar thumb side slices (every slice except the center slice) will overlay the scrollbar frame side slices. And the center slice of the scrollbar_thumb can move all the way (from top to bottom), being drawn on the center slice of the scrollbar frame. That way we can make a scrollbar with round-shaped edges so there won’t be a free space from the thumb to the frame in top and bottom scrollbar positions. Default is “false“.
  scrollbar_slice	The menu frame styled box’s slice in which the scrollbar will be drawn. Possible values are “west“, “center“, “east“ (default). “west“ - the scrollbar will be drawn in the west slice (right-aligned). “east“ - the scrollbar will be drawn in the east slice (left-aligned). “center“ - the scrollbar will be drawn in the center slice. Note: in case of “center“ slice: a) If the scrollbar should be drawn then boot menu entry’s width is decreased by the scrollbar’s width and the scrollbar is drawn at the right side of the center slice. b) If the scrollbar won’t be drawn then the boot menu entry’s width is the width of the center slice. c) We don’t necessary need the menu pixmap box to display the scrollbar.
  scrollbar_left_pad	The left scrollbar padding in pixels. Unused if “scrollbar_slice“ is “west“.
  scrollbar_right_pad	The right scrollbar padding in pixels. Unused if “scrollbar_slice“ is “east“.
  scrollbar_top_pad	The top scrollbar padding in pixels.
  scrollbar_bottom_pad	The bottom scrollbar padding in pixels.
  visible	Set to “false“ to hide the boot menu.

• canvas Canvas is a container that allows manual placement of components within it. It does not alter the positions of its child components. It assigns all child components their preferred sizes.
• hbox The *hbox* container lays out its children from left to right, giving each one its preferred width. The height of each child is set to the maximum of the preferred heights of all children.
• vbox The *vbox* container lays out its children from top to bottom, giving each one its preferred height. The width of each child is set to the maximum of the preferred widths of all children.

7.3.6 Common properties ¶

The following properties are supported by all components:

‘left’

The distance from the left border of container to left border of the object in either of three formats:

x	Value in pixels
p%	Percentage
p%+x	mixture of both

‘top’

The distance from the left border of container to left border of the object in same format.

‘width’

The width of object in same format.

‘height’

The height of object in same format.

‘id’

The identifier for the component. This can be any arbitrary string. The ID can be used by scripts to refer to various components in the GUI component tree. Currently, there is one special ID value that GRUB recognizes:

“__timeout__“

Component with this ID will be updated by GRUB and will indicate time elapsed to an automatical boot of the default entry. Affected components: “label“, “circular_progress“, “progress_bar“.

15.1.1 biosnum ¶

When chain-loading another boot loader (see Chain-loading an OS), GRUB may need to know what BIOS drive number corresponds to the root device (see root) so that it can set up registers properly. If the biosnum variable is set, it overrides GRUB’s own means of guessing this.

For an alternative approach which also changes BIOS drive mappings for the chain-loaded system, see drivemap.

15.1.2 check_signatures ¶

This variable controls whether GRUB enforces digital signature validation on loaded files. See Using digital signatures in GRUB.

15.1.3 chosen ¶

When executing a menu entry, GRUB sets the chosen variable to the title of the entry being executed.

If the menu entry is in one or more submenus, then chosen is set to the titles of each of the submenus starting from the top level followed by the title of the menu entry itself, separated by ‘>’.

15.1.4 cmdpath ¶

The location from which core.img was loaded as an absolute directory name (see How to specify files). This is set by GRUB at startup based on information returned by platform firmware. Not every platform provides this information and some may return only device without path name.

15.1.5 color_highlight ¶

This variable contains the “highlight” foreground and background terminal colors, separated by a slash (‘/’). Setting this variable changes those colors. For the available color names, see color_normal.

The default is ‘black/light-gray’.

15.1.6 color_normal ¶

This variable contains the “normal” foreground and background terminal colors, separated by a slash (‘/’). Setting this variable changes those colors. Each color must be a name from the following list:

• black
• blue
• green
• cyan
• red
• magenta
• brown
• light-gray
• dark-gray
• light-blue
• light-green
• light-cyan
• light-red
• light-magenta
• yellow
• white

The default is ‘light-gray/black’.

The color support support varies from terminal to terminal.

‘morse’ has no color support at all.

‘mda_text’ color support is limited to highlighting by black/white reversal.

‘console’ on ARC, EMU and IEEE1275, ‘serial_*’ and ‘spkmodem’ are governed by terminfo and support only 8 colors if in modes ‘vt100-color’ (default for console on emu), ‘arc’ (default for console on ARC), ‘ieee1275’ (default for console on IEEE1275). When in mode ‘vt100’ then the color support is limited to highlighting by black/white reversal. When in mode ‘dumb’ there is no color support.

When console supports no colors this setting is ignored. When console supports 8 colors, then the colors from the second half of the previous list are mapped to the matching colors of first half.

‘console’ on EFI and BIOS and ‘vga_text’ support all 16 colors.

‘gfxterm’ supports all 16 colors and would be theoretically extendable to support whole rgb24 palette but currently there is no compelling reason to go beyond the current 16 colors.

15.1.7 config_directory ¶

This variable is automatically set by GRUB to the directory part of current configuration file name (see config_file).

15.1.8 config_file ¶

This variable is automatically set by GRUB to the name of configuration file that is being processed by commands configfile (see configfile) or normal (see normal). It is restored to the previous value when command completes.

15.1.9 debug ¶

This variable may be set to enable debugging output from various components of GRUB. The value is an ordered list of debug facility names separated by whitespace or ‘,’. If the special facility named ‘all’ is present then debugging output of all facility names is enabled at the start of processing the value of this variable. A facility’s debug output can then be disabled by prefixing its name with a ‘-’. The last occurence facility name with or without a leading ‘-’ takes precendent over any previous occurence. This allows the easy enabling or disabling of facilities by appending a ‘,’ and then the facility name with or without the leading ‘-’, which will preserve the state of the rest of the facilities. The facility names are the first argument to grub_dprintf. Consult the source for more details.

15.1.10 default ¶

If this variable is set, it identifies a menu entry that should be selected by default, possibly after a timeout (see timeout). The entry may be identified by number (starting from 0 at each level of the hierarchy), by title, or by id.

For example, if you have:

menuentry 'Example GNU/Linux distribution' --class gnu-linux --id example-gnu-linux {
	...
}

then you can make this the default using:

default=example-gnu-linux

If the entry is in a submenu, then it must be identified using the number, title, or id of each of the submenus starting from the top level, followed by the number, title, or id of the menu entry itself, with each element separated by ‘>’. For example, take the following menu structure:

GNU/Hurd --id gnu-hurd
  Standard Boot --id=gnu-hurd-std
  Rescue shell --id=gnu-hurd-rescue
Other platforms --id=other
  Minix --id=minix
    Version 3.4.0 --id=minix-3.4.0
    Version 3.3.0 --id=minix-3.3.0
  GRUB Invaders --id=grub-invaders

The more recent release of Minix would then be identified as ‘Other platforms>Minix>Version 3.4.0’, or as ‘1>0>0’, or as ‘other>minix>minix-3.4.0’.

This variable is often set by ‘GRUB_DEFAULT’ (see Simple configuration handling), grub-set-default, or grub-reboot.

15.1.11 fallback ¶

If this variable is set, it identifies a menu entry that should be selected if the default menu entry fails to boot. Entries are identified in the same way as for ‘default’ (see default).

15.1.12 gfxmode ¶

If this variable is set, it sets the resolution used on the ‘gfxterm’ graphical terminal. Note that you can only use modes which your graphics card supports via VESA BIOS Extensions (VBE), so for example native LCD panel resolutions may not be available. The default is ‘auto’, which selects a platform-specific default that should look reasonable. Supported modes can be listed by ‘videoinfo’ command in GRUB.

The resolution may be specified as a sequence of one or more modes, separated by commas (‘,’) or semicolons (‘;’); each will be tried in turn until one is found. Each mode should be either ‘auto’, ‘widthxheight’, or ‘widthxheightxdepth’.

15.1.13 gfxpayload ¶

If this variable is set, it controls the video mode in which the Linux kernel starts up, replacing the ‘vga=’ boot option (see linux). It may be set to ‘text’ to force the Linux kernel to boot in normal text mode, ‘keep’ to preserve the graphics mode set using ‘gfxmode’, or any of the permitted values for ‘gfxmode’ to set a particular graphics mode (see gfxmode).

Depending on your kernel, your distribution, your graphics card, and the phase of the moon, note that using this option may cause GNU/Linux to suffer from various display problems, particularly during the early part of the boot sequence. If you have problems, set this variable to ‘text’ and GRUB will tell Linux to boot in normal text mode.

The default is platform-specific. On platforms with a native text mode (such as PC BIOS platforms), the default is ‘text’. Otherwise the default may be ‘auto’ or a specific video mode.

This variable is often set by ‘GRUB_GFXPAYLOAD_LINUX’ (see Simple configuration handling).

15.1.14 gfxterm_font ¶

If this variable is set, it names a font to use for text on the ‘gfxterm’ graphical terminal. Otherwise, ‘gfxterm’ may use any available font.

15.1.15 grub_cpu ¶

In normal mode (see normal), GRUB sets the ‘grub_cpu’ variable to the CPU type for which GRUB was built (e.g. ‘i386’ or ‘powerpc’).

15.1.16 grub_platform ¶

In normal mode (see normal), GRUB sets the ‘grub_platform’ variable to the platform for which GRUB was built (e.g. ‘pc’ or ‘efi’).

15.1.17 icondir ¶

If this variable is set, it names a directory in which the GRUB graphical menu should look for icons after looking in the theme’s ‘icons’ directory. See Theme file format.

15.1.18 lang ¶

If this variable is set, it names the language code that the gettext command (see gettext) uses to translate strings. For example, French would be named as ‘fr’, and Simplified Chinese as ‘zh_CN’.

grub-mkconfig (see Simple configuration handling) will try to set a reasonable default for this variable based on the system locale.

15.1.19 locale_dir ¶

If this variable is set, it names the directory where translation files may be found (see gettext), usually /boot/grub/locale. Otherwise, internationalization is disabled.

grub-mkconfig (see Simple configuration handling) will set a reasonable default for this variable if internationalization is needed and any translation files are available.

15.1.20 lockdown ¶

If this variable is set to ‘y’, it means that GRUB has entered see Lockdown when booting on a secure setup mode.

15.1.21 menu_color_highlight ¶

This variable contains the foreground and background colors to be used for the highlighted menu entry, separated by a slash (‘/’). Setting this variable changes those colors. For the available color names, see color_normal.

The default is the value of ‘color_highlight’ (see color_highlight).

15.1.22 menu_color_normal ¶

This variable contains the foreground and background colors to be used for non-highlighted menu entries, separated by a slash (‘/’). Setting this variable changes those colors. For the available color names, see color_normal.

The default is the value of ‘color_normal’ (see color_normal).

15.1.23 net_<interface>_boot_file ¶

See Booting GRUB from the network.

15.1.24 net_<interface>_clientid ¶

See Booting GRUB from the network.

15.1.25 net_<interface>_clientuuid ¶

See Booting GRUB from the network.

15.1.26 net_<interface>_dhcp_server_name ¶

See Booting GRUB from the network.

15.1.27 net_<interface>_domain ¶

See Booting GRUB from the network.

15.1.28 net_<interface>_extensionspath ¶

See Booting GRUB from the network.

15.1.29 net_<interface>_hostname ¶

See Booting GRUB from the network.

15.1.30 net_<interface>_ip ¶

See Booting GRUB from the network.

15.1.31 net_<interface>_mac ¶

See Booting GRUB from the network.

15.1.32 net_<interface>_next_server ¶

See Booting GRUB from the network.

15.1.33 net_<interface>_rootpath ¶

See Booting GRUB from the network.

15.1.34 net_default_interface ¶

See Booting GRUB from the network.

15.1.35 net_default_ip ¶

See Booting GRUB from the network.

15.1.36 net_default_mac ¶

See Booting GRUB from the network.

15.1.37 net_default_server ¶

See Booting GRUB from the network.

15.1.38 pager ¶

If set to ‘1’, pause output after each screenful and wait for keyboard input. The default is not to pause output.

15.1.39 prefix ¶

The location of the ‘/boot/grub’ directory as an absolute file name (see How to specify files). This is normally set by GRUB at startup based on information provided by grub-install. GRUB modules are dynamically loaded from this directory, so it must be set correctly in order for many parts of GRUB to work.

15.1.40 pxe_blksize ¶

See Booting GRUB from the network.

15.1.41 pxe_default_gateway ¶

See Booting GRUB from the network.

15.1.42 pxe_default_server ¶

See Booting GRUB from the network.

15.1.43 root ¶

The root device name (see How to specify devices). Any file names that do not specify an explicit device name are read from this device. The default is normally set by GRUB at startup based on the value of ‘prefix’ (see prefix).

For example, if GRUB was installed to the first partition of the first hard disk, then ‘prefix’ might be set to ‘(hd0,msdos1)/boot/grub’ and ‘root’ to ‘hd0,msdos1’.

15.1.44 shim_lock ¶

If this variable is set to ‘y’, it means that the shim_lock verifier is registered (see see UEFI secure boot and shim support).

15.1.45 superusers ¶

This variable may be set to a list of superuser names to enable authentication support. See Security.

15.1.46 theme ¶

This variable may be set to a directory containing a GRUB graphical menu theme. See Theme file format.

This variable is often set by ‘GRUB_THEME’ (see Simple configuration handling).

15.1.47 timeout ¶

If this variable is set, it specifies the time in seconds to wait for keyboard input before booting the default menu entry. A timeout of ‘0’ means to boot the default entry immediately without displaying the menu; a timeout of ‘-1’ (or unset) means to wait indefinitely.

If ‘timeout_style’ (see timeout_style) is set to ‘countdown’ or ‘hidden’, the timeout is instead counted before the menu is displayed.

This variable is often set by ‘GRUB_TIMEOUT’ (see Simple configuration handling).

15.1.48 timeout_style ¶

This variable may be set to ‘menu’, ‘countdown’, or ‘hidden’ to control the way in which the timeout (see timeout) interacts with displaying the menu. See the documentation of ‘GRUB_TIMEOUT_STYLE’ (see Simple configuration handling) for details.

15.1.49 tpm_fail_fatal ¶

If this variable is set and true (i.e., not set to “0”, “false”, “disable”, or “no”), TPM measurements that fail will be treated as fatal. Otherwise, they will merely be debug-logged and boot will continue.

Call to EFI firmware, like hash_log_extend_event(), can return an unknown error, i.e. due to bug present in firmware. When this variable is set and true (same values as with TPM measurements) this situation will be considered to be fatal and error-logged as “unknown TPM error”. If not set, booting the OS will be enabled.

17.1.1 menuentry ¶

Command: menuentry title [--class=class …] [--users=users] [--unrestricted] [--hotkey=key] [--id=id] [arg …] { command; … } ¶

This defines a GRUB menu entry named title. When this entry is selected from the menu, GRUB will set the chosen environment variable to value of --id if --id is given, execute the list of commands given within braces, and if the last command in the list returned successfully and a kernel was loaded it will execute the boot command.

The --class option may be used any number of times to group menu entries into classes. Menu themes may display different classes using different styles.

The --users option grants specific users access to specific menu entries. See Security.

The --unrestricted option grants all users access to specific menu entries. See Security.

The --hotkey option associates a hotkey with a menu entry. key may be a single letter, or one of the aliases ‘backspace’, ‘tab’, or ‘delete’.

The --id may be used to associate unique identifier with a menu entry. id is string of ASCII aphanumeric characters, underscore and hyphen and should not start with a digit.

All other arguments including title are passed as positional parameters when list of commands is executed with title always assigned to $1.

17.1.2 submenu ¶

Command: submenu title [--class=class …] [--users=users] [--unrestricted] [--hotkey=key] [--id=id] { menu entries … } ¶

This defines a submenu. An entry called title will be added to the menu; when that entry is selected, a new menu will be displayed showing all the entries within this submenu.

All options are the same as in the menuentry command (see menuentry).

17.2.1 chainloader ¶

Command: chainloader [--force] file [args...] ¶

Load file as a chain-loader. Like any other file loaded by the filesystem code, it can use the blocklist notation (see How to specify block lists) to grab the first sector of the current partition with ‘+1’. On EFI platforms, any arguments after file will be sent to the loaded image.

If you specify the option --force, then load file forcibly, whether it has a correct signature or not. This is required when you want to load a defective boot loader, such as SCO UnixWare 7.1.

17.2.2 initrd ¶

Command: initrd file [file …] ¶

Load, in order, all initrds for a Linux kernel image, and set the appropriate parameters in the Linux setup area in memory. This may only be used after the linux command (see linux) has been run. See GNU/Linux for more info on booting GNU/Linux. For more information on initrds see the GNU/Linux kernel documentation.

A new-style initrd (for kernels newer than 2.6) containing one file with leading path components can also be generated at run time. This can be done by prefixing an argument with newc: followed by the path of the file in the new initrd, a :, and then the GRUB file path to the file data to be be included.

For example:

initrd newc:/etc/ssh/config:(hd0,2)/home/user/.ssh/config \
       newc:/etc/ssh/ssh_host_rsa_key:/etc/ssh/ssh_host_rsa_key \
       /boot/initrd.gz \
       newc:/init:/home/user/init.fixed

This command will generate two new-style initrds on the fly. The first contains the path ‘/etc/ssh/config’ with the contents of ‘(hd0,2)/home/user/.ssh/config’ and the path ‘/etc/ssh/ssh_host_rsa_key’ with the contents of ‘/etc/ssh/ssh_host_rsa_key’ on the root device. Parent directory paths will automatically be generated as needed. This first generated initrd will then have ‘/boot/initrd.gz’ concatenated after it. Next, another new-style archive will be generated with the contents of ‘/home/user/init.fixed’ in the path ‘/init’ and appended to the previous concatenation. Finally, the result will be sent to the kernel when booted.

Keep in mind that paths that come later will take precedence. So in the example above, the generated path ‘/init’ will overwrite any ‘/init’ in ‘/boot/initrd.gz’. This can be useful when changing the main initrd is undesirable or difficult.

17.2.3 initrd16 ¶

Command: initrd16 file [file …] ¶

Load, in order, all initrds for a Linux kernel image to be booted in 16-bit mode, and set the appropriate parameters in the Linux setup area in memory. This may only be used after the linux16 command (see linux16) has been run. See also GNU/Linux and the initrd command (see initrd) for more details on arguments.

This command is only available on the pc platform for x86 systems.

17.2.4 linux ¶

Command: linux file … ¶

Load a Linux kernel image from file. The rest of the line is passed verbatim as the kernel command-line. Any initrd must be reloaded after using this command (see initrd).

On x86 systems, the kernel will be booted using the 32-bit boot protocol. Note that this means that the ‘vga=’ boot option will not work; if you want to set a special video mode, you will need to use GRUB commands such as ‘set gfxpayload=1024x768’ or ‘set gfxpayload=keep’ (to keep the same mode as used in GRUB) instead. GRUB can automatically detect some uses of ‘vga=’ and translate them to appropriate settings of ‘gfxpayload’. The linux16 command (see linux16) avoids this restriction.

17.2.5 linux16 ¶

Command: linux16 file … ¶

Load a Linux kernel image from file in 16-bit mode. The rest of the line is passed verbatim as the kernel command-line. Any initrd must be reloaded after using this command (see initrd16).

The kernel will be booted using the traditional 16-bit boot protocol. As well as bypassing problems with ‘vga=’ described in linux, this permits booting some other programs that implement the Linux boot protocol for the sake of convenience.

This command is only available on x86 systems.

17.2.6 xen_hypervisor ¶

Command: xen_hypervisor file [arguments] … ¶

Load a Xen hypervisor binary from file. The rest of the line is passed verbatim as the kernel command-line. Any other binaries must be reloaded after using this command. This command is only available on AArch64 systems.

17.2.7 xen_module ¶

Command: xen_module [–nounzip] file [arguments] ¶

Load a module for xen hypervisor at the booting process of xen. The rest of the line is passed verbatim as the module command line. Modules should be loaded in the following order: - dom0 kernel image - dom0 ramdisk if present - XSM policy if present This command is only available on AArch64 systems.

17.3.1 serial ¶

Command: serial [--unit=unit] [--port=port] [--speed=speed] [--word=word] [--parity=parity] [--stop=stop] ¶

Initialize a serial device. unit is a number in the range 0-3 specifying which serial port to use; default is 0, which corresponds to the port often called COM1.

port is the I/O port where the UART is to be found or, if prefixed with ‘mmio,’, the MMIO address of the UART. If specified it takes precedence over unit.

Additionally, an MMIO address can be suffixed with:

• ‘.b’ for bytes access (default)
• ‘.w’ for 16-bit word access
• ‘.l’ for 32-bit long word access or
• ‘.q’ for 64-bit long long word access

Also, port can be of the form ‘pci,XX:XX.X’ to indicate a serial device exposed on the PCI bus.

speed is the transmission speed; default is 9600. word and stop are the number of data bits and stop bits. Data bits must be in the range 5-8 and stop bits must be 1 or 2. Default is 8 data bits and one stop bit. parity is one of ‘no’, ‘odd’, ‘even’ and defaults to ‘no’.

If passed no unit nor port, or if port is set to ‘auto’ then GRUB will attempt to use ACPI to automatically detect the system default serial port and its configuration. If this information is not available, it will default to unit 0.

The serial port is not used as a communication channel unless the terminal_input or terminal_output command is used (see terminal_input, see terminal_output).

Note, valid port values, excluding IO port addresses, can be found by listing terminals with terminal_output, selecting all names prefixed by ‘serial_’ and removing that prefix.

Examples:

serial --port=0x3f8 --speed=9600
serial --port=mmio,fefb0000.l --speed=115200
serial --port=pci,00:16.3 --speed=115200

See also Using GRUB via a serial line.

17.3.2 terminal_input ¶

Command: terminal_input [--append|--remove] [terminal1] [terminal2] … ¶

List or select an input terminal.

With no arguments, list the active and available input terminals.

With --append, add the named terminals to the list of active input terminals; any of these may be used to provide input to GRUB.

With --remove, remove the named terminals from the active list.

With no options but a list of terminal names, make only the listed terminal names active.

17.3.3 terminal_output ¶

Command: terminal_output [--append|--remove] [terminal1] [terminal2] … ¶

List or select an output terminal.

With no arguments, list the active and available output terminals.

With --append, add the named terminals to the list of active output terminals; all of these will receive output from GRUB.

With --remove, remove the named terminals from the active list.

With no options but a list of terminal names, make only the listed terminal names active.

17.3.4 terminfo ¶

Command: terminfo [-a|-u|-v] [-g WxH] [term] [type] ¶

Define the capabilities of your terminal by giving the name of an entry in the terminfo database, which should correspond roughly to a ‘TERM’ environment variable in Unix.

The currently available terminal types are ‘vt100’, ‘vt100-color’, ‘ieee1275’, and ‘dumb’. If you need other terminal types, please contact us to discuss the best way to include support for these in GRUB.

The -a (--ascii), -u (--utf8), and -v (--visual-utf8) options control how non-ASCII text is displayed. -a specifies an ASCII-only terminal; -u specifies logically-ordered UTF-8; and -v specifies "visually-ordered UTF-8" (in other words, arranged such that a terminal emulator without bidirectional text support will display right-to-left text in the proper order; this is not really proper UTF-8, but a workaround).

The -g (--geometry) can be used to specify terminal geometry.

If no option or terminal type is specified, the current terminal type is printed.

17.4.1 [ ¶

Command: [ expression ] ¶

Alias for test expression (see test).

17.4.2 acpi ¶

Command: acpi [-1|-2] [--exclude=table1,…|--load-only=table1,…] [--oemid=id] [--oemtable=table] [--oemtablerev=rev] [--oemtablecreator=creator] [--oemtablecreatorrev=rev] [--no-ebda] filename … ¶

Modern BIOS systems normally implement the Advanced Configuration and Power Interface (ACPI), and define various tables that describe the interface between an ACPI-compliant operating system and the firmware. In some cases, the tables provided by default only work well with certain operating systems, and it may be necessary to replace some of them.

Normally, this command will replace the Root System Description Pointer (RSDP) in the Extended BIOS Data Area to point to the new tables. If the --no-ebda option is used, the new tables will be known only to GRUB, but may be used by GRUB’s EFI emulation.

Note: The command is not allowed when lockdown is enforced (see Lockdown when booting on a secure setup). Otherwise an attacker can instruct the GRUB to load an SSDT table to overwrite the kernel lockdown configuration and later load and execute unsigned code.

17.4.3 authenticate ¶

Command: authenticate [userlist] ¶

Check whether user is in userlist or listed in the value of variable ‘superusers’. See see superusers for valid user list format. If ‘superusers’ is empty, this command returns true. See Security.

17.4.4 background_color ¶

Command: background_color color ¶

Set background color for active terminal. For valid color specifications see see Colors. Background color can be changed only when using ‘gfxterm’ for terminal output.

This command sets color of empty areas without text. Text background color is controlled by environment variables color_normal, color_highlight, menu_color_normal, menu_color_highlight. See Special environment variables.

17.4.5 background_image ¶

Command: background_image [[--mode ‘stretch’|‘normal’] file] ¶

Load background image for active terminal from file. Image is stretched to fill up entire screen unless option --mode ‘normal’ is given. Without arguments remove currently loaded background image. Background image can be changed only when using ‘gfxterm’ for terminal output.

17.4.6 badram ¶

Command: badram addr,mask[,addr,mask...] ¶

Filter out bad RAM.

This command notifies the memory manager that specified regions of RAM ought to be filtered out (usually, because they’re damaged). This remains in effect after a payload kernel has been loaded by GRUB, as long as the loaded kernel obtains its memory map from GRUB. Kernels that support this include Linux, GNU Mach, the kernel of FreeBSD and Multiboot kernels in general.

Syntax is the same as provided by the Memtest86+ utility: a list of address/mask pairs. Given a page-aligned address and a base address / mask pair, if all the bits of the page-aligned address that are enabled by the mask match with the base address, it means this page is to be filtered. This syntax makes it easy to represent patterns that are often result of memory damage, due to physical distribution of memory cells.

The command is similar to cutmem command.

Note: The command is not allowed when lockdown is enforced (see Lockdown when booting on a secure setup). This prevents removing EFI memory regions to potentially subvert the security mechanisms provided by the UEFI secure boot.

17.4.7 blocklist ¶

Command: blocklist file ¶

Print a block list (see How to specify block lists) for file.

17.4.8 boot ¶

Command: boot ¶

Boot the OS or chain-loader which has been loaded. Only necessary if running the fully interactive command-line (it is implicit at the end of a menu entry).

17.4.9 cat ¶

Command: cat [--dos] file ¶

Display the contents of the file file. This command may be useful to remind you of your OS’s root partition:

grub> cat /etc/fstab

If the --dos option is used, then carriage return / new line pairs will be displayed as a simple new line. Otherwise, the carriage return will be displayed as a control character (‘<d>’) to make it easier to see when boot problems are caused by a file formatted using DOS-style line endings.

Note: cat can be used to view the contents of devices using the block list syntax (see How to specify block lists). However, it is not advised to view binary data because it will try to decode UTF-8 strings, which can lead to some bytes missing or added in the output. Instead, use the hexdump command (see hexdump).

17.4.10 clear ¶

Command: clear ¶

Clear the screen.

17.4.11 cmosclean ¶

Command: cmosclean byte:bit ¶

Clear value of bit in CMOS at location byte:bit. This command is available only on platforms that support CMOS.

17.4.12 cmosdump ¶

Dump: CMOS contents ¶

Dump full CMOS contents as hexadecimal values. This command is available only on platforms that support CMOS.

17.4.13 cmostest ¶

Command: cmostest byte:bit ¶

Test value of bit in CMOS at location byte:bit. Exit status is zero if bit is set, non zero otherwise. This command is available only on platforms that support CMOS.

17.4.14 cmp ¶

Command: cmp [-v] file1 file2 ¶

Compare the file file1 with the file file2. If they are completely identical, $? will be set to 0. Otherwise, if the files are not identical, $? will be set to a nonzero value.

By default nothing will be output. If the -v is used, verbose mode is enabled. In this mode when when the files differ in size, print the sizes like this:

Differ in size: 0x1234 [foo], 0x4321 [bar]

If the sizes are equal but the bytes at an offset differ, then print the bytes like this:

Differ at the offset 777: 0xbe [foo], 0xef [bar]

17.4.15 configfile ¶

Command: configfile file ¶

Load file as a configuration file. If file defines any menu entries, then show a menu containing them immediately. Any environment variable changes made by the commands in file will not be preserved after configfile returns.

17.4.16 cpuid ¶

Command: cpuid [-l] [-p] ¶

Check for CPU features. This command is only available on x86 systems.

With the -l option, return true if the CPU supports long mode (64-bit).

With the -p option, return true if the CPU supports Physical Address Extension (PAE).

If invoked without options, this command currently behaves as if it had been invoked with -l. This may change in the future.

17.4.17 crc ¶

Command: crc arg … ¶

Alias for hashsum --hash crc32 arg …. See command hashsum (see hashsum) for full description.

17.4.18 cryptomount ¶

Command: cryptomount [ [-p password] | [-k keyfile [-O keyoffset] [-S keysize] ] ] [-H file] device|-u uuid|-a|-b ¶

Setup access to encrypted device. A passphrase will be requested interactively, if neither the -p nor -k options are given. The option -p can be used to supply a passphrase (useful for scripts). Alternatively the -k option can be used to supply a keyfile with options -O and -S optionally supplying the offset and size, respectively, of the key data in the given key file. The -H options can be used to supply cryptomount backends with an alternative header file (aka detached header). Not all backends have headers nor support alternative header files (currently only LUKS1 and LUKS2 support them). Argument device configures specific grub device (see Naming convention); option -u uuid configures device with specified uuid; option -a configures all detected encrypted devices; option -b configures all geli containers that have boot flag set.

Devices are not allowed to be given as key files nor as detached header files. However, this limitation can be worked around by using blocklist syntax. So for instance, (hd1,gpt2) can not be used, but (hd1,gpt2)0+ will achieve the desired result.

GRUB suports devices encrypted using LUKS, LUKS2 and geli. Note that necessary modules (luks, luks2 and geli) have to be loaded manually before this command can be used. For LUKS2 only the PBKDF2 key derivation function is supported, as Argon2 is not yet supported.

Successfully decrypted disks are named as (cryptoX) and have increasing numeration suffix for each new decrypted disk. If the encrypted disk hosts some higher level of abstraction (like LVM2 or MDRAID) it will be created under a separate device namespace in addition to the cryptodisk namespace.

Support for plain encryption mode (plain dm-crypt) is provided via separate see plainmount command.

17.4.19 cutmem ¶

Command: cutmem from[K|M|G] to[K|M|G] ¶

Remove any memory regions in specified range.

This command notifies the memory manager that specified regions of RAM ought to be filtered out. This remains in effect after a payload kernel has been loaded by GRUB, as long as the loaded kernel obtains its memory map from GRUB. Kernels that support this include Linux, GNU Mach, the kernel of FreeBSD and Multiboot kernels in general.

The command is similar to badram command.

Note: The command is not allowed when lockdown is enforced (see Lockdown when booting on a secure setup). This prevents removing EFI memory regions to potentially subvert the security mechanisms provided by the UEFI secure boot.

17.4.20 date ¶

Command: date [[year-]month-day] [hour:minute[:second]] ¶

With no arguments, print the current date and time.

Otherwise, take the current date and time, change any elements specified as arguments, and set the result as the new date and time. For example, ‘date 01-01’ will set the current month and day to January 1, but leave the year, hour, minute, and second unchanged.

17.4.21 devicetree ¶

Command: devicetree file ¶

Load a device tree blob (.dtb) from a filesystem, for later use by a Linux kernel. Does not perform merging with any device tree supplied by firmware, but rather replaces it completely.

Note: The command is not allowed when lockdown is enforced (see Lockdown when booting on a secure setup). This is done to prevent subverting various security mechanisms.

17.4.22 distrust ¶

Command: distrust pubkey_id ¶

Remove public key pubkey_id from GRUB’s keyring of trusted keys. pubkey_id is the last four bytes (eight hexadecimal digits) of the GPG v4 key id, which is also the output of list_trusted (see list_trusted). Outside of GRUB, the key id can be obtained using gpg --fingerprint). These keys are used to validate signatures when environment variable check_signatures is set to enforce (see check_signatures), and by some invocations of verify_detached (see verify_detached). See Using digital signatures in GRUB, for more information.

17.4.23 drivemap ¶

Command: drivemap -l|-r|[-s] from_drive to_drive ¶

Without options, map the drive from_drive to the drive to_drive. This is necessary when you chain-load some operating systems, such as DOS, if such an OS resides at a non-first drive. For convenience, any partition suffix on the drive is ignored, so you can safely use ${root} as a drive specification.

With the -s option, perform the reverse mapping as well, swapping the two drives.

With the -l option, list the current mappings.

With the -r option, reset all mappings to the default values.

For example:

drivemap -s (hd0) (hd1)

NOTE: Only available on i386-pc.

17.4.24 echo ¶

Command: echo [-n] [-e] string … ¶

Display the requested text and, unless the -n option is used, a trailing new line. If there is more than one string, they are separated by spaces in the output. As usual in GRUB commands, variables may be substituted using ‘${var}’.

The -e option enables interpretation of backslash escapes. The following sequences are recognised:

\\

backslash

\a

alert (BEL)

\c

suppress trailing new line

\f

form feed

\n

new line

\r

carriage return

\t

horizontal tab

\v

vertical tab

When interpreting backslash escapes, backslash followed by any other character will print that character.

17.4.25 efitextmode ¶

Command: efitextmode [min | max | <mode_num> | <cols> <rows>] ¶

When used with no arguments displays all available text output modes. The set mode determines the columns and rows of the text display when in text mode. An asterisk, ‘*’, will be at the end of the line of the currently set mode.

If given a single parameter, it must be ‘min’, ‘max’, or a mode number given by the listing when run with no arguments. These arguments set the mode to the minimum, maximum, and particular mode respectively.

Otherwise, the command must be given two numerical arguments specifying the columns and rows of the desired mode. Specifying a columns and rows combination that corresponds to no supported mode, will return error, but otherwise have no effect.

By default GRUB will start in whatever mode the EFI firmware defaults to. There are firmwares known to set up the default mode such that output behaves strangely, for example the cursor in the GRUB shell never reaches the bottom of the screen or, when typing characters at the prompt, characters from previous command output are overwritten. Setting the mode may fix this.

The EFI specification says that mode 0 must be available and have columns and rows of 80 and 25 respectively. Mode 1 may be defined and if so must have columns and rows of 80 and 50 respectively. Any other modes may have columns and rows arbitrarily defined by the firmware. This means that a mode with columns and rows of 100 and 31 on one firmware may be a different mode number on a different firmware or not exist at all. Likewise, mode number 2 on one firmware may have a different number of columns and rows than mode 2 on a different firmware. So one should not rely on a particular mode number or a mode of a certain number of columns and rows existing on all firmwares, except for mode 0.

Note: This command is only available on EFI platforms and is similar to EFI shell "mode" command.

17.4.26 eval ¶

Command: eval string ... ¶

Concatenate arguments together using single space as separator and evaluate result as sequence of GRUB commands.

17.4.27 export ¶

Command: export envvar ¶

Export the environment variable envvar. Exported variables are visible to subsidiary configuration files loaded using configfile.

17.4.28 false ¶

Command: false ¶

Do nothing, unsuccessfully. This is mainly useful in control constructs such as if and while (see Writing full configuration files directly).

17.4.29 fwsetup ¶

Command: fwsetup [--is-supported] ¶

Reboot into the firmware setup menu. If --is-supported option is specified, instead check whether the firmware supports a setup menu and exit successfully if so.

17.4.30 gdbinfo ¶

Command: gdbinfo ¶

Output text to be used as a GDB command for a GDB session using the gdb_grub script and attached to a running GRUB instance. The GDB command that is output will tell GDB how to load debugging symbols to their proper runtime address. Currently this is only available for EFI platforms. See the Debugging in the developer documentation for more information.

17.4.31 gettext ¶

Command: gettext string ¶

Translate string into the current language.

The current language code is stored in the ‘lang’ variable in GRUB’s environment (see lang). Translation files in MO format are read from ‘locale_dir’ (see locale_dir), usually /boot/grub/locale.

17.4.32 gptsync ¶

Command: gptsync device [partition[+/-[type]]] … ¶

Disks using the GUID Partition Table (GPT) also have a legacy Master Boot Record (MBR) partition table for compatibility with the BIOS and with older operating systems. The legacy MBR can only represent a limited subset of GPT partition entries.

This command populates the legacy MBR with the specified partition entries on device. Up to three partitions may be used.

type is an MBR partition type code; prefix with ‘0x’ if you want to enter this in hexadecimal. The separator between partition and type may be ‘+’ to make the partition active, or ‘-’ to make it inactive; only one partition may be active. If both the separator and type are omitted, then the partition will be inactive.

17.4.33 halt ¶

Command: halt [--no-apm] ¶

The command halts the computer. On the i386-pc target, the --no-apm option, or short -n, is specified, no APM BIOS call is performed. Otherwise, the computer is shut down using APM on that target.

17.4.34 hashsum ¶

Command: hashsum --hash hash --keep-going --uncompress --check file [--prefix dir]|file … ¶

Compute or verify file hashes. Hash type is selected with option --hash. Supported hashes are: ‘adler32’, ‘crc64’, ‘crc32’, ‘crc32rfc1510’, ‘crc24rfc2440’, ‘md4’, ‘md5’, ‘ripemd160’, ‘sha1’, ‘sha224’, ‘sha256’, ‘sha512’, ‘sha384’, ‘tiger192’, ‘tiger’, ‘tiger2’, ‘whirlpool’. Option --uncompress uncompresses files before computing hash.

When list of files is given, hash of each file is computed and printed, followed by file name, each file on a new line.

When option --check is given, it points to a file that contains list of hash name pairs in the same format as used by UNIX md5sum command. Option --prefix may be used to give directory where files are located. Hash verification stops after the first mismatch was found unless option --keep-going was given. The exit code $? is set to 0 if hash verification is successful. If it fails, $? is set to a nonzero value.

17.4.35 help ¶

Command: help [pattern …] ¶

Display helpful information about builtin commands. If you do not specify pattern, this command shows short descriptions of all available commands.

If you specify any patterns, it displays longer information about each of the commands whose names begin with those patterns.

17.4.36 hexdump ¶

Command: hexdump [–skip offset] [–length len] FILE_OR_DEVICE ¶

Show raw contents of a file or memory. When option --skip is given, ‘offset’ number of bytes are skipped from the start of the device or file given. And --length allows specifying a maximum number of bytes to be shown.

If given the special device named ‘(mem)’, then the ‘offset’ given to --skip is treated as the address of a memory location to dump from.

17.4.37 insmod ¶

Command: insmod module ¶

Insert the dynamic GRUB module called module.

17.4.38 keystatus ¶

Command: keystatus [--shift] [--ctrl] [--alt] ¶

Return true if the Shift, Control, or Alt modifier keys are held down, as requested by options. This is useful in scripting, to allow some user control over behaviour without having to wait for a keypress.

Checking key modifier status is only supported on some platforms. If invoked without any options, the keystatus command returns true if and only if checking key modifier status is supported.

17.4.39 list_env ¶

Command: list_env [--file file] ¶

List all variables in the environment block file. See The GRUB environment block.

The --file option overrides the default location of the environment block.

17.4.40 list_trusted ¶

Command: list_trusted ¶

List all public keys trusted by GRUB for validating signatures. The output is in GPG’s v4 key fingerprint format (i.e., the output of gpg --fingerprint). The least significant four bytes (last eight hexadecimal digits) can be used as an argument to distrust (see distrust). See Using digital signatures in GRUB, for more information about uses for these keys.

17.4.41 load_env ¶

Command: load_env [--file file] [--skip-sig] [whitelisted_variable_name] … ¶

Load all variables from the environment block file into the environment. See The GRUB environment block.

The --file option overrides the default location of the environment block.

The --skip-sig option skips signature checking even when the value of environment variable check_signatures is set to enforce (see check_signatures).

If one or more variable names are provided as arguments, they are interpreted as a whitelist of variables to load from the environment block file. Variables set in the file but not present in the whitelist are ignored.

The --skip-sig option should be used with care, and should always be used in concert with a whitelist of acceptable variables whose values should be set. Failure to employ a carefully constructed whitelist could result in reading a malicious value into critical environment variables from the file, such as setting check_signatures=no, modifying prefix to boot from an unexpected location or not at all, etc.

When used with care, --skip-sig and the whitelist enable an administrator to configure a system to boot only signed configurations, but to allow the user to select from among multiple configurations, and to enable “one-shot” boot attempts and “savedefault” behavior. See Using digital signatures in GRUB, for more information.

17.4.42 loadfont ¶

Command: loadfont file … ¶

Load specified font files. Unless absolute pathname is given, file is assumed to be in directory ‘$prefix/fonts’ with suffix ‘.pf2’ appended. See Fonts.

17.4.43 loopback ¶

Command: loopback [-d] [-D] device file ¶

Make the device named device correspond to the contents of the filesystem image in file. For example:

loopback loop0 /path/to/image
ls (loop0)/

Specifying the -D option allows the loopback file to be tranparently decompressed if there is an appropriate decompressor loaded.

With the -d option, delete a device previously created using this command.

17.4.44 ls ¶

Command: ls [arg …] ¶

List devices or files.

With no arguments, print all devices known to GRUB.

If the argument is a device name enclosed in parentheses (see How to specify devices), then print the name of the filesystem of that device.

If the argument is a directory given as an absolute file name (see How to specify files), then list the contents of that directory.

17.4.45 lsfonts ¶

Command: lsfonts ¶

List loaded fonts.

17.4.46 lsmod ¶

Command: lsmod ¶

Show list of loaded modules.

17.4.47 md5sum ¶

Command: md5sum arg … ¶

Alias for hashsum --hash md5 arg …. See command hashsum (see hashsum) for full description.

17.4.48 module ¶

Command: module [–nounzip] file [arguments] ¶

Load a module for multiboot kernel image. The rest of the line is passed verbatim as the module command line.

17.4.49 multiboot ¶

Command: multiboot [–quirk-bad-kludge] [–quirk-modules-after-kernel] file … ¶

Load a multiboot kernel image from file. The rest of the line is passed verbatim as the kernel command-line. Any module must be reloaded after using this command (see module).

Some kernels have known problems. You need to specify –quirk-* for those. –quirk-bad-kludge is a problem seen in several products that they include loading kludge information with invalid data in ELF file. GRUB prior to 0.97 and some custom builds preferred ELF information while 0.97 and GRUB 2 use kludge. Use this option to ignore kludge. Known affected systems: old Solaris, SkyOS.

–quirk-modules-after-kernel is needed for kernels which load at relatively high address e.g. 16MiB mark and can’t cope with modules stuffed between 1MiB mark and beginning of the kernel. Known afftected systems: VMWare.

17.4.50 nativedisk ¶

Command: nativedisk ¶

Switch from firmware disk drivers to native ones. Really useful only on platforms where both firmware and native disk drives are available. Currently i386-pc, i386-efi, i386-ieee1275 and x86_64-efi.

17.4.51 normal ¶

Command: normal [file] ¶

Enter normal mode and display the GRUB menu.

In normal mode, commands, filesystem modules, and cryptography modules are automatically loaded, and the full GRUB script parser is available. Other modules may be explicitly loaded using insmod (see insmod).

If a file is given, then commands will be read from that file. Otherwise, they will be read from $prefix/grub.cfg if it exists.

normal may be called from within normal mode, creating a nested environment. It is more usual to use configfile (see configfile) for this.

17.4.52 normal_exit ¶

Command: normal_exit ¶

Exit normal mode (see normal). If this instance of normal mode was not nested within another one, then return to rescue mode.

17.4.53 parttool ¶

Command: parttool partition commands ¶

Make various modifications to partition table entries.

Each command is either a boolean option, in which case it must be followed with ‘+’ or ‘-’ (with no intervening space) to enable or disable that option, or else it takes a value in the form ‘command=value’.

Currently, parttool is only useful on DOS partition tables (also known as Master Boot Record, or MBR). On these partition tables, the following commands are available:

‘boot’ (boolean)

When enabled, this makes the selected partition be the active (bootable) partition on its disk, clearing the active flag on all other partitions. This command is limited to primary partitions.

‘type’ (value)

Change the type of an existing partition. The value must be a number in the range 0-0xFF (prefix with ‘0x’ to enter it in hexadecimal).

‘hidden’ (boolean)

When enabled, this hides the selected partition by setting the hidden bit in its partition type code; when disabled, unhides the selected partition by clearing this bit. This is useful only when booting DOS or Windows and multiple primary FAT partitions exist in one disk. See also DOS/Windows.

17.4.54 password ¶

Command: password user clear-password ¶

Define a user named user with password clear-password. See Security.

17.4.55 password_pbkdf2 ¶

Command: password_pbkdf2 user hashed-password ¶

Define a user named user with password hash hashed-password. Use grub-mkpasswd-pbkdf2 (see Invoking grub-mkpasswd-pbkdf2) to generate password hashes. See Security.

17.4.56 plainmount ¶

Command: plainmount device -c cipher -s key size [-h hash] ¶

[-S sector size] [-p password] [-u uuid] [[-d keyfile] [-O keyfile offset]]

Setup access to the encrypted device in plain mode. Offset of the encrypted data at the device is specified in terms of 512 byte sectors using the blocklist syntax and loopback device. The following example shows how to specify 1MiB offset:

loopback node (hd0,gpt1)2048+
plainmount node ...

The plainmount command can be used to open LUKS encrypted volume if its master key and parameters (key size, cipher, offset, etc) are known.

There are two ways to specify a password: a keyfile and a secret passphrase. The keyfile path parameter has higher priority than the secret passphrase parameter and is specified with the option -d. Password data obtained from keyfiles is not hashed and is used directly as a cipher key. An optional offset of password data in the keyfile can be specified with the option -O or directly with the option -d and GRUB blocklist syntax, if the keyfile data can be accessed from a device and is 512 byte aligned. The following example shows both methods to specify password data in the keyfile at offset 1MiB:

plainmount -d (hd0,gpt1)2048+ ...
plainmount -d (hd0,gpt1)+ -O 1048576 ...

If no keyfile is specified then the password is set to the string specified by option -p or is requested interactively from the console. In both cases the provided password is hashed with the algorithm specified by the option -h. This option is mandatory if no keyfile is specified, but it can be set to ‘plain’ which means that no hashing is done and such password is used directly as a key.

Cipher -c and keysize -s options specify the cipher algorithm and the key size respectively and are mandatory options. Cipher must be specified with the mode separated by a dash (for example, ‘aes-xts-plain64’). Key size option -s is the key size of the cipher in bits, not to be confused with the offset of the key data in a keyfile specified with the -O option. It must not exceed 1024 bits, so a 32 byte key would be specified as 256 bits

The optional parameter -S specifies encrypted device sector size. It must be at least 512 bytes long (default value) and a power of 2. ⁹. Disk sector size is configured when creating the encrypted volume. Attempting to decrypt volumes with a different sector size than it was created with will not result in an error, but will decrypt to random bytes and thus prevent accessing the volume (in some cases the filesystem driver can detect the presence of a filesystem, but nevertheless will refuse to mount it).

By default new plainmount devices will be given a UUID starting with ’109fea84-a6b7-34a8-4bd1-1c506305a401’ where the last digits are incremented by one for each plainmounted device beyond the first up to 2^10 devices.

All encryption arguments (cipher, hash, key size, disk offset and disk sector size) must match the parameters used to create the volume. If any of them does not match the actual arguments used during the initial encryption, plainmount will create virtual device with the garbage data and GRUB will report unknown filesystem for such device.

17.4.57 play ¶

Command: play file | tempo [pitch1 duration1] [pitch2 duration2] … ¶

Plays a tune

If the argument is a file name (see How to specify files), play the tune recorded in it. The file format is first the tempo as an unsigned 32bit little-endian number, then pairs of unsigned 16bit little-endian numbers for pitch and duration pairs.

If the arguments are a series of numbers, play the inline tune.

The tempo is the base for all note durations. 60 gives a 1-second base, 120 gives a half-second base, etc. Pitches are Hz. Set pitch to 0 to produce a rest.

17.4.58 probe ¶

Command: probe [--set var] --driver|--partmap|--fs|--fs-uuid|--label|--part-uuid device ¶

Retrieve device information. If option --set is given, assign result to variable var, otherwise print information on the screen.

The option --part-uuid is currently only implemented for MSDOS and GPT formatted disks.

17.4.59 rdmsr ¶

Command:: rdmsr 0xADDR [-v VARNAME] ¶

Read a model-specific register at address 0xADDR. If the parameter -v is used and an environment variable VARNAME is given, set that environment variable to the value that was read.

Please note that on SMP systems, reading from a MSR that has a scope per hardware thread, implies that the value that is returned only applies to the particular cpu/core/thread that runs the command.

Also, if you specify a reserved or unimplemented MSR address, it will cause a general protection exception (which is not currently being handled) and the system will reboot.

17.4.60 read ¶

Command: read [-s] [var] ¶

Read a line of input from the user. If an environment variable var is given, set that environment variable to the line of input that was read, with no terminating newline. If the parameter -s is used, enable silent mode where input is not printed to the terminal.

17.4.61 reboot ¶

Command: reboot ¶

Reboot the computer.

17.4.62 regexp ¶

Command: regexp [--set [number:]var] regexp string ¶

Test if regular expression regexp matches string. Supported regular expressions are POSIX.2 Extended Regular Expressions. If option --set is given, store numberth matched subexpression in variable var. Subexpressions are numbered in order of their opening parentheses starting from ‘1’. number defaults to ‘1’.

17.4.63 rmmod ¶

Command: rmmod module ¶

Remove a loaded module.

17.4.64 save_env ¶

Command: save_env [--file file] var … ¶

Save the named variables from the environment to the environment block file. See The GRUB environment block.

The --file option overrides the default location of the environment block.

This command will operate successfully even when environment variable check_signatures is set to enforce (see check_signatures), since it writes to disk and does not alter the behavior of GRUB based on any contents of disk that have been read. It is possible to modify a digitally signed environment block file from within GRUB using this command, such that its signature will no longer be valid on subsequent boots. Care should be taken in such advanced configurations to avoid rendering the system unbootable. See Using digital signatures in GRUB, for more information.

17.4.65 search ¶

Command: search [--file|--label|--fs-uuid] [--set [var]] [--no-floppy|--efidisk-only] name ¶

Search devices by file (-f, --file), filesystem label (-l, --label), or filesystem UUID (-u, --fs-uuid).

If the (-s, --set) option is used, the first device found is set as the value of environment variable var. The default variable is ‘root’.

The (-n, --no-floppy) option prevents searching floppy devices, which can be slow.

The (--efidisk-only) option prevents searching any other devices then EFI disks. This is typically used when chainloading to local EFI partition.

The ‘search.file’, ‘search.fs_label’, and ‘search.fs_uuid’ commands are aliases for ‘search --file’, ‘search --label’, and ‘search --fs-uuid’ respectively.

Also hints as to which device may be the most likely to contain the item searched for may be given via the (-h, --hint) option with a device name as an argument. If the argument ends with a comma, then partitions on the device are also searched. Furthermore, platform specific hints may be given via the options --hint-ieee1275, --hint-bios, --hint-baremetal, --hint-efi, and --hint-arc. When specified, these options take an argument and operate like --hint, but only on the specified platform.

17.4.66 sendkey ¶

Command: sendkey [--num|--caps|--scroll|--insert|--pause|--left-shift|--right-shift|--sysrq|--numkey|--capskey|--scrollkey|--insertkey|--left-alt|--right-alt|--left-ctrl|--right-ctrl ‘on’|‘off’]… [no-led] keystroke ¶

Insert keystrokes into the keyboard buffer when booting. Sometimes an operating system or chainloaded boot loader requires particular keys to be pressed: for example, one might need to press a particular key to enter "safe mode", or when chainloading another boot loader one might send keystrokes to it to navigate its menu.

Note: This command is currently only available on the i386-pc target.

You may provide up to 16 keystrokes (the length of the BIOS keyboard buffer). Keystroke names may be upper-case or lower-case letters, digits, or taken from the following table:

Name	Key
escape	Escape
exclam	!
at	@
numbersign	#
dollar	$
percent	%
caret	^
ampersand	&
asterisk	*
parenleft	(
parenright	)
minus	-
underscore	_
equal	=
plus	+
backspace	Backspace
tab	Tab
bracketleft	[
braceleft	{
bracketright	]
braceright	}
enter	Enter
control	press and release Control
semicolon	;
colon	:
quote	’
doublequote	"
backquote	‘
tilde	~
shift	press and release left Shift
backslash	\
bar	|
comma	,
less	<
period	.
greater	>
slash	/
question	?
rshift	press and release right Shift
alt	press and release Alt
space	space bar
capslock	Caps Lock
F1	F1
F2	F2
F3	F3
F4	F4
F5	F5
F6	F6
F7	F7
F8	F8
F9	F9
F10	F10
F11	F11
F12	F12
num1	1 (numeric keypad)
num2	2 (numeric keypad)
num3	3 (numeric keypad)
num4	4 (numeric keypad)
num5	5 (numeric keypad)
num6	6 (numeric keypad)
num7	7 (numeric keypad)
num8	8 (numeric keypad)
num9	9 (numeric keypad)
num0	0 (numeric keypad)
numperiod	. (numeric keypad)
numend	End (numeric keypad)
numdown	Down (numeric keypad)
numpgdown	Page Down (numeric keypad)
numleft	Left (numeric keypad)
numcenter	5 with Num Lock inactive (numeric keypad)
numright	Right (numeric keypad)
numhome	Home (numeric keypad)
numup	Up (numeric keypad)
numpgup	Page Up (numeric keypad)
numinsert	Insert (numeric keypad)
numdelete	Delete (numeric keypad)
numasterisk	* (numeric keypad)
numminus	- (numeric keypad)
numplus	+ (numeric keypad)
numslash	/ (numeric keypad)
numenter	Enter (numeric keypad)
delete	Delete
insert	Insert
home	Home
end	End
pgdown	Page Down
pgup	Page Up
down	Down
up	Up
left	Left
right	Right

As well as keystrokes, the sendkey command takes various options that affect the BIOS keyboard status flags. These options take an ‘on’ or ‘off’ parameter, specifying that the corresponding status flag be set or unset; omitting the option for a given status flag will leave that flag at its initial state at boot. The --num, --caps, --scroll, and --insert options emulate setting the corresponding mode, while the --numkey, --capskey, --scrollkey, and --insertkey options emulate pressing and holding the corresponding key. The other status flag options are self-explanatory.

If the --no-led option is given, the status flag options will have no effect on keyboard LEDs.

If the sendkey command is given multiple times, then only the last invocation has any effect.

Since sendkey manipulates the BIOS keyboard buffer, it may cause hangs, reboots, or other misbehaviour on some systems. If the operating system or boot loader that runs after GRUB uses its own keyboard driver rather than the BIOS keyboard functions, then sendkey will have no effect.

This command is only available on PC BIOS systems.

17.4.67 set ¶

Command: set [envvar=value] ¶

Set the environment variable envvar to value. If invoked with no arguments, print all environment variables with their values. For the list of environment variables currently used by GRUB itself see the relevant section see GRUB environment variables.

17.4.68 sha1sum ¶

Command: sha1sum arg … ¶

Alias for hashsum --hash sha1 arg …. See command hashsum (see hashsum) for full description.

17.4.69 sha256sum ¶

Command: sha256sum arg … ¶

Alias for hashsum --hash sha256 arg …. See command hashsum (see hashsum) for full description.

17.4.70 sha512sum ¶

Command: sha512sum arg … ¶

Alias for hashsum --hash sha512 arg …. See command hashsum (see hashsum) for full description.

17.4.71 sleep ¶

Command: sleep [--verbose] [--interruptible] count ¶

Sleep for count seconds. If option --interruptible is given, allow pressing ESC, F4 or holding down SHIFT to interrupt sleep. With --verbose show countdown of remaining seconds. Exit code is set to 0 if timeout expired and to 1 if timeout was interrupted using any of the mentioned keys.

17.4.72 smbios ¶

Command: smbios [--type type] [--handle handle] [--match match] (--get-byte | --get-word | --get-dword | --get-qword | --get-string | --get-uuid) offset [--set variable] ¶

Retrieve SMBIOS information.

The smbios command returns the value of a field in an SMBIOS structure. The following options determine which structure to select.

• Specifying --type will select structures with a matching type. The type can be any integer from 0 to 255.
• Specifying --handle will select structures with a matching handle. The handle can be any integer from 0 to 65535.
• Specifying --match will select structure number match in the filtered list of structures; e.g. smbios --type 4 --match 2 will select the second Process Information (Type 4) structure. The list is always ordered the same as the hardware’s SMBIOS table. The match number must be a positive integer. If unspecified, the first matching structure will be selected.

The remaining options determine which field in the selected SMBIOS structure to return. Only one of these options may be specified at a time.

• When given --get-byte, return the value of the byte at offset bytes into the selected SMBIOS structure. It will be formatted as an unsigned decimal integer.
• When given --get-word, return the value of the word (two bytes) at offset bytes into the selected SMBIOS structure. It will be formatted as an unsigned decimal integer.
• When given --get-dword, return the value of the dword (four bytes) at offset bytes into the selected SMBIOS structure. It will be formatted as an unsigned decimal integer.
• When given --get-qword, return the value of the qword (eight bytes) at offset bytes into the selected SMBIOS structure. It will be formatted as an unsigned decimal integer.
• When given --get-string, return the string with its index found at offset bytes into the selected SMBIOS structure.
• When given --get-uuid, return the value of the UUID (sixteen bytes) at offset bytes into the selected SMBIOS structure. It will be formatted as lower-case hyphenated hexadecimal digits, with the first three fields as little-endian, and the rest printed byte-by-byte.

The default action is to print the value of the requested field to the console, but a variable name can be specified with --set to store the value instead of printing it.

For example, this will store and then display the system manufacturer’s name.

smbios --type 1 --get-string 4 --set system_manufacturer
echo $system_manufacturer

17.4.73 source ¶

Command: source file ¶

Read file as a configuration file, as if its contents had been incorporated directly into the sourcing file. Unlike configfile (see configfile), this executes the contents of file without changing context: any environment variable changes made by the commands in file will be preserved after source returns, and the menu will not be shown immediately.

17.4.74 test ¶

Command: test expression ¶

Evaluate expression and return zero exit status if result is true, non zero status otherwise.

expression is one of:

string1 == string2

the strings are equal

string1 != string2

the strings are not equal

string1 < string2

string1 is lexicographically less than string2

string1 <= string2

string1 is lexicographically less or equal than string2

string1 > string2

string1 is lexicographically greater than string2

string1 >= string2

string1 is lexicographically greater or equal than string2

integer1 -eq integer2

integer1 is equal to integer2

integer1 -ge integer2

integer1 is greater than or equal to integer2

integer1 -gt integer2

integer1 is greater than integer2

integer1 -le integer2

integer1 is less than or equal to integer2

integer1 -lt integer2

integer1 is less than integer2

integer1 -ne integer2

integer1 is not equal to integer2

prefixinteger1 -pgt prefixinteger2

integer1 is greater than integer2 after stripping off common non-numeric prefix.

prefixinteger1 -plt prefixinteger2

integer1 is less than integer2 after stripping off common non-numeric prefix.

file1 -nt file2

file1 is newer than file2 (modification time). Optionally numeric bias may be directly appended to -nt in which case it is added to the first file modification time.

file1 -ot file2

file1 is older than file2 (modification time). Optionally numeric bias may be directly appended to -ot in which case it is added to the first file modification time.

-d file

file exists and is a directory

-e file

file exists

-f file

file exists and is not a directory

-s file

file exists and has a size greater than zero

-n string

the length of string is nonzero

string

string is equivalent to -n string

-z string

the length of string is zero

( expression )

expression is true

! expression

expression is false

expression1 -a expression2

both expression1 and expression2 are true

expression1 expression2

both expression1 and expression2 are true. This syntax is not POSIX-compliant and is not recommended.

expression1 -o expression2

either expression1 or expression2 is true

17.4.75 true ¶

Command: true ¶

Do nothing, successfully. This is mainly useful in control constructs such as if and while (see Writing full configuration files directly).