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