{
    "mode": "man",
    "parameter": "grub-mkrescue",
    "section": "1",
    "url": "https://www.chedong.com/phpMan.php/man/grub-mkrescue/1/json",
    "generated": "2026-06-15T14:19:28Z",
    "synopsis": "grub-mkrescue [OPTION...] [OPTION] SOURCE...",
    "sections": {
        "NAME": {
            "content": "grub-mkrescue - make a GRUB rescue image\n",
            "subsections": []
        },
        "SYNOPSIS": {
            "content": "grub-mkrescue [OPTION...] [OPTION] SOURCE...\n",
            "subsections": []
        },
        "DESCRIPTION": {
            "content": "Make GRUB CD-ROM, disk, pendrive and floppy bootable image.\n\n--compress=no|xz|gz|lzo\ncompress GRUB files [optional]\n\n--dtb=FILE\nembed a specific DTB\n",
            "subsections": [
                {
                    "name": "-d --directory",
                    "content": "use images and modules under DIR [default=/usr/lib/grub/<platform>]\n",
                    "flag": "-d",
                    "long": "--directory"
                },
                {
                    "name": "--disable-shim-lock",
                    "content": "disable shimlock verifier\n\n--fonts=FONTS\ninstall FONTS [default=unicode]\n\n--install-modules=MODULES\ninstall only MODULES and their dependencies [default=all]\n",
                    "long": "--disable-shim-lock"
                },
                {
                    "name": "-k --pubkey",
                    "content": "embed FILE as public key for signature checking\n\n--locale-directory=DIR use translations under DIR\n[default=/usr/share/locale]\n\n--locales=LOCALES\ninstall only LOCALES [default=all]\n\n--modules=MODULES\npre-load specified modules MODULES\n\n--sbat=FILE\nSBAT metadata\n\n--themes=THEMES\ninstall THEMES [default=starfield]\n",
                    "flag": "-k",
                    "long": "--pubkey"
                },
                {
                    "name": "-v --verbose",
                    "content": "print verbose messages.\n",
                    "flag": "-v",
                    "long": "--verbose"
                },
                {
                    "name": "--arcs-boot",
                    "content": "enable  ARCS  (big-endian mips machines, mostly SGI) boot. Disables HFS+, APM, sparc64\nand boot as disk image for i386-pc\n\n--core-compress=xz|none|auto\nchoose the compression to use for core image\n\n--label-bgcolor=COLOR\nuse COLOR for label background\n\n--label-color=COLOR\nuse COLOR for label\n\n--label-font=FILE\nuse FILE as font for label\n",
                    "long": "--arcs-boot"
                },
                {
                    "name": "-o --output",
                    "content": "save output in FILE [required]\n\n--product-name=STRING\nuse STRING as product name\n\n--product-version=STRING\nuse STRING as product version\n\n--rom-directory=DIR\nsave ROM images in DIR [optional]\n",
                    "flag": "-o",
                    "long": "--output"
                },
                {
                    "name": "--sparc-boot",
                    "content": "enable sparc boot. Disables HFS+, APM, ARCS and boot as disk image for i386-pc\n\n--xorriso=FILE\nuse FILE as xorriso [optional]\n\n-?, --help\ngive this help list\n",
                    "long": "--sparc-boot"
                },
                {
                    "name": "--usage",
                    "content": "give a short usage message\n",
                    "long": "--usage"
                },
                {
                    "name": "-V --version",
                    "content": "print program version\n\nMandatory or optional arguments to long options are also mandatory or optional for any corre‐\nsponding short options.\n\nGenerates  a  bootable CD/USB/floppy image.  Arguments other than options to this program are\npassed to xorriso, and indicate source files, source directories, or any of the  mkisofs  op‐\ntions listed by the output of `xorriso -as mkisofs -help'.\n\nOption -- switches to native xorriso command mode.\n\nMail xorriso support requests to <bug-xorriso@gnu.org>.\n",
                    "flag": "-V",
                    "long": "--version"
                }
            ]
        },
        "REPORTING BUGS": {
            "content": "Report bugs to <bug-grub@gnu.org>.\n",
            "subsections": []
        },
        "SEE ALSO": {
            "content": "grub-mkimage(1)\n\nThe  full documentation for grub-mkrescue is maintained as a Texinfo manual.  If the info and\ngrub-mkrescue programs are properly installed at your site, the command\n\ninfo grub-mkrescue\n\nshould give you access to the complete manual.\n\n\n\nGRUB 2.06-2ubuntu7.2                        December 2022                           GRUB-MKRESCUE(1)",
            "subsections": []
        }
    },
    "summary": "grub-mkrescue - make a GRUB rescue image",
    "flags": [
        {
            "flag": "-d",
            "long": "--directory",
            "arg": null,
            "description": "use images and modules under DIR [default=/usr/lib/grub/<platform>]"
        },
        {
            "flag": "",
            "long": "--disable-shim-lock",
            "arg": null,
            "description": "disable shimlock verifier --fonts=FONTS install FONTS [default=unicode] --install-modules=MODULES install only MODULES and their dependencies [default=all]"
        },
        {
            "flag": "-k",
            "long": "--pubkey",
            "arg": null,
            "description": "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]"
        },
        {
            "flag": "-v",
            "long": "--verbose",
            "arg": null,
            "description": "print verbose messages."
        },
        {
            "flag": "",
            "long": "--arcs-boot",
            "arg": null,
            "description": "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"
        },
        {
            "flag": "-o",
            "long": "--output",
            "arg": null,
            "description": "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]"
        },
        {
            "flag": "",
            "long": "--sparc-boot",
            "arg": null,
            "description": "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"
        },
        {
            "flag": "",
            "long": "--usage",
            "arg": null,
            "description": "give a short usage message"
        },
        {
            "flag": "-V",
            "long": "--version",
            "arg": null,
            "description": "print program version Mandatory or optional arguments to long options are also mandatory or optional for any corre‐ sponding 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 op‐ tions listed by the output of `xorriso -as mkisofs -help'. Option -- switches to native xorriso command mode. Mail xorriso support requests to <bug-xorriso@gnu.org>."
        }
    ],
    "examples": [],
    "see_also": [
        {
            "name": "grub-mkimage",
            "section": "1",
            "url": "https://www.chedong.com/phpMan.php/man/grub-mkimage/1/json"
        },
        {
            "name": "GRUB-MKRESCUE",
            "section": "1",
            "url": "https://www.chedong.com/phpMan.php/man/GRUB-MKRESCUE/1/json"
        }
    ],
    "tldr": {
        "source": "official",
        "description": "Make a GRUB CD/USB/floppy bootable image.",
        "examples": [
            {
                "description": "Create a bootable ISO from the current directory and save it as `grub.iso`",
                "command": "grub-mkrescue --output {{grub.iso}} ."
            },
            {
                "description": "Create an ISO using GRUB files from a custom directory",
                "command": "grub-mkrescue --directory {{/usr/lib/grub/i386-pc}} --output {{grub.iso}} {{path/to/source}}"
            },
            {
                "description": "Use compression for GRUB files when building the image, setting `no` disables compression",
                "command": "grub-mkrescue --compress {{no|xz|gz|lzo}} --output {{grub.iso}} {{path/to/source}}"
            },
            {
                "description": "Disable the GRUB command-line interface in the generated image",
                "command": "grub-mkrescue --disable-cli --output {{grub.iso}} {{path/to/source}}"
            },
            {
                "description": "Preload specific GRUB modules into the image",
                "command": "grub-mkrescue --modules \"{{part_gpt iso9660}}\" --output {{grub.iso}} {{path/to/source}}"
            },
            {
                "description": "Pass additional options directly to `xorriso`",
                "command": "grub-mkrescue --output {{grub.iso}} -- {{volid}} {{volume_name}} {{path/to/source}}"
            },
            {
                "description": "Display help",
                "command": "grub-mkrescue {{-?|--help}}"
            },
            {
                "description": "Display version",
                "command": "grub-mkrescue --version"
            }
        ]
    }
}