fdo-mirrors/plymouth
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/plymouth/plymouth.git synced 2026-05-07 08:28:03 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions
read-only mirror of https://gitlab.freedesktop.org/plymouth/plymouth
2651 commits 41 branches 34 tags 11 MiB
C 96.4%
Shell 1.8%
Meson 1.6%
Python 0.2%
Find a file
Ray Strode 9bce1df280 ci: Fix check-format 
In commit bb6580212d we tried to stop
running check-format on debian. We did this by moving the check-format
details to its own map and then adding a "<<" merge key to only pull
it in on Fedora.

The Fedora map already has a "<<" merge key however for doing the actual
build.

It's not allowed for their to be two, and gitlab's ci just ignores
the second one.

This commit combines the merge keys into one.
2022-11-29 14:52:39 -05: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 Add Hindi (hi) translation 2022-11-21 05:47:39 +05:30
scripts meson: Generate version for reproducibility 2022-11-29 14:40:11 -05:00
src input-device: Only allow one renderer to consume input at a time 2022-11-29 13:34:05 -05:00
systemd-units autogoo: Drop the goo 2022-11-14 13:40:56 -05:00
themes scripts: Update keymap-render script to handle xkb keymaps too 2022-11-29 09:22:06 -05:00
.gitignore gitignore: Add plymouthd-fd-escrow to gitignore 2022-02-28 16:28:41 +01:00
.gitlab-ci.yml ci: Fix check-format 2022-11-29 14:52:39 -05: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 meson: Generate version for reproducibility 2022-11-29 14:40:11 -05: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

README.md

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