staticd: Do not ready prefix for printing till it's decoded

[mirror_frr.git] / snapcraft / README.usage.md

diff --git a/snapcraft/README.usage.md b/snapcraft/README.usage.md
index c678c8805c42725eefa0b492504f52bf76ee80a8..a7b51a5656f8603e906f0e2e8f01ad493dd4aa8d 100644 (file)
--- a/snapcraft/README.usage.md
+++ b/snapcraft/README.usage.md
@@ -18,7 +18,7 @@ ie for `ospf6d` (OSPFv3):
     systemctl enable snap.frr.ospf6d.service
 
 The daemons are: `ripd`, `ripngd`, `ospfd`, `ospf6d`, `isisd`, `bgpd`, 
-`pimd`, `zebra`
+`pimd`, `ldpd`, `eigrpd`, `babeld`, `nhrpd`, `bfdd`, `zebra`
 
 Commands defined by this snap
 -----------------------------
@@ -30,6 +30,8 @@ Commands defined by this snap
        options
 - `frr.readme`:
        Returns this document `cat README_usage.md`
+- `frr.set`:
+       Allows to enable `FPM` and/or disable RPKIi module. See Module section below
 
 and for debugging defined at this time (May get removed later - do not 
 depend on them). These are mainly intended to debug the Snap
@@ -51,7 +53,19 @@ depend on them). These are mainly intended to debug the Snap
 - `frr.pimd-debug`:
        Starts pimd daemon in foreground
 - `frr.ldpd-debug`:
-    Starts ldpd daemon in foreground
+        Starts ldpd daemon in foreground
+- `frr.nhrpd-debug`:
+        Starts nhrpd daemon in foreground
+- `frr.babeld-debug`:
+        Starts babeld daemon in foreground
+- `frr.eigrpd-debug`:
+        Starts eigrpd daemon in foreground
+- `frr.pbrd-debug`:
+        Starts pbrd daemon in foreground
+- `frr.staticd-debug`:
+        Starts staticd daemon in foreground
+- `frr.bfdd-debug`:
+        Starts bfdd daemon in foreground
 
 MPLS (LDP)
 ----------
@@ -86,20 +100,49 @@ are named `eth0`, `eth1` and `eth2`, then the additional lines in
 These settings require either a reboot or a manual configuration with
 `sysctl` as well.
 
+Modules
+----------
+The `frr.set` allows to turn FPM module ond the RPKI module on or off.
+
+    frr.set fpm {disable|protobuf|netlink}
+    
+    Disables FPM or enables FPM with selected mode (default: disabled)
+
+By default, the FPM module is disabled, but installed with netlink and
+protobuf support. To enable the FPM module, use the `frr.set fpm protobuf`
+or `frr.set fpm netlink` command. The command will only enable the mode
+for the next restart of zebra. Please reboot or restart zebra after
+changing the mode to become effective.
+
+    frr.set rpki {enable|disable}
+   
+    Disables or enables BGP RPKI (default: enabled)
+
+By default, the RPKI module is enabled. To disable the RPKI module
+use the `frr.set rpki disable` command. The command will only enable
+the module after the next restart of the bgp daemon. Please reboot or 
+restart bgpd after changing the mode to become effective.
+(Normally, there is no need to disable the module as it has no effect
+if there are no RPKI configurations in BGP)
+
 FAQ
 ---
 - frr.vtysh displays `--MORE--` on long output. How to suppress this?
     - Define `VTYSH_PAGER` to `cat` (default is `more`). (Ie add 
       `export VTYSH_PAGER=cat` to the end of your `.profile`)
 
-- ospfd / ospf6d are not running after installation
-       - Installing a new snap starts the daemons, but at this time they
-         may not have the required priviledged access. Make sure you 
-         issue the `snap connect` command as given above (can be verified
-         with `snap interfaces`) and **THEN** restart the daemons (or
-         reboot the system). 
-         This is a limitation of any snap package at this time which
-         requires priviledged interfaces (ie to manipulate routing tables)
+- bfdd / ospfd / ospf6d / nhrpd are not running after installation
+    - Installing a new snap starts the daemons, but at this time they
+      may not have the required privileged access. Make sure you 
+      issue the `snap connect` command as given above (can be verified
+      with `snap interfaces`) and **THEN** restart the daemons (or
+      reboot the system). 
+      This is a limitation of any snap package at this time which
+      requires privileged interfaces (ie to manipulate routing tables)
+
+- Can I run vtysh directly without the "frr." prefix?
+    - Yes, enable the vtysh alias in the frr snap package by:
+      sudo snap alias frr vtysh
        
 Sourcecode available
 ====================