1*ca987d46SWarner Losh.\" Copyright (c) 2011-2013 Devin Teske 2*ca987d46SWarner Losh.\" All rights reserved. 3*ca987d46SWarner Losh.\" 4*ca987d46SWarner Losh.\" Redistribution and use in source and binary forms, with or without 5*ca987d46SWarner Losh.\" modification, are permitted provided that the following conditions 6*ca987d46SWarner Losh.\" are met: 7*ca987d46SWarner Losh.\" 1. Redistributions of source code must retain the above copyright 8*ca987d46SWarner Losh.\" notice, this list of conditions and the following disclaimer. 9*ca987d46SWarner Losh.\" 2. Redistributions in binary form must reproduce the above copyright 10*ca987d46SWarner Losh.\" notice, this list of conditions and the following disclaimer in the 11*ca987d46SWarner Losh.\" documentation and/or other materials provided with the distribution. 12*ca987d46SWarner Losh.\" 13*ca987d46SWarner Losh.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND 14*ca987d46SWarner Losh.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15*ca987d46SWarner Losh.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16*ca987d46SWarner Losh.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE 17*ca987d46SWarner Losh.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18*ca987d46SWarner Losh.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19*ca987d46SWarner Losh.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20*ca987d46SWarner Losh.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21*ca987d46SWarner Losh.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22*ca987d46SWarner Losh.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23*ca987d46SWarner Losh.\" SUCH DAMAGE. 24*ca987d46SWarner Losh.\" 25*ca987d46SWarner Losh.Dd August 6, 2013 26*ca987d46SWarner Losh.Dt COLOR.4TH 8 27*ca987d46SWarner Losh.Os 28*ca987d46SWarner Losh.Sh NAME 29*ca987d46SWarner Losh.Nm color.4th 30*ca987d46SWarner Losh.Nd FreeBSD color-detection boot module 31*ca987d46SWarner Losh.Sh DESCRIPTION 32*ca987d46SWarner LoshThe file that goes by the name of 33*ca987d46SWarner Losh.Nm 34*ca987d46SWarner Loshis a set of commands designed to simplify color logic. 35*ca987d46SWarner LoshThe commands of 36*ca987d46SWarner Losh.Nm 37*ca987d46SWarner Loshby themselves are not enough for most uses. 38*ca987d46SWarner LoshPlease refer to the 39*ca987d46SWarner Loshexamples below for the most common situations, and to 40*ca987d46SWarner Losh.Xr loader 8 41*ca987d46SWarner Loshfor additional commands. 42*ca987d46SWarner Losh.Pp 43*ca987d46SWarner LoshBefore using any of the commands provided in 44*ca987d46SWarner Losh.Nm , 45*ca987d46SWarner Loshit must be included 46*ca987d46SWarner Loshthrough the command: 47*ca987d46SWarner Losh.Pp 48*ca987d46SWarner Losh.Dl include color.4th 49*ca987d46SWarner Losh.Pp 50*ca987d46SWarner LoshThis line is present in 51*ca987d46SWarner Losh.Pa /boot/loader.4th 52*ca987d46SWarner Loshfile, so it is not needed (and should not be re-issued) in a normal setup. 53*ca987d46SWarner Losh.Pp 54*ca987d46SWarner LoshThe commands provided by it are: 55*ca987d46SWarner Losh.Pp 56*ca987d46SWarner Losh.Bl -tag -width disable-module_module -compact -offset indent 57*ca987d46SWarner Losh.It Ic loader_color? 58*ca987d46SWarner LoshReturns FALSE if the 59*ca987d46SWarner Losh.Ic loader_color 60*ca987d46SWarner Loshenvironment variable is set to 61*ca987d46SWarner Losh.Dq NO 62*ca987d46SWarner Losh(case-insensitive) or 63*ca987d46SWarner Losh.Dq 0 . 64*ca987d46SWarner LoshOtherwise returns TRUE 65*ca987d46SWarner Losh.Pq unless booting serial . 66*ca987d46SWarner Losh.El 67*ca987d46SWarner Losh.Pp 68*ca987d46SWarner LoshThe environment variables that effect its behavior are: 69*ca987d46SWarner Losh.Bl -tag -width bootfile -offset indent 70*ca987d46SWarner Losh.It Va loader_color 71*ca987d46SWarner LoshIf set to 72*ca987d46SWarner Losh.Dq NO 73*ca987d46SWarner Losh(case-insensitive) or 74*ca987d46SWarner Losh.Dq 0 , 75*ca987d46SWarner Loshcauses 76*ca987d46SWarner Losh.Ic loader_color? 77*ca987d46SWarner Loshto return FALSE, indicating to many modules that color should not be used. 78*ca987d46SWarner Losh.El 79*ca987d46SWarner Losh.Sh FILES 80*ca987d46SWarner Losh.Bl -tag -width /boot/loader.4th -compact 81*ca987d46SWarner Losh.It Pa /boot/loader 82*ca987d46SWarner LoshThe 83*ca987d46SWarner Losh.Xr loader 8 . 84*ca987d46SWarner Losh.It Pa /boot/color.4th 85*ca987d46SWarner Losh.Nm 86*ca987d46SWarner Loshitself. 87*ca987d46SWarner Losh.It Pa /boot/loader.rc 88*ca987d46SWarner Losh.Xr loader 8 89*ca987d46SWarner Loshbootstrapping script. 90*ca987d46SWarner Losh.El 91*ca987d46SWarner Losh.Sh EXAMPLES 92*ca987d46SWarner LoshStandard i386 93*ca987d46SWarner Losh.Pa /boot/loader.rc : 94*ca987d46SWarner Losh.Pp 95*ca987d46SWarner LoshUse color where applicable: 96*ca987d46SWarner Losh.Pp 97*ca987d46SWarner Losh.Bd -literal -offset indent -compact 98*ca987d46SWarner Loshloader_color="YES" 99*ca987d46SWarner Losh.Ed 100*ca987d46SWarner Losh.Sh SEE ALSO 101*ca987d46SWarner Losh.Xr loader.conf 5 , 102*ca987d46SWarner Losh.Xr loader 8 , 103*ca987d46SWarner Losh.Xr loader.4th 8 104*ca987d46SWarner Losh.Sh HISTORY 105*ca987d46SWarner LoshThe 106*ca987d46SWarner Losh.Nm 107*ca987d46SWarner Loshset of commands first appeared in 108*ca987d46SWarner Losh.Fx 9.0 . 109*ca987d46SWarner Losh.Sh AUTHORS 110*ca987d46SWarner LoshThe 111*ca987d46SWarner Losh.Nm 112*ca987d46SWarner Loshset of commands was written by 113*ca987d46SWarner Losh.An -nosplit 114*ca987d46SWarner Losh.An Devin Teske Aq dteske@FreeBSD.org . 115