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: src/share/man/man4/splash.4,v 1.9.2.7 2001/08/17 13:08:39 ru Exp $
  28 .\"
  29 .Dd August 14, 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 "pseudo-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 .Ss Screen saver
  86 The screen saver will activate when the system is considered idle: i.e.\&
  87 when the user has not typed a key or moved the mouse for a specified period
  88 of time.
  89 As the screen saver is an optional module,
  90 it must be explicitly loaded into memory.
  91 Currently the following screen saver modules are available:
  92 .Pp
  93 .Bl -tag -width splash_module.ko -compact
  94 .It Pa blank_saver.ko
  95 This screen saver simply blanks the screen.
  96 .It Pa fade_saver.ko
  97 The screen will gradually fade away.
  98 .It Pa fred_saver.ko
  99 Animated ASCII
 100 .Dx
 101 logo.
 102 .It Pa green_saver.ko
 103 If the monitor supports power saving mode, it will be turned off.
 104 .It Pa logo_saver.ko
 105 Animated graphical
 106 .Dx
 107 logo.
 108 .It Pa rain_saver.ko
 109 Draws a shower on the screen.
 110 .It Pa snake_saver.ko
 111 Draws a snake of string.
 112 .It Pa star_saver.ko
 113 Twinkling stars.
 114 .It Pa warp_saver.ko
 115 Streaking stars.
 116 .El
 117 .Pp
 118 Screen saver modules can be loaded using
 119 .Xr kldload 8 :
 120 .Pp
 121 .Dl kldload logo_saver
 122 .Pp
 123 The timeout value in seconds can be specified as follows:
 124 .Pp
 125 .Dl vidcontrol -t N
 126 .Pp
 127 Alternatively, you can set the
 128 .Ar saver
 129 variable in the
 130 .Pa /etc/rc.conf
 131 to the screen saver of your choice and
 132 the timeout value to the
 133 .Ar blanktime
 134 variable so that the screen saver is automatically loaded
 135 and the timeout value is set when the system starts.
 136 .Pp
 137 The screen saver may be instantly activated by hitting the
 138 .Ar saver
 139 key: the defaults are
 140 .Em Shift-Pause
 141 on the AT enhanced keyboard and
 142 .Em Shift-Ctrl-NumLock/Pause
 143 on the AT 84 keyboard.
 144 You can change the
 145 .Ar saver
 146 key by modifying the keymap
 147 (see
 148 .Xr kbdcontrol 1 ,
 149 .Xr keymap 5 ) ,
 150 and assign the
 151 .Ar saver
 152 function to a key of your preference.
 153 .Pp
 154 The screen saver will not run if the screen is not in text mode.
 155 .Ss Splash screen as a screen saver
 156 If you load a splash image but do not load a screen saver,
 157 you can continue using the splash module as a screen saver.
 158 The screen blanking interval can be specified as described in the
 159 .Sx Screen saver
 160 section above.
 161 .\".Sh DRIVER CONFIGURATION
 162 .Sh FILES
 163 .Bl -tag -width /boot/defaults/loader.conf -compact
 164 .It Pa /boot/defaults/loader.conf
 165 boot loader configuration defaults
 166 .It Pa /etc/rc.conf
 167 system configuration information
 168 .It Pa /boot/kernel/splash_*.ko
 169 splash image decoder modules
 170 .It Pa /boot/kernel/*_saver.ko
 171 screen saver modules
 172 .El
 173 .Sh EXAMPLES
 174 In order to load the splash screen or the screen saver, you must
 175 have the following line in the kernel configuration file.
 176 .Pp
 177 .Dl pseudo-device splash
 178 .Pp
 179 Next, edit
 180 .Pa /boot/loader.conf
 181 (see
 182 .Xr loader.conf 5 )
 183 and include the following lines:
 184 .Bd -literal -offset indent
 185 splash_bmp_load="YES"
 186 bitmap_load="YES"
 187 bitmap_name="chuck.bmp"
 188 .Ed
 189 .Pp
 190 In the above example, the file
 191 .Pa chuck.bmp
 192 is loaded.
 193 .Sh SEE ALSO
 194 .Xr vidcontrol 1 ,
 195 .Xr syscons 4 ,
 196 .Xr vga 4 ,
 197 .Xr loader.conf 5 ,
 198 .Xr rc.conf 5 ,
 199 .Xr kldload 8 ,
 200 .Xr kldunload 8
 201 .Sh HISTORY
 202 The
 203 .Nm
 204 driver first appeared in
 205 .Fx 3.1 .
 206 .Sh AUTHORS
 207 .An -nosplit
 208 The
 209 .Nm
 210 driver and this manual page were written by
 211 .An Kazutaka Yokota Aq Mt yokota@FreeBSD.org .
 212 The
 213 .Pa splash_bmp
 214 module was written by
 215 .An Michael Smith Aq Mt msmith@FreeBSD.org
 216 and
 217 .An Kazutaka Yokota .
 218 The
 219 .Pa splash_pcx
 220 module was written by
 221 .An Dag-Erling Sm\(/orgrav Aq Mt des@FreeBSD.org
 222 based on the
 223 .Pa splash_bmp
 224 code.
 225 .Sh BUGS
 226 If you load a screen saver while another screen saver has already
 227 been loaded, the first screen saver will not be automatically unloaded
 228 and will remain in memory, wasting kernel memory space.