| splash.4 (43725) | splash.4 (43844) |
|---|---|
| 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: --- 10 unchanged lines hidden (view full) --- 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.\" | 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: --- 10 unchanged lines hidden (view full) --- 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.\" $Id: $ | 27.\" $Id: splash.4,v 1.1 1999/02/07 05:40:14 yokota Exp $ |
| 28.\" | 28.\" |
| 29.Dd February 6, 1999 | 29.Dd February 9, 1999 |
| 30.Dt SPLASH 4 i386 31.Os FreeBSD 32.Sh NAME 33.Nm splash 34.Nd 35splash screen / screen saver interface 36.Sh SYNOPSIS 37.Cd "pseudo-device splash" 38.Sh DESCRIPTION 39The 40.Nm 41pseudo device driver adds support for the splash screen and screen 42savers to the kernel. 43This driver is required if the splash bitmap image is to be loaded or 44any screen saver is to be used. 45.Sh SPLASH SCREEN 46You can load and display an arbitrary bitmap image file as welcome banner | 30.Dt SPLASH 4 i386 31.Os FreeBSD 32.Sh NAME 33.Nm splash 34.Nd 35splash screen / screen saver interface 36.Sh SYNOPSIS 37.Cd "pseudo-device splash" 38.Sh DESCRIPTION 39The 40.Nm 41pseudo device driver adds support for the splash screen and screen 42savers to the kernel. 43This driver is required if the splash bitmap image is to be loaded or 44any screen saver is to be used. 45.Sh SPLASH SCREEN 46You can load and display an arbitrary bitmap image file as welcome banner |
| 47on the screen when the system is about to start. 48It stays on the screen while the system is being initialized, 49and goes away when you hit any key (this may not work 50immediately if the kernel is still probing devices), 51when a screen saver is loaded and initialized, 52or when the "Login" prompt first appears on the screen. | 47on the screen when the system is about to start. This image will remain on 48the screen during kernel initialization process until the ``Login'' prompt 49appears on the screen or until a screen saver is loaded and initialized. 50The image will also disappear if you hit any key, although this may not work 51immediately if the kernel is still probing devices. |
| 53.Pp 54If you specify 55.Fl c 56or 57.Fl v | 52.Pp 53If you specify 54.Fl c 55or 56.Fl v |
| 58boot option when loading kernel, the splash image won't appear 59(though is still loaded and can be used as a screen saver later; see below). | 57boot option when loading kernel, the splash image will not appear. However, it 58is still loaded and can be used as a screen saver later: see below. |
| 60.Pp | 59.Pp |
| 61In order to display the bitmap, the bitmap file itself and 62matching splash image decoder must be loaded by the boot loader. | 60In order to display the bitmap, the bitmap file itself and the 61matching splash image decoder module must be loaded by the boot loader. |
| 63Currently the following decoder module is available: 64.Pp | 62Currently the following decoder module is available: 63.Pp |
| 65.Bl -tag -width splash -compact 66.It splash_bmp.ko | 64.Bl -tag -width splash_decoder -compact 65.It Pa splash_bmp.ko |
| 67W*ndows BMP file decoder. | 66W*ndows BMP file decoder. |
| 68While the BMP file format allows various depth of colors, this decoder 69can only handle 256 color bitmaps. 70Other color depth won't work. | 67While the BMP file format allows images of various color depths, this 68decoder currently only handles 256 color bitmaps. Bitmaps of other color 69depths will not be displayed. |
| 71.El 72.Pp 73The 74.Sx EXAMPLES 75section illustrates how to set up the splash screen. 76.Pp | 70.El 71.Pp 72The 73.Sx EXAMPLES 74section illustrates how to set up the splash screen. 75.Pp |
| 77The size of the bitmap must be 320x200 or less, 78if the standard VGA video mode is used. | 76If the standard VGA video mode is used, 77the size of the bitmap must be 320x200 or less. |
| 79If you enable the VESA mode support in the kernel, 80either by statically linking the VESA module or by loading the VESA module 81.Pq see Xr vga 4 , | 78If you enable the VESA mode support in the kernel, 79either by statically linking the VESA module or by loading the VESA module 80.Pq see Xr vga 4 , |
| 82you can load as large bitmap as 1024x768, depending on the VESA BIOS 83and the amount of video memory on the video card. | 81you can load bitmaps up to a resolution of 1024x768, depending on the VESA 82BIOS and the amount of video memory on the video card. |
| 84.Sh SCREEN SAVER | 83.Sh SCREEN SAVER |
| 85The screen saver will pop up 86when the system is considered "idle", that is, the user has not typed 87a key or moved the mouse, for the specified duration. 88As the screen saver is an optional module, it must be explicitly loaded 89to the memory. 90Currently the following screen saver modules are available: | 84The screen saver will activate when the system is considered idle: i.e. 85when the user has not typed a key or moved the mouse for a specified period 86of time. As the screen saver is an optional module, it must be explicitly 87loaded into memory. Currently the following screen saver modules are 88available: |
| 91.Pp | 89.Pp |
| 92.Bl -tag -width splash -compact 93.It blank_saver.ko | 90.Bl -tag -width splash_module.ko -compact 91.It Pa blank_saver.ko |
| 94This screen saver simply blanks the screen. | 92This screen saver simply blanks the screen. |
| 95.It daemon_saver.ko | 93.It Pa daemon_saver.ko |
| 96Animated BSD Daemon screen saver. | 94Animated BSD Daemon screen saver. |
| 97.It fade_saver.ko | 95.It Pa fade_saver.ko |
| 98The screen will gradually fade away. | 96The screen will gradually fade away. |
| 99.It green_saver.ko | 97.It Pa green_saver.ko |
| 100If the monitor supports power saving mode, it will be turned off. | 98If the monitor supports power saving mode, it will be turned off. |
| 101.It logo_saver.ko | 99.It Pa logo_saver.ko |
| 102Animated graphical BSD Daemon. | 100Animated graphical BSD Daemon. |
| 103.It rain_saver.ko | 101.It Pa rain_saver.ko |
| 104Draws shower on the screen. | 102Draws shower on the screen. |
| 105.It snake_saver.ko | 103.It Pa snake_saver.ko |
| 106Draws a snake of string. | 104Draws a snake of string. |
| 107.It star_saver.ko | 105.It Pa star_saver.ko |
| 108Twinkling stars. | 106Twinkling stars. |
| 109.It warp_saver.ko | 107.It Pa warp_saver.ko |
| 110Streaking stars. 111.El 112.Pp | 108Streaking stars. 109.El 110.Pp |
| 113Load a screen saver module via 114.Xr kldload 1 . | 111Screen saver modules can be loaded using 112.Xr kldload 1 : |
| 115.Pp 116.Dl kldload logo_saver 117.Pp | 113.Pp 114.Dl kldload logo_saver 115.Pp |
| 118Then specify timeout value, in seconds, as follows: | 116The timeout value in seconds can be specified as follows: |
| 119.Pp | 117.Pp |
| 120.Dl vidcontrol -t timeout | 118.Dl vidcontrol -t N |
| 121.Pp 122Alternatively, you can set the 123.Ar saver 124variable in the 125.Pa /etc/rc.conf 126to the screen saver of your choice and 127the timeout value to the 128.Ar blanktime 129variable so that the screen saver is automatically loaded 130and the timeout value is set when the system starts. 131.Pp 132The screen saver may be instantly activated by hitting the 133.Ar saver | 119.Pp 120Alternatively, you can set the 121.Ar saver 122variable in the 123.Pa /etc/rc.conf 124to the screen saver of your choice and 125the timeout value to the 126.Ar blanktime 127variable so that the screen saver is automatically loaded 128and the timeout value is set when the system starts. 129.Pp 130The screen saver may be instantly activated by hitting the 131.Ar saver |
| 134key (Shift-Pause on the AT enhanced keyboard, Shift-Ctrl-NumLock/Pause 135on the AT 84 keyboard by default). 136You can change the | 132key: the defaults are 133.Em Shift-Pause 134 on the AT enhanced keyboard and 135.Em Shift-Ctrl-NumLock/Pause 136on the AT 84 keyboard. You can change the |
| 137.Ar saver | 137.Ar saver |
| 138key by modifying the keymap. 139See 140.Xr kbdcontrol 1 141and 142.Xr keymap 5 , | 138key by modifying the keymap 139.Pq see Xr kbdcontrol 1 , Xr keymap 5 , |
| 143and assign the 144.Ar saver 145function to a key of your preference. 146.Pp | 140and assign the 141.Ar saver 142function to a key of your preference. 143.Pp |
| 147The screen saver won't run if the current screen is not in the 148text mode. | 144The screen saver will not run if the screen is not in text mode. |
| 149.Sh SPLASH SCREEN AS A SCREEN SAVER | 145.Sh SPLASH SCREEN AS A SCREEN SAVER |
| 150If you load a splash image but don't load a screen saver, | 146If you load a splash image but do not load a screen saver, |
| 151you can continue using the splash module as a screen saver. | 147you can continue using the splash module as a screen saver. |
| 152Specify the screen blanking interval as explained in the | 148The screen blanking interval can be specified as described in the |
| 153.Sx SCREEN SAVER | 149.Sx SCREEN SAVER |
| 154section above, and 155the splash screen image will come back after the specified time. | 150section above. |
| 156.\".Sh DRIVER CONFIGURATION 157.Sh FILES 158.Bl -tag -width /modules/splash_xxxx.ko -compact 159.It /boot/loader.rc 160boot loader script 161.It /etc/rc.conf 162system configuration information 163.It /modules/splash_*.ko 164splash image decoder modules 165.It /modules/*_saver.ko 166screen saver modules 167.It /modules/vesa.ko 168the VESA support module 169.El 170.Sh EXAMPLE | 151.\".Sh DRIVER CONFIGURATION 152.Sh FILES 153.Bl -tag -width /modules/splash_xxxx.ko -compact 154.It /boot/loader.rc 155boot loader script 156.It /etc/rc.conf 157system configuration information 158.It /modules/splash_*.ko 159splash image decoder modules 160.It /modules/*_saver.ko 161screen saver modules 162.It /modules/vesa.ko 163the VESA support module 164.El 165.Sh EXAMPLE |
| 166In order to load the splash screen or the screen saver, you must 167have the following line in the kernel configuration file. 168.Pp 169.Dl pseudo-device splash 170.Pp |
|
| 171The following examples show how to load the splash screen image from 172the boot loader prompt. 173They may be typed by hand at the loader prompt or may be written in 174the boot loader script 175.Pa /boot/loader.rc 176.Pq see Xr loader.rc 5 . 177.Bd -literal -offset indent 178load kernel --- 9 unchanged lines hidden (view full) --- 188.Fl t Ar splash_image_data 189in this line, as the splash image decoder module will search for 190this tag name when looking up the preloaded bitmap data. 191The third line loads the splash image decoder module 192.Pa splash_bmp . 193.Pp 194In the following example, the VESA module 195is loaded so that a bitmap file which cannot be displayed in standard | 171The following examples show how to load the splash screen image from 172the boot loader prompt. 173They may be typed by hand at the loader prompt or may be written in 174the boot loader script 175.Pa /boot/loader.rc 176.Pq see Xr loader.rc 5 . 177.Bd -literal -offset indent 178load kernel --- 9 unchanged lines hidden (view full) --- 188.Fl t Ar splash_image_data 189in this line, as the splash image decoder module will search for 190this tag name when looking up the preloaded bitmap data. 191The third line loads the splash image decoder module 192.Pa splash_bmp . 193.Pp 194In the following example, the VESA module 195is loaded so that a bitmap file which cannot be displayed in standard |
| 196VGA modes may be shown using one of VESA video modes. | 196VGA modes may be shown using one of the VESA video modes. |
| 197.Bd -literal -offset indent 198load kernel 199load vesa 200load -t splash_image_data chuck.bmp 201load splash_bmp 202.Ed 203.Pp 204If the VESA support is statically linked to the kernel, it is not 205necessary to load the VESA module. 206Just load the bitmap file and the splash decoder module as in the 207first example above. 208.\".Sh DIAGNOSTICS 209.Sh CAVEATS 210Both the splash screen and the screen saver work with 211.Xr syscons 4 212only. They are not available for the alternative console driver 213.Xr pcvt 4 . 214.Sh BUGS 215If you load a screen saver while another screen saver has already | 197.Bd -literal -offset indent 198load kernel 199load vesa 200load -t splash_image_data chuck.bmp 201load splash_bmp 202.Ed 203.Pp 204If the VESA support is statically linked to the kernel, it is not 205necessary to load the VESA module. 206Just load the bitmap file and the splash decoder module as in the 207first example above. 208.\".Sh DIAGNOSTICS 209.Sh CAVEATS 210Both the splash screen and the screen saver work with 211.Xr syscons 4 212only. They are not available for the alternative console driver 213.Xr pcvt 4 . 214.Sh BUGS 215If you load a screen saver while another screen saver has already |
| 216been loaded, the first screen saver won't be automatically unloaded 217and remain in memory, wasting kernel memory space. | 216been loaded, the first screen saver will not be automatically unloaded 217and will remain in memory, wasting kernel memory space. |
| 218.Sh SEE ALSO 219.Xr vidcontrol 1 , | 218.Sh SEE ALSO 219.Xr vidcontrol 1 , |
| 220.Xr syscons 4 , |
|
| 220.Xr vga 4 , 221.Xr rc.conf 5 , 222.Xr kldload 8 , 223.Xr kldunload 8 . 224.Sh HISTORY 225The 226.Nm 227driver first appeared in 228.Fx 3.1 . 229.Sh AUTHORS 230The 231.Nm 232driver and this manual page were written by 233.An Kazutaka Yokota Aq yokota@FreeBSD.org . | 221.Xr vga 4 , 222.Xr rc.conf 5 , 223.Xr kldload 8 , 224.Xr kldunload 8 . 225.Sh HISTORY 226The 227.Nm 228driver first appeared in 229.Fx 3.1 . 230.Sh AUTHORS 231The 232.Nm 233driver and this manual page were written by 234.An Kazutaka Yokota Aq yokota@FreeBSD.org . |
| 235The 236.Pa splash_bmp 237module was written by 238.An Michael Smith Aq msmith@FreeBSD.org 239and 240.An Kazutaka Yokota . |
|