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