[U-Boot] [PATCH v2] Add mkimage manpage
As for some distribution, a mkimage command is made a package. However, there was not manual of mkimage. This provides manual of mkimage.
Signed-off-by: Nobuhiro Iwamatsu iwamatsu@nigauri.org --- tools/mkimage.1 | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 65 insertions(+), 0 deletions(-) create mode 100644 tools/mkimage.1
diff --git a/tools/mkimage.1 b/tools/mkimage.1 new file mode 100644 index 0000000..d8079bb --- /dev/null +++ b/tools/mkimage.1 @@ -0,0 +1,65 @@ +.TH MKIMAGE 1 "2010-05-16" + +.SH NAME +mkimage - Generate image for U-Boot +.SH SYNOPSIS +.B mkimage +.RB [\fIoptions\fP] +.SH "DESCRIPTION" +.B mkimage +can also be used to create images for use with U-Boot, either +separated from the Linux kernel image, or combined into one file. +mkimage encapsulates the images with header containing information +about target architecture, operating system, image type, compression method, +entry points, time stamp, checksums, etc. + +.SH "OPTIONS" + +.TP +.BI "-l [" "uimage file name" "]" +mkimage lists the information contained in the header of an existing U-Boot image. + +.TP +.BI "-A [" "architecture" "]" +Set architecture. Pass -h as the architecture to see the list of supported architectures. + +.TP +.BI "-O [" "os" "]" +Set operating system. bootm command of u-boot changes boot method by os type. +Pass -h as the OS to see the list of supported OS. + +.TP +.BI "-T [" "image type" "]" +Set image type. +Pass -h as the image to see the list of supported image type. + +.TP +.BI "-C [" "compression type" "]" +Set compression type. +Pass -h as the compression to see the list of supported compression type. + +.TP +.BI "-a [" "load addess" "]" +Set load address with a hex number. + +.TP +.BI "-e [" "entry point" "]" +Set entry point with a hex number. + +.TP +.BI "-n [" "image name" "]" +Set image name to 'image name'. + +.TP +.BI "-d [" "image data file" "]" +Use image data from 'image data file'. + +.TP +.BI "-x" +Set XIP (execute in place) flag. + +.SH HOMEPAGE +http://www.denx.de/wiki/U-Boot/WebHome +.PP +.SH AUTHOR +This manual page was written by Nobuhiro Iwamatsu iwamatsu@nigauri.org
On Wed, 16 Jun 2010 10:38:24 +0900 Nobuhiro Iwamatsu iwamatsu@nigauri.org wrote:
Hello Nobuhiro,
As for some distribution, a mkimage command is made a package. However, there was not manual of mkimage. This provides manual of mkimage.
I recall looking for one several years ago ;)
+.SH SYNOPSIS +.B mkimage +.RB [\fIoptions\fP]
mkimage -h shows more invocation variants than "mkimage [OPTIONS]":
mkimage -l IMAGE
mkimage [-x] -A arch -O os -T type -C comp -a addr -e ep -n name -d DATAFILE[:DATAFILE...] IMAGE
..suggesting certain OPTIONS are not [optional].
+.SH "DESCRIPTION" +.B mkimage +can also be used to create images for use with U-Boot, either
s/can also be/is used to/ ?
+.BI "-l [" "uimage file name" "]" +mkimage lists the information contained in the header of an existing U-Boot image.
s/mkimage lists/list/
+.BI "-A [" "architecture" "]" +Set architecture. Pass -h as the architecture to see the list of supported architectures.
Set target architecture. If architecture is invalid, mkimage will list target architectures it supports.
+.BI "-O [" "os" "]" +Set operating system. bootm command of u-boot changes boot method by os type. +Pass -h as the OS to see the list of supported OS.
-O and the rest could use the same kind of fix as above - mkimage doesn't specifically check for "-O -h".
also, an example would be nice if possible :)
Thanks,
Kim
Dear Nobuhiro Iwamatsu,
In message 1276652304-22025-1-git-send-email-iwamatsu@nigauri.org you wrote:
As for some distribution, a mkimage command is made a package. However, there was not manual of mkimage. This provides manual of mkimage.
Signed-off-by: Nobuhiro Iwamatsu iwamatsu@nigauri.org
tools/mkimage.1 | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 files changed, 65 insertions(+), 0 deletions(-) create mode 100644 tools/mkimage.1
Applied with modifications and extensions: - moved to doc/ directory - added documentation for FIT images - added examples
Thanks.
Best regards,
Wolfgang Denk
participants (3)
-
Kim Phillips -
Nobuhiro Iwamatsu -
Wolfgang Denk