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

   1 .\" Copyright (c) 2011 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 18, 2011
  28 .Dt BRAND.4TH 8
  29 .Os
  30 .Sh NAME
  31 .Nm brand.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 BSD brand above the boot
  37 loader menu.
  38 The commands of
  39 .Nm
  40 by themselves are not enough for most uses.
  41 Please refer to the
  42 examples below for the most common situations, and to
  43 .Xr loader 8
  44 for additional commands.
  45 .Pp
  46 Before using any of the commands provided in
  47 .Nm ,
  48 it must be included
  49 through the command:
  50 .Pp
  51 .Dl include brand.4th
  52 .Pp
  53 This line is present in the default
  54 .Pa /boot/menu.rc
  55 file, so it is not needed (and should not be re-issued) in a normal setup.
  56 .Pp
  57 The commands provided by it are:
  58 .Pp
  59 .Bl -tag -width disable-module_module -compact -offset indent
  60 .It Ic draw-brand
  61 Draws the BSD brand.
  62 .Pp
  63 The brand that is drawn is configured by setting the
  64 .Ic loader_brand
  65 variable in
  66 .Xr loader.conf 5
  67 to one of
  68 .Dq Li fbsd
  69 (the default) or
  70 .Dq Li none .
  71 .Pp
  72 The position of the logo can be configured by setting the
  73 .Ic loader_brand_x
  74 and
  75 .Ic loader_brand_y
  76 variables in
  77 .Xr loader.conf 5 .
  78 The default values are 2 (x) and 1 (y).
  79 .El
  80 .Pp
  81 The environment variables that effect its behavior are:
  82 .Bl -tag -width bootfile -offset indent
  83 .It Va loader_brand
  84 Selects the desired brand in the beastie boot menu. Possible values are:
  85 .Dq Li fbsd
  86 (default) or
  87 .Dq Li none .
  88 .It Va loader_brand_x
  89 Sets the desired column position of the brand. Default is 2.
  90 .It Va loader_brand_y
  91 Sets the desired row position of the brand. Default is 1.
  92 .El
  93 .Sh FILES
  94 .Bl -tag -width /boot/loader.4th -compact
  95 .It Pa /boot/loader
  96 The
  97 .Xr loader 8 .
  98 .It Pa /boot/brand.4th
  99 .Nm
 100 itself.
 101 .It Pa /boot/loader.rc
 102 .Xr loader 8
 103 bootstrapping script.
 104 .El
 105 .Sh EXAMPLES
 106 Set FreeBSD brand in
 107 .Xr loader.conf 5 :
 108 .Pp
 109 .Bd -literal -offset indent -compact
 110 loader_brand="fbsd"
 111 .Ed
 112 .Sh SEE ALSO
 113 .Xr loader.conf 5 ,
 114 .Xr loader 8 ,
 115 .Sh HISTORY
 116 The
 117 .Nm
 118 set of commands first appeared in
 119 .Fx 9.0 .
 120 .Sh AUTHORS
 121 The
 122 .Nm
 123 set of commands was written by
 124 .An -nosplit
 125 .An Devin Teske Aq dteske@FreeBSD.org .