]> git.puffer.fish Git - mirror/frr.git/commitdiff
doc: add vrrpd(8)
authorQuentin Young <qlyoung@cumulusnetworks.com>
Mon, 15 Apr 2019 22:03:43 +0000 (22:03 +0000)
committerQuentin Young <qlyoung@cumulusnetworks.com>
Fri, 17 May 2019 00:27:08 +0000 (00:27 +0000)
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
doc/manpages/common-options.rst
doc/manpages/conf.py
doc/manpages/defines.rst
doc/manpages/index.rst
doc/manpages/subdir.am
doc/manpages/vrrpd.rst [new file with mode: 0644]

index a5977a6ebbe51b8ff5ba775b7185083b4562e5d0..a47a233c08eb2f5a0ffbe87b95fe1077361d96c8 100644 (file)
@@ -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.
 
index 46240de1c0a1244679408c63de9ed88e3d7bdf5e..e7813d81765463c1c2266be12b17ab9143c7cb47 100644 (file)
@@ -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 -------------------------------------------
index cdf5e1967e47f340933b58572b8bbfb19ad20172..2a6a9fd1bdf855bcd9d40109f9539018dd35e5d7 100644 (file)
@@ -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)
index 053555c4e4274205a4d41aa02e6f21e83d522989..40f06efdfeb519aabfa6d10f1d29cb8d67781973 100644 (file)
@@ -26,4 +26,5 @@
    watchfrr
    zebra
    vtysh
+   vrrpd
    frr
index a4457c9c45533d2f4be67cb227649a7528d333df..19d2d8d6ae4ace0f41da640420202fc5383d8498 100644 (file)
@@ -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 (file)
index 0000000..3670916
--- /dev/null
@@ -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
+