|
 |
6cc380 |
From 740aa102eec65abf8dcfeeac043ecbcde74f2bf8 Mon Sep 17 00:00:00 2001
|
|
|
6cc380 |
From: Matthias Clasen <mclasen@redhat.com>
|
|
|
6cc380 |
Date: Mon, 21 Oct 2013 17:53:33 -0400
|
|
|
6cc380 |
Subject: [PATCH] docs: add docbook based man pages
|
|
|
6cc380 |
|
|
|
6cc380 |
This commit adds man pages for the plymouthd and plymouth client
|
|
|
6cc380 |
commands.
|
|
|
6cc380 |
---
|
|
|
6cc380 |
Makefile.am | 6 +-
|
|
|
6cc380 |
configure.ac | 12 ++
|
|
|
6cc380 |
docs/Makefile.am | 33 +++-
|
|
|
6cc380 |
docs/plymouth-set-default-theme.xml | 103 +++++++++++
|
|
|
6cc380 |
docs/plymouth.8 | 62 -------
|
|
|
6cc380 |
docs/plymouth.xml | 86 +++++++++
|
|
|
6cc380 |
docs/plymouth1.xml | 351 ++++++++++++++++++++++++++++++++++++
|
|
|
6cc380 |
docs/plymouthd.xml | 121 +++++++++++++
|
|
|
6cc380 |
8 files changed, 708 insertions(+), 66 deletions(-)
|
|
|
6cc380 |
create mode 100644 docs/plymouth-set-default-theme.xml
|
|
|
6cc380 |
delete mode 100644 docs/plymouth.8
|
|
|
6cc380 |
create mode 100644 docs/plymouth.xml
|
|
|
6cc380 |
create mode 100644 docs/plymouth1.xml
|
|
|
6cc380 |
create mode 100644 docs/plymouthd.xml
|
|
|
6cc380 |
|
|
|
6cc380 |
diff --git a/Makefile.am b/Makefile.am
|
|
|
6cc380 |
index b322463..395c91b 100644
|
|
|
6cc380 |
--- a/Makefile.am
|
|
|
6cc380 |
+++ b/Makefile.am
|
|
|
6cc380 |
@@ -1,13 +1,17 @@
|
|
|
6cc380 |
-SUBDIRS = src themes images scripts docs systemd-units
|
|
|
6cc380 |
+SUBDIRS = src themes images scripts systemd-units
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+if BUILD_DOCUMENTATION
|
|
|
6cc380 |
+SUBDIRS += docs
|
|
|
6cc380 |
+endif
|
|
|
6cc380 |
|
|
|
6cc380 |
DISTCHECK_CONFIGURE_FLAGS = --disable-tests --without-system-root-install
|
|
|
6cc380 |
|
|
|
6cc380 |
EXTRA_DIST = ChangeLog \
|
|
|
6cc380 |
README
|
|
|
6cc380 |
|
|
|
6cc380 |
MAINTAINERCLEANFILES = aclocal.m4 \
|
|
|
6cc380 |
config.h.in \
|
|
|
6cc380 |
config.h.in~ \
|
|
|
6cc380 |
config.sub \
|
|
|
6cc380 |
configure \
|
|
|
6cc380 |
Makefile.in
|
|
|
6cc380 |
diff --git a/configure.ac b/configure.ac
|
|
|
6cc380 |
index bb0207d..6b957d9 100644
|
|
|
6cc380 |
--- a/configure.ac
|
|
|
6cc380 |
+++ b/configure.ac
|
|
|
6cc380 |
@@ -198,60 +198,72 @@ if test x$enable_libdrm_nouveau = xyes; then
|
|
|
6cc380 |
fi
|
|
|
6cc380 |
|
|
|
6cc380 |
AC_ARG_ENABLE(libkms, AS_HELP_STRING([--enable-libkms],[enable building with libkms support]),enable_libkms=$enableval,enable_libkms=no)
|
|
|
6cc380 |
AM_CONDITIONAL(ENABLE_LIBKMS, [test "$enable_libkms" = yes])
|
|
|
6cc380 |
|
|
|
6cc380 |
if test x$enable_libkms = xyes; then
|
|
|
6cc380 |
PKG_CHECK_MODULES(LIBKMS, [libdrm libkms])
|
|
|
6cc380 |
AC_SUBST(LIBKMS_CFLAGS)
|
|
|
6cc380 |
AC_SUBST(LIBKMS_LIBS)
|
|
|
6cc380 |
AC_DEFINE(PLY_ENABLE_LIBKMS, 1, [Enable support for libkms abstraction over drm drivers])
|
|
|
6cc380 |
fi
|
|
|
6cc380 |
|
|
|
6cc380 |
AC_ARG_ENABLE(drm, AS_HELP_STRING([--enable-drm-renderer],[enable building drm kms support]),enable_drm_renderer=$enableval,enable_drm_renderer=yes)
|
|
|
6cc380 |
AM_CONDITIONAL(ENABLE_DRM_RENDERER, [test "$enable_drm_renderer" = yes])
|
|
|
6cc380 |
|
|
|
6cc380 |
if test x$enable_drm_renderer = xyes; then
|
|
|
6cc380 |
PKG_CHECK_MODULES(DRM, [libdrm])
|
|
|
6cc380 |
fi
|
|
|
6cc380 |
|
|
|
6cc380 |
DRM_CFLAGS="$DRM_CFLAGS $DRM_INTEL_CFLAGS $DRM_RADEON_CFLAGS $DRM_NOUVEAU_CFLAGS $LIBKMS_CFLAG"
|
|
|
6cc380 |
DRM_LIBS="$DRM_LIBS $DRM_INTEL_LIBS $DRM_RADEON_LIBS $DRM_NOUVEAU_LIBS $LIBKMS_LIBS"
|
|
|
6cc380 |
AC_SUBST(DRM_CFLAGS)
|
|
|
6cc380 |
AC_SUBST(DRM_LIBS)
|
|
|
6cc380 |
|
|
|
6cc380 |
AC_ARG_ENABLE(tracing, AS_HELP_STRING([--enable-tracing],[enable verbose tracing code]),enable_tracing=$enableval,enable_tracing=yes)
|
|
|
6cc380 |
|
|
|
6cc380 |
if test x$enable_tracing = xyes; then
|
|
|
6cc380 |
AC_DEFINE(PLY_ENABLE_TRACING, 1, [Build in verbose debug tracing spew])
|
|
|
6cc380 |
fi
|
|
|
6cc380 |
|
|
|
6cc380 |
+AC_ARG_ENABLE(documentation,
|
|
|
6cc380 |
+ AS_HELP_STRING([--enable-documentation],
|
|
|
6cc380 |
+ [build documentation]),,
|
|
|
6cc380 |
+ enable_documentation=yes)
|
|
|
6cc380 |
+if test x$enable_documentation = xyes; then
|
|
|
6cc380 |
+ AC_PATH_PROG([XSLTPROC], [xsltproc])
|
|
|
6cc380 |
+ if test x$XSLTPROC = x; then
|
|
|
6cc380 |
+ AC_MSG_ERROR([xsltproc is required to build documentation])
|
|
|
6cc380 |
+ fi
|
|
|
6cc380 |
+fi
|
|
|
6cc380 |
+AM_CONDITIONAL(BUILD_DOCUMENTATION, test x$enable_documentation = xyes)
|
|
|
6cc380 |
+
|
|
|
6cc380 |
AC_ARG_ENABLE(tests, AS_HELP_STRING([--enable-tests],[build tests]),enable_tests=$enableval,enable_tests=yes)
|
|
|
6cc380 |
|
|
|
6cc380 |
AM_CONDITIONAL(ENABLE_TESTS, [test "$enable_tests" = yes])
|
|
|
6cc380 |
|
|
|
6cc380 |
AC_ARG_ENABLE(gdm-transition, AS_HELP_STRING([--enable-gdm-transition],[enable smooth transition to gdm]),enable_gdm_transition=$enableval,enable_gdm_transition=no)
|
|
|
6cc380 |
|
|
|
6cc380 |
if test x$enable_gdm_transition = xyes; then
|
|
|
6cc380 |
AC_DEFINE(PLY_ENABLE_DEPRECATED_GDM_TRANSITION, 1, [Enable deprecated smooth transition to GDM])
|
|
|
6cc380 |
fi
|
|
|
6cc380 |
|
|
|
6cc380 |
AC_ARG_ENABLE(upstart-monitoring, AS_HELP_STRING([--enable-upstart-monitoring],[listen for messages on the Upstart D-Bus interface]),enable_upstart_monitoring=$enableval,enable_upstart_monitoring=no)
|
|
|
6cc380 |
if test x$enable_upstart_monitoring = xyes; then
|
|
|
6cc380 |
PKG_CHECK_MODULES(DBUS, [dbus-1])
|
|
|
6cc380 |
AC_SUBST(DBUS_CFLAGS)
|
|
|
6cc380 |
AC_SUBST(DBUS_LIBS)
|
|
|
6cc380 |
AC_CHECK_HEADERS([ncursesw/term.h ncurses/term.h term.h], [break])
|
|
|
6cc380 |
AC_CHECK_LIB([ncursesw], [initscr],
|
|
|
6cc380 |
[CURSES_LIBS="$CURSES_LIBS -lncursesw"],
|
|
|
6cc380 |
[AC_CHECK_LIB([ncurses], [initscr],
|
|
|
6cc380 |
[CURSES_LIBS="$CURSES_LIBS -lncurses"],
|
|
|
6cc380 |
[AC_CHECK_LIB([curses], [initscr],
|
|
|
6cc380 |
[CURSES_LIBS="$CURSES_LIBS -lcurses"],
|
|
|
6cc380 |
[AC_MSG_ERROR([no curses library found])])])])
|
|
|
6cc380 |
AC_SUBST(CURSES_LIBS)
|
|
|
6cc380 |
fi
|
|
|
6cc380 |
AM_CONDITIONAL(ENABLE_UPSTART_MONITORING, [test "$enable_upstart_monitoring" = yes])
|
|
|
6cc380 |
|
|
|
6cc380 |
AC_ARG_ENABLE(systemd-integration, AS_HELP_STRING([--enable-systemd-integration],[coordinate boot up with systemd]),enable_systemd_integration=$enableval,enable_systemd_integration=no)
|
|
|
6cc380 |
AM_CONDITIONAL(ENABLE_SYSTEMD_INTEGRATION, [test "$enable_systemd_integration" = yes])
|
|
|
6cc380 |
|
|
|
6cc380 |
diff --git a/docs/Makefile.am b/docs/Makefile.am
|
|
|
6cc380 |
index dedda55..1a9f7ea 100644
|
|
|
6cc380 |
--- a/docs/Makefile.am
|
|
|
6cc380 |
+++ b/docs/Makefile.am
|
|
|
6cc380 |
@@ -1,4 +1,31 @@
|
|
|
6cc380 |
-dist_man_MANS = plymouth.8
|
|
|
6cc380 |
+XSLTPROC_FLAGS = \
|
|
|
6cc380 |
+ --nonet \
|
|
|
6cc380 |
+ --stringparam man.output.quietly 1 \
|
|
|
6cc380 |
+ --stringparam funcsynopsis.style ansi \
|
|
|
6cc380 |
+ --stringparam man.th.extra1.suppress 1 \
|
|
|
6cc380 |
+ --stringparam man.authors.section.enabled 0 \
|
|
|
6cc380 |
+ --stringparam man.copyright.section.enabled 0
|
|
|
6cc380 |
|
|
|
6cc380 |
-%.html: %.txt
|
|
|
6cc380 |
- asciidoc $(ASCIIDOC_OPTS) -a toc $*.txt
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+plymouth.1: plymouth1.xml
|
|
|
6cc380 |
+ $(AM_V_GEN) $(XSLTPROC) $(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+%.8: %.xml
|
|
|
6cc380 |
+ $(AM_V_GEN) $(XSLTPROC) $(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+%.1: %.xml
|
|
|
6cc380 |
+ $(AM_V_GEN) $(XSLTPROC) $(XSLTPROC_FLAGS) http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl $<
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+man_MANS = \
|
|
|
6cc380 |
+ plymouth.1 \
|
|
|
6cc380 |
+ plymouth.8 \
|
|
|
6cc380 |
+ plymouthd.8 \
|
|
|
6cc380 |
+ plymouth-set-default-theme.1
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+EXTRA_DIST = \
|
|
|
6cc380 |
+ plymouth.xml \
|
|
|
6cc380 |
+ plymouth1.xml \
|
|
|
6cc380 |
+ plymouth-set-default-theme.xml \
|
|
|
6cc380 |
+ plymouthd.xml
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+CLEANFILES = $(man_MANS)
|
|
|
6cc380 |
diff --git a/docs/plymouth-set-default-theme.xml b/docs/plymouth-set-default-theme.xml
|
|
|
6cc380 |
new file mode 100644
|
|
|
6cc380 |
index 0000000..efb051e
|
|
|
6cc380 |
--- /dev/null
|
|
|
6cc380 |
+++ b/docs/plymouth-set-default-theme.xml
|
|
|
6cc380 |
@@ -0,0 +1,103 @@
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+<refentry id="plymouth-set-default-theme">
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refentryinfo>
|
|
|
6cc380 |
+ <title>plymouth-set-default-theme</title>
|
|
|
6cc380 |
+ <productname>plymouth</productname>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <authorgroup>
|
|
|
6cc380 |
+ <author>
|
|
|
6cc380 |
+ <contrib>Developer</contrib>
|
|
|
6cc380 |
+ <firstname>Kristian</firstname>
|
|
|
6cc380 |
+ <surname>Høgsberg</surname>
|
|
|
6cc380 |
+ </author>
|
|
|
6cc380 |
+ <author>
|
|
|
6cc380 |
+ <contrib>Developer</contrib>
|
|
|
6cc380 |
+ <firstname>Ray</firstname>
|
|
|
6cc380 |
+ <surname>Strode</surname>
|
|
|
6cc380 |
+ </author>
|
|
|
6cc380 |
+ </authorgroup>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ </refentryinfo>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refmeta>
|
|
|
6cc380 |
+ <refentrytitle>plymouth-set-default-theme</refentrytitle>
|
|
|
6cc380 |
+ <manvolnum>1</manvolnum>
|
|
|
6cc380 |
+ <refmiscinfo class="manual">User Commands</refmiscinfo>
|
|
|
6cc380 |
+ </refmeta>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refnamediv>
|
|
|
6cc380 |
+ <refname>plymouth-set-default-theme</refname>
|
|
|
6cc380 |
+ <refpurpose>Set the plymouth theme</refpurpose>
|
|
|
6cc380 |
+ </refnamediv>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refsynopsisdiv>
|
|
|
6cc380 |
+ <cmdsynopsis>
|
|
|
6cc380 |
+ <command>plymouth-set-default-theme <arg choice="opt" rep="repeat">OPTION</arg> <arg choice="opt" rep="norepeat">THEME</arg></command>
|
|
|
6cc380 |
+ </cmdsynopsis>
|
|
|
6cc380 |
+ </refsynopsisdiv>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refsect1>
|
|
|
6cc380 |
+ <title>Description</title>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+<para>
|
|
|
6cc380 |
+When called with a <option>THEME</option> argument,
|
|
|
6cc380 |
+the <command>plymouth-set-default-theme</command> command
|
|
|
6cc380 |
+changes the preferred boot theme and also performs the necessary
|
|
|
6cc380 |
+regeneration of the initial ramdisk (initrd) since plymouth is loaded
|
|
|
6cc380 |
+from the boot loader from the initrd prior to the mounting of the root
|
|
|
6cc380 |
+filesystem.
|
|
|
6cc380 |
+</para>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+<para>
|
|
|
6cc380 |
+If <command>plymouth-set-default-theme</command> is invoked with no options
|
|
|
6cc380 |
+or parameters, it shows the currently selected theme by default. This output
|
|
|
6cc380 |
+is used by the helper scripts plymouth-generate-initrd and
|
|
|
6cc380 |
+plymouth-update-initrd to set the proper theme in the initial ramdisk.
|
|
|
6cc380 |
+</para>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ </refsect1>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refsect1>
|
|
|
6cc380 |
+ <title>Options</title>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <para>The following options are understood:</para>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <variablelist>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>-h</option>, <option>--help</option></term>
|
|
|
6cc380 |
+ <listitem><para>Show summary of options.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>-l</option>, <option>--list</option></term>
|
|
|
6cc380 |
+ <listitem><para>List available themes.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>-r</option>, <option>--reset</option></term>
|
|
|
6cc380 |
+ <listitem><para>Reset to default theme.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>-R</option>, <option>--rebuild-initrd</option></term>
|
|
|
6cc380 |
+ <listitem><para>Rebuild initrd (necessary after changing theme).</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ </variablelist>
|
|
|
6cc380 |
+ </refsect1>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refsect1>
|
|
|
6cc380 |
+ <title>See Also</title>
|
|
|
6cc380 |
+ <para>
|
|
|
6cc380 |
+ <citerefentry><refentrytitle>grub</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
|
|
6cc380 |
+ <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
|
|
6cc380 |
+ <citerefentry><refentrytitle>plymouthd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
|
|
6cc380 |
+ <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
|
6cc380 |
+ <ulink url="http://www.freedesktop.org/wiki/Software/Plymouth">http://www.freedesktop.org/wiki/Software/Plymouth</ulink>
|
|
|
6cc380 |
+ </para>
|
|
|
6cc380 |
+ </refsect1>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+</refentry>
|
|
|
6cc380 |
diff --git a/docs/plymouth.8 b/docs/plymouth.8
|
|
|
6cc380 |
deleted file mode 100644
|
|
|
6cc380 |
index 7f4766b..0000000
|
|
|
6cc380 |
--- a/docs/plymouth.8
|
|
|
6cc380 |
+++ /dev/null
|
|
|
6cc380 |
@@ -1,62 +0,0 @@
|
|
|
6cc380 |
-\" Hey, EMACS: -*- nroff -*-
|
|
|
6cc380 |
-.TH PLYMOUTH 8 "December 15, 2009"
|
|
|
6cc380 |
-.SH NAME
|
|
|
6cc380 |
-plymouth \- A graphical boot system and logger
|
|
|
6cc380 |
-.SH SYNOPSIS
|
|
|
6cc380 |
-.B plymouth-set-default-theme
|
|
|
6cc380 |
-.RI [ options ] " \<theme\>"
|
|
|
6cc380 |
-.SH DESCRIPTION
|
|
|
6cc380 |
-\fBplymouth\fP is a graphical boot system for Linux which takes advantage of the kernel-based
|
|
|
6cc380 |
-mode setting (KMS) available for modern graphic cards to provide a seamless, flickerfree
|
|
|
6cc380 |
-and attractive boot screen. It allows to choose between various, static or
|
|
|
6cc380 |
-animated graphical themes to spruce up the startup and avoid the noise
|
|
|
6cc380 |
-generated by the vast amount of kernel messages while the machine boots into X.
|
|
|
6cc380 |
-On systems where kernel-based mode setting is not available, plymouth falls
|
|
|
6cc380 |
-back to a text mode boot screen which provides a simple progress bar to provide
|
|
|
6cc380 |
-feedback during boot.
|
|
|
6cc380 |
-.PP
|
|
|
6cc380 |
-To configure plymouth, that is to choose and install the preferred boot theme, the
|
|
|
6cc380 |
-user has to invoke \fBplymouth-set-default-theme\fP. It changes the configuration
|
|
|
6cc380 |
-to the new theme and also performs the necessary regeneration of the initial ramdisk
|
|
|
6cc380 |
-(initrd) since plymouth is loaded from the boot loader from the initrd
|
|
|
6cc380 |
-prior to the mounting of the root filesystem. The options available to this
|
|
|
6cc380 |
-script are explained in the \fBOPTIONS\fP paragraph.
|
|
|
6cc380 |
-.PP
|
|
|
6cc380 |
-In order for the configured default plymouth theme to be loaded during boot,
|
|
|
6cc380 |
-the option `splash' (or `rhgb' for backward compatibility with the RHGB boot
|
|
|
6cc380 |
-splash) must be provided at the kernel command line. With this command line
|
|
|
6cc380 |
-option, plymouth will default to showing detailed boot output.
|
|
|
6cc380 |
-.SH OPTIONS
|
|
|
6cc380 |
-plymouth-set-default-theme follows the usual GNU command line syntax, with long
|
|
|
6cc380 |
-options starting with two dashes (`-') and short variants of each of them.
|
|
|
6cc380 |
-.TP
|
|
|
6cc380 |
-.B \-h, \-\-help
|
|
|
6cc380 |
-Show summary of options.
|
|
|
6cc380 |
-.TP
|
|
|
6cc380 |
-.B \-l, \-\-list
|
|
|
6cc380 |
-List available themes.
|
|
|
6cc380 |
-.TP
|
|
|
6cc380 |
-.B \-r, \-\-reset
|
|
|
6cc380 |
-Reset to default theme.
|
|
|
6cc380 |
-.TP
|
|
|
6cc380 |
-.B \-R, \-\-rebuild\-initrd
|
|
|
6cc380 |
-Rebuild initrd (necessary after changing theme).
|
|
|
6cc380 |
-.TP
|
|
|
6cc380 |
-.B \<theme-name\>
|
|
|
6cc380 |
-Name of new theme to use. If you want to see which themes are available, invoke the script with just \-\-list.
|
|
|
6cc380 |
-.PP
|
|
|
6cc380 |
-If plymouth-set-default-theme is invoked with no options or parameters, it shows the currently selected theme
|
|
|
6cc380 |
-by default. This output is used by the helper scripts `plymouth-generate-initrd' and `plymouth-update-initrd'
|
|
|
6cc380 |
-to set the proper theme in the initial ramdisk.
|
|
|
6cc380 |
-.SH SEE ALSO
|
|
|
6cc380 |
-.BR grub (8)
|
|
|
6cc380 |
-.br
|
|
|
6cc380 |
-.SH AUTHOR
|
|
|
6cc380 |
-plymouth was originally prototyped and named by Kristian Høgsberg <krh@bitplanet.net>,
|
|
|
6cc380 |
-originally written by Ray Strode <halfline@gmail.com> and has had significant contributions
|
|
|
6cc380 |
-from Charlie Brej <cbrej@cs.man.ac.uk>. It has also had contributions from
|
|
|
6cc380 |
-Peter Jones <pjones@redhat.com>, Adam Jackson <ajax@nwnk.net>,
|
|
|
6cc380 |
-Frederic Crozat <fcrozat@mandriva.com> and others.
|
|
|
6cc380 |
-It can be downloaded here: <http://www.freedesktop.org/wiki/Software/Plymouth>.
|
|
|
6cc380 |
-.PP
|
|
|
6cc380 |
-This manual page was written by Adrian Glaubitz <glaubitz@physik.fu-berlin.de>.
|
|
|
6cc380 |
diff --git a/docs/plymouth.xml b/docs/plymouth.xml
|
|
|
6cc380 |
new file mode 100644
|
|
|
6cc380 |
index 0000000..0f196c6
|
|
|
6cc380 |
--- /dev/null
|
|
|
6cc380 |
+++ b/docs/plymouth.xml
|
|
|
6cc380 |
@@ -0,0 +1,86 @@
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+<refentry id="plymouth">
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refentryinfo>
|
|
|
6cc380 |
+ <title>plymouth</title>
|
|
|
6cc380 |
+ <productname>plymouth</productname>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <authorgroup>
|
|
|
6cc380 |
+ <author>
|
|
|
6cc380 |
+ <contrib>Developer</contrib>
|
|
|
6cc380 |
+ <firstname>Kristian</firstname>
|
|
|
6cc380 |
+ <surname>Høgsberg</surname>
|
|
|
6cc380 |
+ </author>
|
|
|
6cc380 |
+ <author>
|
|
|
6cc380 |
+ <contrib>Developer</contrib>
|
|
|
6cc380 |
+ <firstname>Ray</firstname>
|
|
|
6cc380 |
+ <surname>Strode</surname>
|
|
|
6cc380 |
+ </author>
|
|
|
6cc380 |
+ </authorgroup>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ </refentryinfo>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refmeta>
|
|
|
6cc380 |
+ <refentrytitle>plymouth</refentrytitle>
|
|
|
6cc380 |
+ <manvolnum>8</manvolnum>
|
|
|
6cc380 |
+ <refmiscinfo class="manual">System Administration</refmiscinfo>
|
|
|
6cc380 |
+ </refmeta>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refnamediv>
|
|
|
6cc380 |
+ <refname>plymouth</refname>
|
|
|
6cc380 |
+ <refpurpose>A graphical boot system and logger</refpurpose>
|
|
|
6cc380 |
+ </refnamediv>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refsect1>
|
|
|
6cc380 |
+ <title>Description</title>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+<para>
|
|
|
6cc380 |
+<command>plymouth</command> is a graphical boot system for Linux which takes advantage of
|
|
|
6cc380 |
+the kernel-based mode setting (KMS) available for modern graphic cards
|
|
|
6cc380 |
+to provide a seamless, flickerfree and attractive boot screen. It
|
|
|
6cc380 |
+allows to choose between various, static or animated graphical themes
|
|
|
6cc380 |
+to spruce up the startup and avoid the noise generated by the vast
|
|
|
6cc380 |
+amount of kernel messages while the machine boots into X. On systems
|
|
|
6cc380 |
+where kernel-based mode setting is not available, plymouth falls back
|
|
|
6cc380 |
+to a text mode boot screen which provides a simple progress bar to pro‐
|
|
|
6cc380 |
+vide feedback during boot.
|
|
|
6cc380 |
+</para>
|
|
|
6cc380 |
+<para>
|
|
|
6cc380 |
+In order for the configured default plymouth theme to be loaded during
|
|
|
6cc380 |
+boot, the option `splash' (or `rhgb' for backward compatibility with
|
|
|
6cc380 |
+the RHGB boot splash) must be provided at the kernel command line.
|
|
|
6cc380 |
+Without this command line option, plymouth will default to showing
|
|
|
6cc380 |
+detailed boot output.
|
|
|
6cc380 |
+</para>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+<para>
|
|
|
6cc380 |
+During the boot process, the user can switch between the graphical theme
|
|
|
6cc380 |
+and the detailed boot output using the Escape key.
|
|
|
6cc380 |
+</para>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ </refsect1>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refsect1>
|
|
|
6cc380 |
+ <title>See Also</title>
|
|
|
6cc380 |
+ <para>
|
|
|
6cc380 |
+ <citerefentry><refentrytitle>grub</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
|
|
6cc380 |
+ <citerefentry><refentrytitle>plymouth-set-theme</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
|
6cc380 |
+ <citerefentry><refentrytitle>plymouthd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
|
|
6cc380 |
+ <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
|
6cc380 |
+ <ulink url="http://www.freedesktop.org/wiki/Software/Plymouth">http://www.freedesktop.org/wiki/Software/Plymouth</ulink>
|
|
|
6cc380 |
+ </para>
|
|
|
6cc380 |
+ </refsect1>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refsect1>
|
|
|
6cc380 |
+ <title>Authors</title>
|
|
|
6cc380 |
+ <para>
|
|
|
6cc380 |
+plymouth was originally prototyped and named by Kristian Høgsberg,
|
|
|
6cc380 |
+originally written by Ray Strode and has had significant contributions from
|
|
|
6cc380 |
+Charlie Brej. It has also had contributions from Peter Jones, Adam Jackson,
|
|
|
6cc380 |
+Frederic Crozat and others.
|
|
|
6cc380 |
+ </para>
|
|
|
6cc380 |
+ </refsect1>
|
|
|
6cc380 |
+</refentry>
|
|
|
6cc380 |
diff --git a/docs/plymouth1.xml b/docs/plymouth1.xml
|
|
|
6cc380 |
new file mode 100644
|
|
|
6cc380 |
index 0000000..b484599
|
|
|
6cc380 |
--- /dev/null
|
|
|
6cc380 |
+++ b/docs/plymouth1.xml
|
|
|
6cc380 |
@@ -0,0 +1,351 @@
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+<refentry id="plymouth-set-default-theme">
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refentryinfo>
|
|
|
6cc380 |
+ <title>plymouth</title>
|
|
|
6cc380 |
+ <productname>plymouth</productname>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <authorgroup>
|
|
|
6cc380 |
+ <author>
|
|
|
6cc380 |
+ <contrib>Developer</contrib>
|
|
|
6cc380 |
+ <firstname>Kristian</firstname>
|
|
|
6cc380 |
+ <surname>Høgsberg</surname>
|
|
|
6cc380 |
+ </author>
|
|
|
6cc380 |
+ <author>
|
|
|
6cc380 |
+ <contrib>Developer</contrib>
|
|
|
6cc380 |
+ <firstname>Ray</firstname>
|
|
|
6cc380 |
+ <surname>Strode</surname>
|
|
|
6cc380 |
+ </author>
|
|
|
6cc380 |
+ </authorgroup>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ </refentryinfo>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refmeta>
|
|
|
6cc380 |
+ <refentrytitle>plymouth</refentrytitle>
|
|
|
6cc380 |
+ <manvolnum>1</manvolnum>
|
|
|
6cc380 |
+ <refmiscinfo class="manual">User Commands</refmiscinfo>
|
|
|
6cc380 |
+ </refmeta>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refnamediv>
|
|
|
6cc380 |
+ <refname>plymouth</refname>
|
|
|
6cc380 |
+ <refpurpose>Send commands to plymouthd</refpurpose>
|
|
|
6cc380 |
+ </refnamediv>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refsynopsisdiv>
|
|
|
6cc380 |
+ <cmdsynopsis>
|
|
|
6cc380 |
+ <command>plymouth <arg choice="opt" rep="repeat">OPTION</arg></command>
|
|
|
6cc380 |
+ </cmdsynopsis>
|
|
|
6cc380 |
+ <cmdsynopsis>
|
|
|
6cc380 |
+ <command>plymouth <arg choice="plain">COMMAND <arg choice="opt" rep="repeat">OPTION</arg></arg></command>
|
|
|
6cc380 |
+ </cmdsynopsis>
|
|
|
6cc380 |
+ </refsynopsisdiv>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refsect1>
|
|
|
6cc380 |
+ <title>Description</title>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+<para>
|
|
|
6cc380 |
+The <command>plymouth</command> sends commands to a running
|
|
|
6cc380 |
+<command>plymouthd</command>. This is used during the boot
|
|
|
6cc380 |
+process to control the display of the graphical boot splash.
|
|
|
6cc380 |
+</para>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ </refsect1>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refsect1>
|
|
|
6cc380 |
+ <title>Options</title>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <para>
|
|
|
6cc380 |
+The following options are understood. These options are supported
|
|
|
6cc380 |
+for compatibility with the old <command>rhgb-client</command> interface,
|
|
|
6cc380 |
+and have been replaced by the commands that are described in the
|
|
|
6cc380 |
+next section.
|
|
|
6cc380 |
+</para>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <variablelist>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--help</option></term>
|
|
|
6cc380 |
+ <listitem><para>Show summary of options.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--debug</option></term>
|
|
|
6cc380 |
+ <listitem><para>Enable verbose debug logging.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--get-splash-plugin-path</option></term>
|
|
|
6cc380 |
+ <listitem><para>Get directory where splash plugins are installed.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--newroot=<arg>STRING</arg></option></term>
|
|
|
6cc380 |
+ <listitem><para>Tell plymouthd that the new root filesystem is mounted.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--quit</option></term>
|
|
|
6cc380 |
+ <listitem><para>Tell plymouthd to quit.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--ping</option></term>
|
|
|
6cc380 |
+ <listitem><para>Check if plymouthd is running.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--has-active-vt</option></term>
|
|
|
6cc380 |
+ <listitem><para>Check if plymouthd has an active vt.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--sysinit</option></term>
|
|
|
6cc380 |
+ <listitem><para>Tell plymouthd root filesystem is mounted read-write.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--show-splash</option></term>
|
|
|
6cc380 |
+ <listitem><para>Show the splash screen.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--hide-splash</option></term>
|
|
|
6cc380 |
+ <listitem><para>Hide the splash screen.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--ask-for-password</option></term>
|
|
|
6cc380 |
+ <listitem><para>Ask the user for a password.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--ignore-keystroke=<arg>STRING</arg></option></term>
|
|
|
6cc380 |
+ <listitem><para>Remove sensitivity to a keystroke.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--update=<arg>STRING</arg></option></term>
|
|
|
6cc380 |
+ <listitem><para>Tell plymouthd an update about boot progress.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--details</option></term>
|
|
|
6cc380 |
+ <listitem><para>Tell plymouthd there were errors during boot.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--wait</option></term>
|
|
|
6cc380 |
+ <listitem><para>Wait for plymouthd to quit.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ </variablelist>
|
|
|
6cc380 |
+ </refsect1>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refsect1>
|
|
|
6cc380 |
+ <title>Commands</title>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+<para>
|
|
|
6cc380 |
+The following commands are understood:
|
|
|
6cc380 |
+</para>
|
|
|
6cc380 |
+ <variablelist>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><command>change-mode <arg choice="plain">OPTION</arg></command></term>
|
|
|
6cc380 |
+ <listitem><para>Change the operation mode.</para>
|
|
|
6cc380 |
+<variablelist>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--boot-up</option></term>
|
|
|
6cc380 |
+ <listitem><para>Start the system up</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--shutdown</option></term>
|
|
|
6cc380 |
+ <listitem><para>Shutting the system up</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--updates</option></term>
|
|
|
6cc380 |
+ <listitem><para>Applying updates</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+</variablelist>
|
|
|
6cc380 |
+</listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><command>system-update <arg choice="plain">OPTION</arg></command></term>
|
|
|
6cc380 |
+ <listitem><para>Tell plymouthd about boot progress.</para>
|
|
|
6cc380 |
+<variablelist>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--progress=INTEGER</option></term>
|
|
|
6cc380 |
+ <listitem><para>The percentage progress of the updates</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+</variablelist>
|
|
|
6cc380 |
+</listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><command>update <arg choice="plain">OPTION</arg></command></term>
|
|
|
6cc380 |
+ <listitem><para>Tell plymouthd about boot status changes.</para>
|
|
|
6cc380 |
+<variablelist>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--status=STRING</option></term>
|
|
|
6cc380 |
+ <listitem><para>Tell plymouthd the current boot status</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+</variablelist>
|
|
|
6cc380 |
+</listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><command>update-root-fs <arg choice="plain">OPTION</arg></command></term>
|
|
|
6cc380 |
+ <listitem><para>Tell plymouthd about root filesystem changes.</para>
|
|
|
6cc380 |
+<variablelist>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--new-root-dir=STRING</option></term>
|
|
|
6cc380 |
+ <listitem><para>Root filesystem is about to change</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--read-write</option></term>
|
|
|
6cc380 |
+ <listitem><para>Root filesystem is no longer read-only</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+</variablelist>
|
|
|
6cc380 |
+</listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><command>show-splash</command></term>
|
|
|
6cc380 |
+ <listitem><para>Tell plymouthd to show splash screen.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><command>hide-splash</command></term>
|
|
|
6cc380 |
+ <listitem><para>Tell plymouthd to hide splash screen.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><command>ask-for-password <arg choice="plain">OPTION</arg></command></term>
|
|
|
6cc380 |
+ <listitem><para>Ask the user for a password.</para>
|
|
|
6cc380 |
+<variablelist>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--command=STRING</option></term>
|
|
|
6cc380 |
+ <listitem><para>Command to send password to via standard input</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--prompt=STRING</option></term>
|
|
|
6cc380 |
+ <listitem><para>Message to display when asking for password</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--number-of-tries=INTEGER</option></term>
|
|
|
6cc380 |
+ <listitem><para>Number of times to ask before giving up (requires <option>--command</option>)</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--dont-pause-progress</option></term>
|
|
|
6cc380 |
+ <listitem><para>Don't pause boot progress bar while asking</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+</variablelist>
|
|
|
6cc380 |
+</listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><command>ask-question</command></term>
|
|
|
6cc380 |
+ <listitem><para>Ask the user a question.</para>
|
|
|
6cc380 |
+<variablelist>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--command=STRING</option></term>
|
|
|
6cc380 |
+ <listitem><para>Command to send the answer to via standard input</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--prompt=STRING</option></term>
|
|
|
6cc380 |
+ <listitem><para>Message to display when asking the question</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--dont-pause-progress</option></term>
|
|
|
6cc380 |
+ <listitem><para>Don't pause boot progress bar while asking</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+</variablelist>
|
|
|
6cc380 |
+</listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><command>display-message <arg choice="plain">OPTION</arg></command></term>
|
|
|
6cc380 |
+ <listitem><para>Display a message.</para>
|
|
|
6cc380 |
+<variablelist>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--text=STRING</option></term>
|
|
|
6cc380 |
+ <listitem><para>The message text</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+</variablelist>
|
|
|
6cc380 |
+</listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><command>hide-message <arg choice="plain">OPTION</arg></command></term>
|
|
|
6cc380 |
+ <listitem><para>Hide a message.</para>
|
|
|
6cc380 |
+<variablelist>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--text=STRING</option></term>
|
|
|
6cc380 |
+ <listitem><para>The message text</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+</variablelist>
|
|
|
6cc380 |
+</listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><command>watch-keystroke <arg choice="plain">OPTION</arg></command></term>
|
|
|
6cc380 |
+ <listitem><para>Become sensitive to a keystroke.</para>
|
|
|
6cc380 |
+<variablelist>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--command=STRING</option></term>
|
|
|
6cc380 |
+ <listitem><para>Command to send keystroke to via standard input</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--keys=STRING</option></term>
|
|
|
6cc380 |
+ <listitem><para>Keys to become sensitive to</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+</variablelist>
|
|
|
6cc380 |
+</listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><command>ignore-keystroke <arg choice="plain">OPTION</arg></command></term>
|
|
|
6cc380 |
+ <listitem><para>Remove sensitivity to a keystroke.</para>
|
|
|
6cc380 |
+<variablelist>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--keys=STRING</option></term>
|
|
|
6cc380 |
+ <listitem><para>Keys to remove sensitivitiy from</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+</variablelist>
|
|
|
6cc380 |
+</listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><command>pause-progress</command></term>
|
|
|
6cc380 |
+ <listitem><para>Pause boot progress bar.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><command>unpause-progress</command></term>
|
|
|
6cc380 |
+ <listitem><para>Unpause boot progress bar.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><command>report-error</command></term>
|
|
|
6cc380 |
+ <listitem><para>Tell plymouthd there were errors during boot.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><command>deactivate</command></term>
|
|
|
6cc380 |
+ <listitem><para>Tell plymouthd to deactivate.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><command>reactivate</command></term>
|
|
|
6cc380 |
+ <listitem><para>Tell plymouthd to reactivate.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><command>quit <arg choice="plain">OPTION</arg></command></term>
|
|
|
6cc380 |
+ <listitem><para>Tell plymouthd to quit.</para>
|
|
|
6cc380 |
+<variablelist>
|
|
|
6cc380 |
+<varlistentry>
|
|
|
6cc380 |
+ <term><option>--retain-splash</option></term>
|
|
|
6cc380 |
+ <listitem><para>Don't explicitly hide boot splash on exit</para></listitem>
|
|
|
6cc380 |
+</varlistentry>
|
|
|
6cc380 |
+</variablelist>
|
|
|
6cc380 |
+</listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ </variablelist>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ </refsect1>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refsect1>
|
|
|
6cc380 |
+ <title>See Also</title>
|
|
|
6cc380 |
+ <para>
|
|
|
6cc380 |
+ <citerefentry><refentrytitle>grub</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
|
|
6cc380 |
+ <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
|
|
6cc380 |
+ <citerefentry><refentrytitle>plymouthd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
|
|
6cc380 |
+ <ulink url="http://www.freedesktop.org/wiki/Software/Plymouth">http://www.freedesktop.org/wiki/Software/Plymouth</ulink>
|
|
|
6cc380 |
+ </para>
|
|
|
6cc380 |
+ </refsect1>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+</refentry>
|
|
|
6cc380 |
diff --git a/docs/plymouthd.xml b/docs/plymouthd.xml
|
|
|
6cc380 |
new file mode 100644
|
|
|
6cc380 |
index 0000000..4e7e499
|
|
|
6cc380 |
--- /dev/null
|
|
|
6cc380 |
+++ b/docs/plymouthd.xml
|
|
|
6cc380 |
@@ -0,0 +1,121 @@
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+<refentry id="plymouthd">
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refentryinfo>
|
|
|
6cc380 |
+ <title>plymouthd</title>
|
|
|
6cc380 |
+ <productname>plymouth</productname>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <authorgroup>
|
|
|
6cc380 |
+ <author>
|
|
|
6cc380 |
+ <contrib>Developer</contrib>
|
|
|
6cc380 |
+ <firstname>Kristian</firstname>
|
|
|
6cc380 |
+ <surname>Høgsberg</surname>
|
|
|
6cc380 |
+ </author>
|
|
|
6cc380 |
+ <author>
|
|
|
6cc380 |
+ <contrib>Developer</contrib>
|
|
|
6cc380 |
+ <firstname>Ray</firstname>
|
|
|
6cc380 |
+ <surname>Strode</surname>
|
|
|
6cc380 |
+ </author>
|
|
|
6cc380 |
+ </authorgroup>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ </refentryinfo>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refmeta>
|
|
|
6cc380 |
+ <refentrytitle>plymouthd</refentrytitle>
|
|
|
6cc380 |
+ <manvolnum>8</manvolnum>
|
|
|
6cc380 |
+ <refmiscinfo class="manual">System Administration</refmiscinfo>
|
|
|
6cc380 |
+ </refmeta>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refnamediv>
|
|
|
6cc380 |
+ <refname>plymouthd</refname>
|
|
|
6cc380 |
+ <refpurpose>The plymouth daemon</refpurpose>
|
|
|
6cc380 |
+ </refnamediv>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refsynopsisdiv>
|
|
|
6cc380 |
+ <cmdsynopsis>
|
|
|
6cc380 |
+ <command>plymouthd <arg choice="opt" rep="repeat">OPTION</arg></command>
|
|
|
6cc380 |
+ </cmdsynopsis>
|
|
|
6cc380 |
+ </refsynopsisdiv>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refsect1>
|
|
|
6cc380 |
+ <title>Description</title>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+<para>
|
|
|
6cc380 |
+The <command>plymouthd</command> daemon is usually run out of
|
|
|
6cc380 |
+the initrd. It does the heavy lifting of the plymouth system, logging
|
|
|
6cc380 |
+the session and showing the splash screen.
|
|
|
6cc380 |
+</para>
|
|
|
6cc380 |
+<para>
|
|
|
6cc380 |
+The <command>plymouth</command> is used to send commands to plymouthd
|
|
|
6cc380 |
+that control its behaviour.
|
|
|
6cc380 |
+</para>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ </refsect1>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refsect1>
|
|
|
6cc380 |
+ <title>Options</title>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <para>The following options are understood:</para>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <variablelist>
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--help</option></term>
|
|
|
6cc380 |
+ <listitem><para>Show summary of options.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--attach-to-session</option></term>
|
|
|
6cc380 |
+ <listitem><para>Redirect console messages from screen to log.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--no-daemon</option></term>
|
|
|
6cc380 |
+ <listitem><para>Do not daemonize.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--debug</option></term>
|
|
|
6cc380 |
+ <listitem><para>Output debugging information.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--debug-file=STRING</option></term>
|
|
|
6cc380 |
+ <listitem><para>File to write debugging information to.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--mode=MODE</option></term>
|
|
|
6cc380 |
+ <listitem><para>Set mode to either boot or shutdown.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--pid-file=STRING</option></term>
|
|
|
6cc380 |
+ <listitem><para>Write the PID of the daemon to a file.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--kernel-command-line=STRING</option></term>
|
|
|
6cc380 |
+ <listitem><para>Fake kernel commandline to use.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <varlistentry>
|
|
|
6cc380 |
+ <term><option>--tty=STRING</option></term>
|
|
|
6cc380 |
+ <listitem><para>TTY to ues instead of default.</para></listitem>
|
|
|
6cc380 |
+ </varlistentry>
|
|
|
6cc380 |
+ </variablelist>
|
|
|
6cc380 |
+ </refsect1>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+ <refsect1>
|
|
|
6cc380 |
+ <title>See Also</title>
|
|
|
6cc380 |
+ <para>
|
|
|
6cc380 |
+ <citerefentry><refentrytitle>grub</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
|
|
6cc380 |
+ <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
|
|
|
6cc380 |
+ <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
|
|
|
6cc380 |
+ <ulink url="http://www.freedesktop.org/wiki/Software/Plymouth">http://www.freedesktop.org/wiki/Software/Plymouth</ulink>
|
|
|
6cc380 |
+ </para>
|
|
|
6cc380 |
+ </refsect1>
|
|
|
6cc380 |
+
|
|
|
6cc380 |
+</refentry>
|
|
|
6cc380 |
--
|
|
|
6cc380 |
1.8.3.1
|
|
|
6cc380 |
|