From 9ed5ac0cd6e8f0745c866db8ffd229323091fd15 Mon Sep 17 00:00:00 2001 From: Christian Poessinger Date: Wed, 27 Nov 2019 17:31:39 +0100 Subject: 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. --- docs/appendix/commandtree/configmode.rst | 62 +++++++++++------------ docs/appendix/commandtree/operationmode.rst | 58 +++++++++++----------- docs/appendix/examples/azure-vpn-bgp.rst | 16 +++--- docs/appendix/examples/azure-vpn-dual-bgp.rst | 16 +++--- docs/appendix/examples/bgp-ipv6-unnumbered.rst | 20 ++++---- docs/appendix/examples/dmvpn.rst | 6 +-- docs/appendix/examples/ospf-unnumbered.rst | 12 ++--- docs/appendix/examples/tunnelbroker-ipv6.rst | 12 ++--- docs/appendix/examples/zone-policy.rst | 22 ++++----- docs/appendix/migrate-from-vyatta.rst | 6 +-- docs/appendix/troubleshooting.rst | 34 ++++++------- docs/appendix/vyos-on-baremetal.rst | 12 ++--- docs/cli.rst | 8 +-- docs/clustering.rst | 8 +-- docs/commandscripting.rst | 16 +++--- docs/configuration-overview.rst | 40 +++++++-------- docs/contributing/build-vyos.rst | 8 +-- docs/contributing/development.rst | 4 +- docs/firewall.rst | 18 +++---- docs/high-availability.rst | 22 ++++----- docs/image-mgmt.rst | 8 +-- docs/install.rst | 20 ++++---- docs/interfaces/addresses.rst | 22 ++++----- docs/interfaces/bonding.rst | 14 +++--- docs/interfaces/bridging.rst | 14 +++--- docs/interfaces/dummy.rst | 2 +- docs/interfaces/ethernet.rst | 6 +-- docs/interfaces/index.rst | 4 +- docs/interfaces/l2tpv3.rst | 10 ++-- docs/interfaces/pppoe.rst | 12 ++--- docs/interfaces/qinq.rst | 4 +- docs/interfaces/tunnel.rst | 22 ++++----- docs/interfaces/vlan.rst | 6 +-- docs/interfaces/vxlan.rst | 28 +++++------ docs/interfaces/wireless.rst | 6 +-- docs/load-balancing.rst | 36 +++++++------- docs/nat.rst | 34 ++++++------- docs/qos.rst | 56 ++++++++++----------- docs/quick-start.rst | 32 ++++++------ docs/routing/arp.rst | 6 +-- docs/routing/bgp.rst | 20 ++++---- docs/routing/igmp-proxy.rst | 2 +- docs/routing/mss-clamp.rst | 6 +-- docs/routing/ospf.rst | 18 +++---- docs/routing/pbr.rst | 14 +++--- docs/routing/rip.rst | 4 +- docs/routing/routing-policy.rst | 6 +-- docs/routing/static.rst | 4 +- docs/services/conntrack.rst | 12 ++--- docs/services/dhcp-relay.rst | 20 ++++---- docs/services/dhcp.rst | 12 ++--- docs/services/dhcpv6.rst | 68 +++++++++++++------------- docs/services/dns-forwarding.rst | 14 +++--- docs/services/dynamic-dns.rst | 24 ++++----- docs/services/ipoe-server.rst | 16 +++--- docs/services/lldp.rst | 2 +- docs/services/mdns-repeater.rst | 4 +- docs/services/pppoe-server.rst | 30 ++++++------ docs/services/snmp.rst | 12 ++--- docs/services/ssh.rst | 6 +-- docs/services/sstp-server.rst | 4 +- docs/services/tftp.rst | 4 +- docs/services/udp-broadcast-relay.rst | 8 +-- docs/services/webproxy.rst | 8 +-- docs/system/config-management.rst | 6 +-- docs/system/eventhandler.rst | 4 +- docs/system/flowaccounting.rst | 6 +-- docs/system/host-information.rst | 36 +++++++------- docs/system/login-users.rst | 20 ++++---- docs/system/ntp.rst | 4 +- docs/system/proxy.rst | 4 +- docs/system/serialconsole.rst | 2 +- docs/system/syslog.rst | 16 +++--- docs/system/task-scheduler.rst | 8 +-- docs/system/time-zone.rst | 2 +- docs/vpn/dmvpn.rst | 12 ++--- docs/vpn/gre-ipsec.rst | 14 +++--- docs/vpn/l2tp.rst | 16 +++--- docs/vpn/openvpn.rst | 38 +++++++------- docs/vpn/pptp.rst | 6 +-- docs/vpn/site2site_ipsec.rst | 12 ++--- docs/vpn/wireguard.rst | 26 +++++----- 82 files changed, 646 insertions(+), 646 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
] 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
"Type Comment Here" To remove a comment, add a blank comment to overwrite: -.. code-block:: sh +.. code-block:: console [edit
] 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
`` 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 Load from system config 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:/// 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 [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 Save to system config 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 from running To clone from system image A to system image B: -.. code-block:: sh +.. code-block:: console clone system config from @@ -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 @@ -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 to @@ -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 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 like 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 Send Internet Control Message Protocol (ICMP) echo request @@ -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 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 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 vyos@vyos:~$ release dhcpv6 interface @@ -280,7 +280,7 @@ Rename The ``rename`` command allows you to rename a system image. -.. code-block:: sh +.. code-block:: console rename system image @@ -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 vyos@vyos:~$ renew dhcpv6 interface @@ -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