Return-Path: X-Spam-Checker-Version: SpamAssassin 3.4.0 (2014-02-07) on aws-us-west-2-korg-lkml-1.web.codeaurora.org Received: from phobos.denx.de (phobos.denx.de [85.214.62.61]) (using TLSv1.2 with cipher ECDHE-RSA-AES128-GCM-SHA256 (128/128 bits)) (No client certificate requested) by smtp.lore.kernel.org (Postfix) with ESMTPS id 62EBFC433EF for ; Sun, 12 Jun 2022 22:16:54 +0000 (UTC) Received: from h2850616.stratoserver.net (localhost [IPv6:::1]) by phobos.denx.de (Postfix) with ESMTP id E089C8446D; Mon, 13 Jun 2022 00:15:01 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=u-boot-bounces@lists.denx.de Authentication-Results: phobos.denx.de; dkim=pass (2048-bit key; unprotected) header.d=gmail.com header.i=@gmail.com header.b="dFWAGnUL"; dkim-atps=neutral Received: by phobos.denx.de (Postfix, from userid 109) id CA8E383E73; Mon, 13 Jun 2022 00:14:36 +0200 (CEST) Received: from mail-qt1-x82e.google.com (mail-qt1-x82e.google.com [IPv6:2607:f8b0:4864:20::82e]) (using TLSv1.3 with cipher TLS_AES_128_GCM_SHA256 (128/128 bits)) (No client certificate requested) by phobos.denx.de (Postfix) with ESMTPS id 1657684440 for ; Mon, 13 Jun 2022 00:14:30 +0200 (CEST) Authentication-Results: phobos.denx.de; dmarc=pass (p=none dis=none) header.from=gmail.com Authentication-Results: phobos.denx.de; spf=pass smtp.mailfrom=seanga2@gmail.com Received: by mail-qt1-x82e.google.com with SMTP id hf10so2842524qtb.7 for ; Sun, 12 Jun 2022 15:14:29 -0700 (PDT) DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=gmail.com; s=20210112; h=from:to:cc:subject:date:message-id:in-reply-to:references :mime-version:content-transfer-encoding; bh=OJc2JVMKaDppA9AQNhQdQ4p6HdZFBtqLSDD4sDdXbz8=; b=dFWAGnULC0c9ogjFE7hVSvRC79taLNtV7Z1g5dTnKu5ycnDm8aDt0zqcYrgUNXsqMb 0s+znzMk9KeSjuDFqFTQJCIHfWvVCo197hoZNLREIYlf7o97TmM8+3v6BlheUqx3cKep nBuKKnU/haVEDRlV9oHN4rSkV4zK3i17p4K9A6eb/MOjV/X2HWQIH7RXsG8iCMqoiHna yHQaHQcGaO1LAbf5msIhzjwPjmRE4dVboSC/Hyz7WziPv1sfJPyZZsVAwf3N7AwmWvOF sEvv5rMDpqYN0LJCMzxqZFSoFPyt0N8yNqfZtKRid0vRVoH9lVYvxN6/Mr+spGre0P/W Ay/w== X-Google-DKIM-Signature: v=1; a=rsa-sha256; c=relaxed/relaxed; d=1e100.net; s=20210112; h=x-gm-message-state:from:to:cc:subject:date:message-id:in-reply-to :references:mime-version:content-transfer-encoding; bh=OJc2JVMKaDppA9AQNhQdQ4p6HdZFBtqLSDD4sDdXbz8=; b=yazV0JseTsepxhtTqxPe7hnhyleGy+EmJo9SLb8q5WkxypCEqwu7f43/cdupaHKf5G Pyo7Ohe/BSBikQWEOAIgoJZEjiKcNr00jYvxvokA4Vu3uHMhetay+5wtRtKoO9tHjSJ2 lvmigF4D1aJQaiOuVtYqJYr6Xs1rqTWhOvRkPrRvyuUaMPFW+uCZLYGUrtgdUcnCP24Y MdkchoE55Dcs6eDvXbdiSeUcchLgUe+XOxOWx8xe+IeFw/Q27fQ0nF7PEqYm3sbaDK2S XF29U7Qw98lIcp9P9Uj82k3o98XO5XIxkQjkpfMYI7TephMBx+60syFvzqcM3wTG8PHO 1SGQ== X-Gm-Message-State: AOAM5321nn04qL3UReYtvA6BW1A8SzOYuCc+woyOQ34NRV9dNzOUYdYo 0cl9d0UH6lm6Rrpj3wqQptoKpTHz2YZYUKPL X-Google-Smtp-Source: ABdhPJzIikpB4FdpetRX9uVBIK4EzSbP0WcAqq0p75OElLKz5RYSCE8yjq6co6FnTpIjZ8l8Jl99cA== X-Received: by 2002:a05:622a:113:b0:304:e741:e462 with SMTP id u19-20020a05622a011300b00304e741e462mr34098021qtw.179.1655072068366; Sun, 12 Jun 2022 15:14:28 -0700 (PDT) Received: from localhost (pool-173-73-95-180.washdc.fios.verizon.net. [173.73.95.180]) by smtp.gmail.com with UTF8SMTPSA id c1-20020ac87d81000000b0030522a969e0sm3840706qtd.60.2022.06.12.15.14.27 (version=TLS1_3 cipher=TLS_AES_128_GCM_SHA256 bits=128/128); Sun, 12 Jun 2022 15:14:28 -0700 (PDT) From: Sean Anderson To: u-boot@lists.denx.de, Heinrich Schuchardt Cc: Simon Glass , Sean Anderson Subject: [PATCH v2 14/14] doc: Add man page for dumpimage Date: Sun, 12 Jun 2022 18:14:11 -0400 Message-Id: <20220612221411.1608406-15-seanga2@gmail.com> X-Mailer: git-send-email 2.35.1 In-Reply-To: <20220612221411.1608406-1-seanga2@gmail.com> References: <20220612221411.1608406-1-seanga2@gmail.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-BeenThere: u-boot@lists.denx.de X-Mailman-Version: 2.1.39 Precedence: list List-Id: U-Boot discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , Errors-To: u-boot-bounces@lists.denx.de Sender: "U-Boot" X-Virus-Scanned: clamav-milter 0.103.5 at phobos.denx.de X-Virus-Status: Clean This tool seems a bit underloved. Unfortunately, it seems to be missing support for FIT images. Alas... Add a man page documenting it. The example is taken from commit a804b5ce2d ("Add dumpimage, a tool to extract data from U-Boot images"). Signed-off-by: Sean Anderson --- Changes in v2: - Ensure comments are requests doc/dumpimage.1 | 103 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 103 insertions(+) create mode 100644 doc/dumpimage.1 diff --git a/doc/dumpimage.1 b/doc/dumpimage.1 new file mode 100644 index 0000000000..52a45a3404 --- /dev/null +++ b/doc/dumpimage.1 @@ -0,0 +1,103 @@ +.\" SPDX-License-Identifier: GPL-2.0 +.\" Copyright (C) 2022 Sean Anderson +.TH DUMPIMAGE 1 2022-06-11 U-Boot +.SH NAME +dumpimage \- extract data from U-Boot images +. +.SH SYNOPSIS +.SY dumpimage +.OP \-T type +.BI \-l\~ image +.YS +.SY dumpimage +.OP \-T type +.OP \-p position +.BI \-o\~ outfile +.I image +.YS +.SY dumpimage +.B \-h +.YS +.SY dumpimage +.B \-V +.YS +. +.SH DESCRIPTION +.B dumpimage +lists and extracts data from U-Boot images. If +.B \-l +is specified, +.B dumpimage +lists the components in +.IR image . +Otherwise, +.B dumpimage +extracts the component at +.IR position " to " outfile . +. +.SH OPTIONS +.TP +.B \-h +Print usage information and exit. +. +.TP +.B \-l +Print the header information for +.IR image , +including a list of components. +. +.TP +.BI \-o " outfile" +The file to write the dumped component to. +.TP +.BI \-p " position" +Specify the +.I position +of the component to dump. This should be a numeric index, starting at 0. If not +specified, the default +.I position +is 0. +. +.TP +.BI \-T " type" +Specify the +.I type +of the image. If not specified, the image type will be automatically detected. A +list of supported image types may be printed by running +.BR "mkimage\~\-T\~list" . +. +.TP +.B \-V +Print version information and exit. +. +.SH BUGS +Please report bugs to the +.UR https://\:source\:.denx\:.de/\:u-boot/\:u-boot/\:issues +U-Boot bug tracker +.UE . +.SH EXAMPLES +Create a multi-file image and then extract part of that image +.PP +.EX +.in +4 +$ \c +.B mkimage \-A x86 \-O linux \-T multi \-n x86 \\\\\& +.in +4 +.B \-d vmlinuz:initrd.img:System.map multi.img +.in +Image Name: x86 +Created: Thu Jul 25 10:29:13 2013 +Image Type: Intel x86 Linux Multi-File Image (gzip compressed) +Data Size: 13722956 Bytes = 13401.32 kB = 13.09 MB +Load Address: 00000000 +Entry Point: 00000000 +Contents: + Image 0: 4040128 Bytes = 3945.44 kB = 3.85 MB + Image 1: 7991719 Bytes = 7804.41 kB = 7.62 MB + Image 2: 1691092 Bytes = 1651.46 kB = 1.61 MB +$ \c +.B dumpimage -p 2 -o System.map multi.img +.EE +.in +.SH SEE ALSO +.BR mkimage (1) -- 2.35.1