Difference between revisions of "Plymouth"

From ArchWiki
Jump to: navigation, search
(Undo revision 280422 by AgrawalAshishS (talk) 'udev' hook is recommended, it should not be removed for no reason)
(Added infos taken from plymouth-git.install file)
Line 17: Line 17:
 
Plymouth is not presently available in the [[Official Repositories]], and will need to be installed from the [[AUR]].
 
Plymouth is not presently available in the [[Official Repositories]], and will need to be installed from the [[AUR]].
  
The stable one is called {{AUR|plymouth}} and the git version {{AUR|plymouth-git}}.
+
The stable one is called {{AUR|plymouth}} and the git version {{AUR|plymouth-git}}. The package we refer to in this article is '''plymouth-git''', which ''actually'' is much better tidy and contains several corrections and additions.
  
==Configuration==
+
=== The ''plymouth'' hook ===
  
===Including Plymouth in the Initcpio===
+
Add {{ic|plymouth}} to the HOOKS array in {{ic|/etc/[[mkinitcpio.conf]]}}. It '''must''' be added ''after'' '''base''' and '''udev''' for it to work:
 
+
Add Plymouth to the HOOKS array in {{ic|/etc/[[mkinitcpio.conf]]}}. It '''must''' be added ''after'' '''base''' and '''udev''' for it to work:
+
 
{{hc|/etc/mkinitcpio.conf|2=HOOKS="base udev plymouth [...] "}}
 
{{hc|/etc/mkinitcpio.conf|2=HOOKS="base udev plymouth [...] "}}
 
 
{{Warning|If you use [[System Encryption with LUKS for dm-crypt|hard drive encryption]] with the '''encrypt''' hook, you ''must'' replace the '''encrypt''' hook with '''plymouth-encrypt''' in order to get to the TTY password prompts.}}
 
{{Warning|If you use [[System Encryption with LUKS for dm-crypt|hard drive encryption]] with the '''encrypt''' hook, you ''must'' replace the '''encrypt''' hook with '''plymouth-encrypt''' in order to get to the TTY password prompts.}}
 
 
For early KMS start add the module [[radeon]] (for radeon cards), [[Intel|i915]] (for intel cards) or [[nouveau]] (for nvidia cards) to the MODULES line in {{ic|/etc/mkinitcpio.conf}}:
 
For early KMS start add the module [[radeon]] (for radeon cards), [[Intel|i915]] (for intel cards) or [[nouveau]] (for nvidia cards) to the MODULES line in {{ic|/etc/mkinitcpio.conf}}:
 
 
{{hc|/etc/mkinitcpio.conf|2=MODULES="i915"
 
{{hc|/etc/mkinitcpio.conf|2=MODULES="i915"
 
'''or'''
 
'''or'''
Line 36: Line 31:
 
MODULES="nouveau"}}
 
MODULES="nouveau"}}
  
