sys/boot/forth/color.4th.8

   1 .\" Copyright (c) 2011-2013 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 August 6, 2013
  28 .Dt COLOR.4TH 8
  29 .Os
  30 .Sh NAME
  31 .Nm color.4th
  32 .Nd FreeBSD color-detection boot module
  33 .Sh DESCRIPTION
  34 The file that goes by the name of
  35 .Nm
  36 is a set of commands designed to simplify color logic.
  37 The commands of
  38 .Nm
  39 by themselves are not enough for most uses.
  40 Please refer to the
  41 examples below for the most common situations, and to
  42 .Xr loader 8
  43 for additional commands.
  44 .Pp
  45 Before using any of the commands provided in
  46 .Nm ,
  47 it must be included
  48 through the command:
  49 .Pp
  50 .Dl include color.4th
  51 .Pp
  52 This line is present in
  53 .Pa /boot/loader.4th
  54 file, so it is not needed (and should not be re-issued) in a normal setup.
  55 .Pp
  56 The commands provided by it are:
  57 .Pp
  58 .Bl -tag -width disable-module_module -compact -offset indent
  59 .It Ic loader_color?
  60 Returns FALSE if the
  61 .Ic loader_color
  62 environment variable is set to
  63 .Dq NO
  64 (case-insensitive) or
  65 .Dq 0 .
  66 Otherwise returns TRUE
  67 .Pq unless booting serial .
  68 .El
  69 .Pp
  70 The environment variables that effect its behavior are:
  71 .Bl -tag -width bootfile -offset indent
  72 .It Va loader_color
  73 If set to
  74 .Dq NO
  75 (case-insensitive) or
  76 .Dq 0 ,
  77 causes
  78 .Ic loader_color?
  79 to return FALSE, indicating to many modules that color should not be used.
  80 .El
  81 .Sh FILES
  82 .Bl -tag -width /boot/loader.4th -compact
  83 .It Pa /boot/loader
  84 The
  85 .Xr loader 8 .
  86 .It Pa /boot/color.4th
  87 .Nm
  88 itself.
  89 .It Pa /boot/loader.rc
  90 .Xr loader 8
  91 bootstrapping script.
  92 .El
  93 .Sh EXAMPLES
  94 Standard i386
  95 .Pa /boot/loader.rc :
  96 .Pp
  97 Use color where applicable:
  98 .Pp
  99 .Bd -literal -offset indent -compact
 100 loader_color="YES"
 101 .Ed
 102 .Sh SEE ALSO
 103 .Xr loader.conf 5 ,
 104 .Xr loader 8 ,
 105 .Xr loader.4th 8
 106 .Sh HISTORY
 107 The
 108 .Nm
 109 set of commands first appeared in
 110 .Fx 9.0 .
 111 .Sh AUTHORS
 112 The
 113 .Nm
 114 set of commands was written by
 115 .An -nosplit
 116 .An Devin Teske Aq dteske@FreeBSD.org .