fdo-mirrors/plymouth
1
0
Fork 0
mirror of https://gitlab.freedesktop.org/plymouth/plymouth.git synced 2026-05-09 03:38:09 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

docs: Rewrite man pages in groff format

Browse source
This commit is contained in:
Leon Marz 2025-08-26 10:52:26 +02:00
parent 3466343257
commit ca16c86369
9 changed files with 373 additions and 682 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

32
docs/meson.build
View file

@ -1,29 +1,19 @@
xsltproc = find_program('xsltproc')
man_conf = configuration_data()
man_conf.set('version', meson.project_version())
man_pages = {
'plymouth1.xml': 'plymouth.1',
'plymouth.xml': 'plymouth.8',
'plymouthd.xml': 'plymouthd.8',
'plymouth-set-default-theme.xml': 'plymouth-set-default-theme.1',
'plymouth.1.in': 'plymouth.1',
'plymouth.8.in': 'plymouth.8',
'plymouthd.8.in': 'plymouthd.8',
'plymouth-set-default-theme.1.in': 'plymouth-set-default-theme.1',
}
foreach man_xml_input, man_output : man_pages
custom_target(man_output,
input: man_xml_input,
output: man_output,
command: [
xsltproc,
'--nonet',
'--stringparam', 'man.output.quietly', '1',
'--stringparam', 'funcsynopsis.style', 'ansi',
'--stringparam', 'man.th.extra1.suppress', '1',
'--stringparam', 'man.authors.section.enabled', '0',
'--stringparam', 'man.copyright.section.enabled', '0',
'-o', '@OUTPUT@',
'http://docbook.sourceforge.net/release/xsl/current/manpages/docbook.xsl',
'@INPUT@',
],
foreach man_input, man_output : man_pages
configure_file(
configuration: man_conf,
input: man_input,
install: true,
install_dir: get_option('mandir') / 'man' + man_output.substring(-1),
output: man_output,
)
endforeach

49
docs/plymouth-set-default-theme.1.in Normal file
View file

@ -0,0 +1,49 @@
.TH plymouth-set-default-theme 1 "2025-08-25" @version@
.SH NAME
plymouth-set-default-theme \- Set the plymouth theme
.SH SYNOPSIS
.SY plymouth-set-default-theme
.RI [ option ]\.\.\.
.RI [ theme ]
.YS
.SH DESCRIPTION
When called with a
.I theme
argument, the
.B plymouth-set-default-theme
command changes the preferred boot 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.
.P
If
.B 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 OPTIONS
The following options are understood:
.TP
.B \-h, \-\-help
Show summary of options.
.TP
.B \-l, \-\-list
Show available themes.
.TP
.B \-r, \-\-reset
Reset to default theme.
.TP
.B \-R, \-\-rebuild\-initrd
Rebuild initrd (necessary after changing theme).
.SH SEE ALSO
.BR plymouth (1),
.BR grub (8),
.BR plymouth (8),
.BR plymouthd (8),
.UR http://www.freedesktop.org/wiki/Software/Plymouth
.UE

103
docs/plymouth-set-default-theme.xml
View file

@ -1,103 +0,0 @@
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<refentry id="plymouth-set-default-theme">
<refentryinfo>
<title>plymouth-set-default-theme</title>
<productname>plymouth</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Kristian</firstname>
<surname>Høgsberg</surname>
</author>
<author>
<contrib>Developer</contrib>
<firstname>Ray</firstname>
<surname>Strode</surname>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>plymouth-set-default-theme</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="manual">User Commands</refmiscinfo>
</refmeta>
<refnamediv>
<refname>plymouth-set-default-theme</refname>
<refpurpose>Set the plymouth theme</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>plymouth-set-default-theme <arg choice="opt" rep="repeat">OPTION</arg> <arg choice="opt" rep="norepeat">THEME</arg></command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
When called with a <option>THEME</option> argument,
the <command>plymouth-set-default-theme</command> command
changes the preferred boot 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.
</para>
<para>
If <command>plymouth-set-default-theme</command> 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.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>-h</option>, <option>--help</option></term>
<listitem><para>Show summary of options.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-l</option>, <option>--list</option></term>
<listitem><para>List available themes.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-r</option>, <option>--reset</option></term>
<listitem><para>Reset to default theme.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>-R</option>, <option>--rebuild-initrd</option></term>
<listitem><para>Rebuild initrd (necessary after changing theme).</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>grub</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>plymouthd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<ulink url="http://www.freedesktop.org/wiki/Software/Plymouth">http://www.freedesktop.org/wiki/Software/Plymouth</ulink>
</para>
</refsect1>
</refentry>

211
docs/plymouth.1.in Normal file
View file

@ -0,0 +1,211 @@
.TH plymouth 1 "2025-08-25" @version@
.SH NAME
plymouth \- Send commands to plymouthd
.SH SYNOPSIS
.SY plymouth
.RI [ option ]\.\.\.
.YS
.SY plymouth
.I command
.RI [ option ]\.\.\.
.YS
.SH DESCRIPTION
The
.B plymouth
command sends commands to a running
.B plymouthd
instance. This is used during the boot process to control the display of
the graphical boot splash.
.SH OPTIONS
The following options are understood. These options are supported for
compatibility with the old
.B rhgb-client
interface, and have been replaced by the commands that are described in
the next section.
.TP
.B \-\-help
Show summary of options.
.TP
.B \-\-debug
Enable verbose debug logging.
.TP
.B \-\-get\-splash\-plugin\-path
Get directory where splash plugins are installed.
.TP
.BI \-\-newroot= string
Tell plymouthd that the new root filesystem is mounted.
.TP
.B \-\-quit
Tell plymouthd to quit.
.TP
.B \-\-ping
Check if plymouthd is running.
.TP
.B \-\-has\-active\-vt
Check if plymouthd has an active vt.
.TP
.B \-\-sysinit
Tell plymouthd root filesystem is mounted read-write.
.TP
.B \-\-show\-splash
Show the splash screen.
.TP
.B \-\-hide\-splash
Hide the splash screen.
.TP
.B \-\-ask\-for\-password
Ask the user for a password.
.TP
.BI \-\-ignore\-keystroke= string
Remove sensitivity to a keystroke.
.TP
.BI \-\-update= string
Tell plymouthd an update about boot progress.
.TP
.B \-\-details
Tell plymouthd there were errors during boot.
.TP
.B \-\-wait
Wait for plymouthd to quit.
.SH COMMANDS
The following commands are understood:
.TP
.BI change\-mode\~ option
Change the operation mode.
.IP
.B \-\-boot\-up
Starting the system up
.IP
.B \-\-shutdown
Shutting the system down
.IP
.B \-\-reboot
Rebooting the system
.IP
.B \-\-updates
Applying updates
.IP
.B \-\-system\-upgrade
Upgrading the OS to a new version
.IP
.B \-\-firmware\-upgrade
Upgrading firmware to a new version
.IP
.B \-\-system\-reset
Resetting the OS and erasing all user data
.TP
.BI system\-update\~ option
Tell plymouthd about updates progress.
.IP
.BI \-\-progress= integer
The percentage progress of the updates
.TP
.BI update\~ option
Tell plymouthd about boot status changes.
.IP
.BI \-\-status= string
Tell plymouthd the current boot status
.TP
.BI update\-root\-fs\~ option
Tell plymouthd about root filesystem changes.
.IP
.BI \-\-new\-root\-dir= string
Root filesystem is about to change
.IP
.B \-\-read\-write
Root filesystem is no longer read-only
.TP
.B show\-splash
Tell plymouthd to show splash screen.
.TP
.B hide\-splash
Tell plymouthd to hide splash screen.
.TP
.BI ask\-for\-password\~ option \.\.\.
Ask user for password.
.IP
.BI \-\-command= string
Command to send password to via standard input
.IP
.BI \-\-prompt= string
Message to display when asking for password
.IP
.BI \-\-number\-of\-tries= integer
Number of times to ask before giving up (requires --command)
.IP
.B \-\-dont\-pause\-progress
Don't pause boot progress bar while asking
.TP
.BI ask\-question\~ option \.\.\.
Ask user a question.
.IP
.BI \-\-command= string
Command to send the answer to via standard input
.IP
.BI \-\-prompt= string
Message to display when asking the question
.IP
.B \-\-dont\-pause\-progress
Don't pause boot progress bar while asking
.TP
.BI display\-message\~ option
Display a message.
.IP
.BI \-\-text= string
The message text
.TP
.BI hide\-message\~ option
Hide a message.
.IP
.BI \-\-text= string
The message text
.TP
.BI watch\-keystroke\~ option
Become sensitive to a keystroke.
.IP
.BI \-\-command= string
Command to send keystroke to via standard input
.IP
.BI \-\-keys= string
Keys to become sensitive to
.TP
.BI ignore\-keystroke\~ option
Remove sensitivity to a keystroke.
.IP
.BI \-\-keys= string
Keys to remove sensitivity to
.TP
.B pause\-progress
Pause boot progress bar.
.TP
.B unpause\-progress
Unpause boot progress bar.
.TP
.B report\-error
Tell plymouthd there were errors during boot.
.TP
.B deactivate
Tell plymouthd to deactivate.
.TP
.B reactivate
Tell plymouthd to reactivate.
.TP
.BI quit\~\f[][ option \f[]]
Tell plymouthd to quit.
.IP
.B \-\-retain\-splash
Don't explicitly hide boot splash on exit
.TP
.B reload
Tell plymouthd to reload the theme.
.SH SEE ALSO
.BR grub (8),
.BR plymouth (8),
.BR plymouthd (8),
.UR http://www.freedesktop.org/wiki/Software/Plymouth
.UE

38
docs/plymouth.8.in Normal file
View file

@ -0,0 +1,38 @@
.TH plymouth 8 "2025-08-25" @version@
.SH NAME
plymouth \- A graphical boot system and logger
.SH DESCRIPTION
.B plymouth
is 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 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 the graphical server. 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.
.P
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. Without
this command line option, plymouth will default to showing detailed boot
output.
.P
During the boot process, the user can switch between the graphical theme
and the detailed boot output using the Escape key.
.SH AUTHORS
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.
.SH SEE ALSO
.BR plymouth (1),
.BR plymouth-set-default-theme (1),
.BR grub (8),
.BR plymouthd (8),
.UR http://www.freedesktop.org/wiki/Software/Plymouth
.UE

86
docs/plymouth.xml
View file

@ -1,86 +0,0 @@
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<refentry id="plymouth">
<refentryinfo>
<title>plymouth</title>
<productname>plymouth</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Kristian</firstname>
<surname>Høgsberg</surname>
</author>
<author>
<contrib>Developer</contrib>
<firstname>Ray</firstname>
<surname>Strode</surname>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>plymouth</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="manual">System Administration</refmiscinfo>
</refmeta>
<refnamediv>
<refname>plymouth</refname>
<refpurpose>A graphical boot system and logger</refpurpose>
</refnamediv>
<refsect1>
<title>Description</title>
<para>
<command>plymouth</command> is 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
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 pro‐
vide feedback during boot.
</para>
<para>
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.
Without this command line option, plymouth will default to showing
detailed boot output.
</para>
<para>
During the boot process, the user can switch between the graphical theme
and the detailed boot output using the Escape key.
</para>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>grub</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>plymouth-set-default-theme</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<citerefentry><refentrytitle>plymouthd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<ulink url="http://www.freedesktop.org/wiki/Software/Plymouth">http://www.freedesktop.org/wiki/Software/Plymouth</ulink>
</para>
</refsect1>
<refsect1>
<title>Authors</title>
<para>
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.
</para>
</refsect1>
</refentry>

351
docs/plymouth1.xml
View file

@ -1,351 +0,0 @@
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<refentry id="plymouth-set-default-theme">
<refentryinfo>
<title>plymouth</title>
<productname>plymouth</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Kristian</firstname>
<surname>Høgsberg</surname>
</author>
<author>
<contrib>Developer</contrib>
<firstname>Ray</firstname>
<surname>Strode</surname>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>plymouth</refentrytitle>
<manvolnum>1</manvolnum>
<refmiscinfo class="manual">User Commands</refmiscinfo>
</refmeta>
<refnamediv>
<refname>plymouth</refname>
<refpurpose>Send commands to plymouthd</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>plymouth <arg choice="opt" rep="repeat">OPTION</arg></command>
</cmdsynopsis>
<cmdsynopsis>
<command>plymouth <arg choice="plain">COMMAND <arg choice="opt" rep="repeat">OPTION</arg></arg></command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
The <command>plymouth</command> sends commands to a running
<command>plymouthd</command>. This is used during the boot
process to control the display of the graphical boot splash.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>
The following options are understood. These options are supported
for compatibility with the old <command>rhgb-client</command> interface,
and have been replaced by the commands that are described in the
next section.
</para>
<variablelist>
<varlistentry>
<term><option>--help</option></term>
<listitem><para>Show summary of options.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--debug</option></term>
<listitem><para>Enable verbose debug logging.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--get-splash-plugin-path</option></term>
<listitem><para>Get directory where splash plugins are installed.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--newroot=<arg>STRING</arg></option></term>
<listitem><para>Tell plymouthd that the new root filesystem is mounted.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--quit</option></term>
<listitem><para>Tell plymouthd to quit.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--ping</option></term>
<listitem><para>Check if plymouthd is running.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--has-active-vt</option></term>
<listitem><para>Check if plymouthd has an active vt.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--sysinit</option></term>
<listitem><para>Tell plymouthd root filesystem is mounted read-write.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--show-splash</option></term>
<listitem><para>Show the splash screen.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--hide-splash</option></term>
<listitem><para>Hide the splash screen.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--ask-for-password</option></term>
<listitem><para>Ask the user for a password.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--ignore-keystroke=<arg>STRING</arg></option></term>
<listitem><para>Remove sensitivity to a keystroke.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--update=<arg>STRING</arg></option></term>
<listitem><para>Tell plymouthd an update about boot progress.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--details</option></term>
<listitem><para>Tell plymouthd there were errors during boot.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--wait</option></term>
<listitem><para>Wait for plymouthd to quit.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>Commands</title>
<para>
The following commands are understood:
</para>
<variablelist>
<varlistentry>
<term><command>change-mode <arg choice="plain">OPTION</arg></command></term>
<listitem><para>Change the operation mode.</para>
<variablelist>
<varlistentry>
<term><option>--boot-up</option></term>
<listitem><para>Start the system up</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--shutdown</option></term>
<listitem><para>Shutting the system up</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--updates</option></term>
<listitem><para>Applying updates</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>system-update <arg choice="plain">OPTION</arg></command></term>
<listitem><para>Tell plymouthd about boot progress.</para>
<variablelist>
<varlistentry>
<term><option>--progress=INTEGER</option></term>
<listitem><para>The percentage progress of the updates</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>update <arg choice="plain">OPTION</arg></command></term>
<listitem><para>Tell plymouthd about boot status changes.</para>
<variablelist>
<varlistentry>
<term><option>--status=STRING</option></term>
<listitem><para>Tell plymouthd the current boot status</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>update-root-fs <arg choice="plain">OPTION</arg></command></term>
<listitem><para>Tell plymouthd about root filesystem changes.</para>
<variablelist>
<varlistentry>
<term><option>--new-root-dir=STRING</option></term>
<listitem><para>Root filesystem is about to change</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--read-write</option></term>
<listitem><para>Root filesystem is no longer read-only</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>show-splash</command></term>
<listitem><para>Tell plymouthd to show splash screen.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>hide-splash</command></term>
<listitem><para>Tell plymouthd to hide splash screen.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>ask-for-password <arg choice="plain">OPTION</arg></command></term>
<listitem><para>Ask the user for a password.</para>
<variablelist>
<varlistentry>
<term><option>--command=STRING</option></term>
<listitem><para>Command to send password to via standard input</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--prompt=STRING</option></term>
<listitem><para>Message to display when asking for password</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--number-of-tries=INTEGER</option></term>
<listitem><para>Number of times to ask before giving up (requires <option>--command</option>)</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--dont-pause-progress</option></term>
<listitem><para>Don't pause boot progress bar while asking</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>ask-question</command></term>
<listitem><para>Ask the user a question.</para>
<variablelist>
<varlistentry>
<term><option>--command=STRING</option></term>
<listitem><para>Command to send the answer to via standard input</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--prompt=STRING</option></term>
<listitem><para>Message to display when asking the question</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--dont-pause-progress</option></term>
<listitem><para>Don't pause boot progress bar while asking</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>display-message <arg choice="plain">OPTION</arg></command></term>
<listitem><para>Display a message.</para>
<variablelist>
<varlistentry>
<term><option>--text=STRING</option></term>
<listitem><para>The message text</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>hide-message <arg choice="plain">OPTION</arg></command></term>
<listitem><para>Hide a message.</para>
<variablelist>
<varlistentry>
<term><option>--text=STRING</option></term>
<listitem><para>The message text</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>watch-keystroke <arg choice="plain">OPTION</arg></command></term>
<listitem><para>Become sensitive to a keystroke.</para>
<variablelist>
<varlistentry>
<term><option>--command=STRING</option></term>
<listitem><para>Command to send keystroke to via standard input</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--keys=STRING</option></term>
<listitem><para>Keys to become sensitive to</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>ignore-keystroke <arg choice="plain">OPTION</arg></command></term>
<listitem><para>Remove sensitivity to a keystroke.</para>
<variablelist>
<varlistentry>
<term><option>--keys=STRING</option></term>
<listitem><para>Keys to remove sensitivity from</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
<varlistentry>
<term><command>pause-progress</command></term>
<listitem><para>Pause boot progress bar.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>unpause-progress</command></term>
<listitem><para>Unpause boot progress bar.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>report-error</command></term>
<listitem><para>Tell plymouthd there were errors during boot.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>deactivate</command></term>
<listitem><para>Tell plymouthd to deactivate.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>reactivate</command></term>
<listitem><para>Tell plymouthd to reactivate.</para></listitem>
</varlistentry>
<varlistentry>
<term><command>quit <arg choice="plain">OPTION</arg></command></term>
<listitem><para>Tell plymouthd to quit.</para>
<variablelist>
<varlistentry>
<term><option>--retain-splash</option></term>
<listitem><para>Don't explicitly hide boot splash on exit</para></listitem>
</varlistentry>
</variablelist>
</listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>grub</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>plymouthd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<ulink url="http://www.freedesktop.org/wiki/Software/Plymouth">http://www.freedesktop.org/wiki/Software/Plymouth</ulink>
</para>
</refsect1>
</refentry>

64
docs/plymouthd.8.in Normal file
View file

@ -0,0 +1,64 @@
.TH plymouthd 8 "2025-08-25" @version@
.SH NAME
plymouthd \- The plymouthd daemon
.SH SYNOPSIS
.SY plymouthd
.RI [ option ]\.\.\.
.YS
.SH DESCRIPTION
The
.B plymouthd
daemon is usually run out of the initrd. It does the heavy lifting of the
plymouth system, logging the session and showing the splash screen.
.P
The
.BR plymouth (1)
command is used to send commands to plymouthd that control its behaviour.
.SH OPTIONS
The following options are understood:
.TP
.B \-\-help
Show summary of options.
.TP
.B \-\-attach\-to\-session
Redirect console messages from screen to log.
.TP
.B \-\-no\-daemon
Do not daemonize.
.TP
.B \-\-debug
Output debugging information.
.TP
.BI \-\-debug\-file= string
File to output debugging information to.
.TP
.BI \-\-mode= string
mode is one of boot, shutdown, reboot, updates, system-upgrade, firmware-upgrade and system-reset.
.TP
.BI \-\-pid-file= string
Write the pid of the daemon to a file.
.TP
.BI \-\-kernel-command-line= string
Fake kernel command line to use.
.TP
.BI \-\-tty= string
TTY to use instead of default.
.TP
.B \-\-no\-boot\-log
Do not write boot log file.
.TP
.B \-\-ignore\-serial\-consoles
Ignore serial consoles.
.TP
.B \-\-graphical\-boot
Use graphical splashes even if the kernel console is not a VT.
.SH SEE ALSO
.BR plymouth (1),
.BR grub (8),
.BR plymouth (8),
.UR http://www.freedesktop.org/wiki/Software/Plymouth
.UE

121
docs/plymouthd.xml
View file

@ -1,121 +0,0 @@
<?xml version='1.0'?>
<!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
"http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
<refentry id="plymouthd">
<refentryinfo>
<title>plymouthd</title>
<productname>plymouth</productname>
<authorgroup>
<author>
<contrib>Developer</contrib>
<firstname>Kristian</firstname>
<surname>Høgsberg</surname>
</author>
<author>
<contrib>Developer</contrib>
<firstname>Ray</firstname>
<surname>Strode</surname>
</author>
</authorgroup>
</refentryinfo>
<refmeta>
<refentrytitle>plymouthd</refentrytitle>
<manvolnum>8</manvolnum>
<refmiscinfo class="manual">System Administration</refmiscinfo>
</refmeta>
<refnamediv>
<refname>plymouthd</refname>
<refpurpose>The plymouth daemon</refpurpose>
</refnamediv>
<refsynopsisdiv>
<cmdsynopsis>
<command>plymouthd <arg choice="opt" rep="repeat">OPTION</arg></command>
</cmdsynopsis>
</refsynopsisdiv>
<refsect1>
<title>Description</title>
<para>
The <command>plymouthd</command> daemon is usually run out of
the initrd. It does the heavy lifting of the plymouth system, logging
the session and showing the splash screen.
</para>
<para>
The <command>plymouth</command> is used to send commands to plymouthd
that control its behaviour.
</para>
</refsect1>
<refsect1>
<title>Options</title>
<para>The following options are understood:</para>
<variablelist>
<varlistentry>
<term><option>--help</option></term>
<listitem><para>Show summary of options.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--attach-to-session</option></term>
<listitem><para>Redirect console messages from screen to log.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--no-daemon</option></term>
<listitem><para>Do not daemonize.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--debug</option></term>
<listitem><para>Output debugging information.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--debug-file=STRING</option></term>
<listitem><para>File to write debugging information to.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--mode=MODE</option></term>
<listitem><para>Set mode to either boot or shutdown.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--pid-file=STRING</option></term>
<listitem><para>Write the PID of the daemon to a file.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--kernel-command-line=STRING</option></term>
<listitem><para>Fake kernel commandline to use.</para></listitem>
</varlistentry>
<varlistentry>
<term><option>--tty=STRING</option></term>
<listitem><para>TTY to use instead of default.</para></listitem>
</varlistentry>
</variablelist>
</refsect1>
<refsect1>
<title>See Also</title>
<para>
<citerefentry><refentrytitle>grub</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
<citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>1</manvolnum></citerefentry>,
<ulink url="http://www.freedesktop.org/wiki/Software/Plymouth">http://www.freedesktop.org/wiki/Software/Plymouth</ulink>
</para>
</refsect1>
</refentry>