PLYMOUTH(1)

📦
version 26.134.222 · 16 versions
, in alpine 3.24

💅 PLYMOUTH(1) 💅

okay so bestie, welcome to the plymouth(1) page — that's the User Commands manual, and it's genuinely the little gremlin that talks to your boot splash 🎀

✨ NAME ✨

plymouth — literally just sends commands to plymouthd 🫶

🌸 SYNOPSIS 🌸

plymouth [OPTION...]

plymouth COMMAND [OPTION...]

🦋 DESCRIPTION 🦋

so the way that plymouth works is it sends commands to a running plymouthd ✨ and it's used during the boot process to control the display of the graphical boot splash. that's it, that's the whole vibe. it's the girl in the group chat relaying messages to the boot splash, and honestly? iconic 👑

💖 OPTIONS 💖

here's the tea ☕ — these options are understood, BUT (and this is important, ngl) they're supported for compatibility with the old rhgb-client interface, and they've been replaced by the commands described in the next section. so like... they still work, they're just a little vintage 🎀

  • --help — show summary of options 💜
  • --debug — enable verbose debug logging 🔥 (yes she WILL be loud about it)
  • --get-splash-plugin-path — get the directory where splash plugins are installed 🍓
  • --newroot=[STRING] — tell plymouthd that the new root filesystem is mounted 🌸
  • --quit — tell plymouthd to quit 💀
  • --ping — check if plymouthd is running 👀 (the vibe check, basically)
  • --has-active-vt — check if plymouthd has an active vt ✨
  • --sysinit — tell plymouthd root filesystem is mounted read-write 🦋
  • --show-splash — show the splash screen 🌈
  • --hide-splash — hide the splash screen 🙈
  • --ask-for-password — ask the user for a password 🔐
  • --ignore-keystroke=[STRING] — remove sensitivity to a keystroke 💅
  • --update=[STRING] — tell plymouthd an update about boot progress ⭐
  • --details — tell plymouthd there were errors during boot 😭
  • --wait — wait for plymouthd to quit 🧚

👑 COMMANDS 👑

these are the main characters, fr fr. the following commands are understood:

  • change-mode OPTION — change the operation mode ✨
    • --boot-up — start the system up 🌅
    • --shutdown — shutting the system up 💤
    • --updates — applying updates 🔄
  • system-update OPTION — tell plymouthd about boot progress 📊
    • --progress=INTEGER — the percentage progress of the updates 🔢
  • update OPTION — tell plymouthd about boot status changes 💫
    • --status=STRING — tell plymouthd the current boot status 📝
  • update-root-fs OPTION — tell plymouthd about root filesystem changes 🌳
    • --new-root-dir=STRING — root filesystem is about to change 🚨
    • --read-write — root filesystem is no longer read-only ✍️
  • show-splash — tell plymouthd to show splash screen 🌈
  • hide-splash — tell plymouthd to hide splash screen 🙈
  • ask-for-password OPTION — ask the user for a password 🔐
    • --command=STRING — command to send password to via standard input 📨
    • --prompt=STRING — message to display when asking for password 💬
    • --number-of-tries=INTEGER — number of times to ask before giving up (requires --command) ⏳
    • --dont-pause-progress — don't pause boot progress bar while asking ⏸️
  • ask-question — ask the user a question ❓
    • --command=STRING — command to send the answer to via standard input 📨
    • --prompt=STRING — message to display when asking the question 💬
    • --dont-pause-progress — don't pause boot progress bar while asking ⏸️
  • display-message OPTION — display a message 💌
    • --text=STRING — the message text 🗒️
  • hide-message OPTION — hide a message 🙈
    • --text=STRING — the message text 🗒️
  • watch-keystroke OPTION — become sensitive to a keystroke 👀
    • --command=STRING — command to send keystroke to via standard input 📨
    • --keys=STRING — keys to become sensitive to ⌨️
  • ignore-keystroke OPTION — remove sensitivity to a keystroke 💅
    • --keys=STRING — keys to remove sensitivity from ⌨️
  • pause-progress — pause boot progress bar ⏸️
  • unpause-progress — unpause boot progress bar ▶️
  • report-error — tell plymouthd there were errors during boot 😭
  • deactivate — tell plymouthd to deactivate 💤
  • reactivate — tell plymouthd to reactivate 🔥
  • quit OPTION — tell plymouthd to quit 👋
    • --retain-splash — don't explicitly hide boot splash on exit 🖼️
lowkey important reminder bestie: these commands talk to a running plymouthd, so if it's not running, nothing's happening. no cap 💀

🧚 SEE ALSO 🧚

grub(8), plymouth(8), plymouthd(8), http://www.freedesktop.org/wiki/Software/Plymouth 🦋

okay that's the whole page, you ate that 💅 and yeah — this page is plymouth, from PLYMOUTH(1), the manual for User Commands. go forth and splash responsibly, bestie 🫶💖✨

📦 where this page comes from