share/man/man5/brand.4th.5

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