summaryrefslogtreecommitdiff
path: root/docs/cli.rst
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2020-08-22 13:35:33 +0200
committerChristian Poessinger <christian@poessinger.com>2020-08-22 13:35:48 +0200
commita0bfcadc0ba67109511459aebcce1fc38fdaef05 (patch)
tree24f89300b9459e19a6e8540d90a4a12e6e07579e /docs/cli.rst
parent0efe17baefc40f8d9ec6f87420badab6faada2a3 (diff)
downloadvyos-documentation-a0bfcadc0ba67109511459aebcce1fc38fdaef05.tar.gz
vyos-documentation-a0bfcadc0ba67109511459aebcce1fc38fdaef05.zip
cli: fix broken links to command references
Diffstat (limited to 'docs/cli.rst')
-rw-r--r--docs/cli.rst17
1 files changed, 13 insertions, 4 deletions
diff --git a/docs/cli.rst b/docs/cli.rst
index 51b8e874..4694cc5d 100644
--- a/docs/cli.rst
+++ b/docs/cli.rst
@@ -4,13 +4,16 @@
CLI
###
-The VyOS :abbr:`CLI (Command-Line Interface)` comprises an
-operational and a configuration mode.
+The VyOS :abbr:`CLI (Command-Line Interface)` comprises an operational and a
+configuration mode.
+
+Operational Mode
+================
Operational mode allows for commands to perform operational system tasks and
view system and service status, while configuration mode allows for the
-modification of system configuration. The :ref:`cmd-index`
-lists available commands and their functions.
+modification of system configuration. The list of all operational level commands
+is available at :ref:`operational_level_commands`.
The CLI provides a built-in help system. In the CLI the ``?`` key may be used
to display available commands. The ``TAB`` key can be used to auto-complete
@@ -69,6 +72,12 @@ When viewing in page mode the following commands are available:
* ``left-arrow`` and ``right-arrow`` can be used to scroll left or right
in the event that the output has lines which exceed the terminal size.
+Configuration Mode
+==================
+
+The list of all operational level commands is available at
+:ref:`configuration_level_commands`.
+
To enter configuration mode use the ``configure`` command:
.. code-block:: none