u-boot/doc/usage/cmd/xxd.rst
Heinrich Schuchardt 60971e63e6 doc: create index entries for commands
Add the description of CLI commands to the generated index.

Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2024-01-17 08:40:19 +01:00

53 lines
897 B
ReStructuredText

.. SPDX-License-Identifier: GPL-2.0+:
.. index::
single: xxd (command)
xxd command
===========
Synopsis
--------
::
xxd <interface> <dev[:part]> <file>
Description
-----------
The xxd command prints the file content as hexdump to standard out.
interface
interface for accessing the block device (mmc, sata, scsi, usb, ....)
dev
device number
part
partition number, defaults to 1
file
path to file
Example
-------
Here is the output for a example text file:
::
=> xxd mmc 0:1 hello
00000000: 68 65 6c 6c 6f 20 77 6f 72 6c 64 0a 00 01 02 03 hello world.....
00000010: 04 05 ..
=>
Configuration
-------------
The xxd command is only available if CONFIG_CMD_XXD=y.
Return value
------------
The return value $? is set to 0 (true) if the file is readable, otherwise it returns a non-zero error code.