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