u-boot/doc/usage/cmd/cat.rst
Tom Rini 11da3403e9 doc: usage: Add general rule for $?
For nearly all commands in U-Boot the '?' variable is handled the same
way with 0 meaning success, 1 meaning any failure.  Explain this in the
general rules section of the cmdline documentation (with a link to a
counter example) and then remove the redundant wording from most
commands. We retain a section about the return value in a number of
places where we are doing something such as always returning a specific
value or we have useful additional information to go along with the
normal return codes.

Signed-off-by: Tom Rini <trini@konsulko.com>
Reviewed-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
2025-10-26 09:03:35 -06:00

48 lines
620 B
ReStructuredText

.. SPDX-License-Identifier: GPL-2.0+:
.. index::
single: cat (command)
cat command
===========
Synopsis
--------
::
cat <interface> <dev[:part]> <file>
Description
-----------
The cat command prints the file content 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:
::
=> cat mmc 0:1 hello
hello world
=>
Configuration
-------------
The cat command is only available if CONFIG_CMD_CAT=y.