summaryrefslogtreecommitdiff
path: root/doc/manpages
diff options
context:
space:
mode:
Diffstat (limited to 'doc/manpages')
-rw-r--r--doc/manpages/bfd-options.rst10
-rw-r--r--doc/manpages/bfdd.rst40
-rw-r--r--doc/manpages/common-options.rst1
-rw-r--r--doc/manpages/conf.py1
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 0000000000..e335ed120b
--- /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 0000000000..1f8b1475f4
--- /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 1b2eb18dea..1e99010505 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 4d5797f613..e540d236ea 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 -------------------------------------------