summaryrefslogtreecommitdiff
path: root/docs/commandtree
diff options
context:
space:
mode:
authorsrividya0208 <a.srividya@vyos.io>2021-08-18 12:58:46 -0400
committersrividya0208 <a.srividya@vyos.io>2021-08-19 00:09:35 -0400
commitc061829d260eef67786e0972b4cac0b3caac52ac (patch)
treec96d62de95b8d03a397d36df9369d8d92b241b29 /docs/commandtree
parent9eb90286c0ca7712e1f55812a5affb18facd8293 (diff)
downloadvyos-documentation-c061829d260eef67786e0972b4cac0b3caac52ac.tar.gz
vyos-documentation-c061829d260eef67786e0972b4cac0b3caac52ac.zip
grammar & spelling correction
Diffstat (limited to 'docs/commandtree')
-rw-r--r--docs/commandtree/configmode.rst6
-rw-r--r--docs/commandtree/operationmode.rst39
2 files changed, 29 insertions, 16 deletions
diff --git a/docs/commandtree/configmode.rst b/docs/commandtree/configmode.rst
index 3e398d5a..0a443522 100644
--- a/docs/commandtree/configmode.rst
+++ b/docs/commandtree/configmode.rst
@@ -1,3 +1,5 @@
+:lastproofread: 2021-08-18
+
.. _commandtree_configmode:
Configuration mode
@@ -34,7 +36,7 @@ The ``confirm`` command confirms the prior ``commit-confirm``.
Comment
^^^^^^^
-The ``comment`` commands allow you to insert a comment above the current
+The ``comment`` command allow you to insert a comment above the current
configuration section.
The command cannot be used at the top of the configuration hierarchy, only on
subsections. Comments need to be commited, just like other config changes.
@@ -515,7 +517,7 @@ Show
^^^^
The ``show`` command in the configuration mode displays the configuration and
-show uncommitted changes.
+shows the uncommitted changes.
Shows the whole config, the address and description of eth1 is moving to vlan 2
if you commit the changes.
diff --git a/docs/commandtree/operationmode.rst b/docs/commandtree/operationmode.rst
index 8092f248..78f507b6 100644
--- a/docs/commandtree/operationmode.rst
+++ b/docs/commandtree/operationmode.rst
@@ -1,10 +1,12 @@
+:lastproofread: 2021-08-16
+
.. _commandtree_operationmode:
Operational mode
----------------
-Operational mode allows for commands to perform operational system tasks and view system and service status.
-After this is the first view after the login.
+Operational mode allows for commands to perform operational system tasks and
+view system and service status. This is the first view after the login.
Please see :ref:`cli` for navigation in the CLI
@@ -66,7 +68,8 @@ Clear
Clone
^^^^^
-The ``clone`` command allows you to clone a configuration from a system image to another one, or from the running config to another system image.
+The ``clone`` command allows you to clone a configuration from a system image
+to another one, or from the running config to another system image.
To clone the running config to a system image:
.. code-block:: none
@@ -95,7 +98,8 @@ The ``configure`` command allows you to enter configuration mode.
Connect
^^^^^^^
-The ``connect`` command allows you to bring up a connection oriented interface, like a pppoe interface.
+The ``connect`` command allows you to bring up a connection oriented interface,
+like a pppoe interface.
.. code-block:: none
@@ -104,7 +108,8 @@ The ``connect`` command allows you to bring up a connection oriented interface,
Copy
^^^^
-The ``copy`` command allows you to copy a file to your running config or over images.
+The ``copy`` command allows you to copy a file to your running config or over
+images.
It can look like this example:
@@ -147,7 +152,8 @@ Delete
Disconnect
^^^^^^^^^^
-The ``disconnect`` command allows you to take down a connection oriented interface, like a pppoe interface.
+The ``disconnect`` command allows you to take down a connection oriented
+interface, like a pppoe interface.
.. code-block:: none
@@ -196,7 +202,7 @@ The ``install`` command allows you to install the system image on the disk.
Monitor
^^^^^^^
-``monitor`` can be used to continually view what is happening on the router.
+``monitor`` can be used to continuously view what is happening on the router.
.. code-block:: none
@@ -230,7 +236,8 @@ Monitor
Ping
^^^^
-The ``ping`` command allows you to send an ICMP-EchoRequest packet and display the ICMP-EchoReply received.
+The ``ping`` command allows you to send an ICMP-EchoRequest packet and display
+the ICMP-EchoReply received.
.. code-block:: none
@@ -242,7 +249,8 @@ The ``ping`` command allows you to send an ICMP-EchoRequest packet and display t
Poweroff
^^^^^^^^
-The ``poweroff`` command allows you to properly shut down the VyOS instance. Without any modifier, the command is executed immediately.
+The ``poweroff`` command allows you to properly shut down the VyOS instance.
+Without any modifier, the command is executed immediately.
.. code-block:: none
@@ -254,7 +262,8 @@ The ``poweroff`` command allows you to properly shut down the VyOS instance. Wit
Reboot
^^^^^^
-The ``reboot`` command allows you to properly restart the VyOS instance. Without any modifier, the command is executed immediately.
+The ``reboot`` command allows you to properly restart the VyOS instance. Without
+ any modifier, the command is executed immediately.
.. code-block:: none
@@ -406,8 +415,9 @@ Show
Telnet
^^^^^^
-In the past the ``telnet`` command allowed you to connect remotely to another device using the telnet protocol.
-Telnet is unencrypted and should not use anymore. But its nice to test if an TCP Port to a host is open.
+In the past the ``telnet`` command allowed you to connect remotely to another
+device using the telnet protocol. Telnet is unencrypted and should not be used
+anymore. But its nice to test if a TCP Port to a host is open or not.
.. code-block:: none
@@ -424,7 +434,8 @@ Telnet is unencrypted and should not use anymore. But its nice to test if an TCP
Traceroute
^^^^^^^^^^
-The ``traceroute`` command allows you to trace the path taken to a particular device.
+The ``traceroute`` command allows you to trace the path taken to a particular
+device.
.. code-block:: none
@@ -441,4 +452,4 @@ Update
.. code-block:: none
dns Update DNS information
- webproxy Update webproxy \ No newline at end of file
+ webproxy Update webproxy