You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

plymouth1.xml 15 KiB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351
  1. <?xml version='1.0'?>
  2. <!DOCTYPE refentry PUBLIC "-//OASIS//DTD DocBook XML V4.2//EN"
  3. "http://www.oasis-open.org/docbook/xml/4.2/docbookx.dtd">
  4. <refentry id="plymouth-set-default-theme">
  5. <refentryinfo>
  6. <title>plymouth</title>
  7. <productname>plymouth</productname>
  8. <authorgroup>
  9. <author>
  10. <contrib>Developer</contrib>
  11. <firstname>Kristian</firstname>
  12. <surname>Høgsberg</surname>
  13. </author>
  14. <author>
  15. <contrib>Developer</contrib>
  16. <firstname>Ray</firstname>
  17. <surname>Strode</surname>
  18. </author>
  19. </authorgroup>
  20. </refentryinfo>
  21. <refmeta>
  22. <refentrytitle>plymouth</refentrytitle>
  23. <manvolnum>1</manvolnum>
  24. <refmiscinfo class="manual">User Commands</refmiscinfo>
  25. </refmeta>
  26. <refnamediv>
  27. <refname>plymouth</refname>
  28. <refpurpose>Send commands to plymouthd</refpurpose>
  29. </refnamediv>
  30. <refsynopsisdiv>
  31. <cmdsynopsis>
  32. <command>plymouth <arg choice="opt" rep="repeat">OPTION</arg></command>
  33. </cmdsynopsis>
  34. <cmdsynopsis>
  35. <command>plymouth <arg choice="plain">COMMAND <arg choice="opt" rep="repeat">OPTION</arg></arg></command>
  36. </cmdsynopsis>
  37. </refsynopsisdiv>
  38. <refsect1>
  39. <title>Description</title>
  40. <para>
  41. The <command>plymouth</command> sends commands to a running
  42. <command>plymouthd</command>. This is used during the boot
  43. process to control the display of the graphical boot splash.
  44. </para>
  45. </refsect1>
  46. <refsect1>
  47. <title>Options</title>
  48. <para>
  49. The following options are understood. These options are supported
  50. for compatibility with the old <command>rhgb-client</command> interface,
  51. and have been replaced by the commands that are described in the
  52. next section.
  53. </para>
  54. <variablelist>
  55. <varlistentry>
  56. <term><option>--help</option></term>
  57. <listitem><para>Show summary of options.</para></listitem>
  58. </varlistentry>
  59. <varlistentry>
  60. <term><option>--debug</option></term>
  61. <listitem><para>Enable verbose debug logging.</para></listitem>
  62. </varlistentry>
  63. <varlistentry>
  64. <term><option>--get-splash-plugin-path</option></term>
  65. <listitem><para>Get directory where splash plugins are installed.</para></listitem>
  66. </varlistentry>
  67. <varlistentry>
  68. <term><option>--newroot=<arg>STRING</arg></option></term>
  69. <listitem><para>Tell plymouthd that the new root filesystem is mounted.</para></listitem>
  70. </varlistentry>
  71. <varlistentry>
  72. <term><option>--quit</option></term>
  73. <listitem><para>Tell plymouthd to quit.</para></listitem>
  74. </varlistentry>
  75. <varlistentry>
  76. <term><option>--ping</option></term>
  77. <listitem><para>Check if plymouthd is running.</para></listitem>
  78. </varlistentry>
  79. <varlistentry>
  80. <term><option>--has-active-vt</option></term>
  81. <listitem><para>Check if plymouthd has an active vt.</para></listitem>
  82. </varlistentry>
  83. <varlistentry>
  84. <term><option>--sysinit</option></term>
  85. <listitem><para>Tell plymouthd root filesystem is mounted read-write.</para></listitem>
  86. </varlistentry>
  87. <varlistentry>
  88. <term><option>--show-splash</option></term>
  89. <listitem><para>Show the splash screen.</para></listitem>
  90. </varlistentry>
  91. <varlistentry>
  92. <term><option>--hide-splash</option></term>
  93. <listitem><para>Hide the splash screen.</para></listitem>
  94. </varlistentry>
  95. <varlistentry>
  96. <term><option>--ask-for-password</option></term>
  97. <listitem><para>Ask the user for a password.</para></listitem>
  98. </varlistentry>
  99. <varlistentry>
  100. <term><option>--ignore-keystroke=<arg>STRING</arg></option></term>
  101. <listitem><para>Remove sensitivity to a keystroke.</para></listitem>
  102. </varlistentry>
  103. <varlistentry>
  104. <term><option>--update=<arg>STRING</arg></option></term>
  105. <listitem><para>Tell plymouthd an update about boot progress.</para></listitem>
  106. </varlistentry>
  107. <varlistentry>
  108. <term><option>--details</option></term>
  109. <listitem><para>Tell plymouthd there were errors during boot.</para></listitem>
  110. </varlistentry>
  111. <varlistentry>
  112. <term><option>--wait</option></term>
  113. <listitem><para>Wait for plymouthd to quit.</para></listitem>
  114. </varlistentry>
  115. </variablelist>
  116. </refsect1>
  117. <refsect1>
  118. <title>Commands</title>
  119. <para>
  120. The following commands are understood:
  121. </para>
  122. <variablelist>
  123. <varlistentry>
  124. <term><command>change-mode <arg choice="plain">OPTION</arg></command></term>
  125. <listitem><para>Change the operation mode.</para>
  126. <variablelist>
  127. <varlistentry>
  128. <term><option>--boot-up</option></term>
  129. <listitem><para>Start the system up</para></listitem>
  130. </varlistentry>
  131. <varlistentry>
  132. <term><option>--shutdown</option></term>
  133. <listitem><para>Shutting the system up</para></listitem>
  134. </varlistentry>
  135. <varlistentry>
  136. <term><option>--updates</option></term>
  137. <listitem><para>Applying updates</para></listitem>
  138. </varlistentry>
  139. </variablelist>
  140. </listitem>
  141. </varlistentry>
  142. <varlistentry>
  143. <term><command>system-update <arg choice="plain">OPTION</arg></command></term>
  144. <listitem><para>Tell plymouthd about boot progress.</para>
  145. <variablelist>
  146. <varlistentry>
  147. <term><option>--progress=INTEGER</option></term>
  148. <listitem><para>The percentage progress of the updates</para></listitem>
  149. </varlistentry>
  150. </variablelist>
  151. </listitem>
  152. </varlistentry>
  153. <varlistentry>
  154. <term><command>update <arg choice="plain">OPTION</arg></command></term>
  155. <listitem><para>Tell plymouthd about boot status changes.</para>
  156. <variablelist>
  157. <varlistentry>
  158. <term><option>--status=STRING</option></term>
  159. <listitem><para>Tell plymouthd the current boot status</para></listitem>
  160. </varlistentry>
  161. </variablelist>
  162. </listitem>
  163. </varlistentry>
  164. <varlistentry>
  165. <term><command>update-root-fs <arg choice="plain">OPTION</arg></command></term>
  166. <listitem><para>Tell plymouthd about root filesystem changes.</para>
  167. <variablelist>
  168. <varlistentry>
  169. <term><option>--new-root-dir=STRING</option></term>
  170. <listitem><para>Root filesystem is about to change</para></listitem>
  171. </varlistentry>
  172. <varlistentry>
  173. <term><option>--read-write</option></term>
  174. <listitem><para>Root filesystem is no longer read-only</para></listitem>
  175. </varlistentry>
  176. </variablelist>
  177. </listitem>
  178. </varlistentry>
  179. <varlistentry>
  180. <term><command>show-splash</command></term>
  181. <listitem><para>Tell plymouthd to show splash screen.</para></listitem>
  182. </varlistentry>
  183. <varlistentry>
  184. <term><command>hide-splash</command></term>
  185. <listitem><para>Tell plymouthd to hide splash screen.</para></listitem>
  186. </varlistentry>
  187. <varlistentry>
  188. <term><command>ask-for-password <arg choice="plain">OPTION</arg></command></term>
  189. <listitem><para>Ask the user for a password.</para>
  190. <variablelist>
  191. <varlistentry>
  192. <term><option>--command=STRING</option></term>
  193. <listitem><para>Command to send password to via standard input</para></listitem>
  194. </varlistentry>
  195. <varlistentry>
  196. <term><option>--prompt=STRING</option></term>
  197. <listitem><para>Message to display when asking for password</para></listitem>
  198. </varlistentry>
  199. <varlistentry>
  200. <term><option>--number-of-tries=INTEGER</option></term>
  201. <listitem><para>Number of times to ask before giving up (requires <option>--command</option>)</para></listitem>
  202. </varlistentry>
  203. <varlistentry>
  204. <term><option>--dont-pause-progress</option></term>
  205. <listitem><para>Don't pause boot progress bar while asking</para></listitem>
  206. </varlistentry>
  207. </variablelist>
  208. </listitem>
  209. </varlistentry>
  210. <varlistentry>
  211. <term><command>ask-question</command></term>
  212. <listitem><para>Ask the user a question.</para>
  213. <variablelist>
  214. <varlistentry>
  215. <term><option>--command=STRING</option></term>
  216. <listitem><para>Command to send the answer to via standard input</para></listitem>
  217. </varlistentry>
  218. <varlistentry>
  219. <term><option>--prompt=STRING</option></term>
  220. <listitem><para>Message to display when asking the question</para></listitem>
  221. </varlistentry>
  222. <varlistentry>
  223. <term><option>--dont-pause-progress</option></term>
  224. <listitem><para>Don't pause boot progress bar while asking</para></listitem>
  225. </varlistentry>
  226. </variablelist>
  227. </listitem>
  228. </varlistentry>
  229. <varlistentry>
  230. <term><command>display-message <arg choice="plain">OPTION</arg></command></term>
  231. <listitem><para>Display a message.</para>
  232. <variablelist>
  233. <varlistentry>
  234. <term><option>--text=STRING</option></term>
  235. <listitem><para>The message text</para></listitem>
  236. </varlistentry>
  237. </variablelist>
  238. </listitem>
  239. </varlistentry>
  240. <varlistentry>
  241. <term><command>hide-message <arg choice="plain">OPTION</arg></command></term>
  242. <listitem><para>Hide a message.</para>
  243. <variablelist>
  244. <varlistentry>
  245. <term><option>--text=STRING</option></term>
  246. <listitem><para>The message text</para></listitem>
  247. </varlistentry>
  248. </variablelist>
  249. </listitem>
  250. </varlistentry>
  251. <varlistentry>
  252. <term><command>watch-keystroke <arg choice="plain">OPTION</arg></command></term>
  253. <listitem><para>Become sensitive to a keystroke.</para>
  254. <variablelist>
  255. <varlistentry>
  256. <term><option>--command=STRING</option></term>
  257. <listitem><para>Command to send keystroke to via standard input</para></listitem>
  258. </varlistentry>
  259. <varlistentry>
  260. <term><option>--keys=STRING</option></term>
  261. <listitem><para>Keys to become sensitive to</para></listitem>
  262. </varlistentry>
  263. </variablelist>
  264. </listitem>
  265. </varlistentry>
  266. <varlistentry>
  267. <term><command>ignore-keystroke <arg choice="plain">OPTION</arg></command></term>
  268. <listitem><para>Remove sensitivity to a keystroke.</para>
  269. <variablelist>
  270. <varlistentry>
  271. <term><option>--keys=STRING</option></term>
  272. <listitem><para>Keys to remove sensitivity from</para></listitem>
  273. </varlistentry>
  274. </variablelist>
  275. </listitem>
  276. </varlistentry>
  277. <varlistentry>
  278. <term><command>pause-progress</command></term>
  279. <listitem><para>Pause boot progress bar.</para></listitem>
  280. </varlistentry>
  281. <varlistentry>
  282. <term><command>unpause-progress</command></term>
  283. <listitem><para>Unpause boot progress bar.</para></listitem>
  284. </varlistentry>
  285. <varlistentry>
  286. <term><command>report-error</command></term>
  287. <listitem><para>Tell plymouthd there were errors during boot.</para></listitem>
  288. </varlistentry>
  289. <varlistentry>
  290. <term><command>deactivate</command></term>
  291. <listitem><para>Tell plymouthd to deactivate.</para></listitem>
  292. </varlistentry>
  293. <varlistentry>
  294. <term><command>reactivate</command></term>
  295. <listitem><para>Tell plymouthd to reactivate.</para></listitem>
  296. </varlistentry>
  297. <varlistentry>
  298. <term><command>quit <arg choice="plain">OPTION</arg></command></term>
  299. <listitem><para>Tell plymouthd to quit.</para>
  300. <variablelist>
  301. <varlistentry>
  302. <term><option>--retain-splash</option></term>
  303. <listitem><para>Don't explicitly hide boot splash on exit</para></listitem>
  304. </varlistentry>
  305. </variablelist>
  306. </listitem>
  307. </varlistentry>
  308. </variablelist>
  309. </refsect1>
  310. <refsect1>
  311. <title>See Also</title>
  312. <para>
  313. <citerefentry><refentrytitle>grub</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  314. <citerefentry><refentrytitle>plymouth</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  315. <citerefentry><refentrytitle>plymouthd</refentrytitle><manvolnum>8</manvolnum></citerefentry>,
  316. <ulink url="http://www.freedesktop.org/wiki/Software/Plymouth">http://www.freedesktop.org/wiki/Software/Plymouth</ulink>
  317. </para>
  318. </refsect1>
  319. </refentry>