1*bbf21555SRichard Lowe.\" Copyright (c) 2011 Devin Teske 2*bbf21555SRichard Lowe.\" All rights reserved. 3*bbf21555SRichard Lowe.\" 4*bbf21555SRichard Lowe.\" Redistribution and use in source and binary forms, with or without 5*bbf21555SRichard Lowe.\" modification, are permitted provided that the following conditions 6*bbf21555SRichard Lowe.\" are met: 7*bbf21555SRichard Lowe.\" 1. Redistributions of source code must retain the above copyright 8*bbf21555SRichard Lowe.\" notice, this list of conditions and the following disclaimer. 9*bbf21555SRichard Lowe.\" 2. Redistributions in binary form must reproduce the above copyright 10*bbf21555SRichard Lowe.\" notice, this list of conditions and the following disclaimer in the 11*bbf21555SRichard Lowe.\" documentation and/or other materials provided with the distribution. 12*bbf21555SRichard Lowe.\" 13*bbf21555SRichard Lowe.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14*bbf21555SRichard Lowe.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15*bbf21555SRichard Lowe.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16*bbf21555SRichard Lowe.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17*bbf21555SRichard Lowe.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18*bbf21555SRichard Lowe.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19*bbf21555SRichard Lowe.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20*bbf21555SRichard Lowe.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21*bbf21555SRichard Lowe.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22*bbf21555SRichard Lowe.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23*bbf21555SRichard Lowe.\" SUCH DAMAGE. 24*bbf21555SRichard Lowe.\" 25*bbf21555SRichard Lowe.Dd July 20, 2018 26*bbf21555SRichard Lowe.Dt BRAND.4TH 7 27*bbf21555SRichard Lowe.Os 28*bbf21555SRichard Lowe.Sh NAME 29*bbf21555SRichard Lowe.Nm brand.4th 30*bbf21555SRichard Lowe.Nd loader ASCII art boot module 31*bbf21555SRichard Lowe.Sh DESCRIPTION 32*bbf21555SRichard LoweThe file that goes by the name of 33*bbf21555SRichard Lowe.Nm 34*bbf21555SRichard Loweis a set of commands designed to draw the ASCII art illumos brand above the 35*bbf21555SRichard Loweboot loader menu. 36*bbf21555SRichard LoweThe commands of 37*bbf21555SRichard Lowe.Nm 38*bbf21555SRichard Loweby themselves are not enough for most uses. 39*bbf21555SRichard LowePlease refer to the 40*bbf21555SRichard Loweexamples below for the most common situations, and to 41*bbf21555SRichard Lowe.Xr loader 7 42*bbf21555SRichard Lowefor additional commands. 43*bbf21555SRichard Lowe.Pp 44*bbf21555SRichard LoweBefore using any of the commands provided in 45*bbf21555SRichard Lowe.Nm , 46*bbf21555SRichard Loweit must be included 47*bbf21555SRichard Lowethrough the command: 48*bbf21555SRichard Lowe.Pp 49*bbf21555SRichard Lowe.Dl include brand.4th 50*bbf21555SRichard Lowe.Pp 51*bbf21555SRichard LoweThis line is present in the default 52*bbf21555SRichard Lowe.Pa /boot/forth/menu.rc 53*bbf21555SRichard Lowefile, so it is not needed (and should not be re-issued) in a normal setup. 54*bbf21555SRichard Lowe.Pp 55*bbf21555SRichard LoweThe commands provided by it are: 56*bbf21555SRichard Lowe.Pp 57*bbf21555SRichard Lowe.Bl -tag -width disable-module_module -compact -offset indent 58*bbf21555SRichard Lowe.It Ic draw-brand 59*bbf21555SRichard LoweDraws the illumos brand. 60*bbf21555SRichard Lowe.Pp 61*bbf21555SRichard LoweThe brand that is drawn is configured by setting the 62*bbf21555SRichard Lowe.Ic loader_brand 63*bbf21555SRichard Lowevariable in 64*bbf21555SRichard Lowe.Xr loader.conf 5 65*bbf21555SRichard Loweto one of 66*bbf21555SRichard Lowe.Dq Li illumos 67*bbf21555SRichard Lowe(the default) or 68*bbf21555SRichard Lowe.Dq Li none . 69*bbf21555SRichard Lowe.Pp 70*bbf21555SRichard LoweThe position of the logo can be configured by setting the 71*bbf21555SRichard Lowe.Ic loader_brand_x 72*bbf21555SRichard Loweand 73*bbf21555SRichard Lowe.Ic loader_brand_y 74*bbf21555SRichard Lowevariables in 75*bbf21555SRichard Lowe.Xr loader.conf 5 . 76*bbf21555SRichard LoweThe default values are 2 (x) and 1 (y). 77*bbf21555SRichard Lowe.El 78*bbf21555SRichard Lowe.Pp 79*bbf21555SRichard LoweThe environment variables that effect its behavior are: 80*bbf21555SRichard Lowe.Bl -tag -width bootfile -offset indent 81*bbf21555SRichard Lowe.It Va loader_brand 82*bbf21555SRichard LoweSelects the desired brand in the beastie boot menu. 83*bbf21555SRichard LowePossible values are: 84*bbf21555SRichard Lowe.Dq Li illumos 85*bbf21555SRichard Lowe(default) or 86*bbf21555SRichard Lowe.Dq Li none . 87*bbf21555SRichard Lowe.It Va loader_brand_x 88*bbf21555SRichard LoweSets the desired column position of the brand. 89*bbf21555SRichard LoweDefault is 2. 90*bbf21555SRichard Lowe.It Va loader_brand_y 91*bbf21555SRichard LoweSets the desired row position of the brand. 92*bbf21555SRichard LoweDefault is 1. 93*bbf21555SRichard Lowe.El 94*bbf21555SRichard Lowe.Sh FILES 95*bbf21555SRichard Lowe.Bl -tag -width /boot/forth/loader.4th -compact 96*bbf21555SRichard Lowe.It Pa /boot/loader 97*bbf21555SRichard LoweThe 98*bbf21555SRichard Lowe.Xr loader 7 . 99*bbf21555SRichard Lowe.It Pa /boot/forth/brand.4th 100*bbf21555SRichard Lowe.Nm 101*bbf21555SRichard Loweitself. 102*bbf21555SRichard Lowe.It Pa /boot/loader.rc 103*bbf21555SRichard Lowe.Xr loader 7 104*bbf21555SRichard Lowebootstrapping script. 105*bbf21555SRichard Lowe.El 106*bbf21555SRichard Lowe.Sh EXAMPLES 107*bbf21555SRichard LoweSet illumos brand in 108*bbf21555SRichard Lowe.Xr loader.conf 5 : 109*bbf21555SRichard Lowe.Pp 110*bbf21555SRichard Lowe.Bd -literal -offset indent -compact 111*bbf21555SRichard Loweloader_brand="illumos" 112*bbf21555SRichard Lowe.Ed 113*bbf21555SRichard Lowe.Sh SEE ALSO 114*bbf21555SRichard Lowe.Xr loader.conf 5 , 115*bbf21555SRichard Lowe.Xr loader 7 116