doc: document true command
authorHeinrich Schuchardt <xypron.glpk@gmx.de>
Fri, 22 Jan 2021 18:25:53 +0000 (19:25 +0100)
committerHeinrich Schuchardt <xypron.glpk@gmx.de>
Mon, 25 Jan 2021 00:15:34 +0000 (01:15 +0100)
Create a man-page for the true command.

Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
doc/usage/index.rst
doc/usage/true.rst [new file with mode: 0644]

index 1304b59..d3abf2d 100644 (file)
@@ -24,3 +24,4 @@ Shell commands
    mbr
    pstore
    sbi
+   true
diff --git a/doc/usage/true.rst b/doc/usage/true.rst
new file mode 100644 (file)
index 0000000..f9ef71b
--- /dev/null
@@ -0,0 +1,28 @@
+true command
+============
+
+Synopsis
+--------
+
+::
+
+    true
+
+Description
+-----------
+
+The true command sets the return value $? to 0 (true).
+
+Example
+-------
+
+::
+
+    => true; echo $?
+    0
+    =>
+
+Configuration
+-------------
+
+The true command is only available if CONFIG_HUSH_PARSER=y.