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