Merge pull request #5809 from donaldsharp/vrf_name

[mirror_frr.git] / doc / user / installation.rst

diff --git a/doc/user/installation.rst b/doc/user/installation.rst
index b45c83ca1cf304cb3fef8e44e088bf252fdc8e9f..9cd1210529c46b212fb077f5f591b8c10c71628b 100644 (file)
--- a/doc/user/installation.rst
+++ b/doc/user/installation.rst
@@ -144,11 +144,21 @@ options from the list below.
    Build watchfrr with systemd integration, this will allow FRR to communicate with
    systemd to tell systemd if FRR has come up properly.
 
+.. option:: --enable-werror
+
+   Build with all warnings converted to errors as a compile option.  This
+   is recommended for developers only.
+
 .. option:: --disable-pimd
 
    Turn off building of pimd.  On some BSD platforms pimd will not build properly due
    to lack of kernel support.
 
+.. option:: --disable-vrrpd
+
+   Turn off building of vrrpd. Linux is required for vrrpd support;
+   other platforms are not supported.
+
 .. option:: --disable-pbrd
 
    Turn off building of pbrd.  This daemon currently requires linux in order to function
@@ -176,6 +186,10 @@ options from the list below.
 
    Turn off bgpd's ability to use VNC.
 
+.. option:: --disable-bgp-bmp
+
+   Turn off BGP BMP support
+
 .. option:: --enable-datacenter
 
    Enable system defaults to work as if in a Data Center. See defaults.h
@@ -194,11 +208,6 @@ options from the list below.
 
    Disable building of the example OSPF-API client.
 
-.. option:: --disable-ospf-ri
-
-   Disable support for OSPF Router Information (RFC4970 & RFC5088) this
-   requires support for Opaque LSAs and Traffic Engineering.
-
 .. option:: --disable-isisd
 
    Do not build isisd.
@@ -211,16 +220,17 @@ options from the list below.
 
    Enable IS-IS topology generator.
 
-.. option:: --enable-isis-te
-
-   Enable Traffic Engineering Extension for ISIS (RFC5305)
-
 .. option:: --enable-realms
 
    Enable the support of Linux Realms. Convert tag values from 1-255 into a
    realm value when inserting into the Linux kernel. Then routing policy can be
    assigned to the realm. See the tc man page.
 
+.. option:: --disable-irdp
+
+   Disable IRDP server support.  This is enabled by default if we have
+   both `struct in_pktinfo` and `struct icmphdr` available to us.
+
 .. option:: --disable-rtadv
 
    Disable support IPV6 router advertisement in zebra.
@@ -306,6 +316,39 @@ options from the list below.
 
    Build the Sysrepo northbound plugin.
 
+.. option:: --enable-grpc
+
+   Enable the gRPC northbound plugin.
+
+.. option:: --enable-zeromq
+
+   Enable the ZeroMQ handler.
+
+.. option:: --with-libpam
+
+   Use libpam for PAM support in vtysh.
+
+.. option:: --enable-time-check XXX
+
+   When this is enabled with a XXX value in microseconds, any thread that
+   runs for over this value will cause a warning to be issued to the log.
+   If you do not specify any value or don't include this option then
+   the default time is 5 seconds.  If --disable-time-check is specified
+   then no warning is issued for any thread run length.
+
+.. option:: --disable-cpu-time
+
+   Disable cpu process accounting, this command also disables the `show thread cpu`
+   command.  If this option is disabled, --enable-time-check is ignored.  This
+   disabling of cpu time effectively means that the getrusage call is skipped.
+   Since this is a process switch into the kernel, systems with high FRR
+   load might see improvement in behavior.  Be aware that `show thread cpu`
+   is considered a good data gathering tool from the perspective of developers.
+
+.. option:: --enable-pcreposix
+
+   Turn on the usage of PCRE Posix libs for regex functionality.
+
 You may specify any combination of the above options to the configure
 script. By default, the executables are placed in :file:`/usr/local/sbin`
 and the configuration files in :file:`/usr/local/etc`. The :file:`/usr/local/`