diff options
| -rw-r--r-- | docs/cli.rst | 17 | ||||
| -rw-r--r-- | docs/command-list-configuration.rst | 10 | ||||
| -rw-r--r-- | docs/command-list-operation.rst | 10 |
3 files changed, 21 insertions, 16 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 diff --git a/docs/command-list-configuration.rst b/docs/command-list-configuration.rst index a1c370e6..7b981518 100644 --- a/docs/command-list-configuration.rst +++ b/docs/command-list-configuration.rst @@ -1,9 +1,7 @@ -############ -Command List -############ +.. _configuration_level_commands: -Configuration level commands: - -.. _cfg_cmd_list: +******************************** +Configuration Level Command List +******************************** .. cfgcmdlist:: diff --git a/docs/command-list-operation.rst b/docs/command-list-operation.rst index 3dabd653..bbb0298c 100644 --- a/docs/command-list-operation.rst +++ b/docs/command-list-operation.rst @@ -1,9 +1,7 @@ -############# -Commands List -############# +.. _operational_level_commands: -Operational level commands: - -.. _op_cmd_list: +****************************** +Operational Level Command List +****************************** .. opcmdlist:: |