1
2PLYMOUTH(8)                 System Manager's Manual                PLYMOUTH(8)
3
4
5

NAME

7       plymouth - A graphical boot system and logger
8

SYNOPSIS

10       plymouth-set-default-theme [options] <theme>
11

DESCRIPTION

13       plymouth  is a graphical boot system for Linux which takes advantage of
14       the kernel-based mode setting (KMS) available for modern graphic  cards
15       to  provide  a  seamless,  flickerfree  and  attractive boot screen. It
16       allows to choose between various, static or animated  graphical  themes
17       to  spruce  up  the  startup  and avoid the noise generated by the vast
18       amount of kernel messages while the machine boots into X.   On  systems
19       where  kernel-based  mode setting is not available, plymouth falls back
20       to a text mode boot screen which provides a simple progress bar to pro‐
21       vide feedback during boot.
22
23       To configure plymouth, that is to choose and install the preferred boot
24       theme, the user has to invoke  plymouth-set-default-theme.  It  changes
25       the  configuration  to  the  new  theme and also performs the necessary
26       regeneration of the initial ramdisk (initrd) since plymouth  is  loaded
27       from  the boot loader from the initrd prior to the mounting of the root
28       filesystem. The options available to this script are explained  in  the
29       OPTIONS paragraph.
30
31       In  order for the configured default plymouth theme to be loaded during
32       boot, the option `splash' (or `rhgb' for  backward  compatibility  with
33       the  RHGB  boot  splash)  must  be provided at the kernel command line.
34       With this  command  line  option,  plymouth  will  default  to  showing
35       detailed boot output.
36

OPTIONS

38       plymouth-set-default-theme  follows  the usual GNU command line syntax,
39       with long options starting with two dashes (`-') and short variants  of
40       each of them.
41
42       -h, --help
43              Show summary of options.
44
45       -l, --list
46              List available themes.
47
48       -r, --reset
49              Reset to default theme.
50
51       -R, --rebuild-initrd
52              Rebuild initrd (necessary after changing theme).
53
54       <theme-name>
55              Name  of  new  theme to use. If you want to see which themes are
56              available, invoke the script with just --list.
57
58       If plymouth-set-default-theme is invoked with no options or parameters,
59       it  shows  the currently selected theme by default. This output is used
60       by the helper scripts `plymouth-generate-initrd' and  `plymouth-update-
61       initrd' to set the proper theme in the initial ramdisk.
62

SEE ALSO

64       grub(8)
65

AUTHOR

67       plymouth  was  originally  prototyped  and  named  by Kristian Høgsberg
68       <krh@bitplanet.net>,    originally    written     by     Ray     Strode
69       <halfline@gmail.com> and has had significant contributions from Charlie
70       Brej <cbrej@cs.man.ac.uk>.  It has also had  contributions  from  Peter
71       Jones   <pjones@redhat.com>,  Adam  Jackson  <ajax@nwnk.net>,  Frederic
72       Crozat <fcrozat@mandriva.com> and others.  It can be  downloaded  here:
73       <http://www.freedesktop.org/wiki/Software/Plymouth>.
74
75       This  manual  page  was written by Adrian Glaubitz <glaubitz@physik.fu-
76       berlin.de>.
77
78
79
80                               December 15, 2009                   PLYMOUTH(8)