diff options
| author | Heinrich Schuchardt <xypron.glpk@gmx.de> | 2021-01-24 22:11:55 +0100 |
|---|---|---|
| committer | Heinrich Schuchardt <xypron.glpk@gmx.de> | 2021-01-25 01:15:34 +0100 |
| commit | bce86e075fbe8b54262b73380846f10a9e9a0c0d (patch) | |
| tree | 1fc73f8a6eeb53465e862e65529793a2f2e9ae46 /doc | |
| parent | a03185a3ecbc5a51fbae9c1790b6148f8c68b1be (diff) | |
doc: describe the false command
Provide a man-page for the false command.
Signed-off-by: Heinrich Schuchardt <xypron.glpk@gmx.de>
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/usage/false.rst | 28 | ||||
| -rw-r--r-- | doc/usage/index.rst | 1 |
2 files changed, 29 insertions, 0 deletions
diff --git a/doc/usage/false.rst b/doc/usage/false.rst new file mode 100644 index 00000000000..a17fe860217 --- /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 d3abf2d88af..0309abf2ffd 100644 --- a/doc/usage/index.rst +++ b/doc/usage/index.rst @@ -19,6 +19,7 @@ Shell commands button echo exit + false for loady mbr |