bin/kenv/kenv.1

   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 May 11, 2012
  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 hNq
  36 .Nm
  37 .Op Fl qv
  38 .Ar variable Ns Op = Ns Ar value
  39 .Nm
  40 .Op Fl q
  41 .Fl u
  42 .Ar variable
  43 .Sh DESCRIPTION
  44 The
  45 .Nm
  46 utility will dump the kernel environment if
  47 invoked without arguments.
  48 If the
  49 .Fl h
  50 option is specified, it will limit the report to kernel probe hints.
  51 If an optional
  52 .Ar variable
  53 name is specified,
  54 .Nm
  55 will only report that value.
  56 If the
  57 .Fl N
  58 option is specified,
  59 .Nm
  60 will only display variable names and not their values.
  61 If the
  62 .Fl u
  63 option is specified,
  64 .Nm
  65 will delete the given environment variable.
  66 If the environment variable is followed by an optional
  67 .Ar value ,
  68 .Nm
  69 will set the environment variable to this value.
  70 .Pp
  71 If the
  72 .Fl q
  73 option is set, warnings normally printed as a result of being unable to
  74 perform the requested operation will be suppressed.
  75 .Pp
  76 If the
  77 .Fl v
  78 option is set, the variable name will be printed out for the
  79 environment variable in addition to the value when
  80 .Nm
  81 is executed with a variable name.
  82 .Pp
  83 Variables can be added to the kernel environment using the
  84 .Pa /boot/loader.conf
  85 file, or also statically compiled into the kernel using the statement
  86 .Pp
  87 .Dl Ic env Ar filename
  88 .Pp
  89 in the kernel config file.
  90 The file can contain lines of the form
  91 .Pp
  92 .Dl name = "value"  # this is a comment
  93 .Pp
  94 where whitespace around name and '=', and
  95 everything after a '#' character, are ignored.  Almost any printable
  96 character except '=' is acceptable as part of a name.  Quotes
  97 are optional and necessary only if the value contains
  98 whitespace.
  99 .Sh SEE ALSO
 100 .Xr kenv 2 ,
 101 .Xr config 5 ,
 102 .Xr loader.conf 5 ,
 103 .Xr loader 8
 104 .Sh HISTORY
 105 The
 106 .Nm
 107 utility appeared in
 108 .Fx 4.1.1 .