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