xref: /freebsd/bin/kenv/kenv.1 (revision 1670a1c2a47d10ecccd001970b859caf93cd3b6e)
1.\"-
2.\" Copyright (c) 2000  Peter Wemm <peter@FreeBSD.org>
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 AUTHORS 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 AUTHORS 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 January 13, 2009
28.Dt KENV 1
29.Os
30.Sh NAME
31.Nm kenv
32.Nd dump or modify the kernel environment
33.Sh SYNOPSIS
34.Nm
35.Op Fl hq
36.Nm
37.Op Fl q
38.Ar variable Ns Op = Ns Ar value
39.Nm
40.Op Fl q
41.Fl u
42.Ar variable
43.Sh DESCRIPTION
44The
45.Nm
46utility will dump the kernel environment if
47invoked without arguments.
48If the
49.Fl h
50option is specified, it will limit the report to kernel probe hints.
51If an optional
52.Ar variable
53name is specified,
54.Nm
55will only report that value.
56If the
57.Fl u
58option is specified,
59.Nm
60will delete the given environment variable.
61If the environment variable is followed by an optional
62.Ar value ,
63.Nm
64will set the environment variable to this value.
65.Pp
66If the
67.Fl q
68option is set, warnings normally printed as a result of being unable to
69perform the requested operation will be suppressed.
70.Pp
71Variables can be added to the kernel environment using the
72.Xr /boot/loader.conf
73file, or also statically compiled into the kernel using the statement
74.Pp
75.Dl Ic env Ar filename
76.Pp
77in the kernel config file.
78The file can contain lines of the form
79.Pp
80.Dl name = "value"  # this is a comment
81.Pp
82where whitespace around name and '=', and
83everything after a '#' character, are ignored.  Almost any printable
84character except '=' is acceptable as part of a name.  Quotes
85are optional and necessary only if the value contains
86whitespace.
87.Pp
88.Sh SEE ALSO
89.Xr kenv 2 ,
90.Xr config 5 ,
91.Xr loader.conf 5 ,
92.Xr loader 8
93.Sh HISTORY
94The
95.Nm
96utility appeared in
97.Fx 4.1.1 .
98