doc: describe the false command

Provide a man-page for the false command. Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
2021-01-24 22:11:55 +01:00 · 2021-01-24 22:11:55 +01:00 · bce86e075f
commit bce86e075f
parent a03185a3ec
2 changed files with 29 additions and 0 deletions
--- a/doc/usage/false.rst
+++ 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.
--- a/doc/usage/index.rst
+++ b/doc/usage/index.rst
@ -19,6 +19,7 @@ Shell commands
   button
   echo
   exit
+   false
   for
   loady
   mbr