diff options
Diffstat (limited to 'nixos/modules/system/boot/loader/grub/grub.nix')
| -rw-r--r-- | nixos/modules/system/boot/loader/grub/grub.nix | 122 |
1 files changed, 61 insertions, 61 deletions
diff --git a/nixos/modules/system/boot/loader/grub/grub.nix b/nixos/modules/system/boot/loader/grub/grub.nix index 1f915d1f419..00ec3d237d5 100644 --- a/nixos/modules/system/boot/loader/grub/grub.nix +++ b/nixos/modules/system/boot/loader/grub/grub.nix @@ -103,7 +103,7 @@ in default = !config.boot.isContainer; defaultText = literalExpression "!config.boot.isContainer"; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to enable the GNU GRUB boot loader. ''; }; @@ -112,9 +112,9 @@ in default = 2; example = 1; type = types.int; - description = '' - The version of GRUB to use: <literal>1</literal> for GRUB - Legacy (versions 0.9x), or <literal>2</literal> (the + description = lib.mdDoc '' + The version of GRUB to use: `1` for GRUB + Legacy (versions 0.9x), or `2` (the default) for GRUB 2. ''; }; @@ -123,12 +123,12 @@ in default = ""; example = "/dev/disk/by-id/wwn-0x500001234567890a"; type = types.str; - description = '' + description = lib.mdDoc '' The device on which the GRUB boot loader will be installed. - The special value <literal>nodev</literal> means that a GRUB + The special value `nodev` means that a GRUB boot menu will be generated, but GRUB itself will not actually be installed. To install GRUB on multiple devices, - use <literal>boot.loader.grub.devices</literal>. + use `boot.loader.grub.devices`. ''; }; @@ -136,9 +136,9 @@ in default = []; example = [ "/dev/disk/by-id/wwn-0x500001234567890a" ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' The devices on which the boot loader, GRUB, will be - installed. Can be used instead of <literal>device</literal> to + installed. Can be used instead of `device` to install GRUB onto multiple devices. ''; }; @@ -148,7 +148,7 @@ in example = { root = { hashedPasswordFile = "/path/to/file"; }; }; - description = '' + description = lib.mdDoc '' User accounts for GRUB. When specified, the GRUB command line and all boot options except the default are password-protected. All passwords and hashes provided will be stored in /boot/grub/grub.cfg, @@ -163,7 +163,7 @@ in example = "/path/to/file"; default = null; type = with types; uniq (nullOr str); - description = '' + description = lib.mdDoc '' Specifies the path to a file containing the password hash for the account, generated with grub-mkpasswd-pbkdf2. This hash will be stored in /boot/grub/grub.cfg, and will @@ -174,7 +174,7 @@ in example = "grub.pbkdf2.sha512.10000.674DFFDEF76E13EA...2CC972B102CF4355"; default = null; type = with types; uniq (nullOr str); - description = '' + description = lib.mdDoc '' Specifies the password hash for the account, generated with grub-mkpasswd-pbkdf2. This hash will be copied to the Nix store, and will be visible to all local users. @@ -184,7 +184,7 @@ in example = "/path/to/file"; default = null; type = with types; uniq (nullOr str); - description = '' + description = lib.mdDoc '' Specifies the path to a file containing the clear text password for the account. This password will be stored in /boot/grub/grub.cfg, and will @@ -195,7 +195,7 @@ in example = "Pa$$w0rd!"; default = null; type = with types; uniq (nullOr str); - description = '' + description = lib.mdDoc '' Specifies the clear text password for the account. This password will be copied to the Nix store, and will be visible to all local users. ''; @@ -210,7 +210,7 @@ in { path = "/boot1"; devices = [ "/dev/disk/by-id/wwn-0x500001234567890a" ]; } { path = "/boot2"; devices = [ "/dev/disk/by-id/wwn-0x500009876543210a" ]; } ]; - description = '' + description = lib.mdDoc '' Mirror the boot configuration to multiple partitions and install grub to the respective devices corresponding to those partitions. ''; @@ -221,7 +221,7 @@ in path = mkOption { example = "/boot1"; type = types.str; - description = '' + description = lib.mdDoc '' The path to the boot directory where GRUB will be written. Generally this boot path should double as an EFI path. ''; @@ -231,7 +231,7 @@ in default = null; example = "/boot1/efi"; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The path to the efi system mount point. Usually this is the same partition as the above path and can be left as null. ''; @@ -241,10 +241,10 @@ in default = null; example = "NixOS-fsid"; type = types.nullOr types.str; - description = '' + description = lib.mdDoc '' The id of the bootloader to store in efi nvram. The default is to name it NixOS and append the path or efiSysMountPoint. - This is only used if <literal>boot.loader.efi.canTouchEfiVariables</literal> is true. + This is only used if `boot.loader.efi.canTouchEfiVariables` is true. ''; }; @@ -252,7 +252,7 @@ in default = [ ]; example = [ "/dev/disk/by-id/wwn-0x500001234567890a" "/dev/disk/by-id/wwn-0x500009876543210a" ]; type = types.listOf types.str; - description = '' + description = lib.mdDoc '' The path to the devices which will have the GRUB MBR written. Note these are typically device paths and not paths to partitions. ''; @@ -266,7 +266,7 @@ in default = ""; example = "Stable 2.6.21"; type = types.str; - description = '' + description = lib.mdDoc '' GRUB entry name instead of default. ''; }; @@ -274,7 +274,7 @@ in storePath = mkOption { default = "/nix/store"; type = types.str; - description = '' + description = lib.mdDoc '' Path to the Nix store when looking for kernels at boot. Only makes sense when copyKernels is false. ''; @@ -283,7 +283,7 @@ in extraPrepareConfig = mkOption { default = ""; type = types.lines; - description = '' + description = lib.mdDoc '' Additional bash commands to be run at the script that prepares the GRUB menu entries. ''; @@ -297,7 +297,7 @@ in terminal_output --append serial ''; type = types.lines; - description = '' + description = lib.mdDoc '' Additional GRUB commands inserted in the configuration file just before the menu entries. ''; @@ -307,26 +307,26 @@ in default = [ ]; example = [ "--modules=nativedisk ahci pata part_gpt part_msdos diskfilter mdraid1x lvm ext2" ]; type = types.listOf types.str; - description = '' - Additional arguments passed to <literal>grub-install</literal>. + description = lib.mdDoc '' + Additional arguments passed to `grub-install`. A use case for this is to build specific GRUB2 modules directly into the GRUB2 kernel image, so that they are available - and activated even in the <literal>grub rescue</literal> shell. + and activated even in the `grub rescue` shell. They are also necessary when the BIOS/UEFI is bugged and cannot correctly read large disks (e.g. above 2 TB), so GRUB2's own - <literal>nativedisk</literal> and related modules can be used + `nativedisk` and related modules can be used to use its own disk drivers. The example shows one such case. This is also useful for booting from USB. See the - <link xlink:href="http://git.savannah.gnu.org/cgit/grub.git/tree/grub-core/commands/nativedisk.c?h=grub-2.04#n326"> + [ GRUB source code - </link> + ](http://git.savannah.gnu.org/cgit/grub.git/tree/grub-core/commands/nativedisk.c?h=grub-2.04#n326) for which disk modules are available. - The list elements are passed directly as <literal>argv</literal> - arguments to the <literal>grub-install</literal> program, in order. + The list elements are passed directly as `argv` + arguments to the `grub-install` program, in order. ''; }; @@ -344,7 +344,7 @@ in export GNUPGHOME=$old_gpg_home ''; type = types.lines; - description = '' + description = lib.mdDoc '' Additional shell commands inserted in the bootloader installer script after generating menu entries. ''; @@ -354,7 +354,7 @@ in default = ""; example = "root (hd0)"; type = types.lines; - description = '' + description = lib.mdDoc '' Additional GRUB commands inserted in the configuration file at the start of each NixOS menu entry. ''; @@ -379,7 +379,7 @@ in chainloader /efi/fedora/grubx64.efi } ''; - description = '' + description = lib.mdDoc '' Any additional entries you want added to the GRUB boot menu. ''; }; @@ -387,7 +387,7 @@ in extraEntriesBeforeNixOS = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether extraEntries are included before the default option. ''; }; @@ -398,10 +398,10 @@ in example = literalExpression '' { "memtest.bin" = "''${pkgs.memtest86plus}/memtest.bin"; } ''; - description = '' - A set of files to be copied to <filename>/boot</filename>. + description = lib.mdDoc '' + A set of files to be copied to {file}`/boot`. Each attribute name denotes the destination file name in - <filename>/boot</filename>, while the corresponding + {file}`/boot`, while the corresponding attribute value specifies the source file. ''; }; @@ -409,7 +409,7 @@ in useOSProber = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' If set to true, append entries for other OSs detected by os-prober. ''; }; @@ -503,7 +503,7 @@ in type = types.nullOr types.path; default = "${realGrub}/share/grub/unicode.pf2"; defaultText = literalExpression ''"''${pkgs.grub2}/share/grub/unicode.pf2"''; - description = '' + description = lib.mdDoc '' Path to a TrueType, OpenType, or pf2 font to be used by Grub. ''; }; @@ -512,8 +512,8 @@ in type = types.nullOr types.int; example = 16; default = null; - description = '' - Font size for the grub menu. Ignored unless <literal>font</literal> + description = lib.mdDoc '' + Font size for the grub menu. Ignored unless `font` is set to a ttf or otf font. ''; }; @@ -522,7 +522,7 @@ in default = "auto"; example = "1024x768"; type = types.str; - description = '' + description = lib.mdDoc '' The gfxmode to pass to GRUB when loading a graphical boot interface under EFI. ''; }; @@ -531,7 +531,7 @@ in default = "1024x768"; example = "auto"; type = types.str; - description = '' + description = lib.mdDoc '' The gfxmode to pass to GRUB when loading a graphical boot interface under BIOS. ''; }; @@ -540,7 +540,7 @@ in default = "keep"; example = "text"; type = types.str; - description = '' + description = lib.mdDoc '' The gfxpayload to pass to GRUB when loading a graphical boot interface under EFI. ''; }; @@ -549,7 +549,7 @@ in default = "text"; example = "keep"; type = types.str; - description = '' + description = lib.mdDoc '' The gfxpayload to pass to GRUB when loading a graphical boot interface under BIOS. ''; }; @@ -558,7 +558,7 @@ in default = 100; example = 120; type = types.int; - description = '' + description = lib.mdDoc '' Maximum of configurations in boot menu. GRUB has problems when there are too many entries. ''; @@ -567,7 +567,7 @@ in copyKernels = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether the GRUB menu builder should copy kernels and initial ramdisks to /boot. This is done automatically if /boot is on a different partition than /. @@ -578,7 +578,7 @@ in default = "0"; type = types.either types.int types.str; apply = toString; - description = '' + description = lib.mdDoc '' Index of the default menu item to be booted. Can also be set to "saved", which will make GRUB select the menu item that was used at the last boot. @@ -588,13 +588,13 @@ in fsIdentifier = mkOption { default = "uuid"; type = types.enum [ "uuid" "label" "provided" ]; - description = '' + description = lib.mdDoc '' Determines how GRUB will identify devices when generating the configuration file. A value of uuid / label signifies that grub will always resolve the uuid or label of the device before using it in the configuration. A value of provided means that GRUB will - use the device name as show in <command>df</command> or - <command>mount</command>. Note, zfs zpools / datasets are ignored + use the device name as show in {command}`df` or + {command}`mount`. Note, zfs zpools / datasets are ignored and will always be mounted using their labels. ''; }; @@ -602,7 +602,7 @@ in zfsSupport = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether GRUB should be built against libzfs. ZFS support is only available for GRUB v2. This option is ignored for GRUB v1. @@ -612,7 +612,7 @@ in efiSupport = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether GRUB should be built with EFI support. EFI support is only available for GRUB v2. This option is ignored for GRUB v1. @@ -659,7 +659,7 @@ in enableCryptodisk = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable support for encrypted partitions. GRUB should automatically unlock the correct encrypted partition and look for filesystems. ''; @@ -668,7 +668,7 @@ in forceInstall = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to try and forcibly install GRUB even if problems are detected. It is not recommended to enable this unless you know what you are doing. @@ -678,7 +678,7 @@ in forcei686 = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Whether to force the use of a ia32 boot loader on x64 systems. Required to install and run NixOS on 64bit x86 systems with 32bit (U)EFI. ''; @@ -689,7 +689,7 @@ in enable = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Enable trusted boot. GRUB will measure all critical components during the boot process to offer TCG (TPM) support. ''; @@ -699,7 +699,7 @@ in default = ""; example = "YES_TPM_is_activated"; type = types.str; - description = '' + description = lib.mdDoc '' Assertion that the target system has an activated TPM. It is a safety check before allowing the activation of 'trustedBoot.enable'. TrustedBoot WILL FAIL TO BOOT YOUR SYSTEM if no TPM is available. @@ -709,7 +709,7 @@ in isHPLaptop = mkOption { default = false; type = types.bool; - description = '' + description = lib.mdDoc '' Use a special version of TrustedGRUB that is needed by some HP laptops and works only for the HP laptops. ''; |