diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/conf.py | 2 | ||||
| -rw-r--r-- | docs/contributing/documentation.rst | 2 | ||||
| -rw-r--r-- | docs/interfaces/geneve.rst | 8 | ||||
| -rw-r--r-- | docs/interfaces/wireless.rst | 2 | ||||
| -rw-r--r-- | docs/routing/arp.rst | 2 | ||||
| -rw-r--r-- | docs/vpn/openvpn.rst | 4 |
6 files changed, 10 insertions, 10 deletions
diff --git a/docs/conf.py b/docs/conf.py index 1591b9bb..f6e81710 100644 --- a/docs/conf.py +++ b/docs/conf.py @@ -170,4 +170,4 @@ texinfo_documents = [ def setup(app): app.add_object_type('opcmd', 'opcmd') - app.add_object_type('cfcmd', 'cfcmd') + app.add_object_type('cfgcmd', 'cfgcmd') diff --git a/docs/contributing/documentation.rst b/docs/contributing/documentation.rst index c89be9d4..33803c98 100644 --- a/docs/contributing/documentation.rst +++ b/docs/contributing/documentation.rst @@ -132,7 +132,7 @@ Please don't use other public address space. Specific Sphinx-doc Markup ^^^^^^^^^^^^^^^^^^^^^^^^^^ -When documenting CLI commands use the ``.. cfcmd::`` directive for +When documenting CLI commands use the ``.. cfgcmd::`` directive for the configuration mode and the ``.. opcmd::`` directive for operational mode commands. Under the command a short exlaination should be provide. diff --git a/docs/interfaces/geneve.rst b/docs/interfaces/geneve.rst index ce0273b9..4090b2e5 100644 --- a/docs/interfaces/geneve.rst +++ b/docs/interfaces/geneve.rst @@ -30,15 +30,15 @@ Geneve Header: | Variable Length Options | +-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+-+ -.. cfcmd:: set interfaces geneve gnv0 address '192.0.2.2/24' +.. cfgcmd:: set interfaces geneve gnv0 address '192.0.2.2/24' Create GENEVE tunnel listening on local address `192.0.2.2/24`. -.. cfcmd:: set interfaces geneve gnv0 remote '172.18.204.10' +.. cfgcmd:: set interfaces geneve gnv0 remote '172.18.204.10' Specify the IP address of the other end of the tunnel. -.. cfcmd:: set interfaces geneve gnv0 vni '1000' +.. cfgcmd:: set interfaces geneve gnv0 vni '1000' :abbr:`VNI (Virtual Network Identifier)` is an identifier for a unique element of a virtual network. In many situations this may represent an L2 segment, @@ -47,6 +47,6 @@ packets. The VNI MAY be used as part of ECMP forwarding decisions or MAY be used as a mechanism to distinguish between overlapping address spaces contained in the encapsulated packet when load balancing across CPUs. -.. cfcmd:: set interfaces geneve gnv0 mtu +.. cfgcmd:: set interfaces geneve gnv0 mtu Set interface :abbr:`MTU (Maximum Transfer Unit)` size. diff --git a/docs/interfaces/wireless.rst b/docs/interfaces/wireless.rst index 13eef0fe..1ae64644 100644 --- a/docs/interfaces/wireless.rst +++ b/docs/interfaces/wireless.rst @@ -25,7 +25,7 @@ its MAC address) and configured to run in monitor mode. To be able to use the wireless interfaces you will first need to set a regulatory domain with the country code of your locaion. -.. cfcmd:: set system wifi-regulatory-domain DE +.. cfgcmd:: set system wifi-regulatory-domain DE Configure system wide Wi-Fi regulatory domain. A reboot is required for this change to be enabled. diff --git a/docs/routing/arp.rst b/docs/routing/arp.rst index a1a8c430..b2a02f9b 100644 --- a/docs/routing/arp.rst +++ b/docs/routing/arp.rst @@ -19,7 +19,7 @@ implemented. Configure ========= -.. cfcmd:: set protocols static arp 192.0.2.100 hwaddr 00:53:27:de:23:aa +.. cfgcmd:: set protocols static arp 192.0.2.100 hwaddr 00:53:27:de:23:aa This will configure a static ARP entry always resolving `192.0.2.100` to `00:53:27:de:23:aa` diff --git a/docs/vpn/openvpn.rst b/docs/vpn/openvpn.rst index 1a9ee9cf..491e6e6d 100644 --- a/docs/vpn/openvpn.rst +++ b/docs/vpn/openvpn.rst @@ -446,13 +446,13 @@ all users can benefit from it. If you are a hacker or want to try on your own we support passing raw OpenVPN options to OpenVPN. -.. cfcmd:: set interfaces openvpn vtun10 openvpn-option 'persistent-key' +.. cfgcmd:: set interfaces openvpn vtun10 openvpn-option 'persistent-key' Will add ``persistent-key`` at the end of the generated OpenVPN configuration. Please use this only as last resort - things might break and OpenVPN won't start if you pass invalid options/syntax. -.. cfcmd:: set interfaces openvpn vtun10 openvpn-option 'push "keepalive 1 10"' +.. cfgcmd:: set interfaces openvpn vtun10 openvpn-option 'push "keepalive 1 10"' Will add ``push "keepalive 1 10"`` to the generated OpenVPN config file. |