diff options
Diffstat (limited to 'static/freebsd/man4/splash.4 3.html')
| -rw-r--r-- | static/freebsd/man4/splash.4 3.html | 260 |
1 files changed, 0 insertions, 260 deletions
diff --git a/static/freebsd/man4/splash.4 3.html b/static/freebsd/man4/splash.4 3.html deleted file mode 100644 index ed33cd45..00000000 --- a/static/freebsd/man4/splash.4 3.html +++ /dev/null @@ -1,260 +0,0 @@ -<table class="head"> - <tr> - <td class="head-ltitle">SPLASH(4)</td> - <td class="head-vol">Device Drivers Manual</td> - <td class="head-rtitle">SPLASH(4)</td> - </tr> -</table> -<div class="manual-text"> -<section class="Sh"> -<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1> -<p class="Pp"><code class="Nm">splash</code> — <span class="Nd">splash - screen / screen saver interface</span></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1> -<p class="Pp"><code class="Cd">device splash</code></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1> -<p class="Pp">The <code class="Nm">splash</code> pseudo device driver adds - support for the splash screen and screen savers to the kernel. This driver - is required if the splash bitmap image is to be loaded or any screen saver - is to be used.</p> -<section class="Ss"> -<h2 class="Ss" id="Splash_screen"><a class="permalink" href="#Splash_screen">Splash - screen</a></h2> -<p class="Pp">You can load and display an arbitrary bitmap image file as a - welcome banner on the screen when the system is about to start. This image - will remain on the screen during kernel initialization process until the - login prompt appears on the screen or until a screen saver is loaded and - initialized. The image will also disappear if you hit any key, although this - may not work immediately if the kernel is still probing devices.</p> -<p class="Pp">If you specify the <code class="Fl">-c</code> or - <code class="Fl">-v</code> boot option when loading the kernel, the splash - image will not appear. However, it is still loaded and can be used as a - screen saver later: see below.</p> -<p class="Pp">In order to display the bitmap, the bitmap file itself and the - matching splash image decoder module must be loaded by the boot loader. - Currently the following decoder modules are available:</p> -<p class="Pp"></p> -<dl class="Bl-tag Bl-compact"> - <dt><span class="Pa">splash_bmp.ko</span></dt> - <dd>Windows BMP file decoder. While the BMP file format allows images of - various color depths, this decoder currently only handles 256 color - bitmaps. Bitmaps of other color depths will not be displayed.</dd> - <dt><span class="Pa">splash_pcx.ko</span></dt> - <dd>ZSoft PCX decoder. This decoder currently only supports version 5 8-bpp - single-plane images.</dd> - <dt><span class="Pa">splash_txt.ko</span></dt> - <dd>TheDraw binary ASCII drawing file decoder. Displays a text-mode 80x25 - ASCII drawing, such as that produced by the Binary save format in TheDraw. - This format consists of a sequence of two byte pairs representing the - 80x25 display, where the first byte is the ASCII character to draw and the - second byte indicates the colors/attributes to use when drawing the - character.</dd> -</dl> -<p class="Pp">The <a class="Sx" href="#EXAMPLES">EXAMPLES</a> section - illustrates how to set up the splash screen.</p> -<p class="Pp">If the standard VGA video mode is used, the size of the bitmap - must be 320x200 or less. If you enable the VESA mode support in the kernel, - either by statically linking the VESA module or by loading the VESA module - (see <a class="Xr">vga(4)</a>), you can load bitmaps up to a resolution of - 1024x768, depending on the VESA BIOS and the amount of video memory on the - video card.</p> -</section> -<section class="Ss"> -<h2 class="Ss" id="Screen_saver"><a class="permalink" href="#Screen_saver">Screen - saver</a></h2> -<p class="Pp">The screen saver will activate when the system is considered idle: - i.e. when the user has not typed a key or moved the mouse for a specified - period of time. As the screen saver is an optional module, it must be - explicitly loaded into memory. Currently the following screen saver modules - are available:</p> -<p class="Pp"></p> -<dl class="Bl-tag Bl-compact"> - <dt><span class="Pa">blank_saver.ko</span></dt> - <dd>This screen saver simply blanks the screen.</dd> - <dt><span class="Pa">beastie_saver.ko</span></dt> - <dd>Animated graphical <span class="Ux">BSD</span> Daemon.</dd> - <dt><span class="Pa">daemon_saver.ko</span></dt> - <dd>Animated <span class="Ux">BSD</span> Daemon screen saver.</dd> - <dt><span class="Pa">dragon_saver.ko</span></dt> - <dd>Draws a random dragon curve.</dd> - <dt><span class="Pa">fade_saver.ko</span></dt> - <dd>The screen will gradually fade away.</dd> - <dt><span class="Pa">fire_saver.ko</span></dt> - <dd>A fire which becomes higher as load increases.</dd> - <dt><span class="Pa">green_saver.ko</span></dt> - <dd>The screen will be blanked, similar to - <span class="Pa">blank_saver.ko</span>. If the monitor and the video - card's BIOS support it the screen will also be powered off.</dd> - <dt><span class="Pa">logo_saver.ko</span></dt> - <dd>Animated graphical <span class="Ux">FreeBSD</span> logo.</dd> - <dt><span class="Pa">plasma_saver.ko</span></dt> - <dd>Draws an animated interference pattern.</dd> - <dt><span class="Pa">rain_saver.ko</span></dt> - <dd>Draws a shower on the screen.</dd> - <dt><span class="Pa">snake_saver.ko</span></dt> - <dd>Draws a snake of string.</dd> - <dt><span class="Pa">star_saver.ko</span></dt> - <dd>Twinkling stars.</dd> - <dt><span class="Pa">warp_saver.ko</span></dt> - <dd>Streaking stars.</dd> -</dl> -<p class="Pp">Screen saver modules can be loaded using - <a class="Xr">kldload(8)</a>:</p> -<p class="Pp"></p> -<div class="Bd Bd-indent"><code class="Li">kldload logo_saver</code></div> -<p class="Pp">The timeout value in seconds can be specified as follows:</p> -<p class="Pp"></p> -<div class="Bd Bd-indent"><code class="Li">vidcontrol -t N</code></div> -<p class="Pp">Alternatively, you can set the <var class="Ar">saver</var> - variable in the <span class="Pa">/etc/rc.conf</span> to the screen saver of - your choice and the timeout value to the <var class="Ar">blanktime</var> - variable so that the screen saver is automatically loaded and the timeout - value is set when the system starts.</p> -<p class="Pp" id="Shift-Pause">The screen saver may be instantly activated by - hitting the <var class="Ar">saver</var> key: the defaults are - <a class="permalink" href="#Shift-Pause"><i class="Em">Shift-Pause</i></a> - on the AT enhanced keyboard and - <a class="permalink" href="#Shift-Ctrl-NumLock/Pause"><i class="Em" id="Shift-Ctrl-NumLock/Pause">Shift-Ctrl-NumLock/Pause</i></a> - on the AT 84 keyboard. You can change the <var class="Ar">saver</var> key by - modifying the keymap (see <a class="Xr">kbdcontrol(1)</a>, - <a class="Xr">keymap(5)</a>), and assign the <var class="Ar">saver</var> - function to a key of your preference.</p> -<p class="Pp">The screen saver will not run if the screen is not in text - mode.</p> -</section> -<section class="Ss"> -<h2 class="Ss" id="Splash_screen_as_a_screen_saver"><a class="permalink" href="#Splash_screen_as_a_screen_saver">Splash - screen as a screen saver</a></h2> -<p class="Pp">If you load a splash image but do not load a screen saver, you can - continue using the splash module as a screen saver. The screen blanking - interval can be specified as described in the - <a class="Sx" href="#Screen_saver">Screen saver</a> section above.</p> -</section> -</section> -<section class="Sh"> -<h1 class="Sh" id="FILES"><a class="permalink" href="#FILES">FILES</a></h1> -<dl class="Bl-tag Bl-compact"> - <dt><span class="Pa">/boot/defaults/loader.conf</span></dt> - <dd>boot loader configuration defaults</dd> - <dt><span class="Pa">/etc/rc.conf</span></dt> - <dd>system configuration information</dd> - <dt><span class="Pa">/boot/kernel/splash_*.ko</span></dt> - <dd>splash image decoder modules</dd> - <dt><span class="Pa">/boot/kernel/*_saver.ko</span></dt> - <dd>screen saver modules</dd> - <dt><span class="Pa">/boot/kernel/vesa.ko</span></dt> - <dd>the VESA support module</dd> -</dl> -</section> -<section class="Sh"> -<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1> -<p class="Pp">In order to load the splash screen or the screen saver, you must - have the following line in the kernel configuration file.</p> -<p class="Pp"></p> -<div class="Bd Bd-indent"><code class="Li">device splash</code></div> -<p class="Pp">Next for <a class="Xr">syscons(4)</a>, edit - <span class="Pa">/boot/loader.conf</span> (see - <a class="Xr">loader.conf(5)</a>) and include the following lines:</p> -<div class="Bd Pp Bd-indent Li"> -<pre>splash_bmp_load="YES" -bitmap_load="YES" -bitmap_name="/boot/chuck.bmp"</pre> -</div> -<p class="Pp">In the above example, the file - <span class="Pa">/boot/chuck.bmp</span> is loaded. In the following example, - the VESA module is loaded so that a bitmap file which cannot be displayed in - standard VGA modes may be shown using one of the VESA video modes.</p> -<div class="Bd Pp Bd-indent Li"> -<pre>splash_pcx_load="YES" -vesa_load="YES" -bitmap_load="YES" -bitmap_name="/boot/chuck.pcx"</pre> -</div> -<p class="Pp">If the VESA support is statically linked to the kernel, it is not - necessary to load the VESA module. Just load the bitmap file and the splash - decoder module as in the first example above.</p> -<p class="Pp">To load a binary ASCII drawing and display this while booting, - include the following into your - <span class="Pa">/boot/loader.conf</span>:</p> -<div class="Bd Pp Bd-indent Li"> -<pre>splash_txt_load="YES" -bitmap_load="YES" -bitmap_name="/boot/splash.bin"</pre> -</div> -<p class="Pp">For <a class="Xr">vt(4)</a>, edit - <span class="Pa">/boot/loader.conf</span> (see - <a class="Xr">loader.conf(5)</a>) and include the following lines:</p> -<div class="Bd Pp Bd-indent Li"> -<pre>splash="/boot/images/freebsd-logo-rev.png" -boot_mute="YES"</pre> -</div> -<p class="Pp">A splash screen to be displayed at shutdown time can be specified - with:</p> -<div class="Bd Pp Bd-indent Li"> -<pre>shutdown_splash="/boot/images/freebsd-logo-rev.png" -boot_mute="YES"</pre> -</div> -</section> -<section class="Sh"> -<h1 class="Sh" id="SEE_ALSO"><a class="permalink" href="#SEE_ALSO">SEE - ALSO</a></h1> -<p class="Pp"><a class="Xr">vidcontrol(1)</a>, <a class="Xr">syscons(4)</a>, - <a class="Xr">vga(4)</a>, <a class="Xr">loader.conf(5)</a>, - <a class="Xr">rc.conf(5)</a>, <a class="Xr">kldload(8)</a>, - <a class="Xr">kldunload(8)</a></p> -</section> -<section class="Sh"> -<h1 class="Sh" id="HISTORY"><a class="permalink" href="#HISTORY">HISTORY</a></h1> -<p class="Pp">The <code class="Nm">splash</code> driver first appeared in - <span class="Ux">FreeBSD 3.1</span>.</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="AUTHORS"><a class="permalink" href="#AUTHORS">AUTHORS</a></h1> -<p class="Pp">The <code class="Nm">splash</code> driver and this manual page - were written by <span class="An">Kazutaka Yokota</span> - <<a class="Mt" href="mailto:yokota@FreeBSD.org">yokota@FreeBSD.org</a>>. - The <span class="Pa">splash_bmp</span> module was written by - <span class="An">Michael Smith</span> - <<a class="Mt" href="mailto:msmith@FreeBSD.org">msmith@FreeBSD.org</a>> - and <span class="An">Kazutaka Yokota</span>. The - <span class="Pa">splash_pcx</span> module was written by - <span class="An">Dag-Erling Smørgrav</span> - <<a class="Mt" href="mailto:des@FreeBSD.org">des@FreeBSD.org</a>> - based on the <span class="Pa">splash_bmp</span> code. The - <span class="Pa">splash_txt</span> module was written by - <span class="An">Antony Mawer</span> - <<a class="Mt" href="mailto:antony@mawer.org">antony@mawer.org</a>> - based on the <span class="Pa">splash_bmp</span> code, with some additional - inspiration from the <span class="Pa">daemon_saver</span> code. The - <span class="Pa">logo_saver</span>, <span class="Pa">plasma_saver</span>, - <span class="Pa">rain_saver</span> and <span class="Pa">warp_saver</span> - modules were written by <span class="An">Dag-Erling Smørgrav</span> - <<a class="Mt" href="mailto:des@FreeBSD.org">des@FreeBSD.org</a>>. - <span class="Pa">splash</span> png support for <a class="Xr">vt(4)</a> was - written by <span class="An">Emmanuel Vadot</span> - <<a class="Mt" href="mailto:manu@FreeBSD.org">manu@FreeBSD.org</a>> - and extended for shutdown by <span class="An">Quentin Thébault</span> - <<a class="Mt" href="mailto:quentin.thebault@defenso.fr">quentin.thebault@defenso.fr</a>>.</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="CAVEATS"><a class="permalink" href="#CAVEATS">CAVEATS</a></h1> -<p class="Pp">The screen saver works with <a class="Xr">syscons(4)</a> only.</p> -<p class="Pp">For vt splash screen, only RGBA png are supported.</p> -</section> -<section class="Sh"> -<h1 class="Sh" id="BUGS"><a class="permalink" href="#BUGS">BUGS</a></h1> -<p class="Pp">If you load a screen saver while another screen saver has already - been loaded, the first screen saver will not be automatically unloaded and - will remain in memory, wasting kernel memory space.</p> -</section> -</div> -<table class="foot"> - <tr> - <td class="foot-date">April 3, 2026</td> - <td class="foot-os">FreeBSD 15.0</td> - </tr> -</table> |