Reference

grub-mkrescue(1)

make a GRUB rescue image

NAME

grub-mkrescue - make a GRUB rescue image

SYNOPSIS

grub-mkrescue [OPTION...] [OPTION] SOURCE...

DESCRIPTION

Make GRUB CD-ROM, disk, pendrive and floppy bootable image.

--appended-signature-size=SIZE

Add a note segment reserving SIZE bytes for an appended signature

--compress=no|xz|gz|lzo

compress GRUB files [optional]

--disable-cli

disabled command line interface access

--disable-shim-lock

disable shim_lock verifier

--dtb=FILE

embed a specific DTB

-d, --directory=DIR

use images and modules under DIR [default=/usr/lib/grub/<platform>]

--fonts=FONTS

install FONTS [default=unicode]

--install-modules=MODULES

install only MODULES and their dependencies [default=all]

-k, --pubkey=FILE

embed FILE as public key for signature checking

--locale-directory=DIR use translations under DIR

[default=/usr/share/locale]

--locales=LOCALES

install only LOCALES [default=all]

--modules=MODULES

pre-load specified modules MODULES

--sbat=FILE

SBAT metadata

--themes=THEMES

install THEMES [default=starfield]

-v, --verbose

print verbose messages.

-x, --x509key=FILE

embed FILE as an x509 certificate for appended signature checking

--arcs-boot

enable ARCS (big-endian mips machines, mostly SGI) boot. Disables HFS+, APM, sparc64 and boot as disk image for i386-pc

--core-compress=xz|none|auto

choose the compression to use for core image

--label-bgcolor=COLOR

use COLOR for label background

--label-color=COLOR

use COLOR for label

--label-font=FILE

use FILE as font for label

-o, --output=FILE

save output in FILE [required]

--product-name=STRING

use STRING as product name

--product-version=STRING

use STRING as product version

--rom-directory=DIR

save ROM images in DIR [optional]

--sparc-boot

enable sparc boot. Disables HFS+, APM, ARCS and boot as disk image for i386-pc

--xorriso=FILE

use FILE as xorriso [optional]

-?, --help

give this help list

--usage

give a short usage message

-V, --version

print program version

Mandatory or optional arguments to long options are also mandatory or optional for any corresponding short options.

Generates a bootable CD/USB/floppy image. Arguments other than options to this program are passed to xorriso, and indicate source files, source directories, or any of the mkisofs options listed by the output of `xorriso -as mkisofs -help'.

Option -- switches to native xorriso command mode.

Mail xorriso support requests to <[email protected]>.

REPORTING BUGS

Report bugs to <[email protected]>.

SEE ALSO

grub-mkimage(1)

The full documentation for grub-mkrescue is maintained as a Texinfo manual. If the info and grub-mkrescue programs are properly installed at your site, the command

info grub-mkrescue

should give you access to the complete manual.

History

--appended-signature-size since Arch Linux 2026-11-01; --arcs-boot since Debian 8 (Jessie); --compress since Debian 8 (Jessie); --core-compress since Debian 8 (Jessie); --directory since Debian 8 (Jessie); --disable-cli since Arch Linux 2026-11-01; --disable-shim-lock since Debian 10 (Buster); --dtb since Debian 10 (Buster); --fonts since Debian 8 (Jessie); --install-modules since Debian 8 (Jessie); --label-bgcolor since Debian 8 (Jessie); --label-color since Debian 8 (Jessie); --label-font since Debian 8 (Jessie); --locales since Debian 8 (Jessie); --output since Debian 6.0 (Squeeze); --product-name since Debian 8 (Jessie); --product-version since Debian 8 (Jessie); --pubkey since Debian 8 (Jessie); --rom-directory since Debian 6.0 (Squeeze); --sbat since Debian 10 (Buster); --sparc-boot since Debian 8 (Jessie); --themes since Debian 8 (Jessie); --usage since Debian 8 (Jessie); --verbose since Debian 8 (Jessie); --x509key since Arch Linux 2026-11-01; --xorriso since Debian 6.0 (Squeeze); -? since Debian 8 (Jessie); -V since Debian 8 (Jessie); -d since Debian 8 (Jessie); -k since Debian 8 (Jessie); -o since Debian 6.0 (Squeeze); -x since Arch Linux 2026-11-01.

--diet until Debian 7 (Wheezy); --emulation until Debian 5.0 (Lenny); --grub-mkimage until Debian 7 (Wheezy); --image-type until Debian 5.0 (Lenny); --overlay until Debian 5.0 (Lenny); --pkglibdir until Debian 5.0 (Lenny); -h until Debian 7 (Wheezy).