1.\" Copyright (c) 2011-2012 Devin Teske 2.\" All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.Dd July 20, 2018 26.Dt BEASTIE.4TH 7 27.Os 28.Sh NAME 29.Nm beastie.4th 30.Nd loader ASCII art boot module 31.Sh DESCRIPTION 32The file that goes by the name of 33.Nm 34is a set of commands designed to draw the ASCII art FreeBSD mascot 35\(en known simply as 36.Em beastie 37\(en to the right of the boot loader menu. 38In illumos based systems, the distribution specific logo is used. 39The commands of 40.Nm 41by themselves are not enough for most uses. 42Please refer to the 43examples below for the most common situations, and to 44.Xr loader 7 45for additional commands. 46.Pp 47Before using any of the commands provided in 48.Nm , 49it must be included 50through the command: 51.Pp 52.Dl include beastie.4th 53.Pp 54This line is present in the default 55.Pa /boot/loader.rc 56file, so it is not needed (and should not be re-issued) in a normal setup. 57.Pp 58The commands provided by it are: 59.Pp 60.Bl -tag -width disable-module_module -compact -offset indent 61.It Ic draw-beastie 62Draws the logo. 63.Pp 64The logo that is drawn is configured by setting the 65.Ic loader_logo 66variable in 67.Xr loader.conf 5 . 68.Pp 69The position of the logo can be configured by setting the 70.Ic loader_logo_x 71and 72.Ic loader_logo_y 73variables in 74.Xr loader.conf 5 . 75The default values are 46 (x) and 4 (y). 76.Pp 77.It Ic clear-beastie 78Clears the screen of beastie. 79.Pp 80.It Ic beastie-start 81Initializes the interactive boot loader menu. 82.Pp 83The 84.Ic loader_delay 85variable can be configured in 86.Xr loader.conf 5 87to the number of seconds you would like to delay loading the boot menu. 88During the delay the user can press Ctrl-C to fall back to 89.Ic autoboot 90or ENTER to proceed. 91The default behavior is to not delay. 92.El 93.Pp 94The environment variables that effect its behavior are: 95.Bl -tag -width bootfile -offset indent 96.It Va loader_logo 97Selects the desired logo in the beastie boot menu. 98.It Va loader_logo_x 99Sets the desired column position of the logo. 100Default is 46. 101.It Va loader_logo_y 102Sets the desired row position of the logo. 103Default is 4. 104.It Va beastie_disable 105If set to 106.Dq YES , 107the beastie boot menu will be skipped. 108The beastie boot menu is always skipped if running non-x86 hardware. 109.It Va loader_delay 110If set to a number higher than zero, introduces a delay before starting the 111beastie boot menu. 112During the delay the user can press either Ctrl-C to skip the menu or ENTER to 113proceed to the menu. 114The default is to not delay when loading the menu. 115.El 116.Sh FILES 117.Bl -tag -width /boot/forth/loader.4th -compact 118.It Pa /boot/loader 119The 120.Xr loader 7 . 121.It Pa /boot/forth/beastie.4th 122.Nm 123itself. 124.It Pa /boot/loader.rc 125.Xr loader 7 126bootstrapping script. 127.El 128.Sh EXAMPLES 129Standard i386 130.Pa /boot/loader.rc : 131.Pp 132.Bd -literal -offset indent -compact 133include /boot/forth/beastie.4th 134beastie-start 135.Ed 136.Pp 137Set a different logo in 138.Xr loader.conf 5 : 139.Pp 140.Bd -literal -offset indent -compact 141loader_logo="beastie" 142.Ed 143.Sh SEE ALSO 144.Xr loader.conf 5 , 145.Xr loader 7 , 146.Xr loader.4th 7 147