1 .\" Copyright (c) 2011-2012 Devin Teske
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .Nd FreeBSD ASCII art boot module
34 The file that goes by the name of
36 is a set of commands designed to draw the ASCII art FreeBSD mascot
39 \(en to the right of the boot loader menu.
42 by themselves are not enough for most uses.
44 examples below for the most common situations, and to
46 for additional commands.
48 Before using any of the commands provided in
53 .Dl include beastie.4th
55 This line is present in the default
57 file, so it is not needed (and should not be re-issued) in a normal setup.
59 The commands provided by it are:
61 .Bl -tag -width disable-module_module -compact -offset indent
63 Draws the FreeBSD logo.
65 The logo that is drawn is configured by setting the
78 The position of the logo can be configured by setting the
84 The default values are 46 (x) and 4 (y).
87 Clears the screen of beastie.
90 Initializes the interactive boot loader menu.
94 variable can be configured in
96 to the number of seconds you would like to delay loading the boot menu.
97 During the delay the user can press Ctrl-C to fall back to
100 The default behavior is to not delay.
103 The environment variables that effect its behavior are:
104 .Bl -tag -width bootfile -offset indent
106 Selects the desired logo in the beastie boot menu.
116 Sets the desired column position of the logo.
119 Sets the desired row position of the logo.
121 .It Va beastie_disable
124 the beastie boot menu will be skipped.
125 The beastie boot menu is always skipped if running non-x86 hardware.
127 If set to a number higher than zero, introduces a delay before starting the
129 During the delay the user can press either Ctrl-C to skip the menu or ENTER
130 to proceed to the menu.
131 The default is to not delay when loading the menu.
134 .Bl -tag -width /boot/loader.4th -compact
138 .It Pa /boot/beastie.4th
141 .It Pa /boot/loader.rc
143 bootstrapping script.
147 .Pa /boot/loader.rc :
149 .Bd -literal -offset indent -compact
150 include /boot/beastie.4th
154 Set a different logo in
157 .Bd -literal -offset indent -compact
158 loader_logo="beastie"
167 set of commands first appeared in
172 set of commands was written by
174 .An Scott Long Aq scottl@FreeBSD.org ,
175 .An Aleksander Fafula Aq alex@fafula.com
177 .An Devin Teske Aq dteske@FreeBSD.org .