1.\" 2.\" Copyright (c) 1999 3.\" Kazutaka YOKOTA <yokota@zodiac.mech.utsunomiya-u.ac.jp> 4.\" All rights reserved. 5.\" 6.\" Redistribution and use in source and binary forms, with or without 7.\" modification, are permitted provided that the following conditions 8.\" are met: 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. 15.\" 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. 26.\" 27.\" $FreeBSD$ 28.\" 29.Dd April 7, 2010 30.Dt SPLASH 4 31.Os 32.Sh NAME 33.Nm splash 34.Nd splash screen / screen saver interface 35.Sh SYNOPSIS 36.Cd "device splash" 37.Sh DESCRIPTION 38The 39.Nm 40pseudo device driver adds support for the splash screen and screen 41savers to the kernel. 42This driver is required if the splash bitmap image is to be loaded or 43any screen saver is to be used. 44.Ss Splash screen 45You can load and display an arbitrary bitmap image file as a welcome banner 46on the screen when the system is about to start. 47This image will remain on the screen 48during kernel initialization process 49until the login prompt appears on the screen 50or until a screen saver is loaded and initialized. 51The image will also disappear if you hit any key, 52although this may not work immediately 53if the kernel is still probing devices. 54.Pp 55If you specify the 56.Fl c 57or 58.Fl v 59boot option when loading the kernel, the splash image will not appear. 60However, it 61is still loaded and can be used as a screen saver later: see below. 62.Pp 63In order to display the bitmap, the bitmap file itself and the 64matching splash image decoder module must be loaded by the boot loader. 65Currently the following decoder modules are available: 66.Pp 67.Bl -tag -width splash_decoder -compact 68.It Pa splash_bmp.ko 69W*ndows BMP file decoder. 70While the BMP file format allows images of various color depths, this 71decoder currently only handles 256 color bitmaps. 72Bitmaps of other color depths will not be displayed. 73.It Pa splash_pcx.ko 74ZSoft PCX decoder. 75This decoder currently only supports version 5 8-bpp single-plane 76images. 77.El 78.Pp 79The 80.Sx EXAMPLES 81section illustrates how to set up the splash screen. 82.Pp 83If the standard VGA video mode is used, 84the size of the bitmap must be 320x200 or less. 85If you enable the VESA mode support in the kernel, 86either by statically linking the VESA module or by loading the VESA module 87(see 88.Xr vga 4 ) , 89you can load bitmaps up to a resolution of 1024x768, depending on the VESA 90BIOS and the amount of video memory on the video card. 91.Ss Screen saver 92The screen saver will activate when the system is considered idle: i.e.\& 93when the user has not typed a key or moved the mouse for a specified period 94of time. 95As the screen saver is an optional module, 96it must be explicitly loaded into memory. 97Currently the following screen saver modules are available: 98.Pp 99.Bl -tag -width splash_module.ko -compact 100.It Pa blank_saver.ko 101This screen saver simply blanks the screen. 102.It Pa beastie_saver.ko 103Animated graphical 104.Bx 105Daemon. 106.It Pa daemon_saver.ko 107Animated 108.Bx 109Daemon screen saver. 110.It Pa dragon_saver.ko 111Draws a random dragon curve. 112.It Pa fade_saver.ko 113The screen will gradually fade away. 114.It Pa fire_saver.ko 115A fire which becomes higher as load increases. 116.It Pa green_saver.ko 117If the monitor supports power saving mode, it will be turned off. 118.It Pa logo_saver.ko 119Animated graphical 120.Fx 121logo. 122.It Pa rain_saver.ko 123Draws a shower on the screen. 124.It Pa snake_saver.ko 125Draws a snake of string. 126.It Pa star_saver.ko 127Twinkling stars. 128.It Pa warp_saver.ko 129Streaking stars. 130.El 131.Pp 132Screen saver modules can be loaded using 133.Xr kldload 8 : 134.Pp 135.Dl kldload logo_saver 136.Pp 137The timeout value in seconds can be specified as follows: 138.Pp 139.Dl vidcontrol -t N 140.Pp 141Alternatively, you can set the 142.Ar saver 143variable in the 144.Pa /etc/rc.conf 145to the screen saver of your choice and 146the timeout value to the 147.Ar blanktime 148variable so that the screen saver is automatically loaded 149and the timeout value is set when the system starts. 150.Pp 151The screen saver may be instantly activated by hitting the 152.Ar saver 153key: the defaults are 154.Em Shift-Pause 155on the AT enhanced keyboard and 156.Em Shift-Ctrl-NumLock/Pause 157on the AT 84 keyboard. 158You can change the 159.Ar saver 160key by modifying the keymap 161(see 162.Xr kbdcontrol 1 , 163.Xr keymap 5 ) , 164and assign the 165.Ar saver 166function to a key of your preference. 167.Pp 168The screen saver will not run if the screen is not in text mode. 169.Ss Splash screen as a screen saver 170If you load a splash image but do not load a screen saver, 171you can continue using the splash module as a screen saver. 172The screen blanking interval can be specified as described in the 173.Sx Screen saver 174section above. 175.\".Sh DRIVER CONFIGURATION 176.Sh FILES 177.Bl -tag -width /boot/kernel/splash_xxxx.ko -compact 178.It Pa /boot/defaults/loader.conf 179boot loader configuration defaults 180.It Pa /etc/rc.conf 181system configuration information 182.It Pa /boot/kernel/splash_*.ko 183splash image decoder modules 184.It Pa /boot/kernel/*_saver.ko 185screen saver modules 186.It Pa /boot/kernel/vesa.ko 187the VESA support module 188.El 189.Sh EXAMPLES 190In order to load the splash screen or the screen saver, you must 191have the following line in the kernel configuration file. 192.Pp 193.Dl device splash 194.Pp 195Next, edit 196.Pa /boot/loader.conf 197(see 198.Xr loader.conf 5 ) 199and include the following lines: 200.Bd -literal -offset indent 201splash_bmp_load="YES" 202bitmap_load="YES" 203bitmap_name="/boot/chuck.bmp" 204.Ed 205.Pp 206In the above example, the file 207.Pa /boot/chuck.bmp 208is loaded. 209In the following example, the VESA module 210is loaded so that a bitmap file which cannot be displayed in standard 211VGA modes may be shown using one of the VESA video modes. 212.Bd -literal -offset indent 213splash_pcx_load="YES" 214vesa_load="YES" 215bitmap_load="YES" 216bitmap_name="/boot/chuck.pcx" 217.Ed 218.Pp 219If the VESA support is statically linked to the kernel, it is not 220necessary to load the VESA module. 221Just load the bitmap file and the splash decoder module as in the 222first example above. 223.\".Sh DIAGNOSTICS 224.Sh SEE ALSO 225.Xr vidcontrol 1 , 226.Xr syscons 4 , 227.Xr vga 4 , 228.Xr loader.conf 5 , 229.Xr rc.conf 5 , 230.Xr kldload 8 , 231.Xr kldunload 8 232.Sh HISTORY 233The 234.Nm 235driver first appeared in 236.Fx 3.1 . 237.Sh AUTHORS 238.An -nosplit 239The 240.Nm 241driver and this manual page were written by 242.An Kazutaka Yokota Aq yokota@FreeBSD.org . 243The 244.Pa splash_bmp 245module was written by 246.An Michael Smith Aq msmith@FreeBSD.org 247and 248.An Kazutaka Yokota . 249The 250.Pa splash_pcx 251module was written by 252.An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org 253based on the 254.Pa splash_bmp 255code. 256.Sh CAVEATS 257Both the splash screen and the screen saver work with 258.Xr syscons 4 259only. 260.Sh BUGS 261If you load a screen saver while another screen saver has already 262been loaded, the first screen saver will not be automatically unloaded 263and will remain in memory, wasting kernel memory space. 264