Find a file
Hans de Goede 6620904dff main: Do not override device_scale from lower-priorities config files
main () calls functions to get the theme and other config settings from
the commandline / config files in order of *descending* priority:

1. find_override_splash ()             /* Parses commandline */
2. find_system_default_splash ()       /* /etc/plymouth/plymouthd.conf */
3. find_distribution_default_splash () /* /usr/share/plymouth/plymouthd.defaults */

To avoid the later parsed config files *with lower priorities* overriding
earlier settings the code initializes the config variables to NAN and only
sets them if they are still set to NAN.

Except for the device_scale handling, where load_settings () always calls
ply_set_device_scale () overriding earlier values, the commandline
handling for "plymouth.force-scale=..." is done separately later so that
the commandline does take priority over the config files, but since
/usr/share/plymouth/plymouthd.defaults is parsed last any DeviceScale
setting there will override /etc/plymouth/plymouthd.conf settings.

Fix this by following the pattern used by start_time/splash_delay/
device_timeout, add a device_scale variable initialized to -1 and
only override that variable if it is at -1.

This also allows removing find_force_scale () moving the commandline
parsing to find_override_splash () together with the other commandline
handling.

Signed-off-by: Hans de Goede <hdegoede@redhat.com>
2025-03-10 11:45:27 +01:00
docs autogoo: Drop the goo 2022-11-14 13:40:56 -05:00
images autogoo: Drop the goo 2022-11-14 13:40:56 -05:00
po Translated using Weblate (Greek) 2024-07-27 17:33:31 +00:00
scripts ply-keymap-icon: Make Dvorak check case-insensitive 2025-02-10 14:23:58 +01:00
src main: Do not override device_scale from lower-priorities config files 2025-03-10 11:45:27 +01:00
systemd-units autogoo: Drop the goo 2022-11-14 13:40:56 -05:00
themes Run keymap-render.py to update the pre-rendered keymap 2025-02-10 14:49:07 +01:00
.gitignore gitignore: Add plymouthd-fd-escrow to gitignore 2022-02-28 16:28:41 +01:00
.gitlab-ci.yml Fix Debian CI 2024-07-16 14:45:32 -04:00
AUTHORS Add Peter to AUTHORS 2008-06-10 21:59:10 -04:00
COPYING initial import 2007-05-08 17:48:00 -04:00
INSTALL build-goo: Remove vestigial remnants of old GDM integration code. 2020-03-07 00:36:54 +08:00
meson.build Bump required Meson version 2024-04-30 01:18:56 +00:00
meson_options.txt Port build system to Meson 2022-11-14 12:21:55 -05:00
ply_header.svg Add README in .md format. 2022-09-07 18:07:31 +00:00
README.md Add README in .md format. 2022-09-07 18:07:31 +00:00
VERSION autogoo: Determine project version from date 2022-01-11 10:38:28 -05:00

header image

Overview

Plymouth is an application that runs very early in the boot process (even before the root filesystem is mounted!) that provides a graphical boot animation while the boot process happens in the background.

It is designed to work on systems with DRM modesetting drivers. The idea is that early on in the boot process the native mode for the computer is set, plymouth uses that mode, and that mode stays throughout the entire boot process up to and after X starts. Ideally, the goal is to get rid of all flicker during startup.

For systems that don't have DRM mode settings drivers, plymouth falls back to text mode (it can also use a legacy /dev/fb interface).

In either text or graphics mode, the boot messages are completely occluded. After the root file system is mounted read-write, the messages are dumped to /var/log/boot.log. Also, the user can see the messages at any time during boot up by hitting the escape key.

Installation

Plymouth isn't really designed to be built from source by end users. For it to work correctly, it needs integration with the distribution. Because it starts so early, it needs to be packed into the distribution's initial ram disk, and the distribution needs to poke plymouth to tell it how boot is progressing.

Binary Files

plymouth ships with two binaries:

  • /sbin/plymouthd and
  • /bin/plymouth

The first one, plymouthd, does all the heavy lifting. It logs the session and shows the splash screen. The second one, /bin/plymouth, is the control interface to plymouthd.

It supports things like plymouth show-splash, or plymouth ask-for-password, which trigger the associated action in plymouthd.

Plymouth supports various "splash" themes which are analogous to screensavers, but happen at boot time. There are several sample themes shipped with plymouth, but most distributions that use plymouth ship something customized for their distribution.

Current Efforts

Plymouth isn't done yet. It's still under active development, but is used in several popular distros already, including Fedora, Mandriva, Ubuntu and others. See the distributions page for more information.

Code of Conduct

As with other projects hosted on freedesktop.org, Plymouth follows its Code of Conduct, based on the Contributor Covenant1. Please conduct yourself in a respectful and civilized manner when using the above mailing lists, bug trackers, etc:

References