Find a file
Scott James Remnant 7d34bb2fea [branch-merge] Improved VT Handling
One of the main differences between Ubuntu's use of Plymouth and
Fedora's is that on Ubuntu we've tried to keep the X server on VT7
so that the historical documentation of Ctrl-Alt-F1 giving you a
text console is preserved.

This obviously means that for a smooth transition, Plymouth must also
run on VT7.

We discovered that although Plymouth does have code to attempt to deal
with VTs, none of it is quite right and there are many paths that don't
work unless Plymouth is run on VT1.

This patch set fixes our known problems with the VT handling making it
possible to run Plymouth on any VT of your choosing, with VT1 remaining
the default.
2010-03-18 20:05:10 +00:00
docs Spelling fix for manpage. 2010-03-11 13:38:18 -05:00
images ship bizcom unconditionally 2008-06-22 00:49:24 -04:00
scripts [scripts] Don't hardcode LIBEXECDIR and DATADIR paths 2010-03-02 20:08:22 +00:00
src [configure] allow boot and shutdown ttys to be changed 2010-03-18 20:01:31 +00:00
themes [script] Add text to image capability 2009-11-21 17:45:41 +00:00
.gitignore [scripts] Don't hardcode LIBEXECDIR and DATADIR paths 2010-03-02 20:08:22 +00:00
acinclude.m4 [configure] Add AS_AC_EXPAND for configured dirs 2009-08-07 16:32:32 -04:00
AUTHORS Add Peter to AUTHORS 2008-06-10 21:59:10 -04:00
autogen.sh [configure] Make maintainer mode default to on but not explicit in autogen 2009-11-30 22:17:14 +00:00
ChangeLog Put in ChangeLog request to not use ChangeLog 2008-05-20 15:15:03 -04:00
configure.ac [configure] allow boot and shutdown ttys to be changed 2010-03-18 20:01:31 +00:00
COPYING initial import 2007-05-08 17:48:00 -04:00
INSTALL Add stub INSTALL file 2009-05-02 01:10:19 -04:00
Makefile.am [docs] Rename man/ to docs/ 2009-12-16 13:13:41 -05:00
NEWS initial import 2007-05-08 17:48:00 -04:00
README word wrap README 2008-11-19 15:58:38 -05:00
TODO Add hack to make maintenance mode probably work when 2008-06-30 17:55:15 -04:00

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 analagous 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.