mkubootimage.1: improve markup

This commit is contained in:
uwe 2024-05-22 00:02:46 +00:00
parent 7d9f356046
commit 61a71e7495
1 changed files with 124 additions and 27 deletions

View File

@ -1,4 +1,4 @@
.\" $NetBSD: mkubootimage.1,v 1.19 2024/05/21 23:31:21 uwe Exp $ .\" $NetBSD: mkubootimage.1,v 1.20 2024/05/22 00:02:46 uwe Exp $
.\" .\"
.\" Copyright (c) 2012 The NetBSD Foundation, Inc. .\" Copyright (c) 2012 The NetBSD Foundation, Inc.
.\" All rights reserved. .\" All rights reserved.
@ -35,18 +35,65 @@
.Nd create U-Boot loader image .Nd create U-Boot loader image
.Sh SYNOPSIS .Sh SYNOPSIS
.Nm .Nm
.
.Op Fl hu .Op Fl hu
.Fl A No ( arm Ns | Ns arm64 Ns | Ns i386 Ns | Ns mips Ns | Ns mips64 Ns | Ns or1k Ns | Ns powerpc Ns | Ns riscv Ns | Ns sh ) .
.Fl A Po Xo
.Li arm Ns \||\| Ns
.Li arm64 Ns \||\| Ns
.Li i386 Ns \||\| Ns
.Li mips Ns \||\| Ns
.Li mips64 Ns \||\| Ns
.Li or1k Ns \||\| Ns
.Li powerpc Ns \||\| Ns
.Li riscv Ns \||\| Ns
.Li sh
.Xc Pc
.
.br
.Fl a Ar address .Fl a Ar address
.Op Fl C Po bz2 Ns | Ns gz Ns | Ns lzma Ns | Ns lzo Ns | Ns none Pc .
.Oo Fl C Po Xo
.Li bz2 Ns \||\| Ns
.Li gz Ns \||\| Ns
.Li lzma Ns \||\| Ns
.Li lzo Ns \||\| Ns
.Li none
.Xc Pc Oc
.
.Op Fl E Ar address .Op Fl E Ar address
.
.Op Fl e Ar address .Op Fl e Ar address
.Op Fl f Po arm64 Ns | Ns uimg Pc .
.Oo Fl f Po Xo
.Li arm64 Ns \||\| Ns
.Li uimg
.Xc Pc Oc
.
.Op Fl m Ar magic .Op Fl m Ar magic
.Fl n Ar image .
.Op Fl O Po freebsd Ns | Ns linux Ns | Ns netbsd Ns | Ns openbsd Pc .Fl n Ar name
.Fl T No ( fs Ns | Ns kernel Ns | Ns kernel_noload Ns | Ns ramdisk Ns | Ns script Ns | Ns standalone ) .
.br
.Oo Fl O Po Xo
.Li freebsd Ns \||\| Ns
.Li linux Ns \||\| Ns
.Li netbsd Ns \||\| Ns
.Li openbsd
.Xc Pc Oc
.
.br
.Fl T Po Xo
.Li fs Ns \||\| Ns
.Li kernel Ns \||\| Ns
.Li kernel_noload Ns \||\| Ns
.Li ramdisk Ns \||\| Ns
.Li script Ns \||\| Ns
.Li standalone
.Xc Pc
.
.Op Fl t Ar epoch .Op Fl t Ar epoch
.
.Ar source destination .Ar source destination
.\" .\"
.Sh DESCRIPTION .Sh DESCRIPTION
@ -56,23 +103,46 @@ utility is used to create an image for Das U-Boot, the
.Qq Universal Boot Loader . .Qq Universal Boot Loader .
.Pp .Pp
The arguments are as follows: The arguments are as follows:
.Bl -tag -width indent .Bl -tag -width Fl
.It Fl A No ( arm Ns | Ns arm64 Ns | Ns i386 Ns | Ns mips Ns | Ns mips64 Ns | Ns or1k Ns | Ns powerpc Ns | Ns riscv Ns | Ns sh ) .
.It Fl A Po Xo
.Li arm Ns \||\| Ns
.Li arm64 Ns \||\| Ns
.Li i386 Ns \||\| Ns
.Li mips Ns \||\| Ns
.Li mips64 Ns \||\| Ns
.Li or1k Ns \||\| Ns
.Li powerpc Ns \||\| Ns
.Li riscv Ns \||\| Ns
.Li sh
.Xc Pc
Defines the architecture. Defines the architecture.
This is required for This is required for
.Qq uimg .Ql uimg
format images. format images.
.
.It Fl a Ar address .It Fl a Ar address
Sets the image load address. Sets the image load address.
This is an integer between 0 and This is an integer between 0 and
.Dv UINT32_MAX . .Dv UINT32_MAX .
This is required for all This is required for all
.Qq uimg .Ql uimg
image types except for script, ramdisk, and kernel_noload. image types except for
.It Fl C No ( bz2 Ns | Ns gz Ns | Ns lzma Ns | Ns lzo Ns | Ns none ) .Li script , ramdisk ,
and
.Li kernel_noload .
.
.It Fl C Po Xo
.Li bz2 Ns \||\| Ns
.Li gz Ns \||\| Ns
.Li lzma Ns \||\| Ns
.Li lzo Ns \||\| Ns
.Li none
.Xc Pc
Defines the compression. Defines the compression.
The default is The default is
.Qq none . .Ql none .
.
.It Fl E Ar address .It Fl E Ar address
Define the entry point. Define the entry point.
This is an integer between 0 and This is an integer between 0 and
@ -88,6 +158,7 @@ or
are not set, the entry point defaults to the are not set, the entry point defaults to the
image load address image load address
.Pq Fl a . .Pq Fl a .
.
.It Fl e Ar address .It Fl e Ar address
Define the entry point. Define the entry point.
This is an integer between 0 and This is an integer between 0 and
@ -99,37 +170,61 @@ or
are not set, the entry point defaults to the are not set, the entry point defaults to the
image load address image load address
.Pq Fl a . .Pq Fl a .
.It Fl f No ( arm64 Ns | Ns uimg ) .
.It Fl f Po Xo
.Li arm64 Ns \||\| Ns
.Li uimg
.Xc Pc
Defines the output image format type. Defines the output image format type.
The default is The default is
.Qq uimg . .Ql uimg .
.
.It Fl h .It Fl h
Display the usage and exit. Display the usage and exit.
.
.It Fl m Ar magic .It Fl m Ar magic
Set the magic used for Set the magic used for
.Qq uimg .Ql uimg
format images. format images.
This is an integer between 0 and This is an integer between 0 and
.Dv UINT32_MAX . .Dv UINT32_MAX .
The default is The default is
.Qq 0x27051956 . .Ql 0x27051956 .
.It Fl n Ar image .
.It Fl n Ar name
Defines the image name. Defines the image name.
This is required. This is required.
.It Fl O No ( freebsd Ns | Ns linux Ns | Ns netbsd Ns | Ns openbsd ) .
.It Fl O Po Xo
.Li freebsd Ns \||\| Ns
.Li linux Ns \||\| Ns
.Li netbsd Ns \||\| Ns
.Li openbsd
.Xc Pc
Defines the operating system type. Defines the operating system type.
The default OS name is The default OS name is
.Qq netbsd . .Ql netbsd .
.It Fl T No ( fs Ns | Ns kernel Ns | Ns kernel_noload Ns | Ns ramdisk Ns | Ns script Ns | Ns standalone ) .
.It Fl T Po Xo
.Li fs Ns \||\| Ns
.Li kernel Ns \||\| Ns
.Li kernel_noload Ns \||\| Ns
.Li ramdisk Ns \||\| Ns
.Li script Ns \||\| Ns
.Li standalone
.Xc Pc
Defines the image type. Defines the image type.
This is required for This is required for
.Qq uimg .Ql uimg
format images. format images.
.
.It Fl t Ar epoch .It Fl t Ar epoch
Use given epoch timestamp as image creation time. Use given epoch timestamp as image creation time.
(This is only used for legacy U-Boot images.) .Pq This is only used for legacy U-Boot images.
.
.It Fl u .It Fl u
Update the header in an existing file instead of creating a new one. Update the header in an existing file instead of creating a new one.
.
.El .El
.Pp .Pp
The required The required
@ -147,7 +242,7 @@ generate a header, or create the image.
.Sh EXAMPLES .Sh EXAMPLES
Before the image is written, the header is displayed to standard out; Before the image is written, the header is displayed to standard out;
for example: for example:
.Bd -literal -offset 0 .Bd -literal -offset indent
image type: uimg image type: uimg
magic: 0x27051956 magic: 0x27051956
time: Tue May 21 18:05:09 2024 time: Tue May 21 18:05:09 2024
@ -164,8 +259,10 @@ for example:
.Ed .Ed
.\" .Sh FILES .\" .Sh FILES
.Sh SEE ALSO .Sh SEE ALSO
.Qq Das U-Boot - the Universal Boot Loader .Rs
.Pa http://www.denx.de/wiki/U-Boot/ .%T Das U-Boot \(en the Universal Boot Loader
.%U http://www.denx.de/wiki/U-Boot/
.Re
.\" .\"
.\" .Sh STANDARDS .\" .Sh STANDARDS
.\" .\"