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