doc: man-page base command
authorHeinrich Schuchardt <xypron.glpk@gmx.de>
Thu, 31 Dec 2020 14:42:05 +0000 (15:42 +0100)
committerHeinrich Schuchardt <xypron.glpk@gmx.de>
Sat, 16 Jan 2021 10:17:20 +0000 (11:17 +0100)
Provide a description of the base command.

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

diff --git a/doc/usage/base.rst b/doc/usage/base.rst
new file mode 100644 (file)
index 0000000..db9cd4d
--- /dev/null
@@ -0,0 +1,23 @@
+.. SPDX-License-Identifier: GPL-2.0+
+
+base command
+============
+
+Synopsis
+--------
+
+::
+
+    base [address]
+
+Description
+-----------
+
+The *base* command sets or displays the address offset used by the memory
+commands *cmp, cp, md, mdc, mm, ms, mw, mwc*.
+
+All other commands ignore the address defined by *base*.
+
+address
+    new base address as hexadecimal number. If no value is provided, the current
+    value is displayed.
index fbb2c04..57bf4fe 100644 (file)
@@ -11,6 +11,7 @@ Shell commands
 .. toctree::
    :maxdepth: 1
 
+   base
    bootefi
    bootmenu
    button