Rebuild your initrd image (refer to the [[mkinitcpio]] article for more info):
+
=== The kernel command line ===
{{bc|# mkinitcpio -p [name of your kernel preset]}}
+
 
+
===The kernel command line===
+
  
 
You now need to set {{ic|quiet splash}} as you kernel command line parameters in your bootloader. See [[Kernel parameters]] for more info.
 
You now need to set {{ic|quiet splash}} as you kernel command line parameters in your bootloader. See [[Kernel parameters]] for more info.
  
===Changing the Theme===
+
Rebuild your initrd image ({{ic|# mkinitcpio -p [kernel preset name]}} – refer to the [[mkinitcpio]] article for more info). E.g.:
 +
{{bc|<nowiki># sudo mkinitcpio -p linux</nowiki>}}
 +
 
 +
OBS. If you have any leftover {{ic|kill Plymouth}} lines in {{ic|/etc/rc.local}} or
 +
{{ic|~/.xinitrc}} they are no longer required.
 +
 
 +
== Configuration ==
 +
 
 +
=== Smooth transition ===
 +
For ''smooth transition'' to Display Manager you have to:
 +
# See the Wiki Page (link in 5) to prepare your Display Manager
 +
# Disable your Display Manager Unit. E.g. : {{ic|# systemctl disable kdm.service}}
 +
# Enable the respective DM-plymouth Unit (GDM, KDM, LXDM units provided). E.g. : {{ic|# systemctl enable kdm-plymouth.service}}
  
 +
=== Changing the Theme ===
 
Plymouth comes with a selection of themes:
 
Plymouth comes with a selection of themes:
 
#'''Fade-in''': "Simple theme that fades in and out with shimmering stars"
 
#'''Fade-in''': "Simple theme that fades in and out with shimmering stars"
Line 55: Line 60:
 
#''('''Details''': "Verbose fallback theme")''
 
#''('''Details''': "Verbose fallback theme")''
  
By default, no theme is selected, you must select a theme by editing {{ic|/etc/plymouth/plymouthd.conf}}
+
By default, '''spinfinity''' theme is selected. You can change the theme by editing {{ic|/etc/plymouth/plymouthd.conf}}.
  
 
Example:
 
Example:
 
{{bc|[Daemon]
 
{{bc|[Daemon]
Theme&#61;spinner}}
+
Theme&#61;spinfinity}}
 +
 
 +
You will also need to rebuild your initrd image every time you change your theme (the default is set as ({{ic|spinfinity}}).
  
 
All currently installed themes can be listed by using this:
 
All currently installed themes can be listed by using this:
 +
 +
{{bc|<nowiki>$ plymouth-set-default-theme -l</nowiki>}}
 +
 +
or:
  
 
{{bc|$ ls /usr/share/plymouth/themes
 
{{bc|$ ls /usr/share/plymouth/themes
Line 79: Line 90:
 
every time a theme is changed, the kernel image must be rebuilt with:
 
every time a theme is changed, the kernel image must be rebuilt with:
 
{{bc|# mkinitcpio -p <name of your kernel preset; e.g. linux>}}
 
{{bc|# mkinitcpio -p <name of your kernel preset; e.g. linux>}}
 +
 +
To change theme and rebuild initrd image:
 +
{{bc|<nowiki># plymouth-set-default-theme -R <theme></nowiki>}}
  
 
Reboot to apply the changes.
 
Reboot to apply the changes.

Revision as of 09:38, 17 November 2013

zh-CN:Plymouth Plymouth is a project from Fedora providing a flicker-free graphical boot process. It relies on 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.

Preparation

Warning: Plymouth is currently under heavy development and may contain bugs.

Plymouth primarily uses KMS (Kernel Mode Setting) to display graphics. If you can't use KMS (e.g. because you are using a proprietary driver) you will need to use framebuffer instead. Uvesafb is recommended as it can function with widescreen resolutions.

If you have neither KMS nor a framebuffer, Plymouth will fall back to text-mode.

Installation

Plymouth is not presently available in the Official Repositories, and will need to be installed from the AUR.

The stable one is called plymouthAUR and the git version plymouth-gitAUR. The package we refer to in this article is plymouth-git, which actually is much better tidy and contains several corrections and additions.

The plymouth hook

Add plymouth to the HOOKS array in /etc/mkinitcpio.conf. It must be added after base and udev for it to work:

/etc/mkinitcpio.conf
HOOKS="base udev plymouth [...] "
Warning: If you use hard drive encryption with the encrypt hook, you must replace the encrypt hook with plymouth-encrypt in order to get to the TTY password prompts.

For early KMS start add the module radeon (for radeon cards), i915 (for intel cards) or nouveau (for nvidia cards) to the MODULES line in /etc/mkinitcpio.conf:

/etc/mkinitcpio.conf
MODULES="i915"
or
MODULES="radeon"
or
MODULES="nouveau"

The kernel command line

You now need to set quiet splash as you kernel command line parameters in your bootloader. See Kernel parameters for more info.

Rebuild your initrd image (# mkinitcpio -p [kernel preset name] – refer to the mkinitcpio article for more info). E.g.:

# sudo mkinitcpio -p linux

OBS. If you have any leftover kill Plymouth lines in /etc/rc.local or ~/.xinitrc they are no longer required.

Configuration

Smooth transition

For smooth transition to Display Manager you have to:

  1. See the Wiki Page (link in 5) to prepare your Display Manager
  2. Disable your Display Manager Unit. E.g. : # systemctl disable kdm.service
  3. Enable the respective DM-plymouth Unit (GDM, KDM, LXDM units provided). E.g. : # systemctl enable kdm-plymouth.service

Changing the Theme

Plymouth comes with a selection of themes:

  1. Fade-in: "Simple theme that fades in and out with shimmering stars"
  2. Glow: "Corporate theme with pie chart boot progress followed by a glowing emerging logo"
  3. Script: "Script example plugin" (Despite the description seems to be a quite nice Arch logo theme)
  4. Solar: "Space theme with violent flaring blue star"
  5. Spinner: "Simple theme with a loading spinner"
  6. Spinfinity: "Simple theme that shows a rotating infinity sign in the center of the screen"
  7. (Text: "Text mode theme with tricolor progress bar")
  8. (Details: "Verbose fallback theme")

By default, spinfinity theme is selected. You can change the theme by editing /etc/plymouth/plymouthd.conf.

Example:

[Daemon]
Theme=spinfinity

You will also need to rebuild your initrd image every time you change your theme (the default is set as (spinfinity).

All currently installed themes can be listed by using this:

$ plymouth-set-default-theme -l

or:

$ ls /usr/share/plymouth/themes
details  glow    solar       spinner  tribar
fade-in  script  spinfinity  text

Themes can be Previewed without Rebuilding, hit Ctrl+Alt+F2 to change to console, log in as root and type:

# plymouthd
# plymouth --show-splash

To quit the preview hit Ctrl+Alt+F2 again and type:

# plymouth --quit

every time a theme is changed, the kernel image must be rebuilt with:

# mkinitcpio -p <name of your kernel preset; e.g. linux>

To change theme and rebuild initrd image:

# plymouth-set-default-theme -R <theme>

Reboot to apply the changes.

See also

Original Spec

A related forum thread