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
I QUIT
Instructs the daemon to terminate, restoring the console that was
previously active.
I 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.
I CLEAR
Clears any text currently displayed.
I TEXT text
Displays the given text in the area on the screen reserved for that,
scrolling any existing text up.
I 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.
I STATUS status
Displays the given status string to the right of the last line of text
in the same colour.
I SUCCESS status
Displays the given status string to the right of the last line of text
in a colour used to indicate success.
I FAILURE status
Displays the given status string to the right of the last line of text
in a colour used to indicate failure.
I PROGRESS percentage
Update the progress bar to show that the given percentage (0-100) of the
process has been completed.
I PULSATE
Set the progress bar to display a throbber (an indicator bouncing from left
to right and back again).
I 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.
I 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.
I 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".
EXIT STATUS
usplash_write
always returns an exit status of zero.
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
