diff options
| author | Samuel Dionne-Riel <samuel@dionne-riel.com> | 2018-05-13 16:59:51 -0400 |
|---|---|---|
| committer | Samuel Dionne-Riel <samuel@dionne-riel.com> | 2018-05-13 19:48:00 -0400 |
| commit | 8f3a541a3d096e5b8cd70112632bd8a6af283010 (patch) | |
| tree | e8e5b0b03befad04add6f47ceca80b10492997a6 /nixos/modules/system/boot/loader | |
| parent | 6db7f92cc2af827e8b8b181bf5ed828a1d0f141d (diff) | |
| download | nixlib-8f3a541a3d096e5b8cd70112632bd8a6af283010.tar nixlib-8f3a541a3d096e5b8cd70112632bd8a6af283010.tar.gz nixlib-8f3a541a3d096e5b8cd70112632bd8a6af283010.tar.bz2 nixlib-8f3a541a3d096e5b8cd70112632bd8a6af283010.tar.lz nixlib-8f3a541a3d096e5b8cd70112632bd8a6af283010.tar.xz nixlib-8f3a541a3d096e5b8cd70112632bd8a6af283010.tar.zst nixlib-8f3a541a3d096e5b8cd70112632bd8a6af283010.zip | |
nixos/grub: Updates `splashImage` description to match reality.
Fixes #4911
Diffstat (limited to 'nixos/modules/system/boot/loader')
| -rw-r--r-- | nixos/modules/system/boot/loader/grub/grub.nix | 18 |
1 files changed, 15 insertions, 3 deletions
diff --git a/nixos/modules/system/boot/loader/grub/grub.nix b/nixos/modules/system/boot/loader/grub/grub.nix index e2cff1c1bd94..67daaa333e5e 100644 --- a/nixos/modules/system/boot/loader/grub/grub.nix +++ b/nixos/modules/system/boot/loader/grub/grub.nix @@ -308,10 +308,22 @@ in type = types.nullOr types.path; example = literalExample "./my-background.png"; description = '' - Background image used for GRUB. It must be a 640x480, + Background image used for GRUB. + Set to <literal>null</literal> to run GRUB in text mode. + + <note><para> + For grub 1: + It must be a 640x480, 14-colour image in XPM format, optionally compressed with - <command>gzip</command> or <command>bzip2</command>. Set to - <literal>null</literal> to run GRUB in text mode. + <command>gzip</command> or <command>bzip2</command>. + </para></note> + + <note><para> + For grub 2: + File must be one of .png, .tga, .jpg, or .jpeg. JPEG images must + not be progressive. + The image will be scaled if necessary to fit the screen. + </para></note> ''; }; |