usr.sbin/efivar/efivar.8

   1 .\" Copyright (c) 2003 Netflix, Inc
   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: head/usr.sbin/efivar/efivar.8 307224 2016-10-13 17:03:54Z imp $
  26 .\"
  27 .Dd September 29, 2016
  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 abdDHlLNpRtw
  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 -fromfile Ar file
  44 .Op Fl -hex
  45 .Op Fl -list-guids
  46 .Op Fl -list
  47 .Op Fl -name Ar name
  48 .Op Fl -no-name
  49 .Op Fl -print
  50 .Op Fl -print-decimal
  51 .Op Fl -raw-guid
  52 .Op Fl -write
  53 .Ar name Ns Op = Ns Ar value
  54 .Sh DESCRIPTION
  55 This program manages
  56 .Dq Unified Extensible Firmware Interface
  57 .Pq UEFI
  58 environment variables.
  59 UEFI variables have three part: A namespace, a name and a value.
  60 The namespace is a GUID that is self assigned by the group defining the
  61 variables.
  62 The name is a Unicode name for the variable.
  63 The value is binary data.
  64 All Unicode data is presented to the user as UTF-8.
  65 .Pp
  66 The following options are available:
  67 .Bl -tag -width 20m
  68 .It Fl n Ar name Fl -name Ar name
  69 Specify the name of the variable to operate on.
  70 The
  71 .Ar name
  72 argument is the GUID of the variable, followed by a dash, followed by the
  73 UEFI variable name.
  74 The GUID may be in numeric format, or may be one of the well known
  75 symbolic name (see
  76 .Fl -list-guids
  77 for a complete list).
  78 .It Fl f Ar file Fl -fromfile Ar file
  79 When writing or appending to a variable, take the data for the
  80 variable's value from
  81 .Ar file
  82 instead of from the command line.
  83 This flag implies
  84 .Fl -write
  85 unless the
  86 .Fl -append
  87 flag is given.
  88 This behavior is not well understood and currently unimplemented.
  89 .It Fl a Fl -append
  90 Append the specified value to the UEFI variable rather than replacing
  91 it.
  92 .It Fl t Ar attr Fl -attributes Ar attr
  93 Specify, in hexadecimal, the attributes for this
  94 variable.
  95 See section 7.2 (GetVariable subsection, Related Definitions) of the
  96 UEFI Specification for hex values to use.
  97 .It Fl A Fl -ascii
  98 Display the variable data as modified ascii: All printable characters
  99 are printed, while unprintable characters are rendered as a two-digit
 100 hexadecimal number preceded by a % character.
 101 .It Fl b Fl -binary
 102 Display the variable data as binary data.
 103 Usually will be used with the
 104 .Fl N
 105 or
 106 .Fl -no-name
 107 flag.
 108 Useful in scripts.
 109 .It Fl D Fl -delete
 110 Delete the specified variable.
 111 May not be used with either the
 112 .Fl -write
 113 or the
 114 .Fl -append
 115 flags.
 116 No
 117 .Ar value
 118 may be specified.
 119 .It Fl H Fl -hex
 120 List variable data as a hex dump.
 121 .It Fl L Fl -list-guids
 122 Lists the well known GUIDs.
 123 The names listed here may be used in place of the numeric GUID values.
 124 These names will replace the numeric GUID values unless
 125 .Fl -raw-guid
 126 flag is specified.
 127 .It Fl l Fl -list
 128 List all the variables.
 129 If the
 130 .Fl -print
 131 flag is also listed, their values will be displayed.
 132 .It Fl N Fl -no-name
 133 Do not display the variable name.
 134 .It Fl p Fl -print
 135 Print the value of the variable.
 136 .It Fl d Fl -print-decimal
 137 Treat the value of the variable as a number and print it as a
 138 decimal.
 139 This is currently unimplemented.
 140 .It Fl R Fl -raw-guid
 141 Do not substitute well known names for GUID numeric values in output.
 142 .It Fl w Fl -write
 143 Write (replace) the variable specified with the value specified.
 144 .It Ar name
 145 Display the
 146 .Ar name
 147 environment variable.
 148 .It Ar name Ns = Ns Ar value
 149 Set the specified
 150 .Ar name
 151 to
 152 .Ar value .
 153 This is not yet implemented.
 154 .El
 155 .Sh COMPATIBILITY
 156 The
 157 .Nm
 158 program is intended to be compatible (strict superset) with a program
 159 of the same name included in the Red Hat libefivar package.
 160 .Sh SEE ALSO
 161 .Xr efivar 3
 162 .Pp
 163 Appendix A of the UEFI specification has the format for GUIDs.
 164 All GUIDs
 165 .Pq Dq Globally Unique Identifiers
 166 have the format described in RFC 4122.