doc/dumpimage.1 at master · jcs.org/u-boot

jcs.org / u-boot
fork atom
"Das U-Boot" Source Tree
fork atom
u-boot / doc / dumpimage.1
at master 103 lines 2.0 kB view raw
wrap content
Sean Anderson doc: Add man page for dumpimage 3y ago
e297f874
  1.\" SPDX-License-Identifier: GPL-2.0
  2.\" Copyright (C) 2022 Sean Anderson <seanga2@gmail.com>
  3.TH DUMPIMAGE 1 2022-06-11 U-Boot
  4.SH NAME
  5dumpimage \- extract data from U-Boot images
  6.
  7.SH SYNOPSIS
  8.SY dumpimage
  9.OP \-T type
 10.BI \-l\~ image
 11.YS
 12.SY dumpimage
 13.OP \-T type
 14.OP \-p position
 15.BI \-o\~ outfile
 16.I image
 17.YS
 18.SY dumpimage
 19.B \-h
 20.YS
 21.SY dumpimage
 22.B \-V
 23.YS
 24.
 25.SH DESCRIPTION
 26.B dumpimage
 27lists and extracts data from U-Boot images. If
 28.B \-l
 29is specified,
 30.B dumpimage
 31lists the components in
 32.IR image .
 33Otherwise,
 34.B dumpimage
 35extracts the component at
 36.IR position " to " outfile .
 37.
 38.SH OPTIONS
 39.TP
 40.B \-h
 41Print usage information and exit.
 42.
 43.TP
 44.B \-l
 45Print the header information for
 46.IR image ,
 47including a list of components.
 48.
 49.TP
 50.BI \-o " outfile"
 51The file to write the dumped component to.
 52.TP
 53.BI \-p " position"
 54Specify the
 55.I position
 56of the component to dump. This should be a numeric index, starting at 0. If not
 57specified, the default
 58.I position
 59is 0.
 60.
 61.TP
 62.BI \-T " type"
 63Specify the
 64.I type
 65of the image. If not specified, the image type will be automatically detected. A
 66list of supported image types may be printed by running
 67.BR "mkimage\~\-T\~list" .
 68.
 69.TP
 70.B \-V
 71Print version information and exit.
 72.
 73.SH BUGS
 74Please report bugs to the
 75.UR https://\:source\:.denx\:.de/\:u-boot/\:u-boot/\:issues
 76U-Boot bug tracker
 77.UE .
 78.SH EXAMPLES
 79Create a multi-file image and then extract part of that image
 80.PP
 81.EX
 82.in +4
 83$ \c
 84.B mkimage \-A x86 \-O linux \-T multi \-n x86 \\\\\&
 85.in +4
 86.B \-d vmlinuz:initrd.img:System.map multi.img
 87.in
 88Image Name:   x86
 89Created:      Thu Jul 25 10:29:13 2013
 90Image Type:   Intel x86 Linux Multi-File Image (gzip compressed)
 91Data Size:    13722956 Bytes = 13401.32 kB = 13.09 MB
 92Load Address: 00000000
 93Entry Point:  00000000
 94Contents:
 95   Image 0: 4040128 Bytes = 3945.44 kB = 3.85 MB
 96   Image 1: 7991719 Bytes = 7804.41 kB = 7.62 MB
 97   Image 2: 1691092 Bytes = 1651.46 kB = 1.61 MB
 98$ \c
 99.B dumpimage -p 2 -o System.map multi.img
100.EE
101.in
102.SH SEE ALSO
103.BR mkimage (1)