diff options
| author | Donald Sharp <sharpd@cumulusnetworks.com> | 2018-03-15 10:13:58 -0400 |
|---|---|---|
| committer | Donald Sharp <sharpd@cumulusnetworks.com> | 2018-04-06 13:22:43 -0400 |
| commit | a6c93cb20fa11bfdc3dedc81099cf9ee39f19f64 (patch) | |
| tree | 24fd56a1808bd99046802972e1aafaf4e317347e /doc/manpages | |
| parent | e5c83d9b314cb513e78707de5d29ec655dbdca7e (diff) | |
doc: Add documentation for PBRD
Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
Diffstat (limited to 'doc/manpages')
| -rw-r--r-- | doc/manpages/common-options.rst | 1 | ||||
| -rw-r--r-- | doc/manpages/conf.py | 1 | ||||
| -rw-r--r-- | doc/manpages/defines.rst | 2 | ||||
| -rw-r--r-- | doc/manpages/index.rst | 1 | ||||
| -rw-r--r-- | doc/manpages/pbrd.rst | 39 |
5 files changed, 43 insertions, 1 deletions
diff --git a/doc/manpages/common-options.rst b/doc/manpages/common-options.rst index 5b136f5e1a..e433c720af 100644 --- a/doc/manpages/common-options.rst +++ b/doc/manpages/common-options.rst @@ -122,6 +122,7 @@ These following options control the daemon's VTY (interactive command line) inte pimd 2611 ldpd 2612 eigrpd 2613 + pbrd 2615 Port 2607 is used for ospfd's Opaque LSA API, while port 2600 is used for the (insecure) TCP-ZEBRA interface. diff --git a/doc/manpages/conf.py b/doc/manpages/conf.py index a78e1a2c38..b5ea537faa 100644 --- a/doc/manpages/conf.py +++ b/doc/manpages/conf.py @@ -318,6 +318,7 @@ man_pages = [ ('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), ('mtracebis', 'mtracebis', "a multicast trace client", [], 8), ('ripd', 'ripd', fwfrr.format("a RIP "), [], 8), ('ripngd', 'ripngd', fwfrr.format("a RIPNG "), [], 8), diff --git a/doc/manpages/defines.rst b/doc/manpages/defines.rst index 841abe300e..21c3790afa 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), ldpd(8), eigrpd(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), mtracebis(8) diff --git a/doc/manpages/index.rst b/doc/manpages/index.rst index ae5c4ca3bd..964cc07d71 100644 --- a/doc/manpages/index.rst +++ b/doc/manpages/index.rst @@ -18,6 +18,7 @@ Welcome to FRR's documentation! ospfclient ospfd pimd + pbrd mtracebis ripd ripngd diff --git a/doc/manpages/pbrd.rst b/doc/manpages/pbrd.rst new file mode 100644 index 0000000000..38e1bc267b --- /dev/null +++ b/doc/manpages/pbrd.rst @@ -0,0 +1,39 @@ +**** +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 + + |