diff options
| author | Rafael Zalamena <rzalamena@opensourcerouting.org> | 2018-06-27 19:24:40 +0200 |
|---|---|---|
| committer | Rafael Zalamena <rzalamena@opensourcerouting.org> | 2018-08-08 23:25:04 +0200 |
| commit | c44032c1ffa9981409de5570a3301e5f05abd027 (patch) | |
| tree | b94de8e46ec71a22084227ef2985096f56377d38 /doc/manpages | |
| parent | bgpd/ospf(6)d/pimd: don't show BFD timers (diff) | |
| download | frr-c44032c1ffa9981409de5570a3301e5f05abd027.tar.xz frr-c44032c1ffa9981409de5570a3301e5f05abd027.zip | |
bfdd: add documentation
Add BFD daemon documentation:
* commands;
* man page;
* manual / description;
Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
Diffstat (limited to 'doc/manpages')
| -rw-r--r-- | doc/manpages/bfd-options.rst | 10 | ||||
| -rw-r--r-- | doc/manpages/bfdd.rst | 40 | ||||
| -rw-r--r-- | doc/manpages/common-options.rst | 1 | ||||
| -rw-r--r-- | doc/manpages/conf.py | 1 |
4 files changed, 52 insertions, 0 deletions
diff --git a/doc/manpages/bfd-options.rst b/doc/manpages/bfd-options.rst new file mode 100644 index 000000000..e335ed120 --- /dev/null +++ b/doc/manpages/bfd-options.rst @@ -0,0 +1,10 @@ +BFD SOCKET +---------- + +The following option controls the BFD daemon control socket location. + +.. option:: --bfdctl bfd-control-socket + + Opens the BFD daemon control socket located at the pointed location. + + (default: |INSTALL_PREFIX_STATE|/bfdd.sock) diff --git a/doc/manpages/bfdd.rst b/doc/manpages/bfdd.rst new file mode 100644 index 000000000..1f8b1475f --- /dev/null +++ b/doc/manpages/bfdd.rst @@ -0,0 +1,40 @@ +**** +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 + diff --git a/doc/manpages/common-options.rst b/doc/manpages/common-options.rst index 1b2eb18de..1e9901050 100644 --- a/doc/manpages/common-options.rst +++ b/doc/manpages/common-options.rst @@ -124,6 +124,7 @@ These following options control the daemon's VTY (interactive command line) inte eigrpd 2613 pbrd 2615 staticd 2616 + bfdd 2617 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 4d5797f61..e540d236e 100644 --- a/doc/manpages/conf.py +++ b/doc/manpages/conf.py @@ -332,6 +332,7 @@ man_pages = [ ('watchfrr', 'watchfrr', 'a program to monitor the status of FRRouting daemons', [], 8), ('vtysh', 'vtysh', 'an integrated shell for FRRouting.', [], 1), ('frr', 'frr', 'a systemd interaction script', [], 1), + ('bfdd', 'bfdd', fwfrr.format("a bfd"), [], 8), ] # -- Options for Texinfo output ------------------------------------------- |