grub-script-check is a command-line utility that is used to check a GRUB (GRand Unified Bootloader) script file for syntax errors. The GRUB script file, typically called “grub.cfg”, is the configuration file that contains information about the available operating systems and boot options, as well as other settings such as the default boot option and the timeout before the default option is automatically selected.
The grub-script-check command reads a GRUB script file and checks it for syntax errors. If any errors are found, it will print them to the console and exit with a non-zero status code. If no errors are found, it will exit with a zero status code.
For example, to check a grub.cfg file for syntax errors, you would use the following command:
# grub-script-check /path/to/grub.cfg
You can also use the command without specifying a path and it will read from the standard input, for example:
# cat /path/to/grub.cfg | grub-script-check
It’s important to note that if you’re using grub-mkconfig to generate your grub.cfg file, you should run grub-script-check after generating the file to ensure that it does not contain any syntax errors. This command is useful when you are troubleshooting any issue with the bootloader, or when you are making manual changes to the grub.cfg file and you want to make sure that it is valid.
If you encounter the below error while running the command grub-script-check:
grub-script-check: command not found
you may try installing the below package as per your choice of distribution:
Distribution | Command |
---|---|
Debian | apt-get install grub-common |
Ubuntu | apt-get install grub-common |
Alpine | apk add grub |
Arch Linux | pacman -S grub |
Kali Linux | apt-get install grub-common |
CentOS | yum install grub |
Raspbian | apt-get install grub-common |
grub-script-check Command Examples
1. Check a specific script file for syntax errors:
# grub-script-check path/to/grub_config_file
2. Display each line of input after reading it:
# grub-script-check --verbose
3. Display version:
# grub-script-check --version
4. Display help:
# grub-script-check --help