doc: describe the false command

Provide a man-page for the false command.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>

diff --git a/doc/usage/false.rst b/doc/usage/false.rst
new file mode 100644 (file)
index 0000000..a17fe86
--- /dev/null
+++ b/doc/usage/false.rst
@@ -0,0 +1,28 @@
+false command
+=============
+
+Synopsis
+--------
+
+::
+
+    false
+
+Description
+-----------
+
+The false command sets the return value $? to 1 (false).
+
+Example
+-------
+
+::
+
+    => false; echo $?
+    1
+    =>
+
+Configuration
+-------------
+
+The false command is only available if CONFIG_HUSH_PARSER=y.

diff --git a/doc/usage/index.rst b/doc/usage/index.rst
index d3abf2d88af3ffc446bfe7faf9063f296b9be9be..0309abf2ffd89c8b312e913f772f47bf904bba48 100644 (file)
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@@ -19,6 +19,7 @@ Shell commands
    button
    echo
    exit
+   false
    for
    loady
    mbr