3 .\" Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp>
4 .\" All rights reserved.
6 .\" Redistribution and use in source and binary forms, with or without
7 .\" modification, are permitted provided that the following conditions
9 .\" 1. Redistributions of source code must retain the above copyright
10 .\" notice, this list of conditions and the following disclaimer as
11 .\" the first lines of this file unmodified.
12 .\" 2. Redistributions in binary form must reproduce the above copyright
13 .\" notice, this list of conditions and the following disclaimer in the
14 .\" documentation and/or other materials provided with the distribution.
16 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
17 .\" IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
18 .\" OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
19 .\" IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
20 .\" INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
21 .\" NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
22 .\" DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
23 .\" THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
24 .\" (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
25 .\" THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
34 .Nd splash screen / screen saver interface
40 pseudo device driver adds support for the splash screen and screen
42 This driver is required if the splash bitmap image is to be loaded or
43 any screen saver is to be used.
45 You can load and display an arbitrary bitmap image file as a welcome banner
46 on the screen when the system is about to start.
47 This image will remain on the screen
48 during kernel initialization process
49 until the login prompt appears on the screen
50 or until a screen saver is loaded and initialized.
51 The image will also disappear if you hit any key,
52 although this may not work immediately
53 if the kernel is still probing devices.
59 boot option when loading the kernel, the splash image will not appear.
61 is still loaded and can be used as a screen saver later: see below.
63 In order to display the bitmap, the bitmap file itself and the
64 matching splash image decoder module must be loaded by the boot loader.
65 Currently the following decoder modules are available:
67 .Bl -tag -width splash_decoder -compact
69 W*ndows BMP file decoder.
70 While the BMP file format allows images of various color depths, this
71 decoder currently only handles 256 color bitmaps.
72 Bitmaps of other color depths will not be displayed.
75 This decoder currently only supports version 5 8-bpp single-plane
78 TheDraw binary ASCII drawing file decoder.
79 Displays a text-mode 80x25 ASCII drawing, such as that produced by
80 the Binary save format in TheDraw.
81 This format consists of a sequence
82 of two byte pairs representing the 80x25 display, where the first byte
83 is the ASCII character to draw and the second byte indicates the
84 colors/attributes to use when drawing the character.
89 section illustrates how to set up the splash screen.
91 If the standard VGA video mode is used,
92 the size of the bitmap must be 320x200 or less.
93 If you enable the VESA mode support in the kernel,
94 either by statically linking the VESA module or by loading the VESA module
97 you can load bitmaps up to a resolution of 1024x768, depending on the VESA
98 BIOS and the amount of video memory on the video card.
100 The screen saver will activate when the system is considered idle: i.e.\&
101 when the user has not typed a key or moved the mouse for a specified period
103 As the screen saver is an optional module,
104 it must be explicitly loaded into memory.
105 Currently the following screen saver modules are available:
107 .Bl -tag -width splash_module.ko -compact
108 .It Pa blank_saver.ko
109 This screen saver simply blanks the screen.
110 .It Pa beastie_saver.ko
114 .It Pa daemon_saver.ko
118 .It Pa dragon_saver.ko
119 Draws a random dragon curve.
121 The screen will gradually fade away.
123 A fire which becomes higher as load increases.
124 .It Pa green_saver.ko
125 The screen will be blanked, similar to
127 If the monitor and the video card's BIOS support it
128 the screen will also be powered off.
133 .It Pa plasma_saver.ko
134 Draws an animated interference pattern.
136 Draws a shower on the screen.
137 .It Pa snake_saver.ko
138 Draws a snake of string.
145 Screen saver modules can be loaded using
148 .Dl kldload logo_saver
150 The timeout value in seconds can be specified as follows:
154 Alternatively, you can set the
158 to the screen saver of your choice and
159 the timeout value to the
161 variable so that the screen saver is automatically loaded
162 and the timeout value is set when the system starts.
164 The screen saver may be instantly activated by hitting the
166 key: the defaults are
168 on the AT enhanced keyboard and
169 .Em Shift-Ctrl-NumLock/Pause
170 on the AT 84 keyboard.
173 key by modifying the keymap
179 function to a key of your preference.
181 The screen saver will not run if the screen is not in text mode.
182 .Ss Splash screen as a screen saver
183 If you load a splash image but do not load a screen saver,
184 you can continue using the splash module as a screen saver.
185 The screen blanking interval can be specified as described in the
188 .\".Sh DRIVER CONFIGURATION
190 .Bl -tag -width /boot/kernel/splash_xxxx.ko -compact
191 .It Pa /boot/defaults/loader.conf
192 boot loader configuration defaults
194 system configuration information
195 .It Pa /boot/kernel/splash_*.ko
196 splash image decoder modules
197 .It Pa /boot/kernel/*_saver.ko
199 .It Pa /boot/kernel/vesa.ko
200 the VESA support module
203 In order to load the splash screen or the screen saver, you must
204 have the following line in the kernel configuration file.
209 .Pa /boot/loader.conf
212 and include the following lines:
213 .Bd -literal -offset indent
214 splash_bmp_load="YES"
216 bitmap_name="/boot/chuck.bmp"
219 In the above example, the file
222 In the following example, the VESA module
223 is loaded so that a bitmap file which cannot be displayed in standard
224 VGA modes may be shown using one of the VESA video modes.
225 .Bd -literal -offset indent
226 splash_pcx_load="YES"
229 bitmap_name="/boot/chuck.pcx"
232 If the VESA support is statically linked to the kernel, it is not
233 necessary to load the VESA module.
234 Just load the bitmap file and the splash decoder module as in the
237 To load a binary ASCII drawing and display this while booting, include the
239 .Pa /boot/loader.conf :
240 .Bd -literal -offset indent
241 splash_txt_load="YES"
243 bitmap_name="/boot/splash.bin"
257 driver first appeared in
263 driver and this manual page were written by
264 .An Kazutaka Yokota Aq yokota@FreeBSD.org .
267 module was written by
268 .An Michael Smith Aq msmith@FreeBSD.org
270 .An Kazutaka Yokota .
273 module was written by
274 .An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org
280 module was written by
281 .An Antony Mawer Aq antony@mawer.org
284 code, with some additional inspiration from the
293 modules were written by
294 .An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org .
296 Both the splash screen and the screen saver work with
300 If you load a screen saver while another screen saver has already
301 been loaded, the first screen saver will not be automatically unloaded
302 and will remain in memory, wasting kernel memory space.