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