Module Name: src
Committed By: uwe
Date: Wed May 22 00:02:47 UTC 2024
Modified Files:
src/usr.bin/mkubootimage: mkubootimage.1
Log Message:
mkubootimage.1: improve markup
To generate a diff of this commit:
cvs rdiff -u -r1.19 -r1.20 src/usr.bin/mkubootimage/mkubootimage.1
Please note that diffs are not public domain; they are subject to the
copyright notices on the relevant files.
Modified files:
Index: src/usr.bin/mkubootimage/mkubootimage.1
diff -u src/usr.bin/mkubootimage/mkubootimage.1:1.19 src/usr.bin/mkubootimage/mkubootimage.1:1.20
--- src/usr.bin/mkubootimage/mkubootimage.1:1.19 Tue May 21 23:31:21 2024
+++ src/usr.bin/mkubootimage/mkubootimage.1 Wed May 22 00:02:46 2024
@@ -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.
.\" All rights reserved.
@@ -35,18 +35,65 @@
.Nd create U-Boot loader image
.Sh SYNOPSIS
.Nm
+.
.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
-.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 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
-.Fl n Ar image
-.Op Fl O Po freebsd Ns | Ns linux Ns | Ns netbsd Ns | Ns openbsd Pc
-.Fl T No ( fs Ns | Ns kernel Ns | Ns kernel_noload Ns | Ns ramdisk Ns | Ns script Ns | Ns standalone )
+.
+.Fl n Ar name
+.
+.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
+.
.Ar source destination
.\"
.Sh DESCRIPTION
@@ -56,23 +103,46 @@ utility is used to create an image for D
.Qq Universal Boot Loader .
.Pp
The arguments are as follows:
-.Bl -tag -width indent
-.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 )
+.Bl -tag -width Fl
+.
+.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.
This is required for
-.Qq uimg
+.Ql uimg
format images.
+.
.It Fl a Ar address
Sets the image load address.
This is an integer between 0 and
.Dv UINT32_MAX .
This is required for all
-.Qq uimg
-image types except for script, ramdisk, and kernel_noload.
-.It Fl C No ( bz2 Ns | Ns gz Ns | Ns lzma Ns | Ns lzo Ns | Ns none )
+.Ql uimg
+image types except for
+.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.
The default is
-.Qq none .
+.Ql none .
+.
.It Fl E Ar address
Define the entry point.
This is an integer between 0 and
@@ -88,6 +158,7 @@ or
are not set, the entry point defaults to the
image load address
.Pq Fl a .
+.
.It Fl e Ar address
Define the entry point.
This is an integer between 0 and
@@ -99,37 +170,61 @@ or
are not set, the entry point defaults to the
image load address
.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.
The default is
-.Qq uimg .
+.Ql uimg .
+.
.It Fl h
Display the usage and exit.
+.
.It Fl m Ar magic
Set the magic used for
-.Qq uimg
+.Ql uimg
format images.
This is an integer between 0 and
.Dv UINT32_MAX .
The default is
-.Qq 0x27051956 .
-.It Fl n Ar image
+.Ql 0x27051956 .
+.
+.It Fl n Ar name
Defines the image name.
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.
The default OS name is
-.Qq netbsd .
-.It Fl T No ( fs Ns | Ns kernel Ns | Ns kernel_noload Ns | Ns ramdisk Ns | Ns script Ns | Ns standalone )
+.Ql netbsd .
+.
+.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.
This is required for
-.Qq uimg
+.Ql uimg
format images.
+.
.It Fl t Ar epoch
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
Update the header in an existing file instead of creating a new one.
+.
.El
.Pp
The required
@@ -147,7 +242,7 @@ generate a header, or create the image.
.Sh EXAMPLES
Before the image is written, the header is displayed to standard out;
for example:
-.Bd -literal -offset 0
+.Bd -literal -offset indent
image type: uimg
magic: 0x27051956
time: Tue May 21 18:05:09 2024
@@ -164,8 +259,10 @@ for example:
.Ed
.\" .Sh FILES
.Sh SEE ALSO
-.Qq Das U-Boot - the Universal Boot Loader
-.Pa http://www.denx.de/wiki/U-Boot/
+.Rs
+.%T Das U-Boot \(en the Universal Boot Loader
+.%U http://www.denx.de/wiki/U-Boot/
+.Re
.\"
.\" .Sh STANDARDS
.\"
