From c588145997eba60b429246df94ad2d2cf5298077 Mon Sep 17 00:00:00 2001 From: Adrian Glaubitz Date: Tue, 15 Dec 2009 23:11:41 +0100 Subject: [PATCH 01/10] [set-default-theme] Provide GNU-style short options --- scripts/plymouth-set-default-theme.in | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/scripts/plymouth-set-default-theme.in b/scripts/plymouth-set-default-theme.in index e731051..e5e2ef0 100755 --- a/scripts/plymouth-set-default-theme.in +++ b/scripts/plymouth-set-default-theme.in @@ -23,11 +23,11 @@ function show_help() { Plymouth theme chooser $(usage) - --help Show this help message - --list Show available themes - --reset Reset to default theme - --rebuild-initrd Rebuild initrd (necessary after changing theme) - Name of new theme to use (see --list for available themes) + -h, --help Show this help message + -l, --list Show available themes + -r. --reset Reset to default theme + -R, --rebuild-initrd Rebuild initrd (necessary after changing theme) + Name of new theme to use (see --list for available themes) EOF } @@ -58,7 +58,7 @@ THEME_NAME="" while [ $# -gt 0 ]; do case "$1" in - --list) + -l|--list) if [ -n "$THEME_NAME" ]; then echo "You can only specify --list or a theme name, not both" > /dev/stderr echo $(usage) > /dev/stderr @@ -74,11 +74,11 @@ while [ $# -gt 0 ]; do DO_LIST=1 ;; - --rebuild-initrd) + -R|--rebuild-initrd) DO_INITRD_REBUILD=1 ;; - --reset|default) + -r|--reset|default) if [ -n "$THEME_NAME" ]; then echo "You can only specify --reset or a theme name, not both" > /dev/stderr echo $(usage) > /dev/stderr @@ -94,7 +94,7 @@ while [ $# -gt 0 ]; do DO_RESET=1 ;; - --help) + -h|--help) DO_HELP=1 ;; From 6b879b6c714c9a379823a168a7d644873e621169 Mon Sep 17 00:00:00 2001 From: Adrian Glaubitz Date: Tue, 15 Dec 2009 23:59:20 +0100 Subject: [PATCH 02/10] [docs] Add man page It explains the basic concepts of plymouth and the usage of tools to be used to setup it. --- Makefile.am | 2 +- configure.ac | 1 + man/Makefile.am | 1 + man/plymouth.8 | 63 +++++++++++++++++++++++++++++++++++++++++++++++++ 4 files changed, 66 insertions(+), 1 deletion(-) create mode 100644 man/Makefile.am create mode 100644 man/plymouth.8 diff --git a/Makefile.am b/Makefile.am index 5c35769..6d1a922 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,4 +1,4 @@ -SUBDIRS = src themes images scripts +SUBDIRS = src themes images scripts man DISTCHECK_CONFIGURE_FLAGS = --disable-tests --without-system-root-install EXTRA_DIST = ChangeLog \ diff --git a/configure.ac b/configure.ac index e6294b9..5cd5ec7 100644 --- a/configure.ac +++ b/configure.ac @@ -243,4 +243,5 @@ AC_OUTPUT([Makefile themes/script/Makefile images/Makefile scripts/Makefile + man/Makefile ]) diff --git a/man/Makefile.am b/man/Makefile.am new file mode 100644 index 0000000..2449290 --- /dev/null +++ b/man/Makefile.am @@ -0,0 +1 @@ +dist_man_MANS = plymouth.8 \ No newline at end of file diff --git a/man/plymouth.8 b/man/plymouth.8 new file mode 100644 index 0000000..493de72 --- /dev/null +++ b/man/plymouth.8 @@ -0,0 +1,63 @@ +\" Hey, EMACS: -*- nroff -*- +.TH PLYMOUTH 8 "December 15, 2009" +.SH NAME +plymouth \- A graphical boot system and logger +.SH SYNOPSIS +.B plymouth-set-default-theme +.RI [ options ] " \" +.SH DESCRIPTION +\fBplymouth\fP is a a graphical boot system for Linux which takes advantage of the kernel-based +mode setting (KMS) available for modern graphic cards to provide a seamless, flickerfree +and attractive boot screen. It supercedes the Red Hat graphical boot manager (RHGB) on Fedora +and Red Hat systems and replaces usplash with xplash on Ubuntu and Debian. It allows +to choose between various, static or animated graphical themes to spruce up the +startup and avoid the noise generated by the vast amount of kernel messages while +the machine boots into X. On systems where kernel-based mode setting is not available, +plymouth falls back to a text mode boot screen which provides a simple progress bar +to provide feedback during boot. +.PP +To configure plymouth, that is to choose and install the preferred boot theme, the +user has to invoke \fBplymouth-set-default-theme\fP. It changes the configuration +to the new theme and also performs the necessary regeneration of the initial ramdisk +(initrd) since plymouth is loaded from the boot loader from the initrd +prior to the mounting of the root filesystem. The options available to this +script are explained in the \fBOPTIONS\fP paragraph. +.PP +In order for plymouth to be loaded during boot, the option `rhgb' must be provided +at the kernel command line. Depending on your version of GRUB (1 or 2), this +involves editing the files menu.lst or grub.cfg in your default grub directory +or editing a special grub configuration file in /etc, followed by invoking +something like `update-grub'. +.SH OPTIONS +plymouth-set-default-theme follows the usual GNU command line syntax, with long +options starting with two dashes (`-') and short variants of each of them. +.TP +.B \-h, \-\-help +Show summary of options. +.TP +\" .B \-v, \-\-version +\" Show version of program. +.TP +.B \-l, \-\-list +List available themes. +.TP +.B \-r, \-\-reset +Reset to default theme. +.TP +.B \-R, \-\-rebuild\-initrd +Rebuild initrd (necessary after changing theme). +.TP +.B \ +Name of new theme to use. If you want to see which themes are available, invoke the script with just \-\-list. +.PP +If plymouth-set-default-theme is invoked with no options or parameters, it shows the currently selected theme +by default. This output is used by the helper scripts `plymouth-generate-initrd' and `plymouth-update-initrd' +to set the proper theme in the initial ramdisk. +.SH SEE ALSO +.BR grub (8) +.br +.SH AUTHOR +plymouth was written by Kristian Høgsberg , Ray Strode and +Peter Jones . It can be downloaded here: . +.PP +This manual page was written by Adrian Glaubitz . From 56c1b86493a61ae562e10afd6429666fa3af350e Mon Sep 17 00:00:00 2001 From: Ray Strode Date: Wed, 16 Dec 2009 08:37:58 -0500 Subject: [PATCH 03/10] [docs] Rename man/ to docs/ This way we can put other documents there as well. --- Makefile.am | 2 +- configure.ac | 2 +- {man => docs}/Makefile.am | 0 {man => docs}/plymouth.8 | 0 4 files changed, 2 insertions(+), 2 deletions(-) rename {man => docs}/Makefile.am (100%) rename {man => docs}/plymouth.8 (100%) diff --git a/Makefile.am b/Makefile.am index 6d1a922..3bc0be0 100644 --- a/Makefile.am +++ b/Makefile.am @@ -1,4 +1,4 @@ -SUBDIRS = src themes images scripts man +SUBDIRS = src themes images scripts docs DISTCHECK_CONFIGURE_FLAGS = --disable-tests --without-system-root-install EXTRA_DIST = ChangeLog \ diff --git a/configure.ac b/configure.ac index 5cd5ec7..207dc64 100644 --- a/configure.ac +++ b/configure.ac @@ -243,5 +243,5 @@ AC_OUTPUT([Makefile themes/script/Makefile images/Makefile scripts/Makefile - man/Makefile + docs/Makefile ]) diff --git a/man/Makefile.am b/docs/Makefile.am similarity index 100% rename from man/Makefile.am rename to docs/Makefile.am diff --git a/man/plymouth.8 b/docs/plymouth.8 similarity index 100% rename from man/plymouth.8 rename to docs/plymouth.8 From fcd88849b3fd2d63eec1dcea3940b0da96cdeeb9 Mon Sep 17 00:00:00 2001 From: Ray Strode Date: Wed, 16 Dec 2009 08:41:33 -0500 Subject: [PATCH 04/10] [docs] Remove distribution references from man page We don't want to provide a history of what distributions used before plymouth, because that history could get long, isn't super relevant, and will add noise for a users looking for help (they probably only care about their distributions, not others). --- docs/plymouth.8 | 13 ++++++------- 1 file changed, 6 insertions(+), 7 deletions(-) diff --git a/docs/plymouth.8 b/docs/plymouth.8 index 493de72..e9dd5d8 100644 --- a/docs/plymouth.8 +++ b/docs/plymouth.8 @@ -8,13 +8,12 @@ plymouth \- A graphical boot system and logger .SH DESCRIPTION \fBplymouth\fP is a a graphical boot system for Linux which takes advantage of the kernel-based mode setting (KMS) available for modern graphic cards to provide a seamless, flickerfree -and attractive boot screen. It supercedes the Red Hat graphical boot manager (RHGB) on Fedora -and Red Hat systems and replaces usplash with xplash on Ubuntu and Debian. It allows -to choose between various, static or animated graphical themes to spruce up the -startup and avoid the noise generated by the vast amount of kernel messages while -the machine boots into X. On systems where kernel-based mode setting is not available, -plymouth falls back to a text mode boot screen which provides a simple progress bar -to provide feedback during boot. +and attractive boot screen. It allows to choose between various, static or +animated graphical themes to spruce up the startup and avoid the noise +generated by the vast amount of kernel messages while the machine boots into X. +On systems where kernel-based mode setting is not available, plymouth falls +back to a text mode boot screen which provides a simple progress bar to provide +feedback during boot. .PP To configure plymouth, that is to choose and install the preferred boot theme, the user has to invoke \fBplymouth-set-default-theme\fP. It changes the configuration From 5da891bbaaae521b9766c34a8e6c63e22161bc75 Mon Sep 17 00:00:00 2001 From: Ray Strode Date: Wed, 16 Dec 2009 08:47:17 -0500 Subject: [PATCH 05/10] [docs] Add reference to splash cmdline in man page It referenced rhgb, but not splash. While rhgb was there first, most distributions use splash since it's more logical (among other reasons). --- docs/plymouth.8 | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/docs/plymouth.8 b/docs/plymouth.8 index e9dd5d8..b1aef2e 100644 --- a/docs/plymouth.8 +++ b/docs/plymouth.8 @@ -22,10 +22,11 @@ to the new theme and also performs the necessary regeneration of the initial ram prior to the mounting of the root filesystem. The options available to this script are explained in the \fBOPTIONS\fP paragraph. .PP -In order for plymouth to be loaded during boot, the option `rhgb' must be provided -at the kernel command line. Depending on your version of GRUB (1 or 2), this -involves editing the files menu.lst or grub.cfg in your default grub directory -or editing a special grub configuration file in /etc, followed by invoking +In order for plymouth to be loaded during boot, the option `splash' +(or `rhgb' for backward compatibility with the RHGB boot splash) must be +provided at the kernel command line. Depending on your version of GRUB +(1 or 2), this involves editing the files menu.lst or grub.cfg in your default +grub directory or editing a special grub configuration file in /etc, followed by invoking something like `update-grub'. .SH OPTIONS plymouth-set-default-theme follows the usual GNU command line syntax, with long From 15c824cc4b68c0eeee0d1d46a25a403f55b8efbf Mon Sep 17 00:00:00 2001 From: Ray Strode Date: Wed, 16 Dec 2009 08:48:45 -0500 Subject: [PATCH 06/10] [docs] Remove instructions about boot loader They weren't completely accurate, you don't need to reinstall grub after editing its config, since it has built-in filesystem drivers. Also, those details very from system to system, so we should probably just leave it out. --- docs/plymouth.8 | 5 +---- 1 file changed, 1 insertion(+), 4 deletions(-) diff --git a/docs/plymouth.8 b/docs/plymouth.8 index b1aef2e..4f0c2e9 100644 --- a/docs/plymouth.8 +++ b/docs/plymouth.8 @@ -24,10 +24,7 @@ script are explained in the \fBOPTIONS\fP paragraph. .PP In order for plymouth to be loaded during boot, the option `splash' (or `rhgb' for backward compatibility with the RHGB boot splash) must be -provided at the kernel command line. Depending on your version of GRUB -(1 or 2), this involves editing the files menu.lst or grub.cfg in your default -grub directory or editing a special grub configuration file in /etc, followed by invoking -something like `update-grub'. +provided at the kernel command line. .SH OPTIONS plymouth-set-default-theme follows the usual GNU command line syntax, with long options starting with two dashes (`-') and short variants of each of them. From 68f3af377afadfbdf11885519b229f094d7d597d Mon Sep 17 00:00:00 2001 From: Ray Strode Date: Wed, 16 Dec 2009 08:53:03 -0500 Subject: [PATCH 07/10] [docs] Clarify "rhgb" cmdline option in man page Previously, it said that "rhgb" was required for plymouth to run, but plymouth runs no matter what. This just specifies which splash is displayed --- docs/plymouth.8 | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/plymouth.8 b/docs/plymouth.8 index 4f0c2e9..273fb73 100644 --- a/docs/plymouth.8 +++ b/docs/plymouth.8 @@ -22,9 +22,10 @@ to the new theme and also performs the necessary regeneration of the initial ram prior to the mounting of the root filesystem. The options available to this script are explained in the \fBOPTIONS\fP paragraph. .PP -In order for plymouth to be loaded during boot, the option `splash' -(or `rhgb' for backward compatibility with the RHGB boot splash) must be -provided at the kernel command line. +In order for the configured default plymouth theme to be loaded during boot, +the option `splash' (or `rhgb' for backward compatibility with the RHGB boot +splash) must be provided at the kernel command line. With this command line +option, plymouth will default to showing detailed boot output. .SH OPTIONS plymouth-set-default-theme follows the usual GNU command line syntax, with long options starting with two dashes (`-') and short variants of each of them. From 2c7b357ff88b5695d44a7eb574485e3fe5d33a61 Mon Sep 17 00:00:00 2001 From: Ray Strode Date: Wed, 16 Dec 2009 09:05:50 -0500 Subject: [PATCH 08/10] [docs] Fix AUTHORS in man page --- docs/plymouth.8 | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/docs/plymouth.8 b/docs/plymouth.8 index 273fb73..640db05 100644 --- a/docs/plymouth.8 +++ b/docs/plymouth.8 @@ -55,7 +55,11 @@ to set the proper theme in the initial ramdisk. .BR grub (8) .br .SH AUTHOR -plymouth was written by Kristian Høgsberg , Ray Strode and -Peter Jones . It can be downloaded here: . +plymouth was originally prototyped and named by Kristian Høgsberg , +originally written by Ray Strode and has had significant contributions +from Charlie Brej . It has also had contributions from +Peter Jones , Adam Jackson , +Frederic Crozat and others. +It can be downloaded here: . .PP This manual page was written by Adrian Glaubitz . From ea12d818cd46961f47f316bc2dd0c9fea8da50fe Mon Sep 17 00:00:00 2001 From: Ray Strode Date: Wed, 16 Dec 2009 09:06:52 -0500 Subject: [PATCH 09/10] [docs] Update home page url in man page --- docs/plymouth.8 | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/plymouth.8 b/docs/plymouth.8 index 640db05..f3de3e0 100644 --- a/docs/plymouth.8 +++ b/docs/plymouth.8 @@ -60,6 +60,6 @@ originally written by Ray Strode and has had significant co from Charlie Brej . It has also had contributions from Peter Jones , Adam Jackson , Frederic Crozat and others. -It can be downloaded here: . +It can be downloaded here: . .PP This manual page was written by Adrian Glaubitz . From 1fa0bf62b7ae58db68104e4307590abab6f32ba5 Mon Sep 17 00:00:00 2001 From: Ray Strode Date: Wed, 16 Dec 2009 13:19:23 -0500 Subject: [PATCH 10/10] [docs] Remove commented out section from man page We don't have a --version and it was adding a gap in the output --- docs/plymouth.8 | 3 --- 1 file changed, 3 deletions(-) diff --git a/docs/plymouth.8 b/docs/plymouth.8 index f3de3e0..dd7443b 100644 --- a/docs/plymouth.8 +++ b/docs/plymouth.8 @@ -33,9 +33,6 @@ options starting with two dashes (`-') and short variants of each of them. .B \-h, \-\-help Show summary of options. .TP -\" .B \-v, \-\-version -\" Show version of program. -.TP .B \-l, \-\-list List available themes. .TP