man-pages/man1/plymouth.1.html
2021-03-31 01:06:50 +01:00

465 lines
7.1 KiB
HTML

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN">
<HTML><HEAD><TITLE>Man page of PLYMOUTH</TITLE>
</HEAD><BODY>
<H1>PLYMOUTH</H1>
Section: User Commands (1)<BR>Updated: <BR><A HREF="#index">Index</A>
<A HREF="/cgi-bin/man/man2html">Return to Main Contents</A><HR>
<A NAME="lbAB">&nbsp;</A>
<H2>NAME</H2>
plymouth - Send commands to plymouthd
<A NAME="lbAC">&nbsp;</A>
<H2>SYNOPSIS</H2>
<DL COMPACT>
<DT id="1">
<B>plymouth </B><B>[OPTION...]</B>
<DT id="2">
<B>plymouth </B><B>COMMAND&nbsp;[OPTION...] </B>
</DL>
<A NAME="lbAD">&nbsp;</A>
<H2>DESCRIPTION</H2>
<P>
<DD>The
<B>plymouth</B>
sends commands to a running
<B>plymouthd</B>. This is used during the boot process to control the display of the graphical boot splash.
<A NAME="lbAE">&nbsp;</A>
<H2>OPTIONS</H2>
<P>
The following options are understood. These options are supported for compatibility with the old
<B>rhgb-client</B>
interface, and have been replaced by the commands that are described in the next section.
<P>
<B>--help</B>
<DL COMPACT><DT id="3"><DD>
Show summary of options.
</DL>
<P>
<B>--debug</B>
<DL COMPACT><DT id="4"><DD>
Enable verbose debug logging.
</DL>
<P>
<B>--get-splash-plugin-path</B>
<DL COMPACT><DT id="5"><DD>
Get directory where splash plugins are installed.
</DL>
<P>
<B>--newroot=</B><B>[STRING]</B>
<DL COMPACT><DT id="6"><DD>
Tell plymouthd that the new root filesystem is mounted.
</DL>
<P>
<B>--quit</B>
<DL COMPACT><DT id="7"><DD>
Tell plymouthd to quit.
</DL>
<P>
<B>--ping</B>
<DL COMPACT><DT id="8"><DD>
Check if plymouthd is running.
</DL>
<P>
<B>--has-active-vt</B>
<DL COMPACT><DT id="9"><DD>
Check if plymouthd has an active vt.
</DL>
<P>
<B>--sysinit</B>
<DL COMPACT><DT id="10"><DD>
Tell plymouthd root filesystem is mounted read-write.
</DL>
<P>
<B>--show-splash</B>
<DL COMPACT><DT id="11"><DD>
Show the splash screen.
</DL>
<P>
<B>--hide-splash</B>
<DL COMPACT><DT id="12"><DD>
Hide the splash screen.
</DL>
<P>
<B>--ask-for-password</B>
<DL COMPACT><DT id="13"><DD>
Ask the user for a password.
</DL>
<P>
<B>--ignore-keystroke=</B><B>[STRING]</B>
<DL COMPACT><DT id="14"><DD>
Remove sensitivity to a keystroke.
</DL>
<P>
<B>--update=</B><B>[STRING]</B>
<DL COMPACT><DT id="15"><DD>
Tell plymouthd an update about boot progress.
</DL>
<P>
<B>--details</B>
<DL COMPACT><DT id="16"><DD>
Tell plymouthd there were errors during boot.
</DL>
<P>
<B>--wait</B>
<DL COMPACT><DT id="17"><DD>
Wait for plymouthd to quit.
</DL>
<A NAME="lbAF">&nbsp;</A>
<H2>COMMANDS</H2>
<P>
The following commands are understood:
<P>
<B>change-mode </B><B>OPTION</B>
<DL COMPACT><DT id="18"><DD>
Change the operation mode.
<P>
<B>--boot-up</B>
<DL COMPACT><DT id="19"><DD>
Start the system up
</DL>
<P>
<B>--shutdown</B>
<DL COMPACT><DT id="20"><DD>
Shutting the system up
</DL>
<P>
<B>--updates</B>
<DL COMPACT><DT id="21"><DD>
Applying updates
</DL>
</DL>
<P>
<B>system-update </B><B>OPTION</B>
<DL COMPACT><DT id="22"><DD>
Tell plymouthd about boot progress.
<P>
<B>--progress=INTEGER</B>
<DL COMPACT><DT id="23"><DD>
The percentage progress of the updates
</DL>
</DL>
<P>
<B>update </B><B>OPTION</B>
<DL COMPACT><DT id="24"><DD>
Tell plymouthd about boot status changes.
<P>
<B>--status=STRING</B>
<DL COMPACT><DT id="25"><DD>
Tell plymouthd the current boot status
</DL>
</DL>
<P>
<B>update-root-fs </B><B>OPTION</B>
<DL COMPACT><DT id="26"><DD>
Tell plymouthd about root filesystem changes.
<P>
<B>--new-root-dir=STRING</B>
<DL COMPACT><DT id="27"><DD>
Root filesystem is about to change
</DL>
<P>
<B>--read-write</B>
<DL COMPACT><DT id="28"><DD>
Root filesystem is no longer read-only
</DL>
</DL>
<P>
<B>show-splash</B>
<DL COMPACT><DT id="29"><DD>
Tell plymouthd to show splash screen.
</DL>
<P>
<B>hide-splash</B>
<DL COMPACT><DT id="30"><DD>
Tell plymouthd to hide splash screen.
</DL>
<P>
<B>ask-for-password </B><B>OPTION</B>
<DL COMPACT><DT id="31"><DD>
Ask the user for a password.
<P>
<B>--command=STRING</B>
<DL COMPACT><DT id="32"><DD>
Command to send password to via standard input
</DL>
<P>
<B>--prompt=STRING</B>
<DL COMPACT><DT id="33"><DD>
Message to display when asking for password
</DL>
<P>
<B>--number-of-tries=INTEGER</B>
<DL COMPACT><DT id="34"><DD>
Number of times to ask before giving up (requires
<B>--command</B>)
</DL>
<P>
<B>--dont-pause-progress</B>
<DL COMPACT><DT id="35"><DD>
Don't pause boot progress bar while asking
</DL>
</DL>
<P>
<B>ask-question</B>
<DL COMPACT><DT id="36"><DD>
Ask the user a question.
<P>
<B>--command=STRING</B>
<DL COMPACT><DT id="37"><DD>
Command to send the answer to via standard input
</DL>
<P>
<B>--prompt=STRING</B>
<DL COMPACT><DT id="38"><DD>
Message to display when asking the question
</DL>
<P>
<B>--dont-pause-progress</B>
<DL COMPACT><DT id="39"><DD>
Don't pause boot progress bar while asking
</DL>
</DL>
<P>
<B>display-message </B><B>OPTION</B>
<DL COMPACT><DT id="40"><DD>
Display a message.
<P>
<B>--text=STRING</B>
<DL COMPACT><DT id="41"><DD>
The message text
</DL>
</DL>
<P>
<B>hide-message </B><B>OPTION</B>
<DL COMPACT><DT id="42"><DD>
Hide a message.
<P>
<B>--text=STRING</B>
<DL COMPACT><DT id="43"><DD>
The message text
</DL>
</DL>
<P>
<B>watch-keystroke </B><B>OPTION</B>
<DL COMPACT><DT id="44"><DD>
Become sensitive to a keystroke.
<P>
<B>--command=STRING</B>
<DL COMPACT><DT id="45"><DD>
Command to send keystroke to via standard input
</DL>
<P>
<B>--keys=STRING</B>
<DL COMPACT><DT id="46"><DD>
Keys to become sensitive to
</DL>
</DL>
<P>
<B>ignore-keystroke </B><B>OPTION</B>
<DL COMPACT><DT id="47"><DD>
Remove sensitivity to a keystroke.
<P>
<B>--keys=STRING</B>
<DL COMPACT><DT id="48"><DD>
Keys to remove sensitivity from
</DL>
</DL>
<P>
<B>pause-progress</B>
<DL COMPACT><DT id="49"><DD>
Pause boot progress bar.
</DL>
<P>
<B>unpause-progress</B>
<DL COMPACT><DT id="50"><DD>
Unpause boot progress bar.
</DL>
<P>
<B>report-error</B>
<DL COMPACT><DT id="51"><DD>
Tell plymouthd there were errors during boot.
</DL>
<P>
<B>deactivate</B>
<DL COMPACT><DT id="52"><DD>
Tell plymouthd to deactivate.
</DL>
<P>
<B>reactivate</B>
<DL COMPACT><DT id="53"><DD>
Tell plymouthd to reactivate.
</DL>
<P>
<B>quit </B><B>OPTION</B>
<DL COMPACT><DT id="54"><DD>
Tell plymouthd to quit.
<P>
<B>--retain-splash</B>
<DL COMPACT><DT id="55"><DD>
Don't explicitly hide boot splash on exit
</DL>
</DL>
<A NAME="lbAG">&nbsp;</A>
<H2>SEE ALSO</H2>
<P>
<B><A HREF="/cgi-bin/man/man2html?8+grub">grub</A></B>(8),
<B><A HREF="/cgi-bin/man/man2html?8+plymouth">plymouth</A></B>(8),
<B><A HREF="/cgi-bin/man/man2html?8+plymouthd">plymouthd</A></B>(8),
m[blue]<B><A HREF="http://www.freedesktop.org/wiki/Software/Plymouth">http://www.freedesktop.org/wiki/Software/Plymouth</A></B>m[]
<P>
<HR>
<A NAME="index">&nbsp;</A><H2>Index</H2>
<DL>
<DT id="56"><A HREF="#lbAB">NAME</A><DD>
<DT id="57"><A HREF="#lbAC">SYNOPSIS</A><DD>
<DT id="58"><A HREF="#lbAD">DESCRIPTION</A><DD>
<DT id="59"><A HREF="#lbAE">OPTIONS</A><DD>
<DT id="60"><A HREF="#lbAF">COMMANDS</A><DD>
<DT id="61"><A HREF="#lbAG">SEE ALSO</A><DD>
</DL>
<HR>
This document was created by
<A HREF="/cgi-bin/man/man2html">man2html</A>,
using the manual pages.<BR>
Time: 00:05:23 GMT, March 31, 2021
</BODY>
</HTML>