Changeset View
Changeset View
Standalone View
Standalone View
usr.sbin/efivar/efivar.8
| .\" | .\" | ||||
| .\" Copyright (c) 2017 Netflix, Inc. | .\" Copyright (c) 2017-2019 Netflix, Inc. | ||||
| .\" | .\" | ||||
| .\" Redistribution and use in source and binary forms, with or without | .\" Redistribution and use in source and binary forms, with or without | ||||
| .\" modification, are permitted provided that the following conditions | .\" modification, are permitted provided that the following conditions | ||||
| .\" are met: | .\" are met: | ||||
| .\" 1. Redistributions of source code must retain the above copyright | .\" 1. Redistributions of source code must retain the above copyright | ||||
| .\" notice, this list of conditions and the following disclaimer. | .\" notice, this list of conditions and the following disclaimer. | ||||
| .\" 2. Redistributions in binary form must reproduce the above copyright | .\" 2. Redistributions in binary form must reproduce the above copyright | ||||
| .\" notice, this list of conditions and the following disclaimer in the | .\" notice, this list of conditions and the following disclaimer in the | ||||
| .\" documentation and/or other materials provided with the distribution. | .\" documentation and/or other materials provided with the distribution. | ||||
| .\" | .\" | ||||
| .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND | .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR AND CONTRIBUTORS ``AS IS'' AND | ||||
| .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE | ||||
| .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE | ||||
| .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE | .\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR OR CONTRIBUTORS BE LIABLE | ||||
| .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL | ||||
| .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS | ||||
| .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) | ||||
| .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT | ||||
| .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY | .\" 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 | .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF | ||||
| .\" SUCH DAMAGE. | .\" SUCH DAMAGE. | ||||
| .\" | .\" | ||||
| .\" $FreeBSD$ | .\" $FreeBSD$ | ||||
| .\" | .\" | ||||
| .Dd May 22, 2017 | .Dd February 19, 2019 | ||||
| .Dt EFIVAR 8 | .Dt EFIVAR 8 | ||||
| .Os | .Os | ||||
| .Sh NAME | .Sh NAME | ||||
| .Nm efivar | .Nm efivar | ||||
| .Nd UEFI environment variable interaction | .Nd UEFI environment variable interaction | ||||
| .Sh SYNOPSIS | .Sh SYNOPSIS | ||||
| .Nm | .Nm | ||||
| .Op Fl abdDHlLNpRtuw | .Op Fl abdDHlLNpRtuw | ||||
| .Op Fl n Ar name | .Op Fl n Ar name | ||||
| .Op Fl f Ar file | .Op Fl f Ar file | ||||
| .Op Fl -append | .Op Fl -append | ||||
| .Op Fl -ascii | .Op Fl -ascii | ||||
| .Op Fl -attributes | .Op Fl -attributes | ||||
| .Op Fl -binary | .Op Fl -binary | ||||
| .Op Fl -delete | .Op Fl -delete | ||||
| .Op Fl -device-path | .Op Fl -device-path | ||||
| .Op Fl -fromfile Ar file | .Op Fl -fromfile Ar file | ||||
| .Op Fl -guid | .Op Fl -guid | ||||
| .Op Fl -hex | .Op Fl -hex | ||||
| .Op Fl -list-guids | .Op Fl -list-guids | ||||
| .Op Fl -list | .Op Fl -list | ||||
| .Op Fl -load-option | |||||
| .Op Fl -name Ar name | .Op Fl -name Ar name | ||||
| .Op Fl -no-name | .Op Fl -no-name | ||||
| .Op Fl -print | .Op Fl -print | ||||
| .Op Fl -print-decimal | .Op Fl -print-decimal | ||||
| .Op Fl -raw-guid | .Op Fl -raw-guid | ||||
| .Op Fl -utf8 | .Op Fl -utf8 | ||||
| .Op Fl -write | .Op Fl -write | ||||
| .Sh DESCRIPTION | .Sh DESCRIPTION | ||||
| ▲ Show 20 Lines • Show All 85 Lines • ▼ Show 20 Lines | |||||
| These names will replace the numeric GUID values unless | These names will replace the numeric GUID values unless | ||||
| .Fl -raw-guid | .Fl -raw-guid | ||||
| flag is specified. | flag is specified. | ||||
| .It Fl l Fl -list | .It Fl l Fl -list | ||||
| List all the variables. | List all the variables. | ||||
| If the | If the | ||||
| .Fl -print | .Fl -print | ||||
| flag is also listed, their values will be displayed. | flag is also listed, their values will be displayed. | ||||
| .It Fl -load-option | |||||
| Print information about the specified boot option. | |||||
| .It Fl N Fl -no-name | .It Fl N Fl -no-name | ||||
kevans: I might suggest re-wording slightly to more strongly indicate that the value will be fully… | |||||
impUnsubmitted Done Inline ActionsI'd be inclined for something more verbose: "Decode the variable as if it were a UEFI BOOT_OPTION, including information about what device and/or paths the UEFI DEVICE_PATHS decode to" But I'm not sure that's quite right either. imp: I'd be inclined for something more verbose:
"Decode the variable as if it were a UEFI… | |||||
| Do not display the variable name. | Do not display the variable name. | ||||
| .It Fl p Fl -print | .It Fl p Fl -print | ||||
| Print the value of the variable. | Print the value of the variable. | ||||
| .It Fl R Fl -raw-guid | .It Fl R Fl -raw-guid | ||||
| Do not substitute well known names for GUID numeric values in output. | Do not substitute well known names for GUID numeric values in output. | ||||
| .It Fl u Fl -utf8 | .It Fl u Fl -utf8 | ||||
| Treat the value of the variable as UCS2 and convert it to UTF8 and | Treat the value of the variable as UCS2 and convert it to UTF8 and | ||||
| print the result. | print the result. | ||||
| Show All 38 Lines | |||||
I might suggest re-wording slightly to more strongly indicate that the value will be fully decoded into its path components rather than displayed as-is. I don't feel that strongly about it, though.