diff --git a/docs/meson.build b/docs/meson.build index ab746e84..1fc1d624 100644 --- a/docs/meson.build +++ b/docs/meson.build @@ -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 diff --git a/docs/plymouth-set-default-theme.1.in b/docs/plymouth-set-default-theme.1.in new file mode 100644 index 00000000..848f1616 --- /dev/null +++ b/docs/plymouth-set-default-theme.1.in @@ -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 + diff --git a/docs/plymouth-set-default-theme.xml b/docs/plymouth-set-default-theme.xml deleted file mode 100644 index efb051eb..00000000 --- a/docs/plymouth-set-default-theme.xml +++ /dev/null @@ -1,103 +0,0 @@ - - - - - - - plymouth-set-default-theme - plymouth - - - - Developer - Kristian - Høgsberg - - - Developer - Ray - Strode - - - - - - - plymouth-set-default-theme - 1 - User Commands - - - - plymouth-set-default-theme - Set the plymouth theme - - - - - plymouth-set-default-theme OPTION THEME - - - - - Description - - -When called with a argument, -the 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. - - - -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. - - - - - - Options - - The following options are understood: - - - - , - Show summary of options. - - - - , - List available themes. - - - - , - Reset to default theme. - - - - , - Rebuild initrd (necessary after changing theme). - - - - - - See Also - - grub8, - plymouth8, - plymouthd8, - plymouth1, - http://www.freedesktop.org/wiki/Software/Plymouth - - - - diff --git a/docs/plymouth.1.in b/docs/plymouth.1.in new file mode 100644 index 00000000..7900254a --- /dev/null +++ b/docs/plymouth.1.in @@ -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 diff --git a/docs/plymouth.8.in b/docs/plymouth.8.in new file mode 100644 index 00000000..761d6cb5 --- /dev/null +++ b/docs/plymouth.8.in @@ -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 diff --git a/docs/plymouth.xml b/docs/plymouth.xml deleted file mode 100644 index 2bc7099d..00000000 --- a/docs/plymouth.xml +++ /dev/null @@ -1,86 +0,0 @@ - - - - - - - plymouth - plymouth - - - - Developer - Kristian - Høgsberg - - - Developer - Ray - Strode - - - - - - - plymouth - 8 - System Administration - - - - plymouth - A graphical boot system and logger - - - - Description - - -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 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. - - -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. - - - -During the boot process, the user can switch between the graphical theme -and the detailed boot output using the Escape key. - - - - - - See Also - - grub8, - plymouth-set-default-theme1, - plymouthd8, - plymouth1, - http://www.freedesktop.org/wiki/Software/Plymouth - - - - - 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. - - - diff --git a/docs/plymouth1.xml b/docs/plymouth1.xml deleted file mode 100644 index c63fcc7e..00000000 --- a/docs/plymouth1.xml +++ /dev/null @@ -1,351 +0,0 @@ - - - - - - - plymouth - plymouth - - - - Developer - Kristian - Høgsberg - - - Developer - Ray - Strode - - - - - - - plymouth - 1 - User Commands - - - - plymouth - Send commands to plymouthd - - - - - plymouth OPTION - - - plymouth COMMAND OPTION - - - - - Description - - -The plymouth sends commands to a running -plymouthd. This is used during the boot -process to control the display of the graphical boot splash. - - - - - - Options - - -The following options are understood. These options are supported -for compatibility with the old rhgb-client interface, -and have been replaced by the commands that are described in the -next section. - - - - - - Show summary of options. - - - - - Enable verbose debug logging. - - - - - Get directory where splash plugins are installed. - - - - - Tell plymouthd that the new root filesystem is mounted. - - - - - Tell plymouthd to quit. - - - - - Check if plymouthd is running. - - - - - Check if plymouthd has an active vt. - - - - - Tell plymouthd root filesystem is mounted read-write. - - - - - Show the splash screen. - - - - - Hide the splash screen. - - - - - Ask the user for a password. - - - - - Remove sensitivity to a keystroke. - - - - - Tell plymouthd an update about boot progress. - - - - - Tell plymouthd there were errors during boot. - - - - - Wait for plymouthd to quit. - - - - - - Commands - - -The following commands are understood: - - - - change-mode OPTION - Change the operation mode. - - - - Start the system up - - - - Shutting the system up - - - - Applying updates - - - - - - system-update OPTION - Tell plymouthd about boot progress. - - - - The percentage progress of the updates - - - - - - update OPTION - Tell plymouthd about boot status changes. - - - - Tell plymouthd the current boot status - - - - - - update-root-fs OPTION - Tell plymouthd about root filesystem changes. - - - - Root filesystem is about to change - - - - 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 to send password to via standard input - - - - Message to display when asking for password - - - - Number of times to ask before giving up (requires ) - - - - Don't pause boot progress bar while asking - - - - - - ask-question - Ask the user a question. - - - - Command to send the answer to via standard input - - - - Message to display when asking the question - - - - Don't pause boot progress bar while asking - - - - - - display-message OPTION - Display a message. - - - - The message text - - - - - - hide-message OPTION - Hide a message. - - - - The message text - - - - - - watch-keystroke OPTION - Become sensitive to a keystroke. - - - - Command to send keystroke to via standard input - - - - Keys to become sensitive to - - - - - - ignore-keystroke OPTION - Remove sensitivity to a keystroke. - - - - 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. - - - - Don't explicitly hide boot splash on exit - - - - - - - - - - See Also - - grub8, - plymouth8, - plymouthd8, - http://www.freedesktop.org/wiki/Software/Plymouth - - - - diff --git a/docs/plymouthd.8.in b/docs/plymouthd.8.in new file mode 100644 index 00000000..3f3e80fe --- /dev/null +++ b/docs/plymouthd.8.in @@ -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 diff --git a/docs/plymouthd.xml b/docs/plymouthd.xml deleted file mode 100644 index 1b6e0067..00000000 --- a/docs/plymouthd.xml +++ /dev/null @@ -1,121 +0,0 @@ - - - - - - - plymouthd - plymouth - - - - Developer - Kristian - Høgsberg - - - Developer - Ray - Strode - - - - - - - plymouthd - 8 - System Administration - - - - plymouthd - The plymouth daemon - - - - - plymouthd OPTION - - - - - Description - - -The 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. - - -The plymouth is used to send commands to plymouthd -that control its behaviour. - - - - - - Options - - The following options are understood: - - - - - Show summary of options. - - - - - Redirect console messages from screen to log. - - - - - Do not daemonize. - - - - - Output debugging information. - - - - - File to write debugging information to. - - - - - Set mode to either boot or shutdown. - - - - - Write the PID of the daemon to a file. - - - - - Fake kernel commandline to use. - - - - - TTY to use instead of default. - - - - - - See Also - - grub8, - plymouth8, - plymouth1, - http://www.freedesktop.org/wiki/Software/Plymouth - - - -