SPLASH(4)

💖 SPLASH(4) 💖

okay bestie, welcome to the Kernel Interfaces Manual ✨ and today's main character is the splash pseudo device driver. she's giving screen saver energy, she's giving welcome banner, she's giving iconic. 🫶

---

✨ NAME ✨

splash — splash screen / screen saver interface 💅

---

🌈 SYNOPSIS 🌈

device splash

---

👑 DESCRIPTION 👑

okay so the splash pseudo device driver is the one that adds support for the splash screen and the screen savers to the kernel. like, both. at once. 💖

and you need this driver if you want a splash bitmap image to be loaded, or if you want literally any screen saver to be used. no driver = no vibe. periodt.

🎀 Splash screen 🎀

so you can load and display an arbitrary bitmap image file as a welcome banner on the screen when the system is about to start. that image just chills there on your screen during the whole kernel initialization process — until the login prompt shows up, or until a screen saver gets loaded and initialized. it'll also disappear if you hit any key, tho ngl that might not work immediately if the kernel is still out here probing devices. 😭

if you specify the -c or -v boot option when loading the kernel, the splash image will not appear. but bestie, it's still loaded! and it can still be used as a screen saver later — see below. 💅

in order to display the bitmap, the bitmap file itself and the matching splash image decoder module must be loaded by the boot loader. currently these decoder modules are available:

• splash_bmp.ko — Windows BMP file decoder. and like, yeah, the BMP file format allows images of various color depths, but this decoder currently only handles 256 color bitmaps. bitmaps of other color depths will not be displayed. 💀
• splash_pcx.ko — ZSoft PCX decoder. this decoder currently only supports version 5 8-bpp single-plane images.
• splash_txt.ko — TheDraw binary ASCII drawing file decoder. displays a text-mode 80x25 ASCII drawing, like the kind produced by the Binary save format in TheDraw. this format is a sequence of two byte pairs representing the 80x25 display, where the first byte is the ASCII character to draw and the second byte indicates the colors/attributes to use when drawing the character. 🎨

the “EXAMPLES” section illustrates how to set up the splash screen, so like, scroll down bestie.

if the standard VGA video mode is used, the size of the bitmap must be 320x200 or less. if you enable the VESA mode support in the kernel — either by statically linking the VESA module or by loading the VESA module (see vga(4)) — you can load bitmaps up to a resolution of 1024x768, depending on the VESA BIOS and the amount of video memory on the video card. 🔥

🦋 Screen saver 🦋

the screen saver will activate when the system is considered idle: i.e. when the user has not typed a key or moved the mouse for a specified period of time. since the screen saver is an optional module, it must be explicitly loaded into memory. currently these screen saver modules are available:

• blank_saver.ko — this screen saver simply blanks the screen.
• beastie_saver.ko — animated graphical BSD Daemon. 👹
• daemon_saver.ko — animated BSD Daemon screen saver.
• dragon_saver.ko — draws a random dragon curve. 🐉
• fade_saver.ko — the screen will gradually fade away.
• fire_saver.ko — a fire which becomes higher as load increases. 🔥
• green_saver.ko — the screen will be blanked, similar to blank_saver.ko. if the monitor and the video card's BIOS support it, the screen will also be powered off.
• logo_saver.ko — animated graphical FreeBSD logo.
• plasma_saver.ko — draws an animated interference pattern.
• rain_saver.ko — draws a shower on the screen. 🌧️
• snake_saver.ko — draws a snake of string.
• star_saver.ko — twinkling stars. ⭐
• warp_saver.ko — streaking stars.

screen saver modules can be loaded using kldload(8):

kldload logo_saver

the timeout value in seconds can be specified as follows:

vidcontrol -t N

alternatively, you can set the saver variable in the /etc/rc.conf to the screen saver of your choice, and the timeout value to the blanktime variable, so that the screen saver is automatically loaded and the timeout value is set when the system starts. automation slay. 💅

the screen saver may be instantly activated by hitting the saver key: the defaults are Shift-Pause on the AT enhanced keyboard and Shift-Ctrl-NumLock/Pause on the AT 84 keyboard. you can change the saver key by modifying the keymap (see kbdcontrol(1), keymap(5)), and assign the saver function to a key of your preference. make it yours. ✨

🚨 heads up: the screen saver will not run if the screen is not in text mode.

🧚 Splash screen as a screen saver 🧚

if you load a splash image but do not load a screen saver, you can continue using the splash module as a screen saver. the screen blanking interval can be specified as described in the “Screen saver” section above. reusing the same module for a whole new purpose? that's main character energy. 👑

---

🍓 FILES 🍓

• /boot/defaults/loader.conf — boot loader configuration defaults
• /etc/rc.conf — system configuration information
• /boot/kernel/splash_*.ko — splash image decoder modules
• /boot/kernel/*_saver.ko — screen saver modules
• /boot/kernel/vesa.ko — the VESA support module

---

💜 EXAMPLES 💜

in order to load the splash screen or the screen saver, you must have the following line in the kernel configuration file.

device splash

next, edit /boot/loader.conf (see loader.conf(5)) and include the following lines:

splash_bmp_load="YES"
bitmap_load="YES"
bitmap_name="/boot/chuck.bmp"

in the above example, the file /boot/chuck.bmp is loaded. 📸 in the following example, the VESA module is loaded so that a bitmap file which cannot be displayed in standard VGA modes may be shown using one of the VESA video modes.

splash_pcx_load="YES"
vesa_load="YES"
bitmap_load="YES"
bitmap_name="/boot/chuck.pcx"

if the VESA support is statically linked to the kernel, it is not necessary to load the VESA module. just load the bitmap file and the splash decoder module as in the first example above. 🫶

to load a binary ASCII drawing and display this while booting, include the following into your /boot/loader.conf:

splash_txt_load="YES"
bitmap_load="YES"
bitmap_name="/boot/splash.bin"

---

🌟 SEE ALSO 🌟

vidcontrol(1), syscons(4), vga(4), loader.conf(5), rc.conf(5), kldload(8), kldunload(8)

---

📜 HISTORY 📜

the splash driver first appeared in FreeBSD 3.1. a true legend since day one. 👑

---

🌸 AUTHORS 🌸

the splash driver and this manual page were written by Kazutaka Yokota <yokota@FreeBSD.org>. the splash_bmp module was written by Michael Smith <msmith@FreeBSD.org> and Kazutaka Yokota. the splash_pcx module was written by Dag-Erling Smørgrav <des@FreeBSD.org> based on the splash_bmp code. the splash_txt module was written by Antony Mawer <antony@mawer.org> based on the splash_bmp code, with some additional inspiration from the daemon_saver code. the logo_saver, plasma_saver, rain_saver and warp_saver modules were written by Dag-Erling Smørgrav <des@FreeBSD.org>. absolute icons, all of them. 🫶✨

---

⚠️ CAVEATS ⚠️

both the splash screen and the screen saver work with syscons(4) only. no syscons, no vibes. 😭

---

💀 BUGS 💀

if you load a screen saver while another screen saver has already been loaded, the first screen saver will not be automatically unloaded and will remain in memory, wasting kernel memory space. so like… double-check before you stack savers, bestie. 🙈

---

and that's the whole page fr fr 💖 this was the splash(4) page from the Kernel Interfaces Manual, signed off by Debian, dated December 31, 2015. bye babes, go load a bitmap 🦋🌸💅