xref: /openbsd-src/usr.sbin/mkuboot/mkuboot.8 (revision 354523d4ecce81e9fabd986b48b9319b326f6062)
1.\"     $OpenBSD: mkuboot.8,v 1.2 2021/06/01 02:13:15 jsg Exp $
2.\"
3.\" Copyright (c) 2008 Mark Kettenis <kettenis@openbsd.org>
4.\"
5.\" Permission to use, copy, modify, and distribute this software for any
6.\" purpose with or without fee is hereby granted, provided that the above
7.\" copyright notice and this permission notice appear in all copies.
8.\"
9.\" THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES
10.\" WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF
11.\" MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR
12.\" ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES
13.\" WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN
14.\" ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF
15.\" OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE.
16.\"
17.Dd $Mdocdate: June 1 2021 $
18.Dt MKUBOOT 8
19.Os
20.Sh NAME
21.Nm mkuboot
22.Nd create U-Boot files
23.Sh SYNOPSIS
24.Nm
25.Op Fl a Ar arch
26.Op Fl e Ar entry
27.Op Fl l Ar loadaddr
28.Op Fl n Ar name
29.Op Fl o Ar os
30.Op Fl t Ar type
31.Ar infile outfile
32.Sh DESCRIPTION
33The
34.Nm
35utility creates images suitable for loading using the U-Boot bootloader.
36.Pp
37The options are as follows:
38.Bl -tag -width xxxxxxxxxxx
39.It Fl a Ar arch
40Sets the image architecture to
41.Ar arch .
42For a list of valid arguments, see below.
43.It Fl e Ar entry
44Sets the entry point to
45.Ar entry .
46.It Fl l Ar loadaddr
47Sets the load address to
48.Ar loadaddr .
49.It Fl n Ar name
50Sets the name of the loaded object inside the generated image.
51.It Fl o Ar os
52Sets the image OS to
53.Ar os .
54.Ar os
55can be either
56.Dq Linux
57or
58.Dq OpenBSD .
59.It Fl t Ar type
60Sets the type of the object to be loaded.
61For a list of valid arguments, see below.
62.El
63.Pp
64The following arguments are valid as the
65.Ar arch
66parameter:
67.Bd -unfilled -offset indent -compact
68aarch64
69alpha
70amd64
71arm
72i386
73m68k
74mips
75mips64
76powerpc
77sparc
78sparc64
79superh
80.Ed
81.Pp
82The following arguments are valid as the
83.Ar type
84parameter:
85.Bd -unfilled -offset indent -compact
86standalone
87kernel
88script
89.Ed
90.Sh HISTORY
91An
92.Nm
93utility first appeared in
94.Ox 4.4
95as
96.Nm mkboot .
97