summaryrefslogtreecommitdiff
path: root/docs/appendix/commandtree
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2019-11-27 17:20:36 +0100
committerChristian Poessinger <christian@poessinger.com>2019-11-27 17:20:38 +0100
commit6aa3cbb611f74bdf8e44d5527f5138f3122a7497 (patch)
tree009a1fe9447bdd980d5017d49f102e7ccdace03b /docs/appendix/commandtree
parent76bbe2744d7184ee50626d9d7b65f21dad1c7e99 (diff)
downloadvyos-documentation-6aa3cbb611f74bdf8e44d5527f5138f3122a7497.tar.gz
vyos-documentation-6aa3cbb611f74bdf8e44d5527f5138f3122a7497.zip
Refactor "code-block:: sh" to "code-block:: console"
This will add proper new-lines into the rendered PDF. Before if it has been a long line, not all content was preserved in the PDF.
Diffstat (limited to 'docs/appendix/commandtree')
-rw-r--r--docs/appendix/commandtree/configmode.rst62
-rw-r--r--docs/appendix/commandtree/operationmode.rst58
2 files changed, 60 insertions, 60 deletions
diff --git a/docs/appendix/commandtree/configmode.rst b/docs/appendix/commandtree/configmode.rst
index abb20f98..2eaa96fc 100644
--- a/docs/appendix/commandtree/configmode.rst
+++ b/docs/appendix/commandtree/configmode.rst
@@ -3,7 +3,7 @@
Configuration mode
------------------
-.. code-block:: sh
+.. code-block:: console
confirm Confirm prior commit-confirm
comment Add comment to this configuration element
@@ -39,21 +39,21 @@ The command cannot be used at the top of the configuration hierarchy, only on su
To add a comment to a section, while being already at the proper section level:
-.. code-block:: sh
+.. code-block:: console
[edit <section>]
vyos@vyos# comment "Type Comment Here"
To add a comment directly to a section, from the top or a higher section:
-.. code-block:: sh
+.. code-block:: console
[edit]
vyos@vyos# comment <section> "Type Comment Here"
To remove a comment, add a blank comment to overwrite:
-.. code-block:: sh
+.. code-block:: console
[edit <section>]
vyos@vyos# comment ""
@@ -63,7 +63,7 @@ Examples
To add a comment to the "interfaces" section:
-.. code-block:: sh
+.. code-block:: console
[edit]
vyos@vyos# edit interfaces
@@ -74,7 +74,7 @@ To add a comment to the "interfaces" section:
The comment would then appear like this:
-.. code-block:: sh
+.. code-block:: console
[edit]
vyos@vyos# show
@@ -86,7 +86,7 @@ The comment would then appear like this:
An important thing to note is that since the comment is added on top of the section, it will not appear if the ``show <section>`` command is used. With the above example, the ``show interfaces`` command would return starting after the "interfaces {" line, hiding the comment:
-.. code-block:: sh
+.. code-block:: console
[edit]
vyos@vyos# show interfaces
@@ -96,7 +96,7 @@ An important thing to note is that since the comment is added on top of the sect
To add a comment to the interfaces section from the top:
-.. code-block:: sh
+.. code-block:: console
[edit]
vyos@vyos# comment interfaces "test"
@@ -104,7 +104,7 @@ To add a comment to the interfaces section from the top:
The comment can be added to any node that already exists, even if it's multiple levels lower:
-.. code-block:: sh
+.. code-block:: console
[edit]
vyos@vyos# comment interfaces ethernet eth0 vif 222 address "Far down comment"
@@ -119,7 +119,7 @@ To discard the changes without committing, use the ``discard`` command. The ``co
The confirm keyword can be added, see ``commit-confirm``. A comment can be entered, it will appear in the commit log.
-.. code-block:: sh
+.. code-block:: console
[edit]
vyos@vyos# commit
@@ -134,7 +134,7 @@ The ``commit-confirm`` command commits the proposed changes to the configuration
If the ``confirm`` command is not entered before the timer expiration, the configuration will be rolled back and VyOS will reboot.
The default timer value is 10 minutes, but a custom value can be entered.
-.. code-block:: sh
+.. code-block:: console
[edit]
vyos@vyos# commit-confirm
@@ -149,7 +149,7 @@ Compare
VyOS maintains backups of previous configurations. To compare configuration revisions in configuration mode, use the compare command:
-.. code-block:: sh
+.. code-block:: console
[edit]
vyos@vyos# compare
@@ -178,7 +178,7 @@ The ``copy`` command allows you to copy a configuration object.
Copy the configuration entrys from a firewall name WAN rule 1 to rule 2.
-.. code-block:: sh
+.. code-block:: console
[edit firewall name WAN]
vyos@vyos# show
@@ -212,7 +212,7 @@ The ``delte`` command is to delete a configuration entry.
This Example delete the hole ``service tftp-server`` section.
-.. code-block:: sh
+.. code-block:: console
delete service tftp-server
@@ -221,7 +221,7 @@ Discard
The ``discard`` command removes all pending configuration changes.
-.. code-block:: sh
+.. code-block:: console
[edit]
vyos@vyos# discard
@@ -235,7 +235,7 @@ The ``edit`` command allows you to navigate down into the configuration tree.
To get back to an upper level, use the ``up`` command or use the ``top`` command to get back to the upper most level.
The ``[edit]`` text displays where the user is located in the configuration tree.
-.. code-block:: sh
+.. code-block:: console
[edit]
vyos@vyos# edit interfaces
@@ -255,7 +255,7 @@ The ``exit`` command doesn't save the configuration, only the ``save`` command d
Exiting from a configuration level:
-.. code-block:: sh
+.. code-block:: console
[edit interfaces ethernet eth0]
vyos@vyos# exit
@@ -264,7 +264,7 @@ Exiting from a configuration level:
Exiting from configuration mode:
-.. code-block:: sh
+.. code-block:: console
[edit]
vyos@vyos# exit
@@ -273,14 +273,14 @@ Exiting from configuration mode:
Exiting from operational mode:
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ exit
logout
Error message when trying to exit with uncommitted changes:
-.. code-block:: sh
+.. code-block:: console
vyos@vyos# exit
Cannot exit: configuration modified.
@@ -291,7 +291,7 @@ Error message when trying to exit with uncommitted changes:
Warning message when exiting with unsaved changes:
-.. code-block:: sh
+.. code-block:: console
[edit]
vyos@vyos# exit
@@ -304,7 +304,7 @@ Load
The ``load`` command load a configuration from a local or remote file. You have to be use ``commit`` to make the change active
-.. code-block:: sh
+.. code-block:: console
<Enter> Load from system config file
<file> Load from file on local machine
@@ -316,7 +316,7 @@ The ``load`` command load a configuration from a local or remote file. You have
tftp://<host>/<file> Load from file on remote machine
-.. code-block:: sh
+.. code-block:: console
[edit]
vyos@vyos# load
@@ -330,7 +330,7 @@ Loadkey
Copies the content of a public key to the ~/.ssh/authorized_keys file.
-.. code-block:: sh
+.. code-block:: console
loadkey <username> [tab]
@@ -348,7 +348,7 @@ The ``merge`` command merge the config from a local or remote file with the runn
In the example below exist a ``default-firewall.config`` file with some common firewall rules you saved earlier.
-.. code-block:: sh
+.. code-block:: console
[edit]
vyos@vyos# show firewall
@@ -392,7 +392,7 @@ The ``rename`` command allows you to rename or move a configuration object.
See here how to move the configuration entrys from vlanid 3 to 2
-.. code-block:: sh
+.. code-block:: console
[edit interfaces ethernet eth1]
vyos@vyos# show
@@ -427,7 +427,7 @@ Rollback
You can ``rollback`` configuration using the rollback command, however this command will currently trigger a system reboot.
Use the compare command to verify the configuration you want to rollback to.
-.. code-block:: sh
+.. code-block:: console
vyos@vyos# compare 1
[edit system]
@@ -447,7 +447,7 @@ Run
The ``run`` command allows you to execute any operational mode commands without exiting the configuration session.
-.. code-block:: sh
+.. code-block:: console
[edit]
vyos@vyos# run show interfaces
@@ -462,7 +462,7 @@ Save
The ``save`` command saves the current configuration to non-volatile storage. VyOS also supports saving and loading configuration remotely using SCP, FTP, or TFTP.
-.. code-block:: sh
+.. code-block:: console
<Enter> Save to system config file
<file> Save to file on local machine
@@ -476,7 +476,7 @@ Set
The ``set`` command create all configuration entrys
-.. code-block:: sh
+.. code-block:: console
[edit]
vyos@vyos# set protocols static route 0.0.0.0/0 next-hop 192.168.1.1
@@ -488,7 +488,7 @@ The ``show`` command in the configuration mode displays the configuration and sh
Show the hole config, the address and description of eth1 is moving to vlan 2 if you commit the changes.
-.. code-block:: sh
+.. code-block:: console
[edit]
vyos@vyos# show
diff --git a/docs/appendix/commandtree/operationmode.rst b/docs/appendix/commandtree/operationmode.rst
index 487df032..96c7a631 100644
--- a/docs/appendix/commandtree/operationmode.rst
+++ b/docs/appendix/commandtree/operationmode.rst
@@ -8,7 +8,7 @@ After this is the first view after the login.
Please see :ref:`cli` for navigation in the CLI
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ [tab]
@@ -44,7 +44,7 @@ Please see :ref:`cli` for navigation in the CLI
Add
^^^
-.. code-block:: sh
+.. code-block:: console
raid Add a RAID set element
system Add an item to a system facility
@@ -52,7 +52,7 @@ Add
Clear
^^^^^
-.. code-block:: sh
+.. code-block:: console
console Clear screen
firewall Clear firewall statistics
@@ -69,13 +69,13 @@ 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.
To clone the running config to a system image:
-.. code-block:: sh
+.. code-block:: console
clone system config <system-image> from running
To clone from system image A to system image B:
-.. code-block:: sh
+.. code-block:: console
clone system config <system-image-B> from <system-image-A>
@@ -85,7 +85,7 @@ Configure
The ``configure`` command allows you to enter configuration mode.
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ configure
[edit]
@@ -97,7 +97,7 @@ Connect
The ``connect`` command allows you to bring up a connection oriented interface, like a pppoe interface.
-.. code-block:: sh
+.. code-block:: console
connect interface <interface>
@@ -108,7 +108,7 @@ The ``copy`` command allows you to copy a file to your running config or over im
It can look like this example:
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ copy file [tab]
Possible completions:
@@ -127,7 +127,7 @@ It can look like this example:
To copy from file A to file B:
-.. code-block:: sh
+.. code-block:: console
copy <file A> to <file B>
@@ -135,7 +135,7 @@ To copy from file A to file B:
Delete
^^^^^^
-.. code-block:: sh
+.. code-block:: console
conntrack Delete Conntrack entries
file Delete files in a particular image
@@ -149,14 +149,14 @@ Disconnect
The ``disconnect`` command allows you to take down a connection oriented interface, like a pppoe interface.
-.. code-block:: sh
+.. code-block:: console
disconnect interface <interface>
Force
^^^^^
-.. code-block:: sh
+.. code-block:: console
arp Send gratuitous ARP request or reply
cluster Force a cluster state transition
@@ -167,14 +167,14 @@ Format
The ``format`` command allows you to format a disk the same way as another one.
-.. code-block:: sh
+.. code-block:: console
format disk <target> like <source>
Generate
^^^^^^^^
-.. code-block:: sh
+.. code-block:: console
openvpn OpenVPN key generation tool
ssh-server-key
@@ -188,7 +188,7 @@ Install
The ``install`` command allows you to install the system image on the disk.
-.. code-block:: sh
+.. code-block:: console
install image
@@ -198,7 +198,7 @@ Monitor
``monitor`` can be used to continually view what is happening on the router.
-.. code-block:: sh
+.. code-block:: console
bandwidth Monitor interface bandwidth in real time
bandwidth-test
@@ -232,7 +232,7 @@ Ping
The ``ping`` command allows you to send an ICMP-EchoRequest packet and display the ICMP-EchoReply received.
-.. code-block:: sh
+.. code-block:: console
<hostname> Send Internet Control Message Protocol (ICMP) echo request
<x.x.x.x>
@@ -244,7 +244,7 @@ Poweroff
The ``poweroff`` command allows you to properly shut down the VyOS instance. Without any modifier, the command is executed immediately.
-.. code-block:: sh
+.. code-block:: console
<Enter> Execute the current command
at Poweroff at a specific time
@@ -256,7 +256,7 @@ Reboot
^^^^^^
The ``reboot`` command allows you to properly restart the VyOS instance. Without any modifier, the command is executed immediately.
-.. code-block:: sh
+.. code-block:: console
<Enter> Execute the current command
at Poweroff at a specific time
@@ -269,7 +269,7 @@ Release
The ``release`` command allows you to release a DHCP or DHCPv6 lease.
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ release dhcp interface <int>
vyos@vyos:~$ release dhcpv6 interface <int>
@@ -280,7 +280,7 @@ Rename
The ``rename`` command allows you to rename a system image.
-.. code-block:: sh
+.. code-block:: console
rename system image <currentname> <newname>
@@ -290,7 +290,7 @@ Renew
The ``renew`` command allows you to renew a DHCP or DHCPv6 lease.
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ renew dhcp interface <int>
vyos@vyos:~$ renew dhcpv6 interface <int>
@@ -298,7 +298,7 @@ The ``renew`` command allows you to renew a DHCP or DHCPv6 lease.
Reset
^^^^^
-.. code-block:: sh
+.. code-block:: console
conntrack Reset all currently tracked connections
conntrack-sync
@@ -315,7 +315,7 @@ Reset
Restart
^^^^^^^
-.. code-block:: sh
+.. code-block:: console
cluster Restart cluster node
conntrack-sync
@@ -335,7 +335,7 @@ Restart
Set
^^^
-.. code-block:: sh
+.. code-block:: console
<OPTION> Bash builtin set command
console Control console behaviors
@@ -346,7 +346,7 @@ Set
Show
^^^^
-.. code-block:: sh
+.. code-block:: console
arp Show Address Resolution Protocol (ARP) information
bridge Show bridging information
@@ -410,7 +410,7 @@ In the past the ``telnet`` command allowed you to connect remotely to another de
Telnet is unencrypted and should not use anymore. But its nice to test if an TCP Port to a host is open.
-.. code-block:: sh
+.. code-block:: console
vyos@vyos:~$ telnet 192.168.1.3 443
Trying 192.168.1.3...
@@ -426,7 +426,7 @@ Traceroute
The ``traceroute`` command allows you to trace the path taken to a particular device.
-.. code-block:: sh
+.. code-block:: console
<hostname> Track network path to specified node
<x.x.x.x>
@@ -438,7 +438,7 @@ The ``traceroute`` command allows you to trace the path taken to a particular de
Update
^^^^^^
-.. code-block:: sh
+.. code-block:: console
dns Update DNS information
webproxy Update webproxy \ No newline at end of file