sys/boot/forth/beastie.4th.8

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