share/man/man4/splash.4

   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 December 31, 2015
  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
  38 The
  39 .Nm
  40 pseudo device driver adds support for the splash screen and screen
  41 savers to the kernel.
  42 This driver is required if the splash bitmap image is to be loaded or
  43 any screen saver is to be used.
  44 .Ss Splash screen
  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.
  54 .Pp
  55 If you specify the
  56 .Fl c
  57 or
  58 .Fl v
  59 boot option when loading the kernel, the splash image will not appear.
  60 However, it
  61 is still loaded and can be used as a screen saver later: see below.
  62 .Pp
  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:
  66 .Pp
  67 .Bl -tag -width splash_decoder -compact
  68 .It Pa splash_bmp.ko
  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.
  73 .It Pa splash_pcx.ko
  74 ZSoft PCX decoder.
  75 This decoder currently only supports version 5 8-bpp single-plane
  76 images.
  77 .It Pa splash_txt.ko
  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.
  85 .El
  86 .Pp
  87 The
  88 .Sx EXAMPLES
  89 section illustrates how to set up the splash screen.
  90 .Pp
  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
  95 (see
  96 .Xr vga 4 ) ,
  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.
  99 .Ss Screen saver
 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
 102 of time.
 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:
 106 .Pp
 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
 111 Animated graphical
 112 .Bx
 113 Daemon.
 114 .It Pa daemon_saver.ko
 115 Animated
 116 .Bx
 117 Daemon screen saver.
 118 .It Pa dragon_saver.ko
 119 Draws a random dragon curve.
 120 .It Pa fade_saver.ko
 121 The screen will gradually fade away.
 122 .It Pa fire_saver.ko
 123 A fire which becomes higher as load increases.
 124 .It Pa green_saver.ko
 125 The screen will be blanked, similar to
 126 .Pa blank_saver.ko .
 127 If the monitor and the video card's BIOS support it
 128 the screen will also be powered off.
 129 .It Pa logo_saver.ko
 130 Animated graphical
 131 .Fx
 132 logo.
 133 .It Pa plasma_saver.ko
 134 Draws an animated interference pattern.
 135 .It Pa rain_saver.ko
 136 Draws a shower on the screen.
 137 .It Pa snake_saver.ko
 138 Draws a snake of string.
 139 .It Pa star_saver.ko
 140 Twinkling stars.
 141 .It Pa warp_saver.ko
 142 Streaking stars.
 143 .El
 144 .Pp
 145 Screen saver modules can be loaded using
 146 .Xr kldload 8 :
 147 .Pp
 148 .Dl kldload logo_saver
 149 .Pp
 150 The timeout value in seconds can be specified as follows:
 151 .Pp
 152 .Dl vidcontrol -t N
 153 .Pp
 154 Alternatively, you can set the
 155 .Ar saver
 156 variable in the
 157 .Pa /etc/rc.conf
 158 to the screen saver of your choice and
 159 the timeout value to the
 160 .Ar blanktime
 161 variable so that the screen saver is automatically loaded
 162 and the timeout value is set when the system starts.
 163 .Pp
 164 The screen saver may be instantly activated by hitting the
 165 .Ar saver
 166 key: the defaults are
 167 .Em Shift-Pause
 168 on the AT enhanced keyboard and
 169 .Em Shift-Ctrl-NumLock/Pause
 170 on the AT 84 keyboard.
 171 You can change the
 172 .Ar saver
 173 key by modifying the keymap
 174 (see
 175 .Xr kbdcontrol 1 ,
 176 .Xr keymap 5 ) ,
 177 and assign the
 178 .Ar saver
 179 function to a key of your preference.
 180 .Pp
 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
 186 .Sx Screen saver
 187 section above.
 188 .\".Sh DRIVER CONFIGURATION
 189 .Sh FILES
 190 .Bl -tag -width /boot/kernel/splash_xxxx.ko -compact
 191 .It Pa /boot/defaults/loader.conf
 192 boot loader configuration defaults
 193 .It Pa /etc/rc.conf
 194 system configuration information
 195 .It Pa /boot/kernel/splash_*.ko
 196 splash image decoder modules
 197 .It Pa /boot/kernel/*_saver.ko
 198 screen saver modules
 199 .It Pa /boot/kernel/vesa.ko
 200 the VESA support module
 201 .El
 202 .Sh EXAMPLES
 203 In order to load the splash screen or the screen saver, you must
 204 have the following line in the kernel configuration file.
 205 .Pp
 206 .Dl device splash
 207 .Pp
 208 Next, edit
 209 .Pa /boot/loader.conf
 210 (see
 211 .Xr loader.conf 5 )
 212 and include the following lines:
 213 .Bd -literal -offset indent
 214 splash_bmp_load="YES"
 215 bitmap_load="YES"
 216 bitmap_name="/boot/chuck.bmp"
 217 .Ed
 218 .Pp
 219 In the above example, the file
 220 .Pa /boot/chuck.bmp
 221 is loaded.
 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"
 227 vesa_load="YES"
 228 bitmap_load="YES"
 229 bitmap_name="/boot/chuck.pcx"
 230 .Ed
 231 .Pp
 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
 235 first example above.
 236 .Pp
 237 To load a binary ASCII drawing and display this while booting, include the
 238 following into your
 239 .Pa /boot/loader.conf :
 240 .Bd -literal -offset indent
 241 splash_txt_load="YES"
 242 bitmap_load="YES"
 243 bitmap_name="/boot/splash.bin"
 244 .Ed
 245 .\".Sh DIAGNOSTICS
 246 .Sh SEE ALSO
 247 .Xr vidcontrol 1 ,
 248 .Xr syscons 4 ,
 249 .Xr vga 4 ,
 250 .Xr loader.conf 5 ,
 251 .Xr rc.conf 5 ,
 252 .Xr kldload 8 ,
 253 .Xr kldunload 8
 254 .Sh HISTORY
 255 The
 256 .Nm
 257 driver first appeared in
 258 .Fx 3.1 .
 259 .Sh AUTHORS
 260 .An -nosplit
 261 The
 262 .Nm
 263 driver and this manual page were written by
 264 .An Kazutaka Yokota Aq yokota@FreeBSD.org .
 265 The
 266 .Pa splash_bmp
 267 module was written by
 268 .An Michael Smith Aq msmith@FreeBSD.org
 269 and
 270 .An Kazutaka Yokota .
 271 The
 272 .Pa splash_pcx
 273 module was written by
 274 .An Dag-Erling Sm\(/orgrav Aq des@FreeBSD.org
 275 based on the
 276 .Pa splash_bmp
 277 code.
 278 The
 279 .Pa splash_txt
 280 module was written by
 281 .An Antony Mawer Aq antony@mawer.org
 282 based on the
 283 .Pa splash_bmp
 284 code, with some additional inspiration from the
 285 .Pa daemon_saver
 286 code.
 287 The
 288 .Pa logo_saver ,
 289 .Pa plasma_saver ,
 290 .Pa rain_saver
 291 and
 292 .Pa warp_saver
 293 modules were written by
 294 .An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org .
 295 .Sh CAVEATS
 296 Both the splash screen and the screen saver work with
 297 .Xr syscons 4
 298 only.
 299 .Sh BUGS
 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.