xref: /dragonfly/usr.sbin/efidp/efidp.8 (revision 7ff0fc30)
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: head/usr.sbin/efidp/efidp.8 343755 2019-02-04 21:28:25Z imp $
26.\"
27.Dd June 6, 2020
28.Dt EFIDP 8
29.Os
30.Sh NAME
31.Nm efidp
32.Nd UEFI Device Path manipulation
33.Sh SYNOPSIS
34.Nm
35.Op Fl efpu
36.Op Fl -format
37.Op Fl -parse
38.Op Fl -to-efi
39.Op Fl -to-unix
40.Sh DESCRIPTION
41This program converts
42.Dq Unified Extensible Firmware Interface
43.Pq UEFI
44Device Paths, as defined in the UEFI standard, to and from binary form.
45Binary and textual forms are defined in Chapter 9 of the UEFI
46Specification.
47.Bl -tag -width 20m
48.It Fl f , Fl -format
49Formats a binary UEFI Device Path into its canonical UTF-8 textual form.
50A binary Device Path can be no longer than 65536 bytes.
51The textual form must fit into 65536 bytes.
52Multiple binary device paths may be specified.
53.It Fl p , Fl -parse
54Parses a UEFI Device Path UTF-8 specification and outputs the binary
55Device Path form.
56Only one device path is parsed, even if there are multiple present in
57the input.
58Leading white space is ignored.
59The resulting binary Device Path can be no longer than 65536 bytes.
60Multiple lines may be specified.
61Each one will be translated.
62.It Fl e , Fl -to-efi
63Translate a Unix file path to an EFI Device Path.
64The output is the textual representation of the EFI Device Path.
65.It Fl u , Fl -to-unix
66Translate an EFI device path to a Unix file path.
67The input is the textual representation of the EFI Device Path.
68.El
69.Sh SEE ALSO
70Appendix A of the UEFI specification has the format for GUIDs.
71All GUIDs
72.Pq Globally Unique Identifiers
73have the format described in RFC 4122.
74.Pp
75The Unified Extensible Firmware Interface Specification is available
76from
77.Pa www.uefi.org .
78.Sh HISTORY
79The
80.Nm
81utility first appeared in
82.Fx 11.1 .
83