dist_examples_DATA += bfdd/bfdd.conf.sample
vtysh_scan += $(top_srcdir)/bfdd/bfdd_vty.c
vtysh_scan += $(top_srcdir)/bfdd/bfdd_cli.c
-man8 += $(MANBUILD)/bfdd.8
+man8 += $(MANBUILD)/frr-bfdd.8
endif
bfdd_libbfd_a_SOURCES = \
if BGP_BMP
module_LTLIBRARIES += bgpd/bgpd_bmp.la
endif
-man8 += $(MANBUILD)/bgpd.8
+man8 += $(MANBUILD)/frr-bgpd.8
endif
bgpd_libbgp_a_SOURCES = \
+doc/manpages/_build/man/frr-bgpd.8
+doc/manpages/_build/man/frr-eigrpd.8
+doc/manpages/_build/man/frr-fabricd.8
+doc/manpages/_build/man/frr-isisd.8
+doc/manpages/_build/man/frr-ldpd.8
+doc/manpages/_build/man/frr-nhrpd.8
+doc/manpages/_build/man/frr-ospf6d.8
+doc/manpages/_build/man/frr-ospfd.8
+doc/manpages/_build/man/frr-pimd.8
+doc/manpages/_build/man/frr-ripd.8
+doc/manpages/_build/man/frr-ripngd.8
+doc/manpages/_build/man/frr-watchfrr.8
+doc/manpages/_build/man/frr-zebra.8
doc/manpages/_build/man/frr.1
-doc/manpages/_build/man/bgpd.8
-doc/manpages/_build/man/pimd.8
-doc/manpages/_build/man/eigrpd.8
-doc/manpages/_build/man/ldpd.8
-doc/manpages/_build/man/nhrpd.8
-doc/manpages/_build/man/ospf6d.8
-doc/manpages/_build/man/ospfd.8
-doc/manpages/_build/man/ripd.8
-doc/manpages/_build/man/ripngd.8
-doc/manpages/_build/man/vtysh.1
-doc/manpages/_build/man/zebra.8
-doc/manpages/_build/man/isisd.8
-doc/manpages/_build/man/watchfrr.8
doc/manpages/_build/man/mtracebis.8
-doc/manpages/_build/man/fabricd.8
+doc/manpages/_build/man/vtysh.1
+++ /dev/null
-****
-BFDD
-****
-
-.. include:: defines.rst
-.. |DAEMON| replace:: bfdd
-
-SYNOPSIS
-========
-|DAEMON| |synopsis-options-hv|
-
-|DAEMON| |synopsis-options|
-
-DESCRIPTION
-===========
-|DAEMON| is a communication failure detection component that works with
-the FRRouting routing engine.
-
-OPTIONS
-=======
-OPTIONS available for the |DAEMON| command:
-
-.. include:: common-options.rst
-.. include:: bfd-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
-
+++ /dev/null
-****
-BGPD
-****
-
-.. include:: defines.rst
-.. |DAEMON| replace:: bgpd
-
-SYNOPSIS
-========
-|DAEMON| |synopsis-options-hv|
-
-|DAEMON| |synopsis-options|
-
-DESCRIPTION
-===========
-|DAEMON| is a routing component that works with the FRRouting routing engine.
-
-OPTIONS
-=======
-OPTIONS available for the |DAEMON| command:
-
-.. include:: common-options.rst
-
-LABEL MANAGER
--------------
-
-.. option:: -I, --int_num
-
- Set zclient id. This is required when using Zebra label manager in proxy mode.
-
-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
-
fwfrr = "{0} routing engine for use with FRRouting."
man_pages = [
- ('bgpd', 'bgpd', fwfrr.format("a BGPv4, BGPv4+, BGPv4- "), [], 8),
- ('eigrpd', 'eigrpd', fwfrr.format("an EIGRP "), [], 8),
- ('ospf6d', 'ospf6d', fwfrr.format("an OSPFv3 "), [], 8),
- ('ospfd', 'ospfd', fwfrr.format("an OSPFv2 "), [], 8),
- ('isisd', 'isisd', fwfrr.format("an IS-IS "), [], 8),
- ('ospfclient', 'ospfclient', 'an example ospf-api client', [], 8),
- ('ldpd', 'ldpd', fwfrr.format("an LDP "), [], 8),
- ('nhrpd', 'nhrpd', fwfrr.format("a Next Hop Routing Protocol "), [], 8),
- ('pimd', 'pimd', fwfrr.format("a PIM "), [], 8),
- ('pbrd', 'pbrd', fwfrr.format("a PBR "), [], 8),
- ('sharpd', 'sharpd', fwfrr.format("a SHARP "), [], 8),
- ('staticd', 'staticd', fwfrr.format("a static route manager "), [], 8),
- ('mtracebis', 'mtracebis', "a multicast trace client", [], 8),
- ('ripd', 'ripd', fwfrr.format("a RIP "), [], 8),
- ('ripngd', 'ripngd', fwfrr.format("a RIPNG "), [], 8),
- ('zebra', 'zebra', 'a routing manager for use with associated FRRouting components.', [], 8),
- ('watchfrr', 'watchfrr', 'a program to monitor the status of FRRouting daemons', [], 8),
- ('vtysh', 'vtysh', 'an integrated shell for FRRouting.', [], 1),
+ ('frr-bfdd', 'frr-bfdd', fwfrr.format("a bfd"), [], 8),
+ ('frr-bgpd', 'frr-bgpd', fwfrr.format("a BGPv4, BGPv4+, BGPv4-"), [], 8),
+ ('frr-eigrpd', 'frr-eigrpd', fwfrr.format("an EIGRP"), [], 8),
+ ('frr-fabricd', 'frr-fabricd', fwfrr.format("an OpenFabric"), [], 8),
+ ('frr-isisd', 'frr-isisd', fwfrr.format("an IS-IS"), [], 8),
+ ('frr-ldpd', 'frr-ldpd', fwfrr.format("an LDP"), [], 8),
+ ('frr-nhrpd', 'frr-nhrpd', fwfrr.format("a Next Hop Routing Protocol"), [], 8),
+ ('frr-ospf6d', 'frr-ospf6d', fwfrr.format("an OSPFv3"), [], 8),
+ ('frr-ospfclient', 'frr-ospfclient', 'an example ospf-api client', [], 8),
+ ('frr-ospfd', 'frr-ospfd', fwfrr.format("an OSPFv2"), [], 8),
+ ('frr-pbrd', 'frr-pbrd', fwfrr.format("a PBR"), [], 8),
+ ('frr-pimd', 'frr-pimd', fwfrr.format("a PIM"), [], 8),
+ ('frr-ripd', 'frr-ripd', fwfrr.format("a RIP"), [], 8),
+ ('frr-ripngd', 'frr-ripngd', fwfrr.format("a RIPNG"), [], 8),
+ ('frr-sharpd', 'frr-sharpd', fwfrr.format("a SHARP"), [], 8),
+ ('frr-staticd', 'frr-staticd', fwfrr.format("a static route manager"), [], 8),
+ ('frr-vrrpd', 'frr-vrrpd', fwfrr.format("a VRRP"), [], 8),
+ ('frr-watchfrr', 'frr-watchfrr', 'a program to monitor the status of FRRouting daemons', [], 8),
+ ('frr-zebra', 'frr-zebra', 'a routing manager for use with associated FRRouting components.', [], 8),
('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),
+ ('mtracebis', 'mtracebis', "a multicast trace client", [], 8),
+ ('vtysh', 'vtysh', 'an integrated shell for FRRouting.', [], 1),
]
# -- Options for Texinfo output -------------------------------------------
.. |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), vrrpd(8), mtracebis(8)
+.. |seealso-programs| replace:: frr-zebra(8), vtysh(1), frr-ripd(8), frr-ripngd(8), frr-ospfd(8), frr-ospf6d(8), frr-bgpd(8), frr-isisd(8), frr-babeld(8), frr-nhrpd(8), frr-pimd(8), frr-pbrd(8), frr-ldpd(8), frr-eigrpd(8), frr-staticd(8), frr-fabricd(8), frr-vrrpd(8), mtracebis(8)
+++ /dev/null
-******
-EIGRPD
-******
-
-.. include:: defines.rst
-.. |DAEMON| replace:: eigrpd
-
-SYNOPSIS
-========
-|DAEMON| |synopsis-options-hv|
-
-|DAEMON| |synopsis-options|
-
-DESCRIPTION
-===========
-|DAEMON| is a routing component that works with the FRRouting routing engine.
-
-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
-
+++ /dev/null
-*******
-FABRICD
-*******
-
-.. include:: defines.rst
-.. |DAEMON| replace:: fabricd
-
-SYNOPSIS
-========
-|DAEMON| |synopsis-options-hv|
-
-|DAEMON| |synopsis-options|
-
-DESCRIPTION
-===========
-|DAEMON| is a routing component that works with the FRRouting routing engine.
-
-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
-
--- /dev/null
+****
+BFDD
+****
+
+.. include:: defines.rst
+.. |DAEMON| replace:: bfdd
+
+SYNOPSIS
+========
+|DAEMON| |synopsis-options-hv|
+
+|DAEMON| |synopsis-options|
+
+DESCRIPTION
+===========
+|DAEMON| is a communication failure detection component that works with
+the FRRouting routing engine.
+
+OPTIONS
+=======
+OPTIONS available for the |DAEMON| command:
+
+.. include:: common-options.rst
+.. include:: bfd-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
+
--- /dev/null
+****
+BGPD
+****
+
+.. include:: defines.rst
+.. |DAEMON| replace:: bgpd
+
+SYNOPSIS
+========
+|DAEMON| |synopsis-options-hv|
+
+|DAEMON| |synopsis-options|
+
+DESCRIPTION
+===========
+|DAEMON| is a routing component that works with the FRRouting routing engine.
+
+OPTIONS
+=======
+OPTIONS available for the |DAEMON| command:
+
+.. include:: common-options.rst
+
+LABEL MANAGER
+-------------
+
+.. option:: -I, --int_num
+
+ Set zclient id. This is required when using Zebra label manager in proxy mode.
+
+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
+
--- /dev/null
+******
+EIGRPD
+******
+
+.. include:: defines.rst
+.. |DAEMON| replace:: eigrpd
+
+SYNOPSIS
+========
+|DAEMON| |synopsis-options-hv|
+
+|DAEMON| |synopsis-options|
+
+DESCRIPTION
+===========
+|DAEMON| is a routing component that works with the FRRouting routing engine.
+
+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
+
--- /dev/null
+*******
+FABRICD
+*******
+
+.. include:: defines.rst
+.. |DAEMON| replace:: fabricd
+
+SYNOPSIS
+========
+|DAEMON| |synopsis-options-hv|
+
+|DAEMON| |synopsis-options|
+
+DESCRIPTION
+===========
+|DAEMON| is a routing component that works with the FRRouting routing engine.
+
+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
+
--- /dev/null
+*****
+ISISD
+*****
+
+.. include:: defines.rst
+.. |DAEMON| replace:: isisd
+
+SYNOPSIS
+========
+|DAEMON| |synopsis-options-hv|
+
+|DAEMON| |synopsis-options|
+
+DESCRIPTION
+===========
+|DAEMON| is a routing component that works with the FRRouting routing engine.
+
+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
+
--- /dev/null
+****
+LDPD
+****
+
+.. include:: defines.rst
+.. |DAEMON| replace:: ldpd
+
+SYNOPSIS
+========
+|DAEMON| |synopsis-options-hv|
+
+|DAEMON| |synopsis-options|
+
+DESCRIPTION
+===========
+|DAEMON| is a routing component that works with the FRRouting routing engine.
+
+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
+
--- /dev/null
+*****
+NHRPD
+*****
+
+.. include:: defines.rst
+.. |DAEMON| replace:: nhrpd
+
+SYNOPSIS
+========
+|DAEMON| |synopsis-options-hv|
+
+|DAEMON| |synopsis-options|
+
+DESCRIPTION
+===========
+|DAEMON| is a routing component that works with the FRRouting routing engine.
+
+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
+
--- /dev/null
+******
+OSPF6D
+******
+
+.. include:: defines.rst
+.. |DAEMON| replace:: ospf6d
+
+SYNOPSIS
+========
+|DAEMON| |synopsis-options-hv|
+
+|DAEMON| |synopsis-options|
+
+
+DESCRIPTION
+===========
+|DAEMON| is a routing component that works with the FRRouting routing engine.
+
+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
+
--- /dev/null
+**********
+OSPFCLIENT
+**********
+
+.. include:: defines.rst
+
+SYNOPSIS
+========
+ospfclient <ospfd> <lsatype> <opaquetype> <opaqueid> <ifaddr> <areaid>
+
+DESCRIPTION
+===========
+ospfclient is an example ospf-api client to test the ospfd daemon.
+
+OPTIONS
+=======
+
+.. option:: ospfd
+
+ A router where the API-enabled OSPF daemon is running.
+
+.. option:: lsatype
+
+ The value has to be either "9", "10", or "11", depending on the flooding scope.
+
+.. option:: opaquetype
+
+ The value has to be in the range of 0-255 (for example, experimental applications might use opaquetype larger than 128).
+
+.. option:: opaqueid
+
+ Arbitrary application instance (24 bits).
+
+.. option:: ifaddr
+
+ Interface IP address for type 9, otherwise it will be ignored.
+
+.. option:: areaid
+
+ Area in the IP address format for type 10, otherwise it will be ignored.
+
+
+.. include:: epilogue.rst
--- /dev/null
+*****
+OSPFD
+*****
+
+.. include:: defines.rst
+.. |DAEMON| replace:: ospfd
+
+SYNOPSIS
+========
+|DAEMON| |synopsis-options-hv|
+
+|DAEMON| |synopsis-options|
+
+
+DESCRIPTION
+===========
+|DAEMON| is a routing component that works with the FRRouting routing engine.
+
+OPTIONS
+=======
+OPTIONS available for the |DAEMON| command:
+
+.. include:: common-options.rst
+
+.. option:: -a, --apiserver
+
+ Enable the OSPF API server.
+
+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
+
--- /dev/null
+****
+PBRD
+****
+
+.. include:: defines.rst
+.. |DAEMON| replace:: pbrd
+
+SYNOPSIS
+========
+|DAEMON| |synopsis-options-hv|
+
+|DAEMON| |synopsis-options|
+
+DESCRIPTION
+===========
+|DAEMON| is a routing component that works with the FRRouting engine.
+
+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
+
+
--- /dev/null
+****
+PIMD
+****
+
+.. include:: defines.rst
+.. |DAEMON| replace:: pimd
+
+SYNOPSIS
+========
+|DAEMON| |synopsis-options-hv|
+
+|DAEMON| |synopsis-options|
+
+DESCRIPTION
+===========
+|DAEMON| is a routing component that works with the FRRouting routing engine.
+
+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
+
--- /dev/null
+****
+RIPD
+****
+
+.. include:: defines.rst
+.. |DAEMON| replace:: ripd
+
+SYNOPSIS
+========
+|DAEMON| |synopsis-options-hv|
+
+|DAEMON| |synopsis-options|
+
+DESCRIPTION
+===========
+|DAEMON| is a routing component that works with the FRRouting routing engine.
+
+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
+
--- /dev/null
+******
+RIPNGD
+******
+
+.. include:: defines.rst
+.. |DAEMON| replace:: ripngd
+
+SYNOPSIS
+========
+|DAEMON| |synopsis-options-hv|
+
+|DAEMON| |synopsis-options|
+
+DESCRIPTION
+===========
+|DAEMON| is a routing component that works with the FRRouting routing engine.
+
+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
+
--- /dev/null
+******
+SHARPD
+******
+
+.. include:: defines.rst
+.. |DAEMON| replace:: sharpd
+
+SYNOPSIS
+========
+|DAEMON| |synopsis-options-hv|
+
+|DAEMON| |synopsis-options|
+
+DESCRIPTION
+===========
+|DAEMON| is a routing component that works with the FRRouting engine.
+
+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
+
+
--- /dev/null
+*******
+STATICD
+*******
+
+.. include:: defines.rst
+.. |DAEMON| replace:: staticd
+
+SYNOPSIS
+========
+|DAEMON| |synopsis-options-hv|
+
+|DAEMON| |synopsis-options|
+
+DESCRIPTION
+===========
+|DAEMON| is a routing component that works with the FRRouting engine.
+
+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
+
+
--- /dev/null
+*****
+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
+
--- /dev/null
+********
+WATCHFRR
+********
+
+.. include:: defines.rst
+.. |DAEMON| replace:: watchfrr
+
+SYNOPSIS
+========
+|DAEMON| |synopsis-options-hv|
+
+|DAEMON| [option...] <daemon>...
+
+
+DESCRIPTION
+===========
+|DAEMON| is a watchdog program that monitors the status of supplied frr daemons and tries to restart them in case they become unresponsive or shut down.
+
+To determine whether a daemon is running, it tries to connect to the daemon's VTY UNIX stream socket, and send echo commands to ensure the daemon responds. When the daemon crashes, EOF is received from the socket, so that |DAEMON| can react immediately.
+
+In order to avoid restarting the daemons in quick succession, you can supply the -m and -M options to set the minimum and maximum delay between the restart commands. The minimum restart delay is recalculated each time a restart is attempted. If the time since the last restart attempt exceeds twice the value of -M, the restart delay is set to the value of -m, otherwise the interval is doubled (but capped at the value of -M).
+
+OPTIONS
+=======
+
+.. option:: --dry
+
+ Run |DAEMON| in "dry-run" mode, only monitoring the specified daemons but not performing any start/stop/restart actions.
+
+.. option:: -d, --daemon
+
+ Run in daemon mode. When supplied, error messages are sent to Syslog instead of standard output (stdout).
+
+.. option:: -S <directory>, --statedir <directory>
+
+ Set the VTY socket directory (the default value is "/var/run/frr").
+
+.. option:: -l <level>, --loglevel <level>
+
+ Set the logging level (the default value is "6"). The value should range from 0 (LOG_EMERG) to 7 (LOG_DEBUG), but higher number can be supplied if extra debugging messages are required.
+
+.. option:: --min-restart-interval <number>
+
+ Set the minimum number of seconds to wait between invocations of the daemon restart commands (the default value is "60").
+
+.. option:: --max-restart-interval <number>
+
+ Set the maximum number of seconds to wait between invocations of the daemon restart commands (the default value is "600").
+
+.. option:: -i <number>, --interval <number>
+
+ Set the status polling interval in seconds (the default value is "5").
+
+.. option:: -t <number>, --timeout <number>
+
+ Set the unresponsiveness timeout in seconds (the default value is "10").
+
+.. option:: -T <number>, --restart-timeout <number>
+
+ Set the restart (kill) timeout in seconds (the default value is "20"). If any background jobs are still running after this period has elapsed, they will be killed.
+
+.. option:: -p <filename>, --pid-file <filename>
+
+ Set the process identifier filename (the default value is "/var/run/frr/|DAEMON|.pid").
+
+.. option:: -b <string>, --blank-string <string>
+
+ When the supplied string is found in any of the command line option arguments (i.e., -r, -s, or -k), replace it with a space.
+
+ This is an ugly hack to circumvent problems with passing the command line arguments containing embedded spaces.
+
+.. option:: -v, --version
+
+ Display the version information and exit.
+
+.. option:: -h, --help
+
+ Display the usage information and exit.
+
+The following 3 options specify scripts that |DAEMON| uses to perform start/stop/restart actions. Reasonable default values are built into watchfrr, so the use of these options should no longer be necessary:
+
+.. option:: -s command, --start-command command
+
+ Supply a Bourne shell command to start a single daemon. The command string should contain the '%s' placeholder to be substituted with the daemon name.
+
+.. option:: -k command, --kill-command command
+
+ Supply a Bourne shell command to stop a single daemon. The command string should contain the '%s' placeholder to be substituted with the daemon name.
+
+.. option:: -r command, --restart command
+
+ Supply a Bourne shell command to restart a single daemon. The command string should contain the '%s' placeholder to be substituted with the daemon name.
+
+PREVIOUS OPTIONS
+================
+Prior versions of |DAEMON| supported some additional options that no longer exist:::
+
+ -a, -A, -e, -R, -z
+
+The ``-a``, ``-A`` and ``-R`` options were used to select alternate monitoring modes that offered different patterns of restarting daemons. The "correct" mode (phased restart) is now the default. The -e and -z options used to disable some monitoring aspects, |DAEMON| now always has all monitoring features enabled.
+
+Removing these options should result in correct operation, if it does not please file a bug report.
+
+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
+
--- /dev/null
+*****
+ZEBRA
+*****
+
+.. include:: defines.rst
+.. |DAEMON| replace:: zebra
+
+SYNOPSIS
+========
+|DAEMON| |synopsis-options-hv|
+
+|DAEMON| |synopsis-options|
+
+DESCRIPTION
+===========
+|DAEMON| is a routing manager that implements the zebra route engine. zebra supports all protocol daemons in the FRRouting suite.
+
+OPTIONS
+=======
+OPTIONS available for the |DAEMON| command:
+
+.. include:: common-options.rst
+
+.. option:: -b, --batch
+
+ Runs in batch mode, zebra parses its config and exits.
+
+.. option:: -k, --keep_kernel
+
+ On startup, don't delete self inserted routes.
+
+.. option:: -s, --nl-bufsize <netlink-buffer-size>
+
+ Set netlink receive buffer size. There are cases where zebra daemon can't handle flood of netlink messages from kernel. If you ever see "recvmsg overrun" messages in zebra log, you are in trouble.
+
+ Solution is to increase receive buffer of netlink socket. Note that kernel < 2.6.14 doesn't allow increasing it over maximum value defined in /proc/sys/net/core/rmem_max. If you want to do it, you have to increase maximum before starting zebra.
+
+ Note that this affects Linux only.
+
+
+.. option:: -n, --vrfwnetns
+
+ Enable namespace VRF backend. By default, the VRF backend relies on VRF-lite support from the Linux kernel. This option permits discovering Linux named network namespaces and mapping it to FRR VRF contexts.
+
+ROUTES
+------
+
+.. option:: -r, --retain
+
+ When the program terminates, do not flush routes installed by zebra from the kernel.
+
+
+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
+
.. toctree::
:maxdepth: 2
- bfdd
- bgpd
- eigrpd
- isisd
- fabricd
- ldpd
- nhrpd
- ospf6d
- ospfclient
- ospfd
- pimd
- pbrd
+ frr
+ frr-bfdd
+ frr-bgpd
+ frr-eigrpd
+ frr-isisd
+ frr-fabricd
+ frr-ldpd
+ frr-nhrpd
+ frr-ospf6d
+ frr-ospfclient
+ frr-ospfd
+ frr-pimd
+ frr-pbrd
+ frr-ripd
+ frr-ripngd
+ frr-sharpd
+ frr-staticd
+ frr-watchfrr
+ frr-zebra
+ frr-vrrpd
mtracebis
- ripd
- ripngd
- sharpd
- staticd
- watchfrr
- zebra
vtysh
- vrrpd
- frr
+++ /dev/null
-*****
-ISISD
-*****
-
-.. include:: defines.rst
-.. |DAEMON| replace:: isisd
-
-SYNOPSIS
-========
-|DAEMON| |synopsis-options-hv|
-
-|DAEMON| |synopsis-options|
-
-DESCRIPTION
-===========
-|DAEMON| is a routing component that works with the FRRouting routing engine.
-
-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
-
+++ /dev/null
-****
-LDPD
-****
-
-.. include:: defines.rst
-.. |DAEMON| replace:: ldpd
-
-SYNOPSIS
-========
-|DAEMON| |synopsis-options-hv|
-
-|DAEMON| |synopsis-options|
-
-DESCRIPTION
-===========
-|DAEMON| is a routing component that works with the FRRouting routing engine.
-
-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
-
+++ /dev/null
-*****
-NHRPD
-*****
-
-.. include:: defines.rst
-.. |DAEMON| replace:: nhrpd
-
-SYNOPSIS
-========
-|DAEMON| |synopsis-options-hv|
-
-|DAEMON| |synopsis-options|
-
-DESCRIPTION
-===========
-|DAEMON| is a routing component that works with the FRRouting routing engine.
-
-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
-
+++ /dev/null
-******
-OSPF6D
-******
-
-.. include:: defines.rst
-.. |DAEMON| replace:: ospf6d
-
-SYNOPSIS
-========
-|DAEMON| |synopsis-options-hv|
-
-|DAEMON| |synopsis-options|
-
-
-DESCRIPTION
-===========
-|DAEMON| is a routing component that works with the FRRouting routing engine.
-
-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
-
+++ /dev/null
-**********
-OSPFCLIENT
-**********
-
-.. include:: defines.rst
-
-SYNOPSIS
-========
-ospfclient <ospfd> <lsatype> <opaquetype> <opaqueid> <ifaddr> <areaid>
-
-DESCRIPTION
-===========
-ospfclient is an example ospf-api client to test the ospfd daemon.
-
-OPTIONS
-=======
-
-.. option:: ospfd
-
- A router where the API-enabled OSPF daemon is running.
-
-.. option:: lsatype
-
- The value has to be either "9", "10", or "11", depending on the flooding scope.
-
-.. option:: opaquetype
-
- The value has to be in the range of 0-255 (for example, experimental applications might use opaquetype larger than 128).
-
-.. option:: opaqueid
-
- Arbitrary application instance (24 bits).
-
-.. option:: ifaddr
-
- Interface IP address for type 9, otherwise it will be ignored.
-
-.. option:: areaid
-
- Area in the IP address format for type 10, otherwise it will be ignored.
-
-
-.. include:: epilogue.rst
+++ /dev/null
-*****
-OSPFD
-*****
-
-.. include:: defines.rst
-.. |DAEMON| replace:: ospfd
-
-SYNOPSIS
-========
-|DAEMON| |synopsis-options-hv|
-
-|DAEMON| |synopsis-options|
-
-
-DESCRIPTION
-===========
-|DAEMON| is a routing component that works with the FRRouting routing engine.
-
-OPTIONS
-=======
-OPTIONS available for the |DAEMON| command:
-
-.. include:: common-options.rst
-
-.. option:: -a, --apiserver
-
- Enable the OSPF API server.
-
-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
-
+++ /dev/null
-****
-PBRD
-****
-
-.. include:: defines.rst
-.. |DAEMON| replace:: pbrd
-
-SYNOPSIS
-========
-|DAEMON| |synopsis-options-hv|
-
-|DAEMON| |synopsis-options|
-
-DESCRIPTION
-===========
-|DAEMON| is a routing component that works with the FRRouting engine.
-
-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
-
-
+++ /dev/null
-****
-PIMD
-****
-
-.. include:: defines.rst
-.. |DAEMON| replace:: pimd
-
-SYNOPSIS
-========
-|DAEMON| |synopsis-options-hv|
-
-|DAEMON| |synopsis-options|
-
-DESCRIPTION
-===========
-|DAEMON| is a routing component that works with the FRRouting routing engine.
-
-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
-
+++ /dev/null
-****
-RIPD
-****
-
-.. include:: defines.rst
-.. |DAEMON| replace:: ripd
-
-SYNOPSIS
-========
-|DAEMON| |synopsis-options-hv|
-
-|DAEMON| |synopsis-options|
-
-DESCRIPTION
-===========
-|DAEMON| is a routing component that works with the FRRouting routing engine.
-
-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
-
+++ /dev/null
-******
-RIPNGD
-******
-
-.. include:: defines.rst
-.. |DAEMON| replace:: ripngd
-
-SYNOPSIS
-========
-|DAEMON| |synopsis-options-hv|
-
-|DAEMON| |synopsis-options|
-
-DESCRIPTION
-===========
-|DAEMON| is a routing component that works with the FRRouting routing engine.
-
-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
-
+++ /dev/null
-******
-SHARPD
-******
-
-.. include:: defines.rst
-.. |DAEMON| replace:: sharpd
-
-SYNOPSIS
-========
-|DAEMON| |synopsis-options-hv|
-
-|DAEMON| |synopsis-options|
-
-DESCRIPTION
-===========
-|DAEMON| is a routing component that works with the FRRouting engine.
-
-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
-
-
+++ /dev/null
-*******
-STATICD
-*******
-
-.. include:: defines.rst
-.. |DAEMON| replace:: staticd
-
-SYNOPSIS
-========
-|DAEMON| |synopsis-options-hv|
-
-|DAEMON| |synopsis-options|
-
-DESCRIPTION
-===========
-|DAEMON| is a routing component that works with the FRRouting engine.
-
-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
-
-
#
man_RSTFILES = \
- doc/manpages/bgpd.rst \
+ doc/manpages/bfd-options.rst \
doc/manpages/common-options.rst \
doc/manpages/conf.py \
doc/manpages/defines.rst \
- doc/manpages/eigrpd.rst \
doc/manpages/epilogue.rst \
- doc/manpages/fabricd.rst \
+ doc/manpages/frr-bfdd.rst \
+ doc/manpages/frr-bgpd.rst \
+ doc/manpages/frr-eigrpd.rst \
+ doc/manpages/frr-fabricd.rst \
+ doc/manpages/frr-isisd.rst \
+ doc/manpages/frr-ldpd.rst \
+ doc/manpages/frr-nhrpd.rst \
+ doc/manpages/frr-ospf6d.rst \
+ doc/manpages/frr-ospfclient.rst \
+ doc/manpages/frr-ospfd.rst \
+ doc/manpages/frr-pbrd.rst \
+ doc/manpages/frr-pimd.rst \
+ doc/manpages/frr-ripd.rst \
+ doc/manpages/frr-ripngd.rst \
+ doc/manpages/frr-sharpd.rst \
+ doc/manpages/frr-staticd.rst \
+ doc/manpages/frr-vrrpd.rst \
+ doc/manpages/frr-watchfrr.rst \
+ doc/manpages/frr-zebra.rst \
doc/manpages/frr.rst \
doc/manpages/index.rst \
- doc/manpages/isisd.rst \
- doc/manpages/ldpd.rst \
doc/manpages/mtracebis.rst \
- doc/manpages/nhrpd.rst \
- doc/manpages/ospf6d.rst \
- doc/manpages/ospfclient.rst \
- doc/manpages/ospfd.rst \
- doc/manpages/pimd.rst \
- doc/manpages/ripd.rst \
- doc/manpages/pbrd.rst \
- doc/manpages/ripngd.rst \
- doc/manpages/sharpd.rst \
- doc/manpages/staticd.rst \
doc/manpages/vtysh.rst \
- doc/manpages/watchfrr.rst \
- doc/manpages/zebra.rst \
- doc/manpages/bfdd.rst \
- doc/manpages/bfd-options.rst \
- doc/manpages/vrrpd.rst \
# end
EXTRA_DIST += $(man_RSTFILES)
+++ /dev/null
-*****
-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
-
+++ /dev/null
-********
-WATCHFRR
-********
-
-.. include:: defines.rst
-.. |DAEMON| replace:: watchfrr
-
-SYNOPSIS
-========
-|DAEMON| |synopsis-options-hv|
-
-|DAEMON| [option...] <daemon>...
-
-
-DESCRIPTION
-===========
-|DAEMON| is a watchdog program that monitors the status of supplied frr daemons and tries to restart them in case they become unresponsive or shut down.
-
-To determine whether a daemon is running, it tries to connect to the daemon's VTY UNIX stream socket, and send echo commands to ensure the daemon responds. When the daemon crashes, EOF is received from the socket, so that |DAEMON| can react immediately.
-
-In order to avoid restarting the daemons in quick succession, you can supply the -m and -M options to set the minimum and maximum delay between the restart commands. The minimum restart delay is recalculated each time a restart is attempted. If the time since the last restart attempt exceeds twice the value of -M, the restart delay is set to the value of -m, otherwise the interval is doubled (but capped at the value of -M).
-
-OPTIONS
-=======
-
-.. option:: --dry
-
- Run |DAEMON| in "dry-run" mode, only monitoring the specified daemons but not performing any start/stop/restart actions.
-
-.. option:: -d, --daemon
-
- Run in daemon mode. When supplied, error messages are sent to Syslog instead of standard output (stdout).
-
-.. option:: -S <directory>, --statedir <directory>
-
- Set the VTY socket directory (the default value is "/var/run/frr").
-
-.. option:: -l <level>, --loglevel <level>
-
- Set the logging level (the default value is "6"). The value should range from 0 (LOG_EMERG) to 7 (LOG_DEBUG), but higher number can be supplied if extra debugging messages are required.
-
-.. option:: --min-restart-interval <number>
-
- Set the minimum number of seconds to wait between invocations of the daemon restart commands (the default value is "60").
-
-.. option:: --max-restart-interval <number>
-
- Set the maximum number of seconds to wait between invocations of the daemon restart commands (the default value is "600").
-
-.. option:: -i <number>, --interval <number>
-
- Set the status polling interval in seconds (the default value is "5").
-
-.. option:: -t <number>, --timeout <number>
-
- Set the unresponsiveness timeout in seconds (the default value is "10").
-
-.. option:: -T <number>, --restart-timeout <number>
-
- Set the restart (kill) timeout in seconds (the default value is "20"). If any background jobs are still running after this period has elapsed, they will be killed.
-
-.. option:: -p <filename>, --pid-file <filename>
-
- Set the process identifier filename (the default value is "/var/run/frr/|DAEMON|.pid").
-
-.. option:: -b <string>, --blank-string <string>
-
- When the supplied string is found in any of the command line option arguments (i.e., -r, -s, or -k), replace it with a space.
-
- This is an ugly hack to circumvent problems with passing the command line arguments containing embedded spaces.
-
-.. option:: -v, --version
-
- Display the version information and exit.
-
-.. option:: -h, --help
-
- Display the usage information and exit.
-
-The following 3 options specify scripts that |DAEMON| uses to perform start/stop/restart actions. Reasonable default values are built into watchfrr, so the use of these options should no longer be necessary:
-
-.. option:: -s command, --start-command command
-
- Supply a Bourne shell command to start a single daemon. The command string should contain the '%s' placeholder to be substituted with the daemon name.
-
-.. option:: -k command, --kill-command command
-
- Supply a Bourne shell command to stop a single daemon. The command string should contain the '%s' placeholder to be substituted with the daemon name.
-
-.. option:: -r command, --restart command
-
- Supply a Bourne shell command to restart a single daemon. The command string should contain the '%s' placeholder to be substituted with the daemon name.
-
-PREVIOUS OPTIONS
-================
-Prior versions of |DAEMON| supported some additional options that no longer exist:::
-
- -a, -A, -e, -R, -z
-
-The ``-a``, ``-A`` and ``-R`` options were used to select alternate monitoring modes that offered different patterns of restarting daemons. The "correct" mode (phased restart) is now the default. The -e and -z options used to disable some monitoring aspects, |DAEMON| now always has all monitoring features enabled.
-
-Removing these options should result in correct operation, if it does not please file a bug report.
-
-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
-
+++ /dev/null
-*****
-ZEBRA
-*****
-
-.. include:: defines.rst
-.. |DAEMON| replace:: zebra
-
-SYNOPSIS
-========
-|DAEMON| |synopsis-options-hv|
-
-|DAEMON| |synopsis-options|
-
-DESCRIPTION
-===========
-|DAEMON| is a routing manager that implements the zebra route engine. zebra supports all protocol daemons in the FRRouting suite.
-
-OPTIONS
-=======
-OPTIONS available for the |DAEMON| command:
-
-.. include:: common-options.rst
-
-.. option:: -b, --batch
-
- Runs in batch mode, zebra parses its config and exits.
-
-.. option:: -k, --keep_kernel
-
- On startup, don't delete self inserted routes.
-
-.. option:: -s, --nl-bufsize <netlink-buffer-size>
-
- Set netlink receive buffer size. There are cases where zebra daemon can't handle flood of netlink messages from kernel. If you ever see "recvmsg overrun" messages in zebra log, you are in trouble.
-
- Solution is to increase receive buffer of netlink socket. Note that kernel < 2.6.14 doesn't allow increasing it over maximum value defined in /proc/sys/net/core/rmem_max. If you want to do it, you have to increase maximum before starting zebra.
-
- Note that this affects Linux only.
-
-
-.. option:: -n, --vrfwnetns
-
- Enable namespace VRF backend. By default, the VRF backend relies on VRF-lite support from the Linux kernel. This option permits discovering Linux named network namespaces and mapping it to FRR VRF contexts.
-
-ROUTES
-------
-
-.. option:: -r, --retain
-
- When the program terminates, do not flush routes installed by zebra from the kernel.
-
-
-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
-
$(top_srcdir)/eigrpd/eigrp_vty.c \
# end
# $(top_srcdir)/eigrpd/eigrp_routemap.c
-man8 += $(MANBUILD)/eigrpd.8
+man8 += $(MANBUILD)/frr-eigrpd.8
endif
eigrpd_libeigrp_a_SOURCES = \
$(top_srcdir)/isisd/isis_vty_fabricd.c \
$(top_srcdir)/isisd/isisd.c \
# end
-man8 += $(MANBUILD)/isisd.8
+man8 += $(MANBUILD)/frr-isisd.8
endif
if FABRICD
sbin_PROGRAMS += ldpd/ldpd
dist_examples_DATA += ldpd/ldpd.conf.sample
vtysh_scan += $(top_srcdir)/ldpd/ldp_vty_cmds.c
-man8 += $(MANBUILD)/ldpd.8
+man8 += $(MANBUILD)/frr-ldpd.8
endif
ldpd_libldp_a_SOURCES = \
if NHRPD
sbin_PROGRAMS += nhrpd/nhrpd
vtysh_scan += $(top_srcdir)/nhrpd/nhrp_vty.c
-man8 += $(MANBUILD)/nhrpd.8
+man8 += $(MANBUILD)/frr-nhrpd.8
endif
nhrpd_nhrpd_LDADD = lib/libfrr.la lib/libfrrcares.la $(LIBCAP)
if SNMP
module_LTLIBRARIES += ospf6d/ospf6d_snmp.la
endif
-man8 += $(MANBUILD)/ospf6d.8
+man8 += $(MANBUILD)/frr-ospf6d.8
endif
ospf6d_libospf6_a_SOURCES = \
if OSPFCLIENT
lib_LTLIBRARIES += ospfclient/libfrrospfapiclient.la
noinst_PROGRAMS += ospfclient/ospfclient
-man8 += $(MANBUILD)/ospfclient.8
+man8 += $(MANBUILD)/frr-ospfclient.8
endif
ospfclient_libfrrospfapiclient_la_LDFLAGS = -version-info 0:0:0
if SNMP
module_LTLIBRARIES += ospfd/ospfd_snmp.la
endif
-man8 += $(MANBUILD)/ospfd.8
+man8 += $(MANBUILD)/frr-ospfd.8
endif
ospfd_libfrrospf_a_SOURCES = \
$(top_srcdir)/pbrd/pbr_vty.c \
$(top_srcdir)/pbrd/pbr_debug.c \
# end
-man8 += $(MANBUILD)/pbrd.8
+man8 += $(MANBUILD)/frr-pbrd.8
endif
pbrd_libpbr_a_SOURCES = \
noinst_PROGRAMS += pimd/test_igmpv3_join
dist_examples_DATA += pimd/pimd.conf.sample
vtysh_scan += $(top_srcdir)/pimd/pim_cmd.c
-man8 += $(MANBUILD)/pimd.8
+man8 += $(MANBUILD)/frr-pimd.8
man8 += $(MANBUILD)/mtracebis.8
endif
if SNMP
module_LTLIBRARIES += ripd/ripd_snmp.la
endif
-man8 += $(MANBUILD)/ripd.8
+man8 += $(MANBUILD)/frr-ripd.8
endif
ripd_librip_a_SOURCES = \
$(top_srcdir)/ripngd/ripng_debug.c \
$(top_srcdir)/ripngd/ripngd.c \
# end
-man8 += $(MANBUILD)/ripngd.8
+man8 += $(MANBUILD)/frr-ripngd.8
endif
ripngd_libripng_a_SOURCES = \
sbin_PROGRAMS += sharpd/sharpd
dist_examples_DATA += sharpd/sharpd.conf.sample
vtysh_scan += $(top_srcdir)/sharpd/sharp_vty.c
-man8 += $(MANBUILD)/sharpd.8
+man8 += $(MANBUILD)/frr-sharpd.8
endif
sharpd_libsharp_a_SOURCES = \
d none @mandir@/man1=$DESTDIR/@mandir@/man1 0755 root bin
f none @mandir@/man1/vtysh.1=$DESTDIR/@mandir@/man1/vtysh.1 0644 root bin
d none @mandir@/man8=$DESTDIR/@mandir@/man8 0755 root bin
-f none @mandir@/man8/bgpd.8=$DESTDIR/@mandir@/man8/bgpd.8 0644 root bin
-f none @mandir@/man8/ospf6d.8=$DESTDIR/@mandir@/man8/ospf6d.8 0644 root bin
-f none @mandir@/man8/ospfd.8=$DESTDIR/@mandir@/man8/ospfd.8 0644 root bin
-f none @mandir@/man8/ripd.8=$DESTDIR/@mandir@/man8/ripd.8 0644 root bin
-f none @mandir@/man8/ripngd.8=$DESTDIR/@mandir@/man8/ripngd.8 0644 root bin
-f none @mandir@/man8/zebra.8=$DESTDIR/@mandir@/man8/zebra.8 0644 root bin
-f none @mandir@/man8/isisd.8=$DESTDIR/@mandir@/man8/isisd.8 0644 root bin
+f none @mandir@/man8/frr-bgpd.8=$DESTDIR/@mandir@/man8/bgpd.8 0644 root bin
+f none @mandir@/man8/frr-ospf6d.8=$DESTDIR/@mandir@/man8/frr-ospf6d.8 0644 root bin
+f none @mandir@/man8/frr-ospfd.8=$DESTDIR/@mandir@/man8/frr-ospfd.8 0644 root bin
+f none @mandir@/man8/frr-ripd.8=$DESTDIR/@mandir@/man8/frr-ripd.8 0644 root bin
+f none @mandir@/man8/frr-ripngd.8=$DESTDIR/@mandir@/man8/frr-ripngd.8 0644 root bin
+f none @mandir@/man8/frr-zebra.8=$DESTDIR/@mandir@/man8/frr-zebra.8 0644 root bin
+f none @mandir@/man8/frr-isisd.8=$DESTDIR/@mandir@/man8/frr-isisd.8 0644 root bin
sbin_PROGRAMS += staticd/staticd
dist_examples_DATA += staticd/staticd.conf.sample
vtysh_scan += $(top_srcdir)/staticd/static_vty.c
-man8 += $(MANBUILD)/staticd.8
+man8 += $(MANBUILD)/frr-staticd.8
endif
staticd_libstatic_a_SOURCES = \
sbin_PROGRAMS += vrrpd/vrrpd
# dist_examples_DATA += staticd/staticd.conf.sample
vtysh_scan += $(top_srcdir)/vrrpd/vrrp_vty.c
-man8 += $(MANBUILD)/vrrpd.8
+man8 += $(MANBUILD)/frr-vrrpd.8
endif
vrrpd_libvrrp_a_SOURCES = \
if WATCHFRR
sbin_PROGRAMS += watchfrr/watchfrr
vtysh_scan += $(top_srcdir)/watchfrr/watchfrr_vty.c
-man8 += $(MANBUILD)/watchfrr.8
+man8 += $(MANBUILD)/frr-watchfrr.8
endif
noinst_HEADERS += \
module_LTLIBRARIES += zebra/zebra_fpm.la
endif
-man8 += $(MANBUILD)/zebra.8
+man8 += $(MANBUILD)/frr-zebra.8
## endif ZEBRA
endif
projects / mirror / frr.git / commitdiff