d/freebsd-skq
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity
5b2a48fb40
freebsd-skq/usr.sbin/efivar/efivar.8

200 lines
5.7 KiB
Groff
Raw Normal View History

Regularize the Netflix copyright Use recent best practices for Copyright form at the top of the license: 1. Remove all the All Rights Reserved clauses on our stuff. Where we piggybacked others, use a separate line to make things clear. 2. Use "Netflix, Inc." everywhere. 3. Use a single line for the copyright for grep friendliness. 4. Use date ranges in all places for our stuff. Approved by: Netflix Legal (who gave me the form), adrian@ (pmc files)
2019-02-04 21:28:25 +00:00
.\"
Document the efivar --load-option option Reviewed by: imp, kevans Sponsored by: Netflix, Inc. Differential Revision: https://reviews.freebsd.org/D19263
2019-03-07 00:01:28 +00:00
.\" Copyright (c) 2017-2019 Netflix, Inc.
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
.\"
.\" Redistribution and use in source and binary forms, with or without
.\" modification, are permitted provided that the following conditions
.\" are met:
.\" 1. Redistributions of source code must retain the above copyright
.\" notice, this list of conditions and the following disclaimer.
.\" 2. Redistributions in binary form must reproduce the above copyright
.\" notice, this list of conditions and the following disclaimer in the
.\" documentation and/or other materials provided with the distribution.
.\"
Fix building on i386 and arm. But 'public domain' headers on the files with no creative content. Include "lost" changes from git: o Use /dev/efi instead of /dev/efidev o Remove redundant NULL checks. Submitted by: kib@, dim@, zbb@, emaste@
2016-10-13 06:56:23 +00:00
.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
Fix building on i386 and arm. But 'public domain' headers on the files with no creative content. Include "lost" changes from git: o Use /dev/efi instead of /dev/efidev o Remove redundant NULL checks. Submitted by: kib@, dim@, zbb@, emaste@
2016-10-13 06:56:23 +00:00
.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
.\" SUCH DAMAGE.
.\"
.\" $FreeBSD$
.\"
Document the efivar --load-option option Reviewed by: imp, kevans Sponsored by: Netflix, Inc. Differential Revision: https://reviews.freebsd.org/D19263
2019-03-07 00:01:28 +00:00
.Dd March 6, 2019
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
.Dt EFIVAR 8
.Os
.Sh NAME
.Nm efivar
Updates for efivar.8 Fix spelling [1], appease igor and mandoc -Tlint, and adopt the language style to be more consistent with our corpus. PR: 219434 [1] Submitted by: olgeni [1]
2017-05-21 22:10:08 +00:00
.Nd UEFI environment variable interaction
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
.Sh SYNOPSIS
.Nm
Add UCS2->UTF8 option. Many UEFI variables are UCS2 strings (some NUL terminated, others not). Add --utf8 (-u) to convert UCS2 strings to UTF8 before printing. Sponsored by: Netflix
2017-08-31 17:53:50 +00:00
.Op Fl abdDHlLNpRtuw
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
.Op Fl n Ar name
.Op Fl f Ar file
.Op Fl -append
.Op Fl -ascii
.Op Fl -attributes
.Op Fl -binary
.Op Fl -delete
Finish implementing -d/--device/--device-path flag to print variable as if it were a device path. Remove language about a=b syntax on the command line. This will not be implemented due to its limited usefulness. UEFI variables are binary blobs, on the whole, and a simple work around exists for strings. Clarify that the new value of the variable is taken from stdin. Update manual with history. Sponsored by: Netflix
2017-03-09 00:31:36 +00:00
.Op Fl -device-path
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
.Op Fl -fromfile Ar file
Implement --guid/-g to print the known GUIDs as human readable. The list of known GUIDs can be found with --list-guids. Sponsored by: Netflix
2017-03-03 20:23:10 +00:00
.Op Fl -guid
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
.Op Fl -hex
.Op Fl -list-guids
.Op Fl -list
Document the efivar --load-option option Reviewed by: imp, kevans Sponsored by: Netflix, Inc. Differential Revision: https://reviews.freebsd.org/D19263
2019-03-07 00:01:28 +00:00
.Op Fl -load-option
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
.Op Fl -name Ar name
.Op Fl -no-name
.Op Fl -print
.Op Fl -print-decimal
.Op Fl -raw-guid
Add UCS2->UTF8 option. Many UEFI variables are UCS2 strings (some NUL terminated, others not). Add --utf8 (-u) to convert UCS2 strings to UTF8 before printing. Sponsored by: Netflix
2017-08-31 17:53:50 +00:00
.Op Fl -utf8
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
.Op Fl -write
.Sh DESCRIPTION
This program manages
.Dq Unified Extensible Firmware Interface
.Pq UEFI
environment variables.
UEFI variables have three part: A namespace, a name and a value.
Updates for efivar.8 Fix spelling [1], appease igor and mandoc -Tlint, and adopt the language style to be more consistent with our corpus. PR: 219434 [1] Submitted by: olgeni [1]
2017-05-21 22:10:08 +00:00
The namespace is a GUID that is self assigned by the group defining the
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
variables.
The name is a Unicode name for the variable.
The value is binary data.
All Unicode data is presented to the user as UTF-8.
.Pp
The following options are available:
.Bl -tag -width 20m
.It Fl n Ar name Fl -name Ar name
Specify the name of the variable to operate on.
The
.Ar name
Updates for efivar.8 Fix spelling [1], appease igor and mandoc -Tlint, and adopt the language style to be more consistent with our corpus. PR: 219434 [1] Submitted by: olgeni [1]
2017-05-21 22:10:08 +00:00
argument is the GUID of the variable, followed by a dash, followed by the
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
UEFI variable name.
The GUID may be in numeric format, or may be one of the well known
symbolic name (see
.Fl -list-guids
for a complete list).
.It Fl f Ar file Fl -fromfile Ar file
When writing or appending to a variable, take the data for the
variable's value from
.Ar file
instead of from the command line.
This flag implies
.Fl -write
unless the
.Fl -append
Implenent --fromfile to read variable values when printing variables So ./efivar --fromfile Boot0001.bin --print --load-option will take the value from Boot0001.bin file and then decode it as if it were a load-option. This is useful for debugging handling of such variables that may be hanging the boot for some people. Sponsored by: Netflix, Inc
2018-10-26 22:13:40 +00:00
or
.Fl -print
flags are given.
This behavior is not well understood and is currently unimplemented
for writes.
When
.Fl -print
is specified, the contents of the file are used as the value to
print using any other specified flags.
This is used primarily for testing purposes for more complicated
variable decoding.
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
.It Fl a Fl -append
Append the specified value to the UEFI variable rather than replacing
Updates for efivar.8 Fix spelling [1], appease igor and mandoc -Tlint, and adopt the language style to be more consistent with our corpus. PR: 219434 [1] Submitted by: olgeni [1]
2017-05-21 22:10:08 +00:00
it.
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
.It Fl t Ar attr Fl -attributes Ar attr
Updates for efivar.8 Fix spelling [1], appease igor and mandoc -Tlint, and adopt the language style to be more consistent with our corpus. PR: 219434 [1] Submitted by: olgeni [1]
2017-05-21 22:10:08 +00:00
Specify, in hexadecimal, the attributes for this
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
variable.
See section 7.2 (GetVariable subsection, Related Definitions) of the
UEFI Specification for hex values to use.
.It Fl A Fl -ascii
Display the variable data as modified ascii: All printable characters
are printed, while unprintable characters are rendered as a two-digit
Updates for efivar.8 Fix spelling [1], appease igor and mandoc -Tlint, and adopt the language style to be more consistent with our corpus. PR: 219434 [1] Submitted by: olgeni [1]
2017-05-21 22:10:08 +00:00
hexadecimal number preceded by a % character.
'b' is short for --binary, it isn't 'a'. PR: 213437 Submitted by: Ganael LAPLANCHE
2016-10-13 17:03:54 +00:00
.It Fl b Fl -binary
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
Display the variable data as binary data.
Usually will be used with the
.Fl N
or
.Fl -no-name
flag.
Useful in scripts.
.It Fl D Fl -delete
Delete the specified variable.
May not be used with either the
.Fl -write
or the
.Fl -append
flags.
No
.Ar value
may be specified.
Finish implementing -d/--device/--device-path flag to print variable as if it were a device path. Remove language about a=b syntax on the command line. This will not be implemented due to its limited usefulness. UEFI variables are binary blobs, on the whole, and a simple work around exists for strings. Clarify that the new value of the variable is taken from stdin. Update manual with history. Sponsored by: Netflix
2017-03-09 00:31:36 +00:00
.It Fl d Fl -device Fl -device-path
Interpret the variables printed as UEFI device paths and print the
UEFI standard string representation.
Implement --guid/-g to print the known GUIDs as human readable. The list of known GUIDs can be found with --list-guids. Sponsored by: Netflix
2017-03-03 20:23:10 +00:00
.It Fl g Fl -guid
flag is specified, guids are converted to names if they are known (and
show up in
.Fl -list-guids ).
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
.It Fl H Fl -hex
List variable data as a hex dump.
.It Fl L Fl -list-guids
Lists the well known GUIDs.
The names listed here may be used in place of the numeric GUID values.
These names will replace the numeric GUID values unless
.Fl -raw-guid
flag is specified.
.It Fl l Fl -list
List all the variables.
If the
.Fl -print
flag is also listed, their values will be displayed.
Document the efivar --load-option option Reviewed by: imp, kevans Sponsored by: Netflix, Inc. Differential Revision: https://reviews.freebsd.org/D19263
2019-03-07 00:01:28 +00:00
.It Fl -load-option
Decode the variable as if it were a UEFI Boot Option, including information about what device and/or paths the UEFI DevicePaths decode to.
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
.It Fl N Fl -no-name
Do not display the variable name.
.It Fl p Fl -print
Print the value of the variable.
.It Fl R Fl -raw-guid
Do not substitute well known names for GUID numeric values in output.
Add UCS2->UTF8 option. Many UEFI variables are UCS2 strings (some NUL terminated, others not). Add --utf8 (-u) to convert UCS2 strings to UTF8 before printing. Sponsored by: Netflix
2017-08-31 17:53:50 +00:00
.It Fl u Fl -utf8
Treat the value of the variable as UCS2 and convert it to UTF8 and
print the result.
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
.It Fl w Fl -write
Finish implementing -d/--device/--device-path flag to print variable as if it were a device path. Remove language about a=b syntax on the command line. This will not be implemented due to its limited usefulness. UEFI variables are binary blobs, on the whole, and a simple work around exists for strings. Clarify that the new value of the variable is taken from stdin. Update manual with history. Sponsored by: Netflix
2017-03-09 00:31:36 +00:00
Write (replace) the variable specified with the value specified from
standard input.
No command line option to do this is available since UEFI variables
are binary structures rather than strings.
.Xr echo 1
.Fl n
can be used to specify simple strings.
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
.It Ar name
Display the
.Ar name
environment variable.
Updates for efivar.8 Fix spelling [1], appease igor and mandoc -Tlint, and adopt the language style to be more consistent with our corpus. PR: 219434 [1] Submitted by: olgeni [1]
2017-05-21 22:10:08 +00:00
.El
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
.Sh COMPATIBILITY
The
.Nm
Updates for efivar.8 Fix spelling [1], appease igor and mandoc -Tlint, and adopt the language style to be more consistent with our corpus. PR: 219434 [1] Submitted by: olgeni [1]
2017-05-21 22:10:08 +00:00
program is intended to be compatible (strict superset) with a program
of the same name included in the Red Hat libefivar package,
but the
Finish implementing -d/--device/--device-path flag to print variable as if it were a device path. Remove language about a=b syntax on the command line. This will not be implemented due to its limited usefulness. UEFI variables are binary blobs, on the whole, and a simple work around exists for strings. Clarify that the new value of the variable is taken from stdin. Update manual with history. Sponsored by: Netflix
2017-03-09 00:31:36 +00:00
.Fl d
and
.Fl -print-decimal
Updates for efivar.8 Fix spelling [1], appease igor and mandoc -Tlint, and adopt the language style to be more consistent with our corpus. PR: 219434 [1] Submitted by: olgeni [1]
2017-05-21 22:10:08 +00:00
flags are not implemented and never will be.
.Pp
Finish implementing -d/--device/--device-path flag to print variable as if it were a device path. Remove language about a=b syntax on the command line. This will not be implemented due to its limited usefulness. UEFI variables are binary blobs, on the whole, and a simple work around exists for strings. Clarify that the new value of the variable is taken from stdin. Update manual with history. Sponsored by: Netflix
2017-03-09 00:31:36 +00:00
The
.Fl d
Updates for efivar.8 Fix spelling [1], appease igor and mandoc -Tlint, and adopt the language style to be more consistent with our corpus. PR: 219434 [1] Submitted by: olgeni [1]
2017-05-21 22:10:08 +00:00
flag is short for
Finish implementing -d/--device/--device-path flag to print variable as if it were a device path. Remove language about a=b syntax on the command line. This will not be implemented due to its limited usefulness. UEFI variables are binary blobs, on the whole, and a simple work around exists for strings. Clarify that the new value of the variable is taken from stdin. Update manual with history. Sponsored by: Netflix
2017-03-09 00:31:36 +00:00
.Fl -device-path .
Add efivar(1) to manipulate EFI variables. It uses a similar command line interface to the Linux program, as well as adding a number of useful features to make using it in shell scripts easier (since we don't have a filesystem to fall back on interacting with). Differential Revision: https://reviews.freebsd.org/D8128 Reviewed by: kib@, wblock@, Ganael Laplanche
2016-10-11 22:31:45 +00:00
.Sh SEE ALSO
Appendix A of the UEFI specification has the format for GUIDs.
All GUIDs
.Dq Globally Unique Identifiers
have the format described in RFC 4122.
Finish implementing -d/--device/--device-path flag to print variable as if it were a device path. Remove language about a=b syntax on the command line. This will not be implemented due to its limited usefulness. UEFI variables are binary blobs, on the whole, and a simple work around exists for strings. Clarify that the new value of the variable is taken from stdin. Update manual with history. Sponsored by: Netflix
2017-03-09 00:31:36 +00:00
.Sh HISTORY
The
.Nm
utility first appeared in
Correct the "first appeared in" version for efivar(8). MFC after: 3 days Sponsored by: The FreeBSD Foundation
2017-05-22 13:55:59 +00:00
.Fx 11.1 .
Reference in New Issue Copy Permalink