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