1 .\" Copyright (c) 2017 Netflix, Inc
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .Nd UEFI Device Path manipulation
40 .Dq Unified Extensible Firmware Interface
42 Device Paths, as defined in the UEFI standard, to and from binary form.
43 Binary and textual forms are defined in Chapter 9 of the UEFI
48 Formats a binary UEFI Device Path into its canonical UTF-8 textual form.
49 A binary Device Path can be no longer than 65536 bytes.
50 The textual form must fit into 65536 bytes.
51 Multiple binary device paths may be specified.
53 Parses a UEFI Device Path UTF-8 specification and outputs the binary
55 Only one device path is parsed, even if there are multiple present in
57 Leading white space is ignored.
58 The resulting binary Device Path can be no longer than 65536 bytes.
59 Multiple lines may be specified.
60 Each one will be translated.
62 Translate a Unix file path to an EFI Device Path.
63 The output is the textual representation of the EFI Device Path.
65 Translate an EFI device path to a Unix file path.
66 The input is the textual representation of the EFI Device Path.
69 Appendix A of the UEFI specification has the format for GUIDs.
71 .Dq Globally Unique Identifiers
72 have the format described in RFC 4122.
74 The Unified Extensible Firmware Interface Specification is available
80 utility first appeared in