You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Go to file
Colin Walters 76142a6f6e
autogen.sh: rework to be more buildsystem friendly
13 years ago
docs [docs] Fix up encoding Kristian Høgsberg 14 years ago
images ship bizcom unconditionally 16 years ago
scripts drm: reduce minimum build requirements 14 years ago
src event-loop: use static buffer instead of stack allocation buffer 13 years ago
themes splash: add new spinner theme 13 years ago
.gitignore upstart-bridge: add new helper program 13 years ago
AUTHORS Add Peter to AUTHORS 16 years ago
COPYING initial import 17 years ago
ChangeLog Put in ChangeLog request to not use ChangeLog 16 years ago
INSTALL Add stub INSTALL file 15 years ago
Makefile.am [docs] Rename man/ to docs/ 15 years ago
NEWS initial import 17 years ago
README README: spelling fix. 13 years ago
TODO Add hack to make maintenance mode probably work when 16 years ago
acinclude.m4 [configure] Add AS_AC_EXPAND for configured dirs 15 years ago
autogen.sh autogen.sh: rework to be more buildsystem friendly 13 years ago
configure.ac main: create runtime directory if it doesn't exist already 13 years ago

README

plymouth - graphical boot animation and logger


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.

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.

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.

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" plugins which are analogous to
screensavers, but happen at boot time. Currently there are three
graphical splash plugins: solar, fade-in, and spinfinity. There are
also three non-graphical plugins which are for text mode and the
detailed view.

The graphical plugins need a logo image and background color to
function. Distributions are expected to set these up in their packages
at ./configure time, but there are some placeholder values set up if
./configure doesn't get those options.

Plymouth isn't done yet. It's still under active development and isn't
ready for distros to use as-is. That should change in the near future
though.