u-boot/doc/usage/cmd/sleep.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

48 lines
879 B
ReStructuredText

.. SPDX-License-Identifier: GPL-2.0+
.. Copyright 2023, Heinrich Schuchardt <heinrich.schuchardt@canonical.com>
.. index::
single: sleep (command)
sleep command
=============
Synopsis
--------
::
sleep <delay>
Description
-----------
The *sleep* command waits for *delay* seconds. It can be interrupted by
CTRL+C.
delay
delay in seconds. The value is decimal and can be fractional.
Example
-------
The current data and time is display before and after sleeping for 3.2
seconds:
::
=> date; sleep 3.2; date
Date: 2023-01-21 (Saturday) Time: 16:02:41
Date: 2023-01-21 (Saturday) Time: 16:02:44
=>
Configuration
-------------
The command is only available if CONFIG_CMD_SLEEP=y.
Return value
------------
The return value $? is 0 (true) if the command completes.
The return value is 1 (false) if the command is interrupted by CTRL+C.