summaryrefslogtreecommitdiff
path: root/doc/usage/cmd/cat.rst
blob: 5ef4731fe3f859c2ca8612a93fd3925a91a6edc9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
.. SPDX-License-Identifier: GPL-2.0+:

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.

Return value
------------

The return value $? is set to 0 (true) if the file is readable, otherwise it returns a non-zero error code.