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.\" $FreeBSD$ 26.\" 27.Dd January 6, 2016 28.Dt BEASTIE.4TH 8 29.Os 30.Sh NAME 31.Nm beastie.4th 32.Nd FreeBSD ASCII art boot module 33.Sh DESCRIPTION 34The file that goes by the name of 35.Nm 36is a set of commands designed to draw the ASCII art FreeBSD mascot 37\(en known simply as 38.Em beastie 39\(en to the right of the boot loader menu. 40The commands of 41.Nm 42by themselves are not enough for most uses. 43Please refer to the 44examples below for the most common situations, and to 45.Xr loader 8 46for additional commands. 47.Pp 48Before using any of the commands provided in 49.Nm , 50it must be included 51through the command: 52.Pp 53.Dl include beastie.4th 54.Pp 55This line is present in the default 56.Pa /boot/loader.rc 57file, so it is not needed (and should not be re-issued) in a normal setup. 58.Pp 59The commands provided by it are: 60.Pp 61.Bl -tag -width disable-module_module -compact -offset indent 62.It Ic draw-beastie 63Draws the FreeBSD logo. 64.Pp 65The logo that is drawn is configured by setting the 66.Ic loader_logo 67variable in 68.Xr loader.conf 5 69to one of 70.Dq Li beastie , 71.Dq Li beastiebw , 72.Dq Li fbsdbw , 73.Dq Li orb , 74and 75.Dq Li orbbw 76(the default). 77.Pp 78The position of the logo can be configured by setting the 79.Ic loader_logo_x 80and 81.Ic loader_logo_y 82variables in 83.Xr loader.conf 5 . 84The default values are 46 (x) and 4 (y). 85.Pp 86.It Ic clear-beastie 87Clears the screen of beastie. 88.Pp 89.It Ic beastie-start 90Initializes the interactive boot loader menu. 91.Pp 92The 93.Ic loader_delay 94variable can be configured in 95.Xr loader.conf 5 96to the number of seconds you would like to delay loading the boot menu. 97During the delay the user can press Ctrl-C to fall back to 98.Ic autoboot 99or ENTER to proceed. 100The default behavior is to not delay. 101.El 102.Pp 103The environment variables that effect its behavior are: 104.Bl -tag -width bootfile -offset indent 105.It Va loader_logo 106Selects the desired logo in the beastie boot menu. 107Possible values are: 108.Dq Li fbsdbw , 109.Dq Li beastie , 110.Dq Li beastiebw , 111.Dq Li orb , 112.Dq Li orbbw 113(default), and 114.Dq Li none . 115.It Va loader_logo_x 116Sets the desired column position of the logo. 117Default is 46. 118.It Va loader_logo_y 119Sets the desired row position of the logo. 120Default is 4. 121.It Va beastie_disable 122If set to 123.Dq YES , 124the beastie boot menu will be skipped. 125The beastie boot menu is always skipped if running non-x86 hardware. 126.It Va loader_delay 127If set to a number higher than zero, introduces a delay before starting the 128beastie boot menu. 129During the delay the user can press either Ctrl-C to skip the menu or ENTER 130to proceed to the menu. 131The default is to not delay when loading the menu. 132.El 133.Sh FILES 134.Bl -tag -width /boot/loader.4th -compact 135.It Pa /boot/loader 136The 137.Xr loader 8 . 138.It Pa /boot/beastie.4th 139.Nm 140itself. 141.It Pa /boot/loader.rc 142.Xr loader 8 143bootstrapping script. 144.El 145.Sh EXAMPLES 146Standard i386 147.Pa /boot/loader.rc : 148.Pp 149.Bd -literal -offset indent -compact 150include /boot/beastie.4th 151beastie-start 152.Ed 153.Pp 154Set a different logo in 155.Xr loader.conf 5 : 156.Pp 157.Bd -literal -offset indent -compact 158loader_logo="beastie" 159.Ed 160.Sh SEE ALSO 161.Xr loader.conf 5 , 162.Xr loader 8 , 163.Xr loader.4th 8 164.Sh HISTORY 165The 166.Nm 167set of commands first appeared in 168.Fx 5.1 . 169.Sh AUTHORS 170The 171.Nm 172set of commands was written by 173.An -nosplit 174.An Scott Long Aq scottl@FreeBSD.org , 175.An Aleksander Fafula Aq alex@fafula.com 176and 177.An Devin Teske Aq dteske@FreeBSD.org . 178