usr.sbin/efivar/efivar.8

   1 .\"
   2 .\" Copyright (c) 2017 Netflix, Inc.
   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 June 18, 2020
  28 .Dt EFIVAR 8
  29 .Os
  30 .Sh NAME
  31 .Nm efivar
  32 .Nd UEFI environment variable interaction
  33 .Sh SYNOPSIS
  34 .Nm
  35 .Op Fl abdDHlLNpRtuw
  36 .Op Fl n Ar name
  37 .Op Fl f Ar file
  38 .Op Fl -append
  39 .Op Fl -ascii
  40 .Op Fl -attributes
  41 .Op Fl -binary
  42 .Op Fl -delete
  43 .Op Fl -device-path
  44 .Op Fl -fromfile Ar file
  45 .Op Fl -guid
  46 .Op Fl -hex
  47 .Op Fl -list-guids
  48 .Op Fl -list
  49 .Op Fl -name Ar name
  50 .Op Fl -no-name
  51 .Op Fl -print
  52 .Op Fl -print-decimal
  53 .Op Fl -raw-guid
  54 .Op Fl -utf8
  55 .Op Fl -write
  56 .Sh DESCRIPTION
  57 This program manages
  58 .Dq Unified Extensible Firmware Interface
  59 .Pq UEFI
  60 environment variables.
  61 UEFI variables have three part: A namespace, a name and a value.
  62 The namespace is a GUID that is self assigned by the group defining the
  63 variables.
  64 The name is a Unicode name for the variable.
  65 The value is binary data.
  66 All Unicode data is presented to the user as UTF-8.
  67 .Pp
  68 The following options are available:
  69 .Bl -tag -width 20m
  70 .It Fl n Ar name Fl -name Ar name
  71 Specify the name of the variable to operate on.
  72 The
  73 .Ar name
  74 argument is the GUID of the variable, followed by a dash, followed by the
  75 UEFI variable name.
  76 The GUID may be in numeric format, or may be one of the well known
  77 symbolic name (see
  78 .Fl -list-guids
  79 for a complete list).
  80 .It Fl f Ar file Fl -fromfile Ar file
  81 When writing or appending to a variable, take the data for the
  82 variable's value from
  83 .Ar file
  84 instead of from the command line.
  85 This flag implies
  86 .Fl -write
  87 unless the
  88 .Fl -append
  89 flag is given.
  90 This behavior is not well understood and is currently unimplemented.
  91 .It Fl a Fl -append
  92 Append the specified value to the UEFI variable rather than replacing
  93 it.
  94 .It Fl t Ar attr Fl -attributes Ar attr
  95 Specify, in hexadecimal, the attributes for this
  96 variable.
  97 See section 7.2 (GetVariable subsection, Related Definitions) of the
  98 UEFI Specification for hex values to use.
  99 .It Fl A Fl -ascii
 100 Display the variable data as modified ascii: All printable characters
 101 are printed, while unprintable characters are rendered as a two-digit
 102 hexadecimal number preceded by a % character.
 103 .It Fl b Fl -binary
 104 Display the variable data as binary data.
 105 Usually will be used with the
 106 .Fl N
 107 or
 108 .Fl -no-name
 109 flag.
 110 Useful in scripts.
 111 .It Fl D Fl -delete
 112 Delete the specified variable.
 113 May not be used with either the
 114 .Fl -write
 115 or the
 116 .Fl -append
 117 flags.
 118 No
 119 .Ar value
 120 may be specified.
 121 .It Fl d Fl -device Fl -device-path
 122 Interpret the variables printed as UEFI device paths and print the
 123 UEFI standard string representation.
 124 .It Fl g Fl -guid
 125 Convert GUIDs to names if they are known
 126 .Po and show them up in
 127 .Fl -list-guids
 128 .Pc .
 129 .It Fl H Fl -hex
 130 List variable data as a hex dump.
 131 .It Fl L Fl -list-guids
 132 Lists the well known GUIDs.
 133 The names listed here may be used in place of the numeric GUID values.
 134 These names will replace the numeric GUID values unless
 135 .Fl -raw-guid
 136 flag is specified.
 137 .It Fl l Fl -list
 138 List all the variables.
 139 If the
 140 .Fl -print
 141 flag is also listed, their values will be displayed.
 142 .It Fl N Fl -no-name
 143 Do not display the variable name.
 144 .It Fl p Fl -print
 145 Print the value of the variable.
 146 .It Fl R Fl -raw-guid
 147 Do not substitute well known names for GUID numeric values in output.
 148 .It Fl u Fl -utf8
 149 Treat the value of the variable as UCS2 and convert it to UTF8 and
 150 print the result.
 151 .It Fl w Fl -write
 152 Write (replace) the variable specified with the value specified from
 153 standard input.
 154 No command line option to do this is available since UEFI variables
 155 are binary structures rather than strings.
 156 .Xr echo 1
 157 .Fl n
 158 can be used to specify simple strings.
 159 .It Ar name
 160 Display the
 161 .Ar name
 162 environment variable.
 163 .El
 164 .Sh COMPATIBILITY
 165 The
 166 .Nm
 167 program is intended to be compatible (strict superset) with a program
 168 of the same name included in the Red Hat libefivar package,
 169 but the
 170 .Fl d
 171 and
 172 .Fl -print-decimal
 173 flags are not implemented and never will be.
 174 .Pp
 175 The
 176 .Fl d
 177 flag is short for
 178 .Fl -device-path .
 179 .Sh SEE ALSO
 180 Appendix A of the UEFI specification has the format for GUIDs.
 181 All GUIDs
 182 .Dq Globally Unique Identifiers
 183 have the format described in RFC 4122.
 184 .Sh HISTORY
 185 The
 186 .Nm
 187 utility first appeared in
 188 .Fx 11.1 .