Man page - configure-splash(8)

Packages contains this manual

Package: rpi-splash-screen-support
apt-get install rpi-splash-screen-support

Manuals in package:

configure-splash(8)

Documentations in package:

rpi-splash-screen-support

Manual

CONFIGURE-SPLASH

NAME
SYNOPSIS
DESCRIPTION
REQUIREMENTS
EXAMPLES
Creating a suitable TGA image
Setting the splash screen
FILES
SEE ALSO
BUGS

NAME

configure-splash - configure the fullscreen splash screen for Raspberry Pi OS

SYNOPSIS

sudo configure-splash <splash-image>

DESCRIPTION

The configure-splash tool configures and sets up a fullscreen splash screen for Raspberry Pi OS. This splash image is drawn early in the boot process, replacing the default four raspberries logo.

This tool will make the necessary changes to the kernel configuration to show a fullscreen splash image at boot time. Upon successful configuration, the only thing drawn to the display during the early boot phase will be the specified splash image, followed by the next application to take control of the display (e.g., the desktop environment, a login console, etc.).

The <splash-image> argument is the path to the image file to be used. This can be either a relative or an absolute path.

REQUIREMENTS

The splash image file must meet the following criteria:

	•		Format: 24-bit TGA
	•		Dimensions: Smaller than 1920x1080 pixels
	•		Colors: Must contain less than 224 colors

EXAMPLES

Creating a suitable TGA image

An image can be converted from a format like PNG to a compliant TGA file using ImageMagick’s convert (1) tool:

$ convert image.png -flip -colors 224 -depth 8 -type TrueColor -alpha off -compress none -define tga:bits-per-sample=8 logo.tga

Setting the splash screen

To set the newly created ‘logo.tga‘ as the splash screen:

$ sudo configure-splash logo.tga

FILES

Modifies kernel configuration files to enable the splash screen functionality.

BUGS

No known bugs.