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