Plymouth: Difference between revisions

Roxwize (talk | contribs)
No edit summary
Added more example configurations and added relevant information pulled from the Arch Wiki
Line 1: Line 1:
<languages/>
<languages/>
<translate>
[https://www.freedesktop.org/wiki/Software/Plymouth Plymouth] is a project from Fedora and now listed among the [https://www.freedesktop.org/wiki/Software/#graphicsdriverswindowsystemsandsupportinglibraries freedesktop.org's official resources] providing a flicker-free graphical boot process. It relies on [https://wiki.archlinux.org/title/Kernel_mode_setting kernel mode setting] (KMS) to set the native resolution of the display as early as possible, then provides an eye-candy splash screen leading all the way up to the login manager.
<!--T:1-->
[<tvar name=1>https://www.freedesktop.org/wiki/Software/Plymouth</tvar> Plymouth] is an application that runs early in the boot process, providing a graphical boot animation. It is used by most desktop-oriented Linux distributions.


== Usage == <!--T:2-->
== Preparation ==
''Plymouth'' primarily uses KMS to display graphics, but on UEFI systems it can utilize the EFI framebuffer.


<!--T:3-->
If you have neither KMS nor a framebuffer, ''Plymouth'' will fall back to text-mode.<ref>https://wiki.archlinux.org/title/Plymouth</ref>
As an example, you can use a boot animation from [<tvar name=1>https://github.com/adi1090x/plymouth-themes</tvar> adi1090x's collection] like so:
</translate>


{{file|3={ pkgs, ... }: {
== Installation ==
 
=== Basic Config ===
<syntaxhighlight lang="nix">
{
  boot = {
    plymouth = {
      enable = true;
    };
 
    # Enable "Silent boot"
    consoleLogLevel = 3;
    initrd.verbose = false;
    kernelParams = [
      "quiet"
      "rd.udev.log_level=3"
      "rd.systemd.show_status=auto"
    ];
 
    # Hide the OS choice for bootloaders.
    # It's still possible to open the bootloader list by pressing any key
    # It will just not appear on screen unless a key is pressed
    loader.timeout = 0;
  };
}
</syntaxhighlight>
 
== Configuration ==
 
=== Changing the theme ===
Plymouth comes with a selection of themes:
 
# '''BGRT''': A variation of Spinner that keeps the OEM logo if available (BGRT stands for Boot Graphics Resource Table)
# '''Fade-in''': "Simple theme that fades in and out with shimmering stars"
# '''Glow''': "Corporate theme with pie chart boot progress followed by a glowing emerging logo"
# '''Script''': "Script example plugin" (Despite the description seems to be a quite nice Arch logo theme)
# '''Solar''': "Space theme with violent flaring blue star"
# '''Spinner''': "Simple theme with a loading spinner"
# '''Spinfinity''': "Simple theme that shows a rotating infinity sign in the center of the screen"
# '''Tribar''': "Text mode theme with tricolor progress bar"
# '''Text''': "Text mode theme with tricolor progress bar"
# '''Details''': "Verbose fallback theme"
 
NixOS sets the default theme to '''bgrt'''<ref>https://github.com/NixOS/nixpkgs/blob/8c91a71d13451abc40eb9dae8910f972f979852f/nixos/modules/system/boot/plymouth.nix</ref>. You can change the theme with `boot.plymouth.theme`:<syntaxhighlight lang="nix">
{
  boot = {
    plymouth = {
      enable = true;
      theme = "solar";
    };
  };
}
</syntaxhighlight>
 
=== Install new themes ===
As an example, you can use a boot animation from [<tvar name="1">https://github.com/adi1090x/plymouth-themes</tvar> adi1090x's collection] like so:{{file|3={ pkgs, ... }: {
   boot = {
   boot = {
     plymouth = {
     plymouth = {
Line 39: Line 91:
}|name=configuration.nix|lang=nix}}
}|name=configuration.nix|lang=nix}}


<translate>
=== HiDPI ===
<!--T:4-->
Edit the configuration file:<syntaxhighlight lang="nix">
{
  boot = {
    plymouth = {
      enable = true;
      extraConfig = ''
        [Daemon]
        DeviceScale=an-integer-scaling-factor
      '';
    };
  };
}
</syntaxhighlight>
 
== Tips and tricks ==
 
=== Show boot messages ===
During the graphical boot process, it is possible to switch to text mode and back by pressing the escape key.
During the graphical boot process, it is possible to switch to text mode and back by pressing the escape key.


<!--T:5-->
== Troubleshooting ==
 
=== LUKS Encryption ===
If you are using LUKS encryption the password prompt may fall back to text mode. While the default <code>bgrt</code> theme supports graphical password entry, this may not be supported by all themes.
If you are using LUKS encryption the password prompt may fall back to text mode. While the default <code>bgrt</code> theme supports graphical password entry, this may not be supported by all themes.
</translate>
 
== See Also ==
 
* [https://wiki.archlinux.org/title/Plymouth Arch Wiki]


[[Category:Booting]]
[[Category:Booting]]