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
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
|
.TH usplash_write "8" "February 2007" 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,
.B usplash_write
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 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.
.\"
.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.
.\"
.TP
.BI PULSATE
Set the progress bar to display a throbber (an indicator bouncing from left
to right and back again).
.\"
.TP
.BI 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.
.\"
.TP
.BI 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.
.\"
.TP
.BI 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".
.\"
.TP
.BI INPUTTIMEOUT " timeout prompt"
Works in the same way as INPUT above, but returns the empty string
after the given number of deciseconds.
.\"
.TP
.BI 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).
.\"
.TP
.BI VERBOSE " mode"
Changes verbosity at runtime. Possible values for
.I mode
are
.B on
or
.B true
for verbose mode,
.B off
or
.B false
for quiet mode,
or
.B default
for the default mode when usplash started.
.\"
.SH EXIT STATUS
.B usplash_write
always returns an exit status of zero by default.
However, if the environment variable
.B 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).
.\"
.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)
|
