All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
$FreeBSD$
.Dd August 6, 2013 .Dt COLOR.4TH 8 .Os .Sh NAME .Nm color.4th .Nd FreeBSD color-detection boot module .Sh DESCRIPTION The file that goes by the name of .Nm is a set of commands designed to simplify color logic. The commands of .Nm by themselves are not enough for most uses. Please refer to the examples below for the most common situations, and to .Xr loader 8 for additional commands.
p Before using any of the commands provided in .Nm , it must be included through the command:
p .Dl include color.4th
p This line is present in
a /boot/loader.4th file, so it is not needed (and should not be re-issued) in a normal setup.
p The commands provided by it are:
p l -tag -width disable-module_module -compact -offset indent t Ic loader_color? Returns FALSE if the c loader_color environment variable is set to .Dq NO (case-insensitive) or .Dq 0 . Otherwise returns TRUE
q unless booting serial . .El
p The environment variables that effect its behavior are: l -tag -width bootfile -offset indent t Va loader_color If set to .Dq NO (case-insensitive) or .Dq 0 , causes c loader_color? to return FALSE, indicating to many modules that color should not be used. .El .Sh FILES l -tag -width /boot/loader.4th -compact t Pa /boot/loader The .Xr loader 8 . t Pa /boot/color.4th .Nm itself. t Pa /boot/loader.rc .Xr loader 8 bootstrapping script. .El .Sh EXAMPLES Standard i386
p Use color where applicable:
p d -literal -offset indent -compact loader_color="YES" .Ed .Sh SEE ALSO .Xr loader.conf 5 , .Xr loader 8 , .Xr loader.4th 8 .Sh HISTORY The .Nm set of commands first appeared in .Fx 9.0 . .Sh AUTHORS The .Nm set of commands was written by .An -nosplit .An Devin Teske Aq dteske@FreeBSD.org .