plymouth/docs/plymouth-set-default-theme.xml
Matthias Clasen efc285dab8 docs: add docbook based man pages
This commit adds man pages for the plymouthd and plymouth client
commands.
2013-10-21 17:56:45 -04:00

103 lines
4.2 KiB
XML

<?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>