1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74
|
.TH usplash_write "8" "June 2006" Ubuntu
.\"
.SH NAME
usplash_write \- send commands to a running usplash daemon
.\"
.SH SYNOPSIS
\fBusplash_write\fR \fICOMMAND\fR...
.\"
.SH DESCRIPTION
Sends the given commands to a running usplash daemon, if no daemon is
running it returns without doing anything.
.\"
.SH COMMANDS
.TP
.BI QUIT
Instructs the daemon to terminate, restoring the console that was
previously active.
.\"
.TP
.BI 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.
.\"
.TP
.BI CLEAR
Clears any text currently displayed.
.\"
.TP
.BI TEXT " text"
Displays the given text in the area on the screen reserved for that,
scrolling any existing text up.
.\"
.TP
.BI STATUS " status"
Displays the given status string to the right of the last line of text
in the same colour.
.\"
.TP
.BI SUCCESS " status"
Displays the given status string to the right of the last line of text
in a colour used to indicate success.
.\"
.TP
.BI FAILURE " status"
Displays the given status string to the right of the last line of text
in a colour used to indicate failure.
.\"
.TP
.BI PROGRESS " percentage"
Update the progress bar to show that the given percentage (0-100) of the
process has been completed.
.\"
.SH EXIT STATUS
.B usplash_write
always returns an exit status of zero.
.\"
.SH AUTHOR
Written by Matthew Garrett <mjg59@srcf.ucam.org>
.\"
.SH REPORTING BUGS
Report bugs at
.br
http://launchpad.net/distros/ubuntu/+source/usplash/+filebug
.\"
.SH COPYRIGHT
Copyright \(co 2006 Canonical Ltd.
.br
Copyright \(co 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.
.\"
.SH SEE ALSO
.BR usplash (8)
|