aboutsummaryrefslogtreecommitdiff
path: root/doc/usage/cmd/bootd.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/usage/cmd/bootd.rst')
-rw-r--r--doc/usage/cmd/bootd.rst38
1 files changed, 38 insertions, 0 deletions
diff --git a/doc/usage/cmd/bootd.rst b/doc/usage/cmd/bootd.rst
new file mode 100644
index 0000000..380ef15
--- /dev/null
+++ b/doc/usage/cmd/bootd.rst
@@ -0,0 +1,38 @@
+.. SPDX-License-Identifier: GPL-2.0+:
+
+bootd command
+=============
+
+Synopsis
+--------
+
+::
+
+ bootd
+
+Description
+-----------
+
+The bootd command executes the command stored in the environment variable
+*bootcmd*, i.e. it does the same thing as *run bootcmd*.
+
+Example
+-------
+
+::
+
+ => setenv bootcmd 'echo Hello World'
+ => bootd
+ Hello World
+ => setenv bootcmd true
+ => bootd; echo $?
+ 0
+ => setenv bootcmd false
+ => bootd; echo $?
+ 1
+
+Return value
+------------
+
+The return value $? of the bootd command is the return value of the command in
+the environment variable *bootcmd*.