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 February 9, 1999 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.Pq see Xr vga 4 , 88you can load bitmaps up to a resolution of 1024x768, depending on the VESA 89BIOS and the amount of video memory on the video card. 90.Ss Screen saver 91The screen saver will activate when the system is considered idle: i.e. 92when the user has not typed a key or moved the mouse for a specified period 93of time. 94As the screen saver is an optional module, 95it must be explicitly loaded into memory. 96Currently the following screen saver modules are available: 97.Pp 98.Bl -tag -width splash_module.ko -compact 99.It Pa blank_saver.ko 100This screen saver simply blanks the screen. 101.It Pa daemon_saver.ko 102Animated BSD Daemon screen saver. 103.It Pa fade_saver.ko 104The screen will gradually fade away. 105.It Pa green_saver.ko 106If the monitor supports power saving mode, it will be turned off. 107.It Pa logo_saver.ko 108Animated graphical BSD Daemon. 109.It Pa rain_saver.ko 110Draws a shower on the screen. 111.It Pa snake_saver.ko 112Draws a snake of string. 113.It Pa star_saver.ko 114Twinkling stars. 115.It Pa warp_saver.ko 116Streaking stars. 117.El 118.Pp 119Screen saver modules can be loaded using 120.Xr kldload 8 : 121.Pp 122.Dl kldload logo_saver 123.Pp 124The timeout value in seconds can be specified as follows: 125.Pp 126.Dl vidcontrol -t N 127.Pp 128Alternatively, you can set the 129.Ar saver 130variable in the 131.Pa /etc/rc.conf 132to the screen saver of your choice and 133the timeout value to the 134.Ar blanktime 135variable so that the screen saver is automatically loaded 136and the timeout value is set when the system starts. 137.Pp 138The screen saver may be instantly activated by hitting the 139.Ar saver 140key: the defaults are 141.Em Shift-Pause 142on the AT enhanced keyboard and 143.Em Shift-Ctrl-NumLock/Pause 144on the AT 84 keyboard. 145You can change the 146.Ar saver 147key by modifying the keymap 148.Pq see Xr kbdcontrol 1 , Xr keymap 5 , 149and assign the 150.Ar saver 151function to a key of your preference. 152.Pp 153The screen saver will not run if the screen is not in text mode. 154.Ss Splash screen as a screen saver 155If you load a splash image but do not load a screen saver, 156you can continue using the splash module as a screen saver. 157The screen blanking interval can be specified as described in the 158.Sx Screen saver 159section above. 160.\".Sh DRIVER CONFIGURATION 161.Sh FILES 162.Bl -tag -width /boot/kernel/splash_xxxx.ko -compact 163.It Pa /boot/defaults/loader.conf 164boot loader configuration defaults 165.It Pa /etc/rc.conf 166system configuration information 167.It Pa /boot/kernel/splash_*.ko 168splash image decoder modules 169.It Pa /boot/kernel/*_saver.ko 170screen saver modules 171.It Pa /boot/kernel/vesa.ko 172the VESA support module 173.El 174.Sh EXAMPLES 175In order to load the splash screen or the screen saver, you must 176have the following line in the kernel configuration file. 177.Pp 178.Dl device splash 179.Pp 180Next, edit 181.Pa /boot/loader.conf 182.Pq see Xr loader.conf 5 183and include the following lines: 184.Bd -literal -offset indent 185splash_bmp_load="YES" 186bitmap_load="YES" 187bitmap_name="chuck.bmp" 188.Ed 189.Pp 190In the above example, the file 191.Pa chuck.bmp 192is loaded. 193In the following example, the VESA module 194is loaded so that a bitmap file which cannot be displayed in standard 195VGA modes may be shown using one of the VESA video modes. 196.Bd -literal -offset indent 197splash_pcx_load="YES" 198vesa_load="YES" 199bitmap_load="YES" 200bitmap_name="chuck.pcx" 201.Ed 202.Pp 203If the VESA support is statically linked to the kernel, it is not 204necessary to load the VESA module. 205Just load the bitmap file and the splash decoder module as in the 206first example above. 207.\".Sh DIAGNOSTICS 208.Sh CAVEATS 209Both the splash screen and the screen saver work with 210.Xr syscons 4 211only. 212They are not available for the alternative console driver 213.Xr pcvt 4 . 214.Sh BUGS 215If you load a screen saver while another screen saver has already 216been loaded, the first screen saver will not be automatically unloaded 217and will remain in memory, wasting kernel memory space. 218.Sh SEE ALSO 219.Xr vidcontrol 1 , 220.Xr syscons 4 , 221.Xr vga 4 , 222.Xr loader.conf 5 , 223.Xr rc.conf 5 , 224.Xr kldload 8 , 225.Xr kldunload 8 226.Sh HISTORY 227The 228.Nm 229driver first appeared in 230.Fx 3.1 . 231.Sh AUTHORS 232.An -nosplit 233The 234.Nm 235driver and this manual page were written by 236.An Kazutaka Yokota Aq yokota@FreeBSD.org . 237The 238.Pa splash_bmp 239module was written by 240.An Michael Smith Aq msmith@FreeBSD.org 241and 242.An Kazutaka Yokota . 243The 244.Pa splash_pcx 245module was written by 246.An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org 247based on the 248.Pa splash_bmp 249code. 250
