summaryrefslogtreecommitdiff
path: root/doc/usage
diff options
context:
space:
mode:
authorHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-10-07 21:51:35 +0300
committerHeinrich Schuchardt <heinrich.schuchardt@canonical.com>2022-10-10 17:34:25 +0300
commitc9704ce7eccc62f913e125852f47e0455fe9fb3c (patch)
tree16417730c910b77be4f16ba357c8869c0ada1472 /doc/usage
parentc6db606dbb5ecb4480a9b83bab1a61800f556493 (diff)
downloadu-boot-c9704ce7eccc62f913e125852f47e0455fe9fb3c.tar.xz
doc: man-page for cls
Provide a man-page for the cls command. Signed-off-by: Heinrich Schuchardt <heinrich.schuchardt@canonical.com> Reviewed-by: Simon Glass <sjg@chromium.org>
Diffstat (limited to 'doc/usage')
-rw-r--r--doc/usage/cmd/cls.rst26
-rw-r--r--doc/usage/index.rst1
2 files changed, 27 insertions, 0 deletions
diff --git a/doc/usage/cmd/cls.rst b/doc/usage/cmd/cls.rst
new file mode 100644
index 0000000000..b5c43e0a2e
--- /dev/null
+++ b/doc/usage/cmd/cls.rst
@@ -0,0 +1,26 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+cls command
+===========
+
+Synopsis
+--------
+
+::
+
+ cls
+
+Description
+-----------
+
+The cls command clears the screen.
+
+Configuration
+-------------
+
+The cls command is only available if CONFIG_CMD_CLS=y.
+
+Return value
+------------
+
+The return value $? is 0 (true) on success and 1 (false) on failure.
diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index 0fda121026..d0641105ae 100644
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -32,6 +32,7 @@ Shell commands
cmd/button
cmd/bootz
cmd/cbsysinfo
+ cmd/cls
cmd/conitrace
cmd/cyclic
cmd/dm