From: Quentin Young <qlyoung@cumulusnetworks.com>
Date: Mon, 15 Apr 2019 22:03:43 +0000 (+0000)
Subject: doc: add vrrpd(8)
X-Git-Tag: base_7.2~330^2~18
X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=4edac1f75f2c8e3366feacf17482169547108bba;p=mirror%2Ffrr.git

doc: add vrrpd(8)

Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
---

diff --git a/doc/manpages/common-options.rst b/doc/manpages/common-options.rst
index a5977a6ebb..a47a233c08 100644
--- a/doc/manpages/common-options.rst
+++ b/doc/manpages/common-options.rst
@@ -126,6 +126,7 @@ These following options control the daemon's VTY (interactive command line) inte
       staticd         2616
       bfdd            2617
       fabricd         2618
+      vrrpd           2619
 
    Port 2607 is used for ospfd's Opaque LSA API.
 
diff --git a/doc/manpages/conf.py b/doc/manpages/conf.py
index 46240de1c0..e7813d8176 100644
--- a/doc/manpages/conf.py
+++ b/doc/manpages/conf.py
@@ -334,6 +334,7 @@ man_pages = [
     ('frr', 'frr', 'a systemd interaction script', [], 1),
     ('bfdd', 'bfdd', fwfrr.format("a bfd"), [], 8),
     ('fabricd', 'fabricd', fwfrr.format("an OpenFabric "), [], 8),
+    ('vrrpd', 'vrrpd', fwfrr.format("a VRRP"), [], 8),
 ]
 
 # -- Options for Texinfo output -------------------------------------------
diff --git a/doc/manpages/defines.rst b/doc/manpages/defines.rst
index cdf5e1967e..2a6a9fd1bd 100644
--- a/doc/manpages/defines.rst
+++ b/doc/manpages/defines.rst
@@ -1,3 +1,3 @@
 .. |synopsis-options| replace:: [-d|-t|-dt] [-C] [-f config-file] [-i pid-file] [-z zclient-path] [-u user] [-g group] [-A vty-addr] [-P vty-port] [-M module[:options]] [-N pathspace] [--vty_socket vty-path] [--moduledir module-path]
 .. |synopsis-options-hv| replace:: [-h] [-v]
-.. |seealso-programs| replace:: zebra(8), vtysh(1), ripd(8), ripngd(8), ospfd(8), ospf6d(8), bgpd(8), isisd(8), babeld(8), nhrpd(8), pimd(8), pbrd(8), ldpd(8), eigrpd(8), staticd(8), fabricd(8), mtracebis(8)
+.. |seealso-programs| replace:: zebra(8), vtysh(1), ripd(8), ripngd(8), ospfd(8), ospf6d(8), bgpd(8), isisd(8), babeld(8), nhrpd(8), pimd(8), pbrd(8), ldpd(8), eigrpd(8), staticd(8), fabricd(8), vrrpd(8), mtracebis(8)
diff --git a/doc/manpages/index.rst b/doc/manpages/index.rst
index 053555c4e4..40f06efdfe 100644
--- a/doc/manpages/index.rst
+++ b/doc/manpages/index.rst
@@ -26,4 +26,5 @@
    watchfrr
    zebra
    vtysh
+   vrrpd
    frr
diff --git a/doc/manpages/subdir.am b/doc/manpages/subdir.am
index a4457c9c45..19d2d8d6ae 100644
--- a/doc/manpages/subdir.am
+++ b/doc/manpages/subdir.am
@@ -30,6 +30,7 @@ man_RSTFILES = \
 	doc/manpages/zebra.rst \
 	doc/manpages/bfdd.rst \
 	doc/manpages/bfd-options.rst \
+	doc/manpages/vrrpd.rst \
 	# end
 
 EXTRA_DIST += $(man_RSTFILES)
diff --git a/doc/manpages/vrrpd.rst b/doc/manpages/vrrpd.rst
new file mode 100644
index 0000000000..3670916050
--- /dev/null
+++ b/doc/manpages/vrrpd.rst
@@ -0,0 +1,40 @@
+*****
+VRRPD
+*****
+
+.. include:: defines.rst
+.. |DAEMON| replace:: vrrpd 
+
+SYNOPSIS
+========
+|DAEMON| |synopsis-options-hv|
+
+|DAEMON| |synopsis-options|
+
+DESCRIPTION
+===========
+|DAEMON| is a routing component that works with the FRRouting routing engine.
+It implements the Virtual Router Redundancy Protocol. Support for both VRRPv2
+and VRRPv3 is present.
+
+OPTIONS
+=======
+OPTIONS available for the |DAEMON| command:
+
+.. include:: common-options.rst
+
+FILES
+=====
+
+|INSTALL_PREFIX_SBIN|/|DAEMON|
+   The default location of the |DAEMON| binary.
+
+|INSTALL_PREFIX_ETC|/|DAEMON|.conf
+   The default location of the |DAEMON| config file.
+
+$(PWD)/|DAEMON|.log
+   If the |DAEMON| process is configured to output logs to a file, then you
+   will find this file in the directory where you started |DAEMON|.
+
+.. include:: epilogue.rst
+