From: Glenn Washburn <development@efficientek.com>
Date: Wed, 26 Jul 2023 18:50:11 +0000 (-0500)
Subject: docs: Document hexdump command
X-Git-Tag: grub-2.12~100
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=7ff4f3c9632fa635d21a7afdd38b4bcfbfae2c99;p=thirdparty%2Fgrub.git

docs: Document hexdump command

Signed-off-by: Glenn Washburn <development@efficientek.com>
Reviewed-by: Oskari Pirhonen <xxc3ncoredxx@gmail.com>
Reviewed-by: Daniel Kiper <daniel.kiper@oracle.com>
---

diff --git a/docs/grub.texi b/docs/grub.texi
index 9d5daa6ee..3634507ac 100644
--- a/docs/grub.texi
+++ b/docs/grub.texi
@@ -4327,6 +4327,7 @@ you forget a command, you can run the command @command{help}
 * halt::                        Shut down your computer
 * hashsum::                     Compute or check hash checksum
 * help::                        Show help messages
+* hexdump::                     Show raw contents of a file or memory
 * insmod::                      Insert a module
 * keystatus::                   Check key modifier status
 * list_env::                    List variables in environment block
@@ -4945,6 +4946,20 @@ about each of the commands whose names begin with those @var{patterns}.
 @end deffn
 
 
+@node hexdump
+@subsection hexdump
+
+@deffn Command hexdump [--skip offset] [--length len] FILE_OR_DEVICE
+Show raw contents of a file or memory. When option @option{--skip} is given,
+@samp{offset} number of bytes are skipped from the start of the device or
+file given. And @option{--length} allows specifying a maximum number of bytes
+to be shown.
+
+If given the special device named @samp{(mem)}, then the @samp{offset} given to
+@option{--skip} is treated as the address of a memory location to dump from.
+@end deffn
+
+
 @node insmod
 @subsection insmod
 
@@ -6131,7 +6146,6 @@ GRUB shell may provide more information on parameters and usage.
 @item @command{gdbstub} -  Start GDB stub on given port
 @item @command{gdbstub_stop} - Stop GDB stub
 @item @command{hdparm} - Get/set ATA disk parameters.
-@item @command{hexdump} - Show raw contents of a file or memory.
 @item @command{hexdump_random} - Hexdump random data.
 @item @command{inb} - Read 8-bit value from PORT.
 @item @command{inl} - Read 32-bit value from PORT.