---
name: "usplash_write"
section: "8"
platform: "linux"
package: "usplash"
version: "0.5.19-3"
release: "Debian 5.0 (Lenny)"
platforms: ["linux"]
url: "https://new.carta.tech/usplash_write"
---

# usplash\_write(8)

send commands to a running usplash daemon

## NAME

usplash\_write - send commands to a running usplash daemon

## SYNOPSIS

**usplash\_write** *COMMAND*...

## DESCRIPTION

Sends the given commands to a running usplash daemon. If no daemon is running, **usplash\_write** returns without doing anything.

## COMMANDS

- **QUIT**

  Instructs the daemon to terminate, restoring the console that was previously active.

- **TIMEOUT** *secs*

  Changes the number of seconds to wait for a command before exiting to that given. If zero is given it will wait forever.

- **CLEAR**

  Clears any text currently displayed.

- **TEXT** *text*

  Displays the given text in the area on the screen reserved for that, scrolling any existing text up.

- **TEXT-URGENT** *text*

  Displays the given text in the same way as TEXT above even if messages would normally be hidden due to the verbosity setting in effect.

- **STATUS** *status*

  Displays the given status string to the right of the last line of text in the same colour.

- **SUCCESS** *status*

  Displays the given status string to the right of the last line of text in a colour used to indicate success.

- **FAILURE** *status*

  Displays the given status string to the right of the last line of text in a colour used to indicate failure.

- **PROGRESS** *percentage*

  Update the progress bar to show that the given percentage (0-100) of the process has been completed.

- **PULSATE**

  Set the progress bar to display a throbber (an indicator bouncing from left to right and back again).

- **INPUT** *prompt*

  Displays the given prompt and waits for one line of user input. The line can then be read from /dev/.initramfs/usplash\_outfifo within the timeout period.

- **INPUTQUIET** *prompt*

  Works in the same way as INPUT above with the exception that the user input is not echoed to the console. Useful for password prompts.

- **INPUTENTER** *prompt*

  Works in the same way as INPUT above with the exception that nothing is echoed to the console. Useful for "Press enter to reboot".

- **INPUTTIMEOUT** *timeout prompt*

  Works in the same way as INPUT above, but returns the empty string after the given number of deciseconds.

- **INPUTCHAR**

  Checks for a single pending key press and writes the character to /dev/.initramfs/usplash\_outfifo. If no key was pressed, this will be an empty string. Useful for polling for input (such as "Press ESC to skip") while doing something in the background (such as running fsck).

- **VERBOSE** *mode*

  Changes verbosity at runtime. Possible values for *mode* are **on** or **true** for verbose mode, **off** or **false** for quiet mode, or **default** for the default mode when usplash started.

## EXIT STATUS

**usplash\_write** always returns an exit status of zero by default.

However, if the environment variable **FAIL\_NO\_USPLASH** is set, then failure to open the usplash fifo (which usually means that usplash is not running) will exit with 1. This can be tested before reading something from the FIFO (which would wait forever).

## AUTHOR

Written by Matthew Garrett \<mjg59@srcf.ucam.org\>

## REPORTING BUGS

Report bugs at\
 http://launchpad.net/distros/ubuntu/+source/usplash/+filebug

## COPYRIGHT

Copyright © 2006 Canonical Ltd.\
 Copyright © 2005 Matthew Garrett \<mjg59@srcf.ucam.org\>

This is free software; see the source for copying conditions.  There is NO warranty; not even for MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.

## SEE ALSO

[**usplash**(8)](/usplash/8.md)