diff options
Diffstat (limited to 'doc/manpages')
| -rw-r--r-- | doc/manpages/bfd-options.rst | 35 | ||||
| -rw-r--r-- | doc/manpages/conf.py | 2 |
2 files changed, 30 insertions, 7 deletions
diff --git a/doc/manpages/bfd-options.rst b/doc/manpages/bfd-options.rst index e335ed12..3f109162 100644 --- a/doc/manpages/bfd-options.rst +++ b/doc/manpages/bfd-options.rst @@ -1,10 +1,33 @@ -BFD SOCKET ----------- +BFD +--- -The following option controls the BFD daemon control socket location. +The following options controls the BFD daemon auxiliary sockets. -.. option:: --bfdctl bfd-control-socket +.. option:: --dplaneaddr <type>:<address>[<:port>] - Opens the BFD daemon control socket located at the pointed location. + Configure the distributed BFD data plane listening socket bind address. - (default: |INSTALL_PREFIX_STATE|/bfdd.sock) + One would expect the data plane to run in the same machine as FRR, so + the suggested configuration would be: + + ``--dplaneaddr unix:/var/run/frr/bfdd_dplane.sock`` + + Or using IPv4: + + ``--dplaneaddr ipv4:127.0.0.1`` + + Or using IPv6: + + ``--dplaneaddr ipv6:[::1]`` + + It is also possible to specify a port (for IPv4/IPv6 only): + + ``--dplaneaddr ipv6:[::1]:50701`` + + (if omitted the default port is ``50700``). + + It is also possible to operate in client mode (instead of listening for + connections). To connect to a data plane server append the letter 'c' to + the protocol, example: + + ``--dplaneaddr ipv4c:127.0.0.1`` diff --git a/doc/manpages/conf.py b/doc/manpages/conf.py index 73dea094..995885b2 100644 --- a/doc/manpages/conf.py +++ b/doc/manpages/conf.py @@ -91,7 +91,7 @@ replace_vars = { # extract version information, installation location, other stuff we need to # use when building final documents -val = re.compile('^S\["([^"]+)"\]="(.*)"$') +val = re.compile(r'^S\["([^"]+)"\]="(.*)"$') try: with open("../../config.status", "r") as cfgstatus: for ln in cfgstatus.readlines(): |